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. Si quieres usar package.json para la configuración de Jest, el atributo "jest" debe ser usado a nivel raíz para que Jest pueda encontrar tu configuración:

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

O a través de 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,
  };
};

Es importante notar que la configuración debe poder serializarse a un objeto JSON.

Cuando uses la opción --config, el archivo JSON no debe contener el atributo "jest":

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

Opciones

Estas opciones permiten controlar el comportamiento de Jest desde el archivo package.json. La filosofía de Jest es que funcione de manera excelente en automático; pero sabemos que a veces se necesita tener más control sobre la configuración.

Valores por defecto

Puedes obtener los valores por defecto de Jest para expandirlos si es necesario:

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

Referencia

automock [boolean]

Por defecto: false

Esta opción le dice a Jest que todos los módulos importados en sus test deben ser reemplazados automáticamente por mocks. Todos los módulos utilizados en los test tendrán una implementación mock, manteniendo el nivel base de la API.

Ejemplo:

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

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

test('si utils es un mock automáticamente', () => {
  // Los métodos públicos de `utils` ahora son funciones mock
  expect(utils.authorize.mock).toBeTruthy();
  expect(utils.isAuthorized.mock).toBeTruthy();

  // Puedes proporcionarles una implementación
  // o pasar el valor que deseas que regresen
  utils.authorize.mockReturnValue('token_mock');
  utils.isAuthorized.mockReturnValue(true);

  expect(utils.authorize()).toBe('token_mock');
  expect(utils.isAuthorized('no_wizard')).toBeTruthy();
});

Nota: Los módulos de node_modules se reemplazan automáticamente por mocks cuando se define manualmente un mock en su lugar (p.e. __mocks__/lodash.js). Más información aquí.

Nota: Los módulos centrales (core) como fs NO son simulados (mocked) de manera automática. Pero pueden ser simulados de manera explicita. En este caso con jest.mock('fs').

bail [número| booleano]

Valor por defecto: 0

Por defecto, Jest ejecuta todos los test y muestra todos los errores en la consola al finalizar. La opción bail puede utilizarse para que Jest deje de ejecutar test después de n test fallidos. Definir bail como true es lo mismo que establecerlo como 1.

cacheDirectory [string]

Por defecto: "/tmp/<path>"

Indica el directorio donde Jest debe guardar el caché de la información de las dependencias del proyecto.

Al iniciar, Jest intenta escanear el árbol de dependencias una vez y guardar la información en caché; con el objetivo de minimizar el trabajo que ocurre al trabajar con el sistema de archivos cuando las pruebas son ejecutadas. Esta opción permite configurar donde es que Jest guarda este caché en disco.

clearMocks [boolean]

Por defecto: false

Automatically clear mock calls and instances before every test. Equivalent to calling jest.clearAllMocks() before each test. Esto no remueve ninguna implementación de mock que se haya proporcionado.

collectCoverage [boolean]

Por defecto: false

Indica si la información de cobertura debe ser recolectada al momento de ejecutar las pruebas. Activar esta opción puede alentar de manera significativa el tiempo de ejecución de las pruebas; pues se agregan sentencias temporales, para la recolección de cobertura, en todos los archivos ejecutados.

collectCoverageFrom [array]

Por defecto: 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.

Ejemplo:

{
  "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/**.

Nota: Esta opción requiere que collectCoverage se defina como true o que Jest sea ejecutado con la opción --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]

Por defecto: undefined

El directorio donde Jest escribe los archivos de resultados del análisis de cobertura.

modulePathIgnorePatterns [arreglo]

Por defecto: ["/node_modules/"]

Arreglo de patrones de expresiones regulares regexp con el que se comparan todos los directorios del proyecto antes de la ejecución de pruebas. Cualquier archivo que entre en la expresión será omitido durante el análisis de cobertura.

Estos patrones se comparan contra la ruta completa. Use the <rootDir> string token to include the path to your project's root directory to prevent it from accidentally ignoring all of your files in different environments that may have different root directories. Ejemplo: ["<rootDir>/build/", "<rootDir>/node_modules/"].

coverageProvider [string]

Indica qué proveedor debe ser usado para calcular cobertura. Los valores permitidos son babel (por defecto) o v8.

Note that using v8 is considered experimental. Esto utiliza la herramienta de cobertura incorporada de V8 en lugar de una basada en Babel. No está tan bien probado, y también ha mejorado en las últimas versiones de Node. Se obtienen mejores resultados al utilizar las últimas versiones de node (v14 al momento de esta escritura).

