ESLint-コードルールのカスタマイズ


概要


ESLintは、Nicholas C.Zakas(『JavaScriptプレミアムプログラミング』著者)が2013年6月に作成したオープンソースプロジェクトです.JavaScriptに完全に構成可能な実用lintツールを提供することを目的としています.
JavaScriptはダイナミックでばらばらな言語で、特に開発者の誤った使用を受けやすい.ESLintはJavaScriptコードを実行せずにコードの問題を発見することができる.
ESLintはNode.js作成は、NPMにより高速な稼働環境を提供し、インストールが便利です.

インストール

  • グローバルインストール
    $ npm install -g eslint
  • ローカルインストール
    $ npm install eslint --save-dev
  • 使用


    プロファイルの生成


    ESLintを使用したいエンジニアリングルートの下で実行します.
    eslint --init

    このコマンドの目的はeslintプロファイルを作成することです.グローバルにインストールされているeslintの場合は、任意のファイルでコマンドを使用できます.そうしないと、コマンドを使用する前にプロジェクトにeslintをインストールする必要があります.
    このコマンドを実行すると、次の3つのオプションが表示されます.
    ❯ Answer questions about your style
      Use a popular style guide
      Inspect your JavaScript file(s)
  • プロファイルをカスタマイズするには、お問い合わせください.
  • 共通のプロファイルを使用します.
  • あなたが書いたJavaScriptファイルを審査することによってプロファイルを生成します.

  • その後、あなたのディレクトリに1つあります.eslintrcファイル、これ.Eslintrcの存在形態も選択可能であり、JavaScript、YAML、JSON、packageである.jsonなど.

    プロファイル


    プロファイルを生成する、を開きます.Eslintrcファイル(一般的には非表示)は、次のフォーマットで表示されます.
    {
        "env": {
            "browser": true
        },
        "extends": "eslint:recommended",
        "rules": {
            "indent": [
                "error",
                "tab"
            ],
            "linebreak-style": [
                "error",
                "unix"
            ],
            "quotes": [
                "error",
                "double"
            ],
            "semi": [
                "error",
                "always"
            ]
        },
        Globals: {
        }
    }

    これはjson形式です.ここでは、このファイルの各パラメータの意味を説明します.
  • env:jsコードがどの実行環境で検出されるかを指定します(各実行環境には事前定義されたグローバル変数のセットがあります).
  • extends:拡張構成規則()、ここで拡張したのはeslintの推奨規則です.
  • rules:検出ルールを指定します.これは最も重要な部分であり、あなたのカスタムjsコード監視ルールの場所でもあります.彼のフォーマットは、ルール名:ルールです.たとえば、"indent": ["error","tab"]ここでindentはルール名で、インデントはtabを使用するべきだと定義されています.ルール内の最初の値errorはエラーレベルを指し、3つのレベルがあります.それぞれ:
    error level
    数値表示
    意味
    error
    2
    エラーとして
    warn
    1
    注意として
    off
    0
    ルールを閉じる
    より多くのルールは公式サイトのrulesを参照することができます.
  • Globals:スクリプト実行中にアクセスする追加のグローバル変数(jqueryなど)
  • を指定します.
    PS:
    グローバルを構成できます.Eslintファイルは、各プロジェクトに独自のファイルを作成する必要はありません.Eslintファイル、調理方法はあなたのです.Eslintrファイルは現在のユーザのルートディレクトリの下に置かれ、クラスUnixシステムの現在のユーザディレクトリは~であり、WindowsシステムではC:\Windows\Users\Usernameのような場所である

    ファイルの検出


    プロジェクトディレクトリの下で実行します.
    eslint yourfile.js

    コマンドの後、すべてのエラーメッセージが出力されます.これでOKです.個人的に最大の利点は、完全に構成可能であり、プロファイルが一度に構築され、貼り付けてコピーすることで数回も使用できないことです.チーム全体がプロファイルを使用して仕様コードの役割を果たすこともできますが、強力です.

    既存の共通ルールの使用


    Eslintは、3つのプリインストールパッケージを公式に提供しています.
  • eslint-config-google Google標準実行インストール:
    npm install eslint eslint-config-google -g
  • eslint-config-airbnb Airbnb規格は、eslint、eslint-plugin-import、eslint-plugin-react、and eslint-plugin-jsx-a 11 yなどのプラグインに依存し、各プラグインのバージョンに要求されています.次のコマンドを実行して、依存する各バージョンを表示できます.
    npm info "eslint-config-airbnb@latest" peerDependencies
    各pluginsのバージョン要件
    { eslint: '^3.15.0',
      'eslint-plugin-jsx-a11y': '^3.0.2 || ^4.0.0',
      'eslint-plugin-import': '^2.2.0',
      'eslint-plugin-react': '^6.9.0' }
    各pluginsのバージョン要件を知ってから、次のコマンドに代わってインストールを実行すると使用できます.
    npm install eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.# -g
  • eslint-config-standard Standard標準は、一部のフロントエンドエンジニアが独自に定めた標準です.インストールの実行:
    npm install eslint-config-standard eslint-plugin-standard eslint-plugin-promise -g
  • 現在のところ、公認の最良の基準はAirbnb基準である.これらの基準をグローバルにインストールし、あなたのものにすることをお勧めします.Eslintプロファイルで直接使用する:
    {
      "extends": "Airbnb/standard/Google/"
    }
    

    転載先:https://www.cnblogs.com/yzg1/p/6282791.html