自动生成日志

参考链接：https://juejin.im/post/5bd2debfe51d457abc710b57

Commitizen – 自动生成合格的 commit message

根据上述的描述，你是不是在感慨写个 commit message 好麻烦，这里介绍下 Commitizen – 能够根据提示自动生成符合规范的 commit message

安装

1
2

$ npm install -g commitizen
复制代码

在项目中使用

然后，在项目目录里，运行下面的命令，使其支持 Angular 的 Commit message 格式。

1
2

$ commitizen init cz-conventional-changelog --save --save-exact
复制代码

commit

在提交的时候就可以使用 git cz 就可以根据提示，生成自动化的 commit message

validate-commit-msg 检查你的 commit-message 规范

Commitizen 可以帮助我们规范自己的 commit-message，但是在团队合作中，如何规范其他成员的 commit 规范呢？

可以使用 validate-commit-msg 来检查你的项目的 commit-message 是否符合格式

validate-commit-msg 安装

1
2

npm install --save-dev validate-commit-msg
复制代码

husky 安装

按照 validate-commit-msg 中 README 中写的，可以用 validate-commit-msg 作为一个 githook 来验证提交消息，并且推荐了 husky。

This provides you a binary that you can use as a githook to validate the commit message. I recommend husky. You’ll want to make this part of the commit-msg githook, e.g. when using husky, add “commitmsg”: “validate-commit-msg” to your npm scripts in package.json.

执行

1
2

npm install husky --save-dev
复制代码

并且在 package.json 中的 scripts 字段中加入

1
2

"commitmsg": "validate-commit-msg"
复制代码

然后每次 git commit 之后，就会自动检查 commit message 是否合格。如果不合格，就会报错

1
2
3
4

husky > commit-msg (node v9.2.1)
INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" !
change
husky > commit-msg hook failed (add --no-verify to bypass)

生成 Change log

如果你的所有 commit 都符合 Angular 格式，那么发布新版本时， Change log 就可以用脚本自动生成。

生成的文档包括以下三个部分。

• New features
• Bug fixes
• Breaking changes.

每个部分都会罗列相关的 commit ，并且有指向这些 commit 的链接。当然，生成的文档允许手动修改，所以发布前，你还可以添加其他内容。

conventional-changelog 自动根据 commit 生成 change log

conventional-changelog 安装

1

npm install -g conventional-changelog-cli

本文作者：草梅友仁
本文地址： https://blog.cmyr.ltd/archives/320b027.html
版权声明：本文采用 CC BY-NC-SA 4.0 协议 进行分发，转载请注明出处！

（头图：P 站 id=72627307，作者：畑健二郎） 在此之前，先讲个段子：A：这是什么漫画 B：总之就是非常可爱 A：我知道女主非常可爱，然后这部作品到底叫什么？B：我是说这部漫画的名字就叫《总之就是非常可爱》！（完）（P 站 id=67273619，作者：畑健二郎）好吧，也许这个段子有些冷了，但不得不说，这部漫画真的“非常可爱”啊！《总之就是非常可爱（fly me to the moon）》是由日本漫画家畑健二郎创作的漫画作品，该作者之前创作过《旋风管家》，因此如果看过《旋风管家》的读者会感觉到本作

（头图：P 站 id=73526405）《擅长捉弄的高木同学》是日本漫画家山本崇一朗创作的日本漫画作品，在《月刊少年 Sunday-mini》。2017 年 7 月宣布制作电视动画，并于 2018 年 1 月 8 日首播。2019 年 1 月 12 日宣布制作第二季电视动画，在 2019 年 7 月 7 日播放。目前，第二季动画正在 B 站火热播出中~相信很多人都在学生时期有过这样的经历：和异性一起同桌。虽然，就我自己的经历而言，在初中后，就没有这样的事情了……而《擅长捉弄的高木同学》正好是将故事时间设定在初中，着实让人反思当年的自己在干什么…

（头图作者：B 站：Arice_夜声）《辉夜大小姐想让我告白~天才们的恋爱头脑战~》，简称《辉告》或《辉夜》。是日本漫画家赤坂明以恋爱喜剧为题材创作的校园漫画作品，现于《周刊 YOUNG JUMP》连载中。后改编为动画，于 2019 年 1 月开播，在第三集的书记舞之后火爆 B 站，拿下当季 B 霸。当然了，实际上不止国内，国外的死宅们对于《辉告》也是十分喜爱，可以说是少见的同时受到全球观众喜爱的动画。当然了，今天要聊的并不是《辉告》的动画，相信大部分观众都已经看过了，我再说一遍也有些无趣了。那么今天就来聊聊漫画版

node-coolq-robot

作者：草梅友仁

本项目基于 cq-robot、coolq-http-api、cq-websocket ，按照官方 SDK 风格重新封装了事件函数和 api 函数

项目特色

1. 仿官方 SDK 风格，熟悉易语言版的很快就可以上手。

2. 仿酷 Q 目录设计，可以像原生酷 Q 插件那样载入插件，也便于插件的开发

3. 可以使用 JavaScript 和 TypeScript 进行开发，具有一定的跨平台性

