webhook-action/node_modules/eslint-plugin-jest/docs/rules/no-mocks-import.md
2022-11-10 20:43:16 +10:00

33 lines
932 B
Markdown

# Disallow manually importing from `__mocks__` (`no-mocks-import`)
💼 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 -->
When using `jest.mock`, your tests (just like the code being tested) should
import from `./x`, not `./__mocks__/x`. Not following this rule can lead to
confusion, because you will have multiple instances of the mocked module:
```js
jest.mock('./x');
const x1 = require('./x');
const x2 = require('./__mocks__/x');
test('x', () => {
expect(x1).toBe(x2); // fails! They are both instances of `./__mocks__/x`, but not referentially equal
});
```
## Rule details
This rule reports imports from a path containing a `__mocks__` component.
Example violations:
```js
import thing from './__mocks__/index';
require('./__mocks__/index');
require('__mocks__');
```