readme.md

nodejs-template

一个 Node.js 项目快速起手模板。

集成技术

• TypeScript：使用 TypeScript 编写代码
• ESLint：代码风格检查
• commitlint：规范 commit message
• commitizen：规范 commit message，主要是与 git-hook 侧的交互
• lefthook：git-hook 工具

构建过程

# commitlint
pnpm install --save-dev @commitlint/cli @commitlint/config-conventional
# commitizen
pnpm install --save-dev commitizen cz-git
# eslint & lefthook
pnpm install --save-dev eslint @antfu/eslint-config lefthook

安装了 commitizen & cz-git 之后， 需要在 package.json 中添加如下配置：

{
  "config": {
    "commitizen": {
      "path": "node_modules/cz-git"
    }
  }
}