knip 0.5.0 → 0.7.0

package/README.md

@@ -20,6 +20,7 @@ This is where Knip comes in:
 - [x] Finds duplicate exports of the same symbol.
 - [x] Supports JavaScript inside TypeScript projects (`"allowJs": true`)
 - [x] Supports JavaScript-only projects using ESM (without a `tsconfig.json`)
+- [x] Features multiple [reporters](#reporters) and supports [custom reporters](#custom-reporters).
 
 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. To produce good
@@ -91,7 +92,8 @@ Options:
   --dev                  Include `devDependencies` in report(s)
   --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 (default: symbols)
+  --reporter             Select reporter: symbols, compact, codeowners (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
   --debug-level          Set verbosity of debug output (default: 1, max: 2)
@@ -104,6 +106,7 @@ $ knip
 $ knip --dir packages/client --include files
 $ knip -c ./knip.js --reporter compact --jsdoc public
 $ knip --ignore 'lib/**/*.ts' --ignore build
+$ knip --reporter codeowners --reporter-options '{"path":".github/CODEOWNERS"}'
 
 More info: https://github.com/webpro/knip
 ```
@@ -245,9 +248,38 @@ module.exports = { entryFiles, projectFiles };
 This should give good results about unused files and exports for the monorepo. After the first run, the configuration
 can be tweaked further to the project structure.
 
-## Example Output
+## Reporters
 
-### Default reporter
+For starters, Knip already contains a few useful reporters:
+
+- `symbol` (default)
+- `compact`
+- `codeowners`
+
+### Custom Reporters
+
+When a `--reporter ./my-reporter` is passed, the default export of that module should have this interface:
+
+```ts
+type Reporter = (options: ReporterOptions) => void;
+
+type ReporterOptions = {
+  report: Report;
+  issues: Issues;
+  cwd: string;
+  workingDir: string;
+  isDev: boolean;
+  options: string;
+};
+```
+
+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
+
+#### Symbol (default)
+
+The default reporter shows the sorted symbols first:
 
 ```
 $ knip
@@ -274,7 +306,9 @@ Registration, default  src/components/Registration.tsx
 ProductsList, default  src/components/Products.tsx
 ```
 
-### Compact
+#### Compact
+
+The compact reporter shows the sorted files first, and then a list of symbols:
 
 ```
 $ knip --reporter compact
@@ -299,6 +333,37 @@ src/components/Registration.tsx: Registration, default
 src/components/Products.tsx: ProductsList, default
 ```
 
+#### Code Owners
+
+The `codeowners` reporter is like `compact`, but shows the sorted code owners (according to `.github/CODEOWNERS`) first:
+
+```
+$ knip --reporter codeowners
+--- UNUSED FILES (2)
+@org/team src/chat/helpers.ts
+@org/owner src/components/SideBar.tsx
+--- UNUSED DEPENDENCIES (1)
+@org/admin moment
+--- UNLISTED DEPENDENCIES (1)
+@org/owner src/components/Registration.tsx react
+--- UNUSED EXPORTS (4)
+@org/team src/common/src/string/index.ts: lowercaseFirstLetter
+@org/owner src/components/Registration.tsx: RegistrationBox
+@org/owner src/css.ts: clamp
+@org/owner src/services/authentication.ts: restoreSession, PREFIX
+--- UNUSED TYPES (3)
+@org/owner src/components/Registration/registrationMachine.ts: RegistrationServices, RegistrationAction
+@org/owner src/components/Registration.tsx: ComponentProps
+@org/owner src/types/Product.ts: ProductDetail
+--- DUPLICATE EXPORTS (2)
+@org/owner src/components/Registration.tsx: Registration, default
+@org/owner src/components/Products.tsx: ProductsList, default
+```
+
+The owner of `package.json` is considered the owner of unused (dev) dependencies.
+
+Use `--reporter-options '{"path":".github/CODEOWNERS"}'` to pass another location for the code owners file.
+
 ## Why Yet Another unused file/dependency/export finder?
 
 There are already some great packages available. Getting good results when finding unused files, dependencies and

package/dist/cli.js

@@ -10,7 +10,7 @@ const _1 = require(".");
 const help_1 = require("./help");
 const reporters_1 = __importDefault(require("./reporters"));
 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)({
+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', 'reporter-options': reporterOptions = '', '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 +24,7 @@ const { values: { help, dir, config: configFilePath = 'knip.json', tsConfig: tsC
         'no-progress': { type: 'boolean' },
         'max-issues': { type: 'string' },
         reporter: { type: 'string' },
+        'reporter-options': { type: 'string' },
         jsdoc: { type: 'string', multiple: true },
         debug: { type: 'boolean' },
         'debug-level': { type: 'string' },
@@ -56,7 +57,7 @@ const run = async () => {
                 level: isDebug ? Number(debugLevel) : 0,
             },
         });
-        printReport({ report, issues, workingDir, isDev });
+        printReport({ report, issues, cwd, workingDir, isDev, options: reporterOptions });
         const reportGroup = report.files ? 'files' : Object.keys(report).find(key => report[key]);
         const counterGroup = reportGroup === 'unlisted' ? 'unresolved' : reportGroup;
         if (counterGroup) {

package/dist/help.js

@@ -15,7 +15,8 @@ Options:
   --dev                  Include \`devDependencies\` in report(s)
   --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 (default: symbols)
+  --reporter             Select reporter: symbols, compact, codeowners (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
   --debug-level          Set verbosity of debug output (default: 1, max: 2)
@@ -28,6 +29,7 @@ $ knip
 $ knip --dir packages/client --include files
 $ knip -c ./knip.js --reporter compact --jsdoc public
 $ knip --ignore 'lib/**/*.ts' --ignore build
+$ knip --reporter codeowners --reporter-options '{"path":".github/CODEOWNERS"}'
 
 More info: https://github.com/webpro/knip`);
 };

