ts-jest
Version:
A preprocessor with source maps support to help use TypeScript with Jest
530 lines • 22.7 kB
JSON
{
"docusaurus-plugin-content-docs": {
"default": {
"loadedVersions": [
{
"versionName": "current",
"versionLabel": "Next",
"versionPath": "/ts-jest/docs",
"isLast": true,
"routePriority": -1,
"sidebarFilePath": "/Users/ahn/ts-jest/website/sidebars.js",
"docsDirPath": "/Users/ahn/ts-jest/website/docs",
"docsDirPathLocalized": "/Users/ahn/ts-jest/website/i18n/en/docusaurus-plugin-content-docs/current",
"mainDocId": "installation",
"sidebars": {
"docs": [
{
"type": "doc",
"id": "installation"
},
{
"collapsed": true,
"type": "category",
"label": "Configuration",
"items": [
{
"type": "doc",
"id": "presets"
},
{
"type": "doc",
"id": "paths-mapping"
},
{
"type": "doc",
"id": "options"
},
{
"type": "doc",
"id": "version-checking"
}
]
},
{
"collapsed": true,
"type": "category",
"label": "Guides",
"items": [
{
"type": "doc",
"id": "test-helpers"
},
{
"type": "doc",
"id": "esm-support"
},
{
"type": "doc",
"id": "react-native"
},
{
"type": "doc",
"id": "troubleshooting"
}
]
},
{
"type": "doc",
"id": "babel7-or-ts"
},
{
"type": "doc",
"id": "migration"
},
{
"type": "doc",
"id": "debugging"
},
{
"collapsed": true,
"type": "category",
"label": "How it works",
"items": [
{
"type": "doc",
"id": "processing"
},
{
"type": "doc",
"id": "e2e-testing"
}
]
}
]
},
"permalinkToSidebar": {
"/ts-jest/docs/babel7-or-ts": "docs",
"/ts-jest/docs/debugging": "docs",
"/ts-jest/docs/e2e-testing": "docs",
"/ts-jest/docs/esm-support": "docs",
"/ts-jest/docs/installation": "docs",
"/ts-jest/docs/migration": "docs",
"/ts-jest/docs/options": "docs",
"/ts-jest/docs/paths-mapping": "docs",
"/ts-jest/docs/presets": "docs",
"/ts-jest/docs/processing": "docs",
"/ts-jest/docs/react-native": "docs",
"/ts-jest/docs/test-helpers": "docs",
"/ts-jest/docs/troubleshooting": "docs",
"/ts-jest/docs/version-checking": "docs"
},
"docs": [
{
"unversionedId": "babel7-or-ts",
"id": "babel7-or-ts",
"isDocsHomePage": false,
"title": "Babel7 or TypeScript",
"description": "In Sept. 2018 Babel7 got released with an interesting preset: @babel/preset-typescript.",
"source": "@site/docs/babel7-or-ts.md",
"slug": "/babel7-or-ts",
"permalink": "/ts-jest/docs/babel7-or-ts",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/babel7-or-ts.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Troubleshooting",
"permalink": "/ts-jest/docs/troubleshooting"
},
"next": {
"title": "Migration from <=23.10",
"permalink": "/ts-jest/docs/migration"
}
},
{
"unversionedId": "contribution",
"id": "contribution",
"isDocsHomePage": false,
"title": "contribution",
"description": "",
"source": "@site/docs/contribution.md",
"slug": "/contribution",
"permalink": "/ts-jest/docs/contribution",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/contribution.md",
"version": "current"
},
{
"unversionedId": "debugging",
"id": "debugging",
"isDocsHomePage": false,
"title": "Debugging ts-jest",
"description": "You can activate the debug logger by setting the environment variable TSJESTLOG before running tests.",
"source": "@site/docs/debugging.md",
"slug": "/debugging",
"permalink": "/ts-jest/docs/debugging",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/debugging.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Migration from <=23.10",
"permalink": "/ts-jest/docs/migration"
},
"next": {
"title": "Jest flow",
"permalink": "/ts-jest/docs/processing"
}
},
{
"unversionedId": "e2e-testing",
"id": "e2e-testing",
"isDocsHomePage": false,
"title": "E2E tests flow",
"description": "These are internal technical documents. If you're not a contributor to ts-jest, but simply trying to use the library you'll find nothing of value here",
"source": "@site/docs/e2e-testing.md",
"slug": "/e2e-testing",
"permalink": "/ts-jest/docs/e2e-testing",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/e2e-testing.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Jest flow",
"permalink": "/ts-jest/docs/processing"
}
},
{
"unversionedId": "esm-support",
"id": "esm-support",
"isDocsHomePage": false,
"title": "ESM Support",
"description": "To use ts-jest with ESM support, you'll first need to check ESM Jest documentation.",
"source": "@site/docs/esm-support.md",
"slug": "/esm-support",
"permalink": "/ts-jest/docs/esm-support",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/esm-support.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Test helpers",
"permalink": "/ts-jest/docs/test-helpers"
},
"next": {
"title": "Using with React Native",
"permalink": "/ts-jest/docs/react-native"
}
},
{
"unversionedId": "installation",
"id": "installation",
"isDocsHomePage": false,
"title": "Installation",
"description": "ts-jest is a Typescript preprocessor for Jest pre-processor. You'll need both Jest and TypeScript installed inside your project.",
"source": "@site/docs/installation.md",
"slug": "/installation",
"permalink": "/ts-jest/docs/installation",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/installation.md",
"version": "current",
"sidebar": "docs",
"next": {
"title": "Presets",
"permalink": "/ts-jest/docs/presets"
}
},
{
"unversionedId": "migration",
"id": "migration",
"isDocsHomePage": false,
"title": "Migration from <=23.10",
"description": "You can use the config:migrate tool of ts-jest CLI if you're coming from an older version to help you migrate your Jest configuration.",
"source": "@site/docs/migration.md",
"slug": "/migration",
"permalink": "/ts-jest/docs/migration",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/migration.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Babel7 or TypeScript",
"permalink": "/ts-jest/docs/babel7-or-ts"
},
"next": {
"title": "Debugging ts-jest",
"permalink": "/ts-jest/docs/debugging"
}
},
{
"unversionedId": "options",
"id": "options",
"isDocsHomePage": false,
"title": "Options",
"description": "Introduction",
"source": "@site/docs/options.md",
"slug": "/options",
"permalink": "/ts-jest/docs/options",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/options.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Paths mapping",
"permalink": "/ts-jest/docs/paths-mapping"
},
"next": {
"title": "Version checking",
"permalink": "/ts-jest/docs/version-checking"
}
},
{
"unversionedId": "options/astTransformers",
"id": "options/astTransformers",
"isDocsHomePage": false,
"title": "AST transformers option",
"description": "ts-jest by default does hoisting for a few jest methods via a TypeScript AST transformer. One can also create custom",
"source": "@site/docs/options/astTransformers.md",
"slug": "/options/astTransformers",
"permalink": "/ts-jest/docs/options/astTransformers",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/options/astTransformers.md",
"version": "current"
},
{
"unversionedId": "options/babelConfig",
"id": "options/babelConfig",
"isDocsHomePage": false,
"title": "Babel Config option",
"description": "ts-jest by default does NOT use Babel. But you may want to use it, especially if your code rely on Babel plugins to make some transformations. ts-jest can call the BabelJest processor once TypeScript has transformed the source into JavaScript.",
"source": "@site/docs/options/babelConfig.md",
"slug": "/options/babelConfig",
"permalink": "/ts-jest/docs/options/babelConfig",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/options/babelConfig.md",
"version": "current"
},
{
"unversionedId": "options/compiler",
"id": "options/compiler",
"isDocsHomePage": false,
"title": "Compiler option",
"description": "The compiler option allows you to define the compiler to be used. It'll be used to load the NodeJS module holding the TypeScript compiler.",
"source": "@site/docs/options/compiler.md",
"slug": "/options/compiler",
"permalink": "/ts-jest/docs/options/compiler",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/options/compiler.md",
"version": "current"
},
{
"unversionedId": "options/diagnostics",
"id": "options/diagnostics",
"isDocsHomePage": false,
"title": "Diagnostics option",
"description": "The diagnostics option configures error reporting.",
"source": "@site/docs/options/diagnostics.md",
"slug": "/options/diagnostics",
"permalink": "/ts-jest/docs/options/diagnostics",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/options/diagnostics.md",
"version": "current"
},
{
"unversionedId": "options/isolatedModules",
"id": "options/isolatedModules",
"isDocsHomePage": false,
"title": "Isolated Modules option",
"description": "By default ts-jest uses TypeScript compiler in the context of a project (yours), with full type-checking and features.",
"source": "@site/docs/options/isolatedModules.md",
"slug": "/options/isolatedModules",
"permalink": "/ts-jest/docs/options/isolatedModules",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/options/isolatedModules.md",
"version": "current"
},
{
"unversionedId": "options/stringifyContentPathRegex",
"id": "options/stringifyContentPathRegex",
"isDocsHomePage": false,
"title": "Stringify content option",
"description": "The stringifyContentPathRegex option has been kept for backward compatibility of HTML_TRANSFORM",
"source": "@site/docs/options/stringifyContentPathRegex.md",
"slug": "/options/stringifyContentPathRegex",
"permalink": "/ts-jest/docs/options/stringifyContentPathRegex",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/options/stringifyContentPathRegex.md",
"version": "current"
},
{
"unversionedId": "options/tsconfig",
"id": "options/tsconfig",
"isDocsHomePage": false,
"title": "TypeScript Config option",
"description": "The tsconfig option allows you to define which tsconfig JSON file to use. An inline compiler options object can also be specified instead of a file path.",
"source": "@site/docs/options/tsconfig.md",
"slug": "/options/tsconfig",
"permalink": "/ts-jest/docs/options/tsconfig",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/options/tsconfig.md",
"version": "current"
},
{
"unversionedId": "options/useESM",
"id": "options/useESM",
"isDocsHomePage": false,
"title": "useESM option",
"description": "The useESM option allows ts-jest to transform codes to ESM syntax if possible.",
"source": "@site/docs/options/useESM.md",
"slug": "/options/useESM",
"permalink": "/ts-jest/docs/options/useESM",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/options/useESM.md",
"version": "current"
},
{
"unversionedId": "paths-mapping",
"id": "paths-mapping",
"isDocsHomePage": false,
"title": "Paths mapping",
"description": "If you use \"baseUrl\" and \"paths\" options in your tsconfig file, you should make sure the \"moduleNameMapper\" option in your Jest config is setup accordingly.",
"source": "@site/docs/paths-mapping.md",
"slug": "/paths-mapping",
"permalink": "/ts-jest/docs/paths-mapping",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/paths-mapping.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Presets",
"permalink": "/ts-jest/docs/presets"
},
"next": {
"title": "Options",
"permalink": "/ts-jest/docs/options"
}
},
{
"unversionedId": "presets",
"id": "presets",
"isDocsHomePage": false,
"title": "Presets",
"description": "The presets",
"source": "@site/docs/presets.md",
"slug": "/presets",
"permalink": "/ts-jest/docs/presets",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/presets.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Installation",
"permalink": "/ts-jest/docs/installation"
},
"next": {
"title": "Paths mapping",
"permalink": "/ts-jest/docs/paths-mapping"
}
},
{
"unversionedId": "processing",
"id": "processing",
"isDocsHomePage": false,
"title": "Jest flow",
"description": "These are internal technical documents. If you're not a contributor to ts-jest, but simply trying to use the library you'll find nothing of value here",
"source": "@site/docs/processing.md",
"slug": "/processing",
"permalink": "/ts-jest/docs/processing",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/processing.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Debugging ts-jest",
"permalink": "/ts-jest/docs/debugging"
},
"next": {
"title": "E2E tests flow",
"permalink": "/ts-jest/docs/e2e-testing"
}
},
{
"unversionedId": "react-native",
"id": "react-native",
"isDocsHomePage": false,
"title": "Using with React Native",
"description": "To use ts-jest with React Native + TypeScript and Babel 7, you'll first need to follow this tutorial.",
"source": "@site/docs/react-native.md",
"slug": "/react-native",
"permalink": "/ts-jest/docs/react-native",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/react-native.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "ESM Support",
"permalink": "/ts-jest/docs/esm-support"
},
"next": {
"title": "Troubleshooting",
"permalink": "/ts-jest/docs/troubleshooting"
}
},
{
"unversionedId": "test-helpers",
"id": "test-helpers",
"isDocsHomePage": false,
"title": "Test helpers",
"description": "ts-jest provides some test utilities to be used in your test, related to TypeScript.",
"source": "@site/docs/test-helpers.md",
"slug": "/test-helpers",
"permalink": "/ts-jest/docs/test-helpers",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/test-helpers.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Version checking",
"permalink": "/ts-jest/docs/version-checking"
},
"next": {
"title": "ESM Support",
"permalink": "/ts-jest/docs/esm-support"
}
},
{
"unversionedId": "troubleshooting",
"id": "troubleshooting",
"isDocsHomePage": false,
"title": "Troubleshooting",
"description": "You can check Jest troubleshooting guide or visit ts-jest [troubleshooting",
"source": "@site/docs/troubleshooting.md",
"slug": "/troubleshooting",
"permalink": "/ts-jest/docs/troubleshooting",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/troubleshooting.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Using with React Native",
"permalink": "/ts-jest/docs/react-native"
},
"next": {
"title": "Babel7 or TypeScript",
"permalink": "/ts-jest/docs/babel7-or-ts"
}
},
{
"unversionedId": "version-checking",
"id": "version-checking",
"isDocsHomePage": false,
"title": "Version checking",
"description": "By default, ts-jest supports a range of versions for jest/typescript. One uses incompatible versions will receive a warning",
"source": "@site/docs/version-checking.md",
"slug": "/version-checking",
"permalink": "/ts-jest/docs/version-checking",
"editUrl": "https://github.com/kulshekhar/ts-jest/edit/master/docs/docs/version-checking.md",
"version": "current",
"sidebar": "docs",
"previous": {
"title": "Options",
"permalink": "/ts-jest/docs/options"
},
"next": {
"title": "Test helpers",
"permalink": "/ts-jest/docs/test-helpers"
}
}
]
}
]
}
},
"docusaurus-plugin-content-blog": {
"default": null
},
"docusaurus-plugin-content-pages": {
"default": [
{
"type": "jsx",
"permalink": "/ts-jest/",
"source": "@site/src/pages/index.js"
}
]
},
"docusaurus-plugin-debug": {
"default": null
},
"docusaurus-theme-classic": {
"default": null
}
}