开源项目 `conventional-changelog-cli` 使用教程

开源项目 conventional-changelog-cli 使用教程

conventional-changelog-clideprecated, instead use https://github.com/conventional-changelog/conventional-changelog monorepo项目地址:https://gitcode.com/gh_mirrors/co/conventional-changelog-cli

1. 项目的目录结构及介绍

conventional-changelog-cli 是一个用于生成变更日志的命令行工具。以下是其基本的目录结构：

conventional-changelog-cli/
├── bin/
│   └── conventional-changelog
├── lib/
│   ├── changelog.js
│   ├── config.js
│   └── index.js
├── test/
│   ├── changelog.spec.js
│   └── config.spec.js
├── .editorconfig
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── yarn.lock

目录结构介绍

• bin/: 包含可执行文件。
• lib/: 包含主要的逻辑文件。
  • changelog.js: 生成变更日志的逻辑。
  • config.js: 配置文件处理逻辑。
  • index.js: 入口文件。
• test/: 包含测试文件。
• .editorconfig, .gitignore, .npmignore, .travis.yml: 项目配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• yarn.lock: Yarn 依赖锁定文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，文件名为 conventional-changelog。这个文件是一个可执行脚本，用于启动 conventional-changelog-cli。

启动文件内容

#!/usr/bin/env node

'use strict';

const conventionalChangelog = require('../lib/index.js');
conventionalChangelog();

启动文件介绍

• #!/usr/bin/env node: 指定使用 Node.js 执行该脚本。
• 'use strict';: 启用严格模式。
• const conventionalChangelog = require('../lib/index.js');: 引入主逻辑文件。
• conventionalChangelog();: 调用主逻辑函数。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 .editorconfig。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。以下是一些关键配置：

{
  "name": "conventional-changelog-cli",
  "version": "2.1.1",
  "description": "Generate a changelog from git metadata",
  "bin": {
    "conventional-changelog": "bin/conventional-changelog"
  },
  "scripts": {
    "test": "mocha --require babel-register",
    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s"
  },
  "dependencies": {
    "conventional-changelog": "^3.1.24",
    "conventional-changelog-angular": "^5.0.12",
    "conventional-changelog-core": "^4.2.2",
    "conventional-recommended-bump": "^6.1.0",
    "lodash": "^4.17.21",
    "meow": "^9.0.0",
    "normalize-package-data": "^3.0.2",
    "read-pkg": "^6.0.0",
    "read-pkg-up": "^8.0.0"
  },
  "devDependencies": {
    "babel-register": "^6.26.0",
    "mocha": "^8.4.0"
  }
}

.editorconfig

.editorconfig 文件用于统一不同编辑器和IDE的编码风格。

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

配置文件介绍

• package.json: 包含项目的名称、版本、描述、可执行文件、脚本、依赖等信息。
• .editorconfig: 定义了代码缩进、行尾符、字符集等编

conventional-changelog-clideprecated, instead use https://github.com/conventional-changelog/conventional-changelog monorepo项目地址:https://gitcode.com/gh_mirrors/co/conventional-changelog-cli