package/dist/index.js

@@ -78,6 +78,8 @@ const main = async (options) => {
         productionFiles,
         projectFiles,
         dependencies: Object.keys(manifest.dependencies ?? {}),
+        peerDependencies: Object.keys(manifest.peerDependencies ?? {}),
+        optionalDependencies: Object.keys(manifest.optionalDependencies ?? {}),
         devDependencies: Object.keys(manifest.devDependencies ?? {}),
         isDev: typeof resolvedConfig.dev === 'boolean' ? resolvedConfig.dev : isDev,
         tsConfigPaths,

package/dist/reporters/codeowners.d.ts

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

package/dist/reporters/codeowners.js

@@ -0,0 +1,98 @@
+"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 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 logIssueGroupResult = (issues, cwd, 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));
+    }
+    else {
+        console.log('Not found');
+    }
+};
+const logIssueGroupResults = (issues, cwd, 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));
+    }
+    else {
+        console.log('Not found');
+    }
+};
+exports.default = ({ report, issues, cwd, isDev, options }) => {
+    let opts = {};
+    try {
+        opts = JSON.parse(options);
+    }
+    catch (error) {
+        console.error(error);
+    }
+    const codeownersFilePath = node_path_1.default.resolve(opts.path ?? '.github/CODEOWNERS');
+    const codeownersEngine = ownership_1.OwnershipEngine.FromCodeownersFile(codeownersFilePath);
+    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');
+    }
+};

package/dist/reporters/compact.d.ts

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

package/dist/reporters/compact.js

@@ -26,7 +26,7 @@ const logIssueGroupResults = (issues, workingDir, title) => {
         console.log('Not found');
     }
 };
