next

Edit

Configuring Jest

Jest's configuration can be defined in the package.json file of your project, or through a jest.config.js, or jest.config.ts file or through the --config <path/to/file.js|ts|cjs|mjs|json> option. If you'd like to use your package.json to store Jest's config, the "jest" key should be used on the top level so Jest will know how to find your settings:

{
  "name": "my-project",
  "jest": {
    "verbose": true
  }
}

Sau prin intermediul JavaScript:

// jest.config.js
// Sync object
module.exports = {
  verbose: true,
};

// Or async function
module.exports = async () => {
  return {
    verbose: true,
  };
};

Or through TypeScript (if ts-node is installed):

// jest.config.ts
import type {Config} from '@jest/types';

// Sync object
const config: Config.InitialOptions = {
  verbose: true,
};
export default config;

// Or async function
export default async (): Promise<Config.InitialOptions> => {
  return {
    verbose: true,
  };
};

Reţineţi că toată configuraţia care rezultă trebuie să fie serializabilă JSON.

When using the --config option, the JSON file must not contain a "jest" key:

{
  "bail": 1,
  "verbose": true
}

Opțiuni

Aceste opţiuni vă vor permite să controlați comportamentul Jest din fişierul package.json. Filosofia Jest este să funcționeze bine din start, însă uneori, e nevoie de mai multă putere de configurare.

Defaults

You can retrieve Jest's default options to expand them if needed:

// jest.config.js
const {defaults} = require('jest-config');
module.exports = {
  // ...
  moduleFileExtensions: [...defaults.moduleFileExtensions, 'ts', 'tsx'],
  // ...
};

Referințe

automock [boolean]

Implicit: false

This option tells Jest that all imported modules in your tests should be mocked automatically. All modules used in your tests will have a replacement implementation, keeping the API surface.

Exemplu:

// utils.js
export default {
  authorize: () => {
    return 'token';
  },
  isAuthorized: secret => secret === 'wizard',
};

//__tests__/automocking.test.js
import utils from '../utils';

test('if utils mocked automatically', () => {
  // Public methods of `utils` are now mock functions
  expect(utils.authorize.mock).toBeTruthy();
  expect(utils.isAuthorized.mock).toBeTruthy();

  // You can provide them with your own implementation
  // or pass the expected return value
  utils.authorize.mockReturnValue('mocked_token');
  utils.isAuthorized.mockReturnValue(true);

  expect(utils.authorize()).toBe('mocked_token');
  expect(utils.isAuthorized('not_wizard')).toBeTruthy();
});

Note: Node modules are automatically mocked when you have a manual mock in place (e.g.: __mocks__/lodash.js). More info here.

Notă: Modulele de bază, cum ar fi fs, nu sunt dublate în mod implicit. Acestea pot fi dublate în mod explicit, cu jest.mock('fs').

bail [number | boolean]

Default: 0

By default, Jest runs all tests and produces all errors into the console upon completion. The bail config option can be used here to have Jest stop running tests after n failures. Setting bail to true is the same as setting bail to 1.

cacheDirectory [string]

Implicit: "/tmp/<path>"

Directorul unde Jest va stoca informaţiile sale de dependenţe.

Jest încearcă să scaneze arborele de dependenţe o dată şi îl memorează pentru a ușura lucrul cu sistemul de fişiere care trebuie să se întâmple în timp ce rulează teste. Această opţiune de configurare vă permite să particularizaţi unde Jest stochează datele pe disc.

clearMocks [boolean]

Implicit: false

Automatically clear mock calls and instances before every test. Equivalent to calling jest.clearAllMocks() before each test. Aceasta nu elimină nicio implementare de dubluri, ce a fost furnizată.

collectCoverage [boolean]

Implicit: false

Indică dacă informaţiile de acoperire a codului trebuie să fie colectate în timpul execuției. Deoarece aceasta adaugă în toate fişierele executate declaraţii de colectare a acoperirii, poate încetini semnificativ testele.

collectCoverageFrom [array]

Implicit: undefined

An array of glob patterns indicating a set of files for which coverage information should be collected. If a file matches the specified glob pattern, coverage information will be collected for it even if no tests exist for this file and it's never required in the test suite.

Exemplu:

{
  "collectCoverageFrom": [
    "**/*.{js,jsx}",
    "!**/node_modules/**",
    "!**/vendor/**"
  ]
}

This will collect coverage information for all the files inside the project's rootDir, except the ones that match **/node_modules/** or **/vendor/**.

Notă: Această opţiune necesită ca opțiunea collectCoverage să fie setată "true" sau Jest să fie invocat cu --coverage.

Help: If you are seeing coverage output such as...

=============================== Coverage summary ===============================
Statements   : Unknown% ( 0/0 )
Branches     : Unknown% ( 0/0 )
Functions    : Unknown% ( 0/0 )
Lines        : Unknown% ( 0/0 )
================================================================================
Jest: Coverage data for global was not found.

Most likely your glob patterns are not matching any files. Refer to the micromatch documentation to ensure your globs are compatible.

coverageDirectory [string]

Implicit: undefined

Directorul unde Jest ar trebui să salveze fişierele sale de acoperire.

coveragePathIgnorePatterns [array<string>]

Implicit: ["/node_modules/"]

O serie de expresii regulate care sunt comparate cu toate căile fişierelor înainte de execuția testelor. Pentru toate fişierele care se potrivesc cu oricare dintre reguli, informaţiile de acoperire vor fi ignorate.

