在日常的前端开发工作中,我们通常都会使用到 npm 包来进行代码的管理,而 tamia-changelog 则是一个基于 Node.js 平台的用于生成项目版本日志的 npm 包。
本教程旨在介绍 tamia-changelog 的使用方法,以及如何将其应用到你的项目当中。
安装
使用 npm 进行安装即可:
--- ------- --------------- ----------
使用
tamia-changelog 的使用非常简单,你只需要在项目根目录下创建一个 changelog.md 文件,并在其中编写每个版本的变化记录即可。
若当前项目遵循 Semantic Versioning 2.0.0 标准,即版本号格式为 MAJOR.MINOR.PATCH,那么 tamia-changelog 就可以自动识别版本号,并将不同的变化记录分类整理,生成美观的版本日志。
下面是一个 changelog.md 的示例:
- --------- -- ------------ -- ------- - ---------- --- ----- - --- --- --- - --- --- --- --- ------- - --- --- --- - --- --- --- --- ---------- - --- --- --- -- ------- - ---------- --- ----- - --- --- --- -- ------- - ---------- - -----
生成的版本日志将会长这样:
- --------- -- ------------ -- ------- - ---------- --- ----- - --- --- --- - --- --- --- --- ------- - --- --- --- - --- --- --- --- ---------- - --- --- --- -- ------- - ---------- --- ----- - --- --- --- -- ------- - ---------- - -----
当然,你还可以通过 tamia-changelog 的配置项来自定义版本日志的输出格式和过滤规则等。
配置项
以下是 tamia-changelog 的默认配置项:
- ----- ----------------- -- --------- ----- ------------- ---- --------------------- -- ------------- -------------- - -- ----- ----- ----- ------ --------- --------- ------ ----------- ------ ---- ------- -- ----------------- ----- -- --------- --------- ----- -- ---------- -
你可以使用命令行参数或在项目的 package.json 添加 tamia-changelog 字段来修改配置项,例如:
- ---------- - ------------ ---------------- ------------------------------- ------- ----------------------- -- ------------------ - ---------------- - ----------- ------ --------- ---------- ---- ---------- ------ ------ --- ------------- -- ----------- ----- - -
参考资料
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/6005728281e8991b448e8b56