@eslint-config-snapshot/api 0.8.0 → 0.14.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eslint-config-snapshot/api",
-  "version": "0.8.0",
+  "version": "0.14.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -26,6 +26,7 @@
   "dependencies": {
     "@manypkg/get-packages": "^3.1.0",
     "cosmiconfig": "^9.0.0",
+    "debug": "^4.4.3",
     "fast-glob": "^3.3.3",
     "picomatch": "^4.0.3"
   }

package/src/config.ts

@@ -24,7 +24,7 @@ export type SnapshotConfig = {
     maxFilesPerWorkspace: number
     includeGlobs: string[]
     excludeGlobs: string[]
-    hintGlobs: string[]
+    tokenHints?: string[] | string[][]
   }
 }
 
@@ -35,10 +35,9 @@ export const DEFAULT_CONFIG: SnapshotConfig = {
     groups: [{ name: 'default', match: ['**/*'] }]
   },
   sampling: {
-    maxFilesPerWorkspace: 8,
-    includeGlobs: ['**/*.{js,jsx,ts,tsx,cjs,mjs}'],
-    excludeGlobs: ['**/node_modules/**', '**/dist/**'],
-    hintGlobs: []
+    maxFilesPerWorkspace: 10,
+    includeGlobs: ['**/*.{js,jsx,ts,tsx,cjs,mjs,md,mdx,json,css}'],
+    excludeGlobs: ['**/node_modules/**', '**/dist/**']
   }
 }
 