coverageReporters [arreglo<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.

Nota: Esta opción sobrescribe los valores por defecto. El valor "text" o "text-summary" debe ser agregado para ver el resumen de cobertura en consola.

Nota: Puedes pasar opciones adicionales a la herramienta de cobertura istanbul usando el formulario de tupla. Por ejemplo:

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

Para información adicional de la forma del objeto de opciones puedes referirte a la definición de tipos en CoverageReporterWithOptions

coverageThreshold [object]

Por defecto: undefined

Utilizado para imponer el mínimo de cobertura necesario. Thresholds can be specified as global, as a glob, and as a directory or file path. Jest fallará si los límites no se cumplen. 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. Los limites para los globs son aplicados a todos los archivos que coincidan con el glob. Si el archivo especificado en la ruta no se encuentra, regresa un error.

Por ejemplo, con la siguiente configuración:

{
  ...
  "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 fallará si:

  • El directorio de ./src/components tiene menos del 40% de cobertura en branch (ramas) o statement (hechos).
  • Uno de los archivos que coincidan con el glob ./src/reducers/**/*.js tiene menos del 90% de cobertura de statement.
  • El archivo ./src/api/very-important-module.js tiene menos del 100% de cobertura.
  • Cada archivo restante combinado tiene menos del 50% de cobertura (global).

dependencyExtractor [string]

Por defecto: undefined

Esta opción permite el uso de un extractor de dependencias custom. Debe ser un módulo de node_modules que exporte un objeto con una función de extract . Por ejemplo:

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]

por defecto: 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',
};

or

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]

Por defecto: false

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

extensionsToTreatAsEsm [array<string>]

Por defecto: []

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 [arreglo<string>]

Por defecto: 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 [arreglo<string>]

Por defecto: ['']

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);
  });
}

Puede recolectar la cobertura de esos archivos con el ajuste forceCoverageMatch.

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

globals [object]

Por defecto: false

Conjunto de variables globales que necesitan estar disponibles en todos los ambientes de pruebas.

El ejemplo siguiente creará una variable global __DEV__ con valor true en todos los ambientes de pruebas:

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

Es importante notar que si se especifica un valor de referencia global aquí (como un objecto o un arreglo), y el código de alguna prueba modifica este valor, estos cambios NO se verán reflejados en pruebas que residan en otros archivos. 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]

Por defecto: 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.

Nota: Cualquier variable global definida a través de globalSetup sólo puede leerse en globalTeardown. Dichos valores no están disponibles para los suites de test.

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.

Ejemplo:

// setup.js
module.exports = async () => {
  // ...
  // Establecer referencia a mongod para cerrar el servidor durante el teardown.
  global.__MONGOD__ = mongo;
};

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

globalTeardown [string]

Por defecto: 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]

Por defecto: 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

Número de test que se pueden ejecutar a la vez cuando se ocupa test.concurrent. Cualquier test por encima de este límite se pondrá en cola y se ejecutará una vez que se libere un espacio.

moduleDirectories [arreglo<string>]

Por defecto: ["/node_modules/"]