Aceste reguli sunt comparate față de calea completă. Utilizaţi cuvântul cheie <rootDir> pentru a include calea către directorul rădăcină din proiectul vostru pentru a preveni ignorarea accidentală a fișierelor în medii diferite, care pot avea diferite directoare rădăcină. Exemplu: ["<rootDir>/build/", "<rootDir>/node_modules/"].

coverageProvider [string]

Indicates which provider should be used to instrument code for coverage. Allowed values are babel (default) or v8.

Note that using v8 is considered experimental. This uses V8's builtin code coverage rather than one based on Babel. It is not as well tested, and it has also improved in the last few releases of Node. Using the latest versions of node (v14 at the time of this writing) will yield better results.

coverageReporters [array<string | [string, options]>]

Default: ["json", "lcov", "text", "clover"]

A list of reporter names that Jest uses when writing coverage reports. Any istanbul reporter can be used.

Notă: Setarea acestei opțiuni suprascrie valorile implicite. Adăugă "text" sau "text-summary" pentru a vedea un rezumat de acoperire în consolă.

Note: You can pass additional options to the istanbul reporter using the tuple form. For example:

["json", ["lcov", {"projectRoot": "../../"}]]

For the additional information about the options object shape you can refer to CoverageReporterWithOptions type in the type definitions.

coverageThreshold [object]

Implicit: undefined

Acesta va fi utilizat pentru a configura pragul minim de acoperire. Thresholds can be specified as global, as a glob, and as a directory or file path. If thresholds aren't met, jest will fail. Thresholds specified as a positive number are taken to be the minimum percentage required. Thresholds specified as a negative number represent the maximum number of uncovered entities allowed.

For example, with the following configuration jest will fail if there is less than 80% branch, line, and function coverage, or if there are more than 10 uncovered statements:

{
  ...
  "jest": {
    "coverageThreshold": {
      "global": {
        "branches": 80,
        "functions": 80,
        "lines": 80,
        "statements": -10
      }
    }
  }
}

If globs or paths are specified alongside global, coverage data for matching paths will be subtracted from overall coverage and thresholds will be applied independently. Thresholds for globs are applied to all files matching the glob. If the file specified by path is not found, an error is returned.

For example, with the following configuration:

{
  ...
  "jest": {
    "coverageThreshold": {
      "global": {
        "branches": 50,
        "functions": 50,
        "lines": 50,
        "statements": 50
      },
      "./src/components/": {
        "branches": 40,
        "statements": 40
      },
      "./src/reducers/**/*.js": {
        "statements": 90
      },
      "./src/api/very-important-module.js": {
        "branches": 100,
        "functions": 100,
        "lines": 100,
        "statements": 100
      }
    }
  }
}

Jest will fail if:

  • The ./src/components directory has less than 40% branch or statement coverage.
  • One of the files matching the ./src/reducers/**/*.js glob has less than 90% statement coverage.
  • The ./src/api/very-important-module.js file has less than 100% coverage.
  • Every remaining file combined has less than 50% coverage (global).

dependencyExtractor [string]

Implicit: undefined

This option allows the use of a custom dependency extractor. It must be a node module that exports an object with an extract function. E.g.:

const crypto = require('crypto');
const fs = require('fs');

module.exports = {
  extract(code, filePath, defaultExtract) {
    const deps = defaultExtract(code, filePath);
    // Scan the file and add dependencies in `deps` (which is a `Set`)
    return deps;
  },
  getCacheKey() {
    return crypto
      .createHash('md5')
      .update(fs.readFileSync(__filename))
      .digest('hex');
  },
};

The extract function should return an iterable (Array, Set, etc.) with the dependencies found in the code.

That module can also contain a getCacheKey function to generate a cache key to determine if the logic has changed and any cached artifacts relying on it should be discarded.

displayName [string, object]

implicit: undefined

Allows for a label to be printed alongside a test while it is running. This becomes more useful in multi-project repositories where there can be many jest configuration files. This visually tells which project a test belongs to. Here are sample valid values.

module.exports = {
  displayName: 'CLIENT',
};

sau

module.exports = {
  displayName: {
    name: 'CLIENT',
    color: 'blue',
  },
};

As a secondary option, an object with the properties name and color can be passed. This allows for a custom configuration of the background color of the displayName. displayName defaults to white when its value is a string. Jest uses chalk to provide the color. As such, all of the valid options for colors supported by chalk are also supported by jest.

errorOnDeprecated [boolean]

Implicit: false

Make calling deprecated APIs throw helpful error messages. Useful for easing the upgrade process.

extensionsToTreatAsEsm [array<string>]

Implicit: []

Jest will run .mjs and .js files with nearest package.json's type field set to module as ECMAScript Modules. If you have any other files that should run with native ESM, you need to specify their file extension here.

Note: Jest's ESM support is still experimental, see its docs for more details.

{
  ...
  "jest": {
    "extensionsToTreatAsEsm": [".ts"]
  }
}

extraGlobals [array<string>]

Implicit: undefined

Test files run inside a vm, which slows calls to global context properties (e.g. Math). With this option you can specify extra properties to be defined inside the vm for faster lookups.

For example, if your tests call Math often, you can pass it by setting extraGlobals.

{
  ...
  "jest": {
    "extraGlobals": ["Math"]
  }
}

forceCoverageMatch [array<string>]

Default: ['']

Test files are normally ignored from collecting code coverage. With this option, you can overwrite this behavior and include otherwise ignored files in code coverage.

For example, if you have tests in source files named with .t.js extension as following:

// sum.t.js

export function sum(a, b) {
  return a + b;
}

if (process.env.NODE_ENV === 'test') {
  test('sum', () => {
    expect(sum(1, 2)).toBe(3);
  });
}

You can collect coverage from those files with setting forceCoverageMatch.

{
  ...
  "jest": {
    "forceCoverageMatch": ["**/*.t.js"]
  }
}

globals [object]

Implicit: {}

Un set de variabile globale care trebuie să fie disponibile în toate mediile de testare.

De exemplu, următorul cod ar crea o variabilă globală __DEV__ cu valoarea true în toate mediile de testare:

{
  ...
  "jest": {
    "globals": {
      "__DEV__": true
    }
  }
}

Reţineţi că, dacă specificaţi o valoare de referinţă la nivel global (cum ar fi un obiect sau un array), şi în mijlocul execuției unui test se modifică această valoare, modificarea nu va persista în rularea testelor pentru alte fişiere de test. In addition, the globals object must be json-serializable, so it can't be used to specify global functions. For that, you should use setupFiles.

globalSetup [string]

Implicit: undefined

This option allows the use of a custom global setup module which exports an async function that is triggered once before all test suites. This function gets Jest's globalConfig object as a parameter.

Note: A global setup module configured in a project (using multi-project runner) will be triggered only when you run at least one test from this project.

Note: Any global variables that are defined through globalSetup can only be read in globalTeardown. You cannot retrieve globals defined here in your test suites.

Note: While code transformation is applied to the linked setup-file, Jest will not transform any code in node_modules. This is due to the need to load the actual transformers (e.g. babel or typescript) to perform transformation.

Exemplu:

// setup.js
module.exports = async () => {
  // ...
  // Set reference to mongod in order to close the server during teardown.
  global.__MONGOD__ = mongod;
};

// teardown.js
module.exports = async function () {
  await global.__MONGOD__.stop();
};

globalTeardown [string]

Implicit: undefined

This option allows the use of a custom global teardown module which exports an async function that is triggered once after all test suites. This function gets Jest's globalConfig object as a parameter.

Note: A global teardown module configured in a project (using multi-project runner) will be triggered only when you run at least one test from this project.

Note: The same caveat concerning transformation of node_modules as for globalSetup applies to globalTeardown.

haste [object]

Implicit: undefined

This will be used to configure the behavior of jest-haste-map, Jest's internal file crawler/cache system. The following options are supported:

type HasteConfig = {
  // Whether to hash files using SHA-1.
  computeSha1?: boolean;
  // The platform to use as the default, e.g. 'ios'.
  defaultPlatform?: string | null;
  // Path to a custom implementation of Haste.
  hasteImplModulePath?: string;
  // All platforms to target, e.g ['ios', 'android'].
  platforms?: Array<string>;
  // Whether to throw on error on module collision.
  throwOnModuleCollision?: boolean;
};

injectGlobals [boolean]

Default: true

Insert Jest's globals (expect, test, describe, beforeEach etc.) into the global environment. If you set this to false, you should import from @jest/globals, e.g.

import {expect, jest, test} from '@jest/globals';

jest.useFakeTimers();

test('some test', () => {
  expect(Date.now()).toBe(0);
});

Note: This option is only supported using the default jest-circus. test runner

maxConcurrency [number]

Default: 5

A number limiting the number of tests that are allowed to run at the same time when using test.concurrent. Any test above this limit will be queued and executed once a slot is released.

moduleDirectories [array<string>]

Implicit: ["node_modules"]

O serie de nume de directoare care vor fi cautate recursiv pentru locaţia modulelor incluse. Setting this option will override the default, if you wish to still search node_modules for packages include it along with any other options: ["node_modules", "bower_components"]

moduleFileExtensions [array<string>]

Default: ["js", "jsx", "ts", "tsx", "json", "node"]

An array of file extensions your modules use. If you require modules without specifying a file extension, these are the extensions Jest will look for, in left-to-right order.

We recommend placing the extensions most commonly used in your project on the left, so if you are using TypeScript, you may want to consider moving "ts" and/or "tsx" to the beginning of the array.

moduleNameMapper [object<string, string | array<string>>]

Implicit: null

A map from regular expressions to module names or to arrays of module names that allow to stub out resources, like images or styles with a single module.

Modulele care sunt mapate la un alias sunt de-dublate în mod implicit, indiferent dacă dublarea automată este activată sau nu.

Utilizaţi <rootDir> pentru a vă referi la valoarea rootDir, dacă doriţi să utilizaţi căi de fişier.

În plus, puteţi înlocui grupuri capturate cu regex folosind referințe numerotate.

Exemplu:

{
  "moduleNameMapper": {
    "^image![a-zA-Z0-9$_-]+$": "GlobalImageStub",
    "^[./a-zA-Z0-9$_-]+\\.png$": "<rootDir>/RelativeImageStub.js",
    "module_name_(.*)": "<rootDir>/substituted_module_$1.js",
    "assets/(.*)": [
      "<rootDir>/images/$1",
      "<rootDir>/photos/$1",
      "<rootDir>/recipes/$1"
    ]
  }
}

The order in which the mappings are defined matters. Patterns are checked one by one until one fits. The most specific rule should be listed first. This is true for arrays of module names as well.

Notă: Dacă folosiți nume fără limite ^$ pot apărea erori greu de identificat. Ex. relay va înlocui toate modulele care contin relay în nume: relay, react-relay şi graphql-relay vor fi redirecționate către dublură.

