feat: exit non-zero when analysis has findings (#163)

* feat(cli): exit non-zero when analysis has findings

* refactor(analyze): move severity and fail threshold ranks to module scope

* test(cli): simplify tests by using a fixture for chalk package

* update: snapshots

Author: dreyfus92

src/commands/analyze.meta.ts

@@ -6,7 +6,8 @@ export const meta = {
       type: 'enum',
       choices: ['debug', 'info', 'warn', 'error'],
       default: 'info',
-      description: 'Set the log level (debug | info | warn | error)'
+      description:
+        'Set the log level and the minimum severity that causes a non-zero exit code (debug | info | warn | error)'
     },
     manifest: {
       type: 'string',

src/commands/analyze.ts

@@ -19,6 +19,18 @@ function formatBytes(bytes: number) {
   return `${size.toFixed(1)} ${units[unitIndex]}`;
 }
 
+const SEVERITY_RANK: Record<string, number> = {
+  error: 3,
+  warning: 2,
+  suggestion: 1
+};
+const FAIL_THRESHOLD_RANK: Record<string, number> = {
+  error: 3,
+  warn: 2,
+  info: 1,
+  debug: 0
+};
+
 export async function run(ctx: CommandContext<typeof meta>) {
   const [_commandName, providedPath] = ctx.positionals;
   const logLevel = ctx.values['log-level'];
@@ -148,4 +160,13 @@ export async function run(ctx: CommandContext<typeof meta>) {
     }
   }
   prompts.outro('Done!');
+
+  // Exit with non-zero when messages meet the fail threshold (--log-level)
+  const thresholdRank = FAIL_THRESHOLD_RANK[logLevel] ?? 0;
+  const hasFailingMessages =
+    thresholdRank > 0 &&
+    messages.some((m) => SEVERITY_RANK[m.severity] >= thresholdRank);
+  if (hasFailingMessages) {
+    process.exit(1);
+  }
 }

src/test/cli.test.ts

@@ -14,6 +14,11 @@ const stripVersion = (str: string): string =>
 const normalizeStderr = (str: string): string =>
   str.replace(/\(node:\d+\)/g, '(node:<pid>)');
 
+const basicChalkFixture = path.join(
+  __dirname,
+  '../../test/fixtures/basic-chalk'
+);
+
 beforeAll(async () => {
   // Create a temporary directory for the test package
   tempDir = await createTempDir();
@@ -94,10 +99,33 @@ describe('CLI', () => {
   });
 });
 
-const basicChalkFixture = path.join(
-  __dirname,
-  '../../test/fixtures/basic-chalk'
-);
+describe('analyze exit codes', () => {
+  it('exits 1 when path is not a directory', async () => {
+    const {code} = await runCliProcess(['analyze', '/nonexistent-path']);
+    expect(code).toBe(1);
+  });
+
+  it('exits 0 with --log-level=debug', async () => {
+    const {code} = await runCliProcess(
+      ['analyze', '--log-level=debug'],
+      tempDir
+    );
+    expect(code).toBe(0);
+  });
+
+  it('exits 1 with default log-level when analysis has messages', async () => {
+    const {code} = await runCliProcess(['analyze'], basicChalkFixture);
+    expect(code).toBe(1);
+  });
+
+  it('exits 0 with --log-level=debug when analysis has messages', async () => {
+    const {code} = await runCliProcess(
+      ['analyze', '--log-level=debug'],
+      basicChalkFixture
+    );
+    expect(code).toBe(0);
+  });
+});
 
 describe('migrate --all', () => {
   it('should migrate all fixable replacements with --all --dry-run when project has fixable deps', async () => {