Arreglo de directorios a ser buscados desde la ubicación del modulo requerido de manera recursiva hacia arriba. 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 [arreglo<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 [objeto<string, string | arreglo<string>>]

Por defecto: 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.

Módulos que se definan a través de un alias no son sustituidos, independientemente de si se ha activado la opción de simulación automática automocking.

Se debe usar la cadena <rootDir> para referirse al directorio raíz rootDir en donde se definan rutas.

De manera adicional, se pueden sustituir grupos de captura de expresiones regulares ocupando referencias anteriores numeradas.

Ejemplo:

{
  "moduleNameMapper": {
    "^imagen![a-zA-Z0-9$_-]+$": "MockGlobalDeImagenes",
    "^[. a-zA-Z0-9$_-]+\\.png$": "<rootDir>/MockRelativoDeImagenes.js",
    "nombre_modulo_(. )": "<rootDir>/modulo_substituto_$1.js",
    "assets/(. )": [
      "<rootDir>/imagenes/$1",
      "<rootDir>/fotos/$1",
      "<rootDir>/recetas/$1"
    ]
  }
}

El orden en que los mapas son importados afecta el resultado. Los patrones se checan en orden hasta que uno coincida. La regla más específica debe ser listada primero. Esto es también cierto para arreglos de módulos.

Nota: Usar nombres de modulo sin los limites ^$ dificulta el encontrar errores. Por ejemplo, relay reemplazará todos los módulos que contengan relay como parte del nombre: tanto relay, react-relay y graphl-relay apuntarán al modulo de sustitución.

modulePathIgnorePatterns [arreglo]

Por defecto: []

Arreglo de patrones de expresiones regulares regexp con los que se comparan las rutas a los módulos. Aquellos módulos que empaten son visibles para el cargador de módulos. Cualquier modulo cuya ruta empate con una expresión no podrá ser cargado vía require() en el ambiente de pruebas.

Estos patrones se comparan contra la ruta completa. Use the <rootDir> string token to include the path to your project's root directory to prevent it from accidentally ignoring all of your files in different environments that may have different root directories. Ejemplo: ["<rootDir>/built/"].

modulePaths [arreglo<string>]

Por defecto: []

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. La cadena <rootDir> puede usarse para referir a la ruta al directorio raíz del proyecto. Ejemplo: ["<rootDir>/app/"].

notify [boolean]

Por defecto: false

Activa notificaciones para los resultados de pruebas.

Atención: Jest usa node-notifier para mostrar las notificaciones de escritorio. 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.

Modos

  • always: envía siempre una notificación.
  • failure: envía una notificación cuando fallen los test.
  • success: envía una notificación cuando los test pasan.
  • change: envía una notificación cuando el estado cambia.
  • success-change: envía una notificación cuando los test pasen o una vez que fallen.
  • failure-change: envía una notificación cuando los test fallen o una vez que pasen.

preset [string]

Por defecto: 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 [arreglo<string | projectconfig>]

Por defecto: undefined

Cuando la opción projects se le asigna un arreglo de paths o patrones glob, Jest ejecutará pruebas en todos los proyectos especificados a la vez. Esto es ideal para mono-repositorios o cuando se trabaja en múltiples proyectos a la vez.

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

Este ejemplo de configuración ejecuta a Jest en el directorio root así como en cualquier directorio dentro de examples. Se puede tener una cantidad ilimitada de proyectos que se ejecuten por la misma instancia de 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"]
    }
  ]
}

Nota: Cuando se utiliza un ejecutor de multi-proyecto, se recomienda añadir un displayName para cada proyecto. Esto mostrará el displayName de un proyecto junto a sus pruebas.

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

Por defecto: undefined

Se utiliza esta opción para agregar reporters personalizados a Jest. Un reporter personalizado es una clase que implementa los metodos onRunStart, onTestStart, onTestResult,onRunComplete los cuales se ejecutan cuando el evento correspondiente ocurre.

Si se especifican reporters personalizados, los reporters por defecto de Jest serán anulados. Para mantener los reporters por defecto, se debe pasar el argumento default como nombre de un módulo.

Esto anulará a los reporters por defecto:

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

Esto agregará reporters personalizados junto con los reporters por defecto que Jest provee:

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

De manera adicional, los reporters personalizados se pueden configurar pasando como segundo argumento un objeto options:

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

Los módulos de reporters personalizados deben definir una clase que toma la configuración global GlobalConfig y opciones de reporter como argumentos en el constructor:

Ejemplo 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;

Los reporters personalizados pueden forzar a Jest a terminar con un código diferente a cero si regresan un Error en los métodos 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]

Por defecto: false

Automatically reset mock state before every test. Equivalent to calling jest.resetAllMocks() before each test. Esto causa que todos los mocks tengan sus implementaciones falsas removidas sin restaurar su implementación inicial.

resetModules [boolean]

Por defecto: 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. Esto es útil para aislar módulos para cada test, de modo que local de módulos no entre en conflicto en los tests. También se puede obtener el mismo resultado en código usando jest.resetModules().

resolver [string]

Por defecto: undefined

Permite ocupar un resolver diferente. El resolver debe ser un modulo de node que exporte una función. Dicha función debe esperar la ruta a resolver en forma de string como primer argumento, y la siguiente estructura como segundo argumento:

{
  "basedir": string,
  "defaultResolver": "función(petición, opciones)",
  "extensions": [string],
  "moduleDirectory": [string],
  "paths": [string],
  "packageFilter": "function(paquete, directorioDelPaquete)",
  "rootDir": [string]
}

La función debe devolver una ruta al módulo a resolver o un error si no se encuentra dicho módulo.

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;

Al combinar defaultResolver y packageFilter podemos implementar un "preprocesador" para package.json que nos permita cambiar cómo el resolvedor por defecto resolverá módulos. Por ejemplo, imagina que queremos usar el campo "module" si está presente, de lo contrario recurriremos a "main":

