feat: adds no jest import rule #95
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ranyitz
reviewed
Mar 2, 2018
docs/rules/no-jest-import.md
Outdated
| @@ -0,0 +1,20 @@ | |||
| # Disallow importing Jest(no-jest-import) | |||
|
|
|||
| The jest object is automatically in scope within every test file. The methods in | |||
There was a problem hiding this comment.
Use a code block for the jest object.
docs/rules/no-jest-import.md
Outdated
|
|
||
| The jest object is automatically in scope within every test file. The methods in | ||
| the jest object help create mocks and let you control Jest's overall behavior. | ||
| It is therefore completely unnecessary to import in Jest, as Jest doesn't export |
There was a problem hiding this comment.
I would change Jest to jest here, as you refer to the object.
docs/rules/no-jest-import.md
Outdated
|
|
||
| This rule reports on any importing of Jest. | ||
|
|
||
| To name a few: *var jest = require('jest'); *const jest = require('jest'); |
There was a problem hiding this comment.
Maybe use code blocks here?
var jest = require('jest');const jest = require('jest');import jest from 'jest';import {jest as test} from 'jest';
docs/rules/no-jest-import.md
Outdated
| To name a few: *var jest = require('jest'); *const jest = require('jest'); | ||
| *import jest from 'jest'; *import {jest as test} from 'jest'; | ||
|
|
||
| There is no correct usage of this code, other than to not import Jest it in the |
rules/no-jest-import.js
Outdated
| if (node.source.value === 'jest') { | ||
| context.report({ | ||
| node, | ||
| message: `Jest is automatically in scope. Do not import Jest, as it doesn't export anything.`, |
There was a problem hiding this comment.
The message can be moved into a variable so you won't write it twice.
SimenB
reviewed
Mar 3, 2018
index.js
Outdated
| @@ -29,6 +30,7 @@ module.exports = { | |||
| 'jest/no-disabled-tests': 'warn', | |||
| 'jest/no-focused-tests': 'error', | |||
| 'jest/no-identical-title': 'error', | |||
| 'jest/no-jest-import': 'error', | |||
There was a problem hiding this comment.
technically breaking to add it here, mind removing it?
|
@ranyitz thanks for reviewing! 😀 |
SimenB
force-pushed
the
feat/nojestimportrule
branch
from
88413a0
to
52b3494
Compare
This was referenced Mar 6, 2018
This was referenced Mar 14, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #90.
Adds the eslint rule 'no-jest-import', disallowing any import from Jest.
Adds tests and documentation for rule.