knip 0.8.2 → 0.9.1

package/README.md

@@ -36,7 +36,7 @@ with OpenAI_</sup>
 
     npm install -D knip
 
-Knip requires at least Node.js v16.17 or v18. Knip is _cutting edge!_
+Knip supports LTS versions of Node.js, and currently requires at least Node.js v16.17 or v18.3. Knip is _cutting edge!_
 
 ## Usage
 
@@ -272,15 +272,18 @@ configuration can be tweaked further to the project structure.
 
 ## Reporters
 
-For starters, Knip already contains a few useful reporters:
+Knip provides the following built-in reporters:
 
-- `symbol` (default)
-- `compact`
-- `codeowners`
+- [`json`](#json)
+- [`symbol`](#symbol-default) (default)
+- [`compact`](#compact)
+- [`codeowners`](#code-owners)
 
 ### Custom Reporters
 
-When a `--reporter ./my-reporter` is passed, the default export of that module should have this interface:
+When the provided built-in reporters are not quite sufficient, a custom reporter can be implemented.
+
+Pass `--reporter ./my-reporter`, with the default export of that module having this interface:
 
 ```ts
 type Reporter = (options: ReporterOptions) => void;
@@ -297,7 +300,59 @@ type ReporterOptions = {
 
 The data can then be used to write issues to `stdout`, a JSON or CSV file, or sent to a service, anything really!
 
-### Example Output
+### JSON
+
+The `json` reporter output is meant to be consumed by other tools. It reports in JSON format as an array with one object
+per file like this:
+
+```json
+[
+  {
+    "file": "src/Registration.tsx",
+    "owners": ["@org/owner"],
+    "files": true,
+    "unlisted": ["react"],
+    "exports": ["lowercaseFirstLetter", "RegistrationBox"],
+    "types": ["RegistrationServices", "RegistrationAction"],
+    "duplicates": ["Registration", "default"]
+  }
+]
+```
+
+The keys match the [known issue types](#reading-the-report).
+
+#### Usage Ideas
+
+Use tools like [miller](https://github.com/johnkerl/miller) or [jtbl](https://github.com/kellyjonbrazil/jtbl) to consume
+the JSON and render a table in the terminal.
+
+##### Table
+
+```
+$ npx knip --reporter json | mlr --ijson --opprint --no-auto-flatten cat
+file                  owners      files  unlisted  exports                                types                                     duplicates
+src/Registration.tsx  @org/owner  true   react     lowercaseFirstLetter, RegistrationBox  RegistrationServices, RegistrationAction  Registration, default
+src/ProductsList.tsx  @org/team   false  -         -                                      ProductDetail                             -
+```
+
+##### Markdown Table
+
+```
+$ npx knip --reporter json | mlr --ijson --omd --no-auto-flatten cat
+| file | owners | files | duplicates |
+| --- | --- | --- | --- |
+| src/Registration.tsx | @org/owner | true | Registration, default |
+| src/ProductsList.tsx | @org/team | false |  |
+```
+
+Include specific issue types and/or replace the `cat` command with `put` for clean output:
+
+```
+npx knip --include files,duplicates --reporter json | mlr --ijson --opprint --no-auto-flatten put 'for (e in $*) { if(is_array($[e])) { $[e] = joinv($[e], ", ") } }'
+npx knip --reporter json | mlr --ijson --omd --no-auto-flatten put 'for (e in $*) { if(is_array($[e])) { $[e] = joinv($[e], ", ") } }'
+```
+
+### More Output Examples
 
 #### Symbol (default)
 

package/dist/cli.js

@@ -59,10 +59,9 @@ const run = async () => {
                 level: isDebug ? Number(debugLevel) : 0,
             },
         });
-        printReport({ report, issues, cwd, workingDir, isDev, options: reporterOptions });
+        await printReport({ report, issues, cwd, workingDir, isDev, options: reporterOptions });
         const totalErrorCount = Object.keys(report)
-            .filter((reportGroup) => report[reportGroup])
-            .map(reportGroup => reportGroup === 'unlisted' ? 'unresolved' : reportGroup)
+            .filter(reportGroup => report[reportGroup])
             .reduce((errorCount, reportGroup) => errorCount + counters[reportGroup], 0);
         if (totalErrorCount > Number(maxIssues))
             process.exit(totalErrorCount);

package/dist/index.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.main = void 0;
-const node_path_1 = __importDefault(require("node:path"));
 const typescript_1 = __importDefault(require("typescript"));
 const config_1 = require("./util/config");
 const fs_1 = require("./util/fs");
@@ -17,7 +16,7 @@ const progress_1 = require("./progress");
 const main = async (options) => {
     const { cwd, workingDir, configFilePath: configFilePathArg, tsConfigFilePath: tsConfigFilePathArg, include, exclude, ignore, gitignore, isIncludeEntryFiles, isDev, isShowProgress, jsDoc, debug, } = options;
     const updateMessage = (0, progress_1.getMessageUpdater)(options);
-    (0, debug_1.debugLogObject)(options, 1, 'Unresolved onfiguration', options);
+    (0, debug_1.debugLogObject)(options, 1, 'Unresolved configuration', options);
     updateMessage('Reading configuration and manifest files...');
     const manifestPath = await (0, fs_1.findFile)(cwd, workingDir, 'package.json');
     const manifest = manifestPath && require(manifestPath);
@@ -39,12 +38,12 @@ const main = async (options) => {
             ? Object.keys(config.config.compilerOptions.paths).map(p => p.replace(/\*/g, '**'))
             : [];
         if (config.error) {
-            throw new errors_1.ConfigurationError(`Unable to read ${node_path_1.default.relative(cwd, resolvedTsConfigFilePath)}`);
+            throw new errors_1.ConfigurationError(`Unable to read ${(0, path_1.relative)(resolvedTsConfigFilePath)}`);
         }
     }
-    const dir = node_path_1.default.relative(cwd, workingDir);
+    const dir = (0, path_1.relative)(workingDir);
     const resolvedConfig = (0, config_1.resolveConfig)(manifest.knip ?? localConfig, { workingDir: dir, isDev });
-    (0, debug_1.debugLogObject)(options, 1, 'Resolved onfiguration', resolvedConfig);
+    (0, debug_1.debugLogObject)(options, 1, 'Resolved configuration', resolvedConfig);
     if (!resolvedConfigFilePath && !manifest.knip && !resolvedTsConfigFilePath) {
         throw new errors_1.ConfigurationError(`Unable to find ${configFilePath} or package.json#knip or ${tsConfigFilePath}`);
     }
@@ -56,7 +55,6 @@ const main = async (options) => {
                 : { compilerOptions: { allowJs: true } };
             updateMessage('Resolving entry files...');
             const entryPaths = await (0, path_1.resolvePaths)({
-                cwd,
                 workingDir,
                 patterns: resolvedConfig.entryFiles,
                 ignore,
@@ -71,7 +69,6 @@ const main = async (options) => {
             (0, debug_1.debugLogSourceFiles)(options, 1, 'Included production source files', productionFiles);
             updateMessage('Resolving project files...');
             const projectPaths = await (0, path_1.resolvePaths)({
-                cwd,
                 workingDir,
                 patterns: resolvedConfig.projectFiles,
                 ignore,
@@ -90,7 +87,7 @@ const main = async (options) => {
             return { entryFiles: files, productionFiles: files, projectFiles: files };
         }
     })();
-    const report = (0, config_1.resolveIncludedIssueGroups)(include, resolvedConfig ? exclude : ['files'], resolvedConfig);
+    const report = (0, config_1.resolveIncludedIssueTypes)(include, resolvedConfig ? exclude : ['files'], resolvedConfig);
     const config = {
         workingDir,
         report,
@@ -102,7 +99,7 @@ const main = async (options) => {
         peerDependencies: Object.keys(manifest.peerDependencies ?? {}),
         optionalDependencies: Object.keys(manifest.optionalDependencies ?? {}),
         devDependencies: Object.keys(manifest.devDependencies ?? {}),
-        isDev: typeof resolvedConfig?.dev === 'boolean' ? resolvedConfig.dev : isDev,
+        isDev: Boolean(resolvedConfig?.dev),
         tsConfigPaths,
         isShowProgress,
         jsDocOptions: {

package/dist/progress.js

@@ -1,11 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCountersUpdater = exports.getMessageUpdater = void 0;
-const node_path_1 = __importDefault(require("node:path"));
 const log_1 = require("./log");
+const path_1 = require("./util/path");
 const lineRewriter = new log_1.LineRewriter();
 const getMessageUpdater = (configuration) => {
     const { isShowProgress } = configuration;
@@ -15,7 +12,7 @@ const getMessageUpdater = (configuration) => {
 };
 exports.getMessageUpdater = getMessageUpdater;
 const getCountersUpdater = (configuration, counters) => {
-    const { workingDir, isShowProgress, report } = configuration;
+    const { isShowProgress, report } = configuration;
     if (!isShowProgress)
         return () => { };
     return (issue) => {
@@ -25,7 +22,7 @@ const getCountersUpdater = (configuration, counters) => {
         const percentage = Math.floor((processed / total) * 100);
         const messages = [(0, log_1.getLine)(`${percentage}%`, `of files processed (${processed} of ${total})`)];
         report.files && messages.push((0, log_1.getLine)(counters.files, 'unused files'));
-        report.unlisted && messages.push((0, log_1.getLine)(counters.unresolved, 'unlisted dependencies'));
+        report.unlisted && messages.push((0, log_1.getLine)(counters.unlisted, 'unlisted dependencies'));
         report.exports && messages.push((0, log_1.getLine)(counters.exports, 'unused exports'));
         report.nsExports && messages.push((0, log_1.getLine)(counters.nsExports, 'unused exports in namespace'));
         report.types && messages.push((0, log_1.getLine)(counters.types, 'unused types'));
@@ -33,7 +30,7 @@ const getCountersUpdater = (configuration, counters) => {
         report.duplicates && messages.push((0, log_1.getLine)(counters.duplicates, 'duplicate exports'));
         if (processed < total) {
             messages.push('');
-            messages.push(`Processing: ${node_path_1.default.relative(workingDir, issue.filePath)}`);
+            messages.push(`Processing: ${(0, path_1.relative)(issue.filePath)}`);
         }
         lineRewriter.update(messages);
     };

package/dist/reporters/codeowners.d.ts

@@ -1,3 +1,3 @@
 import type { ReporterOptions } from '../types';
-declare const _default: ({ report, issues, cwd, isDev, options }: ReporterOptions) => void;
+declare const _default: ({ report, issues, options }: ReporterOptions) => void;
 export default _default;

package/dist/reporters/codeowners.js

@@ -5,31 +5,33 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const node_path_1 = __importDefault(require("node:path"));
 const ownership_1 = require("@snyk/github-codeowners/dist/lib/ownership");
-const logIssueLine = (owner, cwd, filePath, symbols) => {
-    console.log(`${owner} ${node_path_1.default.relative(cwd, filePath)}${symbols ? `: ${symbols.join(', ')}` : ''}`);
+const path_1 = require("../util/path");
+const constants_1 = require("./constants");
+const logIssueLine = (owner, filePath, symbols) => {
+    console.log(`${owner} ${(0, path_1.relative)(filePath)}${symbols ? `: ${symbols.join(', ')}` : ''}`);
 };
-const logIssueGroupResult = (issues, cwd, title) => {
+const logIssueSet = (issues, title) => {
     title && console.log(`--- ${title} (${issues.length})`);
     if (issues.length) {
         issues
             .sort((a, b) => (a.owner < b.owner ? -1 : 1))
-            .forEach(issue => console.log(issue.owner, issue.symbol.startsWith('/') ? node_path_1.default.relative(cwd, issue.symbol) : issue.symbol));
+            .forEach(issue => console.log(issue.owner, issue.symbol.startsWith('/') ? (0, path_1.relative)(issue.symbol) : issue.symbol));
     }
     else {
         console.log('Not found');
     }
 };
-const logIssueGroupResults = (issues, cwd, title) => {
+const logIssueRecord = (issues, title) => {
     title && console.log(`--- ${title} (${issues.length})`);
     if (issues.length) {
         const sortedByFilePath = issues.sort((a, b) => (a.owner < b.owner ? -1 : 1));
-        sortedByFilePath.forEach(({ filePath, symbols, owner }) => logIssueLine(owner, cwd, filePath, symbols));
+        sortedByFilePath.forEach(({ filePath, symbols, owner }) => logIssueLine(owner, filePath, symbols));
     }
     else {
         console.log('Not found');
     }
 };
-exports.default = ({ report, issues, cwd, isDev, options }) => {
+exports.default = ({ report, issues, options }) => {
     let opts = {};
     try {
         opts = options ? JSON.parse(options) : opts;
@@ -42,57 +44,27 @@ exports.default = ({ report, issues, cwd, isDev, options }) => {
     const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
     const [dependenciesOwner = '[no-owner]'] = codeownersEngine.calcFileOwnership('package.json');
     const fallbackOwner = dependenciesOwner;
-    const calcFileOwnership = (filePath) => codeownersEngine.calcFileOwnership(node_path_1.default.relative(cwd, filePath))[0] ?? fallbackOwner;
-    const toIssueWithOwner = (issues) => {
-        const items = Object.values(issues);
-        return { ...items[0], symbols: items.map(i => i.symbol), owner: calcFileOwnership(items[0].filePath) };
-    };
-    if (report.files) {
-        const unreferencedFilesByOwner = Array.from(issues.files).map(filePath => ({
-            symbol: filePath,
-            owner: calcFileOwnership(filePath),
-        }));
-        logIssueGroupResult(unreferencedFilesByOwner, cwd, reportMultipleGroups && 'UNUSED FILES');
-    }
-    if (report.dependencies) {
-        const unreferencedDependencies = Array.from(issues.dependencies).map(dependency => ({
-            symbol: dependency,
-            owner: dependenciesOwner,
-        }));
-        logIssueGroupResult(unreferencedDependencies, cwd, reportMultipleGroups && 'UNUSED DEPENDENCIES');
-    }
-    if (report.dependencies && isDev) {
-        const unreferencedDevDependencies = Array.from(issues.devDependencies).map(dependency => ({
-            symbol: dependency,
-            owner: dependenciesOwner,
-        }));
-        logIssueGroupResult(unreferencedDevDependencies, cwd, 'UNUSED DEV DEPENDENCIES');
-    }
-    if (report.unlisted) {
-        const unreferencedDependencies = Object.values(issues.unresolved).map(toIssueWithOwner);
-        logIssueGroupResults(unreferencedDependencies, cwd, reportMultipleGroups && 'UNLISTED DEPENDENCIES');
-    }
-    if (report.exports) {
-        const unreferencedExports = Object.values(issues.exports).map(toIssueWithOwner);
-        logIssueGroupResults(unreferencedExports, cwd, reportMultipleGroups && 'UNUSED EXPORTS');
-    }
-    if (report.nsExports) {
-        const unreferencedNsExports = Object.values(issues.nsExports).map(toIssueWithOwner);
-        logIssueGroupResults(unreferencedNsExports, cwd, reportMultipleGroups && 'UNUSED EXPORTS IN NAMESPACE');
-    }
-    if (report.types) {
-        const unreferencedTypes = Object.values(issues.types).map(toIssueWithOwner);
-        logIssueGroupResults(unreferencedTypes, cwd, reportMultipleGroups && 'UNUSED TYPES');
-    }
-    if (report.nsTypes) {
-        const unreferencedNsTypes = Object.values(issues.nsTypes).map(toIssueWithOwner);
-        logIssueGroupResults(unreferencedNsTypes, cwd, reportMultipleGroups && 'UNUSED TYPES IN NAMESPACE');
-    }
-    if (report.duplicates) {
-        const unreferencedDuplicates = Object.values(issues.duplicates)
-            .map(issues => Object.values(issues))
-            .flat()
-            .map(issue => ({ ...issue, owner: calcFileOwnership(issue.filePath) }));
-        logIssueGroupResults(unreferencedDuplicates, cwd, reportMultipleGroups && 'DUPLICATE EXPORTS');
+    const calcFileOwnership = (filePath) => codeownersEngine.calcFileOwnership((0, path_1.relative)(filePath))[0] ?? fallbackOwner;
+    const addOwner = (issue) => ({ ...issue, owner: calcFileOwnership(issue.filePath) });
+    for (const [reportType, isReportType] of Object.entries(report)) {
+        if (isReportType) {
+            const title = reportMultipleGroups && constants_1.ISSUE_TYPE_TITLE[reportType];
+            if (issues[reportType] instanceof Set) {
+                const toIssue = (filePath) => ({ filePath, symbol: filePath });
+                const issuesForType = Array.from(issues[reportType]).map(toIssue);
+                logIssueSet(issuesForType.map(addOwner), title);
+            }
+            else if (reportType === 'duplicates') {
+                const issuesForType = Object.values(issues[reportType]).map(Object.values).flat().map(addOwner);
+                logIssueRecord(issuesForType, title);
+            }
+            else {
+                const issuesForType = Object.values(issues[reportType]).map(issues => {
+                    const items = Object.values(issues);
+                    return addOwner({ ...items[0], symbols: items.map(issue => issue.symbol) });
+                });
+                logIssueRecord(issuesForType, title);
+            }
+        }
     }
 };

package/dist/reporters/compact.d.ts

@@ -1,3 +1,3 @@
 import type { ReporterOptions } from '../types';
-declare const _default: ({ report, issues, workingDir, isDev }: ReporterOptions) => void;
+declare const _default: ({ report, issues }: ReporterOptions) => void;
 export default _default;

package/dist/reporters/compact.js

@@ -1,84 +1,48 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const node_path_1 = __importDefault(require("node:path"));
-const logIssueLine = (workingDir, filePath, symbols) => {
-    console.log(`${node_path_1.default.relative(workingDir, filePath)}${symbols ? `: ${symbols.join(', ')}` : ''}`);
+const path_1 = require("../util/path");
+const constants_1 = require("./constants");
+const logIssueLine = (filePath, symbols) => {
+    console.log(`${(0, path_1.relative)(filePath)}${symbols ? `: ${symbols.join(', ')}` : ''}`);
 };
-const logIssueGroupResult = (issues, workingDir, title) => {
+const logIssueSet = (issues, title) => {
     title && console.log(`--- ${title} (${issues.length})`);
     if (issues.length) {
-        issues.sort().forEach(value => console.log(value.startsWith('/') ? node_path_1.default.relative(workingDir, value) : value));
+        issues.sort().forEach(value => console.log(value.startsWith('/') ? (0, path_1.relative)(value) : value));
     }
     else {
         console.log('Not found');
     }
 };
-const logIssueGroupResults = (issues, workingDir, title) => {
+const logIssueRecord = (issues, title) => {
     title && console.log(`--- ${title} (${issues.length})`);
     if (issues.length) {
         const sortedByFilePath = issues.sort((a, b) => (a.filePath > b.filePath ? 1 : -1));
-        sortedByFilePath.forEach(({ filePath, symbols }) => logIssueLine(workingDir, filePath, symbols));
+        sortedByFilePath.forEach(({ filePath, symbols }) => logIssueLine(filePath, symbols));
     }
     else {
         console.log('Not found');
     }
 };
-exports.default = ({ report, issues, workingDir, isDev }) => {
+exports.default = ({ report, issues }) => {
     const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
-    if (report.files) {
-        const unreferencedFiles = Array.from(issues.files);
-        logIssueGroupResult(unreferencedFiles, workingDir, reportMultipleGroups && 'UNUSED FILES');
-    }
-    if (report.dependencies) {
-        const unreferencedDependencies = Array.from(issues.dependencies);
-        logIssueGroupResult(unreferencedDependencies, workingDir, reportMultipleGroups && 'UNUSED DEPENDENCIES');
-    }
-    if (report.dependencies && isDev) {
-        const unreferencedDevDependencies = Array.from(issues.devDependencies);
-        logIssueGroupResult(unreferencedDevDependencies, workingDir, 'UNUSED DEV DEPENDENCIES');
-    }
-    if (report.unlisted) {
-        const unreferencedDependencies = Object.values(issues.unresolved).map(issues => {
-            const items = Object.values(issues);
-            return { ...items[0], symbols: items.map(i => i.symbol) };
-        });
-        logIssueGroupResults(unreferencedDependencies, workingDir, reportMultipleGroups && 'UNLISTED DEPENDENCIES');
-    }
-    if (report.exports) {
-        const unreferencedExports = Object.values(issues.exports).map(issues => {
-            const items = Object.values(issues);
-            return { ...items[0], symbols: items.map(i => i.symbol) };
-        });
-        logIssueGroupResults(unreferencedExports, workingDir, reportMultipleGroups && 'UNUSED EXPORTS');
-    }
-    if (report.nsExports) {
-        const unreferencedNsExports = Object.values(issues.nsExports).map(issues => {
-            const items = Object.values(issues);
-            return { ...items[0], symbols: items.map(i => i.symbol) };
-        });
-        logIssueGroupResults(unreferencedNsExports, workingDir, reportMultipleGroups && 'UNUSED EXPORTS IN NAMESPACE');
-    }
-    if (report.types) {
-        const unreferencedTypes = Object.values(issues.types).map(issues => {
-            const items = Object.values(issues);
-            return { ...items[0], symbols: items.map(i => i.symbol) };
-        });
-        logIssueGroupResults(unreferencedTypes, workingDir, reportMultipleGroups && 'UNUSED TYPES');
-    }
-    if (report.nsTypes) {
-        const unreferencedNsTypes = Object.values(issues.nsTypes).map(issues => {
-            const items = Object.values(issues);
-            return { ...items[0], symbols: items.map(i => i.symbol) };
-        });
-        logIssueGroupResults(unreferencedNsTypes, workingDir, reportMultipleGroups && 'UNUSED TYPES IN NAMESPACE');
-    }
-    if (report.duplicates) {
-        const unreferencedDuplicates = Object.values(issues.duplicates)
-            .map(issues => Object.values(issues))
-            .flat();
-        logIssueGroupResults(unreferencedDuplicates, workingDir, reportMultipleGroups && 'DUPLICATE EXPORTS');
+    for (const [reportType, isReportType] of Object.entries(report)) {
+        if (isReportType) {
+            const title = reportMultipleGroups && constants_1.ISSUE_TYPE_TITLE[reportType];
+            if (issues[reportType] instanceof Set) {
+                logIssueSet(Array.from(issues[reportType]), title);
+            }
+            else if (reportType === 'duplicates') {
+                const issuesForType = Object.values(issues[reportType]).map(Object.values).flat();
+                logIssueRecord(issuesForType, title);
+            }
+            else {
+                const issuesForType = Object.values(issues[reportType]).map(issues => {
+                    const items = Object.values(issues);
+                    return { ...items[0], symbols: items.map(issue => issue.symbol) };
+                });
+                logIssueRecord(issuesForType, title);
+            }
+        }
     }
 };

package/dist/reporters/constants.d.ts

@@ -0,0 +1,11 @@
+export declare const ISSUE_TYPE_TITLE: {
+    files: string;
+    dependencies: string;
+    devDependencies: string;
+    unlisted: string;
+    exports: string;
+    nsExports: string;
+    types: string;
+    nsTypes: string;
+    duplicates: string;
+};

package/dist/reporters/constants.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ISSUE_TYPE_TITLE = void 0;
+exports.ISSUE_TYPE_TITLE = {
+    files: 'UNUSED FILES',
+    dependencies: 'UNUSED DEPENDENCIES',
+    devDependencies: 'UNUSED DEV DEPENDENCIES',
+    unlisted: 'UNLISTED DEPENDENCIES',
+    exports: 'UNUSED EXPORTS',
+    nsExports: 'UNUSED EXPORTS IN NAMESPACE',
+    types: 'UNUSED TYPES',
+    nsTypes: 'UNUSED TYPES IN NAMESPACE',
+    duplicates: 'DUPLICATE EXPORTS',
+};

package/dist/reporters/index.d.ts

@@ -1,6 +1,7 @@
 declare const _default: {
-    symbols: ({ report, issues, workingDir, isDev }: import("../types").ReporterOptions) => void;
-    compact: ({ report, issues, workingDir, isDev }: import("../types").ReporterOptions) => void;
-    codeowners: ({ report, issues, cwd, isDev, options }: import("../types").ReporterOptions) => void;
+    symbols: ({ report, issues }: import("../types").ReporterOptions) => void;
+    compact: ({ report, issues }: import("../types").ReporterOptions) => void;
+    codeowners: ({ report, issues, options }: import("../types").ReporterOptions) => void;
+    json: ({ report, issues, options }: import("../types").ReporterOptions) => Promise<void>;
 };
 export default _default;

package/dist/reporters/index.js

@@ -6,8 +6,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const symbols_1 = __importDefault(require("./symbols"));
 const compact_1 = __importDefault(require("./compact"));
 const codeowners_1 = __importDefault(require("./codeowners"));
+const json_1 = __importDefault(require("./json"));
 exports.default = {
     symbols: symbols_1.default,
     compact: compact_1.default,
     codeowners: codeowners_1.default,
+    json: json_1.default,
 };

package/dist/reporters/json.d.ts

@@ -0,0 +1,3 @@
+import type { ReporterOptions } from '../types';
+declare const _default: ({ report, issues, options }: ReporterOptions) => Promise<void>;
+export default _default;

package/dist/reporters/json.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 });
+const node_path_1 = __importDefault(require("node:path"));
+const fs_1 = require("../util/fs");
+const path_1 = require("../util/path");
+const ownership_1 = require("@snyk/github-codeowners/dist/lib/ownership");
+const mergeTypes = (type) => type === 'exports' || type === 'nsExports' ? 'exports' : type === 'types' || type === 'nsTypes' ? 'types' : type;
+exports.default = async ({ report, issues, options }) => {
+    let opts = {};
+    try {
+        opts = options ? JSON.parse(options) : opts;
+    }
+    catch (error) {
+        console.error(error);
+    }
+    const json = {};
+    const codeownersFilePath = node_path_1.default.resolve(opts.codeowners ?? '.github/CODEOWNERS');
+    const codeownersEngine = (await (0, fs_1.isFile)(codeownersFilePath)) && ownership_1.OwnershipEngine.FromCodeownersFile(codeownersFilePath);
+    const flatten = (issues) => Object.values(issues).map(Object.values).flat();
+    const initRow = (filePath) => {
+        const file = (0, path_1.relative)(filePath);
+        const row = {
+            file,
+            ...(codeownersEngine && { owners: codeownersEngine.calcFileOwnership(file) }),
+            ...(report.files && { files: false }),
+            ...(report.unlisted && { unlisted: [] }),
+            ...((report.exports || report.nsExports) && { exports: [] }),
+            ...((report.types || report.nsTypes) && { types: [] }),
+            ...(report.duplicates && { duplicates: [] }),
+        };
+        return row;
+    };
+    for (const [reportType, isReportType] of Object.entries(report)) {
+        if (isReportType) {
+            if (reportType === 'files') {
+                Array.from(issues[reportType]).forEach(filePath => {
+                    json[filePath] = json[filePath] ?? initRow(filePath);
+                    json[filePath][reportType] = true;
+                });
+            }
+            else {
+                const type = mergeTypes(reportType);
+                flatten(issues[reportType]).forEach(({ filePath, symbol }) => {
+                    json[filePath] = json[filePath] ?? initRow(filePath);
+                    json[filePath][type]?.push(symbol);
+                });
+            }
+        }
+    }
+    console.log(JSON.stringify(Object.values(json)));
+};

package/dist/reporters/symbols.d.ts

@@ -1,3 +1,3 @@
 import type { ReporterOptions } from '../types';
-declare const _default: ({ report, issues, workingDir, isDev }: ReporterOptions) => void;
+declare const _default: ({ report, issues }: ReporterOptions) => void;
 export default _default;

package/dist/reporters/symbols.js

@@ -1,72 +1,47 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const node_path_1 = __importDefault(require("node:path"));
+const path_1 = require("../util/path");
+const constants_1 = require("./constants");
 const TRUNCATE_WIDTH = 40;
-const logIssueLine = (issue, workingDir, maxWidth) => {
+const logIssueLine = (issue, maxWidth) => {
     const symbols = issue.symbols ? issue.symbols.join(', ') : issue.symbol;
     const truncatedSymbol = symbols.length > maxWidth ? symbols.slice(0, maxWidth - 3) + '...' : symbols;
-    const filePath = node_path_1.default.relative(workingDir, issue.filePath);
+    const filePath = (0, path_1.relative)(issue.filePath);
     console.log(`${truncatedSymbol.padEnd(maxWidth + 2)}${issue.symbolType?.padEnd(11) || ''}${filePath}`);
 };
-const logIssueGroupResult = (issues, workingDir, title) => {
+const logIssueSet = (issues, title) => {
     title && console.log(`--- ${title} (${issues.length})`);
     if (issues.length) {
-        issues.sort().forEach(value => console.log(value.startsWith('/') ? node_path_1.default.relative(workingDir, value) : value));
+        issues.sort().forEach(value => console.log(value.startsWith('/') ? (0, path_1.relative)(value) : value));
     }
     else {
         console.log('Not found');
     }
 };
-const logIssueGroupResults = (issues, workingDir, title, isTruncate = false) => {
+const logIssueRecord = (issues, title, isTruncate = false) => {
     title && console.log(`--- ${title} (${issues.length})`);
     if (issues.length) {
         const sortedByFilePath = issues.sort((a, b) => (a.filePath > b.filePath ? 1 : -1));
         const maxWidth = isTruncate ? TRUNCATE_WIDTH : issues.reduce((max, issue) => Math.max(issue.symbol.length, max), 0);
-        sortedByFilePath.forEach(issue => logIssueLine(issue, workingDir, maxWidth));
+        sortedByFilePath.forEach(issue => logIssueLine(issue, maxWidth));
     }
     else {
         console.log('Not found');
     }
 };
-exports.default = ({ report, issues, workingDir, isDev }) => {
+exports.default = ({ report, issues }) => {
     const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
-    if (report.files) {
-        const unreferencedFiles = Array.from(issues.files);
-        logIssueGroupResult(unreferencedFiles, workingDir, reportMultipleGroups && 'UNUSED FILES');
-    }
-    if (report.dependencies) {
-        const unreferencedDependencies = Array.from(issues.dependencies);
-        logIssueGroupResult(unreferencedDependencies, workingDir, reportMultipleGroups && 'UNUSED DEPENDENCIES');
-    }
-    if (report.dependencies && isDev) {
-        const unreferencedDevDependencies = Array.from(issues.devDependencies);
-        logIssueGroupResult(unreferencedDevDependencies, workingDir, 'UNUSED DEV DEPENDENCIES');
-    }
-    if (report.unlisted) {
-        const unresolvedDependencies = Object.values(issues.unresolved).map(Object.values).flat();
-        logIssueGroupResults(unresolvedDependencies, workingDir, reportMultipleGroups && 'UNLISTED DEPENDENCIES');
-    }
-    if (report.exports) {
-        const unreferencedExports = Object.values(issues.exports).map(Object.values).flat();
-        logIssueGroupResults(unreferencedExports, workingDir, reportMultipleGroups && 'UNUSED EXPORTS');
-    }
-    if (report.nsExports) {
-        const unreferencedNsExports = Object.values(issues.nsExports).map(Object.values).flat();
-        logIssueGroupResults(unreferencedNsExports, workingDir, reportMultipleGroups && 'UNUSED EXPORTS IN NAMESPACE');
-    }
-    if (report.types) {
-        const unreferencedTypes = Object.values(issues.types).map(Object.values).flat();
-        logIssueGroupResults(unreferencedTypes, workingDir, reportMultipleGroups && 'UNUSED TYPES');
-    }
-    if (report.nsTypes) {
-        const unreferencedNsTypes = Object.values(issues.nsTypes).map(Object.values).flat();
-        logIssueGroupResults(unreferencedNsTypes, workingDir, reportMultipleGroups && 'UNUSED TYPES IN NAMESPACE');
-    }
-    if (report.duplicates) {
-        const unreferencedDuplicates = Object.values(issues.duplicates).map(Object.values).flat();
-        logIssueGroupResults(unreferencedDuplicates, workingDir, reportMultipleGroups && 'DUPLICATE EXPORTS', true);
+    for (const [reportType, isReportType] of Object.entries(report)) {
+        if (isReportType) {
+            const title = reportMultipleGroups && constants_1.ISSUE_TYPE_TITLE[reportType];
+            if (issues[reportType] instanceof Set) {
+                logIssueSet(Array.from(issues[reportType]), title);
+            }
+            else {
+                const issuesForType = Object.values(issues[reportType]).map(Object.values).flat();
+                const isTruncate = Boolean(issuesForType[0]?.symbols?.length);
+                logIssueRecord(issuesForType, title, isTruncate);
+            }
+        }
     }
 };

package/dist/runner.js

@@ -27,7 +27,7 @@ async function findIssues(configuration) {
         files: new Set(unreferencedProductionFiles.map(file => file.getFilePath())),
         dependencies: new Set(),
         devDependencies: new Set(),
-        unresolved: {},
+        unlisted: {},
         exports: {},
         types: {},
         nsExports: {},
@@ -38,7 +38,7 @@ async function findIssues(configuration) {
         files: issues.files.size,
         dependencies: issues.dependencies.size,
         devDependencies: issues.dependencies.size,
-        unresolved: 0,
+        unlisted: 0,
         exports: 0,
         types: 0,
         nsExports: 0,
@@ -76,7 +76,7 @@ async function findIssues(configuration) {
             const filePath = sourceFile.getFilePath();
             if (report.dependencies || report.unlisted) {
                 const unresolvedDependencies = getUnresolvedDependencies(sourceFile);
-                unresolvedDependencies.forEach(issue => addSymbolIssue('unresolved', issue));
+                unresolvedDependencies.forEach(issue => addSymbolIssue('unlisted', issue));
             }
             const exportDeclarations = sourceFile.getExportedDeclarations();
             if (report.duplicates) {

package/dist/types.d.ts

@@ -1,30 +1,30 @@
 import { SourceFile } from 'ts-morph';
 declare type SymbolType = 'type' | 'interface' | 'enum';
-declare type UnusedFileIssues = Set<string>;
-declare type UnusedExportIssues = Record<string, Record<string, Issue>>;
-declare type UnresolvedDependencyIssues = Record<string, Record<string, Issue>>;
-declare type UnusedDependencyIssues = Set<string>;
 export declare type Issue = {
     filePath: string;
     symbol: string;
     symbols?: string[];
     symbolType?: SymbolType;
 };
+export declare type IssueSet = Set<string>;
+export declare type IssueRecords = Record<string, Record<string, Issue>>;
 export declare type Issues = {
-    files: UnusedFileIssues;
-    dependencies: UnusedDependencyIssues;
-    devDependencies: UnusedDependencyIssues;
-    unresolved: UnresolvedDependencyIssues;
-    exports: UnusedExportIssues;
-    types: UnusedExportIssues;
-    nsExports: UnusedExportIssues;
-    nsTypes: UnusedExportIssues;
-    duplicates: UnusedExportIssues;
+    files: IssueSet;
+    dependencies: IssueSet;
+    devDependencies: IssueSet;
+    unlisted: IssueRecords;
+    exports: IssueRecords;
+    types: IssueRecords;
+    nsExports: IssueRecords;
+    nsTypes: IssueRecords;
+    duplicates: IssueRecords;
 };
-declare type IssueType = keyof Issues;
+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 IssueGroup = 'files' | 'dependencies' | 'unlisted' | 'exports' | 'nsExports' | 'types' | 'nsTypes' | 'duplicates';
+export declare type Report = {
+    [key in keyof Issues]: boolean;
+};
 declare type BaseLocalConfiguration = {
     entryFiles: string[];
     projectFiles: string[];
@@ -53,9 +53,6 @@ export declare type UnresolvedConfiguration = {
         level: number;
     };
 };
-export declare type Report = {
-    [key in IssueGroup]: boolean;
-};
 export declare type Configuration = {
     workingDir: string;
     report: Report;

package/dist/util/config.d.ts

@@ -3,4 +3,4 @@ export declare const resolveConfig: (importedConfiguration: ImportedConfiguratio
     workingDir?: string;
     isDev?: boolean;
 }) => LocalConfiguration | undefined;
-export declare const resolveIncludedIssueGroups: (includeArg: string[], excludeArg: string[], resolvedConfig?: LocalConfiguration) => import("../types").Report;
+export declare const resolveIncludedIssueTypes: (includeArg: string[], excludeArg: string[], resolvedConfig?: LocalConfiguration) => import("../types").Report;

package/dist/util/config.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveIncludedIssueGroups = exports.resolveConfig = void 0;
+exports.resolveIncludedIssueTypes = exports.resolveConfig = void 0;
 const micromatch_1 = __importDefault(require("micromatch"));
 const resolveConfig = (importedConfiguration, options) => {
     if (!importedConfiguration)
@@ -24,20 +24,13 @@ const resolveConfig = (importedConfiguration, options) => {
         console.info(`Add these properties at root level, or use --dir and match one of: ${configKeys.join(', ')}\n`);
         return;
     }
+    resolvedConfig.dev = Boolean(typeof resolvedConfig.dev === 'boolean' ? resolvedConfig.dev : isDev);
     return resolvedConfig;
 };
 exports.resolveConfig = resolveConfig;
-const resolveIncludedIssueGroups = (includeArg, excludeArg, resolvedConfig) => {
-    const groups = [
-        'files',
-        'dependencies',
-        'unlisted',
-        'exports',
-        'types',
-        'nsExports',
-        'nsTypes',
-        'duplicates',
-    ];
+const resolveIncludedIssueTypes = (includeArg, excludeArg, resolvedConfig) => {
+    const deps = resolvedConfig?.dev ? ['dependencies', 'devDependencies'] : ['dependencies'];
+    const groups = ['files', ...deps, 'unlisted', 'exports', 'types', 'nsExports', 'nsTypes', 'duplicates'];
     const include = [includeArg, resolvedConfig?.include ?? []]
         .flat()
         .map(value => value.split(','))
@@ -46,7 +39,7 @@ const resolveIncludedIssueGroups = (includeArg, excludeArg, resolvedConfig) => {
         .flat()
         .map(value => value.split(','))
         .flat();
-    const includes = (include.length > 0 ? include : groups).filter((group) => !exclude.includes(group));
+    const includes = (include.length > 0 ? include : groups).filter(group => !exclude.includes(group));
     return groups.reduce((r, group) => ((r[group] = includes.includes(group)), r), {});
 };
-exports.resolveIncludedIssueGroups = resolveIncludedIssueGroups;
+exports.resolveIncludedIssueTypes = resolveIncludedIssueTypes;

package/dist/util/debug.d.ts

@@ -8,5 +8,4 @@ declare type Config = {
 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

@@ -3,7 +3,7 @@ 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;
+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) => {
@@ -51,4 +51,3 @@ const debugLogDiff = (config, minimumLevel, name, arrA, arrB) => {
     console.log(`[knip] Only in right:`);
     logArray(onlyInB);
 };
-exports.debugLogDiff = debugLogDiff;

package/dist/util/fs.d.ts

@@ -1 +1,2 @@
+export declare const isFile: (filePath: string) => Promise<boolean>;
 export declare const findFile: (cwd: string, workingDir: string, fileName: string) => Promise<string | undefined>;

package/dist/util/fs.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findFile = void 0;
+exports.findFile = exports.isFile = void 0;
 const promises_1 = __importDefault(require("node:fs/promises"));
 const node_path_1 = __importDefault(require("node:path"));
 const isFile = async (filePath) => {
@@ -15,9 +15,10 @@ const isFile = async (filePath) => {
         return false;
     }
 };
+exports.isFile = isFile;
 const findFile = async (cwd, workingDir, fileName) => {
     const filePath = node_path_1.default.join(workingDir, fileName);
-    if (await isFile(filePath)) {
+    if (await (0, exports.isFile)(filePath)) {
         return filePath;
     }
     else {

package/dist/util/path.d.ts

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

package/dist/util/path.js

@@ -3,8 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolvePaths = void 0;
+exports.resolvePaths = 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) {
@@ -18,7 +21,7 @@ const prependDirToPattern = (workingDir, pattern) => {
         return '!' + node_path_1.default.join(workingDir, pattern.slice(1));
     return node_path_1.default.join(workingDir, pattern);
 };
-const resolvePaths = async ({ cwd, workingDir, patterns, ignore, gitignore, }) => glob(patterns.map(pattern => prependDirToPattern(node_path_1.default.relative(cwd, workingDir), pattern)), {
+const resolvePaths = async ({ workingDir, patterns, ignore, gitignore, }) => glob(patterns.map(pattern => prependDirToPattern((0, exports.relative)(workingDir), pattern)), {
     cwd,
     ignore,
     gitignore,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "0.8.2",
+  "version": "0.9.1",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript project",
   "keywords": [
     "find",
@@ -24,7 +24,7 @@
     "knip": "dist/cli.js"
   },
   "scripts": {
-    "knip": "node ./dist/cli.js --include files,dependencies,unlisted",
+    "knip": "node ./dist/cli.js --jsdoc public",
     "test": "node --loader tsx --test test/*.spec.ts",
     "watch": "tsc --watch",
     "build": "rm -rf dist && tsc",
@@ -49,10 +49,11 @@
   },
   "devDependencies": {
     "@types/micromatch": "4.0.2",
-    "@types/node": "18.8.5",
+    "@types/node": "18.11.2",
     "prettier": "2.7.1",
     "release-it": "15.5.0",
-    "tsx": "3.10.1",
+    "tsx": "3.10.3",
+    "type-fest": "3.1.0",
     "typescript": "4.8.4"
   },
   "release-it": {
@@ -61,7 +62,7 @@
     }
   },
   "engines": {
-    "node": ">=16.17.0"
+    "node": ">=16.17.0 <17 || >=18.3.0"
   },
   "engineStrict": true
 }