初めに
学習用でESLintが使いたいけど、プロジェクトごとに設定ファイル(.eslintrc.*)を作成するのは面倒。
そこで、設定ファイルをグローバルルールとして保存してプロジェクトごとに作成しなくていいようにしたので、その時にやった方法を備忘録としてまとめてみました。
方法
1. ESLintのインストール
まずはESLintをグローバルインストール。
>npm -g i eslint
ここで、-gは--global、iはinstallを省略したもの。
2. ESLintの設定ファイルをグローバルとして保存
.eslintrc.json
を作成し、ユーザーディレクトリ直下に保存する。
- .eslintrc.jsonを保存する場所
MacOS:/ Users / {USERNAME}
Windows:C:\ Users \ {USERNAME}
- .eslintrc.jsonの中身
.eslint.json
{"extends":"eslint:recommended","env":{"node":true,"es6":true},"rules":{"semi":["error","never"]}}
各設定の簡単な説明
extends
プロパティ
共有設定を指定する。eslint:recommended
はESLintの推奨ルールがセットになったもの。env
プロパティ
環境を指定する。"node": true
Node.js 固有の変数や構文 (requireや特殊なトップレベル スコープ等) が定義され、利用できるようになる。"es6": true
ECMAScript 2015(ES6)で追加された構文や組込みオブジェクトが利用できるようになる。
rules
プロパティ
ルールを設定する。
大体のルールはextends
プロパティで設定されるため、extends
で設定されていないルールを追加したいときや設定しているルールを省きたいときに利用する。
また、extendsで共有設定を指定しない場合はここで一からルールを設定する。semi
プロパティ
セミコロンを付けるか付けないかの設定をする。"error"
でルールが守れてないときはエラー表示。"never"
で文末のセミコロン;
を禁止する。
3. ESLintの実行
JavaScriptのプログラムを作成してグローバルルールが通っているか確認する。
sample.jsを作成し保存。
sample.js
console.log("hello world");
sample.jsが保存されているディレクトリに移動して以下のコマンドを実行。
>eslint sample.js
グローバルルールが通っていれば以下のようなエラーが表示されるはず。
1:27 error Extra semicolon semi
✖ 1 problem (1 error, 0 warnings)
1 error and 0 warnings potentially fixable with the `--fix` option.