knip 6.24.0 → 6.26.0

package/dist/plugins/zx/visitors/zx.js

@@ -1,13 +1,13 @@
+import { getScriptFromTemplate } from '../../../typescript/ast-nodes.js';
 export function createZxVisitor(ctx) {
     return {
         TaggedTemplateExpression(node) {
             if (!ctx.sourceText.startsWith('#!/usr/bin/env zx'))
                 return;
             if (node.tag.type === 'Identifier' && node.tag.name === '$') {
-                for (const q of node.quasi.quasis) {
-                    if (q.value.raw)
-                        ctx.addScript(q.value.raw);
-                }
+                const script = getScriptFromTemplate(node.quasi);
+                if (script)
+                    ctx.addScript(script);
             }
         },
     };

package/dist/reporters/cycles.d.ts

@@ -0,0 +1,3 @@
+import type { ReporterOptions } from '../types/issues.ts';
+export default _default;
+declare function _default({ cwd, issues, isShowProgress }: ReporterOptions): void;

package/dist/reporters/cycles.js

@@ -0,0 +1,79 @@
+import st from '../util/colors.js';
+import { relative } from '../util/path.js';
+import { flattenIssues, getColoredTitle, getIssueTypeTitle } from './util/util.js';
+const kindLabels = {
+    import: 'import',
+    importAs: 'aliased import',
+    importNS: 'namespace import',
+    reExport: 're-export',
+    reExportAs: 'aliased re-export',
+    reExportNS: 'namespace re-export',
+    reExportStar: 'star re-export',
+    dynamicImport: 'dynamic import',
+    sideEffectImport: 'side-effect import',
+};
+const formatEdge = (edge) => {
+    const kind = kindLabels[edge.kind ?? 'import'] ?? edge.kind ?? 'import';
+    const specifier = edge.specifier ? `${st.dim(' ')}${st.cyanBright(edge.specifier)}` : '';
+    return `${st.cyan(kind)}${specifier}${st.dim(' → ')}`;
+};
+const getLocation = (file) => {
+    const location = file.line === undefined ? '' : `:${file.line}${file.col === undefined ? '' : `:${file.col}`}`;
+    return `${file.symbol}${location}`;
+};
+const formatFile = (file) => st.white(getLocation(file));
+const getIssueRootLocation = (issue, cwd) => {
+    const root = issue.symbols?.[0];
+    return root ? getLocation(root) : relative(cwd, issue.filePath);
+};
+const sortByFilePath = (cwd) => (a, b) => {
+    const aFilePath = relative(cwd, a.filePath);
+    const bFilePath = relative(cwd, b.filePath);
+    const filePath = aFilePath.localeCompare(bFilePath);
+    if (filePath !== 0)
+        return filePath;
+    const rootLocation = getIssueRootLocation(a, cwd).localeCompare(getIssueRootLocation(b, cwd));
+    return rootLocation === 0 ? a.symbol.localeCompare(b.symbol) : rootLocation;
+};
+export default ({ cwd, issues, isShowProgress }) => {
+    const cycles = flattenIssues(issues.cycles).sort(sortByFilePath(cwd));
+    if (cycles.length === 0) {
+        if (isShowProgress)
+            console.log('✂️  No circular dependencies found.');
+        return;
+    }
+    console.log(getColoredTitle(getIssueTypeTitle('cycles'), cycles.length));
+    const rootCounts = new Map();
+    for (const issue of cycles) {
+        const files = issue.symbols ?? issue.symbol.split(' → ').map(symbol => ({ symbol }));
+        const root = files[0];
+        if (root) {
+            const rootLocation = getLocation(root);
+            rootCounts.set(rootLocation, (rootCounts.get(rootLocation) ?? 0) + 1);
+        }
+    }
+    let previousRoot = '';
+    for (const issue of cycles) {
+        const files = issue.symbols ?? issue.symbol.split(' → ').map(symbol => ({ symbol }));
+        const root = files[0];
+        if (!root)
+            continue;
+        const rootLocation = getLocation(root);
+        if (rootLocation !== previousRoot) {
+            const count = rootCounts.get(rootLocation) ?? 0;
+            const countLabel = count > 1 ? st.dim(` (${count} cycles)`) : '';
+            console.log(`\n${formatFile(root)}${countLabel}`);
+            previousRoot = rootLocation;
+        }
+        else {
+            console.log('');
+        }
+        for (let depth = 1; depth <= files.length; depth++) {
+            const isClose = depth === files.length;
+            const edge = files[depth - 1];
+            const file = isClose ? root : files[depth];
+            const connector = st.dim(`${'    '.repeat(depth - 1)}└── `);
+            console.log(`${connector}${formatEdge(edge)}${formatFile(file)}${isClose ? st.dim(' ↩') : ''}`);
+        }
+    }
+};

package/dist/reporters/index.d.ts

@@ -2,6 +2,7 @@ declare const _default: {
     symbols: (options: import("../types.ts").ReporterOptions) => void;
     compact: ({ report, issues, isShowProgress, cwd }: import("../types.ts").ReporterOptions) => void;
     codeowners: ({ report, issues, isShowProgress, options, cwd }: import("../types.ts").ReporterOptions) => void;
+    cycles: ({ cwd, issues, isShowProgress }: import("../types.ts").ReporterOptions) => void;
     disclosure: ({ report, issues, cwd }: import("../types.ts").ReporterOptions) => void;
     codeclimate: ({ report, issues, cwd }: import("../types.ts").ReporterOptions) => Promise<void>;
     json: ({ report, issues, options, cwd }: import("../types.ts").ReporterOptions) => Promise<void>;

package/dist/reporters/index.js

@@ -1,6 +1,7 @@
 import codeclimate from './codeclimate.js';
 import codeowners from './codeowners.js';
 import compact from './compact.js';
+import cycles from './cycles.js';
 import disclosure from './disclosure.js';
 import githubActions from './github-actions.js';
 import json from './json.js';
@@ -10,6 +11,7 @@ export default {
     symbols,
     compact,
     codeowners,
+    cycles,
     disclosure,
     codeclimate,
     json,

package/dist/reporters/json.d.ts

@@ -4,6 +4,8 @@ export interface JSONReportNamedItem {
 }
 export interface JSONReportItem extends JSONReportNamedItem {
     namespace?: string;
+    kind?: string;
+    specifier?: string;
     pos?: number;
     line?: number;
     col?: number;
@@ -13,6 +15,7 @@ export type JSONReportEntry = {
     owners?: Array<JSONReportNamedItem>;
     binaries?: Array<JSONReportNamedItem>;
     catalog?: Array<JSONReportItem>;
+    cycles?: Array<Array<JSONReportItem>>;
     dependencies?: Array<JSONReportItem>;
     devDependencies?: Array<JSONReportItem>;
     duplicates?: Array<Array<JSONReportItem>>;

package/dist/reporters/json.js

@@ -20,6 +20,7 @@ export default async ({ report, issues, options, cwd }) => {
             ...(findOwners && { owners: findOwners(file).map(name => ({ name })) }),
             ...(report.binaries && { binaries: [] }),
             ...(report.catalog && { catalog: [] }),
+            ...(report.cycles && { cycles: [] }),
             ...(report.dependencies && { dependencies: [] }),
             ...(report.devDependencies && { devDependencies: [] }),
             ...(report.duplicates && { duplicates: [] }),
@@ -41,7 +42,7 @@ export default async ({ report, issues, options, cwd }) => {
             for (const issue of flattenIssues(issues[type])) {
                 const { filePath, symbol, symbols } = issue;
                 json[filePath] = json[filePath] ?? initRow(filePath);
-                if (type === 'duplicates') {
+                if (type === 'duplicates' || type === 'cycles') {
                     symbols && json[filePath][type]?.push(symbols.map(convert));
                 }
                 else if (type === 'binaries') {

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

@@ -3,7 +3,7 @@ import type { Issue, IssueRecords, IssueSeverity, IssueSymbol, IssueType } from
 import { Table } from '../../util/table.ts';
 export declare const dim: (text: string | number | null | undefined) => string;
 export declare const bright: (text: string | number | null | undefined) => string;
-export declare const getIssueTypeTitle: (reportType: keyof typeof ISSUE_TYPE_TITLE) => "Duplicate exports" | "Exported types in used namespace" | "Exports in used namespace" | "Referenced optional peerDependencies" | "Unlisted binaries" | "Unlisted dependencies" | "Unresolved imports" | "Unused catalog entries" | "Unused dependencies" | "Unused devDependencies" | "Unused exported enum members" | "Unused exported namespace members" | "Unused exported types" | "Unused exports" | "Unused files";
+export declare const getIssueTypeTitle: (reportType: keyof typeof ISSUE_TYPE_TITLE) => "Circular dependencies" | "Duplicate exports" | "Exported types in used namespace" | "Exports in used namespace" | "Referenced optional peerDependencies" | "Unlisted binaries" | "Unlisted dependencies" | "Unresolved imports" | "Unused catalog entries" | "Unused dependencies" | "Unused devDependencies" | "Unused exported enum members" | "Unused exported namespace members" | "Unused exported types" | "Unused exports" | "Unused files";
 export declare const getColoredTitle: (title: string, count: number) => string;
 export declare const getDimmedTitle: (title: string, count: number) => string;
 type LogIssueLine = {
@@ -17,6 +17,8 @@ export declare const getIssueLine: ({ owner, filePath, symbols, parentSymbol, se
 export declare const convert: (issue: Issue | IssueSymbol) => {
     namespace: string | undefined;
     name: string;
+    kind: string | undefined;
+    specifier: string | undefined;
     line: number | undefined;
     col: number | undefined;
     pos: number | undefined;

package/dist/reporters/util/util.js

@@ -17,6 +17,8 @@ export const getIssueLine = ({ owner, filePath, symbols, parentSymbol, severity
 export const convert = (issue) => ({
     namespace: 'parentSymbol' in issue ? issue.parentSymbol : undefined,
     name: issue.symbol,
+    kind: 'kind' in issue ? issue.kind : undefined,
+    specifier: 'kind' in issue ? issue.specifier : undefined,
     line: issue.line,
     col: issue.col,
     pos: issue.pos,
@@ -44,7 +46,9 @@ export const getTableForType = (issues, cwd, options = { isUseColors: true }) =>
         table.row();
         const print = options.isUseColors && (issue.isFixed || issue.severity === 'warn') ? dim : plain;
         const isFileIssue = issue.type === 'files';
-        const symbol = issue.symbols ? issue.symbols.map(s => s.symbol).join(', ') : issue.symbol;
+        const symbol = issue.symbols
+            ? issue.symbols.map(s => s.symbol).join(issue.type === 'cycles' ? ' → ' : ', ')
+            : issue.symbol;
         if (!isFileIssue)
             table.cell('symbol', print(symbol), options.isUseColors ? highlightSymbol(issue) : () => symbol);
         table.cell('parentSymbol', issue.parentSymbol && print(issue.parentSymbol));