Apply fixes after running preprocessors (#763 #1420)

Author: webpro

packages/knip/src/IssueFixer.ts

@@ -1,12 +1,27 @@
 import { readFile, rm, writeFile } from 'node:fs/promises';
+import { formatly } from 'formatly';
 import type { Fixes } from './types/exports.js';
 import type { Issue, Issues } from './types/issues.js';
 import { DEFAULT_CATALOG } from './util/catalog.js';
 import type { MainOptions } from './util/create-options.js';
+import { debugLogArray, debugLogObject } from './util/debug.js';
 import { load, save } from './util/package-json.js';
 import { extname, join } from './util/path.js';
 import { removeExport } from './util/remove-export.js';
 
+export const fix = async (issues: Issues, options: MainOptions) => {
+  const fixer = new IssueFixer(options);
+  const touchedFiles = await fixer.fixIssues(issues);
+  if (options.isFormat) {
+    const report = await formatly(Array.from(touchedFiles));
+    if (report.ran && report.result && (report.result.runner === 'virtual' || report.result.code === 0)) {
+      debugLogArray('*', `Formatted files using ${report.formatter.name} (${report.formatter.runner})`, touchedFiles);
+    } else {
+      debugLogObject('*', 'Formatting files failed', report);
+    }
+  }
+};
+
 export class IssueFixer {
   options: MainOptions;
 

packages/knip/src/cli.ts

@@ -1,5 +1,6 @@
 // biome-ignore-all lint/suspicious/noConsole: ignore
-import { main } from './index.js';
+import { fix } from './IssueFixer.js';
+import { run } from './run.js';
 import type { IssueType, ReporterOptions } from './types/issues.js';
 import parseArgs, { helpText } from './util/cli-arguments.js';
 import { createOptions } from './util/create-options.js';
@@ -22,7 +23,7 @@ try {
   throw error;
 }
 
-const run = async () => {
+const main = async () => {
   try {
     if (args.help) {
       console.log(helpText);
@@ -36,8 +37,9 @@ const run = async () => {
 
     const options = await createOptions({ args });
 
-    const { issues, counters, tagHints, configurationHints, includedWorkspaceDirs, enabledPlugins } =
-      await main(options);
+    const { results } = await run(options);
+
+    const { issues, counters, tagHints, configurationHints, includedWorkspaceDirs, enabledPlugins } = results;
 
     // These modes have their own reporting mechanism
     if (options.isWatch || options.isTrace) return;
@@ -63,6 +65,8 @@ const run = async () => {
 
     const finalData = await runPreprocessors(args.preprocessor ?? [], initialData);
 
+    if (options.isFix) await fix(finalData.issues, options);
+
     await runReporters(args.reporter ?? ['symbols'], finalData);
 
     const totalErrorCount = (Object.keys(finalData.report) as IssueType[])
@@ -110,4 +114,4 @@ const run = async () => {
   process.exit(0);
 };
 
-await run();
+await main();

packages/knip/src/graph/analyze.ts

@@ -5,7 +5,6 @@ import type { DependencyDeputy } from '../DependencyDeputy.js';
 import { createGraphExplorer } from '../graph-explorer/explorer.js';
 import { getIssueType, hasStrictlyEnumReferences } from '../graph-explorer/utils.js';
 import type { IssueCollector } from '../IssueCollector.js';
-import type { IssueFixer } from '../IssueFixer.js';
 import type { PrincipalFactory } from '../PrincipalFactory.js';
 import traceReporter from '../reporters/trace.js';
 import type { Export, ExportMember, ModuleGraph } from '../types/module-graph.js';
@@ -22,7 +21,6 @@ interface AnalyzeOptions {
   deputy: DependencyDeputy;
   entryPaths: Set<string>;
   factory: PrincipalFactory;
-  fixer: IssueFixer;
   graph: ModuleGraph;
   streamer: ConsoleStreamer;
   unreferencedFiles: Set<string>;

packages/knip/src/index.ts

@@ -1,4 +1,9 @@
+import { fix } from './IssueFixer.js';
 import { run } from './run.js';
 import type { MainOptions } from './util/create-options.js';
 
-export const main = async (options: MainOptions) => (await run(options)).results;
+export const main = async (options: MainOptions) => {
+  const { results } = await run(options);
+  if (options.isFix) await fix(results.issues, options);
+  return results;
+};

packages/knip/src/run.ts

@@ -1,17 +1,15 @@
 import { watch } from 'node:fs';
-import { formatly } from 'formatly';
 import { CatalogCounselor } from './CatalogCounselor.js';
 import { ConfigurationChief } from './ConfigurationChief.js';
 import { ConsoleStreamer } from './ConsoleStreamer.js';
 import { DependencyDeputy } from './DependencyDeputy.js';
 import { analyze } from './graph/analyze.js';
 import { build } from './graph/build.js';
 import { IssueCollector } from './IssueCollector.js';
-import { IssueFixer } from './IssueFixer.js';
 import { PrincipalFactory } from './PrincipalFactory.js';
 import watchReporter from './reporters/watch.js';
 import type { MainOptions } from './util/create-options.js';
-import { debugLogArray, debugLogObject } from './util/debug.js';
+import { debugLogObject } from './util/debug.js';
 import { getGitIgnoredHandler } from './util/glob-core.js';
 import { getSessionHandler, type OnFileChange, type SessionHandler } from './util/watch.js';
 
@@ -25,7 +23,6 @@ export const run = async (options: MainOptions) => {
   const deputy = new DependencyDeputy(options);
   const factory = new PrincipalFactory();
   const streamer = new ConsoleStreamer(options);
-  const fixer = new IssueFixer(options);
   const collector = new IssueCollector(options);
   const counselor = new CatalogCounselor(options);
 
@@ -61,7 +58,6 @@ export const run = async (options: MainOptions) => {
     deputy,
     entryPaths,
     factory,
-    fixer,
     graph,
     streamer,
     unreferencedFiles,
@@ -99,18 +95,6 @@ export const run = async (options: MainOptions) => {
 
   const { issues, counters, tagHints, configurationHints } = collector.getIssues();
 
-  if (options.isFix && !options.isSession) {
-    const touchedFiles = await fixer.fixIssues(issues);
-    if (options.isFormat) {
-      const report = await formatly(Array.from(touchedFiles));
-      if (report.ran && report.result && (report.result.runner === 'virtual' || report.result.code === 0)) {
-        debugLogArray('*', `Formatted files using ${report.formatter.name} (${report.formatter.runner})`, touchedFiles);
-      } else {
-        debugLogObject('*', 'Formatting files failed', report);
-      }
-    }
-  }
-
   if (!options.isWatch) streamer.clear();
 
   return {