knip 2.6.1 → 2.7.0

package/README.md

@@ -133,12 +133,12 @@ Using workspaces in a monorepo? Please see [workspaces][1] for more details abou
       --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)
       --dependencies           Shortcut for --include dependencies,unlisted,unresolved
       --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates
-      --no-progress            Don't show dynamic progress updates
+      -n, --no-progress        Don't show dynamic progress updates
       --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)
       --reporter-options       Pass extra options to the reporter (as JSON string, see example)
       --no-exit-code           Always exit with code zero (0)
       --max-issues             Maximum number of issues before non-zero exit code (default: 0)
-      --debug                  Show debug output
+      -d, --debug              Show debug output
       --debug-file-filter      Filter for files in debug output (regex as string)
       --performance            Measure count and running time of expensive functions and display stats table
       --h, --help              Print this help text

package/dist/ConfigurationChief.js

@@ -5,7 +5,7 @@ import { ROOT_WORKSPACE_NAME, DEFAULT_EXTENSIONS, KNIP_CONFIG_LOCATIONS } from '
 import { defaultRules } from './issues/initializers.js';
 import * as plugins from './plugins/index.js';
 import { arrayify, compact } from './util/array.js';
-import parsedArgs from './util/cli-arguments.js';
+import parsedArgValues from './util/cli-arguments.js';
 import { partitionCompilers } from './util/compilers.js';
 import { ConfigurationError } from './util/errors.js';
 import { findFile, loadJSON } from './util/fs.js';
@@ -16,7 +16,7 @@ import { getKeysByValue } from './util/object.js';
 import { join, relative, toPosix } from './util/path.js';
 import { toCamelCase } from './util/plugin.js';
 import { byPathDepth } from './util/workspace.js';
