feat: add report useless modules workflow

Author: tosaken1116

generator.ts

@@ -15,7 +15,8 @@ export type Workflows =
     | "code-diff"
     | "bundle-size"
     | "install-dependencies"
-    | "build";
+    | "build"
+    | "useless-modules";
 export type GenerateConfigType = {
     projectRoot: string;
     type: "js" | "ts";

helper/addWorkflow.ts

@@ -9,6 +9,7 @@ import {
     LIGHT_HOUSE,
     LINT,
     TEST,
+    USELESS_MODULES,
     WORKFLOW_BASE,
 } from "./workflow";
 import { mkdirSync, readFileSync, writeFileSync } from "fs";
@@ -22,6 +23,7 @@ const dependWorkflows: Record<Workflows, Workflows[]> = {
     "bundle-size": ["build"],
     "install-dependencies": [],
     build: ["install-dependencies"],
+    "useless-modules": ["install-dependencies"],
 };
 const workflowFile: Record<Workflows, { main: string; actions: Actions[] }> = {
     lighthouse: {
@@ -52,6 +54,10 @@ const workflowFile: Record<Workflows, { main: string; actions: Actions[] }> = {
         main: BUILD,
         actions: ["cache-build"],
     },
+    "useless-modules": {
+        main: USELESS_MODULES,
+        actions: ["pull-request-comment"],
+    },
 };
 export const addWorkflow = ({
     projectRoot,

helper/workflow.ts

@@ -209,3 +209,35 @@ export const CODE_DIFF = `  report-diff:
               includes-comment: "<!-- __DIFF -->"
               comment-body: \${{steps.diff-comment.outputs.body}}
 `;
+
+export const USELESS_MODULES = `  report-useless-modules:
+      needs: install-dependencies
+      if: github.event_name == 'pull_request'
+      runs-on: ubuntu-latest
+      steps:
+        - uses: actions/checkout@v2
+        - name: Use Cached Dependencies
+          uses: actions/cache@v4
+          with:
+            path: '**/node_modules'
+            key: \${{ runner.os }}-npm-\${{ hashFiles('**/package-lock.json') }}
+        - name: Analyze modules
+          id: useless-modules
+          run: |
+            echo "result=$(npx depcheck . --skip-missing --json)" >> $GITHUB_OUTPUT
+        - name: Create Useless Modules Comment
+          id: useless-modules-comment
+          uses: actions/github-script@v3
+          with:
+            github-token: \${{secrets.GITHUB_TOKEN}}
+            script: |
+              const json = \${{steps.useless-modules.outputs.result}};
+              const isUselessModuleEmpty = json.dependencies.length === 0;
+              const uselessModulesComment = isUselessModuleEmpty ? 'useless modules not found✨' : \`> [!CAUTION]\\n> The following modules are not used in the code. Please remove them.\\n> \${json.dependencies.map((module) => \`- \${module}\`).join('\\n> ')}\`;
+              core.setOutput("body", uselessModulesComment)
+        - name: report useless modules
+          uses: ./.github/actions/pull-request-comment
+          with:
+            includes-comment: '<!-- __USELESS_MODULES -->'
+            comment-body: \${{steps.useless-modules-comment.outputs.body}}
+`;

index.ts

@@ -472,6 +472,7 @@ async function main() {
                 { title: "lint", value: "lint" },
                 { title: "test", value: "test" },
                 { title: "Check Bundle Size", value: "bundle-size" },
+                { title: "Report Useless Modules", value: "useless-modules" },
             ],
         });
         options.workflows = workflows;