(cache) ESLint で React.js / ES6+ のコードをチェックする手順

ESLint は JavaScript のための静的検証ツールです。コードを実行する前に明らかなバグを見つけたり、括弧やスペースの使い方などのスタイルを統一したりするのに役立ちます。この記事では、 ESLint で ES6+ で書かれた React.js のチェックをするための設定を説明します。

Style guide

Airbnb のスタイルガイドがわかりやすくておすすめです。ESLint でもこのスタイルガイドをベースにチェックをしてくれます。

JavaScript: airbnb/javascript
React.js: airbnb/javascript/react

Installation

npm でインストールするライブラリはこちら:

npm install --save-dev eslint babel-eslint eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react

Configuration

ESLint の設定はこちら:

// .eslint.json
{
  "extends": "airbnb",
  "parser": "babel-eslint",
  "env": {
    "browser": true
  },
  "ecmaFeatures": {
    "classes": true,
    "jsx": true
  },
  "plugins": [
    "react",
    "jsx-a11y",
    "import"
  ],
  "extends": ["eslint", "eslint:recommended", "plugin:react/recommended"],
  "parserOptions": {
    "ecmaVersion": 7,
    "sourceType": "module",
    "ecmaFeatures": {
      "jsx": true
    }
  },
  "rules": {
    "semi": "error",
    "arrow-body-style": "error",
    "arrow-parens": "error",
    "arrow-spacing": "error",
    "generator-star-spacing": "error",
    "no-duplicate-imports": "error",
    "no-useless-computed-key": "error",
    "no-useless-constructor": "error",
    "no-useless-rename": "error",
    "no-var": "error",
    "object-shorthand": "error",
    "prefer-arrow-callback": "error",
    "prefer-const": "error",
    "prefer-rest-params": "error",
    "prefer-spread": "error",
    "prefer-template": "error",
    "rest-spread-spacing": "error",
    "template-curly-spacing": "error",
    "yield-star-spacing": "error"
  }
}

Please see moore detail Configuring ESLint.

Usage in Command Line

./node_modules/bin/eslint sample.js

Usage in overcommit

overcommit という git event を hook して様々なコマンドを実行できるツールがあります。このツールと ESLint を組み合わせる手順も書いておきます。

まずは設定:

# .overcommit.yml (Add following comfigugration)
PreCommit:
  # Style Check for JavaScript
  EsLint:
    enabled: true
    command: ['./client/node_modules/.bin/eslint', 'client/components/*', '-c', 'client/.eslintrc.json']
    include: '**/*.jsx'

あとは bundle exec overcommit --sign としておけば git commit の前に自動でESLintが実行されます。

Usage in wercker

無料で使えるCIツールの wercker で ESLint を実行するための設定も書いておきます。

eslint:
  steps:
    - bundle-install:
      jobs: 4

    - install-packages:
      name: Install node.js, build-essential, libpq-dev
      packages: build-essential libpq-dev nodejs npm nodejs-legacy

    - script:
      name: NPM install
      code: cd client && npm install -D

    - script:
      name: Run ESLint
      code: eslint components/* -c .eslintrc.json