代码风格及Commit规范

1 代码风格

整体代码风格符合 Angular Style Guide，并借助 prettier 和 tslint 及 tsconfig 进行代码风格检查和自动格式化。

1.1 prettier

• 项目 prettier 配置文件: https://github.com/NG-ZORRO/ng-zorro-antd/blob/master/.prettierrc

• 配置内容对照: https://prettier.io/docs/en/configuration.html

1.2 tslint

• 项目 tslint 配置文件: https://github.com/NG-ZORRO/ng-zorro-antd/blob/master/tslint.json

• 配置内容对照: https://palantir.github.io/tslint/rules/

• 附加 lint 内容:

  • codelyzer: Angular 规范检查
  • 自定义lint: license 检查以及测试文件 selector 检查

1.3 tsconfig

• 项目 tsconfig 配置文件: https://github.com/NG-ZORRO/ng-zorro-antd/blob/master/tsconfig.json

1.4 规范检查

1.4.1 开发过程中自动format

• webstorm 中可以依靠 filewatcher 增加 prettier 与 tslint --fix 规则，并且依赖 Save Actions 插件增加 Optimize imports 功能。

• vscode 中可以依靠 prettier-vscode 实现相似功能。

1.4.2 commit时自动format

• commit 时使用 husky 在 pre-commit 时调用了 prettier 以及 tslint 对提交缓存区代码进行了自动 format 和 fix

1.4.3 ci 时代码风格检查

• 在 travis 运行 ci 时，会运行 npm run lint 进行代码风格检查。

2 Commit 规范

项目使用 Angular Commit Message Guidelines 标准规范，所有的 commit 均包含 header、body 和 footer 三个部分

2.1 提交时的规范检查

• commit 时使用 husky 和 commitlint 对 commit log 进行规范检查。

2.2 ci 时规范检查

• semantic-pull-requests: https://github.com/zeke/semantic-pull-requests