knip 2.14.0-next.0 → 2.14.0

package/README.md

@@ -142,7 +142,7 @@ 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
-      --include-entry-exports    Include entry files when reporting unused exports
+      --include-entry-exports  Include entry files when reporting unused exports
       -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)
@@ -579,6 +579,15 @@ export const split = function () {};
 
 Knip does not report public exports and types as unused.
 
+## Include exports in entry files
+
+When a repository is self-contained or private, you may want to include entry files when reporting unused exports:
+
+    knip --include-entry-exports
+
+Knip will also report unused exports in entry source files and scripts (such as those referenced in `package.json`). But
+not in entry and configuration files from plugins, such as `next.config.js` or `src/routes/+page.svelte`.
+
 ## Handling Issues
 
 How to handle a long list of reported issues? Seeing too many false positives? Read more about [handling issues][17]

package/dist/ProjectPrincipal.d.ts

@@ -10,6 +10,7 @@ type ProjectPrincipalOptions = {
 export declare class ProjectPrincipal {
     entryPaths: Set<string>;
     projectPaths: Set<string>;
+    skipExportsAnalysis: Set<string>;
     cwd: string;
     compilerOptions: ts.CompilerOptions;
     extensions: Set<string>;
@@ -25,8 +26,12 @@ export declare class ProjectPrincipal {
     constructor({ compilerOptions, cwd, compilers }: ProjectPrincipalOptions);
     private createProgram;
     private hasAcceptedExtension;
-    addEntryPath(filePath: string): void;
-    addEntryPaths(filePaths: Set<string> | string[]): void;
+    addEntryPath(filePath: string, options?: {
+        skipExportsAnalysis: boolean;
+    }): void;
+    addEntryPaths(filePaths: Set<string> | string[], options?: {
+        skipExportsAnalysis: boolean;
+    }): void;
     addProjectPath(filePath: string): void;
     runAsyncCompilers(): Promise<void>;
     getUsedResolvedFiles(): string[];

package/dist/ProjectPrincipal.js

@@ -22,6 +22,7 @@ const tsCreateProgram = timerify(ts.createProgram);
 export class ProjectPrincipal {
     entryPaths = new Set();
     projectPaths = new Set();
+    skipExportsAnalysis = new Set();
     cwd;
     compilerOptions;
     extensions;
@@ -62,14 +63,16 @@ export class ProjectPrincipal {
     hasAcceptedExtension(filePath) {
         return this.extensions.has(extname(filePath));
     }
-    addEntryPath(filePath) {
+    addEntryPath(filePath, options) {
         if (!isInNodeModules(filePath) && this.hasAcceptedExtension(filePath)) {
             this.entryPaths.add(filePath);
             this.projectPaths.add(filePath);
+            if (options?.skipExportsAnalysis)
+                this.skipExportsAnalysis.add(filePath);
         }
     }
-    addEntryPaths(filePaths) {
-        filePaths.forEach(filePath => this.addEntryPath(filePath));
+    addEntryPaths(filePaths, options) {
+        filePaths.forEach(filePath => this.addEntryPath(filePath, options));
     }
     addProjectPath(filePath) {
         if (!isInNodeModules(filePath) && this.hasAcceptedExtension(filePath)) {
@@ -101,7 +104,8 @@ export class ProjectPrincipal {
         const sourceFile = this.backend.program?.getSourceFile(filePath);
         if (!sourceFile)
             throw new Error(`Unable to find ${filePath}`);
-        const { imports, exports, scripts } = getImportsAndExports(sourceFile, { skipTypeOnly });
+        const skipExports = this.skipExportsAnalysis.has(filePath);
+        const { imports, exports, scripts } = getImportsAndExports(sourceFile, { skipTypeOnly, skipExports });
         const { internal, unresolved, external } = imports;
         const unresolvedImports = new Set();
         unresolved.forEach(specifier => {
@@ -114,7 +118,7 @@ export class ProjectPrincipal {
                     external.add(specifier);
                 }
                 else {
-                    this.addEntryPath(resolvedModule.resolvedFileName);
+                    this.addEntryPath(resolvedModule.resolvedFileName, { skipExportsAnalysis: true });
                 }
             }
             else {

package/dist/index.js

@@ -71,7 +71,7 @@ export const main = async (unresolvedConfiguration) => {
                     if (otherWorkspace) {
                         const filePath = _resolveSpecifier(otherWorkspace.dir, specifier);
                         if (filePath) {
-                            principal.addEntryPath(filePath);
+                            principal.addEntryPath(filePath, { skipExportsAnalysis: true });
                         }
                         else {
                             collector.addIssue({ type: 'unresolved', filePath: containingFilePath, symbol: specifier });
@@ -121,7 +121,7 @@ export const main = async (unresolvedConfiguration) => {
                 const patterns = worker.getProductionPluginEntryFilePatterns();
                 const pluginWorkspaceEntryPaths = await _glob({ ...sharedGlobOptions, patterns });
                 debugLogArray(`Found production plugin entry paths (${name})`, pluginWorkspaceEntryPaths);
-                principal.addEntryPaths(pluginWorkspaceEntryPaths);
+                principal.addEntryPaths(pluginWorkspaceEntryPaths, { skipExportsAnalysis: true });
             }
             {
                 const patterns = worker.getProductionProjectFilePatterns();
@@ -147,7 +147,7 @@ export const main = async (unresolvedConfiguration) => {
                 const patterns = worker.getPluginEntryFilePatterns();
                 const pluginWorkspaceEntryPaths = await _glob({ ...sharedGlobOptions, patterns });
                 debugLogArray(`Found plugin entry paths (${name})`, pluginWorkspaceEntryPaths);
-                principal.addEntryPaths(pluginWorkspaceEntryPaths);
+                principal.addEntryPaths(pluginWorkspaceEntryPaths, { skipExportsAnalysis: true });
             }
             {
                 const patterns = worker.getPluginProjectFilePatterns();
@@ -159,11 +159,11 @@ export const main = async (unresolvedConfiguration) => {
                 const patterns = compact(worker.getPluginConfigPatterns());
                 const configurationEntryPaths = await _glob({ ...sharedGlobOptions, patterns });
                 debugLogArray(`Found plugin configuration paths (${name})`, configurationEntryPaths);
-                principal.addEntryPaths(configurationEntryPaths);
+                principal.addEntryPaths(configurationEntryPaths, { skipExportsAnalysis: true });
             }
         }
         if (chief.resolvedConfigFilePath)
-            principal.addEntryPath(chief.resolvedConfigFilePath);
+            principal.addEntryPath(chief.resolvedConfigFilePath, { skipExportsAnalysis: true });
         const dependencies = await worker.findAllDependencies();
         const { referencedDependencies, peerDependencies, installedBinaries, enabledPlugins } = dependencies;
         deputy.addPeerDependencies(name, peerDependencies);
@@ -288,7 +288,7 @@ export const main = async (unresolvedConfiguration) => {
                         continue;
                     }
                     const isStar = Boolean(importedModule?.isStar);
-                    const isReExportedByEntryFile = isStar && isExportedInEntryFile(importedModule);
+                    const isReExportedByEntryFile = !isIncludeEntryExports && isStar && isExportedInEntryFile(importedModule);
                     if (!isReExportedByEntryFile && !isExportedItemReferenced(exportedItem, filePath)) {
                         if (['enum', 'type', 'interface'].includes(exportedItem.type)) {
                             if (isProduction)

package/dist/plugins/webpack/index.js

@@ -22,6 +22,8 @@ const resolveRuleSetDependencies = (rule) => {
     if (typeof useItem === 'function')
         useItem = useItem(info);
     return [useItem].flat().flatMap((useItem) => {
+        if (!useItem)
+            return [];
         if (hasBabelOptions(useItem)) {
             return [
                 ...resolveUseItem(useItem),

package/dist/typescript/getImportsAndExports.d.ts

@@ -4,6 +4,7 @@ import type { ExportItems as Exports, ExportItem } from '../types/exports.js';
 import type { Imports } from '../types/imports.js';
 export type GetImportsAndExportsOptions = {
     skipTypeOnly: boolean;
+    skipExports: boolean;
 };
 export type AddImportOptions = {
     specifier: string;

package/dist/typescript/getImportsAndExports.js

@@ -86,6 +86,8 @@ export const getImportsAndExports = (sourceFile, options) => {
         }
     };
     const addExport = ({ node, identifier, type, pos, members }) => {
+        if (options.skipExports)
+            return;
         if (exports.has(identifier)) {
             const item = exports.get(identifier);
             exports.set(identifier, { ...item, node, type, pos, members });

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\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              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\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

@@ -14,7 +14,7 @@ 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
-  --include-entry-exports    Include entry files when reporting unused exports
+  --include-entry-exports  Include entry files when reporting unused exports
   -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)

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.14.0-next.0";
+export declare const version = "2.14.0";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.14.0-next.0';
+export const version = '2.14.0';

package/package.json

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