knip 5.62.0 → 5.63.1

package/dist/reporters/json.d.ts

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

package/dist/reporters/json.js

@@ -2,7 +2,7 @@ import { createOwnershipEngine } from '../util/codeowners.js';
 import { isFile } from '../util/fs.js';
 import { relative, resolve } from '../util/path.js';
 import { convert } from './util/util.js';
-export default async ({ report, issues, options }) => {
+export default async ({ report, issues, options, cwd }) => {
     let opts = {};
     try {
         opts = options ? JSON.parse(options) : opts;
@@ -15,7 +15,7 @@ export default async ({ report, issues, options }) => {
     const findOwners = isFile(codeownersFilePath) && createOwnershipEngine(codeownersFilePath);
     const flatten = (issues) => Object.values(issues).flatMap(Object.values);
     const initRow = (filePath) => {
-        const file = relative(filePath);
+        const file = relative(cwd, filePath);
         const row = {
             file,
             ...(findOwners && { owners: findOwners(file).map(name => ({ name })) }),
@@ -66,7 +66,7 @@ export default async ({ report, issues, options }) => {
         }
     }
     const output = JSON.stringify({
-        files: Array.from(issues.files).map(filePath => relative(filePath)),
+        files: Array.from(issues.files).map(filePath => relative(cwd, filePath)),
         issues: Object.values(json),
     });
     process.stdout._handle?.setBlocking?.(true);

package/dist/reporters/markdown.d.ts

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

package/dist/reporters/markdown.js

@@ -1,11 +1,11 @@
 import { relative, toRelative } from '../util/path.js';
 import { getIssueTypeTitle } from './util/util.js';
-export default ({ report, issues }) => {
+export default ({ report, issues, cwd }) => {
     console.log('# Knip report\n');
     const getFilePath = (issue) => {
         if (!(issue.line && issue.col))
-            return relative(issue.filePath);
-        return `${relative(issue.filePath)}:${issue.line}:${issue.col}`;
+            return relative(cwd, issue.filePath);
+        return `${relative(cwd, issue.filePath)}:${issue.line}:${issue.col}`;
     };
     const sortLongestSymbol = (a, b) => b.symbol.length - a.symbol.length;
     const sortLongestFilePath = (a, b) => getFilePath(b).length - getFilePath(a).length;
@@ -20,7 +20,7 @@ export default ({ report, issues }) => {
                 console.log(`## ${title} (${issuesForType.length})\n`);
                 if (isSet) {
                     for (const issue of issuesForType.sort()) {
-                        console.log(`* ${toRelative(issue)}`);
+                        console.log(`* ${toRelative(issue, cwd)}`);
                     }
                 }
                 else {

package/dist/reporters/symbols.js

@@ -12,7 +12,7 @@ export default (options) => {
             const issuesForType = Object.values(issues[reportType]).flatMap(Object.values);
             if (issuesForType.length > 0) {
                 title && console.log(getColoredTitle(title, issuesForType.length));
-                console.log(getTableForType(issuesForType).toString());
+                console.log(getTableForType(issuesForType, options.cwd).toString());
                 totalIssues = totalIssues + issuesForType.length;
             }
         }
@@ -20,7 +20,9 @@ export default (options) => {
     if (!isDisableConfigHints) {
         printConfigurationHints(options);
     }
-    if (totalIssues === 0 && isShowProgress) {
+    if (totalIssues === 0 &&
+        isShowProgress &&
+        (!options.isTreatConfigHintsAsErrors || options.configurationHints.size === 0)) {
         console.log('✂️  Excellent, Knip found no issues.');
     }
 };

package/dist/reporters/util/configuration-hints.d.ts

@@ -1,2 +1,2 @@
 import type { ReporterOptions } from '../../types/issues.js';
-export declare const printConfigurationHints: ({ counters, issues, tagHints, configurationHints, isTreatConfigHintsAsErrors, includedWorkspaces, }: ReporterOptions) => void;
+export declare const printConfigurationHints: ({ cwd, counters, issues, tagHints, configurationHints, isTreatConfigHintsAsErrors, includedWorkspaceDirs, configFilePath, }: ReporterOptions) => void;

package/dist/reporters/util/configuration-hints.js

@@ -1,14 +1,33 @@
-import { toRelative } from '../../util/path.js';
+import { relative, toRelative } from '../../util/path.js';
+import { Table } from '../../util/table.js';
 import { byPathDepth } from '../../util/workspace.js';
-import { bright, dim, getColoredTitle, getDimmedTitle, plain, yellow } from './util.js';
-const id = (id) => bright(id.toString() + (id === '.' ? ' (root)' : ''));
-const type = (id) => yellow(id.split('-').at(0));
-const workspace = ({ isRootOnly, workspaceName: id }) => isRootOnly ? '' : id === '.' ? ` in root ${yellow('"."')} workspace` : ` in ${yellow(id ?? '.')}`;
-const unused = (options) => `Remove from ${type(options.type)}${options.workspaceName === '.' ? '' : `${workspace(options)}`}: ${id(options.identifier)}`;
-const empty = (options) => `Refine ${type(options.type)}${workspace(options)}: ${id(options.identifier)} (no files found)`;
-const remove = (options) => `Remove ${type(options.type)}${workspace(options)}: ${id(options.identifier)}`;
-const add = (options) => `Add to or refine in ${yellow('workspaces')}: ${id(options.identifier)} (${options.size} unused files)`;
-const topLevel = (options) => `Remove or move unused top-level ${type(options.type)} to one of ${yellow('workspaces')}: ${id(options.identifier)}`;
+import { bright, dim, getColoredTitle, getDimmedTitle } from './util.js';
+const getWorkspaceName = (hint) => hint.workspaceName &&
+    hint.workspaceName !== '.' &&
+    hint.type !== 'workspace-unconfigured' &&
+    hint.type !== 'package-entry'
+    ? hint.workspaceName
+    : '';
+const getTableForHints = (hints) => {
+    const table = new Table({ truncateStart: ['identifier', 'workspace', 'filePath'] });
+    for (const hint of hints) {
+        table.row();
+        table.cell('identifier', hint.identifier.toString());
+        table.cell('workspace', getWorkspaceName(hint));
+        table.cell('filePath', hint.filePath);
+        table.cell('description', dim(hint.message));
+    }
+    return table;
+};
+const type = (id) => bright(id.split('-').at(0));
+const unused = (options) => `Remove from ${type(options.type)}`;
+const empty = (options) => `Refine ${type(options.type)} pattern (no matches)`;
+const remove = (options) => `Remove redundant ${type(options.type)} pattern`;
+const topLevel = (options) => `Remove, or move unused top-level ${type(options.type)} to one of ${bright('"workspaces"')}`;
+const add = (options) => options.configFilePath
+    ? `Add ${bright('entry')} and/or refine ${bright('project')} files in ${bright(`workspaces["${options.workspaceName}"]`)} (${options.size} unused files)`
+    : `Create ${bright('knip.json')} configuration file with ${bright(`workspaces["${options.workspaceName}"]`)} object (${options.size} unused files)`;
+const packageEntry = () => 'Package entry file not found';
 const hintPrinters = new Map([
     ['ignoreBinaries', { print: unused }],
     ['ignoreDependencies', { print: unused }],
@@ -21,11 +40,21 @@ const hintPrinters = new Map([
     ['workspace-unconfigured', { print: add }],
     ['entry-top-level', { print: topLevel }],
     ['project-top-level', { print: topLevel }],
+    ['package-entry', { print: packageEntry }],
 ]);
-export const printConfigurationHints = ({ counters, issues, tagHints, configurationHints, isTreatConfigHintsAsErrors, includedWorkspaces, }) => {
+const hintTypesOrder = [
+    ['workspace-unconfigured'],
+    ['entry-top-level', 'project-top-level'],
+    ['ignoreWorkspaces'],
+    ['ignoreDependencies'],
+    ['ignoreBinaries'],
+    ['ignoreUnresolved'],
+    ['entry-empty', 'project-empty', 'entry-redundant', 'project-redundant'],
+    ['package-entry'],
+];
+export const printConfigurationHints = ({ cwd, counters, issues, tagHints, configurationHints, isTreatConfigHintsAsErrors, includedWorkspaceDirs, configFilePath, }) => {
     if (counters.files > 20) {
-        const workspaces = includedWorkspaces
-            .map(workspace => workspace.dir)
+        const workspaces = includedWorkspaceDirs
             .sort(byPathDepth)
             .reverse()
             .map(dir => ({ dir, size: 0 }));
@@ -36,28 +65,34 @@ export const printConfigurationHints = ({ counters, issues, tagHints, configurat
         }
         const hlWorkspaces = workspaces.sort((a, b) => b.size - a.size).filter(ws => ws.size > 1);
         for (const { dir, size } of hlWorkspaces) {
-            const identifier = toRelative(dir) || '.';
+            const identifier = toRelative(dir, cwd) || '.';
             configurationHints.add({ type: 'workspace-unconfigured', workspaceName: identifier, identifier, size });
         }
     }
     if (configurationHints.size > 0) {
-        const isTopLevel = (type) => type.includes('top-level');
-        const hintOrderer = (a, b) => isTopLevel(a.type) && !isTopLevel(b.type) ? -1 : !isTopLevel(a.type) && isTopLevel(b.type) ? 1 : 0;
         const getTitle = isTreatConfigHintsAsErrors ? getColoredTitle : getDimmedTitle;
-        const style = isTreatConfigHintsAsErrors ? plain : dim;
         console.log(getTitle('Configuration hints', configurationHints.size));
-        const isRootOnly = includedWorkspaces.length === 1 && includedWorkspaces[0].name === '.';
-        for (const hint of Array.from(configurationHints).sort(hintOrderer)) {
-            const hintPrinter = hintPrinters.get(hint.type);
-            if (hintPrinter)
-                console.warn(style(hintPrinter.print({ ...hint, isRootOnly })));
+        const hintsByType = new Map();
+        for (const hint of configurationHints) {
+            const hints = hintsByType.get(hint.type) ?? [];
+            hintsByType.set(hint.type, [...hints, hint]);
         }
+        const rows = hintTypesOrder.flatMap(hintTypes => hintTypes.flatMap(hintType => {
+            const hints = hintsByType.get(hintType) ?? [];
+            return hints.map(hint => {
+                hint.filePath = relative(cwd, hint.filePath ?? configFilePath ?? '');
+                const hintPrinter = hintPrinters.get(hint.type);
+                const message = hintPrinter ? hintPrinter.print({ ...hint, configFilePath }) : '';
+                return { ...hint, message };
+            });
+        }));
+        console.warn(getTableForHints(rows).toString());
     }
     if (tagHints.size > 0) {
         console.log(getColoredTitle('Tag issues', tagHints.size));
         for (const hint of tagHints) {
             const { filePath, identifier, tagName } = hint;
-            const message = `Unused tag in ${toRelative(filePath)}:`;
+            const message = `Unused tag in ${toRelative(filePath, cwd)}:`;
             console.warn(dim(message), `${identifier} → ${tagName}`);
         }
     }

package/dist/reporters/util/util.d.ts

@@ -1,10 +1,8 @@
 import { ISSUE_TYPE_TITLE } from '../../constants.js';
 import { type Issue, type IssueSeverity, type IssueSymbol } from '../../types/issues.js';
 import { Table } from '../../util/table.js';
-export declare const plain: (text: string) => string;
 export declare const dim: import("picocolors/types.js").Formatter;
 export declare const bright: import("picocolors/types.js").Formatter;
-export declare const yellow: import("picocolors/types.js").Formatter;
 export declare const getIssueTypeTitle: (reportType: keyof typeof ISSUE_TYPE_TITLE) => string;
 export declare const getColoredTitle: (title: string, count: number) => string;
 export declare const getDimmedTitle: (title: string, count: number) => string;
@@ -15,14 +13,14 @@ type LogIssueLine = {
     parentSymbol?: string;
     severity?: IssueSeverity;
 };
-export declare const getIssueLine: ({ owner, filePath, symbols, parentSymbol, severity }: LogIssueLine) => string;
+export declare const getIssueLine: ({ owner, filePath, symbols, parentSymbol, severity }: LogIssueLine, cwd: string) => string;
 export declare const convert: (issue: Issue | IssueSymbol) => {
     name: string;
     line: number | undefined;
     col: number | undefined;
     pos: number | undefined;
 };
-export declare const getTableForType: (issues: Issue[], options?: {
+export declare const getTableForType: (issues: Issue[], cwd: string, options?: {
     isUseColors?: boolean;
 }) => Table;
 export {};

package/dist/reporters/util/util.js

@@ -3,18 +3,18 @@ import { ISSUE_TYPE_TITLE } from '../../constants.js';
 import { SymbolType } from '../../types/issues.js';
 import { relative } from '../../util/path.js';
 import { Table } from '../../util/table.js';
-export const plain = (text) => text;
+const plain = (text) => text;
 export const dim = picocolors.gray;
 export const bright = picocolors.whiteBright;
-export const yellow = picocolors.yellow;
+const yellow = picocolors.yellow;
 export const getIssueTypeTitle = (reportType) => ISSUE_TYPE_TITLE[reportType];
 export const getColoredTitle = (title, count) => `${picocolors.yellowBright(picocolors.underline(title))} (${count})`;
 export const getDimmedTitle = (title, count) => `${yellow(`${picocolors.underline(title)} (${count})`)}`;
-export const getIssueLine = ({ owner, filePath, symbols, parentSymbol, severity }) => {
+export const getIssueLine = ({ owner, filePath, symbols, parentSymbol, severity }, cwd) => {
     const symbol = symbols ? `: ${symbols.map(s => s.symbol).join(', ')}` : '';
     const parent = parentSymbol ? ` (${parentSymbol})` : '';
     const print = severity === 'warn' ? dim : plain;
-    return `${owner ? `${picocolors.cyan(owner)} ` : ''}${print(`${relative(filePath)}${symbol}${parent}`)}`;
+    return `${owner ? `${picocolors.cyan(owner)} ` : ''}${print(`${relative(cwd, filePath)}${symbol}${parent}`)}`;
 };
 export const convert = (issue) => ({
     name: issue.symbol,
@@ -39,7 +39,7 @@ const highlightSymbol = (issue) => (_) => {
     }
     return issue.symbol;
 };
-export const getTableForType = (issues, options = { isUseColors: true }) => {
+export const getTableForType = (issues, cwd, options = { isUseColors: true }) => {
     const table = new Table({ truncateStart: ['filePath'], noTruncate: ['symbolType'] });
     for (const issue of issues.sort(sortByPos)) {
         table.row();
@@ -49,7 +49,7 @@ export const getTableForType = (issues, options = { isUseColors: true }) => {
         table.cell('parentSymbol', issue.parentSymbol && print(issue.parentSymbol));
         table.cell('symbolType', issue.symbolType && issue.symbolType !== SymbolType.UNKNOWN && print(issue.symbolType));
         const pos = issue.line === undefined ? '' : `:${issue.line}${issue.col === undefined ? '' : `:${issue.col}`}`;
-        const cell = issue.type === 'files' ? '' : `${relative(issue.filePath)}${pos}`;
+        const cell = issue.type === 'files' ? '' : `${relative(cwd, issue.filePath)}${pos}`;
         table.cell('filePath', print(cell));
         table.cell('fixed', issue.isFixed && print('(removed)'));
     }

package/dist/reporters/watch.d.ts

@@ -1,12 +1,11 @@
 import type { ConsoleStreamer } from '../ConsoleStreamer.js';
-import type { Issues, Report } from '../types/issues.js';
+import type { Issues } from '../types/issues.js';
+import type { MainOptions } from '../util/create-options.js';
 interface WatchReporter {
-    report: Report;
     issues: Issues;
     streamer: ConsoleStreamer;
     startTime?: number;
     size: number;
-    isDebug: boolean;
 }
-declare const _default: ({ report, issues, streamer, startTime, size, isDebug }: WatchReporter) => void;
+declare const _default: (options: MainOptions, { issues, streamer, startTime, size }: WatchReporter) => void;
 export default _default;

package/dist/reporters/watch.js

@@ -2,11 +2,11 @@ import picocolors from 'picocolors';
 import { perfObserver } from '../util/Performance.js';
 import { prettyMilliseconds } from '../util/string.js';
 import { getIssueTypeTitle, getTableForType } from './util/util.js';
-export default ({ report, issues, streamer, startTime, size, isDebug }) => {
-    const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
+export default (options, { issues, streamer, startTime, size }) => {
+    const reportMultipleGroups = Object.values(options.includedIssueTypes).filter(Boolean).length > 1;
     let totalIssues = 0;
     const lines = [];
-    for (let [reportType, isReportType] of Object.entries(report)) {
+    for (let [reportType, isReportType] of Object.entries(options.includedIssueTypes)) {
         if (reportType === 'files')
             reportType = '_files';
         if (isReportType) {
@@ -16,7 +16,7 @@ export default ({ report, issues, streamer, startTime, size, isDebug }) => {
                 if (title) {
                     lines.push(`${picocolors.yellowBright(picocolors.underline(title))} (${issuesForType.length})`);
                 }
-                lines.push(...getTableForType(issuesForType).toRows());
+                lines.push(...getTableForType(issuesForType, options.cwd).toRows());
             }
             totalIssues = totalIssues + issuesForType.length;
         }
@@ -27,7 +27,7 @@ export default ({ report, issues, streamer, startTime, size, isDebug }) => {
     const messages = totalIssues === 0
         ? ['✂️  Excellent, Knip found no issues.', '', picocolors.gray(summary)]
         : [...lines, '', picocolors.gray(summary)];
-    if (isDebug)
+    if (options.isDebug)
         console.log(messages.join('\n'));
     else
         streamer.cast(messages);