knip 2.18.0 → 2.19.0

package/README.md

@@ -136,14 +136,14 @@ Using workspaces in a monorepo? Please see [workspaces][1] for more details abou
       -t, --tsConfig [file]    TypeScript configuration path (default: tsconfig.json)
       --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)
       --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)
-      --workspace              Analyze a single workspace (default: analyze all configured workspaces)
+      --workspace [dir]        Analyze a single workspace (default: analyze all configured workspaces)
       --no-gitignore           Don't use .gitignore
       --include                Report only provided issue type(s), can be comma-separated or repeated (1)
       --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
       --include-entry-exports  Include entry files when reporting unused exports
-      -n, --no-progress        Don't show dynamic progress updates (this is automatically enabled in CI environments)
+      -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)
       --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)
       --reporter-options       Pass extra options to the reporter (as JSON string, see example)
       --no-config-hints        Suppress configuration hints
@@ -330,9 +330,10 @@ Knip supports workspaces as defined in three possible locations:
 - In the `workspaces` array in `package.json` (npm, Yarn, Lerna).
 - In the `workspaces.packages` array in `package.json` (legacy).
 - In the `packages` array in `pnpm-workspace.yaml` (pnpm).
+- In the `workspaces` object in Knip configuration.
 
-Extra "workspaces" not configured as a workspace in the root `package.json` can be configured as well, Knip is happy to
-analyze unused dependencies and exports from any directory with a `package.json`.
+The `workspaces` in Knip configuration not already defined in the root `package.json` or `pnpm-workspace.yaml` are
+added. Knip requires a `package.json` file in each workspace directory.
 
 The `ignore`, `ignoreBinaries` and `ignoreDependencies` options are available inside workspace configurations.
 
@@ -342,6 +343,8 @@ Here's some example output when running Knip in a workspace:
 
 Use `--debug` to get more verbose output.
 
+Use `--workspace [dir]` to analyze a single workspace (including its ancestors).
+
 ## Plugins
 
 Plugins tell Knip where to look for configuration and entry files, and if necessary have a custom dependency finder.

package/dist/ConfigurationChief.js

@@ -1,3 +1,4 @@
+import { existsSync } from 'node:fs';
 import mapWorkspaces from '@npmcli/map-workspaces';
 import micromatch from 'micromatch';
 import { ConfigurationValidator } from './ConfigurationValidator.js';
