Jira Prepare Commit Msg 项目启动与配置教程

1. 项目目录结构及介绍

Jira Prepare Commit Msg 项目的主要目录结构如下：

jira-prepare-commit-msg/
├── .gitattributes           # Git 属性配置文件
├── .gitignore              # Git 忽略文件配置
├── .vscode                 # Visual Studio Code 项目配置
├── bin                     # 执行脚本目录
│   └── jira-prepare-commit-msg
├── lib                     # 项目库文件目录
│   ├── git                 # Git 相关操作模块
│   ├── jira                # Jira 相关操作模块
│   └── utils               # 工具模块
├── package.json            # Node.js 项目配置文件
├── README.md               # 项目说明文件
├── test                    # 测试文件目录
│   └── ...
└── ...

• .gitattributes: 定义 Git 的一些特殊行为，如文件编码、行结束符等。
• .gitignore: 指定 Git 忽略提交的文件和目录。
• .vscode: Visual Studio Code 的项目配置，包含代码风格、插件设置等。
• bin: 执行脚本目录，包含项目的主执行脚本。
• lib: 库文件目录，包含项目的核心代码模块。
• package.json: Node.js 项目配置文件，定义了项目的依赖、脚本等。
• README.md: 项目说明文件，介绍了项目的使用方法和功能。
• test: 测试文件目录，包含项目的单元测试。

2. 项目的启动文件介绍

项目的启动文件为 bin/jira-prepare-commit-msg，这是一个 Node.js 脚本。其主要功能是：

• 分析当前 Git 仓库的提交信息。
• 根据配置文件中的规则，生成 Jira 问题编号的提交信息。

使用方法：

首先，确保已安装 Node.js。然后在项目根目录下执行以下命令：

npm install

接着，在终端中执行以下命令启动脚本：

./bin/jira-prepare-commit-msg

3. 项目的配置文件介绍

项目的配置文件为 package.json，位于项目根目录。该文件定义了项目的依赖、脚本等。

以下是一些主要的配置项：

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 项目入口文件。
• scripts: 定义了一些可执行的脚本，如 start、test 等。
• dependencies: 项目的依赖库。
• devDependencies: 开发依赖库。

例如，以下是一个 scripts 配置示例：

"scripts": {
  "start": "node bin/jira-prepare-commit-msg",
  "test": "jest"
}

这里的 start 脚本用于启动项目，test 脚本用于执行单元测试。