no-interpolation-in-snapshots.md
1.25 KB
no-interpolation-in-snapshots
)
Disallow string interpolation inside snapshots (Prevents the use of string interpolations in snapshots.
Rule Details
Interpolation prevents snapshots from being updated. Instead, properties should be overloaded with a matcher by using property matchers.
Examples of incorrect code for this rule:
expect(something).toMatchInlineSnapshot(
`Object {
property: ${interpolated}
}`,
);
expect(something).toMatchInlineSnapshot(
{ other: expect.any(Number) },
`Object {
other: Any<Number>,
property: ${interpolated}
}`,
);
expect(errorThrowingFunction).toThrowErrorMatchingInlineSnapshot(
`${interpolated}`,
);
Examples of correct code for this rule:
expect(something).toMatchInlineSnapshot();
expect(something).toMatchInlineSnapshot(
`Object {
property: 1
}`,
);
expect(something).toMatchInlineSnapshot(
{ property: expect.any(Date) },
`Object {
property: Any<Date>
}`,
);
expect(errorThrowingFunction).toThrowErrorMatchingInlineSnapshot();
expect(errorThrowingFunction).toThrowErrorMatchingInlineSnapshot(
`Error Message`,
);
When Not To Use It
Don't use this rule on non-jest test files.