-const { config: rawConfigArg, workspace: rawWorkspaceArg, include = [], exclude = [], dependencies = false, exports = false, } = parsedArgs.values;
+const { config: rawConfigArg, workspace: rawWorkspaceArg, include = [], exclude = [], dependencies = false, exports = false, } = parsedArgValues;
 const workspaceArg = rawWorkspaceArg ? toPosix(rawWorkspaceArg).replace(/^\.\//, '').replace(/\/$/, '') : undefined;
 const getDefaultWorkspaceConfig = (extensions) => {
     const exts = [...DEFAULT_EXTENSIONS, ...(extensions ?? [])].map(ext => ext.slice(1)).join(',');
@@ -211,7 +211,7 @@ export class ConfigurationChief {
     getDescendentWorkspaces(name) {
         return this.getAllWorkspaces()
             .filter(workspaceName => workspaceName !== name)
-            .filter(workspaceName => name === ROOT_WORKSPACE_NAME || workspaceName.startsWith(name));
+            .filter(workspaceName => name === ROOT_WORKSPACE_NAME || workspaceName.startsWith(name + '/'));
     }
     getIgnoredWorkspaces() {
         const ignored = this.config.ignoreWorkspaces;

package/dist/cli.js

@@ -2,14 +2,14 @@
 import './util/register.js';
 import prettyMilliseconds from 'pretty-ms';
 import reporters from './reporters/index.js';
-import parsedArgs, { helpText } from './util/cli-arguments.js';
-import { isKnownError, ConfigurationError } from './util/errors.js';
+import parsedArgValues, { helpText } from './util/cli-arguments.js';
+import { isKnownError, getKnownError, isConfigurationError, hasCause } from './util/errors.js';
 import { _load } from './util/loader.js';
 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-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': isNoProgress = false, performance: isObservePerf = false, production: isProduction = false, reporter = 'symbols', 'reporter-options': reporterOptions = '', strict: isStrict = false, tsConfig, version: isVersion, } = parsedArgs.values;
+const { debug: isDebug = false, help: isHelp, 'max-issues': maxIssues = '0', 'no-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': isNoProgress = false, performance: isObservePerf = false, production: isProduction = false, reporter = 'symbols', 'reporter-options': reporterOptions = '', strict: isStrict = false, tsConfig, version: isVersion, } = parsedArgValues;
 if (isHelp) {
     console.log(helpText);
     process.exit(0);
@@ -47,10 +47,11 @@ const run = async () => {
     }
     catch (error) {
         if (error instanceof Error && isKnownError(error)) {
-            console.error(error.message);
-            if (error.cause instanceof Error)
-                console.error('Reason:', error.cause.message);
-            if (error instanceof ConfigurationError)
+            const knownError = getKnownError(error);
+            console.error(knownError.message);
+            if (hasCause(knownError))
+                console.error('Reason:', knownError.cause.message);
+            if (isConfigurationError(knownError))
                 console.log('\n' + helpText);
             process.exit(1);
         }

package/dist/plugins/eslint/fallback.d.ts

@@ -1,5 +1 @@
-type Options = {
-    cwd: string;
-};
-export declare const fallback: (configFilePath: string, { cwd }: Options) => Promise<string[]>;
-export {};
+export declare const fallback: (configFilePath: string) => any;

package/dist/plugins/eslint/fallback.js

@@ -1,19 +1,13 @@
-import { compact } from '../../util/array.js';
-import { resolvePluginPackageName, getDependenciesFromSettings } from './helpers.js';
-export const fallback = async (configFilePath, { cwd }) => {
-    const { ESLint } = await import('eslint');
-    const engine = new ESLint({ cwd, overrideConfigFile: configFilePath, useEslintrc: false });
-    const jsConfig = await engine.calculateConfigForFile('__placeholder__.js');
-    const tsConfig = await engine.calculateConfigForFile('__placeholder__.ts');
-    const tsxConfig = await engine.calculateConfigForFile('__placeholder__.tsx');
-    const dependencies = [jsConfig, tsConfig, tsxConfig].map(config => {
-        if (!config)
-            return [];
-        const plugins = config.plugins?.map(resolvePluginPackageName) ?? [];
-        const parsers = config.parser ? [config.parser] : [];
-        const extraParsers = config.parserOptions?.babelOptions?.presets ?? [];
-        const settings = config.settings ? getDependenciesFromSettings(config.settings) : [];
-        return [...parsers, ...extraParsers, ...plugins, ...settings];
-    });
-    return compact(dependencies.flat());
-};
+import createJITI from 'jiti';
+import transform from 'jiti/dist/babel.js';
+import { timerify } from '../../util/Performance.js';
+const rushstackMatch = /require\(("|')@rushstack\/(eslint-config\/patch|eslint-patch)\/modern-module-resolution("|')\)/;
+const jiti = createJITI(process.cwd(), {
+    cache: false,
+    transform: (opts) => {
+        opts.source = opts.source.replace(rushstackMatch, '');
+        return transform(opts);
+    },
+});
+const load = (configFilePath) => jiti(configFilePath);
+export const fallback = timerify(load);

package/dist/plugins/eslint/helpers.d.ts

@@ -8,6 +8,4 @@ type GetDependenciesDeep = (configFilePath: string, dependencies: Set<string>, o
     manifest: Manifest;
 }) => Promise<Set<string>>;
 export declare const getDependenciesDeep: GetDependenciesDeep;
-export declare const resolvePluginPackageName: (pluginName: string) => string;
-export declare const getDependenciesFromSettings: (settings?: ESLintConfig['settings']) => string[];
 export {};

package/dist/plugins/eslint/helpers.js

@@ -6,8 +6,6 @@ import { _resolve } from '../../util/require.js';
 import { fallback } from './fallback.js';
 const getDependencies = (config) => {
     const extendsSpecifiers = config.extends ? [config.extends].flat().map(resolveExtendsSpecifier) : [];
-    if (extendsSpecifiers.includes('eslint-plugin-prettier'))
-        extendsSpecifiers.push('eslint-config-prettier');
     const plugins = config.plugins ? config.plugins.map(resolvePluginPackageName) : [];
     const parser = config.parser;
     const extraParsers = config.parserOptions?.babelOptions?.presets ?? [];
@@ -17,21 +15,11 @@ const getDependencies = (config) => {
 };
 export const getDependenciesDeep = async (configFilePath, dependencies = new Set(), options) => {
     const addAll = (deps) => deps.forEach(dependency => dependencies.add(dependency));
-    let config = configFilePath.endsWith('package.json') ? options.manifest.eslintConfig : undefined;
-    if (!config) {
-        try {
-            config = await load(configFilePath);
-        }
-        catch (err) {
-            if (err instanceof Error && err.cause instanceof Error && /Failed to patch ESLint/.test(err.cause.message)) {
-                const dependencies = await fallback(configFilePath, options);
-                addAll(dependencies);
-            }
-            else {
-                throw err;
-            }
-        }
-    }
+    const config = configFilePath.endsWith('package.json')
+        ? options.manifest.eslintConfig
+        : /(\.(jsonc?|ya?ml)|rc)$/.test(configFilePath)
+            ? await load(configFilePath)
+            : await fallback(configFilePath);
     if (config) {
         if (config.extends) {
             for (const extend of [config.extends].flat()) {
@@ -48,7 +36,7 @@ export const getDependenciesDeep = async (configFilePath, dependencies = new Set
     return dependencies;
 };
 const resolvePackageName = (namespace, pluginName) => {
-    return pluginName.includes(namespace + '-')
+    return pluginName.includes(namespace + '-') || pluginName.endsWith(`/${namespace}`)
         ? pluginName
         : pluginName.startsWith('@')
             ? pluginName.includes('/')
@@ -56,7 +44,7 @@ const resolvePackageName = (namespace, pluginName) => {
                 : `${pluginName}/${namespace}`
             : `${namespace}-${pluginName}`;
 };
-export const resolvePluginPackageName = (pluginName) => resolvePackageName('eslint-plugin', pluginName);
+const resolvePluginPackageName = (pluginName) => resolvePackageName('eslint-plugin', pluginName);
 const resolveExtendsSpecifier = (specifier) => {
     if (isInternal(specifier))
         return;
@@ -80,7 +68,7 @@ const getImportPluginDependencies = (settings) => {
         .filter(key => key !== 'node')
         .map(key => (knownKeys.includes(key) ? `eslint-import-resolver-${key}` : key));
 };
-export const getDependenciesFromSettings = (settings = {}) => {
+const getDependenciesFromSettings = (settings = {}) => {
     return compact(Object.entries(settings).reduce((packageNames, [settingKey, settings]) => {
         if (/^import\/(parsers|resolvers)?/.test(settingKey) && typeof settings !== 'string') {
             return [...packageNames, ...getImportPluginDependencies(settings)];

package/dist/util/Performance.js

@@ -1,8 +1,8 @@
 import { performance, PerformanceObserver } from 'node:perf_hooks';
 import EasyTable from 'easy-table';
 import Summary from 'summary';
-import parsedArgs from './cli-arguments.js';
-const { performance: isEnabled = false } = parsedArgs.values;
+import parsedArgValues from './cli-arguments.js';
+const { performance: isEnabled = false } = parsedArgValues;
 export const timerify = fn => (isEnabled ? performance.timerify(fn) : fn);
 export class Performance {
     isEnabled;

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

@@ -1,27 +1,24 @@
-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              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  --no-progress            Don't show dynamic progress updates\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-exit-code           Always exit with code zero (0)\n  --max-issues             Maximum number of issues before non-zero exit code (default: 0)\n  --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              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  -n, --no-progress        Don't show dynamic progress updates\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-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: {
-    values: {
-        config: string | undefined;
-        debug: boolean | undefined;
-        'debug-file-filter': string | undefined;
-        dependencies: boolean | undefined;
-        exclude: string[] | undefined;
-        exports: boolean | undefined;
-        help: boolean | undefined;
-        include: string[] | undefined;
-        'max-issues': string | undefined;
-        'no-exit-code': boolean | undefined;
-        'no-gitignore': boolean | undefined;
-        'no-progress': boolean | undefined;
-        performance: boolean | undefined;
-        production: boolean | undefined;
-        reporter: string | undefined;
-        'reporter-options': string | undefined;
-        strict: boolean | undefined;
-        tsConfig: string | undefined;
-        version: boolean | undefined;
-        workspace: string | undefined;
-    };
-    positionals: [];
+    config: string | undefined;
+    debug: boolean | undefined;
+    'debug-file-filter': string | undefined;
+    dependencies: boolean | undefined;
+    exclude: string[] | undefined;
+    exports: boolean | undefined;
+    help: boolean | undefined;
+    include: string[] | undefined;
+    'max-issues': string | undefined;
+    'no-exit-code': boolean | undefined;
+    'no-gitignore': boolean | undefined;
+    'no-progress': boolean | undefined;
+    performance: boolean | undefined;
+    production: boolean | undefined;
+    reporter: string | undefined;
+    'reporter-options': string | undefined;
+    strict: boolean | undefined;
+    tsConfig: string | undefined;
+    version: boolean | undefined;
+    workspace: string | undefined;
 };
 export default _default;

package/dist/util/cli-arguments.js

@@ -14,12 +14,12 @@ Options:
   --exclude                Exclude provided issue type(s) from report, can be comma-separated or repeated (1)
   --dependencies           Shortcut for --include dependencies,unlisted,unresolved
   --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates
-  --no-progress            Don't show dynamic progress updates
+  -n, --no-progress        Don't show dynamic progress updates
   --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)
   --reporter-options       Pass extra options to the reporter (as JSON string, see example)
   --no-exit-code           Always exit with code zero (0)
   --max-issues             Maximum number of issues before non-zero exit code (default: 0)
-  --debug                  Show debug output
+  -d, --debug              Show debug output
   --debug-file-filter      Filter for files in debug output (regex as string)
   --performance            Measure count and running time of expensive functions and display stats table
   --h, --help              Print this help text
@@ -37,27 +37,39 @@ $ knip --reporter codeowners --reporter-options '{"path":".github/CODEOWNERS"}'
 $ knip --debug --debug-file-filter '(specific|particular)-module'
 
 More documentation and bug reports: https://github.com/webpro/knip`;
-export default parseArgs({
-    options: {
-        config: { type: 'string', short: 'c' },
-        debug: { type: 'boolean' },
-        'debug-file-filter': { type: 'string' },
-        dependencies: { type: 'boolean' },
-        exclude: { type: 'string', multiple: true },
-        exports: { type: 'boolean' },
-        help: { type: 'boolean', short: 'h' },
-        include: { type: 'string', multiple: true },
-        'max-issues': { type: 'string' },
-        'no-exit-code': { type: 'boolean' },
-        'no-gitignore': { type: 'boolean' },
-        'no-progress': { type: 'boolean' },
-        performance: { type: 'boolean' },
-        production: { type: 'boolean' },
-        reporter: { type: 'string' },
-        'reporter-options': { type: 'string' },
-        strict: { type: 'boolean' },
-        tsConfig: { type: 'string', short: 't' },
-        version: { type: 'boolean', short: 'V' },
-        workspace: { type: 'string' },
-    },
-});
+let parsedArgs;
+try {
+    parsedArgs = parseArgs({
+        options: {
+            config: { type: 'string', short: 'c' },
+            debug: { type: 'boolean', short: 'd' },
+            'debug-file-filter': { type: 'string' },
+            dependencies: { type: 'boolean' },
+            exclude: { type: 'string', multiple: true },
+            exports: { type: 'boolean' },
+            help: { type: 'boolean', short: 'h' },
+            include: { type: 'string', multiple: true },
+            'max-issues': { type: 'string' },
+            'no-exit-code': { type: 'boolean' },
+            'no-gitignore': { type: 'boolean' },
+            'no-progress': { type: 'boolean', short: 'n' },
+            performance: { type: 'boolean' },
+            production: { type: 'boolean' },
+            reporter: { type: 'string' },
+            'reporter-options': { type: 'string' },
+            strict: { type: 'boolean' },
+            tsConfig: { type: 'string', short: 't' },
+            version: { type: 'boolean', short: 'V' },
+            workspace: { type: 'string' },
+        },
+    });
+}
+catch (error) {
+    if (error instanceof Error) {
+        console.error(error.message);
+        console.log('\n' + helpText);
+        process.exit(1);
+    }
+    throw error;
+}
+export default parsedArgs.values;

package/dist/util/debug.js

@@ -1,6 +1,6 @@
 import util from 'node:util';
-import parsedArgs from './cli-arguments.js';
-const { debug, 'debug-file-filter': debugFileFilter } = parsedArgs.values;
+import parsedArgValues from './cli-arguments.js';
+const { debug, 'debug-file-filter': debugFileFilter } = parsedArgValues;
 const IS_ENABLED = debug ?? false;
 const FILE_FILTER = debugFileFilter;
 const inspectOptions = { maxArrayLength: null, depth: null, colors: true };

package/dist/util/errors.d.ts

@@ -1,5 +1,12 @@
+interface ErrorWithCause extends Error {
+    cause: Error;
+}
 export declare class ConfigurationError extends Error {
 }
 export declare class LoaderError extends Error {
 }
 export declare const isKnownError: (error: Error) => boolean;
+export declare const hasCause: (error: Error) => error is ErrorWithCause;
+export declare const isConfigurationError: (error: Error) => boolean;
+export declare const getKnownError: (error: Error) => Error;
+export {};

package/dist/util/errors.js

@@ -1,5 +1,14 @@
+import { ZodError } from 'zod';
+import { fromZodError } from 'zod-validation-error';
 export class ConfigurationError extends Error {
 }
 export class LoaderError extends Error {
 }
-export const isKnownError = (error) => error instanceof ConfigurationError || error instanceof LoaderError;
+export const isKnownError = (error) => error instanceof ConfigurationError || error instanceof LoaderError || error instanceof ZodError;
+export const hasCause = (error) => error.cause instanceof Error;
+export const isConfigurationError = (error) => error instanceof ConfigurationError;
+export const getKnownError = (error) => {
+    if (error instanceof ZodError)
+        return fromZodError(error);
+    return error;
+};

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.6.1";
+export declare const version = "2.7.0";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.6.1';
+export const version = '2.7.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "2.6.1",
+  "version": "2.7.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",
@@ -56,7 +56,8 @@
     "strip-json-comments": "^5.0.0",
     "summary": "^2.1.0",
     "typescript": "^5.0.2",
-    "zod": "^3.20.6"
+    "zod": "^3.20.6",
+    "zod-validation-error": "1.2.1"
   },
   "devDependencies": {
     "@jest/types": "29.5.0",