Custom Jest snapshot matchers that use prettyhtml to format strings.
npm install jest-prettyhtml-matchers
> Custom Jest snapshot matchers that use prettyhtml to format strings.
Basic Usage | API | Installation | License
First, add the custom matchers to Jest. A convenient way to do this is via a setup file included in setupFilesAfterEnv:
``ts`
// setupJest.js
import { createPrettyHtmlMatchers } from 'jest-prettyhtml-matchers'
expect.extend(createPrettyHtmlMatchers())
> Note for TypeScript users: To ensure the global jest declaration is augmented correctly, this file should be included via your TypeScript configuration. There's an example of this setup in tanem/react-svg.
Now you can use the custom matchers in your tests:
`ts`
expect(string).toMatchPrettyHtmlSnapshot()
expect(string).toMatchInlinePrettyHtmlSnapshot()
Generates the custom matchers so that they can be added to Jest.
#### Arguments
- options - _Optional_ An object containing prettyhtml options. If options is not provided, prettyhtml's default options will be used when formatting strings. If options is provided, it will be merged with prettyhtml's default options, and the merged options will be used when formatting strings. In both cases, the options will apply to all usages of the custom matchers, but can be overridden in the matcher calls themselves.
#### Examples
`js`
createPrettyHtmlMatchers()
createPrettyHtmlMatchers({ singleQuote: false }))
Ensures that a value formatted with prettyhtml matches the most recent snapshot.
#### Arguments
- options - _Optional_ An object containing prettyhtml options. These options take precedence over options defined globally in createPrettyHtmlMatchers.hint
- - _Optional_ A string that is appended to the test name.
#### Examples
`js`
expect(string).toMatchPrettyHtmlSnapshot()
expect(string).toMatchPrettyHtmlSnapshot('testName')
expect(string).toMatchPrettyHtmlSnapshot({ singleQuote: false })
expect(string).toMatchPrettyHtmlSnapshot({ singleQuote: false }, 'testName')
Ensures that a value formatted with prettyhtml matches the most recent snapshot.
#### Arguments
- options - _Optional_ An object containing prettyhtml options. These options take precedence over options defined globally in createPrettyHtmlMatchers.inlineSnapshot
- - _Optional_ Jest adds this string to the matcher in the test file (instead of an external .snap file) the first time that the test runs.
#### Examples
`js`
expect(string).toMatchInlinePrettyHtmlSnapshot()
expect(string).toMatchInlinePrettyHtmlSnapshot({ singleQuote: false })
`
$ npm install -D jest-prettyhtml-matchers
MIT