项目目录

• /src 源代码
  • /app 插件存放的位置
    • /com.example.demo 应用根目录
      • /data 应用数据存放目录
      • index.json/index.jsonc 插件配置项
      • index.ts/index.ts 插件入口文件
  • /conf
    • setting.json/setting.jsonc CQWebSocket 连接配置，用于和 coolq-http-api 建立连接
  • /utils 一些工具类
  • index.ts 项目运行入口
• /dist 最终需要运行的文件

快速开始

1. clone 本项目

   1	git clone https://github.com/CaoMeiYouRen/node-coolq-robot.git

2. 修改 src/conf/setting.jsonc 中的accessToken【重要】，其他参数可以默认（关于该配置，详见CoolQ HTTP API 配置）

3. 酷 Q 安装 coolq-http-api，修改 酷 Q Pro\data\app\io.github.richardchien.coolqhttpapi\config 下的相关配置，其中 access_token 与上方 accessToken 保持一致（关于该配置，详见CQWebSocketOption）

4. 酷 Q 启动 coolq-http-api，注意，如果修改 access_token 时插件已启用，请重载应用或重启酷 Q

5. 执行 npm run build 生成 dist 文件

6. 执行 dist/index.js，开发环境下可以使用 nodemon，生产环境可以使用 pm2 等

7. 在控制台查看效果（如果出现 [WebSocket] 连接成功 即为成功）

8. 演示效果

安装插件

1. 所有插件放在 src/app 目录下，新建一个由 appId 命名的文件夹（下称为应用根目录），入口文件必须为 index.js/index.ts（编译后均为 index.js），配置项为 index.json 或 index.jsonc【关于 jsonc 需要特别解释下，就是支持注释的 json，即 VScode 中的 JSON with Comments 格式】

2. 应用所有数据需存放在 [appId]/data/ 目录下，以免给用户造成困扰

3. 考虑到插件可能会有自己的 node_modules 依赖，将依赖也装在 项目根目录 下即可（注意，如果安装在项目根目录有问题，也可安装在 应用根目录 ，只不过 src 和 dist 目录下均需安装）

4. 注意：最终执行的文件为 dist 目录下的内容，因此如果有除了 json/jsonc 格式以外的文件需要从 src 目录下复制，请修改 gulpfile.js 文件

插件开发

对于开发者，本人也提供了 demo，建议使用 TypeScript 进行开发，当然也支持用 JavaScript 开发

以下是一个空的 demo 示例，更详细内容请查看本项目的 src/app/下面的 demo

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

class App extends CQApp {
    constructor() {
        super('com.example.demo', __dirname)
        //每一个CQApp对象身上都挂载着一个属性：CQ，里面封装了所有api相关操作，是核心操作类，更多内容请直接查看注释
        this.CQ.setDebug(false)//为了方便调试，本人提供了CQ.setDebug()方法来设置插件的运行环境，在debug模式下将不会执行具体的api操作，可以在不影响其他插件的情况下进行逻辑调试；同时也提供了CQ.getDebug()来获取当前的运行环境，开发者可以针对此做一些操作
        this.isEnable = true//注意，只有isEnable为true的插件才会载入，可以将isEnable置为false不载入某插件
    }
}
const app = new App()//类名可以随意
export { app }//导出模块的名称必须为app
/**
 *仅在debug模式下执行，若不需要也可注释掉
 *请注意，因为debug的内容在此处就会执行，因此是最先执行的内容！
 */
if (app.CQ.getDebug()) {
    app.debug()
}

1. 关于应用加载：符合以下条件之一的应用不会载入

   1. AppID 与其根文件夹名称不同
   2. CQ_API 版本不为 9
   3. HTTP_API 版本不为 4
   4. 应用未启用(isEnable=false)

2. api 权限：在应用根目录的 index.json 中配置，对于没有权限的 api 调用不会执行

3. 插件事件优先级：在应用根目录的 index.json 中配置，数值越低优先级越高，高优先级的可以截断消息。注意：本项目中并未对插件事件优先级做限制，而且也不限制优先级为 10000 时就不能截断消息，但为了与官方要求一致，建议不要使用 10000、20000、30000、40000、50000 以外的优先级，并且不得在优先级为 10000 时截断消息

4. 日志：日志文件会在同级运行目录生成 log 文件夹。在 log 文件夹下有 app 和 debug 两个文件夹，分别是生产环境和开发环境的日志，会记录下 api 的调用和应用接收到的事件信息。当插件处于 debug 模式时，所有日志都在 debug 文件夹下；生产环境下，所有日志都在 app 目录下

项目依赖

node-cq-websocket : https://github.com/momocow/node-cq-websocket

coolq-http-api : https://github.com/richardchien/coolq-http-api

项目参考

JCQ-CoolQ : https://github.com/Meowya/JCQ-CoolQ

（本项目在开发中很大程度上借鉴了 JCQ 的思路，在此表示感谢）

本文作者：草梅友仁
本文地址： https://blog.cmyr.ltd/archives/5e4e9fe0.html
版权声明：本文采用 CC BY-NC-SA 4.0 协议 进行分发，转载请注明出处！