modulePathIgnorePatterns [array<string>]

Implicit: []

Un array de expresii regulate care sunt comparate cu toate căile de module, înainte de acestea să fie considerate 'vizibile' pentru încărcătorul de module. În cazul în care calea unui modul se potriveşte cu oricare dintre modele, acesta nu va fi require()-uit în mediul de testare.

Aceste reguli sunt comparate față de calea completă. Utilizaţi cuvântul cheie <rootDir> pentru a include calea către directorul rădăcină din proiectul vostru pentru a preveni ignorarea accidentală a fișierelor în medii diferite, care pot avea diferite directoare rădăcină. Exemplu: ["<rootDir>/build/"].

modulePaths [array<string>]

Implicit: []

An alternative API to setting the NODE_PATH env variable, modulePaths is an array of absolute paths to additional locations to search when resolving modules. Utilizaţi atributul <rootDir> pentru a include rădăcina proiectului vostru. Exemplu: ["<rootDir>/app/"].

notify [boolean]

Implicit: false

Activează afișsarea de notificări pentru rezultatele testelor.

Beware: Jest uses node-notifier to display desktop notifications. On Windows, it creates a new start menu entry on the first use and not display the notification. Notifications will be properly displayed on subsequent runs

notifyMode [string]

Default: failure-change

Specifies notification mode. Requires notify: true.

Modes

  • always: always send a notification.
  • failure: send a notification when tests fail.
  • success: send a notification when tests pass.
  • change: send a notification when the status changed.
  • success-change: send a notification when tests pass or once when it fails.
  • failure-change: send a notification when tests fail or once when it passes.

preset [string]

Implicit: undefined

A preset that is used as a base for Jest's configuration. A preset should point to an npm module that has a jest-preset.json or jest-preset.js file at the root.

For example, this preset foo-bar/jest-preset.js will be configured as follows:

{
  "preset": "foo-bar"
}

Presets may also be relative to filesystem paths.

{
  "preset": "./node_modules/foo-bar/jest-preset.js"
}

prettierPath [string]

Default: 'prettier'

Sets the path to the prettier node module used to update inline snapshots.

projects [array<string | projectconfig>]

Implicit: undefined

Atunci când configuraţia projects este completată cu o serie de căi sau tipare glob, Jest va rula testele în toate proiectele specificate, în acelaşi timp. Acest lucru este util pentru proiecte monolit sau atunci când se lucrează pe mai multe proiecte în acelaşi timp.

{
  "projects": ["<rootDir>", "<rootDir>/examples/*"]
}

Acest exemplu de configurare va rula Jest în directorul rădăcină, precum şi în fiecare subdirector din directorul "examples". Puteţi avea un număr nelimitat de proiecte care rulează în aceeaşi instanță Jest.

The projects feature can also be used to run multiple configurations or multiple runners. For this purpose, you can pass an array of configuration objects. For example, to run both tests and ESLint (via jest-runner-eslint) in the same invocation of Jest:

{
  "projects": [
    {
      "displayName": "test"
    },
    {
      "displayName": "lint",
      "runner": "jest-runner-eslint",
      "testMatch": ["<rootDir>/**/*.js"]
    }
  ]
}

Note: When using multi-project runner, it's recommended to add a displayName for each project. This will show the displayName of a project next to its tests.

reporters [array<modulename | [modulename, options]>]

Implicit: undefined

Utilizaţi această opţiune de configurare pentru a adăuga tipuri personalizate de raportări Jest. Un reporter personalizat este o clasă care implementează metodele onRunStart, onTestStart, onTestResult, onRunComplete, ce vor fi apelate atunci când oricare din aceste evenimente survine.

Dacă sunt specificați reporteri personalizați, atunci cei impliciți din Jest vor fi suprascriși. Pentru a păstra reporterii impliciți, default poate fi adăugat.

Acest lucru va suprascrie reporterii impliciți:

{
  "reporters": ["<rootDir>/my-custom-reporter.js"]
}

Acest lucru va utiliza reporterul personalizat în plus faţă de cei impliciți pe care Jest îi oferă:

{
  "reporters": ["default", "<rootDir>/my-custom-reporter.js"]
}

În plus, reporterii personalizați pot fi configurați prin pasarea unui obiect options ca al doilea argument:

{
  "reporters": [
    "default",
    ["<rootDir>/my-custom-reporter.js", {"banana": "yes", "pineapple": "no"}]
  ]
}

Modulele pentru reporteri personalizați trebuie să definească o clasă care primește GlobalConfig şi un obiect "options" ca argumente în constructor:

Exemplu de reporter:

// my-custom-reporter.js
class MyCustomReporter {
  constructor(globalConfig, options) {
    this._globalConfig = globalConfig;
    this._options = options;
  }

  onRunComplete(contexts, results) {
    console.log('Custom reporter output:');
    console.log('GlobalConfig: ', this._globalConfig);
    console.log('Options: ', this._options);
  }
}

module.exports = MyCustomReporter;
// or export default MyCustomReporter;

Reporterii personalizați pot forţa Jest să-ți termine execuția cu cod non-0 prin returnarea unui obiect Error în metoda getLastError()

class MyCustomReporter {
  // ...
  getLastError() {
    if (this._shouldFail) {
      return new Error('my-custom-reporter.js reported an error');
    }
  }
}

For the full list of methods and argument types see Reporter interface in packages/jest-reporters/src/types.ts

resetMocks [boolean]

Implicit: false

