knip 2.19.11 → 2.20.0

package/README.md

@@ -482,6 +482,11 @@ Additionally, the `--strict` flag can be used to:
 - Ignore type-only imports (`import type {}`).
 - Verify each workspace is self-contained: have their own `dependencies` (and not use packages of ancestor workspaces).
 
+### Ignore `@internal` exports
+
+In addition to the flags above, the `--ignore-internal` flag can be used to ignore exports tagged with `@internal`. This
+can be useful in production mode, since `@internal` exports might be only imported from non-production code.
+
 ### Plugins
 
 Plugins also have this distinction. For instance, Next.js entry files for pages (`pages/**/*.tsx`) and Remix routes
@@ -630,6 +635,7 @@ for false positives, and how to handle them.
       -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)
+      --ignore-internal        Ignore exports with tag @internal (JSDoc/TSDoc)
       --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)

package/dist/DependencyDeputy.js

@@ -168,9 +168,9 @@ export class DependencyDeputy {
                         return false;
                     return referencedDependencies.has(typedPackageName);
                 }
-                const peerDependencies = this.getPeerDependenciesOf(workspaceName, dependency);
-                peerDependencies.forEach(dep => (!peerDepRecs[dep] ? (peerDepRecs[dep] = 1) : peerDepRecs[dep]++));
-                return !!peerDependencies.find(peerDependency => isReferencedDependency(peerDependency, true));
+                const peerDependenciesOf = this.getPeerDependenciesOf(workspaceName, dependency);
+                peerDependenciesOf.forEach(dep => (!peerDepRecs[dep] ? (peerDepRecs[dep] = 1) : peerDepRecs[dep]++));
+                return peerDependenciesOf.some(peerDependency => isReferencedDependency(peerDependency, true));
             };
             const isNotReferencedDependency = (dependency) => !isReferencedDependency(dependency);
             const pd = this.getProductionDependencies(workspaceName);

package/dist/ProjectPrincipal.d.ts

@@ -1,3 +1,4 @@
+import { isGitIgnoredSync } from 'globby';
 import ts from 'typescript';
 import { SourceFileManager } from './typescript/SourceFileManager.js';
 import type { SyncCompilers, AsyncCompilers } from './types/compilers.js';
