feat(feature): 添加prettier命令

OSpoon · OSpoon · commit 61a467ffca86 · 2023-09-17T19:23:36.000+08:00
diff --git a/README.md b/README.md
@@ -18,14 +18,15 @@ npm i -g code-genius
 
 ## 终端命令
 
-| 命令   | 参数                                           | 功能描述                                       |
-| ------ | ---------------------------------------------- | ---------------------------------------------- |
-| cm     | --noEmoji                                      | 帮助生成规范的 git 提交内容                    |
-| cmv    | --                                             | 帮助验证 git commit 的内容是否符合规范         |
-| cup    | --ignore \<path\>                              | 清理运行时生成的文件                           |
-| ihooks | --                                             | 使用且有修改 simple-git-hooks 后需要重新初始化 |
-| run    | --                                             | 运行列出的脚本                                 |
-| lint   | --eslintrc \<file\>, --path \<path\>, --staged, --suffix \<suffix\> | 检查代码并尝试修复                             |
+| 命令     | 参数                                                                | 功能描述                                       |
+| -------- | ------------------------------------------------------------------- | ---------------------------------------------- |
+| cm       | --noEmoji                                                           | 帮助生成规范的 git 提交内容                    |
+| cmv      | --                                                                  | 帮助验证 git commit 的内容是否符合规范         |
+| cup      | --ignore \<path\>                                                   | 清理运行时生成的文件                           |
+| ihooks   | --                                                                  | 使用且有修改 simple-git-hooks 后需要重新初始化 |
+| run      | --                                                                  | 运行列出的脚本                                 |
+| lint     | --eslintrc \<file\>, --path \<path\>, --staged, --suffix \<suffix\> | 检查代码并尝试修复                             |
+| prettier | --path \<path\>, --staged, --suffix \<suffix\>                      | 格式化代码高风格                               |
 
 ## API
 
@@ -37,6 +38,7 @@ npm i -g code-genius
 | 4    | `gitInitSimpleHooks(cwd)`           | `cwd?: string`                                                                         | `Promise<void>` |
 | 5    | `npmRun(cwd)`                       | `cwd?: string`                                                                         | `Promise<void>` |
 | 6    | `eslintFix(cwd, options)`           | `cwd?: string`,` options:(EsLintOptions)`                                              | `Promise<void>` |
+| 7    | `prettierFormat(cwd, options)`           | `cwd?: string`,` options:(PrettierFormatOptions)`                                              | `Promise<void>` |
 
 ## API 示例
 
