JavaScript 代码规范

JavaScript规范

SonarJS

• Sonar JavaScript规则

• 可使用SonarLint插件，WebStorm: File > Setting > Plugins 搜索SonarLint，安装完需重启WebStorm

• SonarLint配置：

  • File > Settings > Other Settings > SonarLint General Settings 添加SonarQube servers并启用自动检测

  • SonarQube URL: http://www.airuima.net:8000

  • File > Settings > Other Settings > SonarLint Project Settings 绑定server和project并启用配置

ESLint

• ESLint规则

• 推荐使用现成的standard规则，JavaScript standard 代码规范

• WebStorm可启用ESLint自动提示

ESLint安装

• npm i -D eslint eslint-plugin-import eslint-plugin-node eslint-plugin-promise

• 启用ESLint：File > Settings > Languages & Frameworks > JavaScript > Code Quality Tools > ESLint

• File > Settings > Editor > Inspections > JavaScript > Code quality tools > ESLint

• ESLint与Prettier结合：npm i -D eslint-config-prettier eslint-plugin-prettier

• StandardJS规则配置：

  • npm i -D eslint-plugin-standard eslint-config-standard

  • .eslintrc文件内容：

        {
            "env": {
                "browser": true,
                "jquery": true
            },
            "extends": ["standard", "plugin:prettier/recommended"],
            "parserOptions": {
                "ecmaVersion": 5
            }
        }