51 lines
1.2 KiB
Markdown
51 lines
1.2 KiB
Markdown
|
# Disallow using `exports` in files containing tests (`no-export`)
|
||
|
|
|
||
|
|
💼 This rule is enabled in the ✅ `recommended`
|
||
|
|
[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
|
||
|
|
|
||
|
|
<!-- end auto-generated rule header -->
|
||
|
|
|
||
|
|
Prevents using `exports` if a file has one or more tests in it.
|
||
|
|
|
||
|
|
## Rule details
|
||
|
|
|
||
|
|
This rule aims to eliminate duplicate runs of tests by exporting things from
|
||
|
|
test files. If you import from a test file, then all the tests in that file will
|
||
|
|
be run in each imported instance, so bottom line, don't export from a test, but
|
||
|
|
instead move helper functions into a separate file when they need to be shared
|
||
|
|
across tests.
|
||
|
|
|
||
|
|
Examples of **incorrect** code for this rule:
|
||
|
|
|
||
|
|
```js
|
||
|
|
export function myHelper() {}
|
||
|
|
|
||
|
|
module.exports = function () {};
|
||
|
|
|
||
|
|
module.exports = {
|
||
|
|
something: 'that should be moved to a non-test file',
|
||
|
|
};
|
||
|
|
|
||
|
|
describe('a test', () => {
|
||
|
|
expect(1).toBe(1);
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
Examples of **correct** code for this rule:
|
||
|
|
|
||
|
|
```js
|
||
|
|
function myHelper() {}
|
||
|
|
|
||
|
|
const myThing = {
|
||
|
|
something: 'that can live here',
|
||
|
|
};
|
||
|
|
|
||
|
|
describe('a test', () => {
|
||
|
|
expect(1).toBe(1);
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
## When Not To Use It
|
||
|
|
|
||
|
|
Don't use this rule on non-jest test files.
|