15
6

More than 3 years have passed since last update.

ESLint が .gitignore を認識するように設定する方法

Posted at

どのファイル・ディレクトリを無視するかを 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 以下を見るので、共有設定でこれをすると期待通りには動かないと思います。

15
6
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
15
6