feat: implement list view

src/cli/action/list.ts

@@ -0,0 +1,66 @@
+import { table } from "table";
+
+import type { TodoModuleLike } from "../../todofile/types";
+import type { TodoModuleV2 } from "../../todofile/v2";
+
+import { TodoModuleV2Handler } from "../../todofile/v2";
+import { defineAction } from "./index";
+
+export const listAction = defineAction(async ({ core, logger }) => {
+  const todoModule = getTodoModuleV2(await core.readTodoModule());
+
+  if (todoModule === false) {
+    throw new Error("Unsupported todo file version");
+  }
+
+  const todoTable = generateTodoTable(todoModule);
+
+  if (todoTable.length === 0) {
+    logger.success("No rules found in the todo file! Good job!");
+    return;
+  }
+
+  const tableData = [
+    ["Rule", "Files", "Violations", "AutoFixable"],
+    ...todoTable,
+  ];
+
+  logger.log.raw(table(tableData));
+
+  return;
+});
+
+const getTodoModuleV2 = (module: TodoModuleLike): false | TodoModuleV2 => {
+  if (TodoModuleV2Handler.isVersion(module)) {
+    return module;
+  }
+
+  return false;
+};
+
+type TableFormat = [
+  ruleId: string,
+  violatedFiles: number,
+  totalViolations: number,
+  autoFixableEmoji: string,
+];
+
+const generateTodoTable = (todoModule: TodoModuleV2): TableFormat[] => {
+  const tableData: TableFormat[] = [];
+
+  for (const [ruleId, { autoFix, violations }] of Object.entries(
+    todoModule.todo,
+  )) {
+    const violatedFiles = Object.keys(violations).length;
+    const totalViolations = Object.values(violations).reduce(
+      (sum, count) => sum + count,
+      0,
+    );
+
+    const autoFixEmoji = autoFix ? "✓" : "";
+
+    tableData.push([ruleId, violatedFiles, totalViolations, autoFixEmoji]);
+  }
+
+  return tableData;
+};

src/cli/index.ts

@@ -9,6 +9,7 @@ import { ESLintTodoCore } from "../index";
 import { runAction } from "./action";
 import { deleteRuleAction } from "./action/delete-rule";
 import { genAction } from "./action/gen";
+import { listAction } from "./action/list";
 import { selectRulesToFixAction } from "./action/select-rule";
 import { updateAction } from "./action/update";
 import { resolveCLIContext } from "./context";
@@ -135,6 +136,11 @@ const cli = defineCommand({
 
     await runAction(updateAction, { consola, options });
 
+    if (context.mode === "list") {
+      await runAction(listAction, { consola, options });
+      return;
+    }
+
     if (context.mode === "generate") {
       await runAction(genAction, { consola, options });
       consola.success(`ESLint todo file generated at ${context.todoFilePath}!`);