Automatically reset mock state before every test. Equivalent to calling jest.resetAllMocks() before each test. Acest lucru va conduce la eliminearea implementării false pentru toate dublurile, dar nu restaurează implementarea lor iniţială.

resetModules [boolean]

Implicit: false

By default, each test file gets its own independent module registry. Enabling resetModules goes a step further and resets the module registry before running each individual test. This is useful to isolate modules for every test so that the local module state doesn't conflict between tests. Acest lucru se poate face programatic folosind jest.resetModules().

resolver [string]

Implicit: undefined

Această opţiune permite utilizarea unei metode personalizate pentru rezolvarea modulelor. Acest instrument de rezolvare trebuie să fie un modul Node care exportă o funcţie ce aşteaptă ca prim argument un şir de caractere pentru calea de rezolvat şi un obiect cu următoarea structură ca al doilea argument:

{
  "basedir": string,
  "defaultResolver": "function(request, options)",
  "extensions": [string],
  "moduleDirectory": [string],
  "paths": [string],
  "packageFilter": "function(pkg, pkgdir)",
  "rootDir": [string]
}

Funcţia ar trebui să returneze fie calea către modulul care ar trebui să fie rezolvat sau să arunce o eroare în cazul în care modulul nu poate fi găsit.

Note: the defaultResolver passed as an option is the Jest default resolver which might be useful when you write your custom one. It takes the same arguments as your custom one, e.g. (request, options).

For example, if you want to respect Browserify's "browser" field, you can use the following configuration:

{
  ...
  "jest": {
    "resolver": "<rootDir>/resolver.js"
  }
}

// resolver.js
const browserResolve = require('browser-resolve');

module.exports = browserResolve.sync;

By combining defaultResolver and packageFilter we can implement a package.json "pre-processor" that allows us to change how the default resolver will resolve modules. For example, imagine we want to use the field "module" if it is present, otherwise fallback to "main":

{
  ...
  "jest": {
    "resolver": "my-module-resolve"
  }
}

// my-module-resolve package

module.exports = (request, options) => {
  // Call the defaultResolver, so we leverage its cache, error handling, etc.
  return options.defaultResolver(request, {
    ...options,
    // Use packageFilter to process parsed `package.json` before the resolution (see https://www.npmjs.com/package/resolve#resolveid-opts-cb)
    packageFilter: pkg => {
      return {
        ...pkg,
        // Alter the value of `main` before resolving the package
        main: pkg.module || pkg.main,
      };
    },
  });
};

restoreMocks [boolean]

Implicit: false

Automatically restore mock state before every test. Equivalent to calling jest.restoreAllMocks() before each test. This will lead to any mocks having their fake implementations removed and restores their initial implementation.

rootDir [string]

Default: The root of the directory containing your Jest config file or the package.json or the pwd if no package.json is found

Directorul rădăcină în care Jest ar trebui să caute teste şi module. Dacă puneți configurarea Jest în interiorul fișierului package.json şi doriţi ca directorul rădăcină a fie rădăcina proiectului vostru, valoarea pentru această configurare va fi implicit directorul cu package.json.

Deseori, veţi dori să setați această valoare la "src" sau "lib", corespunzător locației unde stocați codul sursă.

Reţineţi că folosind '<rootDir>' în orice altă configurare de căi, va referi înapoi la această valoare. De exemplu, dacă doriţi configurarea setupFiles să indice către fișierul env-setup.js din rădăcina proiectul vostru, puteți seta valoarea sa la ["<rootDir>/env-setup.js"].

roots [array<string>]

Implicit: ["<rootDir>"]

O listă de căi de directoare pe care Jest ar trebui să le utilizeze pentru a căuta fișiere.

Există cazuri în care doriţi ca Jest să căute într-un singur sub-director (în cazul în care aveţi un director src/), dar doriți să preveniți accesarea celorlalte directoare.

Notă: În timp ce rootDir este folosit mai ales ca un simbol pentru reutilizare în alte opţiuni de configurare, roots este folosit intern de Jest pentru a localiza fişierele test și sursă. Acest lucru se aplică și atunci când se caută mock-uri manuale pentru module din node_modules (__mocks__ va trebui să fie într-una din rădăcini).

Notă: În mod implicit, roots are o singură intrare <rootDir>, dar există cazuri în care v-ați dori să aveţi mai multe rădăcini într-un proiect, de exemplu roots: ["<rootDir> /src/", "< rootDir>/tests/"].

runner [string]

Default: "jest-runner"

This option allows you to use a custom runner instead of Jest's default test runner. Examples of runners include:

Note: The runner property value can omit the jest-runner- prefix of the package name.

To write a test-runner, export a class with which accepts globalConfig in the constructor, and has a runTests method with the signature:

async runTests(
  tests: Array<Test>,
  watcher: TestWatcher,
  onStart: OnTestStart,
  onResult: OnTestSuccess,
  onFailure: OnTestFailure,
  options: TestRunnerOptions,
): Promise<void>

If you need to restrict your test-runner to only run in serial rather than being executed in parallel your class should have the property isSerial to be set as true.

setupFiles [array]

Implicit: []

A list of paths to modules that run some code to configure or set up the testing environment. Each setupFile will be run once per test file. Deoarece fiecare test se execută în propriul său mediu, aceste module vor fi executate în mediul de testare imediat înainte de execuția codului de testare în sine.

It's also worth noting that setupFiles will execute before setupFilesAfterEnv.

setupFilesAfterEnv [array]

Implicit: []

