npm 包 metiri 使用教程

阅读时长 3 分钟读完

介绍

Metiri 是一个用于在前端项目中自动化管理版本号的工具,可以自动地更新项目版本号并在其中添加变更记录。它支持 semver 版本号管理,并可以自动解析 git 提交信息并将其与 semver 版本号规则进行匹配,从而自动生成 changelog,并将其更新到项目的变更记录中。

Metiri 使用 Node.js 编写,可通过 npm 安装。接下来将详细介绍如何在你的项目中使用 Metiri,并说明其使用方法和指导意义。

安装

安装 Metiri 的方式非常简单,只需在你的项目目录中运行以下命令即可:

在安装完 Metiri 之后,你可以在项目中使用 npx metiri 命令来自动更新版本号和生成 changelog。

使用

使用 Metiri 有两个步骤:

  1. 自动更新版本号
  2. 自动生成 changelog

自动更新版本号

在使用 Metiri 之前,你需要确保项目根目录下的 package.json 中的 version 字段已经设置为 semver 规范的版本号。然后,你可以在你的项目中的任何地方运行以下命令来更新版本号:

这将从 git 提交历史中自动读取最近一次的提交信息,并将其作为更新版本号的依据。在版本号更新后,Metiri 会自动更新项目的 package.json 文件,并将更新后的版本号写入到 commit 中。

如果你想手动指定版本号,可以使用 npx metiri version <version> 命令来使用指定的版本号更新:

自动生成 changelog

在版本号更新完成之后,你可以运行以下命令来自动生成 changelog:

这将从 git 提交历史中读取所有的提交信息,并根据 semver 规范自动生成 changelog,并将其写入到项目中的变更记录文件中。

在 changelog 自动生成之前,你需要确保项目中的变更记录文件已经存在,且按照指定的格式进行编写。变更记录文件应该位于项目根目录下的 CHANGELOG.md 文件中,并包含以下结构:

-- -------------------- ---- -------
- ----- ------------

--- --------

- --- ---- --
- -

--- --- -----

- --- ---- ---
- -

在 changelog 自动生成之后,Metiri 会自动将更新后的 changelog 写入到变更记录文件中。

指导意义

Metiri 可以很好地帮助你自动化管理版本号和 changelog 的生成,从而能够简化项目开发和维护中的一些繁琐操作,并提高项目的可追踪性和可维护性。通过使用 Metiri,你可以:

  • 更好地遵循 semver 规范,规范化项目版本号的管理和更新。
  • 更好地按照细颗粒度的更新记录来跟进项目的变化情况,方便后续的维护和迭代,同时也有助于提高项目的代码质量和可读性。
  • 更好地遵循 git 提交信息的规范,规范化项目的代码贡献流程,并提高代码质量和可读性。

示例代码

以下是一个示例变更记录文件,你可以参考此文件格式来编写你自己的变更记录文件。

-- -------------------- ---- -------
- ----- ------------

--- --------

- --- ---- --
- -

--- --- -----

- --- ---- ---
- -

- ----- ------------

--- --------

- --- ---- --
- -

--- --- -----

- --- ---- ---
- -

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066f441d8e776d08040ed9

纠错
反馈