knip 5.1.5 → 5.2.0

package/dist/IssueFixer.js

@@ -45,7 +45,10 @@ export class IssueFixer {
             ].sort((a, b) => b[0] - a[0]);
             if (exportPositions.length > 0) {
                 const sourceFileText = exportPositions.reduce((text, [start, end]) => text.substring(0, start) + text.substring(end), await readFile(filePath, 'utf-8'));
-                await writeFile(filePath, sourceFileText);
+                const withoutEmptyReExports = sourceFileText
+                    .replaceAll(/export \{[ ,]+\} from ('|")[^'"]+('|");?\n?/g, '')
+                    .replaceAll(/export \{[ ,]+\};?\n?/g, '');
+                await writeFile(filePath, withoutEmptyReExports);
             }
         }
     }

package/dist/ProjectPrincipal.d.ts

@@ -1,4 +1,5 @@
 import ts from 'typescript';
+import { type GetImportsAndExportsOptions } from './typescript/getImportsAndExports.js';
 import { createCustomModuleResolver } from './typescript/resolveModuleNames.js';
 import { SourceFileManager } from './typescript/SourceFileManager.js';
 import type { SyncCompilers, AsyncCompilers } from './compilers/types.js';
@@ -7,12 +8,6 @@ import type { SerializableExportMember } from './types/exports.js';
 import type { UnresolvedImport } from './types/imports.js';
 import type { ProgramMaybe53 } from './typescript/SourceFile.js';
 import type { ReferencedDependencies } from './WorkspaceWorker.js';