A list of paths to modules that run some code to configure or set up the testing framework before each test file in the suite is executed. Deoarece setupFiles se execută înainte de instalarea framework-ului în mediul de testare, această opțiune vă oferă posibilitatea de a rula bucăți de cod imediat după ce framework-ul a fost instalat în mediul de testare.

If you want a path to be relative to the root directory of your project, please include <rootDir> inside a path's string, like "<rootDir>/a-configs-folder".

De exemplu, Jest este livrat cu mai multe plug-in-uri jasmine, care modifică API-ul jasmine. If you wanted to add even more jasmine plugins to the mix (or if you wanted some custom, project-wide matchers for example), you could do so in these modules.

Note: setupTestFrameworkScriptFile is deprecated in favor of setupFilesAfterEnv.

Example setupFilesAfterEnv array in a jest.config.js:

module.exports = {
  setupFilesAfterEnv: ['./jest.setup.js'],
};

Example jest.setup.js file

jest.setTimeout(10000); // in milliseconds

slowTestThreshold [number]

Default: 5

The number of seconds after which a test is considered as slow and reported as such in the results.

snapshotResolver [string]

Implicit: undefined

The path to a module that can resolve test<->snapshot path. This config option lets you customize where Jest stores snapshot files on disk.

Example snapshot resolver module:

module.exports = {
  // resolves from test to snapshot path
  resolveSnapshotPath: (testPath, snapshotExtension) =>
    testPath.replace('__tests__', '__snapshots__') + snapshotExtension,

  // resolves from snapshot to test path
  resolveTestPath: (snapshotFilePath, snapshotExtension) =>
    snapshotFilePath
      .replace('__snapshots__', '__tests__')
      .slice(0, -snapshotExtension.length),

  // Example test path, used for preflight consistency check of the implementation above
  testPathForConsistencyCheck: 'some/__tests__/example.test.js',
};

snapshotSerializers [array<string>]

Implicit: []

A list of paths to snapshot serializer modules Jest should use for snapshot testing.

Jest has default serializers for built-in JavaScript types, HTML elements (Jest 20.0.0+), ImmutableJS (Jest 20.0.0+) and for React elements. See snapshot test tutorial for more information.

Exemplu de modul serializator:

// my-serializer-module
module.exports = {
  serialize(val, config, indentation, depth, refs, printer) {
    return 'Pretty foo: ' + printer(val.foo);
  },

  test(val) {
    return val && val.hasOwnProperty('foo');
  },
};

printer is a function that serializes a value using existing plugins.

To use my-serializer-module as a serializer, configuration would be as follows:

{
  ...
  "jest": {
    "snapshotSerializers": ["my-serializer-module"]
  }
}

În cele din urmă testul ar arăta după cum urmează:

test(() => {
  const bar = {
    foo: {
      x: 1,
      y: 2,
    },
  };

  expect(bar).toMatchSnapshot();
});

Imaginea obținută:

Pretty foo: Object {
  "x": 1,
  "y": 2,
}

Pentru a face o dependenţă explicită, nu implicită, puteţi apela expect.addSnapshotSerializer pentru a adăuga un modul pentru un fişier individual de test, în loc de adăugarea sa în configurarea snapshotSerializers.

More about serializers API can be found here.

testEnvironment [string]

Default: "node"

Mediul de testare care va fi utilizat pentru testare. The default environment in Jest is a Node.js environment. If you are building a web app, you can use a browser-like environment through jsdom instead.

By adding a @jest-environment docblock at the top of the file, you can specify another environment to be used for all tests in that file:

/**
 * @jest-environment jsdom
 */

test('use jsdom in this test file', () => {
  const element = document.createElement('div');
  expect(element).not.toBeNull();
});

Puteţi crea propriile module care vor fi folosite pentru configurarea mediul de testare. The module must export a class with setup, teardown and getVmContext methods. You can also pass variables from this module to your test suites by assigning them to this.global object – this will make them available in your test suites as global variables.

The class may optionally expose an asynchronous handleTestEvent method to bind to events fired by jest-circus. Normally, jest-circus test runner would pause until a promise returned from handleTestEvent gets fulfilled, except for the next events: start_describe_definition, finish_describe_definition, add_hook, add_test or error (for the up-to-date list you can look at SyncEvent type in the types definitions). That is caused by backward compatibility reasons and process.on('unhandledRejection', callback) signature, but that usually should not be a problem for most of the use cases.

Any docblock pragmas in test files will be passed to the environment constructor and can be used for per-test configuration. If the pragma does not have a value, it will be present in the object with its value set to an empty string. If the pragma is not present, it will not be present in the object.

To use this class as your custom environment, refer to it by its full path within the project. For example, if your class is stored in my-custom-environment.js in some subfolder of your project, then the annotation might looke like this:

/**
 * @jest-environment ./src/test/my-custom-environment
 */

Note: TestEnvironment is sandboxed. Each test suite will trigger setup/teardown in their own TestEnvironment.

Exemplu:

// my-custom-environment
const NodeEnvironment = require('jest-environment-node');

class CustomEnvironment extends NodeEnvironment {
  constructor(config, context) {
    super(config, context);
    this.testPath = context.testPath;
    this.docblockPragmas = context.docblockPragmas;
  }

  async setup() {
    await super.setup();
    await someSetupTasks(this.testPath);
    this.global.someGlobalObject = createGlobalObject();

    // Will trigger if docblock contains @my-custom-pragma my-pragma-value
    if (this.docblockPragmas['my-custom-pragma'] === 'my-pragma-value') {
      // ...
    }
  }

