standard-version 使用教程

standard-version 使用教程

standard-version :trophy: Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org 项目地址: https://gitcode.com/gh_mirrors/st/standard-version

1. 项目目录结构及介绍

standard-version 是一个用于自动化版本控制和 CHANGELOG 生成的小型 Node.js 项目。以下是项目的目录结构及各部分的简要介绍：

standard-version/
├── .github/               # GitHub 工作流和模板文件
├── .gitignore             # 指定 Git 忽略的文件
├── bin/                   # 存放可执行的脚本文件
├── lib/                   # 包含项目的核心库代码
├── test/                  # 测试代码目录
├── .editorconfig           # 编辑器配置文件
├── .eslintrc              # ESLint 配置文件
├── package.json           # 项目包配置文件
├── README.md              # 项目说明文档
├── CHANGELOG.md           # 项目更新日志
└── LICENSE.txt            # 项目许可证文件

2. 项目的启动文件介绍

standard-version 的启动主要通过 bin 目录下的脚本实现。以下是一些主要的启动文件：

• command.js: 这是 standard-version 命令行界面的主要入口文件，负责解析命令行参数并执行相关操作。
• index.js: 这是项目的入口文件，它导出了 standard-version 的 API，便于在 Node.js 环境中直接使用。

在命令行中使用 standard-version 时，实际上是在调用 bin 目录下的脚本。

3. 项目的配置文件介绍

standard-version 的配置文件主要有以下几种：

• package.json: 这个文件定义了项目的元数据、依赖关系、脚本等。standard-version 的配置可以在这个文件的 scripts 部分进行定义，例如：

{
  "scripts": {
    "release": "standard-version"
  }
}

使用 npm run release 命令即可触发版本发布流程。

• .versionrc 或 .versionrc.json 或 .versionrc.js: 这些文件用于配置 standard-version 的行为，例如版本号的增量规则、CHANGELOG 的格式等。如果使用 .versionrc.js，则必须导出一个配置对象或一个返回配置对象的函数。

例如，一个简单的 .versionrc.js 配置文件如下：

module.exports = {
  bumpFiles: ["package.json"],
  packageFiles: ["package.json"],
  commitUrlFormat: "https://example.com/commit/${commit}",
  compareUrlFormat: "https://example.com/compare/${base}...${head}",
  issueUrlFormat: "https://example.com/issue/${issue}"
};

以上配置文件是 standard-version 项目的基础，通过它们可以自定义项目的版本控制流程和文档生成规则。

standard-version :trophy: Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org 项目地址: https://gitcode.com/gh_mirrors/st/standard-version