{
  ...
  "jest": {
    "resolver": "mi-resolverdor-de-modulos"
  }
}

// paquete mi-resolvedor-de-modulos
module.exports = (peticion, opciones) => {
  // Llama al defaultResolvewr, así que utilizamos su caché, manejo de errores, etc.
  return opciones.defaultResolver(peticion, {
    ...opciones,
    // Usar packageFilter para procesar el `package.json` analizado antes de la resolución (véase https://www. pmjs.com/package/resolve#resolveid-opts-cb)
    packageFilter: paquete => {
      return {
        . .paquete,
        // Cambia el valor de `main` antes de resolver el paquete
        main: paquete.module || paquete.main,
      };
    },
  });
};

restoreMocks[boolean]

Por defecto: 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

El directorio raíz a utilizar por Jest para buscar tests y módulos. Si se desea configurar a Jest dentro del archivo package.json del proyecto y que el directorio raíz apunte al directorio del repositorio del proyecto, el valor de este parámetro tomará como valor por defecto el directorio donde se encuentre el package.json.

Comúnmente esta opción tomará el valor de 'src' o 'lib, dependiendo donde se encuentre el código en el repositorio del proyecto.

Es importante notar que cualquier otra opción que ocupe la cadena <rootDir> hará referencia al valor de esta opción. Por ejemplo, si se desea que la opción setupFiles apunte al archivo env-setup.js ubicado en la raíz del proyecto, se le debe asignar el valor ["<rootDir>/env-setup.js"].

roots [arreglo<string>]

Por defecto: ["<rootDir>"]

Una lista de rutas a directorios que Jest usará para buscar archivos.

Se puede ocupar para casos en donde se desea que Jest busque solamente en un sub-directorio (por ejemplo cuando existe un directorio src/ en el repositorio), y que no acceda al resto del repositorio.

Nota: Mientras que rootDir es ocupado generalmente como una constante en varias opciones de configuración, roots es usado por Jest internamente para encontrar archivos de prueba y de código fuente. This applies also when searching for manual mocks for modules from node_modules (__mocks__ will need to live in one of the roots).

Note: By default, roots has a single entry <rootDir> but there are cases where you may want to have multiple roots within one project, for example roots: ["<rootDir>/src/", "<rootDir>/tests/"].

runner [string]

Por defecto: "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]

Por defecto: []

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. Ya que cada prueba es ejecutada en su propio ambiente, estos scripts serán ejecutados en cada ambiente inmediatamente antes de ejecutar el código de la prueba.

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

setupFilesAfterEnv [array]

Por defecto: []

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. Debido a que setupFiles es ejecutado antes de que se instale el framework de pruebas en el ambiente, este script presenta la oportunidad de ejecutar código inmediatamente después que el framework de pruebas ha sido instalado en el ambiente.

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".

Por ejemplo, Jest contiene diferentes plug-ins de jasmine que se modifican la API de Jasmine sólo en la instancia donde se prueba. 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 [número]

Default: 5

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

snapshotResolver [string]

Por defecto: undefined

The path to a module that can resolve test<->snapshot path. Esta opción de configuración te permite personalizar donde Jest almacena archivos de snapshot en disco.

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 [arreglo<string>]

Por defecto: []

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.

Ejemplo de modulo serializador:

// 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"]
  }
}

Y finalmente, las pruebas se ven así:

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

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

Snapshot producido:

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

Para llamar a una dependencia de manera explicita en lugar de implícita, se puede ocupar expect.addSnapshotSerializer para agregarlo a un sólo archivo de prueba en lugar de agregar la ruta en snapshotSerializers de la configuración de Jest.

More about serializers API can be found here.

testEnvironment [string]

Default: "node"

Ambiente de pruebas a utilizar. 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();
});

Se pueden crear módulos personalizados para preparar un ambiente de pruebas. 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. Normalmente, el corredor de test jest-circus pausa hasta que se resuelva una promesa devuelta de handleTestEvent , excepto para los siguientes eventos: start_describe_definition, finish_describe_definition, add_hook, add_test o error (para la lista actualizada véase el tipo SyncEventen la definición de tipos). 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.

Ejemplo:

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

Por defecto: false

Opciones de ambiente de prueba que serán pasadas a testEnvironment. The relevant options depend on the environment. For example, you can override options given to jsdom such as {userAgent: "Agent/007"}.

testFailureExitCode [number]