  async teardown() {
    this.global.someGlobalObject = destroyGlobalObject();
    await someTeardownTasks();
    await super.teardown();
  }

  getVmContext() {
    return super.getVmContext();
  }

  async handleTestEvent(event, state) {
    if (event.name === 'test_start') {
      // ...
    }
  }
}

module.exports = CustomEnvironment;

// my-test-suite
/**
 * @jest-environment ./my-custom-environment
 */
let someGlobalObject;

beforeAll(() => {
  someGlobalObject = global.someGlobalObject;
});

testEnvironmentOptions [Object]

Implicit: {}

Test environment options that will be passed to the testEnvironment. The relevant options depend on the environment. For example, you can override options given to jsdom such as {userAgent: "Agent/007"}.

testFailureExitCode [number]

Default: 1

The exit code Jest returns on test failure.

Note: This does not change the exit code in the case of Jest errors (e.g. invalid configuration).

testMatch [array<string>]

(default: [ "**/__tests__/**/*.[jt]s?(x)", "**/?(*.)+(spec|test).[jt]s?(x)" ])

Modele glob pe care Jest le utilizează pentru a detecta fişiere de test. By default it looks for .js, .jsx, .ts and .tsx files inside of __tests__ folders, as well as any files with a suffix of .test or .spec (e.g. Component.test.js or Component.spec.js). It will also find files called test.js or spec.js.

See the micromatch package for details of the patterns you can specify.

See also testRegex [string | array<string>], but note that you cannot specify both options.

testPathIgnorePatterns [array<string>]

Implicit: ["/node_modules/"]

O serie de expresii regulate care sunt comparate cu toate căile fişierelor înainte de execuția testelor. Fişierele care se potrivesc cu oricare dintre reguli vor fi ignorate.

Aceste reguli sunt comparate față de calea completă. Utilizaţi cuvântul cheie <rootDir> pentru a include calea către directorul rădăcină din proiectul vostru pentru a preveni ignorarea accidentală a fișierelor în medii diferite, care pot avea diferite directoare rădăcină. Exemplu: ["<rootDir>/build/", "<rootDir>/node_modules/"].

testRegex [string | array<string>]

Default: (/__tests__/.*|(\\.|/)(test|spec))\\.[jt]sx?$

The pattern or patterns Jest uses to detect test files. By default it looks for .js, .jsx, .ts and .tsx files inside of __tests__ folders, as well as any files with a suffix of .test or .spec (e.g. Component.test.js or Component.spec.js). It will also find files called test.js or spec.js. See also testMatch [array<string>], but note that you cannot specify both options.

Aceasta este o vizualizare a opțiunii implicite:

├── __tests__
│   └── component.spec.js # test
│   └── anything # test
├── package.json # not test
├── foo.test.js # test
├── bar.spec.jsx # test
└── component.js # not test

Note: testRegex will try to detect test files using the absolute file path, therefore, having a folder with a name that matches it will run all the files as tests

testResultsProcessor [string]

Implicit: undefined

This option allows the use of a custom results processor. This processor must be a node module that exports a function expecting an object with the following structure as the first argument and return it:

{
  "success": boolean,
  "startTime": epoch,
  "numTotalTestSuites": number,
  "numPassedTestSuites": number,
  "numFailedTestSuites": number,
  "numRuntimeErrorTestSuites": number,
  "numTotalTests": number,
  "numPassedTests": number,
  "numFailedTests": number,
  "numPendingTests": number,
  "numTodoTests": number,
  "openHandles": Array<Error>,
  "testResults": [{
    "numFailingTests": number,
    "numPassingTests": number,
    "numPendingTests": number,
    "testResults": [{
      "title": string (message in it block),
      "status": "failed" | "pending" | "passed",
      "ancestorTitles": [string (message in describe blocks)],
      "failureMessages": [string],
      "numPassingAsserts": number,
      "location": {
        "column": number,
        "line": number
      }
    },
    ...
    ],
    "perfStats": {
      "start": epoch,
      "end": epoch
    },
    "testFilePath": absolute path to test file,
    "coverage": {}
  },
  ...
  ]
}

testRunner [string]

Default: jest-circus/runner

This option allows the use of a custom test runner. The default is jest-circus. A custom test runner can be provided by specifying a path to a test runner implementation.

Un astfel de modul trebuie să exporte o funcţie cu următoarea semnătură:

function testRunner(
  globalConfig: GlobalConfig,
  config: ProjectConfig,
  environment: Environment,
  runtime: Runtime,
  testPath: string,
): Promise<TestResult>;

Un exemplu de astfel de funcţie poate fi găsită în modulul nostru implicit jasmine2.

testSequencer [string]

Default: @jest/test-sequencer

This option allows you to use a custom sequencer instead of Jest's default. sort may optionally return a Promise.

Exemplu:

Sort test path alphabetically.

// testSequencer.js
const Sequencer = require('@jest/test-sequencer').default;

class CustomSequencer extends Sequencer {
  sort(tests) {
    // Test structure information
    // https://github.com/facebook/jest/blob/6b8b1404a1d9254e7d5d90a8934087a9c9899dab/packages/jest-runner/src/types.ts#L17-L21
    const copyTests = Array.from(tests);
    return copyTests.sort((testA, testB) => (testA.path > testB.path ? 1 : -1));
  }
}

module.exports = CustomSequencer;

Use it in your Jest config file like this:

{
  "testSequencer": "path/to/testSequencer.js"
}

