Make _files issue type consistent with the other types

Author: webpro

packages/knip/src/IssueCollector.ts

@@ -62,8 +62,9 @@ export class IssueCollector {
       if (this.isMatch(filePath)) continue;
 
       this.issues.files.add(filePath);
+      const symbol = relative(filePath);
       // @ts-expect-error TODO Fix up in next major
-      this.issues._files.add({ type: 'files', filePath, symbol: relative(filePath), severity: this.rules.files });
+      this.issues._files[symbol] = [{ type: 'files', filePath, symbol, severity: this.rules.files }];
 
       this.counters.files++;
       this.counters.processed++;

packages/knip/src/IssueFixer.ts

@@ -68,7 +68,7 @@ export class IssueFixer {
   private async removeUnusedFiles(issues: Issues) {
     if (!this.isFixFiles) return;
 
-    for (const issue of issues._files) {
+    for (const issue of Object.values(issues._files).flatMap(Object.values)) {
       await rm(issue.filePath);
       issue.isFixed = true;
     }

packages/knip/src/reporters/compact.ts

@@ -21,7 +21,7 @@ export default ({ report, issues, isShowProgress }: ReporterOptions) => {
           ? Object.values(issues[reportType]).flatMap(Object.values)
           : Object.values(issues[reportType] as IssueRecords).map(issues => {
               const items = Object.values(issues);
-              return { ...items[0], symbols: items.map(issue => issue.symbol) };
+              return { ...items[0], symbols: items };
             });
 
       if (issuesForType.length > 0) {

packages/knip/src/reporters/disclosure.ts

@@ -1,7 +1,7 @@
 import EasyTable from 'easy-table';
 import type { Entries } from 'type-fest';
 import type { Issue, ReporterOptions } from '../types/issues.js';
-import { relative, toRelative } from '../util/path.js';
+import { relative } from '../util/path.js';
 import { getTitle } from './util.js';
 
 const printHeader = (size: number, title?: string) =>
@@ -16,7 +16,8 @@ const logIssueRecord = (issues: Issue[]) => {
     issue.parentSymbol && table.cell('parentSymbol', issue.parentSymbol);
     issue.symbolType && table.cell('symbolType', issue.symbolType);
     const pos = issue.line === undefined ? '' : `:${issue.line}${issue.col === undefined ? '' : `:${issue.col}`}`;
-    const cell = `${relative(issue.filePath)}${pos}`;
+    // @ts-expect-error TODO Fix up in next major
+    const cell = issue.type === 'files' ? '' : `${relative(issue.filePath)}${pos}`;
     table.cell('filePath', cell);
     table.newRow();
   }
@@ -27,29 +28,17 @@ export default ({ report, issues }: ReporterOptions) => {
   const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
   let totalIssues = 0;
 
-  for (const [reportType, isReportType] of Object.entries(report) as Entries<typeof report>) {
-    if (reportType === '_files') continue;
+  for (let [reportType, isReportType] of Object.entries(report) as Entries<typeof report>) {
+    if (reportType === 'files') reportType = '_files';
 
     if (isReportType) {
       const title = reportMultipleGroups ? getTitle(reportType) : undefined;
-
-      if (reportType === 'files') {
-        const issuesForType = Array.from(issues._files);
-        if (issuesForType.length > 0) {
-          printHeader(issuesForType.length, title);
-          const sortedIssues = issuesForType.sort((a, b) => a.filePath.localeCompare(b.filePath));
-          for (const issue of sortedIssues) console.log(toRelative(issue.filePath));
-          totalIssues = totalIssues + issuesForType.length;
-          printFooter();
-        }
-      } else {
-        const issuesForType = Object.values(issues[reportType]).flatMap(Object.values);
-        if (issuesForType.length > 0) {
-          printHeader(issuesForType.length, title);
-          logIssueRecord(issuesForType);
-          totalIssues = totalIssues + issuesForType.length;
-          printFooter();
-        }
+      const issuesForType = Object.values(issues[reportType]).flatMap(Object.values);
+      if (issuesForType.length > 0) {
+        printHeader(issuesForType.length, title);
+        logIssueRecord(issuesForType);
+        totalIssues = totalIssues + issuesForType.length;
+        printFooter();
       }
     }
   }

packages/knip/src/reporters/symbols.ts

@@ -52,33 +52,19 @@ export default ({ report, issues, tagHints, configurationHints, noConfigHints, i
   const reportMultipleGroups = Object.values(report).filter(Boolean).length > 1;
   let totalIssues = 0;
 
-  for (const [reportType, isReportType] of Object.entries(report) as Entries<typeof report>) {
-    if (reportType === '_files') continue;
+  for (let [reportType, isReportType] of Object.entries(report) as Entries<typeof report>) {
+    if (reportType === 'files') reportType = '_files';
 
     if (isReportType) {
       const title = reportMultipleGroups && getTitle(reportType);
 
-      if (reportType === 'files') {
-        const issuesForType = Array.from(issues._files);
-        if (issuesForType.length > 0) {
-          title && logTitle(title, issuesForType.length);
-          const sortedIssues = issuesForType.sort((a, b) => a.filePath.localeCompare(b.filePath));
-          for (const issue of sortedIssues) {
-            const relPath = toRelative(issue.filePath);
-            if (issue.isFixed) console.log(dim(`${relPath} (removed)`));
-            else if (issue.severity === 'warn') console.log(dim(relPath));
-            else console.log(relPath);
-          }
-          totalIssues = totalIssues + issuesForType.length;
-        }
-      } else {
-        const issuesForType = Object.values(issues[reportType]).flatMap(Object.values);
-        if (issuesForType.length > 0) {
-          title && logTitle(title, issuesForType.length);
-          logIssueRecord(issuesForType);
-          totalIssues = totalIssues + issuesForType.length;
-        }
+      const issuesForType = Object.values(issues[reportType]).flatMap(Object.values);
+      if (issuesForType.length > 0) {
+        title && logTitle(title, issuesForType.length);
+        logIssueRecord(issuesForType);
+        totalIssues = totalIssues + issuesForType.length;
       }
+      // }
     }
   }
 

packages/knip/src/types/issues.ts

@@ -32,7 +32,7 @@ export type IssueRecords = Record<string, Record<string, Issue>>;
 
 export type Issues = {
   files: IssueSet;
-  _files: Set<Issue>;
+  _files: IssueRecords;
   dependencies: IssueRecords;
   devDependencies: IssueRecords;
   optionalPeerDependencies: IssueRecords;
@@ -50,7 +50,7 @@ export type Issues = {
 
 export type IssueType = keyof Issues;
 
-export type SymbolIssueType = Exclude<IssueType, 'files' | '_files'>;
+export type SymbolIssueType = Exclude<IssueType, 'files'>;
 
 export type Report = {
   [key in keyof Issues]: boolean;

packages/knip/src/util/issue-initializers.ts

@@ -4,7 +4,7 @@ import type { Counters, Issue, IssueType, Issues, Rules } from '../types/issues.
 export const initIssues = (): Issues => ({
   ...(Object.fromEntries(ISSUE_TYPES.map(issueType => [issueType, {}])) as Record<IssueType, never>),
   files: new Set<string>(),
-  _files: new Set<Issue>(),
+  _files: {} as Record<string, Record<string, Issue>>,
 });
 
 export const initCounters = (): Counters => ({