prefer-inline-snapshots.md
1.07 KB
prefer-inline-snapshots
)
Suggest using inline snapshots (Deprecated
This rule has been deprecated in favor of
no-restricted-matchers
with the following config:
{
"rules": {
"jest/no-restricted-matchers": [
"error",
{
"toThrowErrorMatchingSnapshot": "Use `toThrowErrorMatchingInlineSnapshot()` instead",
"toMatchSnapshot": "Use `toMatchInlineSnapshot()` instead"
}
]
}
}
In order to make snapshot tests more manageable and reviewable
toMatchInlineSnapshot()
and toThrowErrorMatchingInlineSnapshot
should be
used to write the snapshots' inline in the test file.
Rule details
This rule triggers a warning if toMatchSnapshot()
or
toThrowErrorMatchingSnapshot
is used to capture a snapshot.
The following pattern is considered warning:
expect(obj).toMatchSnapshot();
expect(error).toThrowErrorMatchingSnapshot();
The following pattern is not warning:
expect(obj).toMatchInlineSnapshot();
expect(error).toThrowErrorMatchingInlineSnapshot();