knip 1.0.0-alpha.1 → 1.0.0-alpha.2

package/dist/configuration-chief.js

@@ -103,10 +103,12 @@ export default class ConfigurationChief {
                         const config = isObject ? arrayify(pluginConfig.config) : arrayify(pluginConfig);
                         const entryFiles = isObject && 'entryFiles' in pluginConfig ? arrayify(pluginConfig.entryFiles) : [];
                         const projectFiles = isObject && 'projectFiles' in pluginConfig ? arrayify(pluginConfig.projectFiles) : entryFiles;
+                        const sampleFiles = isObject && 'sampleFiles' in pluginConfig ? arrayify(pluginConfig.sampleFiles) : [];
                         workspaces[workspaceName][pluginName] = {
                             config,
                             entryFiles,
                             projectFiles,
+                            sampleFiles,
                         };
                     }
                 }

package/dist/dependency-deputy.js

@@ -1,5 +1,6 @@
 import { isBuiltin } from 'node:module';
 import micromatch from 'micromatch';
+import { isDefinitelyTyped, getDefinitelyTypedPackage } from './util/modules.js';
 const IGNORE_DEFINITELY_TYPED = ['node'];
 export default class DependencyDeputy {
     _manifests = new Map();
@@ -69,12 +70,14 @@ export default class DependencyDeputy {
         const packageName = this.resolvePackageName(moduleSpecifier);
         const workspaceNames = isStrict ? [workspace.name] : [workspace.name, ...[...workspace.ancestors].reverse()];
         const closestWorkspaceName = workspaceNames.find(name => this.isInDependencies(name, packageName));
-        if (closestWorkspaceName) {
-            this.addReferencedDependency(closestWorkspaceName, packageName);
-        }
-        else {
-            return moduleSpecifier;
+        const typesPackageName = !isDefinitelyTyped(packageName) && getDefinitelyTypedPackage(packageName);
+        const closestWorkspaceNameForTypes = typesPackageName && workspaceNames.find(name => this.isInDependencies(name, typesPackageName));
+        if (closestWorkspaceName || closestWorkspaceNameForTypes) {
+            closestWorkspaceName && this.addReferencedDependency(closestWorkspaceName, packageName);
+            closestWorkspaceNameForTypes && this.addReferencedDependency(closestWorkspaceNameForTypes, typesPackageName);
+            return;
         }
+        return moduleSpecifier;
     }
     isInternalDependency(workspaceName, moduleSpecifier) {
         if (moduleSpecifier.startsWith('/') || moduleSpecifier.startsWith('.'))
@@ -104,15 +107,13 @@ export default class DependencyDeputy {
                 continue;
             const referencedDependencies = this.referencedDependencies.get(workspaceName);
             const isUnreferencedDependency = (dependency) => {
+                if (referencedDependencies?.has(dependency))
+                    return false;
                 const [scope, typedDependency] = dependency.split('/');
                 if (scope === '@types') {
                     if (IGNORE_DEFINITELY_TYPED.includes(typedDependency))
                         return false;
-                    if (referencedDependencies?.has(dependency))
-                        return false;
-                    const [scope, name] = typedDependency.split('__');
-                    const typedPackageName = scope && name ? `@${scope}/${name}` : typedDependency;
-                    return referencedDependencies ? !referencedDependencies.has(typedPackageName) : false;
+                    return !referencedDependencies?.has(typedDependency);
                 }
                 if (!referencedDependencies?.has(dependency)) {
                     const peerDependencies = Array.from(this.peerDependencies.get(workspaceName)?.get(dependency) ?? []);

package/dist/index.js

@@ -7,8 +7,10 @@ import SourceLab from './source-lab.js';
 import { compact } from './util/array.js';
 import { ROOT_WORKSPACE_NAME } from './util/constants.js';
 import { debugLogObject, debugLogFiles } from './util/debug.js';
+import { _findExternalImportModuleSpecifiers } from './util/externalImports.js';
 import { findFile, loadJSON } from './util/fs.js';
 import { _glob } from './util/glob.js';
+import { _findDuplicateExportedNames } from './util/project.js';
 import { loadTSConfig } from './util/tsconfig-loader.js';
 import WorkspaceWorker from './workspace-worker.js';
 export const main = async (unresolvedConfiguration) => {
@@ -211,15 +213,23 @@ export const main = async (unresolvedConfiguration) => {
         const filePath = sourceFile.getFilePath();
         const workspaceDir = workspaceDirs.find(workspaceDir => filePath.startsWith(workspaceDir));
         const workspace = workspaces.find(workspace => workspace.dir === workspaceDir);
-        const { externalModuleSpecifiers, issues } = lab.analyzeSourceFile(sourceFile);
-        issues.forEach(issue => issue.type && collector.addIssue(issue));
-        if (workspace) {
+        if (workspace && (report.dependencies || report.unlisted)) {
+            const externalModuleSpecifiers = _findExternalImportModuleSpecifiers(sourceFile);
             externalModuleSpecifiers.forEach(moduleSpecifier => {
                 const unlistedDependency = deputy.maybeAddListedReferencedDependency(workspace, moduleSpecifier, isStrict);
                 if (unlistedDependency)
                     collector.addIssue({ type: 'unlisted', filePath, symbol: unlistedDependency });
             });
         }
+        if (report.duplicates) {
+            const duplicateExports = _findDuplicateExportedNames(sourceFile);
+            duplicateExports.forEach(symbols => {
+                const symbol = symbols.join('|');
+                collector.addIssue({ type: 'duplicates', filePath, symbol, symbols });
+            });
+        }
+        const issues = lab.analyzeSourceFile(sourceFile);
+        issues.forEach(issue => issue.type && collector.addIssue(issue));
     });
     collector.removeProgress();
     if (report.dependencies) {

package/dist/plugins/eslint/index.js

@@ -8,6 +8,7 @@ export const isEnabled = ({ dependencies }) => {
     return dependencies.has('eslint');
 };
 export const CONFIG_FILE_PATTERNS = ['eslint.config.js', '.eslintrc', '.eslintrc.json', '.eslintrc.js'];
+const SAMPLE_FILE_PATHS = ['__placeholder__.js', '__placeholder__.ts'];
 const resolvePluginPackageName = (pluginName) => {
     return pluginName.startsWith('@')
         ? pluginName.includes('/')
@@ -15,16 +16,15 @@ const resolvePluginPackageName = (pluginName) => {
             : `${pluginName}/eslint-plugin`
         : `eslint-plugin-${pluginName}`;
 };
-const findESLintDependencies = async (configFilePath, { cwd }) => {
+const findESLintDependencies = async (configFilePath, { cwd, config }) => {
     if (path.basename(configFilePath) === 'eslint.config.js') {
         return [];
     }
     else {
         const engine = new ESLint({ cwd, overrideConfigFile: configFilePath, useEslintrc: false });
-        const jsConfig = await engine.calculateConfigForFile('__placeholder__.js');
-        const tsConfig = await engine.calculateConfigForFile('__placeholder__.ts');
-        const tsxConfig = await engine.calculateConfigForFile('__placeholder__.spec.tsx');
-        const dependencies = [jsConfig, tsConfig, tsxConfig].map(config => {
+        const calculateConfigForFile = async (sampleFile) => await engine.calculateConfigForFile(sampleFile);
+        const sampleFiles = config?.sampleFiles.length > 0 ? config.sampleFiles : SAMPLE_FILE_PATHS;
+        const dependencies = await Promise.all(sampleFiles.map(calculateConfigForFile)).then(configs => configs.flatMap(config => {
             if (!config)
                 return [];
             const plugins = config.plugins?.map(resolvePluginPackageName) ?? [];
@@ -32,7 +32,7 @@ const findESLintDependencies = async (configFilePath, { cwd }) => {
             const extraParsers = config.parserOptions?.babelOptions?.presets ?? [];
             const settings = config.settings ? getDependenciesFromSettings(config.settings) : [];
             return [...parsers, ...extraParsers, ...plugins, ...settings].map(getPackageName);
-        });
+        }));
         return compact(dependencies.flat());
     }
 };

package/dist/plugins/rollup/index.js

@@ -1,3 +1,3 @@
 export const isEnabled = ({ dependencies }) => dependencies.has('rollup');
 export const CONFIG_FILE_PATTERNS = [];
-export const ENTRY_FILE_PATTERNS = ['rollup.config.{js,mjs}'];
+export const ENTRY_FILE_PATTERNS = ['rollup.config.{js,mjs,ts}'];

package/dist/source-lab.d.ts

@@ -13,10 +13,7 @@ export default class SourceLab {
     isReportTypes: boolean;
     constructor({ report, workspaceDirs }: FileLabOptions);
     skipExportsAnalysisFor(filePath: string | string[]): void;
-    analyzeSourceFile(sourceFile: SourceFile): {
-        externalModuleSpecifiers: string[];
-        issues: Set<Issue>;
-    };
+    analyzeSourceFile(sourceFile: SourceFile): Set<Issue>;
     private analyzeExports;
 }
 export {};

package/dist/source-lab.js

@@ -1,7 +1,6 @@
 import { ts, Node } from 'ts-morph';
-import { _findExternalImportModuleSpecifiers } from './util/externalImports.js';
 import { findUnusedClassMembers, findUnusedEnumMembers } from './util/members.js';
-import { _findDuplicateExportedNames, _hasReferencingDefaultImport, _findReferencingNamespaceNodes, _getExportedDeclarations, _findReferences, hasExternalReferences, } from './util/project.js';
+import { _hasReferencingDefaultImport, _findReferencingNamespaceNodes, _getExportedDeclarations, _findReferences, hasExternalReferences, } from './util/project.js';
 import { getType } from './util/type.js';
 export default class SourceLab {
     report;
@@ -26,26 +25,14 @@ export default class SourceLab {
     }
     analyzeSourceFile(sourceFile) {
         const issues = new Set();
-        const report = this.report;
         const filePath = sourceFile.getFilePath();
-        let externalModuleSpecifiers = [];
-        if (report.dependencies || report.unlisted) {
-            externalModuleSpecifiers = _findExternalImportModuleSpecifiers(sourceFile);
-        }
-        if (report.duplicates) {
-            const duplicateExports = _findDuplicateExportedNames(sourceFile);
-            duplicateExports.forEach(symbols => {
-                const symbol = symbols.join('|');
-                issues.add({ type: 'duplicates', filePath, symbol, symbols });
-            });
-        }
         if (this.skipExportsAnalysis.has(filePath))
-            return { externalModuleSpecifiers, issues };
+            return issues;
         if (this.isReportExports) {
             const exportsIssues = this.analyzeExports(sourceFile);
             exportsIssues.forEach(issue => issues.add(issue));
         }
-        return { externalModuleSpecifiers, issues };
+        return issues;
     }
     analyzeExports(sourceFile) {
         const issues = new Set();

package/dist/types/config.d.ts

@@ -3,6 +3,7 @@ export interface PluginConfiguration {
     config: NormalizedGlob;
     entryFiles: NormalizedGlob;
     projectFiles: NormalizedGlob;
+    sampleFiles: NormalizedGlob;
 }
 interface PluginsConfiguration {
     babel: PluginConfiguration;

package/dist/types/plugins.d.ts

@@ -1,4 +1,5 @@
 import { PackageJson } from 'type-fest';
+import { PluginConfiguration } from './config.js';
 type IsPluginEnabledCallbackOptions = {
     manifest: PackageJson;
     dependencies: Set<string>;
@@ -7,5 +8,6 @@ export type IsPluginEnabledCallback = (options: IsPluginEnabledCallbackOptions)
 export type GenericPluginCallback = (configFilePath: string, { cwd, manifest }: {
     cwd: string;
     manifest: PackageJson;
+    config: PluginConfiguration;
 }) => Promise<string[]> | string[];
 export {};

package/dist/types/validate.d.ts

@@ -85,16 +85,19 @@ export declare const LocalConfiguration: z.ZodObject<z.extendShape<z.extendShape
             entryFiles: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
             productionEntryFiles: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
             projectFiles: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+            sampleFiles: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
         }, "strip", z.ZodTypeAny, {
             config?: string | string[] | undefined;
             entryFiles?: string | string[] | undefined;
             projectFiles?: string | string[] | undefined;
             productionEntryFiles?: string | string[] | undefined;
+            sampleFiles?: string | string[] | undefined;
         }, {
             config?: string | string[] | undefined;
             entryFiles?: string | string[] | undefined;
             projectFiles?: string | string[] | undefined;
             productionEntryFiles?: string | string[] | undefined;
+            sampleFiles?: string | string[] | undefined;
         }>]>>;
         gatsby: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>, z.ZodObject<{
             config: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
@@ -290,6 +293,7 @@ export declare const LocalConfiguration: z.ZodObject<z.extendShape<z.extendShape
             entryFiles?: string | string[] | undefined;
             projectFiles?: string | string[] | undefined;
             productionEntryFiles?: string | string[] | undefined;
+            sampleFiles?: string | string[] | undefined;
         } | undefined;
         gatsby?: string | string[] | {
             config?: string | string[] | undefined;
@@ -385,6 +389,7 @@ export declare const LocalConfiguration: z.ZodObject<z.extendShape<z.extendShape
             entryFiles?: string | string[] | undefined;
             projectFiles?: string | string[] | undefined;
             productionEntryFiles?: string | string[] | undefined;
+            sampleFiles?: string | string[] | undefined;
         } | undefined;
         gatsby?: string | string[] | {
             config?: string | string[] | undefined;
@@ -517,16 +522,19 @@ export declare const LocalConfiguration: z.ZodObject<z.extendShape<z.extendShape
         entryFiles: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
         productionEntryFiles: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
         projectFiles: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+        sampleFiles: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
     }, "strip", z.ZodTypeAny, {
         config?: string | string[] | undefined;
         entryFiles?: string | string[] | undefined;
         projectFiles?: string | string[] | undefined;
         productionEntryFiles?: string | string[] | undefined;
+        sampleFiles?: string | string[] | undefined;
     }, {
         config?: string | string[] | undefined;
         entryFiles?: string | string[] | undefined;
         projectFiles?: string | string[] | undefined;
         productionEntryFiles?: string | string[] | undefined;
+        sampleFiles?: string | string[] | undefined;
     }>]>>;
     gatsby: z.ZodOptional<z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>, z.ZodObject<{
         config: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
@@ -726,6 +734,7 @@ export declare const LocalConfiguration: z.ZodObject<z.extendShape<z.extendShape
         entryFiles?: string | string[] | undefined;
         projectFiles?: string | string[] | undefined;
         productionEntryFiles?: string | string[] | undefined;
+        sampleFiles?: string | string[] | undefined;
     } | undefined;
     gatsby?: string | string[] | {
         config?: string | string[] | undefined;
@@ -821,6 +830,7 @@ export declare const LocalConfiguration: z.ZodObject<z.extendShape<z.extendShape
             entryFiles?: string | string[] | undefined;
             projectFiles?: string | string[] | undefined;
             productionEntryFiles?: string | string[] | undefined;
+            sampleFiles?: string | string[] | undefined;
         } | undefined;
         gatsby?: string | string[] | {
             config?: string | string[] | undefined;
@@ -921,6 +931,7 @@ export declare const LocalConfiguration: z.ZodObject<z.extendShape<z.extendShape
         entryFiles?: string | string[] | undefined;
         projectFiles?: string | string[] | undefined;
         productionEntryFiles?: string | string[] | undefined;
+        sampleFiles?: string | string[] | undefined;
     } | undefined;
     gatsby?: string | string[] | {
         config?: string | string[] | undefined;
@@ -1016,6 +1027,7 @@ export declare const LocalConfiguration: z.ZodObject<z.extendShape<z.extendShape
             entryFiles?: string | string[] | undefined;
             projectFiles?: string | string[] | undefined;
             productionEntryFiles?: string | string[] | undefined;
+            sampleFiles?: string | string[] | undefined;
         } | undefined;
         gatsby?: string | string[] | {
             config?: string | string[] | undefined;

package/dist/types/validate.js

@@ -21,12 +21,22 @@ const pluginWithEntryFilesSchema = z.union([
         projectFiles: globSchema.optional(),
     }),
 ]);
+const pluginWithSampleFilesSchema = z.union([
+    globSchema,
+    z.object({
+        config: globSchema.optional(),
+        entryFiles: globSchema.optional(),
+        productionEntryFiles: globSchema.optional(),
+        projectFiles: globSchema.optional(),
+        sampleFiles: globSchema.optional(),
+    }),
+]);
 const pluginsConfigurationSchema = z.object({
     babel: pluginWithEntryFilesSchema,
     capacitor: pluginWithEntryFilesSchema,
     changesets: pluginWithEntryFilesSchema,
     cypress: pluginWithEntryFilesSchema,
-    eslint: pluginWithEntryFilesSchema,
+    eslint: pluginWithSampleFilesSchema,
     gatsby: pluginWithEntryFilesSchema,
     jest: pluginWithEntryFilesSchema,
     next: pluginWithEntryFilesSchema,

package/dist/util/members.d.ts

@@ -1,4 +1,4 @@
 import { MethodDeclaration, PropertyDeclaration } from 'ts-morph';
 import type { ClassDeclaration, EnumDeclaration } from 'ts-morph';
-export declare const findUnusedClassMembers: (declaration: ClassDeclaration, filePath: string) => (PropertyDeclaration | MethodDeclaration)[];
+export declare const findUnusedClassMembers: (declaration: ClassDeclaration, filePath: string) => (MethodDeclaration | PropertyDeclaration)[];
 export declare const findUnusedEnumMembers: (declaration: EnumDeclaration, filePath: string) => import("ts-morph").EnumMember[];

package/dist/util/modules.d.ts

@@ -1 +1,3 @@
 export declare const getPackageName: (value: string) => string;
+export declare const isDefinitelyTyped: (packageName: string) => boolean;
+export declare const getDefinitelyTypedPackage: (packageName: string) => string;

package/dist/util/modules.js

@@ -8,3 +8,9 @@ export const getPackageName = (value) => {
     }
     return value.startsWith('/') ? value : value.split('/')[0];
 };
+export const isDefinitelyTyped = (packageName) => packageName.startsWith('@types/');
+export const getDefinitelyTypedPackage = (packageName) => {
+    if (isDefinitelyTyped(packageName))
+        return packageName;
+    return '@types/' + packageName.replace('@', '__');
+};

package/dist/workspace-worker.js

@@ -51,7 +51,7 @@ export default class WorkspaceWorker {
     }
     getConfigForPlugin(pluginName) {
         return (this.config[pluginName] ??
-            this.rootWorkspaceConfig[pluginName] ?? { config: [], entryFiles: [], projectFiles: [] });
+            this.rootWorkspaceConfig[pluginName] ?? { config: [], entryFiles: [], projectFiles: [], sampleFiles: [] });
     }
     async init() {
         this.setEnabledPlugins();
@@ -212,11 +212,16 @@ export default class WorkspaceWorker {
         const cwd = this.dir;
         const ignore = this.getWorkspaceIgnorePatterns();
         const configFilePaths = await _pureGlob({ patterns, cwd, ignore });
+        const pluginConfig = this.getConfigForPlugin(pluginName);
         debugLogFiles(1, `Globbed ${pluginName} config file paths`, configFilePaths);
         if (configFilePaths.length === 0)
             return [];
         const referencedDependencyIssues = (await Promise.all(configFilePaths.map(async (configFilePath) => {
-            const dependencies = await pluginCallback(configFilePath, { cwd, manifest: this.manifest });
+            const dependencies = await pluginCallback(configFilePath, {
+                cwd,
+                manifest: this.manifest,
+                config: pluginConfig,
+            });
             return dependencies.map(symbol => ({ type: 'unlisted', filePath: configFilePath, symbol }));
         }))).flat();
         debugLogIssues(1, `Dependencies used by ${pluginName} configuration`, referencedDependencyIssues);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.2",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript project",
   "keywords": [
     "find",