knip 1.8.0 → 1.9.0

package/README.md

@@ -66,6 +66,19 @@ with a configuration file (or a `knip` property in `package.json`). Let's name t
 The `entry` files target the starting point(s) to resolve the rest of the imported code. The `project` files should
 contain all files to match against the files resolved from the entry files, including potentially unused files.
 
+Use `knip.ts` with TypeScript if you prefer:
+
+```ts
+import type { KnipConfig } from 'knip';
+
+const config: KnipConfig = {
+  entry: ['src/index.ts'],
+  project: ['src/**/*.ts'],
+};
+
+export default config;
+```
+
 If you have, please see [workspaces & monorepos][1].
 
 Then run the checks with `npx knip`. Or first add this script to `package.json`:
@@ -84,11 +97,13 @@ Use `npm run knip` to analyze the project and output unused files, dependencies
 ## Command-line options
 
     $ npx knip --help
-    knip [options]
+    ✂️  Find unused files, dependencies and exports in your JavaScript and TypeScript projects
+
+    Usage: knip [options]
 
     Options:
-      -c/--config [file]       Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)
-      -t/--tsConfig [file]     TypeScript configuration path (default: tsconfig.json)
+      -c, --config [file]      Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)
+      -t, --tsConfig [file]    TypeScript configuration path (default: tsconfig.json)
       --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)
       --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)
       --workspace              Analyze a single workspace (default: analyze all configured workspaces)
@@ -107,6 +122,8 @@ Use `npm run knip` to analyze the project and output unused files, dependencies
       --debug                  Show debug output
       --debug-file-filter      Filter for files in debug output (regex as string)
       --performance            Measure running time of expensive functions and display stats table
+      --h, --help              Print this help text
+      --V, version             Print version
 
     (1) Issue types: files, dependencies, unlisted, exports, nsExports, classMembers, types, nsTypes, enumMembers, duplicates
 
@@ -119,7 +136,7 @@ Use `npm run knip` to analyze the project and output unused files, dependencies
     $ knip --reporter codeowners --reporter-options '{"path":".github/CODEOWNERS"}'
     $ knip --debug --debug-file-filter '(specific|particular)-module'
 
-    More info: https://github.com/webpro/knip
+    More documentation and bug reports: https://github.com/webpro/knip
 
 ## Screenshots
 
@@ -363,7 +380,7 @@ aliases. They can be configured manually:
 
 ```json
 {
-  "$schema": "/Users/lars/p/knip/schema.json",
+  "$schema": "https://unpkg.com/knip@1/schema.json",
   "paths": {
     "@lib": ["./lib/index.ts"],
     "@lib/*": ["./lib/*"]

package/dist/cli.js

@@ -6,13 +6,18 @@ import parsedArgs, { helpText } from './util/cli-arguments.js';
 import { ConfigurationError } from './util/errors.js';
 import { _load } from './util/loader.js';
 import { measure } from './util/performance.js';
+import { version } from './version.js';
 import { main } from './index.js';
 register();
-const { values: { debug: isDebug = false, help, 'include-entry-exports': isIncludeEntryExports = false, 'max-issues': maxIssues = '0', 'no-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': isNoProgress = false, production: isProduction = false, reporter = 'symbols', 'reporter-options': reporterOptions = '', strict: isStrict = false, tsConfig, }, } = parsedArgs;
-if (help) {
+const { values: { debug: isDebug = false, help: isHelp, 'include-entry-exports': isIncludeEntryExports = false, 'max-issues': maxIssues = '0', 'no-exit-code': noExitCode = false, 'no-gitignore': isNoGitIgnore = false, 'no-progress': isNoProgress = false, production: isProduction = false, reporter = 'symbols', 'reporter-options': reporterOptions = '', strict: isStrict = false, tsConfig, version: isVersion, }, } = parsedArgs;
+if (isHelp) {
     console.log(helpText);
     process.exit(0);
 }
+if (isVersion) {
+    console.log(version);
+    process.exit(0);
+}
 const cwd = process.cwd();
 const isShowProgress = !isDebug && isNoProgress === false && process.stdout.isTTY && typeof process.stdout.cursorTo === 'function';
 const printReport = reporter in reporters ? reporters[reporter] : await _load(path.join(cwd, reporter));

package/dist/configuration-chief.d.ts

@@ -12,6 +12,7 @@ export default class ConfigurationChief {
     manifestPath: undefined | string;
     manifest: undefined | PackageJson;
     manifestWorkspaces: undefined | string[];
+    resolvedConfigFilePath: undefined | string;
     constructor({ cwd, isProduction }: ConfigurationManagerOptions);
     loadLocalConfig(): Promise<void>;
     normalize(rawLocalConfig: RawConfiguration): {

package/dist/configuration-chief.js

@@ -34,6 +34,7 @@ export default class ConfigurationChief {
     manifestPath;
     manifest;
     manifestWorkspaces;
+    resolvedConfigFilePath;
     constructor({ cwd, isProduction }) {
         this.cwd = cwd;
         this.isProduction = isProduction;
@@ -52,16 +53,15 @@ export default class ConfigurationChief {
         if (this.manifest && !this.manifest.workspaces && pnpmWorkspaces) {
             this.manifest.workspaces = pnpmWorkspaces;
         }
-        let resolvedConfigFilePath;
         for (const configPath of rawConfigArg ? [rawConfigArg] : KNIP_CONFIG_LOCATIONS) {
-            resolvedConfigFilePath = findFile(this.cwd, configPath);
-            if (resolvedConfigFilePath)
+            this.resolvedConfigFilePath = findFile(this.cwd, configPath);
+            if (this.resolvedConfigFilePath)
                 break;
         }
-        if (rawConfigArg && !resolvedConfigFilePath && !manifest.knip) {
+        if (rawConfigArg && !this.resolvedConfigFilePath && !manifest.knip) {
             throw new ConfigurationError(`Unable to find ${rawConfigArg} or package.json#knip`);
         }
