既存プロジェクトへ段階的にLinter(eslint)を導入する方法を考える

npm i -S eslint lodash.uniq
npm i -D @types/eslint @types/lodash.uniq

// index.ts

import { ESLint } from 'eslint'
import uniq from 'lodash.uniq'
import fs from 'fs'

const main = async () => {
  // eslintのターゲットファイルパス
  const filePathPatterns = process.env.FILE_PATH_PATTERNS!
  // .eslintrcのパス
  const configPath = process.env.CONFIG_PATH!

  const esLint = new ESLint({
    fix: false, // `eslint --fix` はしない
  })

  // .eslintrcを読み込む
  esLint.calculateConfigForFile(configPath)

  // Lintする
  const result = await esLint.lintFiles(filePathPatterns.split(','))
  // Lint結果を出力
  fs.writeFileSync('result.json', JSON.stringify(result, null, 2))

  for (const item of result) {
    if (item.messages.length === 0) {
      // Lintエラーがなければ何もしない
      continue
    }

    // Lintエラーが1つ以上ある場合

    // ruleIdのユニークな配列を取得する
    // 各ファイルでコメントの順序が統一されていた方が見栄えがいいので、ソートする
    const ruleIds = [
      ...uniq(
        item.messages
          .map(({ ruleId }) => ruleId)
          .filter((v) => v != null) as string[]
      ),
    ].sort()

    // 先頭に挿入するeslint無効化コメントの文字列
    const eslintDisableComments =
      ruleIds.map((ruleId) => `/* eslint ${ruleId}: 0 */`).join('\n') + '\n\n'

    // 既存のファイル文字列を取得
    const fileContent = fs.readFileSync(item.filePath).toString()

    // 既存のファイル文字列の先頭にeslint無効化コメントを追加して上書きする
    const newFileContent = eslintDisableComments + fileContent
    fs.writeFileSync(item.filePath, newFileContent)
  }
}

main()

[
  {
    "filePath": "/path/to/foo.ts",
    "messages": [],
    "errorCount": 0,
    "fatalErrorCount": 0,
    "warningCount": 0,
    "fixableErrorCount": 0,
    "fixableWarningCount": 0,
    "usedDeprecatedRules": []
  },
  {
    "filePath": "/path/to/bar.ts",
    "messages": [],
    "errorCount": 0,
    "fatalErrorCount": 0,
    "warningCount": 0,
    "fixableErrorCount": 0,
    "fixableWarningCount": 0,
    "usedDeprecatedRules": []
  },
  {
    "filePath": "/path/to/baz.ts",
    "messages": [
      {
        "ruleId": "no-unused-vars",
        "severity": 2,
        "message": "'MyClass' is defined but never used.",
        "line": 3,
        "column": 10,
        "nodeType": "Identifier",
        "messageId": "unusedVar",
        "endLine": 3,
        "endColumn": 22
      },
      {
        "ruleId": "no-unused-vars",
        "severity": 2,
        "message": "'MyClass' is defined but never used.",
        "line": 5,
        "column": 10,
        "nodeType": "Identifier",
        "messageId": "unusedVar",
        "endLine": 5,
        "endColumn": 14
      },
      {
        "ruleId": "eqeqeq",
        "severity": 2,
        "message": "Expected '===' and instead saw '=='.",
        "line": 138,
        "column": 55,
        "nodeType": "BinaryExpression",
        "messageId": "unexpected",
        "endLine": 138,
        "endColumn": 57
      },
    ],
    "errorCount": 3,
    "fatalErrorCount": 0,
    "warningCount": 0,
    "fixableErrorCount": 3,
    "fixableWarningCount": 0,
    "source": "...",
    "usedDeprecatedRules": []
  },
]

FILE_PATH_PATTERNS=/path/to/**/*.ts \
CONFIG_PATH=/path/to/.eslintrc.yml \
npx ts-node index.ts

/* eslint eqeqeq: 0 */
/* eslint no-unused-vars: 0 */

import { MyClass } from './path/to/my-class'

// 以下省略...