knip 0.4.1 → 0.5.0

package/README.md

@@ -22,12 +22,14 @@ This is where Knip comes in:
 - [x] Supports JavaScript-only projects using ESM (without a `tsconfig.json`)
 
 Knip really shines in larger projects where you have non-production files (such as `/docs`, `/tools` and `/scripts`).
-The `includes` setting in `tsconfig.json` is often too broad, resulting in too many false negatives. Similar projects
-either detect only unimported files, or only unused exports. Most of them don't work by configuring entry files, an
-essential feature to produce good results. This also allows to unleash knip on a specific part of your project, and work
-these separately.
+The `includes` setting in `tsconfig.json` is often too broad, resulting in too many false negatives. To produce good
+results it's essential to configure entry files. A comparison with similar toos answers the question
+[Why yet another unused file/dependency/export finder?](#why-yet-another-unused-filedependencyexport-finder)
 
-✂️ Knip is another fresh take on keeping your projects clean & tidy!
+Knip is a fresh take on keeping your projects clean & tidy!
+
+[![An orange cow with scissors, Van Gogh style](./assets/cow-with-orange-scissors-van-gogh-style.webp)](https://labs.openai.com/s/xZQACaLepaKya0PRUPtIN5dC)
+<sup>_“An orange cow with scissors, Van Gogh style” - generated with OpenAI_</sup>
 
 ## Installation
 
@@ -91,6 +93,8 @@ Options:
   --max-issues           Maximum number of issues before non-zero exit code (default: 0)
   --reporter             Select reporter: symbols, compact (default: symbols)
   --jsdoc                Enable JSDoc parsing, with options: public
+  --debug                Show debug output
+  --debug-level          Set verbosity of debug output (default: 1, max: 2)
 
 Issue groups: files, dependencies, unlisted, exports, nsExports, types, nsTypes, duplicates
 

package/dist/cli.js

@@ -9,7 +9,8 @@ const node_util_1 = require("node:util");
 const _1 = require(".");
 const help_1 = require("./help");
 const reporters_1 = __importDefault(require("./reporters"));
-const { values: { help, dir, config: configFilePath = 'knip.json', tsConfig: tsConfigFilePath, include = [], exclude = [], ignore = [], 'no-gitignore': isNoGitIgnore = false, dev: isDev = false, 'no-progress': noProgress = false, reporter = 'symbols', 'max-issues': maxIssues = '0', jsdoc: jsDoc = [], }, } = (0, node_util_1.parseArgs)({
+const errors_1 = require("./util/errors");
+const { values: { help, dir, config: configFilePath = 'knip.json', tsConfig: tsConfigFilePath, include = [], exclude = [], ignore = [], 'no-gitignore': isNoGitIgnore = false, dev: isDev = false, 'no-progress': noProgress = false, reporter = 'symbols', 'max-issues': maxIssues = '0', jsdoc: jsDoc = [], debug: isDebug = false, 'debug-level': debugLevel = '1', }, } = (0, node_util_1.parseArgs)({
     options: {
         help: { type: 'boolean' },
         config: { type: 'string', short: 'c' },
@@ -24,6 +25,8 @@ const { values: { help, dir, config: configFilePath = 'knip.json', tsConfig: tsC
         'max-issues': { type: 'string' },
         reporter: { type: 'string' },
         jsdoc: { type: 'string', multiple: true },
+        debug: { type: 'boolean' },
+        'debug-level': { type: 'string' },
     },
 });
 if (help) {
@@ -48,6 +51,10 @@ const run = async () => {
             isDev,
             isShowProgress,
             jsDoc,
+            debug: {
+                isEnabled: isDebug,
+                level: isDebug ? Number(debugLevel) : 0,
+            },
         });
         printReport({ report, issues, workingDir, isDev });
         const reportGroup = report.files ? 'files' : Object.keys(report).find(key => report[key]);
@@ -59,7 +66,7 @@ const run = async () => {
         }
     }
     catch (error) {
-        if (error instanceof Error) {
+        if (error instanceof errors_1.ConfigurationError) {
             console.error(error.message + '\n');
             (0, help_1.printHelp)();
             process.exit(1);

package/dist/help.js

@@ -17,6 +17,8 @@ Options:
   --max-issues           Maximum number of issues before non-zero exit code (default: 0)
   --reporter             Select reporter: symbols, compact (default: symbols)
   --jsdoc                Enable JSDoc parsing, with options: public
+  --debug                Show debug output
+  --debug-level          Set verbosity of debug output (default: 1, max: 2)
 
 Issue groups: files, dependencies, unlisted, exports, nsExports, types, nsTypes, duplicates
 

package/dist/index.js

@@ -11,26 +11,30 @@ const fs_1 = require("./util/fs");
 const path_1 = require("./util/path");
 const project_1 = require("./util/project");
 const runner_1 = require("./runner");
+const errors_1 = require("./util/errors");
+const debug_1 = require("./util/debug");
 const main = async (options) => {
-    const { cwd, workingDir, configFilePath = 'knip.json', tsConfigFilePath, include, exclude, ignore, gitignore, isDev, isShowProgress, jsDoc, } = options;
+    const { cwd, workingDir, configFilePath = 'knip.json', tsConfigFilePath, include, exclude, ignore, gitignore, isDev, isShowProgress, jsDoc, debug, } = options;
+    (0, debug_1.debugLogObject)(options, 1, 'Unresolved onfiguration', options);
     const localConfigurationPath = configFilePath && (await (0, fs_1.findFile)(workingDir, configFilePath));
     const manifestPath = await (0, fs_1.findFile)(workingDir, 'package.json');
     const localConfiguration = localConfigurationPath && require(localConfigurationPath);
     const manifest = manifestPath && require(manifestPath);
     if (!localConfigurationPath && !manifest.knip) {
         const location = workingDir === cwd ? 'current directory' : `${node_path_1.default.relative(cwd, workingDir)} or up.`;
-        throw new Error(`Unable to find ${configFilePath} or package.json#knip in ${location}`);
+        throw new errors_1.ConfigurationError(`Unable to find ${configFilePath} or package.json#knip in ${location}`);
     }
     const dir = node_path_1.default.relative(cwd, workingDir);
     const resolvedConfig = (0, config_1.resolveConfig)(manifest.knip ?? localConfiguration, { workingDir: dir, isDev });
+    (0, debug_1.debugLogObject)(options, 1, 'Resolved onfiguration', resolvedConfig);
     if (!resolvedConfig) {
-        throw new Error('Unable to find `entryFiles` and/or `projectFiles` in configuration.');
+        throw new errors_1.ConfigurationError('Unable to find `entryFiles` and/or `projectFiles` in configuration.');
     }
     const report = (0, config_1.resolveIncludedIssueGroups)(include, exclude, resolvedConfig);
     let tsConfigPaths = [];
     const tsConfigPath = await (0, fs_1.findFile)(workingDir, tsConfigFilePath ?? 'tsconfig.json');
     if (tsConfigFilePath && !tsConfigPath) {
-        throw new Error(`Unable to find ${tsConfigFilePath}`);
+        throw new errors_1.ConfigurationError(`Unable to find ${tsConfigFilePath}`);
     }
     if (tsConfigPath) {
         const tsConfig = typescript_1.default.readConfigFile(tsConfigPath, typescript_1.default.sys.readFile);
@@ -38,10 +42,10 @@ const main = async (options) => {
             ? Object.keys(tsConfig.config.compilerOptions.paths).map(p => p.replace(/\*/g, '**'))
             : [];
         if (tsConfig.error) {
-            throw new Error(`An error occured when reading ${node_path_1.default.relative(cwd, tsConfigPath)}`);
+            throw new errors_1.ConfigurationError(`An error occured when reading ${node_path_1.default.relative(cwd, tsConfigPath)}`);
         }
     }
-    const projectOptions = tsConfigFilePath ? { tsConfigFilePath } : { compilerOptions: { allowJs: true } };
+    const projectOptions = tsConfigPath ? { tsConfigFilePath: tsConfigPath } : { compilerOptions: { allowJs: true } };
     const entryPaths = await (0, path_1.resolvePaths)({
         cwd,
         workingDir,
@@ -49,10 +53,13 @@ const main = async (options) => {
         ignore,
         gitignore,
     });
+    (0, debug_1.debugLogFiles)(options, 1, 'Globbed entry paths', entryPaths);
     const production = (0, project_1.createProject)({ projectOptions, paths: entryPaths });
     const entryFiles = production.getSourceFiles();
+    (0, debug_1.debugLogSourceFiles)(options, 1, 'Included entry source files', entryFiles);
     production.resolveSourceFileDependencies();
     const productionFiles = production.getSourceFiles();
+    (0, debug_1.debugLogSourceFiles)(options, 1, 'Included production source files', productionFiles);
     const projectPaths = await (0, path_1.resolvePaths)({
         cwd,
         workingDir,
@@ -60,8 +67,10 @@ const main = async (options) => {
         ignore,
         gitignore,
     });
+    (0, debug_1.debugLogFiles)(options, 1, 'Globbed project paths', projectPaths);
     const project = (0, project_1.createProject)({ projectOptions, paths: projectPaths });
     const projectFiles = project.getSourceFiles();
+    (0, debug_1.debugLogSourceFiles)(options, 1, 'Included project source files', projectFiles);
     const config = {
         workingDir,
         report,
@@ -76,8 +85,10 @@ const main = async (options) => {
         jsDocOptions: {
             isReadPublicTag: jsDoc.includes('public'),
         },
+        debug,
     };
     const { issues, counters } = await (0, runner_1.findIssues)(config);
+    (0, debug_1.debugLogObject)(options, 2, 'Issues', issues);
     return { report, issues, counters };
 };
 exports.main = main;

package/dist/runner.js

@@ -11,6 +11,7 @@ const project_1 = require("./util/project");
 const type_1 = require("./util/type");
 const dependencies_1 = require("./util/dependencies");
 const log_1 = require("./log");
+const debug_1 = require("./util/debug");
 const lineRewriter = new log_1.LineRewriter();
 async function findIssues(configuration) {
     const { workingDir, isShowProgress, report, isDev, jsDocOptions } = configuration;
@@ -18,6 +19,10 @@ async function findIssues(configuration) {
     const { getUnresolvedDependencies, getUnusedDependencies, getUnusedDevDependencies } = (0, dependencies_1.getDependencyAnalyzer)(configuration);
     const [usedProductionFiles, unreferencedProductionFiles] = (0, project_1.partitionSourceFiles)(projectFiles, productionFiles);
     const [usedEntryFiles, usedNonEntryFiles] = (0, project_1.partitionSourceFiles)(usedProductionFiles, entryFiles);
+    (0, debug_1.debugLogSourceFiles)(configuration, 1, 'usedProductionFiles', usedProductionFiles);
+    (0, debug_1.debugLogSourceFiles)(configuration, 1, 'unreferencedProductionFiles', unreferencedProductionFiles);
+    (0, debug_1.debugLogSourceFiles)(configuration, 1, 'usedEntryFiles', usedEntryFiles);
+    (0, debug_1.debugLogSourceFiles)(configuration, 1, 'usedNonEntryFiles', usedNonEntryFiles);
     const issues = {
         files: new Set(unreferencedProductionFiles.map(file => file.getFilePath())),
         dependencies: new Set(),
@@ -44,8 +49,8 @@ async function findIssues(configuration) {
     const updateProcessingOutput = (item) => {
         if (!isShowProgress)
             return;
-        const counter = unreferencedProductionFiles.length + counters.processed;
-        const total = unreferencedProductionFiles.length + usedNonEntryFiles.length;
+        const counter = counters.processed;
+        const total = projectFiles.length;
         const percentage = Math.floor((counter / total) * 100);
         const messages = [(0, log_1.getLine)(`${percentage}%`, `of files processed (${counter} of ${total})`)];
         report.files && messages.push((0, log_1.getLine)(unreferencedProductionFiles.length, 'unused files'));
@@ -78,6 +83,7 @@ async function findIssues(configuration) {
     };
     if (report.dependencies || report.unlisted) {
         usedEntryFiles.forEach(sourceFile => {
+            counters.processed++;
             const unresolvedDependencies = getUnresolvedDependencies(sourceFile);
             unresolvedDependencies.forEach(issue => addSymbolIssue('unresolved', issue));
         });
@@ -90,6 +96,7 @@ async function findIssues(configuration) {
         report.nsTypes ||
         report.duplicates) {
         usedNonEntryFiles.forEach(sourceFile => {
+            counters.processed++;
             const filePath = sourceFile.getFilePath();
             if (report.dependencies || report.unlisted) {
                 const unresolvedDependencies = getUnresolvedDependencies(sourceFile);
@@ -175,7 +182,6 @@ async function findIssues(configuration) {
                     });
                 });
             }
-            counters.processed++;
         });
     }
     if (report.dependencies) {

package/dist/types.d.ts

@@ -47,6 +47,10 @@ export declare type UnresolvedConfiguration = {
     isDev: boolean;
     isShowProgress: boolean;
     jsDoc: string[];
+    debug: {
+        isEnabled: boolean;
+        level: number;
+    };
 };
 export declare type Report = {
     [key in IssueGroup]: boolean;
@@ -65,5 +69,9 @@ export declare type Configuration = {
     jsDocOptions: {
         isReadPublicTag: boolean;
     };
+    debug: {
+        isEnabled: boolean;
+        level: number;
+    };
 };
 export {};

package/dist/util/debug.d.ts

@@ -0,0 +1,12 @@
+import type { SourceFile } from 'ts-morph';
+declare type Config = {
+    debug: {
+        isEnabled: boolean;
+        level: number;
+    };
+};
+export declare const debugLogObject: (config: Config, minimumLevel: number, name: string, obj: unknown) => void;
+export declare const debugLogFiles: (config: Config, minimumLevel: number, name: string, filePaths: string[]) => void;
+export declare const debugLogSourceFiles: (config: Config, minimumLevel: number, name: string, sourceFiles: SourceFile[]) => void;
+export declare const debugLogDiff: (config: Config, minimumLevel: number, name: string, arrA: string[], arrB: string[]) => void;
+export {};

package/dist/util/debug.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.debugLogDiff = exports.debugLogSourceFiles = exports.debugLogFiles = exports.debugLogObject = void 0;
+const node_util_1 = __importDefault(require("node:util"));
+const logArray = (collection) => console.log(node_util_1.default.inspect(collection, { maxArrayLength: null }));
+const debugLogObject = (config, minimumLevel, name, obj) => {
+    if (minimumLevel > config.debug.level)
+        return;
+    console.log(`[exportman] ${name}:`);
+    console.log(node_util_1.default.inspect(obj, { depth: null, colors: true }));
+};
+exports.debugLogObject = debugLogObject;
+const debugLogFiles = (config, minimumLevel, name, filePaths) => {
+    if (minimumLevel > config.debug.level)
+        return;
+    const { debug } = config;
+    if (debug.level > 1) {
+        console.debug(`[exportman] ${name} (${filePaths.length}):`);
+        logArray(filePaths);
+    }
+    else {
+        console.debug(`[exportman] ${name} (${filePaths.length})`);
+    }
+};
+exports.debugLogFiles = debugLogFiles;
+const debugLogSourceFiles = (config, minimumLevel, name, sourceFiles) => {
+    if (minimumLevel > config.debug.level)
+        return;
+    const { debug } = config;
+    if (debug.level > 1) {
+        console.debug(`[exportman] ${name} (${sourceFiles.length}):`);
+        logArray(sourceFiles.map(sourceFile => sourceFile.getFilePath()));
+    }
+    else {
+        console.debug(`[exportman] ${name} (${sourceFiles.length})`);
+    }
+};
+exports.debugLogSourceFiles = debugLogSourceFiles;
+const debugLogDiff = (config, minimumLevel, name, arrA, arrB) => {
+    if (minimumLevel > config.debug.level)
+        return;
+    const onlyInA = arrA.filter(itemA => !arrB.includes(itemA)).sort();
+    const onlyInB = arrB.filter(itemB => !arrA.includes(itemB)).sort();
+    console.log(`[exportman] ${name}`);
+    console.log(`[exportman] Only in left:`);
+    logArray(onlyInA);
+    console.log();
+    console.log(`[exportman] Only in right:`);
+    logArray(onlyInB);
+};
+exports.debugLogDiff = debugLogDiff;

package/dist/util/errors.d.ts

@@ -0,0 +1,2 @@
+export declare class ConfigurationError extends Error {
+}

package/dist/util/errors.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigurationError = void 0;
+class ConfigurationError extends Error {
+}
+exports.ConfigurationError = ConfigurationError;

package/package.json

@@ -1,12 +1,14 @@
 {
   "name": "knip",
-  "version": "0.4.1",
-  "description": "Find unused files and exports in your TypeScript project",
+  "version": "0.5.0",
+  "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript project",
   "keywords": [
     "find",
     "detect",
     "unused",
+    "unreferenced",
     "files",
+    "dependencies",
     "exports",
     "types",
     "duplicates",