Socket
Book a DemoInstallSign in
Socket
Book a DemoInstallSign in

jest-prettyhtml-matchers

Package Overview
Dependencies
Maintainers
1
Versions
196
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jest-prettyhtml-matchers

Custom Jest snapshot matchers that use prettyhtml to format strings.

latest
Source
npmnpm
Version
1.17.15
Version published
Weekly downloads
49
-37.18%
Maintainers
1
Weekly downloads
 
Created
Source

jest-prettyhtml-matchers

npm version build status coverage status npm downloads

Custom Jest snapshot matchers that use prettyhtml to format strings.

Basic Usage | API | Installation | License

Basic Usage

First, add the custom matchers to Jest. A convenient way to do this is via a setup file included in setupFilesAfterEnv:

// 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:

expect(string).toMatchPrettyHtmlSnapshot()
expect(string).toMatchInlinePrettyHtmlSnapshot()

API

createPrettyHtmlMatchers(options?: PrettyHtmlOptions)

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

createPrettyHtmlMatchers()
createPrettyHtmlMatchers({ singleQuote: false }))

toMatchPrettyHtmlSnapshot(options?: PrettyHtmlOptions, hint?: string)

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

expect(string).toMatchPrettyHtmlSnapshot()
expect(string).toMatchPrettyHtmlSnapshot('testName')
expect(string).toMatchPrettyHtmlSnapshot({ singleQuote: false })
expect(string).toMatchPrettyHtmlSnapshot({ singleQuote: false }, 'testName')

toMatchInlinePrettyHtmlSnapshot(options?: PrettyHtmlOptions, inlineSnapshot?: string)

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

expect(string).toMatchInlinePrettyHtmlSnapshot()
expect(string).toMatchInlinePrettyHtmlSnapshot({ singleQuote: false })

Installation

$ npm install -D jest-prettyhtml-matchers

License

MIT

Keywords

custom
javascript
jest
matchers
prettyhtml
snapshot

FAQs

Package last updated on 22 Nov 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

Meet Socket at Black Hat Europe and BSides London 2025

Security News

Meet Socket at Black Hat Europe and BSides London 2025

Socket is heading to London! Stop by our booth or schedule a meeting to see what we've been working on.

By Anders Søndergaard  -  Nov 11, 2025
9 Malicious NuGet Packages Deliver Time-Delayed Destructive Payloads

Research

/

Security News

9 Malicious NuGet Packages Deliver Time-Delayed Destructive Payloads

Socket researchers discovered nine malicious NuGet packages that use time-delayed payloads to crash applications and corrupt industrial control systems.

By Kush Pandya  -  Nov 06, 2025