-type AnalyzeSourceFileOptions = {
-    skipTypeOnly: boolean;
-    isFixExports: boolean;
-    isFixTypes: boolean;
-    ignoreExportsUsedInFile: boolean;
-};
 export declare class ProjectPrincipal {
     entryPaths: Set<string>;
     projectPaths: Set<string>;
@@ -52,7 +47,7 @@ export declare class ProjectPrincipal {
     getUsedResolvedFiles(): string[];
     private getProgramSourceFiles;
     getUnreferencedFiles(): string[];
-    analyzeSourceFile(filePath: string, options: AnalyzeSourceFileOptions): {
+    analyzeSourceFile(filePath: string, options: Omit<GetImportsAndExportsOptions, 'skipExports'>): {
         imports: {
             internal: import("./types/imports.js").SerializableImportMap;
             unresolved: Set<UnresolvedImport>;
@@ -67,4 +62,3 @@ export declare class ProjectPrincipal {
     resolveModule(specifier: string, filePath?: string): ts.ResolvedModuleFull | undefined;
     findUnusedMembers(filePath: string, members: SerializableExportMember[]): SerializableExportMember[];
 }
-export {};

package/dist/cli.js

@@ -1,4 +1,5 @@
 import './util/register.js';
+import picocolors from 'picocolors';
 import prettyMilliseconds from 'pretty-ms';
 import parsedArgValues, { helpText } from './util/cli-arguments.js';
 import { isKnownError, getKnownError, isConfigurationError, hasCause } from './util/errors.js';
@@ -8,7 +9,7 @@ import { runPreprocessors, runReporters } from './util/reporter.js';
 import { splitTags } from './util/tag.js';
 import { version } from './version.js';
 import { main } from './index.js';
-const { debug: isDebug = false, trace: isTrace = false, help: isHelp, 'max-issues': maxIssues = '0', 'no-config-hints': noConfigHints = false, 'no-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': isNoProgress = isDebug || isTrace || false, 'include-entry-exports': isIncludeEntryExports = false, 'isolate-workspaces': isIsolateWorkspaces = false, performance: isObservePerf = false, production: isProduction = false, 'reporter-options': reporterOptions = '', 'preprocessor-options': preprocessorOptions = '', strict: isStrict = false, fix: isFix = false, 'fix-type': fixTypes = [], tsConfig, version: isVersion, 'experimental-tags': tags = [], } = parsedArgValues;
+const { debug: isDebug = false, trace: isTrace = false, help: isHelp, 'max-issues': maxIssues = '0', 'no-config-hints': noConfigHints = false, 'no-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': isNoProgress = isDebug || isTrace || false, 'include-entry-exports': isIncludeEntryExports = false, 'isolate-workspaces': isIsolateWorkspaces = false, performance: isObservePerf = false, production: isProduction = false, 'reporter-options': reporterOptions = '', 'preprocessor-options': preprocessorOptions = '', strict: isStrict = false, fix: isFix = false, 'fix-type': fixTypes = [], tsConfig, version: isVersion, 'experimental-tags': experimentalTags = [], tags = [], } = parsedArgValues;
 if (isHelp) {
     console.log(helpText);
     process.exit(0);
@@ -30,7 +31,7 @@ const run = async () => {
             isShowProgress,
             isIncludeEntryExports,
             isIsolateWorkspaces,
-            tags: splitTags(tags),
+            tags: tags.length > 0 ? splitTags(tags) : splitTags(experimentalTags),
             isFix: isFix || fixTypes.length > 0,
             fixTypes: fixTypes.flatMap(type => type.split(',')),
         });
@@ -58,6 +59,9 @@ const run = async () => {
             console.log('\nTotal running time:', prettyMilliseconds(perfObserver.getTotalTime()), `(mem: ${mem}MB)`);
             perfObserver.reset();
         }
+        if (experimentalTags.length > 0) {
+            console.warn(`\n${picocolors.yellow('DEPRECATION WARNING:')} --experimental-tags is deprecated, please start using --tags instead`);
+        }
         if (!noExitCode && totalErrorCount > Number(maxIssues)) {
             process.exit(1);
         }

package/dist/index.js

@@ -227,6 +227,7 @@ export const main = async (unresolvedConfiguration) => {
                     isFixExports: fixer.isEnabled && fixer.isFixUnusedExports,
                     isFixTypes: fixer.isEnabled && fixer.isFixUnusedTypes,
                     ignoreExportsUsedInFile: Boolean(chief.config.ignoreExportsUsedInFile),
+                    tags,
                 });
                 const { internal, external, unresolved } = imports;
                 const { exported, duplicate } = exports;
@@ -423,7 +424,7 @@ export const main = async (unresolvedConfiguration) => {
                         continue;
                     if (exportedItem.jsDocTags.includes('@alias'))
                         continue;
-                    if (shouldIgnore(exportedItem, tags))
+                    if (shouldIgnore(exportedItem.jsDocTags, tags))
                         continue;
                     if (isProduction && exportedItem.jsDocTags.includes('@internal'))
                         continue;
@@ -437,7 +438,7 @@ export const main = async (unresolvedConfiguration) => {
                         if (isIdentifierReferenced(filePath, identifier, importsForExport)) {
                             if (exportedItem.type === 'enum') {
                                 exportedItem.members?.forEach(member => {
-                                    if (shouldIgnore(member, tags))
+                                    if (shouldIgnore(member.jsDocTags, tags))
                                         return;
                                     if (member.refs === 0) {
                                         exportLookupLog(-1, `Looking up export member ${identifier}.${member.identifier} from`, filePath);
@@ -507,7 +508,7 @@ export const main = async (unresolvedConfiguration) => {
             const workspace = chief.findWorkspaceByFilePath(filePath);
             const principal = workspace && factory.getPrincipalByPackageName(workspace.pkgName);
             if (principal) {
-                const members = exportedItem.members.filter(member => !shouldIgnore(member, tags));
+                const members = exportedItem.members.filter(member => !shouldIgnore(member.jsDocTags, tags));
                 principal.findUnusedMembers(filePath, members).forEach(member => {
                     collector.addIssue({
                         type: 'classMembers',

package/dist/typescript/ast-helpers.js

@@ -89,6 +89,9 @@ export const getJSDocTags = (node) => {
     else if (ts.isEnumMember(node) || ts.isClassElement(node)) {
         tagNodes = [...tagNodes, ...ts.getJSDocTags(node.parent)];
     }
+    else if (ts.isCallExpression(node)) {
+        tagNodes = [...tagNodes, ...ts.getJSDocTags(node.parent)];
+    }
     for (const tagNode of tagNodes) {
         const match = tagNode.getText()?.match(/@\S+/);
         if (match)

package/dist/typescript/getImportsAndExports.d.ts

@@ -1,5 +1,6 @@
 import ts from 'typescript';
 import type { BoundSourceFile, GetResolvedModule } from './SourceFile.js';
+import type { Tags } from '../types/cli.js';
 import type { SerializableExports } from '../types/exports.js';
 import type { SerializableImportMap, UnresolvedImport } from '../types/imports.js';
 import type { IssueSymbol } from '../types/issues.js';
@@ -9,6 +10,7 @@ export type GetImportsAndExportsOptions = {
     isFixExports: boolean;
     isFixTypes: boolean;
     ignoreExportsUsedInFile: boolean;
+    tags: Tags;
 };
 export declare const _getImportsAndExports: (sourceFile: BoundSourceFile, getResolvedModule: GetResolvedModule, typeChecker: ts.TypeChecker, options: GetImportsAndExportsOptions) => {
     imports: {

package/dist/typescript/getImportsAndExports.js

@@ -3,6 +3,7 @@ import ts from 'typescript';
 import { isStartsLikePackageName, sanitizeSpecifier } from '../util/modules.js';
 import { isInNodeModules } from '../util/path.js';
 import { timerify } from '../util/Performance.js';
+import { shouldIgnore } from '../util/tag.js';
 import { isAccessExpression, getJSDocTags, getLineAndCharacterOfPosition, getMemberStringLiterals, } from './ast-helpers.js';
 import getDynamicImportVisitors from './visitors/dynamic-imports/index.js';
 import getExportVisitors from './visitors/exports/index.js';
@@ -30,7 +31,7 @@ const createSerializableMember = (node, member, pos) => {
     };
 };
 const getImportsAndExports = (sourceFile, getResolvedModule, typeChecker, options) => {
-    const { skipTypeOnly } = options;
+    const { skipTypeOnly, tags } = options;
     const internalImports = {};
     const externalImports = new Set();
     const unresolvedImports = new Set();
@@ -75,7 +76,7 @@ const getImportsAndExports = (sourceFile, getResolvedModule, typeChecker, option
         if (symbol)
             importedInternalSymbols.set(symbol, filePath);
     };
-    const addImport = (options) => {
+    const addImport = (options, node) => {
         const { specifier, isTypeOnly, pos, identifier = '__anonymous', isReExport = false } = options;
         if (isBuiltin(specifier))
             return;
@@ -103,6 +104,8 @@ const getImportsAndExports = (sourceFile, getResolvedModule, typeChecker, option
         else {
             if (skipTypeOnly && isTypeOnly)
                 return;
+            if (shouldIgnore(getJSDocTags(node), tags))
+                return;
             if (typeof pos === 'number') {
                 const { line, character } = sourceFile.getLineAndCharacterOfPosition(pos);
                 unresolvedImports.add({ specifier, pos, line: line + 1, col: character + 1 });
@@ -208,13 +211,13 @@ const getImportsAndExports = (sourceFile, getResolvedModule, typeChecker, option
     const visit = (node) => {
         for (const visitor of visitors.dynamicImport) {
             const result = visitor(node, options);
-            result && (Array.isArray(result) ? result.forEach(addImport) : addImport(result));
+            result && (Array.isArray(result) ? result.forEach(r => addImport(r, node)) : addImport(result, node));
         }
         const isTopLevel = node.parent === sourceFile || node.parent?.parent === sourceFile;
         if (isTopLevel) {
             for (const visitor of visitors.import) {
                 const result = visitor(node, options);
-                result && (Array.isArray(result) ? result.forEach(addImport) : addImport(result));
+                result && (Array.isArray(result) ? result.forEach(r => addImport(r, node)) : addImport(result, node));
             }
             for (const visitor of visitors.export) {
                 const result = visitor(node, options);

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  -W, --workspace [dir]    Analyze a single workspace (default: analyze all configured workspaces)\n  --directory [dir]        Run process from a different directory (default: cwd)\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,binaries,unresolved\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\n  --fix                    Fix issues\n  --fix-type               Fix only issues of type, can be comma-separated or repeated (2)\n  --include-entry-exports  Include entry files when reporting unused exports\n  --isolate-workspaces     Isolate workspaces into separate programs (default: false)\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  --preprocessor-options   Pass extra options to the preprocessor (as JSON string, see --reporter-options example)\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  --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(2) Fixable issue types: dependencies, exports, types\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\nWebsite: https://knip.dev";
+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  -W, --workspace [dir]    Analyze a single workspace (default: analyze all configured workspaces)\n  --directory [dir]        Run process from a different directory (default: cwd)\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,binaries,unresolved\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\n  --fix                    Fix issues\n  --fix-type               Fix only issues of type, can be comma-separated or repeated (2)\n  --include-entry-exports  Include entry files when reporting unused exports\n  --isolate-workspaces     Isolate workspaces into separate programs (default: false)\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  --preprocessor-options   Pass extra options to the preprocessor (as JSON string, see --reporter-options example)\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  --tags                   Include or exclude tagged exports\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  --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(2) Fixable issue types: dependencies, exports, types\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 --tags=-knipignore\n\nWebsite: https://knip.dev";
 declare const _default: {
     config: string | undefined;
     debug: boolean | undefined;
@@ -6,6 +6,7 @@ declare const _default: {
     directory: string | undefined;
     exclude: string[] | undefined;
     exports: boolean | undefined;
+    tags: string[] | undefined;
     'experimental-tags': string[] | undefined;
     fix: boolean | undefined;
     'fix-type': string[] | undefined;

package/dist/util/cli-arguments.js

@@ -24,6 +24,7 @@ Options:
   --preprocessor-options   Pass extra options to the preprocessor (as JSON string, see --reporter-options example)
   --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)
+  --tags                   Include or exclude tagged exports
   --no-config-hints        Suppress configuration hints
   --no-exit-code           Always exit with code zero (0)
   --max-issues             Maximum number of issues before non-zero exit code (default: 0)
@@ -42,6 +43,7 @@ $ knip --production
 $ knip --workspace packages/client --include files,dependencies
 $ knip -c ./config/knip.json --reporter compact
 $ knip --reporter codeowners --reporter-options '{"path":".github/CODEOWNERS"}'
+$ knip --tags=-knipignore
 
 Website: https://knip.dev`;
 let parsedArgs;
@@ -54,6 +56,7 @@ try {
             directory: { type: 'string' },
             exclude: { type: 'string', multiple: true },
             exports: { type: 'boolean' },
+            tags: { type: 'string', multiple: true },
             'experimental-tags': { type: 'string', multiple: true },
             fix: { type: 'boolean' },
             'fix-type': { type: 'string', multiple: true },

package/dist/util/tag.d.ts

@@ -1,4 +1,3 @@
 import type { Tags } from '../types/cli.js';
-import type { SerializableExport, SerializableExportMember } from '../types/exports.js';
 export declare const splitTags: (tags: string[]) => Tags;
-export declare const shouldIgnore: (exportedItem: SerializableExport | SerializableExportMember, tags: Tags) => boolean;
+export declare const shouldIgnore: (jsDocTags: string[], tags: Tags) => boolean;

package/dist/util/tag.js

@@ -5,11 +5,11 @@ export const splitTags = (tags) => tags
     return [incl, excl];
 }, [[], []]);
 const hasTag = (tags, jsDocTags) => tags.some(tag => jsDocTags.includes('@' + tag));
-export const shouldIgnore = (exportedItem, tags) => {
+export const shouldIgnore = (jsDocTags, tags) => {
     const [includeJSDocTags, excludeJSDocTags] = tags;
-    if (includeJSDocTags.length > 0 && !hasTag(includeJSDocTags, exportedItem.jsDocTags))
+    if (includeJSDocTags.length > 0 && !hasTag(includeJSDocTags, jsDocTags))
         return true;
-    if (excludeJSDocTags.length > 0 && hasTag(excludeJSDocTags, exportedItem.jsDocTags))
+    if (excludeJSDocTags.length > 0 && hasTag(excludeJSDocTags, jsDocTags))
         return true;
     return false;
 };

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.1.5";
+export declare const version = "5.2.0";

package/dist/version.js

@@ -1 +1 @@
-export const version = '5.1.5';
+export const version = '5.2.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "5.1.5",
+  "version": "5.2.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://knip.dev",
   "repository": {