@@ -11,6 +12,7 @@ export declare class ProjectPrincipal {
     entryPaths: Set<string>;
     projectPaths: Set<string>;
     skipExportsAnalysis: Set<string>;
+    isGitIgnored: ReturnType<typeof isGitIgnoredSync>;
     cwd: string;
     compilerOptions: ts.CompilerOptions;
     extensions: Set<string>;

package/dist/ProjectPrincipal.js

@@ -7,7 +7,7 @@ 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, join } from './util/path.js';
+import { dirname, extname, isInNodeModules, join } from './util/path.js';
 import { timerify } from './util/Performance.js';
 const baseCompilerOptions = {
     allowJs: true,
@@ -23,11 +23,11 @@ const baseCompilerOptions = {
     moduleResolution: ts.ModuleResolutionKind.NodeNext,
 };
 const tsCreateProgram = timerify(ts.createProgram);
-const isGitIgnored = isGitIgnoredSync();
 export class ProjectPrincipal {
     entryPaths = new Set();
     projectPaths = new Set();
     skipExportsAnalysis = new Set();
+    isGitIgnored;
     cwd;
     compilerOptions;
     extensions;
@@ -36,6 +36,7 @@ export class ProjectPrincipal {
     backend;
     constructor({ compilerOptions, cwd, compilers }) {
         this.cwd = cwd;
+        this.isGitIgnored = isGitIgnoredSync({ cwd });
         this.compilerOptions = {
             ...compilerOptions,
             ...baseCompilerOptions,
@@ -132,7 +133,7 @@ export class ProjectPrincipal {
                     external.add(sanitizedSpecifier);
                 }
                 else {
-                    const isIgnored = isGitIgnored(join(filePath, sanitizedSpecifier));
+                    const isIgnored = this.isGitIgnored(join(dirname(filePath), sanitizedSpecifier));
                     if (!isIgnored) {
                         const ext = extname(sanitizedSpecifier);
                         if (!ext || (ext !== '.json' && !IGNORED_FILE_EXTENSIONS.includes(ext))) {

package/dist/cli.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, 'ignore-internal': isIgnoreInternal = false, 'include-entry-exports': isIncludeEntryExports = 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);
@@ -27,8 +27,9 @@ const run = async () => {
             cwd,
             tsConfigFile: tsConfig,
             gitignore: !isNoGitIgnore,
-            isStrict,
             isProduction,
+            isStrict,
+            isIgnoreInternal,
             isShowProgress,
             isIncludeEntryExports,
         });

package/dist/index.js

@@ -20,7 +20,7 @@ import { _require } from './util/require.js';
 import { loadTSConfig as loadCompilerOptions } from './util/tsconfig-loader.js';
 import { WorkspaceWorker } from './WorkspaceWorker.js';
 export const main = async (unresolvedConfiguration) => {
-    const { cwd, tsConfigFile, gitignore, isStrict, isProduction, isShowProgress, isIncludeEntryExports } = unresolvedConfiguration;
+    const { cwd, tsConfigFile, gitignore, isStrict, isProduction, isIgnoreInternal, isShowProgress, isIncludeEntryExports, } = unresolvedConfiguration;
     debugLogObject('Unresolved configuration (from CLI arguments)', unresolvedConfiguration);
     const chief = new ConfigurationChief({ cwd, isProduction });
     const deputy = new DependencyDeputy({ isStrict });
@@ -270,6 +270,8 @@ export const main = async (unresolvedConfiguration) => {
                     const jsDocTags = principal.getJSDocTags(exportedItem);
                     if (jsDocTags.includes('@public') || jsDocTags.includes('@beta'))
                         continue;
+                    if (isIgnoreInternal && jsDocTags.includes('@internal'))
+                        continue;
                     if (importedModule?.symbols.has(symbol)) {
                         if (importedModule.isReExport && isExportedInEntryFile(importedModule))
                             continue;

package/dist/plugins/ava/index.js

@@ -10,7 +10,7 @@ const findAvaDependencies = async (configFilePath, { cwd, manifest }) => {
     const config = configFilePath.endsWith('package.json') ? manifest.ava : await load(configFilePath);
     const requireArgs = (config?.require ?? []).map(require => `--require ${require}`);
     const otherArgs = config?.nodeArguments ?? [];
-    const cmd = `node ${otherArgs.join(' ') + ' '}${requireArgs.join(' ')}`;
+    const cmd = `node ${otherArgs.join(' ')} ${requireArgs.join(' ')}`;
     return _getDependenciesFromScripts([cmd], {
         cwd,
         manifest,

package/dist/plugins/vitest/index.js

@@ -1,4 +1,5 @@
 import { compact } from '../../util/array.js';
+import { join } from '../../util/path.js';
 import { timerify } from '../../util/Performance.js';
 import { hasDependency, load } from '../../util/plugin.js';
 import { getEnvPackageName, getExternalReporters } from './helpers.js';
@@ -7,7 +8,7 @@ export const ENABLERS = ['vitest'];
 export const isEnabled = ({ dependencies }) => hasDependency(dependencies, ENABLERS);
 export const CONFIG_FILE_PATTERNS = ['vitest.config.ts'];
 export const ENTRY_FILE_PATTERNS = ['vite.config.ts'];
-const findVitestDependencies = async (configFilePath) => {
+const findVitestDependencies = async (configFilePath, { cwd }) => {
     const config = await load(configFilePath);
     if (!config || !config.test)
         return [];
@@ -15,8 +16,8 @@ const findVitestDependencies = async (configFilePath) => {
     const environments = cfg.environment ? [getEnvPackageName(cfg.environment)] : [];
     const reporters = getExternalReporters(cfg.reporters);
     const coverage = cfg.coverage ? [`@vitest/coverage-${cfg.coverage.provider ?? 'v8'}`] : [];
-    const setupFiles = cfg.setupFiles ? [cfg.setupFiles].flat() : [];
-    const globalSetup = cfg.globalSetup ? [cfg.globalSetup].flat() : [];
+    const setupFiles = cfg.setupFiles ? [cfg.setupFiles].flat().map(filePath => join(cwd, filePath)) : [];
+    const globalSetup = cfg.globalSetup ? [cfg.globalSetup].flat().map(filePath => join(cwd, filePath)) : [];
     return compact([...environments, ...reporters, ...coverage, ...setupFiles, ...globalSetup]);
 };
 export const findDependencies = timerify(findVitestDependencies);

package/dist/types/cli.d.ts

@@ -4,6 +4,7 @@ export interface CommandLineOptions {
     gitignore: boolean;
     isStrict: boolean;
     isProduction: boolean;
+    isIgnoreInternal: boolean;
     isShowProgress: boolean;
     isIncludeEntryExports: boolean;
 }

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  --ignore-internal        Ignore exports with tag @internal (JSDoc/TSDoc)\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;
@@ -7,6 +7,7 @@ declare const _default: {
     exclude: string[] | undefined;
     exports: boolean | undefined;
     help: boolean | undefined;
+    'ignore-internal': boolean | undefined;
     include: string[] | undefined;
     'include-entry-exports': boolean | undefined;
     'max-issues': string | undefined;

package/dist/util/cli-arguments.js

@@ -8,6 +8,7 @@ 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)
+  --ignore-internal        Ignore exports with tag @internal (JSDoc/TSDoc)
   --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)
@@ -50,6 +51,7 @@ try {
             exclude: { type: 'string', multiple: true },
             exports: { type: 'boolean' },
             help: { type: 'boolean', short: 'h' },
+            'ignore-internal': { type: 'boolean' },
             include: { type: 'string', multiple: true },
             'include-entry-exports': { type: 'boolean' },
             'max-issues': { type: 'string' },

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.19.11";
+export declare const version = "2.20.0";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.19.11';
+export const version = '2.20.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "2.19.11",
+  "version": "2.20.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",
@@ -18,7 +18,7 @@
   "types": "./dist/index.d.ts",
   "scripts": {
     "knip": "node ./dist/cli.js",
-    "knip:production": "node ./dist/cli.js --production --strict",
+    "knip:production": "node ./dist/cli.js --production --strict --ignore-internal",
     "lint": "eslint scripts src tests",
     "lint:fix": "eslint scripts src tests --fix",
     "format": "prettier scripts src tests schema.json --with-node-modules --write --config .prettierrc",