Skip to content
Permalink
Browse files
feat(rules): add no-jasmine-globals (#116)
  • Loading branch information
SimenB committed May 27, 2018
1 parent 523e2f4 commit 7707e1449e44d24de3507c0653fd5f3a9e3c0735
Showing with 399 additions and 0 deletions.
  1. +59 −0 docs/rules/no-jasmine-globals.md
  2. +2 −0 index.js
  3. +224 −0 rules/__tests__/no-jasmine-globals.test.js
  4. +114 −0 rules/no-jasmine-globals.js
@@ -0,0 +1,59 @@
# Disallow Jasmine globals

`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 therefor
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 alternative from Jest's own API.

### Default configuration

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());
});
```
@@ -6,6 +6,7 @@ const noDisabledTests = require('./rules/no-disabled-tests');
const noFocusedTests = require('./rules/no-focused-tests');
const noHooks = require('./rules/no-hooks');
const noIdenticalTitle = require('./rules/no-identical-title');
const noJasmineGlobals = require('./rules/no-jasmine-globals');
const noJestImport = require('./rules/no-jest-import');
const noLargeSnapshots = require('./rules/no-large-snapshots');
const noTestPrefixes = require('./rules/no-test-prefixes');
@@ -69,6 +70,7 @@ module.exports = {
'no-focused-tests': noFocusedTests,
'no-hooks': noHooks,
'no-identical-title': noIdenticalTitle,
'no-jasmine-globals': noJasmineGlobals,
'no-jest-import': noJestImport,
'no-large-snapshots': noLargeSnapshots,
'no-test-prefixes': noTestPrefixes,
@@ -0,0 +1,224 @@
'use strict';

const RuleTester = require('eslint').RuleTester;
const rule = require('../no-jasmine-globals');

const ruleTester = new RuleTester();

ruleTester.run('no-jasmine-globals', rule, {
valid: [
'jest.spyOn()',
'jest.fn()',
'expect.extend()',
'expect.any()',
'it("foo", function () {})',
'test("foo", function () {})',
'foo()',
],
invalid: [
{
code: 'spyOn(some, "object")',
errors: [
{
message: 'Illegal usage of global `spyOn`, prefer `jest.spyOn`',
column: 1,
line: 1,
},
],
},
{
code: 'spyOnProperty(some, "object")',
errors: [
{
message:
'Illegal usage of global `spyOnProperty`, prefer `jest.spyOn`',
column: 1,
line: 1,
},
],
},
{
code: 'fail()',
errors: [
{
message:
'Illegal usage of `fail`, prefer throwing an error, or the `done.fail` callback',
column: 1,
line: 1,
},
],
},
{
code: 'pending()',
errors: [
{
message:
'Illegal usage of `pending`, prefer explicitly skipping a test using `test.skip`',
column: 1,
line: 1,
},
],
},
{
code: 'jasmine.DEFAULT_TIMEOUT_INTERVAL = 5000;',
errors: [
{
message: 'Illegal usage of jasmine global',
column: 1,
line: 1,
},
],
output: 'jest.setTimeout(5000);',
},
{
code: 'jasmine.addMatchers(matchers)',
errors: [
{
message:
'Illegal usage of `jasmine.addMatchers`, prefer `expect.extend`',
column: 1,
line: 1,
},
],
},
{
code: 'jasmine.createSpy()',
errors: [
{
message: 'Illegal usage of `jasmine.createSpy`, prefer `jest.fn`',
column: 1,
line: 1,
},
],
},
{
code: 'jasmine.any()',
errors: [
{
message: 'Illegal usage of `jasmine.any`, prefer `expect.any`',
column: 1,
line: 1,
},
],
output: 'expect.any()',
},
{
code: 'jasmine.anything()',
errors: [
{
message:
'Illegal usage of `jasmine.anything`, prefer `expect.anything`',
column: 1,
line: 1,
},
],
output: 'expect.anything()',
},
{
code: 'jasmine.arrayContaining()',
errors: [
{
message:
'Illegal usage of `jasmine.arrayContaining`, prefer `expect.arrayContaining`',
column: 1,
line: 1,
},
],
output: 'expect.arrayContaining()',
},
{
code: 'jasmine.objectContaining()',
errors: [
{
message:
'Illegal usage of `jasmine.objectContaining`, prefer `expect.objectContaining`',
column: 1,
line: 1,
},
],
output: 'expect.objectContaining()',
},
{
code: 'jasmine.stringMatching()',
errors: [
{
message:
'Illegal usage of `jasmine.stringMatching`, prefer `expect.stringMatching`',
column: 1,
line: 1,
},
],
output: 'expect.stringMatching()',
},
{
code: 'jasmine.getEnv()',
errors: [
{
message: 'Illegal usage of jasmine global',
column: 1,
line: 1,
},
],
},
{
code: 'jasmine.empty()',
errors: [
{
message: 'Illegal usage of jasmine global',
column: 1,
line: 1,
},
],
},
{
code: 'jasmine.falsy()',
errors: [
{
message: 'Illegal usage of jasmine global',
column: 1,
line: 1,
},
],
},
{
code: 'jasmine.truthy()',
errors: [
{
message: 'Illegal usage of jasmine global',
column: 1,
line: 1,
},
],
},
{
code: 'jasmine.arrayWithExactContents()',
errors: [
{
message: 'Illegal usage of jasmine global',
column: 1,
line: 1,
},
],
},
{
code: 'jasmine.clock()',
errors: [
{
message: 'Illegal usage of jasmine global',
column: 1,
line: 1,
},
],
},
{
code: 'jasmine.MAX_PRETTY_PRINT_ARRAY_LENGTH = 42',
errors: [
{
message: 'Illegal usage of jasmine global',
column: 1,
line: 1,
},
],
},
],
});

0 comments on commit 7707e14

Please sign in to comment.