-exports.default = ({ report, issues, workingDir, isDev, }) => {
+exports.default = ({ report, issues, workingDir, isDev }) => {
     const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
     if (report.files) {
         const unreferencedFiles = Array.from(issues.files);

package/dist/reporters/index.d.ts

@@ -1,15 +1,6 @@
 declare const _default: {
-    symbols: ({ report, issues, workingDir, isDev, }: {
-        report: import("../types").Report;
-        issues: import("../types").Issues;
-        workingDir: string;
-        isDev: boolean;
-    }) => void;
-    compact: ({ report, issues, workingDir, isDev, }: {
-        report: import("../types").Report;
-        issues: import("../types").Issues;
-        workingDir: string;
-        isDev: boolean;
-    }) => void;
+    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;
 };
 export default _default;

package/dist/reporters/index.js

@@ -5,7 +5,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const symbols_1 = __importDefault(require("./symbols"));
 const compact_1 = __importDefault(require("./compact"));
+const codeowners_1 = __importDefault(require("./codeowners"));
 exports.default = {
     symbols: symbols_1.default,
     compact: compact_1.default,
+    codeowners: codeowners_1.default,
 };

package/dist/reporters/symbols.d.ts

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

package/dist/reporters/symbols.js

@@ -28,7 +28,7 @@ const logIssueGroupResults = (issues, workingDir, title) => {
         console.log('Not found');
     }
 };
-exports.default = ({ report, issues, workingDir, isDev, }) => {
+exports.default = ({ report, issues, workingDir, isDev }) => {
     const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
     if (report.files) {
         const unreferencedFiles = Array.from(issues.files);

package/dist/types.d.ts

@@ -62,6 +62,8 @@ export declare type Configuration = {
     productionFiles: SourceFile[];
     entryFiles: SourceFile[];
     dependencies: string[];
+    peerDependencies: string[];
+    optionalDependencies: string[];
     devDependencies: string[];
     isDev: boolean;
     tsConfigPaths: string[];
@@ -74,4 +76,13 @@ export declare type Configuration = {
         level: number;
     };
 };
+export declare type ReporterOptions = {
+    report: Report;
+    issues: Issues;
+    cwd: string;
+    workingDir: string;
+    isDev: boolean;
+    options: string;
+};
+export declare type Reporter = (options: ReporterOptions) => void;
 export {};

package/dist/util/dependencies.js

@@ -9,7 +9,8 @@ const is_builtin_module_1 = __importDefault(require("is-builtin-module"));
 const micromatch_1 = __importDefault(require("micromatch"));
 const compact = (collection) => Array.from(new Set(collection)).filter((value) => Boolean(value));
 const getDependencyAnalyzer = (configuration) => {
-    const { dependencies, devDependencies, tsConfigPaths } = configuration;
+    const { dependencies, devDependencies, peerDependencies, optionalDependencies, tsConfigPaths } = configuration;
+    const productionDependencies = [...dependencies, ...peerDependencies, ...optionalDependencies];
     const referencedDependencies = new Set();
     const getUnresolvedDependencies = (sourceFile) => {
         const unresolvedDependencies = new Set();
@@ -29,16 +30,16 @@ const getDependencyAnalyzer = (configuration) => {
                 return;
             const parts = moduleSpecifier.split('/').slice(0, 2);
             const packageName = moduleSpecifier.startsWith('@') ? parts.join('/') : parts[0];
-            if (!dependencies.includes(packageName) && !devDependencies.includes(packageName)) {
+            if (!productionDependencies.includes(packageName) && !devDependencies.includes(packageName)) {
                 unresolvedDependencies.add({ filePath: sourceFile.getFilePath(), symbol: moduleSpecifier });
             }
-            if (dependencies.includes(packageName) || devDependencies.includes(packageName)) {
+            if (productionDependencies.includes(packageName) || devDependencies.includes(packageName)) {
                 referencedDependencies.add(packageName);
             }
         });
         return unresolvedDependencies;
     };
-    const getUnusedDependencies = () => dependencies.filter(dependency => !referencedDependencies.has(dependency));
+    const getUnusedDependencies = () => productionDependencies.filter(dependency => !referencedDependencies.has(dependency));
     const getUnusedDevDependencies = () => devDependencies.filter(dependency => !referencedDependencies.has(dependency));
     return { getUnresolvedDependencies, getUnusedDependencies, getUnusedDevDependencies };
 };

package/dist/util/fs.d.ts

@@ -1,2 +1 @@
-export declare const isFile: (filePath: string) => Promise<boolean>;
 export declare const findFile: (cwd: 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 = exports.isFile = void 0;
+exports.findFile = void 0;
 const promises_1 = __importDefault(require("node:fs/promises"));
 const node_path_1 = __importDefault(require("node:path"));
 const isFile = async (filePath) => {
@@ -15,10 +15,9 @@ const isFile = async (filePath) => {
         return false;
     }
 };
-exports.isFile = isFile;
 const findFile = async (cwd, fileName) => {
     const filePath = node_path_1.default.join(cwd, fileName);
-    if (await (0, exports.isFile)(filePath)) {
+    if (await isFile(filePath)) {
         return filePath;
     }
     else {

package/dist/util/path.d.ts

@@ -1,4 +1,3 @@
-export declare const prependDirToPattern: (workingDir: string, pattern: string) => string;
 export declare const resolvePaths: ({ cwd, workingDir, patterns, ignore, gitignore, }: {
     cwd: string;
     workingDir: string;

package/dist/util/path.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.resolvePaths = exports.prependDirToPattern = void 0;
+exports.resolvePaths = void 0;
 const node_path_1 = __importDefault(require("node:path"));
 let _globby;
 const glob = async function (patterns, options) {
@@ -18,8 +18,7 @@ const prependDirToPattern = (workingDir, pattern) => {
         return '!' + node_path_1.default.join(workingDir, pattern.slice(1));
     return node_path_1.default.join(workingDir, pattern);
 };
-exports.prependDirToPattern = prependDirToPattern;
-const resolvePaths = async ({ cwd, workingDir, patterns, ignore, gitignore, }) => glob(patterns.map(pattern => (0, exports.prependDirToPattern)(node_path_1.default.relative(cwd, workingDir), pattern)), {
+const resolvePaths = async ({ cwd, workingDir, patterns, ignore, gitignore, }) => glob(patterns.map(pattern => prependDirToPattern(node_path_1.default.relative(cwd, workingDir), pattern)), {
     cwd,
     ignore,
     gitignore,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knip",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "Find unused files, dependencies and exports in your TypeScript and JavaScript project",
   "keywords": [
     "find",
@@ -40,6 +40,7 @@
   },
   "license": "ISC",
   "dependencies": {
+    "@snyk/github-codeowners": "1.0.0",
     "globby": "13.1.2",
     "is-builtin-module": "3.2.0",
     "micromatch": "4.0.5",