testTimeout [number]

Default: 5000

Default timeout of a test in milliseconds.

testURL [string]

Default: http://localhost

Această opţiune stabileşte URL-ul pentru mediul jsdom. Aceasta apare în diverse proprietăţi, cum ar fi location.href.

timers [string]

Implicit: real

Setting this value to legacy or fake allows the use of fake timers for functions such as setTimeout. Cronometrele false sunt utile atunci când o bucată de cod stabileşte o pauză lungă pe care nu dorim să o aşteptăm într-un test.

If the value is modern, @sinonjs/fake-timers will be used as implementation instead of Jest's own legacy implementation. This will be the default fake implementation in Jest 27.

transform [object<string, pathToTransformer | [pathToTransformer, object]>]

Default: {"\\.[jt]sx?$": "babel-jest"}

O mapare între expresii regulate către căi de transformatoare. Un transformator este un modul care oferă o funcţie sincron pentru transformarea fişierele sursă. For example, if you wanted to be able to use a new language feature in your modules or tests that aren't yet supported by node, you might plug in one of many compilers that compile a future version of JavaScript to a current one. Example: see the examples/typescript example or the webpack tutorial.

Examples of such compilers include:

You can pass configuration to a transformer like {filePattern: ['path-to-transformer', {options}]} For example, to configure babel-jest for non-default behavior, {"\\.js$": ['babel-jest', {rootMode: "upward"}]}

Note: a transformer is only run once per file unless the file has changed. During the development of a transformer it can be useful to run Jest with --no-cache to frequently delete Jest's cache.

Note: when adding additional code transformers, this will overwrite the default config and babel-jest is no longer automatically loaded. If you want to use it to compile JavaScript or Typescript, it has to be explicitly defined by adding {"\\.[jt]sx?$": "babel-jest"} to the transform property. A se vedea babel-jest plugin

A transformer must be an object with at least a process function, and it's also recommended to include a getCacheKey function. If your transformer is written in ESM you should have a default export with that object.

transformIgnorePatterns [array<string>]

Default: ["/node_modules/", "\\.pnp\\.[^\\\/]+$"]

O serie de expresii regulate care sunt comparate cu toate căile fişierelor înainte de transformare. Pentru toate fişierele care se potrivesc cu oricare dintre reguli, acestea nu vor fi transformate.

Aceste reguli sunt comparate față de calea completă. Utilizaţi cuvântul cheie <rootDir> pentru a include calea către directorul rădăcină din proiectul vostru pentru a preveni ignorarea accidentală a fișierelor în medii diferite, care pot avea diferite directoare rădăcină.

Exemplu: ["<rootDir>/bower_components/", "<rootDir>/node_modules/"].

Sometimes it happens (especially in React Native or TypeScript projects) that 3rd party modules are published as untranspiled. Since all files inside node_modules are not transformed by default, Jest will not understand the code in these modules, resulting in syntax errors. To overcome this, you may use transformIgnorePatterns to allow transpiling such modules. You'll find a good example of this use case in React Native Guide.

unmockedModulePathPatterns [array<string>]

Implicit: []

O serie de expresii regulate care sunt comparate cu toate modulele inainte sa se returneze o dublare automată a lor. Pentru toate fișierele care se potrivesc cu oricare dintre modele din această listă, acesta nu va fi dublat automat.

Aceasta este utilă pentru unele module 'utilitare' frecvente, care sunt aproape întotdeauna utilizate ca detalii de implementare (cum ar fi underscore/lo-dash, etc). În general este o bună practică pentru a păstra această listă cât mai scurtă posibil şi folosirea explicită a jest.mock() / jest.unmock() în teste individuale. Configurare explicită per test este mult mai uşoară pentru alţi cititori ai testului privind înțelegerea mediului în care va rula testul.

Este posibilă suprascrierea aceastei setări în teste individuale prin apelul explicit jest.mock() în partea de sus a fişierului de testare.

verbose [boolean]

Implicit: false

Indicates whether each individual test should be reported during the run. All errors will also still be shown on the bottom after execution. Note that if there is only one test file being run it will default to true.

watchPathIgnorePatterns [array<string>]

Implicit: []

O listă de tipare RegExp care sunt comparate cu toate căile fişierelor sursă înainte de a re-rula testele în modul de veghe. În cazul în care calea de fişier se potriveşte cu oricare dintre modele, atunci când acesta este actualizat, nu se va declanşa o re-rulare a testelor.

Aceste tipare sunt comparate față de calea completă. Utilizaţi cuvântul cheie <rootDir> pentru a include calea către directorul rădăcină din proiectul vostru pentru a preveni ignorarea accidentală a fișierelor în medii diferite, care pot avea diferite directoare rădăcină. Exemplu: ["<rootDir>/node_modules/"].

Even if nothing is specified here, the watcher will ignore changes to any hidden files and directories, i.e. files and folders that begin with a dot (.).

watchPlugins [array<string | [string, object]>]

Implicit: []

This option allows you to use custom watch plugins. Read more about watch plugins here.

Examples of watch plugins include:

Note: The values in the watchPlugins property value can omit the jest-watch- prefix of the package name.

watchman [boolean]

Default: true

Whether to use watchman for file crawling.

// [string]

No default

This option allows comments in package.json. Include the comment text as the value of this key anywhere in package.json.

Exemplu:

{
  "name": "my-project",
  "jest": {
    "//": "Comment goes here",
    "verbose": true
  }
}
← The Jest ObjectJest CLI Options →