代码检查¶
项目接入¶
请参考 构建和测试 文档接入项目,如不需要构建/测试可忽略相关配置, 对于代码检查,需要配置 linter 选项,如:
单个 linter 示例¶
linter: flake8
多个 linter 示例¶
linter:
- flake8
- eslint
自定义文件类型示例¶
可以通过配置 linter 的 pattern 来自定义 linter 需要处理的文件类型,支持 glob/正则表达式,如:
linter: {name: "jsonlint", pattern: "*.mapping"}
支持的代码检查工具¶
名称 | 编程语言 | 官网/文档地址 |
---|---|---|
flake8 | Python | http://flake8.readthedocs.org/en/latest/ |
pycodestyle | Python | http://pycodestyle.readthedocs.org/en/latest/ |
pylint | Python | http://pylint.readthedocs.org/en/latest/ |
bandit | Python | https://github.com/openstack/bandit |
eslint | JavaScript | http://eslint.org/ |
csslint | CSS | http://csslint.net/ |
stylelint | CSS/SASS/SCSS | http://stylelint.io/ |
sasslint | SASS/SCSS | https://github.com/sasstools/sass-lint |
shellcheck | bash/zsh | https://github.com/koalaman/shellcheck |
yamllint | YAML | https://github.com/adrienverge/yamllint |
jsonlint | JSON | https://github.com/zaach/jsonlint |
rstlint | RestructuredText | https://github.com/twolfson/restructuredtext-lint |
hadolint | Dockerfile | https://github.com/hadolint/hadolint |
指定 Python 代码检查工具使用的 Python 版本¶
对于 Python 相关的代码检查工具,支持指定其使用的 Python 版本(默认使用 Python 3):
linter: {name: 'pylint', python_version: 2}
Tips¶
- 在 Pull Request 的标题/描述中包含 lint skip 禁用代码检查功能