knip 5.63.1 → 5.64.1

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

@@ -6,5 +6,6 @@ declare const _default: {
     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.js

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

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

@@ -1,2 +1,14 @@
-import type { ReporterOptions } from '../../types/issues.js';
+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

@@ -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'],