代码检查

编辑

关于代码检查的说明:我们使用 eslint 来检查是否遵循了 风格指南。它在预提交钩子和测试中运行,但大多数贡献者将其与代码编辑器集成以获得实时反馈。

以下是一些在您喜欢的编辑器中设置 eslint 的提示

编辑器 插件

Sublime

SublimeLinter-eslint

Atom

linter-eslint

VSCode

ESLint

IntelliJ

设置 » 语言 & 框架 » JavaScript » 代码质量工具 » ESLint

vi

scrooloose/syntastic

我们用于强制执行一致编码风格的另一个工具是 EditorConfig,可以通过在编辑器中安装一个动态更新其配置的插件来设置。请查看 EditorConfig 网站,找到适合您编辑器的插件,并浏览我们的 .editorconfig 文件,查看我们设置的配置规则。

VS Code 用户设置指南

编辑

请注意,对于 VSCode,要启用 TypeScript(和其他)文件类型的“实时”代码检查,您需要修改您的本地设置,如下所示。 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 处理的文件,和/或突出显示实际上没问题的错误。