|
| 1 | +--- |
| 2 | +id: code-transformation |
| 3 | +title: Code Transformation |
| 4 | +--- |
| 5 | + |
| 6 | +Jest runs the code in your project as JavaScript, but if you use some syntax not supported by Node.js out of the box (such as JSX, types from TypeScript, Vue templates etc.) then you'll need to transform that code into plain JavaScript, similar to what you would do when building for browsers. |
| 7 | + |
| 8 | +Jest supports this via the [`transform` configuration option](Configuration.md#transform-objectstring-pathtotransformer--pathtotransformer-object). |
| 9 | + |
| 10 | +A transformer is a module that provides a synchronous function for transforming source files. 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. |
| 11 | + |
| 12 | +Jest will cache the result of a transformation and attempt to invalidate that result based on a number of factors, such as the source of the file being transformed and changing configuration. |
| 13 | + |
| 14 | +## Defaults |
| 15 | + |
| 16 | +Jest ships with one transformer out of the box - `babel-jest`. It will automatically load your project's Babel configuration and transform any file matching the following RegEx: `/\.[jt]sx?$/` meaning any `.js`, `.jsx`, `.ts` and `.tsx` file. In addition, `babel-jest` will inject the Babel plugin necessary for mock hoisting talked about in [ES Module mocking](ManualMocks.md#using-with-es-module-imports). |
| 17 | + |
| 18 | +If you override the `transform` configuration option `babel-jest` will no longer be active, and you'll need to add it manually if you wish to use Babel. |
| 19 | + |
| 20 | +## Writing custom transformers |
| 21 | + |
| 22 | +You can write you own transformer. The API of a transformer is as follows: |
| 23 | + |
| 24 | +```ts |
| 25 | +interface Transformer<OptionType = unknown> { |
| 26 | + /** |
| 27 | + * Indicates if the transformer is capabale of instrumenting the code for code coverage. |
| 28 | + * |
| 29 | + * If V8 coverage is _not_ active, and this is `true`, Jest will assume the code is instrumented. |
| 30 | + * If V8 coverage is _not_ active, and this is `false`. Jest will instrument the code returned by this transformer using Babel. |
| 31 | + */ |
| 32 | + canInstrument?: boolean; |
| 33 | + createTransformer?: (options?: OptionType) => Transformer; |
| 34 | + |
| 35 | + getCacheKey?: ( |
| 36 | + sourceText: string, |
| 37 | + sourcePath: string, |
| 38 | + options: TransformOptions, |
| 39 | + ) => string; |
| 40 | + |
| 41 | + process: ( |
| 42 | + sourceText: string, |
| 43 | + sourcePath: string, |
| 44 | + options: TransformOptions, |
| 45 | + ) => TransformedSource; |
| 46 | +} |
| 47 | + |
| 48 | +interface TransformOptions { |
| 49 | + config: Config.ProjectConfig; |
| 50 | + /** A stringified version of the configuration - useful in cache busting */ |
| 51 | + configString: string; |
| 52 | + instrument: boolean; |
| 53 | + // names are copied from babel: https://babeljs.io/docs/en/options#caller |
| 54 | + supportsDynamicImport: boolean; |
| 55 | + supportsExportNamespaceFrom: boolean; |
| 56 | + supportsStaticESM: boolean; |
| 57 | + supportsTopLevelAwait: boolean; |
| 58 | +} |
| 59 | + |
| 60 | +type TransformedSource = |
| 61 | + | {code: string; map?: RawSourceMap | string | null} |
| 62 | + | string; |
| 63 | + |
| 64 | +// Config.ProjectConfig can be seen in in code [here](https://github.com/facebook/jest/blob/v26.6.3/packages/jest-types/src/Config.ts#L323) |
| 65 | +// RawSourceMap comes from [`source-map`](https://github.com/mozilla/source-map/blob/0.6.1/source-map.d.ts#L6-L12) |
| 66 | +``` |
| 67 | + |
| 68 | +As can be seen, only `process` is mandatory to implement, although we highly recommend implementing `getCacheKey` as well, so we don't waste resources transpiling the same source file when we can read its previous result from disk. You can use [`@jest/create-cache-key-function`](https://www.npmjs.com/package/@jest/create-cache-key-function) to help implement it. |
| 69 | + |
| 70 | +Note that [ECMAScript module](ECMAScriptModules.md) support is indicated by the passed in `supports*` options. Specifically `supportsDynamicImport: true` means the transformer can return `import()` expressions, which is supported by both ESM and CJS. If `supportsStaticESM: true` it means top level `import` statements are supported and the code will be interpreted as ESM and not CJS. See [Node's docs](https://nodejs.org/api/esm.html#esm_differences_between_es_modules_and_commonjs) for details on the differences. |
| 71 | + |
| 72 | +### Examples |
| 73 | + |
| 74 | +### TypeScript with type checking |
| 75 | + |
| 76 | +While `babel-jest` by default will transpile TypeScript files, Babel will not verify the types. If you want that you can use [`ts-jest`](https://github.com/kulshekhar/ts-jest). |
| 77 | + |
| 78 | +#### Transforming images to their path |
| 79 | + |
| 80 | +Importing images is a way to include them in your browser bundle, but they are not valid JavaScript. One way of handling it in Jest is to replace the imported value with its filename. |
| 81 | + |
| 82 | +```js |
| 83 | +// fileTransformer.js |
| 84 | +const path = require('path'); |
| 85 | + |
| 86 | +module.exports = { |
| 87 | + process(src, filename, config, options) { |
| 88 | + return 'module.exports = ' + JSON.stringify(path.basename(filename)) + ';'; |
| 89 | + }, |
| 90 | +}; |
| 91 | +``` |
| 92 | + |
| 93 | +```js |
| 94 | +// jest.config.js |
| 95 | + |
| 96 | +module.exports = { |
| 97 | + transform: { |
| 98 | + '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': |
| 99 | + '<rootDir>/fileTransformer.js', |
| 100 | + }, |
| 101 | +}; |
| 102 | +``` |
0 commit comments