ESLintの使用と.eslintrc.js配置

12576 ワード

チームワークの中で、低レベルのBugを避けるために、風格の統一したコードを作り出すために、事前にコード規範を制定します.Lintツールとコードスタイル検出ツールを使用すると、コード仕様の実行を支援し、コード品質を効果的に制御することができます.
ESList概要
ESLintはJavaScript紅宝書のNichollas C.Zakasによって編纂され、2013年に第一版が発表された.NCZは車輪を繰り返し作るのではなく、実際にJSHintチームの応答が得られない場合の選択です.拡張可能、ルールごとに独立し、コードスタイルを内蔵しないことを理念として、lintツールを作成します.
ESLINEは主に以下の特徴があります.
  • デフォルトルールは、JSLint、JSHintに存在するすべてのルールを含み、移動しやすい.
  • ルールは、「警告」、「エラー」の両方のerrorレベルを設定することができます.または、直接無効にします.
  • コードスタイル検出のルール
  • を含む.
  • プラグイン拡張、カスタムルール
  • をサポートします.
    ESLINEを使う
    ESLint詳細は公式文書を参照してください.http://eslint.org/docs/user-guide/configuring
    ESListの設定
    ESLINEは以下の3つの方法で設定できます.
  • .eslintrcファイル(JSONとYAMLの2つの文法に対応)を使用する.
  • package.jsonにeslintConfig構成ブロックを追加する.
  • はコードファイルで直接定義されています.
  • .eslintrcファイルの例:
    {
      "env": {
        "browser": true,
      },
      "globals": {
        "angular": true,
      },
      "rules": {
        "camelcase": 2,
        "curly": 2,
        "brace-style": [2, "1tbs"],
        "quotes": [2, "single"],
        "semi": [2, "always"],
        "space-in-brackets": [2, "never"],
        "space-infix-ops": 2,
      }
    }
    
    プロジェクトのルートディレクトリにeslintrcを置くと、プロジェクト全体に適用されます.サブディレクトリにも含まれています.eslintrcファイルの場合、サブディレクトリはルートディレクトリのプロファイルを無視して、このディレクトリのプロファイルを適用します.このように、異なる環境のコードに異なるルールを適用することができます.
    package.jsonの例:
    {
      "name": "mypackage",
      "version": "0.0.1",
      "eslintConfig":
      {
        "env": {
          "browser": true,
          "node": true
        }
      }
    }
    
    ファイル内の設定
    コードファイル内に配置されているルールは、設定ファイルのルールをカバーします.
    .eslintrcファイルの例と解釈:
      {  
        "env": {  
          "browser": true,  
          "node": true,  
          "commonjs": true  
        },  
        "ecmaFeatures": {  
          // lambda     
          "arrowFunctions": true,  
          //       
          "destructuring": true,  
          // class  
          "classes": true,  
          // http://es6.ruanyifeng.com/#docs/function#          
          "defaultParams": true,  
          //      ,    let const  
          "blockBindings": true,  
          //       ,           
          "modules": true,  
          //           ,          
          // http://es6.ruanyifeng.com/#docs/object#        
          "objectLiteralComputedProperties": true,  
          //               
          /*var o = {
              method() {
                return "Hello!";
              }
           };
    
              
    
           var o = {
             method: function() {
               return "Hello!";
             }
           };
          */  
          "objectLiteralShorthandMethods": true,  
          /*
                      
            var foo = 'bar';
            var baz = {foo};
            baz // {foo: "bar"}
    
            //    
            var baz = {foo: foo};
          */  
          "objectLiteralShorthandProperties": true,  
          // http://es6.ruanyifeng.com/#docs/function#rest    
          "restParams": true,  
          // http://es6.ruanyifeng.com/#docs/function#       
          "spread": true,  
          // http://es6.ruanyifeng.com/#docs/iterator#for---of    
          "forOf": true,  
          // http://es6.ruanyifeng.com/#docs/generator  
          "generators": true,  
          // http://es6.ruanyifeng.com/#docs/string#       
          "templateStrings": true,  
          "superInFunctions": true,  
          // http://es6.ruanyifeng.com/#docs/object#          
          "experimentalObjectRestSpread": true  
        },  
    
        "rules": {  
          //      set      ,    get  
          "accessor-pairs": 2,  
          //                (,  ), never  :[     ]        ,always  :[     ]          
          "array-bracket-spacing": [2, "never"],  
          //                         
          "block-scoped-var": 0,  
          // if while function    {   if    ,java  。  
          "brace-style": [2, "1tbs", { "allowSingleLine": true }],  
          //          
          "camelcase": 2,  
          //               , never  :        , always  :        ,  
          // always-multiline:         ,           
          "comma-dangle": [2, "never"],  
          //            
          "comma-spacing": [2, { "before": false, "after": true }],  
          //                   
          // http://eslint.org/docs/rules/comma-style  
          "comma-style": [2, "last"],  
          //       
          "complexity": [2,9],  
          //           ,[     ]         ,      never, always  
          "computed-property-spacing": [2,"never"],  
          //          ,TypeScript   ,     
          "consistent-return": 0,  
          //              this    ,      this           ,        
          // e.g [0,"that"]      var that = this. that         ,this      that        
          "consistent-this": 0,  
          //            super()        ,TypeScrip          
          "constructor-super": 0,  
          // if else while for do          { }  ,  :  
          //    multi               { }    
          //    multi-line               { }  ,               ,  
          //                            if      。if (foo) foo++; else doSomething();  
          //    multi-or-nest              { }  ,              ,                if      
          //    [2, "multi", "consistent"]        { }    
          //    default: [2, "all"]     { }    
          "curly": [2, "all"],  
          // switch    default  ,     // no default           
          "default-case": 2,  
          //   object.key   .    ,  :  
          //      property,'.'           
          //      object, '.'             
          "dot-location": [2, "property"],  
          //     .      
          //      : allowKeywords:true           ,    .       
          //                          false           ,     []      e.g [2, {"allowKeywords": false}]  
          //           allowPattern:                 ,    []    ,     .    e.g [2, {"allowPattern": "^[a-z]+(_[a-z]+)+$"}]  
          "dot-notation": [2, {"allowKeywords": true}],  
          //           
          "eol-last": 2,  
          //    ===    ==  
          "eqeqeq": [2, "allow-null"],  
          //              
          "func-names": 0,  
          //       ,  :  
          //    declaration:            ,function f(){} e.g [2, "declaration"]  
          //    expression:            ,var f = function() {}  e.g [2, "expression"]  
          //    allowArrowFunctions: declaration         。 e.g [2, "declaration", { "allowArrowFunctions": true }]  
          "func-style": 0,  
          "generator-star-spacing": [2, { "before": true, "after": true }],  
          "guard-for-in": 0,  
          "handle-callback-err": [2, "^(err|error)$" ],  
          "indent": [2, 2, { "SwitchCase": 1 }],  
          "key-spacing": [2, { "beforeColon": false, "afterColon": true }],  
          "linebreak-style": 0,  
          "lines-around-comment": 0,  
          "max-nested-callbacks": 0,  
          "new-cap": [2, { "newIsCap": true, "capIsNew": false }],  
          "new-parens": 2,  
          "newline-after-var": 0,  
          "no-alert": 0,  
          "no-array-constructor": 2,  
          "no-caller": 2,  
          "no-catch-shadow": 0,  
          "no-cond-assign": 2,  
          "no-console": 0,  
          "no-constant-condition": 0,  
          "no-continue": 0,  
          "no-control-regex": 2,  
          "no-debugger": 2,  
          "no-delete-var": 2,  
          "no-div-regex": 0,  
          "no-dupe-args": 2,  
          "no-dupe-keys": 2,  
          "no-duplicate-case": 2,  
          "no-else-return": 0,  
          "no-empty": 0,  
          "no-empty-character-class": 2,  
          "no-empty-label": 2,  
          "no-eq-null": 0,  
          "no-eval": 2,  
          "no-ex-assign": 2,  
          "no-extend-native": 2,  
          "no-extra-bind": 2,  
          "no-extra-boolean-cast": 2,  
          "no-extra-parens": 0,  
          "no-extra-semi": 0,  
          "no-fallthrough": 2,  
          "no-floating-decimal": 2,  
          "no-func-assign": 2,  
          "no-implied-eval": 2,  
          "no-inline-comments": 0,  
          "no-inner-declarations": [2, "functions"],  
          "no-invalid-regexp": 2,  
          "no-irregular-whitespace": 2,  
          "no-iterator": 2,  
          "no-label-var": 2,  
          "no-labels": 2,  
          "no-lone-blocks": 2,  
          "no-lonely-if": 0,  
          "no-loop-func": 0,  
          "no-mixed-requires": 0,  
          "no-mixed-spaces-and-tabs": 2,  
          "no-multi-spaces": 2,  
          "no-multi-str": 2,  
          "no-multiple-empty-lines": [2, { "max": 1 }],  
          "no-native-reassign": 2,  
          "no-negated-in-lhs": 2,  
          "no-nested-ternary": 0,  
          "no-new": 2,  
          "no-new-func": 0,  
          "no-new-object": 2,  
          "no-new-require": 2,  
          "no-new-wrappers": 2,  
          "no-obj-calls": 2,  
          "no-octal": 2,  
          "no-octal-escape": 2,  
          "no-param-reassign": 0,  
          "no-path-concat": 0,  
          "no-process-env": 0,  
          "no-process-exit": 0,  
          "no-proto": 0,  
          "no-redeclare": 2,  
          "no-regex-spaces": 2,  
          "no-restricted-modules": 0,  
          "no-return-assign": 2,  
          "no-script-url": 0,  
          "no-self-compare": 2,  
          "no-sequences": 2,  
          "no-shadow": 0,  
          "no-shadow-restricted-names": 2,  
          "no-spaced-func": 2,  
          "no-sparse-arrays": 2,  
          "no-sync": 0,  
          "no-ternary": 0,  
          "no-this-before-super": 2,  
          "no-throw-literal": 2,  
          "no-trailing-spaces": 2,  
          "no-undef": 2,  
          "no-undef-init": 2,  
          "no-undefined": 0,  
          "no-underscore-dangle": 0,  
          "no-unexpected-multiline": 2,  
          "no-unneeded-ternary": 2,  
          "no-unreachable": 2,  
          "no-unused-expressions": 0,  
          "no-unused-vars": [2, { "vars": "all", "args": "none" }],  
          "no-use-before-define": 0,  
          "no-var": 0,  
          "no-void": 0,  
          "no-warning-comments": 0,  
          "no-with": 2,  
          "object-curly-spacing": 0,  
          "object-shorthand": 0,  
          "one-var": [2, { "initialized": "never" }],  
          "operator-assignment": 0,  
          "operator-linebreak": [2, "after", { "overrides": { "?": "before", ":": "before" } }],  
          "padded-blocks": 0,  
          "prefer-const": 0,  
          "quote-props": 0,  
          "quotes": [2, "single", "avoid-escape"],  
          "radix": 2,  
          "semi": [2, "never"],  
          "semi-spacing": 0,  
          "sort-vars": 0,  
          "space-after-keywords": [2, "always"],  
          "space-before-blocks": [2, "always"],  
          "space-before-function-paren": [2, "always"],  
          "space-in-parens": [2, "never"],  
          "space-infix-ops": 2,  
          "space-return-throw-case": 2,  
          "space-unary-ops": [2, { "words": true, "nonwords": false }],  
          "spaced-comment": [2, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!"] }],  
          "strict": 0,  
          "use-isnan": 2,  
          "valid-jsdoc": 0,  
          "valid-typeof": 2,  
          "vars-on-top": 0,  
          "wrap-iife": [2, "any"],  
          "wrap-regex": 0,  
          "yoda": [2, "never"]  
        }  
      }