ESLint (JS / TS)

eslint-plugin-aaa-pattern は、JavaScript / TypeScript のテストファイルに対して Arrange-Act-Assert パターンを強制します。

インストール

npm install --save-dev eslint-plugin-aaa-pattern

Flat config (ESLint v9+)

// eslint.config.js
import aaa from 'eslint-plugin-aaa-pattern'

export default [
  {
    files: ['**/*.test.{js,ts}'],
    plugins: { aaa },
    rules: {
      'aaa/pattern': 'error'
    }
  }
]

同梱の推奨設定を使う場合:

import aaa from 'eslint-plugin-aaa-pattern'

export default [aaa.configs.recommended]

Legacy config (ESLint v8)

// .eslintrc.json
{
  "plugins": ["aaa"],
  "overrides": [
    {
      "files": ["**/*.test.js"],
      "rules": { "aaa/pattern": "error" }
    }
  ]
}

ルール: aaa/pattern

オプション

{
  "aaa/pattern": ["error", {
    "labels": {
      "arrange": ["arrange"],
      "act":     ["act"],
      "assert":  ["assert"]
    },
    "testFunctions": ["it", "test"],
    "caseSensitive": false,
    "allowEmptySection": true
  }]
}

オプション	デフォルト	説明
labels	英語のデフォルト	各セクションで許可するコメント文字列。配列なので同義語を複数登録できます。
testFunctions	["it", "test"]	検査対象のテスト定義関数。必要に応じて "specify" / "example" などを追加してください。
caseSensitive	false	false のとき // ARRANGE と arrange は同一視されます。
allowEmptySection	true	false にすると、セクション内にコードが無い場合もエラーになります。

例

Given / When / Then

{
  "labels": {
    "arrange": ["given"],
    "act":     ["when"],
    "assert":  ["then"]
  }
}

日本語

{
  "labels": {
    "arrange": ["準備", "前準備"],
    "act":     ["実行"],
    "assert":  ["検証", "確認"]
  }
}

検出例

// エラー: "arrange" コメントが無い
it('bad', () => {
  // act
  const x = doThing()
  // assert
  expect(x).toBe(1)
})

// エラー: 順序が逆
it('also bad', () => {
  // act
  const x = doThing()
  // arrange
  const y = 1
  // assert
  expect(x).toBe(y)
})

自動修正 (auto-fix)

3つすべてのセクションコメントが欠けている場合、eslint --fix がテストブロックの先頭に // arrange / // act / // assert のテンプレートを挿入します。あとは各コメントを該当するコードの上に移動するだけです。

それ以外のケース (1〜2個欠けている、順序が違う、空セクション) は自動修正されません — 適切な挿入位置はテストの意図に依存するため、エラーメッセージが「何を」「どこに」追加すべきかを具体的に教えてくれます。