knip 2.12.3 → 2.13.0

package/dist/ConfigurationChief.d.ts

@@ -51,6 +51,7 @@ export declare class ConfigurationChief {
         ignore: string[];
         ignoreBinaries: string[];
         ignoreDependencies: string[];
+        ignoreExportsUsedInFile: boolean | Partial<Record<"function" | "type" | "enum" | "class" | "interface" | "member", boolean>>;
         ignoreWorkspaces: string[];
         syncCompilers: Map<string, (args_0: string, ...args_1: unknown[]) => string>;
         asyncCompilers: Map<string, (args_0: string, ...args_1: unknown[]) => Promise<string>>;

package/dist/ConfigurationChief.js

@@ -36,6 +36,7 @@ const defaultConfig = {
     ignore: [],
     ignoreBinaries: [],
     ignoreDependencies: [],
+    ignoreExportsUsedInFile: false,
     ignoreWorkspaces: [],
     syncCompilers: new Map(),
     asyncCompilers: new Map(),
@@ -107,6 +108,7 @@ export class ConfigurationChief {
         const exclude = rawLocalConfig.exclude ?? defaultConfig.exclude;
         const ignore = arrayify(rawLocalConfig.ignore ?? defaultConfig.ignore);
         const ignoreBinaries = rawLocalConfig.ignoreBinaries ?? [];
+        const ignoreExportsUsedInFile = rawLocalConfig.ignoreExportsUsedInFile ?? false;
         const ignoreDependencies = rawLocalConfig.ignoreDependencies ?? [];
         const ignoreWorkspaces = rawLocalConfig.ignoreWorkspaces ?? defaultConfig.ignoreWorkspaces;
         const { syncCompilers, asyncCompilers } = rawLocalConfig;
@@ -155,6 +157,7 @@ export class ConfigurationChief {
             ignore,
             ignoreBinaries,
             ignoreDependencies,
+            ignoreExportsUsedInFile,
             ignoreWorkspaces,
             syncCompilers: new Map(Object.entries(syncCompilers ?? {})),
             asyncCompilers: new Map(Object.entries(asyncCompilers ?? {})),

package/dist/ConfigurationValidator.d.ts

@@ -7,6 +7,7 @@ export declare const ConfigurationValidator: z.ZodObject<{
     paths: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>>;
     ignore: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
     ignoreBinaries: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    ignoreExportsUsedInFile: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodRecord<z.ZodUnion<[z.ZodLiteral<"class">, z.ZodLiteral<"enum">, z.ZodLiteral<"function">, z.ZodLiteral<"interface">, z.ZodLiteral<"member">, z.ZodLiteral<"type">]>, z.ZodBoolean>]>>;
     ignoreDependencies: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     ignoreWorkspaces: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     compilers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodString>, z.ZodFunction<z.ZodTuple<[z.ZodString], z.ZodUnknown>, z.ZodPromise<z.ZodString>>]>>>;
@@ -1411,6 +1412,7 @@ export declare const ConfigurationValidator: z.ZodObject<{
     paths?: Record<string, string[]> | undefined;
     ignore?: string | string[] | undefined;
     ignoreBinaries?: string[] | undefined;
+    ignoreExportsUsedInFile?: boolean | Partial<Record<"function" | "type" | "enum" | "class" | "interface" | "member", boolean>> | undefined;
     ignoreDependencies?: string[] | undefined;
     ignoreWorkspaces?: string[] | undefined;
     compilers?: Record<string, ((args_0: string, ...args_1: unknown[]) => string) | ((args_0: string, ...args_1: unknown[]) => Promise<string>)> | undefined;
@@ -1813,6 +1815,7 @@ export declare const ConfigurationValidator: z.ZodObject<{
     paths?: Record<string, string[]> | undefined;
     ignore?: string | string[] | undefined;
     ignoreBinaries?: string[] | undefined;
+    ignoreExportsUsedInFile?: boolean | Partial<Record<"function" | "type" | "enum" | "class" | "interface" | "member", boolean>> | undefined;
     ignoreDependencies?: string[] | undefined;
     ignoreWorkspaces?: string[] | undefined;
     compilers?: Record<string, ((args_0: string, ...args_1: unknown[]) => string) | ((args_0: string, ...args_1: unknown[]) => Promise<string>)> | undefined;

package/dist/ConfigurationValidator.js

@@ -28,6 +28,19 @@ const rootConfigurationSchema = z.object({
     paths: pathsSchema.optional(),
     ignore: globSchema.optional(),
     ignoreBinaries: z.array(z.string()).optional(),
+    ignoreExportsUsedInFile: z
+        .union([
+        z.boolean(),
+        z.record(z.union([
+            z.literal('class'),
+            z.literal('enum'),
+            z.literal('function'),
+            z.literal('interface'),
+            z.literal('member'),
+            z.literal('type'),
+        ]), z.boolean()),
+    ])
+        .optional(),
     ignoreDependencies: z.array(z.string()).optional(),
     ignoreWorkspaces: z.array(z.string()).optional(),
     compilers: compilersSchema.optional(),

package/dist/ProjectPrincipal.d.ts

@@ -49,7 +49,10 @@ export declare class ProjectPrincipal {
         scripts: Set<string>;
     };
     private resolveModule;
-    hasExternalReferences(filePath: string, exportedItem: ExportItem): boolean;
+    getHasReferences(filePath: string, exportedItem: ExportItem): {
+        external: boolean;
+        internal: boolean;
+    };
     findUnusedMembers(filePath: string, members: ExportItemMember[]): string[];
     private findReferences;
     isPublicExport(exportedItem: ExportItem): ts.JSDocPublicTag | undefined;

package/dist/ProjectPrincipal.js

@@ -148,10 +148,20 @@ export class ProjectPrincipal {
         const module = ts.resolveModuleName(specifier, filePath, this.compilerOptions, this.backend.languageServiceHost);
         return module?.resolvedModule;
     }
-    hasExternalReferences(filePath, exportedItem) {
-        const referencedSymbols = this.findReferences(filePath, exportedItem.node);
-        const externalRefs = referencedSymbols.flatMap(f => f.references).filter(ref => ref.fileName !== filePath);
-        return externalRefs.length > 0;
+    getHasReferences(filePath, exportedItem) {
+        const hasReferences = { external: false, internal: false };
+        const symbolReferences = this.findReferences(filePath, (ts.isExportAssignment(exportedItem.node) && exportedItem.node.getChildAt(1)) || exportedItem.node).flatMap(f => f.references);
+        for (const reference of symbolReferences) {
+            if (reference.fileName === filePath) {
+                if (!reference.isDefinition) {
+                    hasReferences.internal = true;
+                }
+            }
+            else {
+                hasReferences.external = true;
+            }
+        }
+        return hasReferences;
     }
     findUnusedMembers(filePath, members) {
         return members

package/dist/index.js

@@ -282,9 +282,16 @@ export const main = async (unresolvedConfiguration) => {
                             }
                             continue;
                         }
+                        const exportedItemAllowsInternalReferences = typeof chief.config.ignoreExportsUsedInFile === 'object'
+                            ? exportedItem.type !== 'unknown' && !!chief.config.ignoreExportsUsedInFile[exportedItem.type]
+                            : chief.config.ignoreExportsUsedInFile;
+                        const isExportedItemReferenced = () => {
+                            const hasReferences = principal.getHasReferences(filePath, exportedItem);
+                            return hasReferences.external || (exportedItemAllowsInternalReferences && hasReferences.internal);
+                        };
                         if (importedModule.isStar) {
                             const isReExportedByEntryFile = isExportedInEntryFile(importedModule);
-                            if (!isReExportedByEntryFile && !principal.hasExternalReferences(filePath, exportedItem)) {
+                            if (!isReExportedByEntryFile && !isExportedItemReferenced()) {
                                 if (['enum', 'type', 'interface'].includes(exportedItem.type)) {
                                     collector.addIssue({ type: 'nsTypes', filePath, symbol, symbolType: exportedItem.type });
                                 }
@@ -295,13 +302,12 @@ export const main = async (unresolvedConfiguration) => {
                         }
                         else {
                             if (['enum', 'type', 'interface'].includes(exportedItem.type)) {
-                                collector.addIssue({ type: 'types', filePath, symbol, symbolType: exportedItem.type });
+                                if (!isExportedItemReferenced()) {
+                                    collector.addIssue({ type: 'types', filePath, symbol, symbolType: exportedItem.type });
+                                }
                             }
                             else {
-                                if (importedModule.isReExport && !principal.hasExternalReferences(filePath, exportedItem)) {
-                                    collector.addIssue({ type: 'exports', filePath, symbol });
-                                }
-                                else if (!importedModule.isDynamic || !principal.hasExternalReferences(filePath, exportedItem)) {
+                                if ((importedModule.isReExport || !importedModule.isDynamic) && !isExportedItemReferenced()) {
                                     collector.addIssue({ type: 'exports', filePath, symbol });
                                 }
                             }

package/dist/types/config.d.ts

@@ -22,6 +22,7 @@ interface BaseWorkspaceConfiguration {
 }
 export interface WorkspaceConfiguration extends BaseWorkspaceConfiguration, Partial<PluginsConfiguration> {
 }
+type IgnorableExport = 'class' | 'enum' | 'function' | 'interface' | 'member' | 'type';
 export interface Configuration {
     rules: Rules;
     include: string[];
@@ -29,6 +30,7 @@ export interface Configuration {
     ignore: NormalizedGlob;
     ignoreBinaries: string[];
     ignoreDependencies: string[];
+    ignoreExportsUsedInFile: boolean | Partial<Record<IgnorableExport, boolean>>;
     ignoreWorkspaces: string[];
     workspaces: Record<string, WorkspaceConfiguration>;
     syncCompilers: SyncCompilers;

package/dist/util/compilers.d.ts

@@ -10,6 +10,7 @@ export declare const partitionCompilers: (rawLocalConfig: RawConfiguration) => {
     paths?: Record<string, string[]> | undefined;
     ignore?: string | string[] | undefined;
     ignoreBinaries?: string[] | undefined;
+    ignoreExportsUsedInFile?: boolean | Partial<Record<"function" | "type" | "enum" | "class" | "interface" | "member", boolean>> | undefined;
     ignoreDependencies?: string[] | undefined;
     ignoreWorkspaces?: string[] | undefined;
     compilers?: Record<string, ((args_0: string, ...args_1: unknown[]) => string) | ((args_0: string, ...args_1: unknown[]) => Promise<string>)> | undefined;

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "2.12.3";
+export declare const version = "2.13.0";

package/dist/version.js

@@ -1 +1 @@
-export const version = '2.12.3';
+export const version = '2.13.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "2.12.3",
+  "version": "2.13.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",
@@ -67,7 +67,7 @@
     "@types/js-yaml": "4.0.5",
     "@types/micromatch": "4.0.2",
     "@types/minimist": "1.2.2",
-    "@types/node": "20.2.3",
+    "@types/node": "20.2.5",
     "@types/npmcli__map-workspaces": "3.0.1",
     "@types/webpack": "5.28.1",
     "@typescript-eslint/eslint-plugin": "5.59.7",