knip 1.0.0-beta.3 → 1.0.0-beta.4

package/README.md

@@ -57,7 +57,9 @@ Knip supports LTS versions of Node.js, and currently requires at least Node.js v
 
 ## Usage
 
-Create a configuration file, let's give it the default name `knip.json` with these contents:
+Knip has good defaults and you can run it without any configuration, but especially larger projects get more out of Knip
+with a configuration file (or a `knip` property in `package.json`). Let's name this file `knip.json` with these contents
+(you might want to adjust right away for your project):
 
 ```json
 {

package/dist/cli.js

@@ -8,7 +8,7 @@ import parsedArgs from './util/parseArgs.js';
 import { measure } from './util/performance.js';
 import { main } from './index.js';
 register();
-const { values: { debug: isDebug = false, help, 'max-issues': maxIssues = '0', 'no-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': noProgress = false, production: isProduction = false, reporter = 'symbols', 'reporter-options': reporterOptions = '', strict: isStrict = false, tsConfig, }, } = parsedArgs;
+const { values: { debug: isDebug = false, help, 'ignore-entry-exports': isIgnoreEntryExports = false, 'max-issues': maxIssues = '0', 'no-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': noProgress = false, production: isProduction = false, reporter = 'symbols', 'reporter-options': reporterOptions = '', strict: isStrict = false, tsConfig, }, } = parsedArgs;
 if (help) {
     printHelp();
     process.exit(0);
@@ -25,6 +25,7 @@ const run = async () => {
             isStrict,
             isProduction,
             isShowProgress,
+            isIgnoreEntryExports,
         });
         await printReport({ report, issues, cwd, isProduction, options: reporterOptions });
         const totalErrorCount = Object.keys(report)

package/dist/configuration-chief.js

@@ -7,6 +7,7 @@ import * as plugins from './plugins/index.js';
 import { arrayify } from './util/array.js';
 import { ConfigurationError } from './util/errors.js';
 import { findFile, loadJSON } from './util/fs.js';
+import { ensurePosixPath } from './util/glob.js';
 import parsedArgs from './util/parseArgs.js';
 import { resolveIncludedIssueTypes } from './util/resolve-included-issue-types.js';
 import { byPathDepth } from './util/workspace.js';
@@ -84,13 +85,14 @@ export default class ConfigurationChief {
                 .reduce((workspaces, workspace) => {
                 const [workspaceName, workspaceConfig] = workspace;
                 const entry = workspaceConfig.entry ? arrayify(workspaceConfig.entry) : defaultWorkspaceConfig.entry;
+                const project = workspaceConfig.project
+                    ? arrayify(workspaceConfig.project)
+                    : workspaceConfig.entry
+                        ? entry
+                        : defaultWorkspaceConfig.project;
                 workspaces[workspaceName] = {
                     entry,
-                    project: workspaceConfig.project
-                        ? arrayify(workspaceConfig.project)
-                        : workspaceConfig.entry
-                            ? entry
-                            : defaultWorkspaceConfig.project,
+                    project,
                     ignore: arrayify(workspaceConfig.ignore),
                 };
                 for (const [pluginName, pluginConfig] of Object.entries(workspaceConfig)) {
@@ -125,7 +127,9 @@ export default class ConfigurationChief {
                 ignore: this.config.ignoreWorkspaces,
                 absolute: false,
             });
-            this.manifestWorkspaces = Array.from(workspaces.values()).map(dir => path.relative(this.cwd, dir));
+            this.manifestWorkspaces = Array.from(workspaces.values())
+                .map(dir => path.relative(this.cwd, dir))
+                .map(ensurePosixPath);
             return this.manifestWorkspaces;
         }
         return [];
@@ -185,8 +189,9 @@ export default class ConfigurationChief {
     }
     async getNegatedWorkspacePatterns(name) {
         const descendentWorkspaces = await this.getDescendentWorkspaces(name);
+        const matchName = new RegExp(`^${name}/`);
         return descendentWorkspaces
-            .map(workspaceName => path.relative(path.join(this.cwd, name), workspaceName))
+            .map(workspaceName => workspaceName.replace(matchName, ''))
             .map(workspaceName => `!${workspaceName}`);
     }
     getConfigKeyForWorkspace(workspaceName) {

package/dist/configuration-validator.d.ts

@@ -856,10 +856,10 @@ export declare const ConfigurationValidator: z.ZodObject<z.extendShape<z.extendS
 }>, "strip", z.ZodTypeAny, {
     exclude?: string[] | undefined;
     ignore?: string | string[] | undefined;
-    ignoreBinaries?: string[] | undefined;
     include?: string[] | undefined;
     entry?: string | string[] | undefined;
     project?: string | string[] | undefined;
+    ignoreBinaries?: string[] | undefined;
     ignoreDependencies?: string[] | undefined;
     ignoreWorkspaces?: string[] | undefined;
     babel?: string | false | string[] | {
@@ -1100,10 +1100,10 @@ export declare const ConfigurationValidator: z.ZodObject<z.extendShape<z.extendS
 }, {
     exclude?: string[] | undefined;
     ignore?: string | string[] | undefined;
-    ignoreBinaries?: string[] | undefined;
     include?: string[] | undefined;
     entry?: string | string[] | undefined;
     project?: string | string[] | undefined;
+    ignoreBinaries?: string[] | undefined;
     ignoreDependencies?: string[] | undefined;
     ignoreWorkspaces?: string[] | undefined;
     babel?: string | false | string[] | {

package/dist/index.js

@@ -9,14 +9,14 @@ import { compact } from './util/array.js';
 import { debugLogObject, debugLogFiles } from './util/debug.js';
 import { _findImportModuleSpecifiers } from './util/find-import-specifiers.js';
 import { findFile, loadJSON } from './util/fs.js';
-import { _glob } from './util/glob.js';
+import { _glob, ensurePosixPath } from './util/glob.js';
 import { getPackageNameFromModuleSpecifier } from './util/modules.js';
 import { _findDuplicateExportedNames } from './util/project.js';
 import { loadTSConfig } from './util/tsconfig-loader.js';
 import { byPathDepth } from './util/workspace.js';
 import WorkspaceWorker from './workspace-worker.js';
 export const main = async (unresolvedConfiguration) => {
-    const { cwd, tsConfigFile, gitignore, isStrict, isProduction, isShowProgress } = unresolvedConfiguration;
+    const { cwd, tsConfigFile, gitignore, isStrict, isProduction, isShowProgress, isIgnoreEntryExports } = unresolvedConfiguration;
     const chief = new ConfigurationChief({ cwd, isStrict, isProduction });
     debugLogObject('Unresolved configuration', unresolvedConfiguration);
     const collector = new IssueCollector({ cwd, isShowProgress });
@@ -81,6 +81,8 @@ export const main = async (unresolvedConfiguration) => {
                 });
                 debugLogFiles(`Globbed entry paths${suffix}`, workspaceEntryPaths);
                 workspaceEntryPaths.forEach(entryPath => principal.addEntryPath(entryPath));
+                if (isIgnoreEntryExports)
+                    workspaceEntryPaths.forEach(entryPath => lab.skipExportsAnalysisFor(entryPath));
                 collector.updateMessage(`Resolving production plugin entry files${suffix}...`);
                 const pluginWorkspaceEntryPaths = await _glob({
                     cwd,
@@ -120,6 +122,8 @@ export const main = async (unresolvedConfiguration) => {
                     });
                     debugLogFiles(`Globbed entry paths${suffix}`, workspaceEntryPaths);
                     workspaceEntryPaths.forEach(entryPath => principal.addEntryPath(entryPath));
+                    if (isIgnoreEntryExports)
+                        workspaceEntryPaths.forEach(entryPath => lab.skipExportsAnalysisFor(entryPath));
                 }
                 {
                     collector.updateMessage(`Resolving project files${suffix}...`);
@@ -232,7 +236,7 @@ export const main = async (unresolvedConfiguration) => {
         const filePath = sourceFile.getFilePath();
         if (report.dependencies || report.unlisted) {
             const filePath = sourceFile.getFilePath();
-            const workspaceDir = workspaceDirs.find(workspaceDir => filePath.startsWith(workspaceDir));
+            const workspaceDir = workspaceDirs.find(workspaceDir => filePath.startsWith(ensurePosixPath(workspaceDir)));
             const workspace = workspaces.find(workspace => workspace.dir === workspaceDir);
             if (workspace) {
                 const [, externalModuleSpecifiers] = moduleSpecifierCache.get(sourceFile) ?? _findImportModuleSpecifiers(sourceFile, { skipInternal: true });

package/dist/source-lab.js

@@ -52,23 +52,17 @@ export default class SourceLab {
                 if (declaration.isKind(ts.SyntaxKind.EnumDeclaration)) {
                     identifier = declaration.getFirstChildByKind(ts.SyntaxKind.Identifier);
                     if (report.enumMembers) {
-                        findUnusedEnumMembers(declaration, filePath).forEach(member => issues.add({
-                            type: 'enumMembers',
-                            filePath,
-                            symbol: member.getName().replace(/['"`]/g, ''),
-                            parentSymbol: identifier?.getText(),
-                        }));
+                        findUnusedEnumMembers(declaration, filePath).forEach(symbol => {
+                            issues.add({ type: 'enumMembers', filePath, symbol, parentSymbol: identifier?.getText() });
+                        });
                     }
                 }
                 else if (declaration.isKind(ts.SyntaxKind.ClassDeclaration)) {
                     identifier = declaration.getFirstChildByKind(ts.SyntaxKind.Identifier);
                     if (report.classMembers) {
-                        findUnusedClassMembers(declaration, filePath).forEach(member => issues.add({
-                            type: 'classMembers',
-                            filePath,
-                            symbol: member.getName(),
-                            parentSymbol: identifier?.getText(),
-                        }));
+                        findUnusedClassMembers(declaration, filePath).forEach(symbol => {
+                            issues.add({ type: 'classMembers', filePath, symbol, parentSymbol: identifier?.getText() });
+                        });
                     }
                 }
                 if (Node.isExportGetable(declaration) &&

package/dist/types/cli.d.ts

@@ -5,4 +5,5 @@ export interface CommandLineOptions {
     isStrict: boolean;
     isProduction: boolean;
     isShowProgress: boolean;
+    isIgnoreEntryExports: boolean;
 }

package/dist/util/glob.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="nano-memoize" />
+export declare const ensurePosixPath: (value: string) => string;
 export declare const negate: (pattern: string) => string;
 export declare const hasProductionSuffix: (pattern: string) => boolean;
 export declare const hasNoProductionSuffix: (pattern: string) => boolean;

package/dist/util/glob.js

@@ -5,7 +5,7 @@ import memoize from 'nano-memoize';
 import { compact } from './array.js';
 import { debugLogObject } from './debug.js';
 import { timerify } from './performance.js';
-const ensurePosixPath = (value) => value.split(path.sep).join(path.posix.sep);
+export const ensurePosixPath = (value) => value.split(path.sep).join(path.posix.sep);
 const prependDirToPattern = (workingDir, pattern) => {
     if (pattern.startsWith('!'))
         return '!' + path.posix.join(workingDir, pattern.slice(1));

package/dist/util/help.js

@@ -10,6 +10,7 @@ Options:
   --include              Report only listed issue type(s), can be comma-separated or repeated
   --exclude              Exclude issue type(s) from report, can be comma-separated or repeated
   --ignore               Ignore files matching this glob pattern, can be repeated
+  --ignore-entry-exports Ignore exports from entry files
   --no-gitignore         Don't use .gitignore
   --no-progress          Don't show dynamic progress updates
   --no-exit-code         Always exit with code zero (0)

package/dist/util/members.d.ts

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

package/dist/util/members.js

@@ -2,7 +2,8 @@ import { ts } from 'ts-morph';
 import { _findReferences, hasExternalReferences, hasInternalReferences } from './project.js';
 export const findUnusedClassMembers = (declaration, filePath) => {
     const members = declaration.getMembers();
-    return members.filter((member) => {
+    return members
+        .filter((member) => {
         const isPrivate = Boolean(member.getCombinedModifierFlags() & ts.ModifierFlags.Private);
         if (!isPrivate &&
             (member.isKind(ts.SyntaxKind.PropertyDeclaration) || member.isKind(ts.SyntaxKind.MethodDeclaration))) {
@@ -10,12 +11,15 @@ export const findUnusedClassMembers = (declaration, filePath) => {
             return !hasExternalReferences(refs, filePath) && !hasInternalReferences(refs);
         }
         return false;
-    });
+    })
+        .map(member => member.getName());
 };
 export const findUnusedEnumMembers = (declaration, filePath) => {
     const members = declaration.getMembers();
-    return members.filter(member => {
+    return members
+        .filter(member => {
         const refs = _findReferences(member);
         return !hasExternalReferences(refs, filePath) && !hasInternalReferences(refs);
-    });
+    })
+        .map(member => member.getName().replace(/['"`]/g, ''));
 };

package/dist/util/modules.js

@@ -1,9 +1,10 @@
+import { ensurePosixPath } from './glob.js';
 export const getPackageNameFromModuleSpecifier = (moduleSpecifier) => {
     const parts = moduleSpecifier.split('/').slice(0, 2);
     return moduleSpecifier.startsWith('@') ? parts.join('/') : parts[0];
 };
 export const getPackageName = (value) => {
-    const match = value.replace(/\\/g, '/').match(/(?<=node_modules\/)(@[^/]+\/[^/]+|[^/]+)/);
+    const match = ensurePosixPath(value).match(/(?<=node_modules\/)(@[^/]+\/[^/]+|[^/]+)/);
     if (match)
         return match[1];
     if (value.startsWith('@')) {

package/dist/util/parseArgs.d.ts

@@ -6,7 +6,7 @@ declare const _default: {
         exclude: string[] | undefined;
         help: boolean | undefined;
         ignore: string[] | undefined;
-        ignoreBinaries: string[] | undefined;
+        'ignore-entry-exports': boolean | undefined;
         include: string[] | undefined;
         'max-issues': string | undefined;
         'no-exit-code': boolean | undefined;

package/dist/util/parseArgs.js

@@ -7,7 +7,7 @@ export default parseArgs({
         exclude: { type: 'string', multiple: true },
         help: { type: 'boolean', short: 'h' },
         ignore: { type: 'string', multiple: true },
-        ignoreBinaries: { type: 'string', multiple: true },
+        'ignore-entry-exports': { type: 'boolean' },
         include: { type: 'string', multiple: true },
         'max-issues': { type: 'string' },
         'no-exit-code': { type: 'boolean' },

package/dist/util/path.js

@@ -1,3 +1,4 @@
 import path from 'node:path';
+import { ensurePosixPath } from './glob.js';
 const cwd = process.cwd();
-export const relative = (to) => path.relative(cwd, to).replace(/\\/g, '/');
+export const relative = (to) => ensurePosixPath(path.relative(cwd, to));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.4",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript project",
   "keywords": [
     "find",
@@ -61,7 +61,7 @@
     "@snyk/github-codeowners": "1.1.0",
     "chalk": "5.2.0",
     "easy-table": "1.2.0",
-    "esbuild": "0.16.11",
+    "esbuild": "0.16.12",
     "esbuild-register": "3.4.2",
     "eslint": "8.30.0",
     "fast-glob": "3.2.12",
@@ -91,7 +91,7 @@
     "eslint-import-resolver-typescript": "3.5.2",
     "eslint-plugin-import": "2.26.0",
     "globstar": "1.0.0",
-    "release-it": "15.5.1",
+    "release-it": "15.6.0",
     "remark-cli": "11.0.0",
     "remark-preset-webpro": "0.0.1",
     "tsx": "3.12.1",