简介
verb-log
是一个用于记录版本更新日志的 npm
包。在前端项目开发中,通常需要记录每个版本的更新内容以便后续开发者进行参考。verb-log
提供了一个简便的方式来记录版本更新日志。
安装
你可以使用 npm
进行安装:
npm install verb-log
使用
初始化配置
在使用 verb-log
前,需要先设置项目的初始化配置。在项目的根目录下创建一个 .verb.md
文件,并添加以下内容:
# <%= name %> <%= version %> > <%= description %> ## Installation ```bash $ npm install
Usage
$ npm run dev
Changelog
//This is where verb-log will insert the changelog
其中,`<%= name %>`,`<%= version %>` 和 `<%= description %>` 分别代表项目的名称、版本号和描述信息。 ### 记录更新日志 在项目根目录下运行以下命令即可为当前版本记录更新日志:
verb-log
-- -------------------- ---- ------- ---------- --- ---------- ---------------------------------- ----------- ---- ------ ---- ------- ---------- -------------------------------- ----------- ---- -- ---- --- ---------- --
my-project 1.0.0
My cool project
Installation
$ npm install my-project
Usage
const myProject = require('my-project') console.log(myProject())
Changelog
//This is where verb-log will insert the changelog
### 记录更新日志 运行以下命令:
verb-log
将会自动生成更新日志并添加到 `.verb.md` 文件中的 `Changelog` 标题下。 ### 更新版本号并生成日志 运行以下命令:
npm version patch
-- -------------------- ---- ------- --------------------------- ---------- ---- ----------- ---- -- -- ------------ ---------- ------------------------------- ---------- ----------------- - ------------------------------------------------------------------------------ -------- ------------------------------------------------------------------------------------------------------------------------