Consistent-test-it rule #64
Conversation
README.md
Outdated
| @@ -80,6 +80,7 @@ for more information about extending configuration files. | |||
|
|
|||
| | Rule | Description | Recommended | Fixable | | |||
| | ------------------------------------------------------------------ | --------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------- | | |||
| | [consistent-test-it](docs/rules/consistent-test-it.md) | Enforce consistent test or it keyword |  |  | | |||
rules/consistent-test-it.js
Outdated
|
|
||
| context.report({ | ||
| message: | ||
| "Prefer using '{{ testKeyword }}' on '{{ opositeTestKeyword }}'", |
There was a problem hiding this comment.
Switch "on" with "instead of" perhaps?
There was a problem hiding this comment.
I agree, "instead of" is better.
rules/consistent-test-it.js
Outdated
| @@ -0,0 +1,124 @@ | |||
| 'use strict'; | |||
|
|
|||
| const { getNodeName, isTestCase, isDescribe } = require('./util'); | |||
There was a problem hiding this comment.
cannot use destructuring due to node 4 support - see failing CI
There was a problem hiding this comment.
May be worth adding the es5/no-destructuring rule to help prevent/communicate this.
There was a problem hiding this comment.
Opened #66 to address this.
There was a problem hiding this comment.
Yes, I see, Will be fixed
rules/consistent-test-it.js
Outdated
| ], | ||
| }, | ||
| create(context) { | ||
| const configObj = context.options[0]; |
There was a problem hiding this comment.
I think you could declare this like:
const configObj = context.options[0] || {}And then you're always dealing with a truthy object, so that on the following lines, you do not need to call configObj && configObj.propertyName.
There was a problem hiding this comment.
I agree about that. Thanks
rules/consistent-test-it.js
Outdated
| describeNestingLevel === 0 && | ||
| nodeName.indexOf(testKeyword) === -1 | ||
| ) { | ||
| const opositeTestKeyword = getOpositeTestKeyword(testKeyword); |
There was a problem hiding this comment.
oposite is misspelled - should be opposite.
rules/consistent-test-it.js
Outdated
| }, | ||
| }; | ||
|
|
||
| function getPreferedNodeName(nodeName, preferedTestKeyword) { |
There was a problem hiding this comment.
prefered is mispelled - should be preferred.
| const testKeyword = configObj.fn || 'test'; | ||
| const testKeywordWithinDescribe = | ||
| configObj.withinDescribe || configObj.fn || 'it'; | ||
|
|
There was a problem hiding this comment.
This top part is missing some coverage, mind adding the necessary tests to cover all cases?
| valid: [ | ||
| { | ||
| code: 'test("foo")', | ||
| options: [{ fn: 'test', withinDescribe: 'it' }], |
There was a problem hiding this comment.
I think removing options here is enough to get to 100% coverage 🙂
There was a problem hiding this comment.
Yes, you are right :) will push fix soon
|
@SimenB Thanks for the comment. |
Following the discussion in #12
Summary
This rule gives you control over the usage of these keywords in your codebase.
You can control which style you prefer, within describe or outside.
{"fn": "it"}enforceitcalls and fixtestto beit.{"fn": "test"}enforetestcalls and fixitto betest.{"fn": "test", "withinDescribe":"it"}enforceteston top level tests and enforceitwhen nested inside ofdescribe, fixittotestwhen using in top level, fixtesttoitwhen using inside ofdescribe.