@@ -130,10 +129,35 @@ export function getConfigScaffold(preset: ConfigPreset = 'minimal'): string {
     groups: [{ name: 'default', match: ['**/*'] }]
   },
   sampling: {
-    maxFilesPerWorkspace: 8,
-    includeGlobs: ['**/*.{js,jsx,ts,tsx,cjs,mjs}'],
+    maxFilesPerWorkspace: 10,
+    includeGlobs: ['**/*.{js,jsx,ts,tsx,cjs,mjs,md,mdx,json,css}'],
     excludeGlobs: ['**/node_modules/**', '**/dist/**'],
-    hintGlobs: []
+    tokenHints: [
+      'chunk',
+      'conf',
+      'config',
+      'container',
+      'controller',
+      'helpers',
+      'mock',
+      'mocks',
+      'presentation',
+      'repository',
+      'route',
+      'routes',
+      'schema',
+      'setup',
+      'spec',
+      'stories',
+      'style',
+      'styles',
+      'test',
+      'type',
+      'types',
+      'utils',
+      'view',
+      'views'
+    ]
   }
 }\n`
 }

package/src/diff.ts

@@ -1,6 +1,7 @@
 import { canonicalizeJson, sortUnique } from './core.js'
 
-import type { SnapshotFile } from './snapshot.js'
+import type { NormalizedRuleEntry } from './extract.js'
+import type { SnapshotFile, SnapshotRuleEntry } from './snapshot.js'
 
 export type RuleSeverityChange = {
   rule: string
@@ -43,37 +44,56 @@ export function diffSnapshots(before: SnapshotFile, after: SnapshotFile): Snapsh
   for (const name of beforeNames.filter((entry) => afterNames.includes(entry))) {
     const oldEntry = beforeRules[name]
     const newEntry = afterRules[name]
+    const oldVariants = toVariants(oldEntry)
+    const newVariants = toVariants(newEntry)
 
-    if (oldEntry[0] !== newEntry[0]) {
+    const oldSeverity = summarizeSeveritySet(oldVariants)
+    const newSeverity = summarizeSeveritySet(newVariants)
+    if (oldSeverity !== newSeverity) {
       severityChanges.push({
         rule: name,
-        before: oldEntry[0],
-        after: newEntry[0]
+        before: oldSeverity,
+        after: newSeverity
       })
     }
 
-    const oldOptions = oldEntry.length > 1 ? canonicalizeJson(oldEntry[1]) : undefined
-    const newOptions = newEntry.length > 1 ? canonicalizeJson(newEntry[1]) : undefined
+    const oldSerialized = JSON.stringify(oldVariants)
+    const newSerialized = JSON.stringify(newVariants)
+    if (oldSerialized === newSerialized) {
+      continue
+    }
 
-    if (oldEntry[0] === 'off' || newEntry[0] === 'off') {
+    const oldIsOnlyOff = oldVariants.every((entry) => entry[0] === 'off')
+    const newIsOnlyOff = newVariants.every((entry) => entry[0] === 'off')
+    if (oldIsOnlyOff || newIsOnlyOff) {
       // Treat off->off option removal/addition as removed/introduced config intent.
-      if (oldEntry[0] === 'off' && newEntry[0] === 'off') {
-        if (oldOptions !== undefined && newOptions === undefined) {
+      if (oldIsOnlyOff && newIsOnlyOff) {
+        const oldHasOptions = oldVariants.some((variant) => variant.length > 1)
+        const newHasOptions = newVariants.some((variant) => variant.length > 1)
+        if (oldHasOptions && !newHasOptions) {
+          removedRules.push(name)
+        } else if (!oldHasOptions && newHasOptions) {
+          introducedRules.push(name)
+        } else if (oldVariants.length > newVariants.length) {
           removedRules.push(name)
-        } else if (oldOptions === undefined && newOptions !== undefined) {
+        } else if (oldVariants.length < newVariants.length) {
           introducedRules.push(name)
+        } else {
+          optionChanges.push({
+            rule: name,
+            before: oldVariants,
+            after: newVariants
+          })
         }
       }
       continue
     }
 
-    if (JSON.stringify(oldOptions) !== JSON.stringify(newOptions)) {
-      optionChanges.push({
-        rule: name,
-        before: oldOptions,
-        after: newOptions
-      })
-    }
+    optionChanges.push({
+      rule: name,
+      before: oldVariants,
+      after: newVariants
+    })
   }
 
   const beforeWorkspaces = sortUnique(before.workspaces)
@@ -91,6 +111,20 @@ export function diffSnapshots(before: SnapshotFile, after: SnapshotFile): Snapsh
   }
 }
 
+function toVariants(entry: SnapshotRuleEntry): NormalizedRuleEntry[] {
+  if (!Array.isArray(entry[0])) {
+    return [canonicalizeJson(entry as NormalizedRuleEntry)]
+  }
+
+  return (entry as NormalizedRuleEntry[]).map((variant) => canonicalizeJson(variant))
+}
+
+function summarizeSeveritySet(variants: NormalizedRuleEntry[]): string {
+  const severityOrder: Array<'error' | 'warn' | 'off'> = ['error', 'warn', 'off']
+  const severities = new Set(variants.map((variant) => variant[0]))
+  return severityOrder.filter((severity) => severities.has(severity)).join('|')
+}
+
 export function hasDiff(diff: SnapshotDiff): boolean {
   return (
     diff.introducedRules.length > 0 ||

package/src/extract.ts

@@ -1,3 +1,4 @@
+import createDebug from 'debug'
 import { spawnSync } from 'node:child_process'
 import { existsSync, readFileSync } from 'node:fs'
 import { createRequire } from 'node:module'
@@ -6,6 +7,8 @@ import { pathToFileURL } from 'node:url'
 
 import { canonicalizeJson, normalizeSeverity } from './core.js'
 
+const debugExtract = createDebug('eslint-config-snapshot:extract')
+
 export type NormalizedRuleEntry = [severity: 'off' | 'warn' | 'error'] | [severity: 'off' | 'warn' | 'error', options: unknown]
 
 export type ExtractedWorkspaceRules = Map<string, NormalizedRuleEntry>
@@ -66,12 +69,17 @@ function findPackageRoot(entryAbs: string): string {
 
 export function extractRulesFromPrintConfig(workspaceAbs: string, fileAbs: string): ExtractedWorkspaceRules {
   const eslintBin = resolveEslintBinForWorkspace(workspaceAbs)
+  const commandArgs = [eslintBin, '--print-config', fileAbs]
+  const startedAt = Date.now()
+  debugExtract('spawn: cwd=%s cmd=%s %o', workspaceAbs, process.execPath, commandArgs)
   const proc = spawnSync(process.execPath, [eslintBin, '--print-config', fileAbs], {
     cwd: workspaceAbs,
     encoding: 'utf8'
   })
+  debugExtract('spawn: done status=%s elapsedMs=%d', String(proc.status), Date.now() - startedAt)
 
   if (proc.status !== 0) {
+    debugExtract('spawn: stderr=%s', proc.stderr.trim())
     throw new Error(`Failed to run eslint --print-config for ${fileAbs}`)
   }
 
@@ -112,6 +120,7 @@ export async function extractRulesForWorkspaceSamples(
   workspaceAbs: string,
   fileAbsList: string[]
 ): Promise<WorkspaceExtractionResult[]> {
+  debugExtract('workspace=%s sampleCount=%d', workspaceAbs, fileAbsList.length)
   const evaluate = await createWorkspaceEvaluator(workspaceAbs)
   const results: WorkspaceExtractionResult[] = []
 
@@ -121,10 +130,18 @@ export async function extractRulesForWorkspaceSamples(
       results.push({ fileAbs, rules })
     } catch (error: unknown) {
       const normalizedError = error instanceof Error ? error : new Error(String(error))
+      debugExtract('extract failed: workspace=%s file=%s error=%s', workspaceAbs, fileAbs, normalizedError.message)
       results.push({ fileAbs, error: normalizedError })
     }
   }
 
+  debugExtract(
+    'workspace=%s extracted=%d failed=%d',
+    workspaceAbs,
+    results.filter((entry) => entry.rules !== undefined).length,
+    results.filter((entry) => entry.error !== undefined).length
+  )
+
   return results
 }
 
@@ -142,6 +159,7 @@ async function createWorkspaceEvaluator(
 
     const ESLintClass = eslintModule.ESLint ?? eslintModule.default?.ESLint
     if (ESLintClass) {
+      debugExtract('workspace=%s evaluator=eslint-api', workspaceAbs)
       const eslint = new ESLintClass({ cwd: workspaceAbs })
       return async (fileAbs: string) => {
         const config = await eslint.calculateConfigForFile(fileAbs)
@@ -156,6 +174,7 @@ async function createWorkspaceEvaluator(
     // fall through to subprocess-based extractor
   }
 
+  debugExtract('workspace=%s evaluator=spawn-print-config', workspaceAbs)
   return (fileAbs: string) => Promise.resolve(extractRulesFromPrintConfig(workspaceAbs, fileAbs))
 }
 

package/src/index.ts

@@ -16,7 +16,7 @@ export {
 export type { ExtractedWorkspaceRules, NormalizedRuleEntry, WorkspaceExtractionResult } from './extract.js'
 
 export { aggregateRules, buildSnapshot, readSnapshotFile, writeSnapshotFile } from './snapshot.js'
-export type { SnapshotFile } from './snapshot.js'
+export type { SnapshotFile, SnapshotRuleEntry } from './snapshot.js'
 
 export { diffSnapshots, hasDiff } from './diff.js'
 export type { RuleOptionChange, RuleSeverityChange, SnapshotDiff, WorkspaceMembershipChange } from './diff.js'