代码检查
关于代码检查的说明:我们使用 eslint 来检查是否遵循了 风格指南。它在预提交钩子和测试中运行,但大多数贡献者将其与代码编辑器集成以获得实时反馈。
以下是在您喜欢的编辑器中设置 eslint 的一些提示
编辑器 | 插件 |
---|---|
Sublime | SublimeLinter-eslint |
Atom | linter-eslint |
VSCode | ESLint |
IntelliJ | 设置 » 语言和框架 » JavaScript » 代码质量工具 » 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
}
在维护 Kibana 项目时,不建议使用 Prettier
扩展/IDE 插件。格式化和样式角色在整个项目的多个 .eslintrc.js
文件中设置,其中一些使用 NPM 版本的 Prettier。使用 IDE 扩展可能会导致冲突,将格式应用于太多不应进行 prettier 化的文件,和/或突出显示实际上没问题的错误。