返回

",

前端

征服代码提交烦恼:打造专属 Element-Plus 提交工具,助你成为代码管理大师

前言

作为一名 Element-Plus 的忠实拥趸,在项目开发过程中,代码提交的规范性常常令人头疼不已。忘记添加提交信息,提交信息杂乱无章,导致代码维护困难重重。此刻,一款命令行工具便应运而生,为我们规范提交代码提供了有力保障。

打造专属提交工具

准备工作

迈出第一步,我们需安装必要的工具:Node.js、yarn 以及 create-react-app。

创建项目

通过 npx create-react-app my-gz-tool 创建一个项目,并进入该项目目录。

安装依赖库

使用 yarn add inquirer 安装 inquirer 依赖库。

编写命令行脚本

接下来,编写命令行脚本 script.js:

const inquirer = require("inquirer");
const fs = require("fs");

const questions = [
  {
    type: "input",
    name: "title",
    message: "请输入提交  },
  {
    type: "input",
    name: "body",
    message: "请输入提交内容:"
  }
];

inquirer.prompt(questions).then((answers) => {
  const commitMessage = `${answers.title}\n\n${answers.body}`;
  fs.writeFileSync(".git/COMMIT_EDITMSG", commitMessage);
});

创建 package.json 文件

{
  "name": "my-gz-tool",
  "version": "1.0.0",
  "scripts": {
    "gz": "node script.js"
  },
  "dependencies": {
    "inquirer": "^8.2.4"
  }
}

使用指南

1. 克隆项目

将项目克隆至本地。

2. 进入项目目录

进入项目目录。

3. 安装依赖库

运行 npm install 安装依赖库。

4. 运行命令

运行 npm run gz 命令。

5. 输入提交信息

按照提示输入提交信息。

6. 完成提交

输入完毕,即可完成提交。

总结

通过打造专属的 Element-Plus 提交工具,我们能够轻松规范代码提交信息,提高开发效率,成为一名合格的开发者。现在就行动起来,创建属于你的工具,开启规范代码之旅!

常见问题解答

1. 如何修改提交工具的默认提交信息?

修改 script.js 中的 questions 数组,自定义提交信息模板。

2. 如何在提交工具中使用占位符?

在 questions 数组中使用占位符,例如:{type: "input", name: "type", message: "请选择提交类型:feat/fix/docs"}。

3. 如何在提交工具中添加自定义验证?

在 questions 数组中使用 validate 函数,例如:{type: "input", name: "body", message: "请输入提交内容:", validate: (value) => { if (value.length < 10) { return "提交内容不能少于 10 个字符"; } } }。

4. 如何在提交工具中禁用提交信息编辑?

在 script.js 中使用 fs.writeFileSync 直接写入提交信息,而不使用 inquirer。

5. 如何在提交工具中添加多个提交信息模板?

在 questions 数组中添加多个提交信息模板,例如:[{type: "list", name: "type", message: "请选择提交类型:", choices: ["feat", "fix", "docs"]}, {type: "input", name: "title", message: "请输入提交标题:"}, {type: "input", name: "body", message: "请输入提交内容:"}。