どのファイル・ディレクトリを無視するかを ESLint に設定するために .gitignore
ファイルをそのまま使うには、以下の方法があります。
1. CLI オプション --ignore-path
で指定
eslint --ignore-path .gitignore
のように、CLI オプションで指定できます。
ただし、.gitignore
がサブディレクトリにある場合には対応できない他、エディタ連携はその設定を認識できません。
2. .eslintignore
ファイルをシンボリックリンクに
.eslintignore
ファイルを .gitignore
ファイルのシンボリックリンクにすれば、ESLint は .gitignore
の内容を認識できます。
ただし、.gitignore
がサブディレクトリにある場合には対応できません。
3. .eslintrc.js
で .gitignore
を読む
.eslintrc.js
ファイル内で .gitignore
ファイルを読み込み、ignorePatterns
フィールドに設定すれば、ESLint は .gitignore
の内容を認識できます。
eslint-gitignore パッケージを使うと少し楽をできます。
例
// __dirname 以下から全 `.gitignore` を探して `ignorePatterns` で使えるように変換する
const { readGitignoreFiles } = require("eslint-gitignore")
const gitignore = readGitignoreFiles({ cwd: __dirname })
module.exports = {
ignorePatterns: gitignore,
// ...他の設定...
}
※ __dirname
以下を見るので、共有設定でこれをすると期待通りには動かないと思います。