Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ambar/rollup-jest
Rollup preprocessor for Jest
https://github.com/ambar/rollup-jest
jest rollup testing
Last synced: 3 months ago
JSON representation
Rollup preprocessor for Jest
- Host: GitHub
- URL: https://github.com/ambar/rollup-jest
- Owner: ambar
- License: mit
- Created: 2019-01-20T07:41:27.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2023-01-08T17:24:24.000Z (about 2 years ago)
- Last Synced: 2024-10-28T17:21:42.665Z (3 months ago)
- Topics: jest, rollup, testing
- Language: JavaScript
- Homepage:
- Size: 396 KB
- Stars: 18
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# rollup-jest
Rollup preprocessor for Jest.
[](https://coveralls.io/github/ambar/rollup-jest?branch=master)
[](https://www.npmjs.com/package/rollup-jest)
## Install
```bash
npm install rollup-jest rollup --save-dev
```
## Usage
Add preset to Jest config:
```json
{
"jest": {
"preset": "rollup-jest"
}
}
// alternatively, specifying the files to transform:
{
"jest": {
"transform": {
"\\.m?js$": "rollup-jest"
},
}
}
// or with options:
// the preset enables sourcemaps by default
{
"jest": {
"transform": {
"\\.m?js$": ["rollup-jest", {"output": {"sourcemap": true}}]
},
}
}
```
Write your tests with ES modules:
```js
import path from 'path'
test('parses extname', () => {
expect(path.extname('foo.md')).toBe('.md')
})
```
Happy testing!
## Configuration
### Use `configFile` field
NOTE: To use ESM format `configFile` in Rollup v3, you should add `--experimental-vm-module` flag to run jest，eg. `NODE_OPTIONS=--experimental-vm-modules npm run test`
```json
{
"jest": {
"transform": {
"\\.js$": ["rollup-jest", {"configFile": "./rollup.config.js"}]
}
}
}
```
`rollup.config.js`:
```js
import inject from '@rollup/plugin-inject'
let config = {}
if (process.env.NODE_ENV === 'test') {
config = {
plugins: [inject({React: 'react'})],
}
}
export default config
```
### Use inline config
```json
{
"jest": {
"transform": {
"\\.js$": [
"rollup-jest",
{"plugins": [["@rollup/plugin-inject", {"React": "react"}]]}
]
}
}
}
```
### All options
- `useCache: boolean`: Default `true`. Enable caching of entry module. This can mess with plugins (e.g. typescript).
- `resolveImports: 'relative' | boolean`: Default `false`. Resolve (bundle) imports, either all (incl. packages) or only relative files.
- `args: any`: If your config file exports a function, you can use this field to pass arguments that aren't supported in rollup's `inputOptions`.
- `plugins: Plugin[]`: Gets merged with plugins from config file. Special syntax `[name, options]` allows you to specify the plugin in json without `require`.
## Related
- [es-jest](https://github.com/ambar/es-jest)
- [babel-jest](https://github.com/facebook/jest/tree/master/packages/babel-jest)
- [ts-jest](https://github.com/kulshekhar/ts-jest)