knip 5.3.1 → 5.4.0

package/dist/ConfigurationChief.d.ts

@@ -1,5 +1,5 @@
 import { createPkgGraph } from '@pnpm/workspace.pkgs-graph';
-import type { Configuration, WorkspaceConfiguration } from './types/config.js';
+import type { Configuration, WorkspaceConfiguration, IgnorePatterns } from './types/config.js';
 import type { PackageJson } from './types/package-json.js';
 type ConfigurationManagerOptions = {
     cwd: string;
@@ -14,6 +14,7 @@ export type Workspace = {
     ancestors: string[];
     config: WorkspaceConfiguration;
     manifestPath: string;
+    ignoreMembers: IgnorePatterns;
 };
 export declare class ConfigurationChief {
     cwd: string;
@@ -63,6 +64,7 @@ export declare class ConfigurationChief {
     private getIgnoredWorkspacesFor;
     getNegatedWorkspacePatterns(name: string): string[];
     private getConfigKeyForWorkspace;
+    getWorkspaceConfig(workspaceName: string): any;
     getIgnores(workspaceName: string): {
         ignoreBinaries: (string | RegExp)[];
         ignoreDependencies: (string | RegExp)[];

package/dist/ConfigurationChief.js

@@ -37,6 +37,7 @@ const defaultConfig = {
     ignore: [],
     ignoreBinaries: [],
     ignoreDependencies: [],
+    ignoreMembers: [],
     ignoreExportsUsedInFile: false,
     ignoreWorkspaces: [],
     isIncludeEntryExports: false,
@@ -123,6 +124,7 @@ export class ConfigurationChief {
         const ignore = arrayify(rawConfig.ignore ?? defaultConfig.ignore);
         const ignoreBinaries = (rawConfig.ignoreBinaries ?? []).map(toRegexOrString);
         const ignoreDependencies = (rawConfig.ignoreDependencies ?? []).map(toRegexOrString);
+        const ignoreMembers = (rawConfig.ignoreMembers ?? []).map(toRegexOrString);
         const ignoreExportsUsedInFile = rawConfig.ignoreExportsUsedInFile ?? false;
         const ignoreWorkspaces = rawConfig.ignoreWorkspaces ?? defaultConfig.ignoreWorkspaces;
         const isIncludeEntryExports = rawConfig.includeEntryExports ?? this.isIncludeEntryExports;
@@ -141,6 +143,7 @@ export class ConfigurationChief {
             ignore,
             ignoreBinaries,
             ignoreDependencies,
+            ignoreMembers,
             ignoreExportsUsedInFile,
             ignoreWorkspaces,
             isIncludeEntryExports,
@@ -271,6 +274,8 @@ export class ConfigurationChief {
             .map((name) => {
             const dir = join(this.cwd, name);
             const pkgName = this.availableWorkspaceManifests.find(p => p.dir === dir)?.manifest.name ?? `NOT_FOUND_${name}`;
+            const workspaceConfig = this.getWorkspaceConfig(name);
+            const ignoreMembers = arrayify(workspaceConfig.ignoreMembers).map(toRegexOrString);
             return {
                 name,
                 pkgName,
@@ -278,6 +283,7 @@ export class ConfigurationChief {
                 config: this.getConfigForWorkspace(name),
                 ancestors: this.availableWorkspaceNames.reduce(getAncestors(name), []),
                 manifestPath: join(dir, 'package.json'),
+                ignoreMembers,
             };
         });
     }
@@ -311,27 +317,24 @@ export class ConfigurationChief {
             .reverse()
             .find(pattern => micromatch.isMatch(workspaceName, pattern));
     }
-    getIgnores(workspaceName) {
+    getWorkspaceConfig(workspaceName) {
         const key = this.getConfigKeyForWorkspace(workspaceName);
         const workspaces = this.rawConfig?.workspaces ?? {};
-        const workspaceConfig = (key
+        return ((key
             ? key === ROOT_WORKSPACE_NAME && !(ROOT_WORKSPACE_NAME in workspaces)
                 ? this.rawConfig
                 : workspaces[key]
-            : {}) ?? {};
+            : {}) ?? {});
+    }
+    getIgnores(workspaceName) {
+        const workspaceConfig = this.getWorkspaceConfig(workspaceName);
         const ignoreBinaries = arrayify(workspaceConfig.ignoreBinaries).map(toRegexOrString);
         const ignoreDependencies = arrayify(workspaceConfig.ignoreDependencies).map(toRegexOrString);
         return { ignoreBinaries, ignoreDependencies };
     }
     getConfigForWorkspace(workspaceName, extensions) {
         const baseConfig = getDefaultWorkspaceConfig(extensions);
-        const key = this.getConfigKeyForWorkspace(workspaceName);
-        const workspaces = this.rawConfig?.workspaces ?? {};
-        const workspaceConfig = (key
-            ? key === ROOT_WORKSPACE_NAME && !(ROOT_WORKSPACE_NAME in workspaces)
-                ? this.rawConfig
-                : workspaces[key]
-            : {}) ?? {};
+        const workspaceConfig = this.getWorkspaceConfig(workspaceName);
         const entry = workspaceConfig.entry ? arrayify(workspaceConfig.entry) : baseConfig.entry;
         const project = workspaceConfig.project ? arrayify(workspaceConfig.project) : baseConfig.project;
         const paths = workspaceConfig.paths ?? {};

package/dist/ConfigurationValidator.d.ts

@@ -21,6 +21,7 @@ export declare const ConfigurationValidator: z.ZodObject<{
     ignore: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
     ignoreBinaries: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>]>, "many">>;
     ignoreDependencies: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>]>, "many">>;
+    ignoreMembers: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>]>, "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>]>>;
     ignoreWorkspaces: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
     includeEntryExports: z.ZodOptional<z.ZodBoolean>;
@@ -35,6 +36,7 @@ export declare const ConfigurationValidator: z.ZodObject<{
         ignore: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
         ignoreBinaries: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>]>, "many">>;
         ignoreDependencies: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>]>, "many">>;
+        ignoreMembers: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodType<RegExp, z.ZodTypeDef, RegExp>]>, "many">>;
         includeEntryExports: z.ZodOptional<z.ZodBoolean>;
         astro: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>, z.ZodObject<{
             config: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
@@ -758,6 +760,7 @@ export declare const ConfigurationValidator: z.ZodObject<{
         ignore?: string | string[] | undefined;
         ignoreBinaries?: (string | RegExp)[] | undefined;
         ignoreDependencies?: (string | RegExp)[] | undefined;
+        ignoreMembers?: (string | RegExp)[] | undefined;
         includeEntryExports?: boolean | undefined;
         astro?: string | boolean | string[] | {
             config?: string | string[] | undefined;
@@ -1041,6 +1044,7 @@ export declare const ConfigurationValidator: z.ZodObject<{
         ignore?: string | string[] | undefined;
         ignoreBinaries?: (string | RegExp)[] | undefined;
         ignoreDependencies?: (string | RegExp)[] | undefined;
+        ignoreMembers?: (string | RegExp)[] | undefined;
         includeEntryExports?: boolean | undefined;
         astro?: string | boolean | string[] | {
             config?: string | string[] | undefined;
@@ -2042,6 +2046,7 @@ export declare const ConfigurationValidator: z.ZodObject<{
     ignore?: string | string[] | undefined;
     ignoreBinaries?: (string | RegExp)[] | undefined;
     ignoreDependencies?: (string | RegExp)[] | undefined;
+    ignoreMembers?: (string | RegExp)[] | undefined;
     ignoreExportsUsedInFile?: boolean | Partial<Record<"function" | "type" | "enum" | "class" | "interface" | "member", boolean>> | undefined;
     ignoreWorkspaces?: string[] | undefined;
     includeEntryExports?: boolean | undefined;
@@ -2056,6 +2061,7 @@ export declare const ConfigurationValidator: z.ZodObject<{
         ignore?: string | string[] | undefined;
         ignoreBinaries?: (string | RegExp)[] | undefined;
         ignoreDependencies?: (string | RegExp)[] | undefined;
+        ignoreMembers?: (string | RegExp)[] | undefined;
         includeEntryExports?: boolean | undefined;
         astro?: string | boolean | string[] | {
             config?: string | string[] | undefined;
@@ -2617,6 +2623,7 @@ export declare const ConfigurationValidator: z.ZodObject<{
     ignore?: string | string[] | undefined;
     ignoreBinaries?: (string | RegExp)[] | undefined;
     ignoreDependencies?: (string | RegExp)[] | undefined;
+    ignoreMembers?: (string | RegExp)[] | undefined;
     ignoreExportsUsedInFile?: boolean | Partial<Record<"function" | "type" | "enum" | "class" | "interface" | "member", boolean>> | undefined;
     ignoreWorkspaces?: string[] | undefined;
     includeEntryExports?: boolean | undefined;
@@ -2631,6 +2638,7 @@ export declare const ConfigurationValidator: z.ZodObject<{
         ignore?: string | string[] | undefined;
         ignoreBinaries?: (string | RegExp)[] | undefined;
         ignoreDependencies?: (string | RegExp)[] | undefined;
+        ignoreMembers?: (string | RegExp)[] | undefined;
         includeEntryExports?: boolean | undefined;
         astro?: string | boolean | string[] | {
             config?: string | string[] | undefined;

package/dist/ConfigurationValidator.js

@@ -41,6 +41,7 @@ const rootConfigurationSchema = z.object({
     ignore: globSchema.optional(),
     ignoreBinaries: stringOrRegexSchema.optional(),
     ignoreDependencies: stringOrRegexSchema.optional(),
+    ignoreMembers: stringOrRegexSchema.optional(),
     ignoreExportsUsedInFile: ignoreExportsUsedInFileSchema.optional(),
     ignoreWorkspaces: z.array(z.string()).optional(),
     includeEntryExports: z.boolean().optional(),
@@ -125,6 +126,7 @@ const baseWorkspaceConfigurationSchema = z.object({
     ignore: globSchema.optional(),
     ignoreBinaries: stringOrRegexSchema.optional(),
     ignoreDependencies: stringOrRegexSchema.optional(),
+    ignoreMembers: stringOrRegexSchema.optional(),
     includeEntryExports: z.boolean().optional(),
 });
 const workspaceConfigurationSchema = baseWorkspaceConfigurationSchema.merge(pluginsSchema.partial());

package/dist/compilers/index.d.ts

@@ -12,6 +12,7 @@ export declare const partitionCompilers: (rawLocalConfig: RawConfiguration) => {
     ignore?: string | string[] | undefined;
     ignoreBinaries?: (string | RegExp)[] | undefined;
     ignoreDependencies?: (string | RegExp)[] | undefined;
+    ignoreMembers?: (string | RegExp)[] | undefined;
     ignoreExportsUsedInFile?: boolean | Partial<Record<"function" | "type" | "enum" | "class" | "interface" | "member", boolean>> | undefined;
     ignoreWorkspaces?: string[] | undefined;
     includeEntryExports?: boolean | undefined;
@@ -24,6 +25,7 @@ export declare const partitionCompilers: (rawLocalConfig: RawConfiguration) => {
         ignore?: string | string[] | undefined;
         ignoreBinaries?: (string | RegExp)[] | undefined;
         ignoreDependencies?: (string | RegExp)[] | undefined;
+        ignoreMembers?: (string | RegExp)[] | undefined;
         includeEntryExports?: boolean | undefined;
         astro?: string | boolean | string[] | {
             config?: string | string[] | undefined;

package/dist/index.js

@@ -14,6 +14,7 @@ import { getGitIgnoredFn } from './util/globby.js';
 import { getHandler } from './util/handleReferencedDependency.js';
 import { getEntryPathFromManifest, getPackageNameFromModuleSpecifier } from './util/modules.js';
 import { dirname, join } from './util/path.js';
+import { hasMatch } from './util/regex.js';
 import { shouldIgnore } from './util/tag.js';
 import { loadTSConfig } from './util/tsconfig-loader.js';
 import { getType, getHasStrictlyNsReferences } from './util/type.js';
@@ -273,7 +274,7 @@ export const main = async (unresolvedConfiguration) => {
         });
         principal.getUnreferencedFiles().forEach(filePath => unreferencedFiles.add(filePath));
         principal.entryPaths.forEach(filePath => entryPaths.add(filePath));
-        if (!isReportClassMembers)
+        if (isSkipLibs)
             factory.deletePrincipal(principal);
     }
     const isIdentifierReferenced = (filePath, id, importsForExport, depth = 0) => {
@@ -397,6 +398,8 @@ export const main = async (unresolvedConfiguration) => {
                         if (isIdentifierReferenced(filePath, identifier, importsForExport)) {
                             if (exportedItem.type === 'enum') {
                                 exportedItem.members?.forEach(member => {
+                                    if (hasMatch(workspace.ignoreMembers, member.identifier))
+                                        return;
                                     if (shouldIgnore(member.jsDocTags, tags))
                                         return;
                                     if (member.refs === 0) {
@@ -472,7 +475,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.jsDocTags, tags));
+                const members = exportedItem.members.filter(member => !hasMatch(workspace.ignoreMembers, member.identifier) && !shouldIgnore(member.jsDocTags, tags));
                 principal.findUnusedMembers(filePath, members).forEach(member => {
                     collector.addIssue({
                         type: 'classMembers',

package/dist/types/config.d.ts

@@ -34,6 +34,7 @@ export interface Configuration {
     ignoreBinaries: IgnorePatterns;
     ignoreDependencies: IgnorePatterns;
     ignoreExportsUsedInFile: boolean | Partial<Record<IgnorableExport, boolean>>;
+    ignoreMembers: IgnorePatterns;
     ignoreWorkspaces: string[];
     isIncludeEntryExports: boolean;
     syncCompilers: SyncCompilers;

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "5.3.1";
+export declare const version = "5.4.0";

package/dist/version.js

@@ -1 +1 @@
-export const version = '5.3.1';
+export const version = '5.4.0';

package/package.json

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

package/schema.json

@@ -31,6 +31,11 @@
       "examples": ["husky", "lint-staged"],
       "$ref": "#/definitions/list"
     },
+    "ignoreMembers": {
+      "title": "Class members to ignore (regex allowed)",
+      "examples": ["render", "on.*"],
+      "$ref": "#/definitions/list"
+    },
     "ignoreWorkspaces": {
       "title": "Workspaces to ignore",
       "examples": ["packages/ignore-me"],