68 lines
1.5 KiB
Markdown
68 lines
1.5 KiB
Markdown
|
# Disallow Jasmine globals (`no-jasmine-globals`)
|
||
|
|
|
||
|
|
💼 This rule is enabled in the ✅ `recommended`
|
||
|
|
[config](https://github.com/jest-community/eslint-plugin-jest/blob/main/README.md#shareable-configurations).
|
||
|
|
|
||
|
|
🔧 This rule is automatically fixable by the
|
||
|
|
[`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
|
||
|
|
|
||
|
|
<!-- end auto-generated rule header -->
|
||
|
|
|
||
|
|
`jest` uses `jasmine` as a test runner. A side effect of this is that both a
|
||
|
|
`jasmine` object, and some jasmine-specific globals, are exposed to the test
|
||
|
|
environment. Most functionality offered by Jasmine has been ported to Jest, and
|
||
|
|
the Jasmine globals will stop working in the future. Developers should therefore
|
||
|
|
migrate to Jest's documented API instead of relying on the undocumented Jasmine
|
||
|
|
API.
|
||
|
|
|
||
|
|
## Rule details
|
||
|
|
|
||
|
|
This rule reports on any usage of Jasmine globals, which is not ported to Jest,
|
||
|
|
and suggests alternatives from Jest's own API.
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
The following patterns are considered warnings:
|
||
|
|
|
||
|
|
```js
|
||
|
|
jasmine.DEFAULT_TIMEOUT_INTERVAL = 5000;
|
||
|
|
|
||
|
|
test('my test', () => {
|
||
|
|
pending();
|
||
|
|
});
|
||
|
|
|
||
|
|
test('my test', () => {
|
||
|
|
fail();
|
||
|
|
});
|
||
|
|
|
||
|
|
test('my test', () => {
|
||
|
|
spyOn(some, 'object');
|
||
|
|
});
|
||
|
|
|
||
|
|
test('my test', () => {
|
||
|
|
jasmine.createSpy();
|
||
|
|
});
|
||
|
|
|
||
|
|
test('my test', () => {
|
||
|
|
expect('foo').toEqual(jasmine.anything());
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
The following patterns would not be considered warnings:
|
||
|
|
|
||
|
|
```js
|
||
|
|
jest.setTimeout(5000);
|
||
|
|
|
||
|
|
test('my test', () => {
|
||
|
|
jest.spyOn(some, 'object');
|
||
|
|
});
|
||
|
|
|
||
|
|
test('my test', () => {
|
||
|
|
jest.fn();
|
||
|
|
});
|
||
|
|
|
||
|
|
test('my test', () => {
|
||
|
|
expect('foo').toEqual(expect.anything());
|
||
|
|
});
|
||
|
|
```
|