knip 0.10.0 → 0.11.0

package/README.md

@@ -83,9 +83,10 @@ Knip works by creating two sets of files:
       --ignore               Ignore files matching this glob pattern (can be set multiple times)
       --no-gitignore         Don't use .gitignore
       --dev                  Include `devDependencies` in report(s)
+      --include-entry-files  Report unused exports and types for entry files
       --no-progress          Don't show dynamic progress updates
       --max-issues           Maximum number of issues before non-zero exit code (default: 0)
-      --reporter             Select reporter: symbols, compact, codeowners (default: symbols)
+      --reporter             Select reporter: symbols, compact, codeowners, json (default: symbols)
       --reporter-options     Pass extra options to the reporter (as JSON string, see example)
       --jsdoc                Enable JSDoc parsing, with options: public
       --debug                Show debug output
@@ -309,10 +310,23 @@ per file like this:
 
 ```json
 [
+  {
+    "file": "package.json",
+    "owners": ["@org/admin"],
+    "files": false,
+    "dependencies": ["jquery", "moment"],
+    "devDependencies": [],
+    "unlisted": [],
+    "exports": [],
+    "types": [],
+    "duplicates": []
+  },
   {
     "file": "src/Registration.tsx",
     "owners": ["@org/owner"],
     "files": true,
+    "dependencies": [],
+    "devDependencies": [],
     "unlisted": ["react"],
     "exports": ["lowercaseFirstLetter", "RegistrationBox"],
     "types": ["RegistrationServices", "RegistrationAction"],

package/dist/help.js

@@ -16,7 +16,7 @@ Options:
   --include-entry-files  Report unused exports and types for entry files
   --no-progress          Don't show dynamic progress updates
   --max-issues           Maximum number of issues before non-zero exit code (default: 0)
-  --reporter             Select reporter: symbols, compact, codeowners (default: symbols)
+  --reporter             Select reporter: symbols, compact, codeowners, json (default: symbols)
   --reporter-options     Pass extra options to the reporter (as JSON string, see example)
   --jsdoc                Enable JSDoc parsing, with options: public
   --debug                Show debug output

package/dist/index.js

@@ -8,6 +8,7 @@ const typescript_1 = __importDefault(require("typescript"));
 const config_1 = require("./util/config");
 const fs_1 = require("./util/fs");
 const path_1 = require("./util/path");
+const glob_1 = require("./util/glob");
 const project_1 = require("./util/project");
 const runner_1 = require("./runner");
 const errors_1 = require("./util/errors");
@@ -20,6 +21,9 @@ const main = async (unresolvedConfiguration) => {
     updateMessage('Reading configuration and manifest files...');
     const manifestPath = await (0, fs_1.findFile)(cwd, workingDir, 'package.json');
     const manifest = manifestPath && require(manifestPath);
+    if (!manifestPath || !manifest) {
+        throw new errors_1.ConfigurationError('Unable to find package.json');
+    }
     const configFilePath = configFilePathArg ?? 'knip.json';
     const resolvedConfigFilePath = await (0, fs_1.findFile)(cwd, workingDir, configFilePath);
     const localConfig = resolvedConfigFilePath && require(resolvedConfigFilePath);
@@ -54,7 +58,7 @@ const main = async (unresolvedConfiguration) => {
                 ? { tsConfigFilePath: resolvedTsConfigFilePath }
                 : { compilerOptions: { allowJs: true } };
             updateMessage('Resolving entry files...');
-            const entryPaths = await (0, path_1.resolvePaths)({
+            const entryPaths = await (0, glob_1.glob)({
                 cwd,
                 workingDir,
                 patterns: resolvedConfig.entryFiles,
@@ -64,12 +68,12 @@ const main = async (unresolvedConfiguration) => {
             (0, debug_1.debugLogFiles)(debug, 1, 'Globbed entry paths', entryPaths);
             const production = (0, project_1.createProject)({ ...projectOptions, ...skipAddFiles }, entryPaths);
             const entryFiles = production.getSourceFiles();
-            (0, debug_1.debugLogSourceFiles)(debug, 1, 'Included entry source files', entryFiles);
+            (0, debug_1.debugLogSourceFiles)(debug, 1, 'Resolved entry source files', entryFiles);
             production.resolveSourceFileDependencies();
-            const productionFiles = production.getSourceFiles();
-            (0, debug_1.debugLogSourceFiles)(debug, 1, 'Included production source files', productionFiles);
+            const productionFiles = (0, project_1.removeExternalSourceFiles)(production);
+            (0, debug_1.debugLogSourceFiles)(debug, 1, 'Resolved production source files', productionFiles);
             updateMessage('Resolving project files...');
-            const projectPaths = await (0, path_1.resolvePaths)({
+            const projectPaths = await (0, glob_1.glob)({
                 cwd,
                 workingDir,
                 patterns: resolvedConfig.projectFiles,
@@ -79,7 +83,7 @@ const main = async (unresolvedConfiguration) => {
             (0, debug_1.debugLogFiles)(debug, 1, 'Globbed project paths', projectPaths);
             const project = (0, project_1.createProject)({ ...projectOptions, ...skipAddFiles }, projectPaths);
             const projectFiles = project.getSourceFiles();
-            (0, debug_1.debugLogSourceFiles)(debug, 1, 'Included project source files', projectFiles);
+            (0, debug_1.debugLogSourceFiles)(debug, 1, 'Resolved project source files', projectFiles);
             return { entryFiles, productionFiles, projectFiles };
         }
         else {
@@ -97,6 +101,7 @@ const main = async (unresolvedConfiguration) => {
         productionFiles,
         projectFiles,
         isIncludeEntryFiles: !resolvedConfig || isIncludeEntryFiles,
+        manifestPath,
         dependencies: Object.keys(manifest.dependencies ?? {}),
         peerDependencies: Object.keys(manifest.peerDependencies ?? {}),
         optionalDependencies: Object.keys(manifest.optionalDependencies ?? {}),

package/dist/reporters/json.js

@@ -26,6 +26,8 @@ exports.default = async ({ report, issues, options }) => {
             file,
             ...(codeownersEngine && { owners: codeownersEngine.calcFileOwnership(file) }),
             ...(report.files && { files: false }),
+            ...(report.dependencies && { dependencies: [] }),
+            ...(report.devDependencies && { devDependencies: [] }),
             ...(report.unlisted && { unlisted: [] }),
             ...((report.exports || report.nsExports) && { exports: [] }),
             ...((report.types || report.nsTypes) && { types: [] }),

package/dist/runner.js

@@ -15,6 +15,7 @@ const progress_1 = require("./progress");
 async function findIssues(configuration) {
     const { workingDir, report, isDev, jsDocOptions, debug } = configuration;
     const { entryFiles, productionFiles, projectFiles, isIncludeEntryFiles } = configuration;
+    const { manifestPath } = configuration;
     const updateMessage = (0, progress_1.getMessageUpdater)(configuration);
     const { getUnresolvedDependencies, getUnusedDependencies, getUnusedDevDependencies } = (0, dependencies_1.getDependencyAnalyzer)(configuration);
     const [usedProductionFiles, unreferencedProductionFiles] = (0, project_1.partitionSourceFiles)(projectFiles, productionFiles);
@@ -25,8 +26,8 @@ async function findIssues(configuration) {
     (0, debug_1.debugLogSourceFiles)(debug, 1, 'Used non-entry files', usedNonEntryFiles);
     const issues = {
         files: new Set(unreferencedProductionFiles.map(file => file.getFilePath())),
-        dependencies: new Set(),
-        devDependencies: new Set(),
+        dependencies: {},
+        devDependencies: {},
         unlisted: {},
         exports: {},
         types: {},
@@ -36,8 +37,8 @@ async function findIssues(configuration) {
     };
     const counters = {
         files: issues.files.size,
-        dependencies: issues.dependencies.size,
-        devDependencies: issues.dependencies.size,
+        dependencies: 0,
+        devDependencies: 0,
         unlisted: 0,
         exports: 0,
         types: 0,
@@ -56,13 +57,6 @@ async function findIssues(configuration) {
         counters[issueType]++;
         updateCounters(issue);
     };
-    const addProjectIssue = (issueType, issue) => {
-        if (!issues[issueType].has(issue.symbol)) {
-            issues[issueType].add(issue.symbol);
-            counters[issueType]++;
-        }
-        updateCounters(issue);
-    };
     updateMessage('Connecting the dots...');
     if (report.dependencies ||
         report.unlisted ||
@@ -174,10 +168,10 @@ async function findIssues(configuration) {
     }
     if (report.dependencies) {
         const unusedDependencies = getUnusedDependencies();
-        unusedDependencies.forEach(symbol => addProjectIssue('dependencies', { filePath: '', symbol }));
+        unusedDependencies.forEach(symbol => addSymbolIssue('dependencies', { filePath: manifestPath, symbol }));
         if (isDev) {
             const unusedDevDependencies = getUnusedDevDependencies();
-            unusedDevDependencies.forEach(symbol => addProjectIssue('devDependencies', { filePath: '', symbol }));
+            unusedDevDependencies.forEach(symbol => addSymbolIssue('devDependencies', { filePath: manifestPath, symbol }));
         }
     }
     updateCounters();

package/dist/types.d.ts

@@ -10,8 +10,8 @@ export declare type IssueSet = Set<string>;
 export declare type IssueRecords = Record<string, Record<string, Issue>>;
 export declare type Issues = {
     files: IssueSet;
-    dependencies: IssueSet;
-    devDependencies: IssueSet;
+    dependencies: IssueRecords;
+    devDependencies: IssueRecords;
     unlisted: IssueRecords;
     exports: IssueRecords;
     types: IssueRecords;
@@ -20,8 +20,7 @@ export declare type Issues = {
     duplicates: IssueRecords;
 };
 export declare type IssueType = keyof Issues;
-export declare type ProjectIssueType = Extract<IssueType, 'files' | 'dependencies' | 'devDependencies'>;
-export declare type SymbolIssueType = Exclude<IssueType, ProjectIssueType>;
+export declare type SymbolIssueType = Exclude<IssueType, 'files'>;
 export declare type Report = {
     [key in keyof Issues]: boolean;
 };
@@ -60,6 +59,7 @@ export declare type Configuration = {
     productionFiles: SourceFile[];
     entryFiles: SourceFile[];
     isIncludeEntryFiles: boolean;
+    manifestPath: string;
     dependencies: string[];
     peerDependencies: string[];
     optionalDependencies: string[];

package/dist/util/debug.js

@@ -16,24 +16,19 @@ exports.debugLogObject = debugLogObject;
 const debugLogFiles = (debug, minimumLevel, name, filePaths) => {
     if (minimumLevel > debug.level)
         return;
+    console.debug(`[knip] ${name} (${filePaths.length}):`);
     if (debug.level > 1) {
-        console.debug(`[knip] ${name} (${filePaths.length}):`);
         logArray(filePaths);
     }
-    else {
-        console.debug(`[knip] ${name} (${filePaths.length})`);
-    }
 };
 exports.debugLogFiles = debugLogFiles;
 const debugLogSourceFiles = (debug, minimumLevel, name, sourceFiles) => {
     if (minimumLevel > debug.level)
         return;
+    console.debug(`[knip] ${name} (${sourceFiles.length})`);
     if (debug.level > 1) {
-        console.debug(`[knip] ${name} (${sourceFiles.length}):`);
-        logArray(sourceFiles.map(sourceFile => sourceFile.getFilePath()));
-    }
-    else {
-        console.debug(`[knip] ${name} (${sourceFiles.length})`);
+        const files = sourceFiles.map(sourceFile => sourceFile.getFilePath());
+        logArray(files);
     }
 };
 exports.debugLogSourceFiles = debugLogSourceFiles;

package/dist/util/glob.d.ts

@@ -0,0 +1,7 @@
+export declare const glob: ({ cwd, workingDir, patterns, ignore, gitignore, }: {
+    cwd: string;
+    workingDir: string;
+    patterns: string[];
+    ignore: string[];
+    gitignore: boolean;
+}) => Promise<string[]>;

package/dist/util/glob.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.glob = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+let _globby;
+const globProxy = async function (patterns, options) {
+    if (!_globby) {
+        const { globby } = await eval('import("globby")');
+        _globby = globby;
+    }
+    return _globby(patterns, options);
+};
+const prependDirToPattern = (workingDir, pattern) => {
+    if (pattern.startsWith('!'))
+        return '!' + node_path_1.default.posix.join(workingDir, pattern.slice(1));
+    return node_path_1.default.posix.join(workingDir, pattern);
+};
+const glob = async ({ cwd, workingDir, patterns, ignore, gitignore, }) => {
+    return globProxy(patterns.map(pattern => prependDirToPattern(node_path_1.default.posix.relative(cwd, workingDir), pattern)), {
+        cwd,
+        ignore: [...ignore, '**/node_modules/**'],
+        gitignore,
+        absolute: true,
+    });
+};
+exports.glob = glob;

package/dist/util/path.d.ts

@@ -1,8 +1 @@
 export declare const relative: (to: string) => string;
-export declare const resolvePaths: ({ cwd, workingDir, patterns, ignore, gitignore, }: {
-    cwd: string;
-    workingDir: string;
-    patterns: string[];
-    ignore: string[];
-    gitignore: boolean;
-}) => Promise<string[]>;

package/dist/util/path.js

@@ -3,28 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolvePaths = exports.relative = void 0;
+exports.relative = void 0;
 const node_path_1 = __importDefault(require("node:path"));
 const cwd = process.cwd();
 const relative = (to) => node_path_1.default.relative(cwd, to);
 exports.relative = relative;
-let _globby;
-const glob = async function (patterns, options) {
-    if (!_globby) {
-        const { globby } = await eval('import("globby")');
-        _globby = globby;
-    }
-    return _globby(patterns, options);
-};
-const prependDirToPattern = (workingDir, pattern) => {
-    if (pattern.startsWith('!'))
-        return '!' + node_path_1.default.posix.join(workingDir, pattern.slice(1));
-    return node_path_1.default.posix.join(workingDir, pattern);
-};
-const resolvePaths = async ({ cwd, workingDir, patterns, ignore, gitignore, }) => glob(patterns.map(pattern => prependDirToPattern(node_path_1.default.posix.relative(cwd, workingDir), pattern)), {
-    cwd,
-    ignore: [...ignore, '**/node_modules'],
-    gitignore,
-    absolute: true,
-});
-exports.resolvePaths = resolvePaths;

package/dist/util/project.d.ts

@@ -1,4 +1,5 @@
 import { Project } from 'ts-morph';
 import type { ProjectOptions, SourceFile } from 'ts-morph';
 export declare const createProject: (projectOptions: ProjectOptions, paths?: string[]) => Project;
+export declare const removeExternalSourceFiles: (project: Project) => SourceFile[];
 export declare const partitionSourceFiles: (projectFiles: SourceFile[], productionFiles: SourceFile[]) => SourceFile[][];

package/dist/util/project.js

@@ -1,14 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.partitionSourceFiles = exports.createProject = void 0;
+exports.partitionSourceFiles = exports.removeExternalSourceFiles = exports.createProject = void 0;
 const ts_morph_1 = require("ts-morph");
 const createProject = (projectOptions, paths) => {
-    const workspace = new ts_morph_1.Project(projectOptions);
+    const project = new ts_morph_1.Project(projectOptions);
     if (paths)
-        workspace.addSourceFilesAtPaths(paths);
-    return workspace;
+        project.addSourceFilesAtPaths(paths);
+    return project;
 };
 exports.createProject = createProject;
+const removeExternalSourceFiles = (project) => project.getSourceFiles().filter(sourceFile => {
+    if (/\/node_modules\//.test(sourceFile.getFilePath())) {
+        project.removeSourceFile(sourceFile);
+        return false;
+    }
+    return true;
+});
+exports.removeExternalSourceFiles = removeExternalSourceFiles;
 const partitionSourceFiles = (projectFiles, productionFiles) => {
     const productionFilePaths = productionFiles.map(file => file.getFilePath());
     const usedFiles = [];

package/package.json

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