代码规范检查
编辑代码规范检查编辑
关于代码规范检查的说明:我们使用 eslint 来检查是否遵循了 代码风格指南。它在预提交钩子和测试中运行,但大多数贡献者将其集成到他们的代码编辑器中以获得实时反馈。
以下是在您喜欢的编辑器中设置 eslint 的一些提示
编辑器 | 插件 |
---|---|
Sublime |
|
Atom |
|
VSCode |
|
IntelliJ |
设置 » 语言和框架 » JavaScript » 代码质量工具 » ESLint |
|
我们用来强制执行一致编码风格的另一个工具是 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 格式化的文件,以及/或者突出显示实际上没有问题的错误。