@eslint-config-snapshot/cli 0.5.0 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # @eslint-config-snapshot/cli
 
+## 0.8.0
+
+### Minor Changes
+
+- Release minor version with improved human-readable CLI runtime logs and consistent output spacing.
+
+### Patch Changes
+
+- Updated dependencies
+  - @eslint-config-snapshot/api@0.8.0
+
+## 0.7.0
+
+### Minor Changes
+
+- Release minor version after improving runtime command header messaging and UX consistency.
+
+### Patch Changes
+
+- Updated dependencies
+  - @eslint-config-snapshot/api@0.7.0
+
+## 0.6.0
+
+### Minor Changes
+
+- Release minor version with improved interactive CLI logging tone and richer runtime context reporting.
+
+### Patch Changes
+
+- Updated dependencies
+  - @eslint-config-snapshot/api@0.6.0
+
 ## 0.5.0
 
 ### Minor Changes

package/dist/index.cjs

@@ -195,7 +195,7 @@ async function executeCheck(cwd, format, defaultInvocation = false) {
   if (format !== "status") {
     writeRunContextHeader(cwd, defaultInvocation ? "check" : `check:${format}`, foundConfig?.path, storedSnapshots);
     if (shouldShowRunLogs()) {
-      writeSubtleInfo("Analyzing current ESLint configuration...\n");
+      writeSubtleInfo("\u{1F50E} Checking current ESLint configuration...\n");
     }
   }
   if (!foundConfig) {
@@ -218,13 +218,13 @@ async function executeCheck(cwd, format, defaultInvocation = false) {
   if (storedSnapshots.size === 0) {
     const summary = summarizeSnapshots(currentSnapshots);
     process.stdout.write(
-      `Current rule state: ${summary.groups} groups, ${summary.rules} rules (severity mix: ${summary.error} errors, ${summary.warn} warnings, ${summary.off} off).
+      `Rules found in this analysis: ${summary.groups} groups, ${summary.rules} rules (severity mix: ${summary.error} errors, ${summary.warn} warnings, ${summary.off} off).
 `
     );
     const canPromptBaseline = defaultInvocation || format === "summary";
     if (canPromptBaseline && process.stdin.isTTY && process.stdout.isTTY) {
       const shouldCreateBaseline = await askYesNo(
-        "No baseline yet. Use current rule state as your baseline now? [Y/n] ",
+        "No baseline yet. Do you want to save this analyzed rule state as your baseline now? [Y/n] ",
         true
       );
       if (shouldCreateBaseline) {
@@ -271,7 +271,7 @@ async function executeUpdate(cwd, printSummary) {
   const storedSnapshots = await loadStoredSnapshots(cwd);
   writeRunContextHeader(cwd, "update", foundConfig?.path, storedSnapshots);
   if (shouldShowRunLogs()) {
-    writeSubtleInfo("Analyzing current ESLint configuration...\n");
+    writeSubtleInfo("\u{1F50E} Checking current ESLint configuration...\n");
   }
   if (!foundConfig) {
     writeSubtleInfo(
@@ -310,7 +310,7 @@ async function executePrint(cwd, format) {
   const storedSnapshots = await loadStoredSnapshots(cwd);
   writeRunContextHeader(cwd, `print:${format}`, foundConfig?.path, storedSnapshots);
   if (shouldShowRunLogs()) {
-    writeSubtleInfo("Analyzing current ESLint configuration...\n");
+    writeSubtleInfo("\u{1F50E} Checking current ESLint configuration...\n");
   }
   const currentSnapshots = await computeCurrentSnapshots(cwd);
   if (format === "short") {
@@ -329,7 +329,7 @@ async function executeConfig(cwd, format) {
   const storedSnapshots = await loadStoredSnapshots(cwd);
   writeRunContextHeader(cwd, `config:${format}`, foundConfig?.path, storedSnapshots);
   if (shouldShowRunLogs()) {
-    writeSubtleInfo("Resolving effective runtime configuration...\n");
+    writeSubtleInfo("\u2699\uFE0F Resolving effective runtime configuration...\n");
   }
   const config = await (0, import_api.loadConfig)(cwd);
   const resolved = await resolveWorkspaceAssignments(cwd, config);
@@ -780,7 +780,6 @@ function printWhatChanged(changes, currentSnapshots, eslintVersionsByGroup) {
 - workspace membership changes: ${changeSummary.workspace}
 - current baseline: ${currentSummary.groups} groups, ${currentSummary.rules} rules
 - current severity mix: ${currentSummary.error} errors, ${currentSummary.warn} warnings, ${currentSummary.off} off
-
 `
   );
   writeEslintVersionSummary(eslintVersionsByGroup);
@@ -890,11 +889,14 @@ function endRunTimer(exitCode) {
     activeRunTimer.pauseStartedAtMs = void 0;
   }
   const elapsedMs = Math.max(0, Date.now() - activeRunTimer.startedAtMs - activeRunTimer.pausedMs);
-  const color = createColorizer();
-  const status = exitCode === 0 ? color.green("done") : color.red("failed");
   const seconds = (elapsedMs / 1e3).toFixed(2);
-  writeSubtleInfo(`Run ${status} in ${seconds}s
+  if (exitCode === 0) {
+    writeSubtleInfo(`Finished in ${seconds}s
+`);
+  } else {
+    writeSubtleInfo(`Finished with errors in ${seconds}s
 `);
+  }
   activeRunTimer = void 0;
 }
 function pauseRunTimer() {
@@ -954,17 +956,53 @@ function writeRunContextHeader(cwd, commandLabel, configPath, storedSnapshots) {
     return;
   }
   const color = createColorizer();
-  process.stdout.write(color.bold(`eslint-config-snapshot v${readCliVersion()}
+  process.stdout.write(color.bold(`eslint-config-snapshot v${readCliVersion()} \u2022 ${formatCommandDisplayLabel(commandLabel)}
 `));
-  process.stdout.write(`Command: ${commandLabel}
-`);
-  process.stdout.write(`Repository: ${cwd}
+  process.stdout.write(`\u{1F4C1} Repository: ${cwd}
 `);
-  process.stdout.write(`Config: ${formatConfigSource(cwd, configPath)}
+  process.stdout.write(`\u{1F4C1} Baseline: ${formatStoredSnapshotSummary(storedSnapshots)}
 `);
-  process.stdout.write(`Baseline: ${formatStoredSnapshotSummary(storedSnapshots)}
-
+  process.stdout.write(`\u2699\uFE0F Config source: ${formatConfigSource(cwd, configPath)}
 `);
+  process.stdout.write("\n");
+}
+function formatCommandDisplayLabel(commandLabel) {
+  switch (commandLabel) {
+    case "check":
+    case "check:summary": {
+      return "Check drift against baseline (summary)";
+    }
+    case "check:diff": {
+      return "Check drift against baseline (detailed diff)";
+    }
+    case "check:status": {
+      return "Check drift against baseline (status only)";
+    }
+    case "update": {
+      return "Update baseline snapshot";
+    }
+    case "print:json": {
+      return "Print aggregated rules (JSON)";
+    }
+    case "print:short": {
+      return "Print aggregated rules (short view)";
+    }
+    case "config:json": {
+      return "Show effective runtime config (JSON)";
+    }
+    case "config:short": {
+      return "Show effective runtime config (short view)";
+    }
+    case "init": {
+      return "Initialize local configuration";
+    }
+    case "help": {
+      return "Show CLI help";
+    }
+    default: {
+      return commandLabel;
+    }
+  }
 }
 function formatConfigSource(cwd, configPath) {
   if (!configPath) {

package/dist/index.js

@@ -176,7 +176,7 @@ async function executeCheck(cwd, format, defaultInvocation = false) {
   if (format !== "status") {
     writeRunContextHeader(cwd, defaultInvocation ? "check" : `check:${format}`, foundConfig?.path, storedSnapshots);
     if (shouldShowRunLogs()) {
-      writeSubtleInfo("Analyzing current ESLint configuration...\n");
+      writeSubtleInfo("\u{1F50E} Checking current ESLint configuration...\n");
     }
   }
   if (!foundConfig) {
@@ -199,13 +199,13 @@ async function executeCheck(cwd, format, defaultInvocation = false) {
   if (storedSnapshots.size === 0) {
     const summary = summarizeSnapshots(currentSnapshots);
     process.stdout.write(
-      `Current rule state: ${summary.groups} groups, ${summary.rules} rules (severity mix: ${summary.error} errors, ${summary.warn} warnings, ${summary.off} off).
+      `Rules found in this analysis: ${summary.groups} groups, ${summary.rules} rules (severity mix: ${summary.error} errors, ${summary.warn} warnings, ${summary.off} off).
 `
     );
     const canPromptBaseline = defaultInvocation || format === "summary";
     if (canPromptBaseline && process.stdin.isTTY && process.stdout.isTTY) {
       const shouldCreateBaseline = await askYesNo(
-        "No baseline yet. Use current rule state as your baseline now? [Y/n] ",
+        "No baseline yet. Do you want to save this analyzed rule state as your baseline now? [Y/n] ",
         true
       );
       if (shouldCreateBaseline) {
@@ -252,7 +252,7 @@ async function executeUpdate(cwd, printSummary) {
   const storedSnapshots = await loadStoredSnapshots(cwd);
   writeRunContextHeader(cwd, "update", foundConfig?.path, storedSnapshots);
   if (shouldShowRunLogs()) {
-    writeSubtleInfo("Analyzing current ESLint configuration...\n");
+    writeSubtleInfo("\u{1F50E} Checking current ESLint configuration...\n");
   }
   if (!foundConfig) {
     writeSubtleInfo(
@@ -291,7 +291,7 @@ async function executePrint(cwd, format) {
   const storedSnapshots = await loadStoredSnapshots(cwd);
   writeRunContextHeader(cwd, `print:${format}`, foundConfig?.path, storedSnapshots);
   if (shouldShowRunLogs()) {
-    writeSubtleInfo("Analyzing current ESLint configuration...\n");
+    writeSubtleInfo("\u{1F50E} Checking current ESLint configuration...\n");
   }
   const currentSnapshots = await computeCurrentSnapshots(cwd);
   if (format === "short") {
@@ -310,7 +310,7 @@ async function executeConfig(cwd, format) {
   const storedSnapshots = await loadStoredSnapshots(cwd);
   writeRunContextHeader(cwd, `config:${format}`, foundConfig?.path, storedSnapshots);
   if (shouldShowRunLogs()) {
-    writeSubtleInfo("Resolving effective runtime configuration...\n");
+    writeSubtleInfo("\u2699\uFE0F Resolving effective runtime configuration...\n");
   }
   const config = await loadConfig(cwd);
   const resolved = await resolveWorkspaceAssignments(cwd, config);
@@ -761,7 +761,6 @@ function printWhatChanged(changes, currentSnapshots, eslintVersionsByGroup) {
 - workspace membership changes: ${changeSummary.workspace}
 - current baseline: ${currentSummary.groups} groups, ${currentSummary.rules} rules
 - current severity mix: ${currentSummary.error} errors, ${currentSummary.warn} warnings, ${currentSummary.off} off
-
 `
   );
   writeEslintVersionSummary(eslintVersionsByGroup);
@@ -871,11 +870,14 @@ function endRunTimer(exitCode) {
     activeRunTimer.pauseStartedAtMs = void 0;
   }
   const elapsedMs = Math.max(0, Date.now() - activeRunTimer.startedAtMs - activeRunTimer.pausedMs);
-  const color = createColorizer();
-  const status = exitCode === 0 ? color.green("done") : color.red("failed");
   const seconds = (elapsedMs / 1e3).toFixed(2);
-  writeSubtleInfo(`Run ${status} in ${seconds}s
+  if (exitCode === 0) {
+    writeSubtleInfo(`Finished in ${seconds}s
+`);
+  } else {
+    writeSubtleInfo(`Finished with errors in ${seconds}s
 `);
+  }
   activeRunTimer = void 0;
 }
 function pauseRunTimer() {
@@ -935,17 +937,53 @@ function writeRunContextHeader(cwd, commandLabel, configPath, storedSnapshots) {
     return;
   }
   const color = createColorizer();
-  process.stdout.write(color.bold(`eslint-config-snapshot v${readCliVersion()}
+  process.stdout.write(color.bold(`eslint-config-snapshot v${readCliVersion()} \u2022 ${formatCommandDisplayLabel(commandLabel)}
 `));
-  process.stdout.write(`Command: ${commandLabel}
-`);
-  process.stdout.write(`Repository: ${cwd}
+  process.stdout.write(`\u{1F4C1} Repository: ${cwd}
 `);
-  process.stdout.write(`Config: ${formatConfigSource(cwd, configPath)}
+  process.stdout.write(`\u{1F4C1} Baseline: ${formatStoredSnapshotSummary(storedSnapshots)}
 `);
-  process.stdout.write(`Baseline: ${formatStoredSnapshotSummary(storedSnapshots)}
-
+  process.stdout.write(`\u2699\uFE0F Config source: ${formatConfigSource(cwd, configPath)}
 `);
+  process.stdout.write("\n");
+}
+function formatCommandDisplayLabel(commandLabel) {
+  switch (commandLabel) {
+    case "check":
+    case "check:summary": {
+      return "Check drift against baseline (summary)";
+    }
+    case "check:diff": {
+      return "Check drift against baseline (detailed diff)";
+    }
+    case "check:status": {
+      return "Check drift against baseline (status only)";
+    }
+    case "update": {
+      return "Update baseline snapshot";
+    }
+    case "print:json": {
+      return "Print aggregated rules (JSON)";
+    }
+    case "print:short": {
+      return "Print aggregated rules (short view)";
+    }
+    case "config:json": {
+      return "Show effective runtime config (JSON)";
+    }
+    case "config:short": {
+      return "Show effective runtime config (short view)";
+    }
+    case "init": {
+      return "Initialize local configuration";
+    }
+    case "help": {
+      return "Show CLI help";
+    }
+    default: {
+      return commandLabel;
+    }
+  }
 }
 function formatConfigSource(cwd, configPath) {
   if (!configPath) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-config-snapshot/cli",
-  "version": "0.5.0",
+  "version": "0.8.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -30,6 +30,6 @@
     "@inquirer/prompts": "^8.2.0",
     "commander": "^14.0.3",
     "fast-glob": "^3.3.3",
-    "@eslint-config-snapshot/api": "0.5.0"
+    "@eslint-config-snapshot/api": "0.8.0"
   }
 }

package/src/index.ts

@@ -270,7 +270,7 @@ async function executeCheck(cwd: string, format: CheckFormat, defaultInvocation
   if (format !== 'status') {
     writeRunContextHeader(cwd, defaultInvocation ? 'check' : `check:${format}`, foundConfig?.path, storedSnapshots)
     if (shouldShowRunLogs()) {
-      writeSubtleInfo('Analyzing current ESLint configuration...\n')
+      writeSubtleInfo('🔎 Checking current ESLint configuration...\n')
     }
   }
 
@@ -293,18 +293,18 @@ async function executeCheck(cwd: string, format: CheckFormat, defaultInvocation
 
     throw error
   }
-  if (storedSnapshots.size === 0) {
-    const summary = summarizeSnapshots(currentSnapshots)
-    process.stdout.write(
-      `Current rule state: ${summary.groups} groups, ${summary.rules} rules (severity mix: ${summary.error} errors, ${summary.warn} warnings, ${summary.off} off).\n`
-    )
-
-    const canPromptBaseline = defaultInvocation || format === 'summary'
-    if (canPromptBaseline && process.stdin.isTTY && process.stdout.isTTY) {
-      const shouldCreateBaseline = await askYesNo(
-        'No baseline yet. Use current rule state as your baseline now? [Y/n] ',
-        true
+    if (storedSnapshots.size === 0) {
+      const summary = summarizeSnapshots(currentSnapshots)
+      process.stdout.write(
+        `Rules found in this analysis: ${summary.groups} groups, ${summary.rules} rules (severity mix: ${summary.error} errors, ${summary.warn} warnings, ${summary.off} off).\n`
       )
+
+      const canPromptBaseline = defaultInvocation || format === 'summary'
+      if (canPromptBaseline && process.stdin.isTTY && process.stdout.isTTY) {
+        const shouldCreateBaseline = await askYesNo(
+          'No baseline yet. Do you want to save this analyzed rule state as your baseline now? [Y/n] ',
+          true
+        )
       if (shouldCreateBaseline) {
         await writeSnapshots(cwd, currentSnapshots)
         const summary = summarizeSnapshots(currentSnapshots)
@@ -356,7 +356,7 @@ async function executeUpdate(cwd: string, printSummary: boolean): Promise<number
   const storedSnapshots = await loadStoredSnapshots(cwd)
   writeRunContextHeader(cwd, 'update', foundConfig?.path, storedSnapshots)
   if (shouldShowRunLogs()) {
-    writeSubtleInfo('Analyzing current ESLint configuration...\n')
+    writeSubtleInfo('🔎 Checking current ESLint configuration...\n')
   }
 
   if (!foundConfig) {
@@ -399,7 +399,7 @@ async function executePrint(cwd: string, format: PrintFormat): Promise<void> {
   const storedSnapshots = await loadStoredSnapshots(cwd)
   writeRunContextHeader(cwd, `print:${format}`, foundConfig?.path, storedSnapshots)
   if (shouldShowRunLogs()) {
-    writeSubtleInfo('Analyzing current ESLint configuration...\n')
+    writeSubtleInfo('🔎 Checking current ESLint configuration...\n')
   }
   const currentSnapshots = await computeCurrentSnapshots(cwd)
 
@@ -420,7 +420,7 @@ async function executeConfig(cwd: string, format: PrintFormat): Promise<void> {
   const storedSnapshots = await loadStoredSnapshots(cwd)
   writeRunContextHeader(cwd, `config:${format}`, foundConfig?.path, storedSnapshots)
   if (shouldShowRunLogs()) {
-    writeSubtleInfo('Resolving effective runtime configuration...\n')
+    writeSubtleInfo('⚙️ Resolving effective runtime configuration...\n')
   }
   const config = await loadConfig(cwd)
   const resolved = await resolveWorkspaceAssignments(cwd, config)
@@ -969,7 +969,7 @@ function printWhatChanged(
   process.stdout.write(color.red('Heads up: snapshot drift detected.\n'))
   writeSectionTitle('Summary', color)
   process.stdout.write(
-    `- changed groups: ${changes.length}\n- introduced rules: ${changeSummary.introduced}\n- removed rules: ${changeSummary.removed}\n- severity changes: ${changeSummary.severity}\n- options changes: ${changeSummary.options}\n- workspace membership changes: ${changeSummary.workspace}\n- current baseline: ${currentSummary.groups} groups, ${currentSummary.rules} rules\n- current severity mix: ${currentSummary.error} errors, ${currentSummary.warn} warnings, ${currentSummary.off} off\n\n`
+    `- changed groups: ${changes.length}\n- introduced rules: ${changeSummary.introduced}\n- removed rules: ${changeSummary.removed}\n- severity changes: ${changeSummary.severity}\n- options changes: ${changeSummary.options}\n- workspace membership changes: ${changeSummary.workspace}\n- current baseline: ${currentSummary.groups} groups, ${currentSummary.rules} rules\n- current severity mix: ${currentSummary.error} errors, ${currentSummary.warn} warnings, ${currentSummary.off} off\n`
   )
   writeEslintVersionSummary(eslintVersionsByGroup)
   process.stdout.write('\n')
@@ -1090,10 +1090,12 @@ function endRunTimer(exitCode: number): void {
   }
 
   const elapsedMs = Math.max(0, Date.now() - activeRunTimer.startedAtMs - activeRunTimer.pausedMs)
-  const color = createColorizer()
-  const status = exitCode === 0 ? color.green('done') : color.red('failed')
   const seconds = (elapsedMs / 1000).toFixed(2)
-  writeSubtleInfo(`Run ${status} in ${seconds}s\n`)
+  if (exitCode === 0) {
+    writeSubtleInfo(`Finished in ${seconds}s\n`)
+  } else {
+    writeSubtleInfo(`Finished with errors in ${seconds}s\n`)
+  }
   activeRunTimer = undefined
 }
 
@@ -1169,11 +1171,50 @@ function writeRunContextHeader(
   }
 
   const color = createColorizer()
-  process.stdout.write(color.bold(`eslint-config-snapshot v${readCliVersion()}\n`))
-  process.stdout.write(`Command: ${commandLabel}\n`)
-  process.stdout.write(`Repository: ${cwd}\n`)
-  process.stdout.write(`Config: ${formatConfigSource(cwd, configPath)}\n`)
-  process.stdout.write(`Baseline: ${formatStoredSnapshotSummary(storedSnapshots)}\n\n`)
+  process.stdout.write(color.bold(`eslint-config-snapshot v${readCliVersion()} • ${formatCommandDisplayLabel(commandLabel)}\n`))
+  process.stdout.write(`📁 Repository: ${cwd}\n`)
+  process.stdout.write(`📁 Baseline: ${formatStoredSnapshotSummary(storedSnapshots)}\n`)
+  process.stdout.write(`⚙️ Config source: ${formatConfigSource(cwd, configPath)}\n`)
+  process.stdout.write('\n')
+}
+
+function formatCommandDisplayLabel(commandLabel: string): string {
+  switch (commandLabel) {
+    case 'check':
+    case 'check:summary': {
+      return 'Check drift against baseline (summary)'
+    }
+    case 'check:diff': {
+      return 'Check drift against baseline (detailed diff)'
+    }
+    case 'check:status': {
+      return 'Check drift against baseline (status only)'
+    }
+    case 'update': {
+      return 'Update baseline snapshot'
+    }
+    case 'print:json': {
+      return 'Print aggregated rules (JSON)'
+    }
+    case 'print:short': {
+      return 'Print aggregated rules (short view)'
+    }
+    case 'config:json': {
+      return 'Show effective runtime config (JSON)'
+    }
+    case 'config:short': {
+      return 'Show effective runtime config (short view)'
+    }
+    case 'init': {
+      return 'Initialize local configuration'
+    }
+    case 'help': {
+      return 'Show CLI help'
+    }
+    default: {
+      return commandLabel
+    }
+  }
 }
 
 function formatConfigSource(cwd: string, configPath: string | undefined): string {

package/test/cli.terminal.integration.test.ts

@@ -101,7 +101,7 @@ describe('cli terminal invocation', () => {
     const result = run([])
     expect(result.status).toBe(1)
     expect(result.stdout).toBe(
-      'Current rule state: 1 groups, 3 rules (severity mix: 2 errors, 0 warnings, 1 off).\nYou are almost set: no baseline snapshot found yet.\nRun `eslint-config-snapshot --update` to create your first baseline.\n'
+      'Rules found in this analysis: 1 groups, 3 rules (severity mix: 2 errors, 0 warnings, 1 off).\nYou are almost set: no baseline snapshot found yet.\nRun `eslint-config-snapshot --update` to create your first baseline.\n'
     )
   })