Skip to content

keplersj/jest-runner-prettier

Repository files navigation

npm npm Codecov Bundle Size Conventional Commits Mentioned in Awesome Jest

jest-runner-prettier

Prettier runner for Jest

Usage

Install

Install jest, prettier and jest-runner-prettier

yarn add --dev jest prettier jest-runner-prettier

# or with NPM

npm install --save-dev jest prettier jest-runner-prettier

Add it to your Jest config

Using Built-in Preset

This package includes a Jest preset which configures Jest to run Prettier on all files supported by Prettier. To use it set the following in your package.json:

{
  "jest": {
    "preset": "jest-runner-prettier"
  }
}

or jest.config.js:

module.exports = {
  preset: "jest-runner-prettier",
};

Manually

In your package.json

{
  "jest": {
    "runner": "prettier",
    "moduleFileExtensions": [
      "js",
      "mjs",
      "jsx",
      "vue",
      "ts",
      "tsx",
      "css",
      "less",
      "scss",
      "html",
      "json",
      "graphql",
      "md",
      "markdown",
      "mdx",
      "yaml",
      "yml"
    ],
    "testMatch": [
      "**/*.js",
      "**/*.mjs",
      "**/*.jsx",
      "**/*.vue",
      "**/*.ts",
      "**/*.tsx",
      "**/*.css",
      "**/*.less",
      "**/*.scss",
      "**/*.html",
      "**/*.json",
      "**/*.graphql",
      "**/*.md",
      "**/*.markdown",
      "**/*.mdx",
      "**/*.yaml",
      "**/*.yml"
    ]
  }
}

Or in jest.config.js

module.exports = {
  runner: "prettier",
  moduleFileExtensions: [
    "js",
    "mjs",
    "jsx",
    "vue",
    "ts",
    "tsx",
    "css",
    "less",
    "scss",
    "html",
    "json",
    "graphql",
    "md",
    "markdown",
    "mdx",
    "yaml",
    "yml",
  ],
  testMatch: [
    "**/*.js",
    "**/*.mjs",
    "**/*.jsx",
    "**/*.vue",
    "**/*.ts",
    "**/*.tsx",
    "**/*.css",
    "**/*.less",
    "**/*.scss",
    "**/*.html",
    "**/*.json",
    "**/*.graphql",
    "**/*.md",
    "**/*.markdown",
    "**/*.mdx",
    "**/*.yaml",
    "**/*.yml",
  ],
};

Run Jest

npx jest

# or, with yarn

yarn jest

License

Copyright Kepler Sticka-Jones 2017-2022. Licensed MIT.