@@ -214,6 +215,9 @@ export class ConfigurationChief {
         return [ROOT_WORKSPACE_NAME, ...this.manifestWorkspaces.keys(), ...this.additionalWorkspaceNames].filter(name => !micromatch.isMatch(name, this.ignoredWorkspacePatterns));
     }
     getEnabledWorkspaces() {
+        if (workspaceArg && !existsSync(workspaceArg)) {
+            throw new ConfigurationError(`Directory does not exist: ${workspaceArg}`);
+        }
         const workspaceNames = workspaceArg
             ? this.enabledWorkspaceNames.filter(name => name === workspaceArg)
             : this.enabledWorkspaceNames;

package/dist/DependencyDeputy.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="npmcli__package-json" />
-import { Workspace } from './ConfigurationChief.js';
+import type { Workspace } from './ConfigurationChief.js';
 import type { ConfigurationHints, Issue } from './types/issues.js';
 import type { WorkspaceManifests } from './types/workspace.js';
 import type { PeerDependencies, InstalledBinaries } from './types/workspace.js';

package/dist/PrincipalFactory.js

@@ -1,3 +1,4 @@
+import ts from 'typescript';
 import { ProjectPrincipal } from './ProjectPrincipal.js';
 import { toAbsolute } from './util/path.js';
 const mergePaths = (cwd, compilerOptions, paths = {}) => {

package/dist/ProjectPrincipal.js

@@ -4,6 +4,7 @@ import { IGNORED_FILE_EXTENSIONS } from './constants.js';
 import { isInModuleBlock } from './typescript/ast-helpers.js';
 import { createHosts } from './typescript/createHosts.js';
 import { getImportsAndExports } from './typescript/getImportsAndExports.js';
+import { SourceFileManager } from './typescript/SourceFileManager.js';
 import { isMaybePackageName } from './util/modules.js';
 import { extname, isInNodeModules } from './util/path.js';
 import { timerify } from './util/Performance.js';

package/dist/WorkspaceWorker.d.ts

@@ -1,6 +1,6 @@
-import { PackageJsonWithPlugins } from './types/plugins.js';
-import { InstalledBinaries, PeerDependencies } from './types/workspace.js';
 import type { Configuration, PluginName, WorkspaceConfiguration } from './types/config.js';
+import type { PackageJsonWithPlugins } from './types/plugins.js';
+import type { InstalledBinaries, PeerDependencies } from './types/workspace.js';
 type WorkspaceManagerOptions = {
     name: string;
     dir: string;

package/dist/constants.d.ts

@@ -3,6 +3,7 @@ export declare const ROOT_WORKSPACE_NAME = ".";
 export declare const KNIP_CONFIG_LOCATIONS: string[];
 export declare const DEFAULT_EXTENSIONS: string[];
 export declare const TEST_FILE_PATTERNS: string[];
+export declare const GLOBAL_IGNORE_PATTERNS: string[];
 export declare const IGNORED_GLOBAL_BINARIES: string[];
 export declare const IGNORED_DEPENDENCIES: string[];
 export declare const IGNORED_FILE_EXTENSIONS: string[];

package/dist/constants.js

@@ -5,6 +5,7 @@ export const TEST_FILE_PATTERNS = [
     '**/*{.,-}{test,spec}.{js,jsx,ts,tsx,mjs,cjs}',
     '**/{test,__tests__}/**/*.{js,jsx,ts,tsx,mjs,cjs}',
 ];
+export const GLOBAL_IGNORE_PATTERNS = ['**/node_modules/**', '.yarn'];
 export const IGNORED_GLOBAL_BINARIES = [
     'bash',
     'bun',

package/dist/index.js

@@ -7,6 +7,7 @@ import { ROOT_WORKSPACE_NAME } from './constants.js';
 import { DependencyDeputy } from './DependencyDeputy.js';
 import { IssueCollector } from './IssueCollector.js';
 import { PrincipalFactory } from './PrincipalFactory.js';
+import { ProjectPrincipal } from './ProjectPrincipal.js';
 import { compact } from './util/array.js';
 import { debugLogObject, debugLogArray, debugLog } from './util/debug.js';
 import { LoaderError } from './util/errors.js';

package/dist/issues/initializers.d.ts

@@ -1,4 +1,4 @@
-import { Issues, Counters, Rules } from '../types/issues.js';
+import type { Issues, Counters, Rules } from '../types/issues.js';
 export declare const initIssues: () => Issues;
 export declare const initCounters: () => Counters;
 export declare const defaultRules: Rules;

package/dist/manifest/index.js

@@ -20,7 +20,8 @@ const findManifestDependencies = async ({ manifest, isProduction, isStrict, dir,
     for (const packageName of packageNames) {
         const manifest = await getPackageManifest({ dir, packageName, cwd });
         if (manifest) {
-            const binaries = typeof manifest.bin === 'string' ? [packageName] : Object.keys(manifest.bin ?? {});
+            const binaryName = packageName.replace(/^@[^/]+\//, '');
+            const binaries = typeof manifest.bin === 'string' ? [binaryName] : Object.keys(manifest.bin ?? {});
             binaries.forEach(binaryName => {
                 if (installedBinaries.has(binaryName)) {
                     installedBinaries.get(binaryName)?.add(packageName);

package/dist/plugins/babel/types.js

@@ -1 +1 @@
-export {};
+import { api } from './helpers.js';

package/dist/plugins/eslint/helpers.js

@@ -64,14 +64,9 @@ export const resolveExtendsSpecifier = (specifier) => {
     const noProtocolSpecifier = specifier.replace(/(^plugin:|:.+$)/, '');
     if (noProtocolSpecifier.startsWith('@typescript-eslint/'))
         return '@typescript-eslint/eslint-plugin';
-    const strippedSpecifier = noProtocolSpecifier.replace(/\/(eslint-)?(recommended|all)$/, '');
-    if (/eslint-(config|plugin)-/.test(strippedSpecifier))
-        return strippedSpecifier;
-    const packageName = getPackageNameFromModuleSpecifier(strippedSpecifier);
-    if (!packageName)
-        return;
-    if (packageName === 'eslint')
+    if (noProtocolSpecifier === 'eslint')
         return;
+    const packageName = getPackageNameFromModuleSpecifier(noProtocolSpecifier) ?? noProtocolSpecifier;
     return resolvePackageName(specifier.startsWith('plugin:') ? 'eslint-plugin' : 'eslint-config', packageName);
 };
 const getDependenciesFromSettings = (settings = {}) => {

package/dist/plugins/vitest/index.js

@@ -14,7 +14,7 @@ const findVitestDependencies = async (configFilePath) => {
     const cfg = config.test;
     const environments = cfg.environment ? [getEnvPackageName(cfg.environment)] : [];
     const reporters = getExternalReporters(cfg.reporters);
-    const coverage = cfg.coverage?.provider ? [`@vitest/coverage-${cfg.coverage.provider}`] : [];
+    const coverage = cfg.coverage ? [`@vitest/coverage-${cfg.coverage.provider ?? "v8"}`] : [];
     const setupFiles = cfg.setupFiles ? [cfg.setupFiles].flat() : [];
     const globalSetup = cfg.globalSetup ? [cfg.globalSetup].flat() : [];
     return compact([...environments, ...reporters, ...coverage, ...setupFiles, ...globalSetup]);

package/dist/reporters/util.d.ts

@@ -1,5 +1,5 @@
 import { ISSUE_TYPE_TITLE } from '../constants.js';
-import { IssueSeverity } from '../types/issues.js';
+import type { IssueSeverity } from '../types/issues.js';
 export declare const identity: (text: string) => string;
 export declare const getTitle: (reportType: keyof typeof ISSUE_TYPE_TITLE) => string;
 export declare const logTitle: (title: string, count: number) => void;

package/dist/types/config.d.ts

@@ -1,7 +1,7 @@
 import { z } from 'zod';
 import { ConfigurationValidator } from '../ConfigurationValidator.js';
 import * as Plugins from '../plugins/index.js';
-import { Rules } from './issues.js';
+import type { Rules } from './issues.js';
 import type { SyncCompilers, AsyncCompilers } from '../types/compilers.js';
 export type RawConfiguration = z.infer<typeof ConfigurationValidator>;
 type NormalizedGlob = string[];

package/dist/types/config.js

@@ -1 +1,3 @@
-export {};
+import { z } from 'zod';
+import { ConfigurationValidator } from '../ConfigurationValidator.js';
+import * as Plugins from '../plugins/index.js';

package/dist/types/exports.js

@@ -1 +1 @@
-export {};
+import ts from 'typescript';

package/dist/typescript/SourceFile.js

@@ -1 +1 @@
-export {};
+import ts from 'typescript';

package/dist/typescript/visitors/exports/index.js

@@ -1,3 +1,4 @@
+import ts from 'typescript';
 import exportAssignment from './exportAssignment.js';
 import exportDeclaration from './exportDeclaration.js';
 import exportKeyword from './exportKeyword.js';

package/dist/typescript/visitors/helpers.d.ts

@@ -1,4 +1,4 @@
-import { BoundSourceFile } from '../SourceFile.js';
+import type { BoundSourceFile } from '../SourceFile.js';
 export declare const isNotJS: (sourceFile: BoundSourceFile) => boolean;
 export declare const isJS: (sourceFile: BoundSourceFile) => boolean;
 export declare function getJSXImplicitImportBase(sourceFile: BoundSourceFile): string | undefined;

package/dist/typescript/visitors/imports/index.js

@@ -1,3 +1,4 @@
+import ts from 'typescript';
 import importCall from './importCall.js';
 import importDeclaration from './importDeclaration.js';
 import importEqualsDeclaration from './importEqualsDeclaration.js';

package/dist/typescript/visitors/index.js

@@ -1,3 +1,4 @@
+import ts from 'typescript';
 export const importVisitor = (fileCondition, visitorFn) => sourceFile => {
     if (fileCondition(sourceFile)) {
         return (node, options) => visitorFn(node, options);

package/dist/typescript/visitors/scripts/index.js

@@ -1,3 +1,4 @@
+import ts from 'typescript';
 import execa from './execa.js';
 import zx from './zx.js';
 const visitors = [execa, zx];

package/dist/util/Performance.js

@@ -1,4 +1,4 @@
-import { performance, PerformanceObserver } from 'node:perf_hooks';
+import { performance, PerformanceObserver, PerformanceEntry } from 'node:perf_hooks';
 import EasyTable from 'easy-table';
 import Summary from 'summary';
 import parsedArgValues from './cli-arguments.js';

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              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 (this is 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  --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";
 declare const _default: {
     config: string | undefined;
     debug: boolean | undefined;

package/dist/util/cli-arguments.js

@@ -8,14 +8,14 @@ Options:
   -t, --tsConfig [file]    TypeScript configuration path (default: tsconfig.json)
   --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)
   --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)
-  --workspace              Analyze a single workspace (default: analyze all configured workspaces)
+  --workspace [dir]        Analyze a single workspace (default: analyze all configured workspaces)
   --no-gitignore           Don't use .gitignore
   --include                Report only provided issue type(s), can be comma-separated or repeated (1)
   --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
   --include-entry-exports  Include entry files when reporting unused exports
-  -n, --no-progress        Don't show dynamic progress updates (this is automatically enabled in CI environments)
+  -n, --no-progress        Don't show dynamic progress updates (automatically enabled in CI environments)
   --reporter               Select reporter: symbols, compact, codeowners, json (default: symbols)
   --reporter-options       Pass extra options to the reporter (as JSON string, see example)
   --no-config-hints        Suppress configuration hints

package/dist/util/compilers.d.ts

@@ -1,5 +1,5 @@
-import { AsyncCompilerFn, SyncCompilerFn } from '../types/compilers.js';
-import { RawConfiguration } from '../types/config.js';
+import type { AsyncCompilerFn, SyncCompilerFn } from '../types/compilers.js';
+import type { RawConfiguration } from '../types/config.js';
 export declare const partitionCompilers: (rawLocalConfig: RawConfiguration) => {
     syncCompilers: Record<string, SyncCompilerFn>;
     asyncCompilers: Record<string, AsyncCompilerFn>;

package/dist/util/glob.js

@@ -1,6 +1,6 @@
 import fg from 'fast-glob';
 import { globby } from 'globby';
-import { ROOT_WORKSPACE_NAME } from '../constants.js';
+import { GLOBAL_IGNORE_PATTERNS, ROOT_WORKSPACE_NAME } from '../constants.js';
 import { compact } from './array.js';
 import { debugLogObject } from './debug.js';
 import { join, relative } from './path.js';
@@ -23,7 +23,7 @@ const glob = async ({ cwd, workingDir = cwd, patterns, ignore = [], gitignore =
     const globPatterns = compact([patterns].flat().map(prepend).map(removeProductionSuffix)).sort(negatedLast);
     if (globPatterns[0].startsWith('!'))
         return [];
-    const ignorePatterns = compact([...ignore, '**/node_modules/**']);
+    const ignorePatterns = compact([...ignore, ...GLOBAL_IGNORE_PATTERNS]);
     debugLogObject(`Globbing (${relativePath || ROOT_WORKSPACE_NAME})`, { cwd, globPatterns, ignorePatterns });
     return globby(globPatterns, {
         cwd,
@@ -38,13 +38,13 @@ const pureGlob = async ({ cwd, patterns, ignore = [], gitignore = true }) => {
         return [];
     return globby(patterns, {
         cwd,
-        ignore: [...ignore, '**/node_modules/**'],
+        ignore: [...ignore, ...GLOBAL_IGNORE_PATTERNS],
         gitignore,
         absolute: true,
     });
 };
 const firstGlob = async ({ cwd, patterns }) => {
-    const stream = fg.stream(patterns.map(removeProductionSuffix), { cwd, ignore: ['**/node_modules/**'] });
+    const stream = fg.stream(patterns.map(removeProductionSuffix), { cwd, ignore: GLOBAL_IGNORE_PATTERNS });
     for await (const entry of stream) {
         return entry;
     }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.18.0";
+export declare const version = "2.19.0";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.18.0';
+export const version = '2.19.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "2.18.0",
+  "version": "2.19.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",
@@ -65,12 +65,12 @@
     "@npmcli/package-json": "4.0.1",
     "@release-it/bumper": "5.1.0",
     "@swc/cli": "0.1.62",
-    "@swc/core": "1.3.73",
-    "@types/eslint": "8.44.1",
+    "@swc/core": "1.3.74",
+    "@types/eslint": "8.44.2",
     "@types/js-yaml": "4.0.5",
     "@types/micromatch": "4.0.2",
     "@types/minimist": "1.2.2",
-    "@types/node": "20.4.5",
+    "@types/node": "20.4.7",
     "@types/npmcli__map-workspaces": "3.0.1",
     "@types/webpack": "5.28.1",
     "@typescript-eslint/eslint-plugin": "6.2.1",
@@ -80,7 +80,7 @@
     "eslint-import-resolver-typescript": "3.5.5",
     "eslint-plugin-import": "2.28.0",
     "eslint-plugin-n": "16.0.1",
-    "prettier": "3.0.0",
+    "prettier": "3.0.1",
     "release-it": "16.1.3",
     "remark-cli": "11.0.0",
     "remark-preset-webpro": "0.0.3",