knip 2.19.5 → 2.20.0-preprocess.0

package/README.md

@@ -637,7 +637,8 @@ for false positives, and how to handle them.
       --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates
       --include-entry-exports  Include entry files when reporting unused exports
       -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)
-      --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)
+      --preprocessor           Preprocess the results before providing it to the reporter(s), can be repeated
+      --reporter               Select reporter: symbols, compact, codeowners, json, can be repeated (default: symbols)
       --reporter-options       Pass extra options to the reporter (as JSON string, see example)
       --no-config-hints        Suppress configuration hints
       --no-exit-code           Always exit with code zero (0)

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import './util/register.js';
 import prettyMilliseconds from 'pretty-ms';
-import reporters from './reporters/index.js';
+import internalReporters from './reporters/index.js';
 import parsedArgValues, { helpText } from './util/cli-arguments.js';
 import { isKnownError, getKnownError, isConfigurationError, hasCause } from './util/errors.js';
 import { _load } from './util/loader.js';
@@ -9,7 +9,7 @@ import { cwd, resolve } from './util/path.js';
 import { Performance } from './util/Performance.js';
 import { version } from './version.js';
 import { main } from './index.js';
-const { debug: isDebug = false, help: isHelp, 'max-issues': maxIssues = '0', 'no-config-hints': noConfigHints = false, 'no-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': isNoProgress = false, 'include-entry-exports': isIncludeEntryExports = false, performance: isObservePerf = false, production: isProduction = false, reporter = 'symbols', 'reporter-options': reporterOptions = '', strict: isStrict = false, tsConfig, version: isVersion, } = parsedArgValues;
+const { debug: isDebug = false, help: isHelp, 'max-issues': maxIssues = '0', 'no-config-hints': noConfigHints = false, 'no-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': isNoProgress = false, 'include-entry-exports': isIncludeEntryExports = false, performance: isObservePerf = false, production: isProduction = false, preprocessor = [], reporter = ['symbols'], 'reporter-options': reporterOptions = '', strict: isStrict = false, tsConfig, version: isVersion, } = parsedArgValues;
 if (isHelp) {
     console.log(helpText);
     process.exit(0);
@@ -19,7 +19,13 @@ if (isVersion) {
     process.exit(0);
 }
 const isShowProgress = !isDebug && isNoProgress === false && process.stdout.isTTY && typeof process.stdout.cursorTo === 'function';
-const printReport = reporter in reporters ? reporters[reporter] : await _load(resolve(reporter));
+const preprocessors = await Promise.all(preprocessor.map(processor => _load(resolve(processor))));
+const processAsync = (data, processors) => processors.length === 0 ? Promise.resolve(data) : processAsync(processors[0](data), processors.slice(1));
+const reporters = await Promise.all(reporter.map(async (reporter) => {
+    return reporter in internalReporters
+        ? internalReporters[reporter]
+        : await _load(resolve(reporter));
+}));
 const run = async () => {
     try {
         const perfObserver = new Performance(isObservePerf);
@@ -32,7 +38,7 @@ const run = async () => {
             isShowProgress,
             isIncludeEntryExports,
         });
-        await printReport({
+        const initialData = {
             report,
             issues,
             configurationHints,
@@ -41,7 +47,10 @@ const run = async () => {
             isProduction,
             isShowProgress,
             options: reporterOptions,
-        });
+        };
+        const finalData = await processAsync(initialData, preprocessors);
+        for (const reporter of reporters)
+            await reporter(finalData);
         const totalErrorCount = Object.keys(report)
             .filter(reportGroup => report[reportGroup] && rules[reportGroup] === 'error')
             .reduce((errorCount, reportGroup) => errorCount + counters[reportGroup], 0);

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import type { CommandLineOptions } from './types/cli.js';
 export type { RawConfiguration as KnipConfig } from './types/config.js';
-export type { Reporter, ReporterOptions } from './types/issues.js';
+export type { Preprocessor, Reporter, ReporterOptions } from './types/issues.js';
 export declare const main: (unresolvedConfiguration: CommandLineOptions) => Promise<{
     report: import("./types/issues.js").Report;
     issues: import("./types/issues.js").Issues;

package/dist/types/issues.d.ts

@@ -45,12 +45,12 @@ export type ReporterOptions = {
     configurationHints: ConfigurationHints;
     noConfigHints: boolean;
     cwd: string;
-    workingDir: string;
     isProduction: boolean;
     isShowProgress: boolean;
     options: string;
 };
 export type Reporter = (options: ReporterOptions) => void;
+export type Preprocessor = (options: ReporterOptions) => ReporterOptions;
 export type IssueSeverity = 'error' | 'warn' | 'off';
 export type Rules = Record<IssueType, IssueSeverity>;
 export type ConfigurationHints = Set<ConfigurationHint>;

package/dist/util/cli-arguments.d.ts

@@ -1,4 +1,4 @@
-export declare const helpText = "\u2702\uFE0F  Find unused files, dependencies and exports in your JavaScript and TypeScript projects\n\nUsage: knip [options]\n\nOptions:\n  -c, --config [file]      Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)\n  -t, --tsConfig [file]    TypeScript configuration path (default: tsconfig.json)\n  --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)\n  --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)\n  --workspace [dir]        Analyze a single workspace (default: analyze all configured workspaces)\n  --no-gitignore           Don't use .gitignore\n  --include                Report only provided issue type(s), can be comma-separated or repeated (1)\n  --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)\n  --dependencies           Shortcut for --include dependencies,unlisted,unresolved\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\n  --include-entry-exports  Include entry files when reporting unused exports\n  -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)\n  --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)\n  --reporter-options       Pass extra options to the reporter (as JSON string, see example)\n  --no-config-hints        Suppress configuration hints\n  --no-exit-code           Always exit with code zero (0)\n  --max-issues             Maximum number of issues before non-zero exit code (default: 0)\n  -d, --debug              Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure count and running time of expensive functions and display stats table\n  -h, --help               Print this help text\n  -V, --version            Print version\n\n(1) Issue types: files, dependencies, unlisted, unresolved, exports, nsExports, classMembers, types, nsTypes, enumMembers, duplicates\n\nExamples:\n\n$ knip\n$ knip --production\n$ knip --workspace packages/client --include files,dependencies\n$ knip -c ./config/knip.json --reporter compact\n$ knip --reporter codeowners --reporter-options '{\"path\":\".github/CODEOWNERS\"}'\n$ knip --debug --debug-file-filter '(specific|particular)-module'\n\nMore documentation and bug reports: https://github.com/webpro/knip";
+export declare const helpText = "\u2702\uFE0F  Find unused files, dependencies and exports in your JavaScript and TypeScript projects\n\nUsage: knip [options]\n\nOptions:\n  -c, --config [file]      Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)\n  -t, --tsConfig [file]    TypeScript configuration path (default: tsconfig.json)\n  --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)\n  --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)\n  --workspace [dir]        Analyze a single workspace (default: analyze all configured workspaces)\n  --no-gitignore           Don't use .gitignore\n  --include                Report only provided issue type(s), can be comma-separated or repeated (1)\n  --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)\n  --dependencies           Shortcut for --include dependencies,unlisted,unresolved\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\n  --include-entry-exports  Include entry files when reporting unused exports\n  -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)\n  --preprocessor           Preprocess the results before providing it to the reporter(s), can be repeated\n  --reporter               Select reporter: symbols, compact, codeowners, json, can be repeated (default: symbols)\n  --reporter-options       Pass extra options to the reporter (as JSON string, see example)\n  --no-config-hints        Suppress configuration hints\n  --no-exit-code           Always exit with code zero (0)\n  --max-issues             Maximum number of issues before non-zero exit code (default: 0)\n  -d, --debug              Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure count and running time of expensive functions and display stats table\n  -h, --help               Print this help text\n  -V, --version            Print version\n\n(1) Issue types: files, dependencies, unlisted, unresolved, exports, nsExports, classMembers, types, nsTypes, enumMembers, duplicates\n\nExamples:\n\n$ knip\n$ knip --production\n$ knip --workspace packages/client --include files,dependencies\n$ knip -c ./config/knip.json --reporter compact\n$ knip --reporter codeowners --reporter-options '{\"path\":\".github/CODEOWNERS\"}'\n$ knip --debug --debug-file-filter '(specific|particular)-module'\n\nMore documentation and bug reports: https://github.com/webpro/knip";
 declare const _default: {
     config: string | undefined;
     debug: boolean | undefined;
@@ -16,7 +16,8 @@ declare const _default: {
     'no-progress': boolean | undefined;
     performance: boolean | undefined;
     production: boolean | undefined;
-    reporter: string | undefined;
+    preprocessor: string[] | undefined;
+    reporter: string[] | undefined;
     'reporter-options': string | undefined;
     strict: boolean | undefined;
     tsConfig: string | undefined;

package/dist/util/cli-arguments.js

@@ -16,7 +16,8 @@ Options:
   --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates
   --include-entry-exports  Include entry files when reporting unused exports
   -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)
-  --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)
+  --preprocessor           Preprocess the results before providing it to the reporter(s), can be repeated
+  --reporter               Select reporter: symbols, compact, codeowners, json, can be repeated (default: symbols)
   --reporter-options       Pass extra options to the reporter (as JSON string, see example)
   --no-config-hints        Suppress configuration hints
   --no-exit-code           Always exit with code zero (0)
@@ -59,7 +60,8 @@ try {
             'no-progress': { type: 'boolean', short: 'n' },
             performance: { type: 'boolean' },
             production: { type: 'boolean' },
-            reporter: { type: 'string' },
+            preprocessor: { type: 'string', multiple: true },
+            reporter: { type: 'string', multiple: true },
             'reporter-options': { type: 'string' },
             strict: { type: 'boolean' },
             tsConfig: { type: 'string', short: 't' },

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.19.5";
+export declare const version = "2.20.0-preprocess.0";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.19.5';
+export const version = '2.20.0-preprocess.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "2.19.5",
+  "version": "2.20.0-preprocess.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",