Linting
关于代码检查 (Linting) 的说明:我们使用 eslint 来检查是否遵循了 代码风格指南。它会在预提交钩子(pre-commit hook)中运行,并作为测试的一部分,但大多数贡献者将其集成到他们的代码编辑器中以获取实时反馈。
以下是在您偏好的编辑器中设置 eslint 的一些提示
| 编辑器 | 插件 |
|---|---|
| Sublime | SublimeLinter-eslint |
| Atom | linter-eslint |
| VSCode | ESLint |
| IntelliJ | 设置 (Settings) » 语言和框架 (Languages & Frameworks) » JavaScript » 代码质量工具 (Code Quality Tools) » ESLint |
vi |
scrooloose/syntastic |
我们用于强制执行一致代码风格的另一个工具是 EditorConfig,可以通过在您的编辑器中安装插件来设置,该插件会动态更新配置。请查看 EditorConfig 网站查找适用于您编辑器的插件,并浏览我们的 .editorconfig 文件以了解我们设置的配置规则。
请注意,对于 VSCode,要启用 TypeScript(以及其他)文件类型的“live”(实时)代码检查,您需要按照下方所示修改本地设置。ESLint 扩展的默认设置是仅检查 JavaScript 文件类型。
"eslint.validate": [
"javascript",
"javascriptreact",
"typescript",
"typescriptreact",
]
尽管如此,从 ESLint v2.0.4 开始,无需使用 eslint.validate 来解析 typescript 文件,因为它开箱即用。
通过在您的设置中添加此行,eslint 可以在您保存文件时自动修复琐碎的代码检查错误。
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
}
Prettier 扩展/IDE 插件,同时维护 Kibana 项目。格式化和样式规则设置在整个项目的多个 .eslintrc.js 文件中,其中一些使用了 NPM 版本的 Prettier。使用 IDE 扩展可能会导致冲突,将格式化应用于不应由 Prettier 处理的过多文件,和/或突出显示实际上没问题的错误。