Valor por defecto: 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 [arreglo<string>]

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

Patrones glob que Jest usa para detectar archivos. 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). También encontrará archivos llamados test.js o 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 [arreglo<string>]

Por defecto: ["/node_modules/"]

Arreglo de patrones de expresiones regulares regexp con el que se comparan todos los directorios del proyecto antes de la ejecución de pruebas. Cualquier archivo que entre en la expresión será omitido durante el análisis de cobertura.

Estos patrones se comparan contra la ruta completa. Use the <rootDir> string token to include the path to your project's root directory to prevent it from accidentally ignoring all of your files in different environments that may have different root directories. Ejemplo: ["<rootDir>/build/", "<rootDir>/node_modules/"].

testRegex [string | arreglo<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). También encontrará archivos llamados test.js o spec.js. See also testMatch [array<string>], but note that you cannot specify both options.

A continuación se muestra una visualización de la expresión regex por defecto:

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

Nota: testRegex intentará detectar archivos de test usando la ruta absoluta del archivo, por lo tanto, tener una carpeta con un nombre que coincida ejecutará todos los archivos como test

testResultsProcessor [string]

Por defecto: undefined

Esta opción permite el uso de un procesador de resultados personalizado. 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": ruta absoluta al archivo de prueba,
    "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.

El modulo que ejecuta pruebas debe exportar una función con la siguiente estructura:

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

Un ejemplo de tal función puede encontrarse en el modulo por defecto jasmine2.

testSequencer [string]

Default: @jest/test-sequencer

Esta opción te permite usar un secuenciador custom en lugar del default de Jest. sort puede opcionalmente devolver una Promise.

Ejemplo:

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

Esta opción establece la dirección URL para el ambiente jsdom. Se refleja en ciertas propiedades como location.href.

timers [string]

Por defecto: real

Setting this value to legacy or fake allows the use of fake timers for functions such as setTimeout. Los temporalizadores falsos son útiles cuando un fragmento de código establece un largo tiempo de espera que se desea omitir al probar.

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 [objeto<string, rutaAlTransformador| [rutaAlTransformador, objeto]>]

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

Mapa de expresiones regulares que apuntan a rutas de transformers. Un transformer es un modulo que provee una función sincrona para la transformación de archivos de código fuente. 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. Véase 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 [arreglo<string>]

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

Arreglo de patrones de expresiones regulares regexp con el que se comparan todos los directorios de código fuente del proyecto antes de transformarlo. Cualquier archivo que empate con la expresión no será transformado.

Estos patrones se comparan contra la ruta completa. Use the <rootDir> string token to include the path to your project's root directory to prevent it from accidentally ignoring all of your files in different environments that may have different root directories.

Ejemplo: ["<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 [arreglo<string>]

Por defecto: []

Arreglo de expresiones regulares regexp con el que se comparan todos los módulos antes de que el cargador de módulos regrese automáticamente un modulo simulado mock para estos. Cualquier modulo cuya ruta empate con algún patrón en la lista no será simulado automáticamente por el cargador de módulos.

Esto es particularmente útil para modulos de 'utilidad' que se frecuentemente se ocupan para detalles de implementación (como underscore/lo-dash, etc). Es considerado como buena practica minimizar el tamaño de esta lista y utilizar jest.mock()/jest.unmock() en cada prueba de manera individual. Hacer estas llamadas en cada prueba facilita a otros desarrolladores el entender el ambiente en el que se corre cada prueba.

Es posible sobrescribir el valor de esta opción en cada prueba de manera individual llamando jest.mock() al inicio de cada archivo de prueba.

verbose [boolean]

Por defecto: 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 [arreglo<string>]

Por defecto: []

Una serie de modelos RegExp que son comparados con todas los ficheros de origen antes de volver a ejecutar las pruebas en el modo de vigilancia. Cuando se actualice si el fichero del archivo coincide con cualquiera de los patrones, no activará una nueva ejecución de las pruebas.

Estos patrones corresponden a la secuencia entera. Use the <rootDir> string token to include the path to your project's root directory to prevent it from accidentally ignoring all of your files in different environments that may have different root directories. Example: ["<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 [arreglo<string | [string, object]>]

Por defecto: []

Esta opción te permite usar plugins custom para el modo de observación watch. Puedes leer mas de estos plugins aquí.

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

Esta opción permite añadir comentarios en package.json. Incluye el texto del comentario como el valor de esta clave en cualquier lugar en package.json.

Ejemplo:

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