feat(feature): 支持仅lint暂存区文件

Author: OSpoon

scripts/lint-script.ts

@@ -0,0 +1,13 @@
+import { eslintFix } from "./../src/command/eslint-fix";
+import { loggerWarring } from "../src/shared";
+import { esLintOptions } from "../src/shared/config";
+
+async function lint() {
+  try {
+    await Promise.all([eslintFix(process.cwd(), esLintOptions)]);
+  } catch (error) {
+    loggerWarring(error);
+  }
+}
+
+lint();

src/command/eslint-fix.ts

@@ -2,6 +2,7 @@ import { ESLint } from "eslint";
 import path from "node:path";
 
 import {
+  execCommand,
   loading,
   loggerError,
   loggerInfo,
@@ -15,11 +16,12 @@ export const eslintFix = async (
   options: EsLintOptions
 ) => {
   try {
-    const { eslintrc, paths } = options;
+    const { eslintrc, staged, paths } = options;
 
     if (ACTIVATION) {
       loggerInfo("eslintFix 参数信息: \n");
       console.table(cwd);
+      console.table(staged);
       console.table(options);
     }
 
@@ -30,7 +32,17 @@ export const eslintFix = async (
       overrideConfigFile: path.join(cwd, eslintrc),
     });
 
-    const files = paths.map((path) => `${cwd}/${path}`);
+    let files: string[] = [];
+    if (staged) {
+      const result = await execCommand("git", [
+        "diff",
+        "--name-only",
+        "--cached",
+      ]);
+      files = result?.split("\n").map((path) => `${cwd}/${path}`) || [];
+    } else {
+      files = paths.map((path) => `${cwd}/${path}`);
+    }
 
     const resultText = await loading(async () => {
       const results = await eslint.lintFiles(files);

src/setup.ts

@@ -1,7 +1,13 @@
 import { eslintFix } from "./command/eslint-fix";
 import type { CAC } from "cac";
 
-import { cleanUpDirs, cwd, esLintOptions, gitCommitScopes, gitCommitTypes } from "./shared/config";
+import {
+  cleanUpDirs,
+  cwd,
+  esLintOptions,
+  gitCommitScopes,
+  gitCommitTypes,
+} from "./shared/config";
 import { SetupSet } from "./shared/types";
 
 import { gitCommitVerify } from "./command/git-commit-verify";
@@ -62,16 +68,19 @@ export const setupSet: SetupSet = {
   },
   eslintFix: (cli: CAC) => {
     cli
-      .command("lint", "Inspected the code and try to fix it.")
+      .command("lint", "Inspecte the code and try to fix it.")
       .option("--eslintrc <file>", "eslintrc file", {
         default: esLintOptions.eslintrc,
       })
-      .option("--path <path>", "inspected path", {
+      .option("--path <path>", "Inspecte path", {
         default: esLintOptions.paths,
       })
+      .option("--staged", "Inspecte staged files", {
+        default: false,
+      })
       .action(async (options) => {
-        const { eslintrc, path } = options;
-        await eslintFix(cwd, { eslintrc, paths: path });
+        const { eslintrc, staged, path } = options;
+        await eslintFix(cwd, { eslintrc, staged, paths: path });
       });
   },
 };

src/shared/config.ts

@@ -97,4 +97,5 @@ export const ACTIVATION = process.env.CG_DEBUG === "activation";
 export const esLintOptions: EsLintOptions = {
   eslintrc: ".eslintrc.json",
   paths: ["src"],
+  staged: true,
 };

src/shared/types.ts

@@ -18,4 +18,5 @@ export interface CommitScope {
 export interface EsLintOptions {
   eslintrc: string;
   paths: string[];
-}
+  staged: boolean;
+}