-        const rawLocalConfig = resolvedConfigFilePath ? await _load(resolvedConfigFilePath) : manifest.knip;
+        const rawLocalConfig = this.resolvedConfigFilePath ? await _load(this.resolvedConfigFilePath) : manifest.knip;
         if (rawLocalConfig) {
             this.config = this.normalize(ConfigurationValidator.parse(rawLocalConfig));
         }

package/dist/index.js

@@ -17,7 +17,7 @@ import WorkspaceWorker from './workspace-worker.js';
 export const main = async (unresolvedConfiguration) => {
     const { cwd, tsConfigFile, gitignore, isStrict, isProduction, isShowProgress, isIncludeEntryExports } = unresolvedConfiguration;
     const chief = new ConfigurationChief({ cwd, isProduction });
-    debugLogObject('Unresolved configuration', unresolvedConfiguration);
+    debugLogObject('Unresolved configuration (from CLI arguments)', unresolvedConfiguration);
     const collector = new IssueCollector({ cwd, isShowProgress });
     collector.updateMessage('Reading configuration and manifest files...');
     await chief.loadLocalConfig();
@@ -195,6 +195,9 @@ export const main = async (unresolvedConfiguration) => {
     }
     collector.setReport(report);
     collector.updateMessage('Connecting the dots...');
+    if (chief.resolvedConfigFilePath) {
+        principal.removeProjectPath(chief.resolvedConfigFilePath);
+    }
     principal.createProjects();
     const moduleSpecifierCache = new WeakMap();
     const resolvedFiles = principal.getResolvedFiles();

package/dist/project-principal.d.ts

@@ -12,6 +12,7 @@ export default class ProjectPrincipal {
     addEntryPath(filePath: string): void;
     addSourceFile(filePath: string): void;
     addProjectPath(filePath: string): void;
+    removeProjectPath(filePath: string): void;
     addTypeScriptPaths(workspaceDir: string, compilerOptions: TsConfigJson['compilerOptions']): void;
     createProjects(): void;
     getResolvedFiles(): SourceFile[];

package/dist/project-principal.js

@@ -31,6 +31,9 @@ export default class ProjectPrincipal {
     addProjectPath(filePath) {
         this.projectPaths.add(filePath);
     }
+    removeProjectPath(filePath) {
+        this.projectPaths.delete(filePath);
+    }
     addTypeScriptPaths(workspaceDir, compilerOptions) {
         if (!compilerOptions || !compilerOptions.paths)
             return;

package/dist/util/cli-arguments.d.ts

@@ -1,4 +1,4 @@
-export declare const helpText = "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  --include-entry-exports  Include unused exports in entry files (without `@public`)\n  --ignore                 Ignore files matching this glob pattern, can be repeated\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\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\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-exit-code           Always exit with code zero (0)\n  --max-issues             Maximum number of issues before non-zero exit code (default: 0)\n  --debug                  Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure running time of expensive functions and display stats table\n\n(1) Issue types: files, dependencies, unlisted, 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 info: 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  --include-entry-exports  Include unused exports in entry files (without `@public`)\n  --ignore                 Ignore files matching this glob pattern, can be repeated\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\n  --exports                Shortcut for --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates\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-exit-code           Always exit with code zero (0)\n  --max-issues             Maximum number of issues before non-zero exit code (default: 0)\n  --debug                  Show debug output\n  --debug-file-filter      Filter for files in debug output (regex as string)\n  --performance            Measure 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, 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: {
     values: {
         config: string | undefined;
@@ -21,6 +21,7 @@ declare const _default: {
         'reporter-options': string | undefined;
         strict: boolean | undefined;
         tsConfig: string | undefined;
+        version: boolean | undefined;
         workspace: string | undefined;
     };
     positionals: [];

package/dist/util/cli-arguments.js

@@ -1,9 +1,11 @@
 import { parseArgs } from 'node:util';
-export const helpText = `knip [options]
+export const helpText = `✂️  Find unused files, dependencies and exports in your JavaScript and TypeScript projects
+
+Usage: knip [options]
 
 Options:
-  -c/--config [file]       Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)
-  -t/--tsConfig [file]     TypeScript configuration path (default: tsconfig.json)
+  -c, --config [file]      Configuration file path (default: [.]knip.json[c], knip.js, knip.ts or package.json#knip)
+  -t, --tsConfig [file]    TypeScript configuration path (default: tsconfig.json)
   --production             Analyze only production source files (e.g. no tests, devDependencies, exported types)
   --strict                 Consider only direct dependencies of workspace (not devDependencies, not other workspaces)
   --workspace              Analyze a single workspace (default: analyze all configured workspaces)
@@ -22,6 +24,8 @@ Options:
   --debug                  Show debug output
   --debug-file-filter      Filter for files in debug output (regex as string)
   --performance            Measure running time of expensive functions and display stats table
+  --h, --help              Print this help text
+  --V, version             Print version
 
 (1) Issue types: files, dependencies, unlisted, exports, nsExports, classMembers, types, nsTypes, enumMembers, duplicates
 
@@ -34,7 +38,7 @@ $ knip -c ./config/knip.json --reporter compact
 $ knip --reporter codeowners --reporter-options '{"path":".github/CODEOWNERS"}'
 $ knip --debug --debug-file-filter '(specific|particular)-module'
 
-More info: https://github.com/webpro/knip`;
+More documentation and bug reports: https://github.com/webpro/knip`;
 export default parseArgs({
     options: {
         config: { type: 'string', short: 'c' },
@@ -57,6 +61,7 @@ export default parseArgs({
         'reporter-options': { type: 'string' },
         strict: { type: 'boolean' },
         tsConfig: { type: 'string', short: 't' },
+        version: { type: 'boolean', short: 'V' },
         workspace: { type: 'string' },
     },
 });

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare const version = "1.9.0";

package/dist/version.js

@@ -0,0 +1 @@
+export const version = '1.9.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript projects",
   "homepage": "https://github.com/webpro/knip",
   "repository": "github:webpro/knip",
@@ -63,6 +63,7 @@
   "devDependencies": {
     "@jest/types": "29.3.1",
     "@npmcli/package-json": "3.0.0",
+    "@release-it/bumper": "^4.0.2",
     "@types/eslint": "8.4.10",
     "@types/js-yaml": "4.0.5",
     "@types/micromatch": "4.0.2",
@@ -98,6 +99,11 @@
     },
     "github": {
       "release": true
+    },
+    "plugins": {
+      "@release-it/bumper": {
+        "out": "{dist,src}/version.*"
+      }
     }
   },
   "remarkConfig": {