More than 3 years have passed since last update.

VSCode + Prettier + ESLint かんたん設定

Last updated at 2020-03-15Posted at 2020-03-15

はじめに

前回の記事 React + TypeScript + Webpackで開発環境セットアップに続き、プロジェクトにコードフォーマットと静的解析を導入していきます。🤖

プロジェクトファイルはこちらで公開中💁‍♂️
・説明に沿って導入を試したい場合はこのブランチ:topic/basic_template
・完成版を確認してみたい場合はこのブランチ:topic/lint_and_format

まずは、VSCodeにプラグインをインストールしましょう。
・Prettier
・ESLint

$ yarn add -D prettier

設定ファイルを作成。

.prettierrc.json

{
  "arrowParens": "always",
  "tabWidth": 2,
  "singleQuote": true,
  "trailingComma": "none",
  "semi": true,
  "printWidth": 120
}

VSCodeの設定から、保存時にフォーマットをオンにする。

src/index.tsxを開いて保存すると、フォーマットされましたね！

$ yarn add -D eslint
$ yarn eslint --init

自分はこんな設定にしてみました。

自分はyarnを使っているので、自動生成されたpackage-lock.jsonは不要なので削除し、パッケージを改めてインストール。ちなみにeslint --initにおけるyarnサポートが無い理由については、このあたりを読むとわかります。

$ rm package-lock.json
$ yarn install

src/index.tsxでさっそくエラーが出ていますね。

.tsxでもJSXの記述を許可する為、設定ファイルのrulesに以下を追記。

.eslintrc.json

{
  "rules": {
    "react/jsx-filename-extension": [1, { "extensions": [".jsx", ".tsx"] }]
  }
}

もうひとつ、webpack.config.jsにエラーが出ています。
どうやらPrettierのルールとバッティングしているので、eslint側のフォーマット関連ルールをeslint-config-prettierで無効にしましょう。

$ yarn add -D eslint-config-prettier

extendsの最後にprettierを追記すると、エラーが消えました。

.eslintrc.json

{
  "extends": ["plugin:react/recommended", "airbnb", "prettier"]
}

lintコマンドを追加しておきます。

package.json

"scripts": {
  "lint": "eslint '**/*.{js,ts,tsx}'"
}

試しに、VSCodeの"Format On Save"を無効にした後、src/index.tsxの4行目末尾のセミコロンを削除してみる。

あら、lintを実行しても通ってしまいました。

$ yarn lint

Prettierによるフォーマット関連のチェックもlintと同時にチェックしたいですね、ということでeslint-plugin-prettierを導入。

$ yarn add -D eslint-plugin-prettier

extendsのprettierを以下のように変更

.eslintrc.json

{
  "extends": ["plugin:react/recommended", "airbnb", "plugin:prettier/recommended"]
}

再度yarn lintすると、エラーが検知されるようになりました！🕵🏻‍♂️

ついでに、コミット直前に自動でlintするようにしておきます。

$ yarn add -D husky
$ touch .huskyrc.json

設定ファイルには以下のように記述。

.huskyrc.json

{
  "hooks": {
    "pre-commit": "yarn lint"
  }
}

git commit時にyarn lintが実行されるようになりました。ナイスです👍

今回はReact&TypeScriptなプロジェクトに導入する手順でしたが、基本的にeslint --init時の質問に答えていけば、自動で必要なパッケージがインストールされるので楽です。あとは、必要に応じてルールを追記/変更していけば良いですね！