knip 5.63.0 → 5.64.0

package/dist/reporters/compact.js

@@ -1,15 +1,15 @@
 import { toRelative } from '../util/path.js';
 import { getColoredTitle, getIssueLine, getIssueTypeTitle } from './util/util.js';
-const logIssueSet = (issues) => {
+const logIssueSet = (issues, cwd) => {
     for (const filePath of issues.sort())
-        console.log(toRelative(filePath));
+        console.log(toRelative(filePath, cwd));
 };
-const logIssueRecord = (issues) => {
+const logIssueRecord = (issues, cwd) => {
     const sortedByFilePath = issues.sort((a, b) => (a.filePath > b.filePath ? 1 : -1));
     for (const issue of sortedByFilePath)
-        console.log(getIssueLine(issue));
+        console.log(getIssueLine(issue, cwd));
 };
-export default ({ report, issues, isShowProgress }) => {
+export default ({ report, issues, isShowProgress, cwd }) => {
     const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
     let totalIssues = 0;
     for (const [reportType, isReportType] of Object.entries(report)) {
@@ -27,10 +27,10 @@ export default ({ report, issues, isShowProgress }) => {
             if (issuesForType.length > 0) {
                 title && console.log(getColoredTitle(title, issuesForType.length));
                 if (isSet) {
-                    logIssueSet(Array.from(issues[reportType]));
+                    logIssueSet(Array.from(issues[reportType]), cwd);
                 }
                 else {
-                    logIssueRecord(issuesForType);
+                    logIssueRecord(issuesForType, cwd);
                 }
             }
             totalIssues = totalIssues + issuesForType.length;

package/dist/reporters/disclosure.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/disclosure.js

@@ -1,5 +1,5 @@
 import { getIssueTypeTitle, getTableForType } from './util/util.js';
-export default ({ report, issues }) => {
+export default ({ report, issues, cwd }) => {
     const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
     for (let [reportType, isReportType] of Object.entries(report)) {
         if (reportType === 'files')
@@ -9,7 +9,7 @@ export default ({ report, issues }) => {
             const issuesForType = Object.values(issues[reportType]).flatMap(Object.values);
             if (issuesForType.length > 0) {
                 console.log(`<details>\n${title ? `<summary>${title} (${issuesForType.length})</summary>\n` : ''}\n\`\`\``);
-                console.log(getTableForType(issuesForType, { isUseColors: false }).toString());
+                console.log(getTableForType(issuesForType, cwd, { isUseColors: false }).toString());
                 console.log('```\n\n</details>\n');
             }
         }

package/dist/reporters/githubActions.d.ts

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

package/dist/reporters/githubActions.js

@@ -0,0 +1,94 @@
+import { ISSUE_TYPE_TITLE } from '../constants.js';
+import { relative } from '../util/path.js';
+import { hintPrinters } from './util/configuration-hints.js';
+import { getIssueTypeTitle } from './util/util.js';
+const createGitHubActionsLogger = () => {
+    const formatAnnotation = (level, message, options) => {
+        const params = [`file=${options.file}`];
+        if (options.startLine != null)
+            params.push(`line=${options.startLine}`);
+        if (options.endLine != null)
+            params.push(`endLine=${options.endLine}`);
+        if (options.startColumn != null)
+            params.push(`col=${options.startColumn}`);
+        if (options.endColumn != null)
+            params.push(`endColumn=${options.endColumn}`);
+        params.push(`title=✂️ Knip${options.title ? ` / ${options.title}` : ''}`);
+        const paramString = params.join(',');
+        console.log(`::${level} ${paramString}::${message}`);
+    };
+    return {
+        info: (message) => console.log(message),
+        error: (message, options) => formatAnnotation('error', message, options),
+        warning: (message, options) => formatAnnotation('warning', message, options),
+        notice: (message, options) => formatAnnotation('notice', message, options),
+    };
+};
+export default ({ report, issues, cwd, configurationHints, isDisableConfigHints, isTreatConfigHintsAsErrors, configFilePath, }) => {
+    const core = createGitHubActionsLogger();
+    const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
+    for (let [reportType, isReportType] of Object.entries(report)) {
+        if (reportType === 'files')
+            reportType = '_files';
+        if (isReportType) {
+            const title = reportMultipleGroups && getIssueTypeTitle(reportType);
+            const issuesForType = Object.values(issues[reportType]).flatMap(Object.values);
+            if (issuesForType.length > 0) {
+                title && core.info(`${title} (${issuesForType.length})`);
+                for (const issue of issuesForType) {
+                    if (issue.isFixed || issue.severity === 'off')
+                        continue;
+                    const log = issue.severity === 'error' ? core.error : core.warning;
+                    const filePath = relative(cwd, issue.filePath);
+                    const message = reportType === '_files' ? issue.symbol : `${issue.symbol} in ${filePath}`;
+                    log(message, {
+                        file: filePath,
+                        startLine: issue.line ?? 1,
+                        endLine: issue.line ?? 1,
+                        startColumn: issue.col ?? 1,
+                        endColumn: issue.col ?? 1,
+                        title: ISSUE_TYPE_TITLE[issue.type],
+                    });
+                }
+            }
+        }
+    }
+    if (!isDisableConfigHints && configurationHints.size > 0) {
+        const CONFIG_HINTS_TITLE = 'Configuration hints';
+        core.info(`${CONFIG_HINTS_TITLE} (${configurationHints.size})`);
+        for (const hint of configurationHints) {
+            const hintPrinter = hintPrinters.get(hint.type);
+            const message = hintPrinter?.print({
+                ...hint,
+                filePath: hint.filePath ?? configFilePath ?? '',
+                configFilePath,
+            }) ?? '';
+            const file = hint.filePath
+                ? relative(cwd, hint.filePath)
+                : configFilePath
+                    ? relative(cwd, configFilePath)
+                    : 'knip.json';
+            const hintMessage = `${message}: ${hint.identifier} in ${file}`;
+            if (isTreatConfigHintsAsErrors) {
+                core.error(hintMessage, {
+                    file,
+                    startLine: 1,
+                    endLine: 1,
+                    startColumn: 1,
+                    endColumn: 1,
+                    title: CONFIG_HINTS_TITLE,
+                });
+            }
+            else {
+                core.notice(hintMessage, {
+                    file,
+                    startLine: 1,
+                    endLine: 1,
+                    startColumn: 1,
+                    endColumn: 1,
+                    title: CONFIG_HINTS_TITLE,
+                });
+            }
+        }
+    }
+};

package/dist/reporters/index.d.ts

@@ -1,10 +1,11 @@
 declare const _default: {
     symbols: (options: import("../index.js").ReporterOptions) => void;
-    compact: ({ report, issues, isShowProgress }: import("../index.js").ReporterOptions) => void;
-    codeowners: ({ report, issues, isShowProgress, options }: import("../index.js").ReporterOptions) => void;
-    disclosure: ({ report, issues }: import("../index.js").ReporterOptions) => void;
-    codeclimate: ({ report, issues }: import("../index.js").ReporterOptions) => Promise<void>;
-    json: ({ report, issues, options }: import("../index.js").ReporterOptions) => Promise<void>;
-    markdown: ({ report, issues }: import("../index.js").ReporterOptions) => void;
+    compact: ({ report, issues, isShowProgress, cwd }: import("../index.js").ReporterOptions) => void;
+    codeowners: ({ report, issues, isShowProgress, options, cwd }: import("../index.js").ReporterOptions) => void;
+    disclosure: ({ report, issues, cwd }: import("../index.js").ReporterOptions) => void;
+    codeclimate: ({ report, issues, cwd }: import("../index.js").ReporterOptions) => Promise<void>;
+    json: ({ report, issues, options, cwd }: import("../index.js").ReporterOptions) => Promise<void>;
+    markdown: ({ report, issues, cwd }: import("../index.js").ReporterOptions) => void;
+    'github-actions': ({ report, issues, cwd, configurationHints, isDisableConfigHints, isTreatConfigHintsAsErrors, configFilePath, }: import("../index.js").ReporterOptions) => void;
 };
 export default _default;

package/dist/reporters/index.js

@@ -2,6 +2,7 @@ import codeclimate from './codeclimate.js';
 import codeowners from './codeowners.js';
 import compact from './compact.js';
 import disclosure from './disclosure.js';
+import githubActions from './githubActions.js';
 import json from './json.js';
 import markdown from './markdown.js';
 import symbols from './symbols.js';
@@ -13,4 +14,5 @@ export default {
     codeclimate,
     json,
     markdown,
+    'github-actions': githubActions,
 };

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 })) }),
@@ -54,7 +54,7 @@ export default async ({ report, issues, options }) => {
                         }
                     }
                     else {
-                        if (['unlisted', 'binaries'].includes(type)) {
+                        if (type === 'binaries') {
                             json[filePath][type]?.push({ name: symbol });
                         }
                         else {
@@ -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;
             }
         }

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

@@ -1,2 +1,14 @@
-import type { ReporterOptions } from '../../types/issues.js';
-export declare const printConfigurationHints: ({ counters, issues, tagHints, configurationHints, isTreatConfigHintsAsErrors, includedWorkspaces, configFilePath, }: ReporterOptions) => void;
+import type { ConfigurationHintType, ReporterOptions } from '../../types/issues.js';
+interface PrintHintOptions {
+    type: ConfigurationHintType;
+    identifier: string | RegExp;
+    filePath: string;
+    configFilePath?: string;
+    workspaceName?: string;
+    size?: number;
+}
+declare const hintPrinters: Map<ConfigurationHintType, {
+    print: (options: PrintHintOptions) => string;
+}>;
+export { hintPrinters };
+export declare const printConfigurationHints: ({ cwd, counters, issues, tagHints, configurationHints, isTreatConfigHintsAsErrors, includedWorkspaceDirs, configFilePath, }: ReporterOptions) => void;

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

@@ -14,7 +14,7 @@ const getTableForHints = (hints) => {
         table.row();
         table.cell('identifier', hint.identifier.toString());
         table.cell('workspace', getWorkspaceName(hint));
-        table.cell('filePath', hint.filePath ? relative(hint.filePath) : '');
+        table.cell('filePath', hint.filePath);
         table.cell('description', dim(hint.message));
     }
     return table;
@@ -42,6 +42,7 @@ const hintPrinters = new Map([
     ['project-top-level', { print: topLevel }],
     ['package-entry', { print: packageEntry }],
 ]);
+export { hintPrinters };
 const hintTypesOrder = [
     ['workspace-unconfigured'],
     ['entry-top-level', 'project-top-level'],
@@ -52,10 +53,9 @@ const hintTypesOrder = [
     ['entry-empty', 'project-empty', 'entry-redundant', 'project-redundant'],
     ['package-entry'],
 ];
-export const printConfigurationHints = ({ counters, issues, tagHints, configurationHints, isTreatConfigHintsAsErrors, includedWorkspaces, configFilePath, }) => {
+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 }));
@@ -66,7 +66,7 @@ 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 });
         }
     }
@@ -81,7 +81,7 @@ export const printConfigurationHints = ({ counters, issues, tagHints, configurat
         const rows = hintTypesOrder.flatMap(hintTypes => hintTypes.flatMap(hintType => {
             const hints = hintsByType.get(hintType) ?? [];
             return hints.map(hint => {
-                hint.filePath ??= configFilePath;
+                hint.filePath = relative(cwd, hint.filePath ?? configFilePath ?? '');
                 const hintPrinter = hintPrinters.get(hint.type);
                 const message = hintPrinter ? hintPrinter.print({ ...hint, configFilePath }) : '';
                 return { ...hint, message };
@@ -93,7 +93,7 @@ export const printConfigurationHints = ({ counters, issues, tagHints, configurat
         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

@@ -13,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

@@ -10,11 +10,11 @@ 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);