New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(rules): add prefer-strict-equal #134
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# Suggest using `toStrictEqual()` (prefer-strict-equal) | ||
|
||
`toStrictEqual` not only checks that two objects contain the same data but also | ||
that they have the same shape. The believe is that imposing a stricter equality | ||
results in safer tests. | ||
|
||
## Rule details | ||
|
||
This rule triggers a warning if `toEqual()` is used to assert equality. | ||
|
||
This rule is enabled by default. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. no it's not 🙂 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks, addressed in a7ca3b2 |
||
|
||
### Default configuration | ||
|
||
The following pattern is considered warning: | ||
|
||
```js | ||
expect({ a: 'a', b: undefined }).toEqual({ a: 'a' }); // true | ||
``` | ||
|
||
The following pattern is not warning: | ||
|
||
```js | ||
expect({ a: 'a', b: undefined }).toStrictEqual({ a: 'a' }); // false | ||
``` |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
'use strict'; | ||
|
||
const RuleTester = require('eslint').RuleTester; | ||
const rule = require('../prefer-strict-equal'); | ||
|
||
const ruleTester = new RuleTester(); | ||
|
||
ruleTester.run('prefer-strict-equal', rule, { | ||
valid: ['expect(something).toStrictEqual(somethingElse);'], | ||
invalid: [ | ||
{ | ||
code: 'expect(something).toEqual(somethingElse);', | ||
errors: [ | ||
{ | ||
message: 'Use toStrictEqual() instead', | ||
column: 19, | ||
line: 1, | ||
}, | ||
], | ||
output: 'expect(something).toStrictEqual(somethingElse);', | ||
}, | ||
], | ||
}); |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
'use strict'; | ||
|
||
const getDocsUrl = require('./util').getDocsUrl; | ||
|
||
module.exports = { | ||
meta: { | ||
docs: { | ||
url: getDocsUrl(__filename), | ||
}, | ||
fixable: 'code', | ||
}, | ||
create(context) { | ||
return { | ||
CallExpression(node) { | ||
const propertyName = node.callee.property && node.callee.property.name; | ||
if (propertyName === 'toEqual') { | ||
context.report({ | ||
fix(fixer) { | ||
return [fixer.replaceText(node.callee.property, 'toStrictEqual')]; | ||
}, | ||
message: 'Use toStrictEqual() instead', | ||
node: node.callee.property, | ||
}); | ||
} | ||
}, | ||
}; | ||
}, | ||
}; |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"The believe is that" sounds odd. Could you re-phrase?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tweaked and expanded on this a bit in a7ca3b2