@@ -112,6 +114,18 @@ await eslintFix(cwd, esLintOptions);
 npx esno index.ts
 ```
 
+prettierFormat()
+
+```typescript
+// ./index.ts
+import { prettierFormat, cwd, prettierFormatOptions } from "code-genius";
+
+await prettierFormat(cwd, prettierFormatOptions);
+
+// 运行
+npx esno index.ts
+```
+
 ## 执照
 
 MIT License
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -77,7 +77,7 @@
     "rimraf": "^5.0.1"
   },
   "simple-git-hooks": {
-    "pre-commit": "npx esno scripts/lint-script.ts",
-    "commit-msg": "npx esno scripts/cmv-script.ts"
+    "pre-commit": "npx cross-env CG_DEBUG=activation esno scripts/lint-script.ts",
+    "commit-msg": "npx cross-env CG_DEBUG=activation esno scripts/cmv-script.ts"
   }
 }
diff --git a/scripts/format-script.ts b/scripts/format-script.ts
@@ -0,0 +1,13 @@
+import { loggerWarring } from "../src/shared";
+import { prettierFormatOptions } from "../src/shared/config";
+import { prettierFormat } from "../src/command/prettier-format";
+
+async function format() {
+  try {
+    await Promise.all([prettierFormat(process.cwd(), prettierFormatOptions)]);
+  } catch (error) {
+    loggerWarring(error);
+  }
+}
+
+format();
diff --git a/scripts/lint-script.ts b/scripts/lint-script.ts
@@ -1,10 +1,12 @@
 import { eslintFix } from "./../src/command/eslint-fix";
 import { loggerWarring } from "../src/shared";
-import { esLintOptions } from "../src/shared/config";
+import { esLintOptions, prettierFormatOptions } from "../src/shared/config";
+import { prettierFormat } from "../src/command/prettier-format";
 
 async function lint() {
   try {
-    await Promise.all([eslintFix(process.cwd(), esLintOptions)]);
+    await prettierFormat(process.cwd(), prettierFormatOptions);
+    await eslintFix(process.cwd(), esLintOptions);
   } catch (error) {
     loggerWarring(error);
   }
diff --git a/src/command/eslint-fix.ts b/src/command/eslint-fix.ts
@@ -12,7 +12,7 @@ import { EsLintOptions } from "../shared/types";
 
 export const eslintFix = async (
   cwd = process.cwd(),
-  options: EsLintOptions
+  options: EsLintOptions,
 ) => {
   try {
     const { eslintrc, staged, paths, suffix } = options;
diff --git a/src/command/git-commit-verify.ts b/src/command/git-commit-verify.ts
@@ -4,7 +4,9 @@ import path from "node:path";
 import { execCommand } from "../shared";
 
 export const gitCommitVerify = async () => {
-  const dogit = await execCommand("git", ["rev-parse", "--show-toplevel"]);
+  const dogit = await execCommand("git", ["rev-parse", "--show-toplevel"], {
+    stdio: "inherit",
+  });
   const root = path.join(dogit || "", ".git", "COMMIT_EDITMSG");
   const content = readFileSync(root, { encoding: "utf-8" }).trim();
   const REG_EXP =
diff --git a/src/command/git-commit.ts b/src/command/git-commit.ts
@@ -16,7 +16,7 @@ interface GitCommitOptions {
 export const gitCommit = async (
   types: Array<CommitType>,
   scopes: Array<CommitScope>,
-  options: GitCommitOptions
+  options: GitCommitOptions,
 ) => {
   if (ACTIVATION) {
     loggerInfo("gitCommit 参数信息: \n");
diff --git a/src/command/prettier-format.ts b/src/command/prettier-format.ts
@@ -0,0 +1,46 @@
+import {
+  execCommand,
+  getLintFiles,
+  loggerError,
+  loggerInfo,
+} from "./../shared/index";
+import { PrettierFormatOptions } from "../shared/types";
+import { ACTIVATION } from "../shared/config";
+
+export const prettierFormat = async (
+  cwd = process.cwd(),
+  options: PrettierFormatOptions,
+) => {
+  const { staged, paths, suffix } = options;
+
+  if (ACTIVATION) {
+    loggerInfo("prettierFormat 参数信息: \n");
+    console.table(cwd);
+    console.table(options);
+  }
+
+  try {
+    const files = await getLintFiles(cwd, staged, paths, suffix);
+    if (files.length > 0) {
+      const result = await execCommand("npx", [
+        "prettier",
+        "--debug-check",
+        ...files,
+      ]);
+      if (result) {
+        await execCommand(
+          "npx",
+          ["prettier", "--write", ...result.split("\n")],
+          {
+            stdio: "inherit",
+          },
+        );
+        await execCommand("git", ["add", ...result.split("\n")], {
+          stdio: "inherit",
+        });
+      }
+    }
+  } catch (error) {
+    loggerError(error);
+  }
+};
diff --git a/src/index.ts b/src/index.ts
@@ -1,12 +1,13 @@
-export * from './command/cheanup';
-export * from './command/git-commit';
-export * from './command/git-commit-verify';
-export * from './command/git-init-hooks';
-export * from './command/npm-run';
-export * from './command/eslint-fix';
+export * from "./command/cheanup";
+export * from "./command/git-commit";
+export * from "./command/git-commit-verify";
+export * from "./command/git-init-hooks";
+export * from "./command/npm-run";
+export * from "./command/eslint-fix";
+export * from "./command/prettier-format";
 
-export * from './shared/index';
-export * from './shared/config';
-export * from './shared/types';
+export * from "./shared/index";
+export * from "./shared/config";
+export * from "./shared/types";
 
-export * from './setup';
+export * from "./setup";
diff --git a/src/setup.ts b/src/setup.ts
@@ -1,3 +1,4 @@
+import { prettierFormat } from "./command/prettier-format";
 import { eslintFix } from "./command/eslint-fix";
 import type { CAC } from "cac";
 
@@ -7,6 +8,7 @@ import {
   esLintOptions,
   gitCommitScopes,
   gitCommitTypes,
+  prettierFormatOptions,
 } from "./shared/config";
 import { SetupSet } from "./shared/types";
 
@@ -34,7 +36,7 @@ export const setupSet: SetupSet = {
     cli
       .command(
         "cmv",
-        "Help verify whether the content of git commit complies with the specification"
+        "Help verify whether the content of git commit complies with the specification",
       )
       .action(async () => {
         await gitCommitVerify();
@@ -55,7 +57,7 @@ export const setupSet: SetupSet = {
     cli
       .command(
         "ihooks",
-        "Need to re-initialize after modifying simple-git-hooks"
+        "Need to re-initialize after modifying simple-git-hooks",
       )
       .action(async () => {
         await gitInitSimpleHooks();
@@ -83,12 +85,32 @@ export const setupSet: SetupSet = {
       })
       .action(async (options) => {
         const { eslintrc, staged, path, suffix } = options;
-        console.log(suffix)
         await eslintFix(cwd, {
           eslintrc,
           staged,
           paths: typeof path === "string" ? [path] : path,
-          suffix: suffix.split(",")
+          suffix: suffix.split(","),
+        });
+      });
+  },
+  prettier: (cli: CAC) => {
+    cli
+      .command("prettier", "Format code style(default prettier)")
+      .option("--path <path>", "Inspecte path", {
+        default: prettierFormatOptions.paths,
+      })
+      .option("--staged", "Inspecte staged files", {
+        default: false,
+      })
+      .option("--suffix <suffix>", "Inspecte files with specified suffixes", {
+        default: ".js,.jsx,.ts,.tsx",
+      })
+      .action(async (options) => {
+        const { staged, path, suffix } = options;
+        await prettierFormat(cwd, {
+          staged,
+          paths: typeof path === "string" ? [path] : path,
+          suffix: suffix.split(","),
         });
       });
   },
diff --git a/src/shared/config.ts b/src/shared/config.ts
@@ -1,4 +1,9 @@
-import { CommitScope, CommitType, EsLintOptions } from "./types";
+import {
+  CommitScope,
+  CommitType,
+  EsLintOptions,
+  PrettierFormatOptions,
+} from "./types";
 
 export const gitCommitTypes: Array<CommitType> = [
   {
@@ -100,3 +105,9 @@ export const esLintOptions: EsLintOptions = {
   staged: true,
   suffix: [".js", "jsx", ".ts", ".tsx"],
 };
+
+export const prettierFormatOptions: PrettierFormatOptions = {
+  paths: ["src"],
+  staged: true,
+  suffix: [".js", "jsx", ".ts", ".tsx"],
+};
diff --git a/src/shared/types.ts b/src/shared/types.ts
@@ -21,3 +21,9 @@ export interface EsLintOptions {
   suffix: string[];
   staged: boolean;
 }
+
+export interface PrettierFormatOptions {
+  paths: string[];
+  suffix: string[];
+  staged: boolean;
+}

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@`
`77`	`77`	`"rimraf": "^5.0.1"`
`78`	`78`	`},`
`79`	`79`	`"simple-git-hooks": {`
`80`		`- "pre-commit": "npx esno scripts/lint-script.ts",`
`81`		`- "commit-msg": "npx esno scripts/cmv-script.ts"`
	`80`	`+ "pre-commit": "npx cross-env CG_DEBUG=activation esno scripts/lint-script.ts",`
	`81`	`+ "commit-msg": "npx cross-env CG_DEBUG=activation esno scripts/cmv-script.ts"`
`82`	`82`	`}`
`83`	`83`	`}`