Merge pull request #10 from barrymichaeldoyle/feat/ignore-peer-deps

feat: added ignore peer deps flag

Author: barrymichaeldoyle

packages/cli/CHANGELOG.md

@@ -1,5 +1,11 @@
 # patch-pulse
 
+## 4.1.0
+
+### Minor Changes
+
+- Add `--no-peer-deps` CLI flag and `ignorePeerDeps` config option to exclude `peerDependencies` from the scan. Useful for published libraries where peer dep ranges are intentionally broad and not something you manage directly.
+
 ## 4.0.4
 
 ### Patch Changes

packages/cli/package.json

@@ -1,6 +1,6 @@
 {
   "name": "patch-pulse",
-  "version": "4.0.4",
+  "version": "4.1.0",
   "description": "Check for outdated npm dependencies",
   "type": "module",
   "bin": {

packages/cli/src/cli.ts

@@ -60,6 +60,7 @@ const VALID_FLAGS = [
   '--hide-clean',
   '--expand',
   '--fail',
+  '--no-peer-deps',
 ];
 
 export async function runCli({
@@ -205,6 +206,10 @@ export async function runCli({
         }
 
         for (const key of PACKAGE_JSON_DEPENDENCY_FIELDS) {
+          if (key === 'peerDependencies' && config.ignorePeerDeps) {
+            continue;
+          }
+
           const value = project.sections[key];
           if (!value) {
             continue;

packages/cli/src/gen/version.gen.ts

@@ -1,2 +1,2 @@
 // Auto-generated file - do not edit manually
-export const VERSION = '4.0.4';
+export const VERSION = '4.1.0';

packages/cli/src/services/config.ts

@@ -9,6 +9,7 @@ export interface PatchPulseConfig {
   includePaths?: string[];
   packageManager?: PackageManager;
   interactive?: boolean;
+  ignorePeerDeps?: boolean;
 }
 
 /**
@@ -95,6 +96,11 @@ export function parseCliConfig(args: string[]): PatchPulseConfig {
     config.interactive = false;
   }
 
+  // Parse ignorePeerDeps flag
+  if (args.includes('--no-peer-deps')) {
+    config.ignorePeerDeps = true;
+  }
+
   return config;
 }
 
@@ -160,6 +166,13 @@ export function mergeConfigs(
     merged.interactive = fileConfig.interactive;
   }
 
+  // Handle ignorePeerDeps (CLI takes precedence)
+  if (cliConfig.ignorePeerDeps !== undefined) {
+    merged.ignorePeerDeps = cliConfig.ignorePeerDeps;
+  } else if (fileConfig?.ignorePeerDeps !== undefined) {
+    merged.ignorePeerDeps = fileConfig.ignorePeerDeps;
+  }
+
   return merged;
 }
 
@@ -200,6 +213,10 @@ function validateConfig(config: any): PatchPulseConfig {
     validated.interactive = config.interactive;
   }
 
+  if (typeof config.ignorePeerDeps === 'boolean') {
+    validated.ignorePeerDeps = config.ignorePeerDeps;
+  }
+
   return validated;
 }
 

packages/cli/src/services/tests/config.test.ts

@@ -82,6 +82,28 @@ describe('Configuration Service', () => {
       consoleSpy.mockRestore();
     });
 
+    it('should read ignorePeerDeps from file config', () => {
+      vi.mocked(existsSync).mockReturnValue(true);
+      vi.mocked(join).mockReturnValue('/test/patchpulse.json');
+      vi.mocked(readFileSync).mockReturnValue(
+        JSON.stringify({ ignorePeerDeps: true }),
+      );
+
+      const result = readConfigFile('/test');
+      expect(result).toEqual({ ignorePeerDeps: true });
+    });
+
+    it('should ignore non-boolean ignorePeerDeps from file config', () => {
+      vi.mocked(existsSync).mockReturnValue(true);
+      vi.mocked(join).mockReturnValue('/test/patchpulse.json');
+      vi.mocked(readFileSync).mockReturnValue(
+        JSON.stringify({ ignorePeerDeps: 'yes' }),
+      );
+
+      const result = readConfigFile('/test');
+      expect(result?.ignorePeerDeps).toBeUndefined();
+    });
+
     it('should ignore unsupported package manager values from file config', () => {
       vi.mocked(existsSync).mockReturnValue(true);
       vi.mocked(join).mockReturnValue('/test/patchpulse.json');
@@ -134,6 +156,16 @@ describe('Configuration Service', () => {
 
       expect(result).toEqual({});
     });
+
+    it('should parse --no-peer-deps flag', () => {
+      const result = parseCliConfig(['--no-peer-deps']);
+      expect(result).toEqual({ ignorePeerDeps: true });
+    });
+
+    it('should not set ignorePeerDeps when --no-peer-deps is absent', () => {
+      const result = parseCliConfig([]);
+      expect(result.ignorePeerDeps).toBeUndefined();
+    });
   });
 
   describe('mergeConfigs', () => {
@@ -191,6 +223,24 @@ describe('Configuration Service', () => {
         interactive: false,
       });
     });
+
+    it('CLI ignorePeerDeps takes precedence over file config', () => {
+      const result = mergeConfigs(
+        { ignorePeerDeps: false },
+        { ignorePeerDeps: true },
+      );
+      expect(result.ignorePeerDeps).toBe(true);
+    });
+
+    it('file ignorePeerDeps is used when CLI does not set it', () => {
+      const result = mergeConfigs({ ignorePeerDeps: true }, {});
+      expect(result.ignorePeerDeps).toBe(true);
+    });
+
+    it('ignorePeerDeps is undefined when neither config sets it', () => {
+      const result = mergeConfigs(null, {});
+      expect(result.ignorePeerDeps).toBeUndefined();
+    });
   });
 
   describe('shouldSkipPackage', () => {

packages/cli/src/ui/display/help.ts

@@ -35,6 +35,7 @@ ${ansi.cyanBoldUnderline('🔧 Configuration Options:')}
   ${ansi.white('--project <name|path>')}    ${ansi.gray('Limit the scan output to one project in a monorepo')}
   ${ansi.white('-i, --interactive')}        ${ansi.gray('Show interactive update prompt after summary')}
   ${ansi.white('--no-interactive')}         ${ansi.gray('Skip update prompt after summary (default)')}
+  ${ansi.white('--no-peer-deps')}           ${ansi.gray('Exclude peerDependencies from the scan')}
   ${ansi.white('--hide-clean')}             ${ansi.gray('Hide clean projects in monorepos')}
   ${ansi.white('--expand')}                 ${ansi.gray('Show full output for every project in monorepos')}
   ${ansi.white('--fail')}                   ${ansi.gray('Exit with code 1 if any outdated packages are found')}
@@ -46,7 +47,8 @@ ${ansi.cyanBoldUnderline('📁 Configuration File:')}
     ${ansi.gray('"skip": ["lodash", "@types/*", "test-*"],')}
     ${ansi.gray('"ignorePaths": ["packages/cli/e2e"],')}
     ${ansi.gray('"packageManager": "npm",')}
-    ${ansi.gray('"interactive": true')}
+    ${ansi.gray('"interactive": true,')}
+    ${ansi.gray('"ignorePeerDeps": true')}
   ${ansi.gray('}')}
 
 ${ansi.cyanBoldUnderline('📝 Description:')}
@@ -74,6 +76,7 @@ ${ansi.cyanBoldUnderline('💡 Examples:')}
   ${ansi.white('npx patch-pulse --expand')}                 ${ansi.gray('# Show full monorepo output including clean projects')}
   ${ansi.white('npx patch-pulse --fail')}                   ${ansi.gray('# Exit 1 if any outdated packages found (useful in CI)')}
   ${ansi.white('npx patch-pulse --json --fail')}            ${ansi.gray('# Machine-readable output + non-zero exit for CI scripts')}
+  ${ansi.white('npx patch-pulse --no-peer-deps')}          ${ansi.gray('# Exclude peerDependencies from the scan')}
 
 ${ansi.cyanBoldUnderline('🔗 Links:')}
   ${ansi.blue('📚 Docs:')}      ${ansi.white(ansi.link('barrymichaeldoyle.github.io/patch-pulse', DOCS_URL))}

packages/docs/src/content/docs/cli/commands.mdx

@@ -148,3 +148,15 @@ npx patch-pulse --json --fail
   Combine `--json` and `--fail` for machine-readable output with a non-zero exit
   code when updates are available.
 </Aside>
+
+---
+
+### `--no-peer-deps`
+
+Exclude `peerDependencies` from the scan. Useful for published libraries where peer dep ranges are intentionally broad and not something you manage directly.
+
+```bash
+npx patch-pulse --no-peer-deps
+```
+
+Can also be set persistently via [`ignorePeerDeps`](../configuration#ignorePeerDeps) in your config file.

packages/docs/src/content/docs/cli/configuration.mdx

@@ -19,7 +19,8 @@ The CLI supports a configuration file for persistent settings. Use `patchpulse.j
   "skip": ["lodash", "@types/*", "test-*"],
   "ignorePaths": ["packages/cli/e2e"],
   "packageManager": "pnpm",
-  "interactive": true
+  "interactive": true,
+  "ignorePeerDeps": true
 }
 ```
 
@@ -101,6 +102,20 @@ Enable the interactive update prompt automatically after every run.
 
 ---
 
+### `ignorePeerDeps`
+
+Exclude `peerDependencies` from the scan entirely. Useful for published libraries where peer dep ranges are intentionally broad and not something you manage directly.
+
+```json
+{
+  "ignorePeerDeps": true
+}
+```
+
+Can also be set via the [`--no-peer-deps`](../commands#--no-peer-deps) CLI flag.
+
+---
+
 ## CLI vs file precedence
 
 CLI flags take precedence over file settings for most options. The `skip` array is an exception — values from both sources are **merged**.

packages/docs/src/content/docs/github-action/configuration.mdx

@@ -77,7 +77,10 @@ Use `ignore` to permanently exclude packages from ever getting a PR. Supports ex
 <Aside type="note">
   The ignore list is also respected by the PatchPulse CLI's `skip`
   configuration. Packages skipped in `patchpulse.json` are filtered out before
-  the action even sees them.
+  the action even sees them. Setting [`ignorePeerDeps:
+  true`](../../cli/configuration#ignorePeerDeps) in `patchpulse.json` has the
+  same effect — peer dependencies are excluded from the CLI output and will
+  never trigger a PR.
 </Aside>
 
 ---