jest/no-large-snapshots スタイル

何をするか

大きなスナップショットの禁止。

なぜ問題なのか

Jest のスナップショット機能を使用する際には、作成されるスナップショットのサイズに注意する必要があります。一般的なベストプラクティスとして、スナップショットはサイズが小さく抑えられるべきです。これは、より管理しやすく、レビューしやすくなるためです。保存されたスナップショットの価値は、そのレビューの質に依存します。そのため、スナップショットを短く、簡潔で読みやすく保つことは、徹底的なレビューを可能にするために重要です。

例

このルールに違反する誤りなコードの例：

javascript

exports[`a large snapshot 1`] = `
line 1
line 2
line 3
line 4
line 5
line 6
line 7
line 8
line 9
line 10
line 11
line 12
line 13
line 14
line 15
line 16
line 17
line 18
line 19
line 20
line 21
line 22
line 23
line 24
line 25
line 26
line 27
line 28
line 29
line 30
line 31
line 32
line 33
line 34
line 35
line 36
line 37
line 38
line 39
line 40
line 41
line 42
line 43
line 44
line 45
line 46
line 47
line 48
line 49
line 50
line 51
`;

このルールに違反する誤りなコードの例：

exports[`a more manageable and readable snapshot 1`] = `
line 1
line 2
line 3
line 4
`;

このルールは eslint-plugin-vitest と互換性があります。使用するには、.oxlintrc.json に以下の設定を追加してください：

json

{
  "rules": {
    "vitest/no-large-snapshots": "error"
  }
}

設定

このルールは、次のプロパティを持つ設定オブジェクトを受け取ります：

allowedSnapshots

type: Record<string, array>

default: {}

サイズ制限を超えることが許可されるスナップショット名のリストを、スナップショットファイルパスごとにマップするオブジェクト。スナップショット名は正規表現で指定することもできます。

inlineMaxSize

type: integer

default: 50

インラインスナップショットの許可される最大行数。

maxSize

type: integer

default: 50

外部スナップショットファイルの許可される最大行数。

使用方法

設定ファイルまたは CLI でこのルールを 有効化 するには、次のようにします：

Config (.oxlintrc.json)CLI

json

{
  "plugins": ["jest"],
  "rules": {
    "jest/no-large-snapshots": "error"
  }
}

bash

oxlint --deny jest/no-large-snapshots --jest-plugin

参照

ルールのソース

何をするか ​

なぜ問題なのか ​

例 ​

設定 ​

allowedSnapshots ​

inlineMaxSize ​

maxSize ​

使用方法 ​

参照 ​