forked from jest-community/eslint-plugin-jest
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(rules): prefer valid-title (jest-community#273)
- Loading branch information
Showing
4 changed files
with
291 additions
and
0 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# Disallow duplicate setup and teardown hooks (no-duplicate-hooks) | ||
|
||
A describe/ test block should not contain accidentalSpace or duplicatePrefix. | ||
|
||
## Rule Details | ||
|
||
**duplicatePrefix** | ||
|
||
A describe/ test block should not start with duplicatePrefix | ||
|
||
Examples of **incorrect** code for this rule | ||
|
||
```js | ||
test('test foo', () => {}); | ||
it('it foo', () => {}); | ||
|
||
describe('foo', () => { | ||
test('test bar', () => {}); | ||
}); | ||
|
||
describe('describe foo', () => { | ||
test('bar', () => {}); | ||
}); | ||
``` | ||
|
||
Examples of **correct** code for this rule | ||
|
||
```js | ||
test('foo', () => {}); | ||
it('foo', () => {}); | ||
|
||
describe('foo', () => { | ||
test('bar', () => {}); | ||
}); | ||
``` | ||
|
||
**accidentalSpace** | ||
|
||
A describe/ test block should not contain accidentalSpace | ||
|
||
Examples of **incorrect** code for this rule | ||
|
||
```js | ||
test(' foo', () => {}); | ||
it(' foo', () => {}); | ||
|
||
describe('foo', () => { | ||
test(' bar', () => {}); | ||
}); | ||
|
||
describe(' foo', () => { | ||
test('bar', () => {}); | ||
}); | ||
``` | ||
|
||
Examples of **correct** code for this rule | ||
|
||
```js | ||
test('foo', () => {}); | ||
it('foo', () => {}); | ||
|
||
describe('foo', () => { | ||
test('bar', () => {}); | ||
}); | ||
``` |
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,160 @@ | ||
import { TSESLint } from '@typescript-eslint/experimental-utils'; | ||
import rule from '../valid-title'; | ||
|
||
const ruleTester = new TSESLint.RuleTester({ | ||
parserOptions: { | ||
ecmaVersion: 8, | ||
}, | ||
}); | ||
|
||
ruleTester.run('no-accidental-space', rule, { | ||
valid: [ | ||
'describe("foo", function () {})', | ||
'fdescribe("foo", function () {})', | ||
'xdescribe("foo", function () {})', | ||
'it("foo", function () {})', | ||
'fit("foo", function () {})', | ||
'xit("foo", function () {})', | ||
'test("foo", function () {})', | ||
'xtest("foo", function () {})', | ||
'someFn("foo", function () {})', | ||
` | ||
describe('foo', () => { | ||
it('bar', () => {}) | ||
}) | ||
`, | ||
], | ||
invalid: [ | ||
{ | ||
code: 'describe(" foo", function () {})', | ||
errors: [{ messageId: 'accidentalSpace', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'fdescribe(" foo", function () {})', | ||
errors: [{ messageId: 'accidentalSpace', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'xdescribe(" foo", function () {})', | ||
errors: [{ messageId: 'accidentalSpace', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'it(" foo", function () {})', | ||
errors: [{ messageId: 'accidentalSpace', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'fit(" foo", function () {})', | ||
errors: [{ messageId: 'accidentalSpace', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'xit(" foo", function () {})', | ||
errors: [{ messageId: 'accidentalSpace', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'test(" foo", function () {})', | ||
errors: [{ messageId: 'accidentalSpace', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'xtest(" foo", function () {})', | ||
errors: [{ messageId: 'accidentalSpace', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: ` | ||
describe(' foo', () => { | ||
it('bar', () => {}) | ||
}) | ||
`, | ||
errors: [{ messageId: 'accidentalSpace', column: 7, line: 2 }], | ||
}, | ||
{ | ||
code: ` | ||
describe('foo', () => { | ||
it(' bar', () => {}) | ||
}) | ||
`, | ||
errors: [{ messageId: 'accidentalSpace', column: 9, line: 3 }], | ||
}, | ||
], | ||
}); | ||
|
||
ruleTester.run('no-duplicate-prefix ft describe', rule, { | ||
valid: [ | ||
'describe("foo", function () {})', | ||
'fdescribe("foo", function () {})', | ||
'xdescribe("foo", function () {})', | ||
], | ||
invalid: [ | ||
{ | ||
code: 'describe("describe foo", function () {})', | ||
errors: [{ messageId: 'duplicatePrefix', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'fdescribe("describe foo", function () {})', | ||
errors: [{ messageId: 'duplicatePrefix', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'xdescribe("describe foo", function () {})', | ||
errors: [{ messageId: 'duplicatePrefix', column: 1, line: 1 }], | ||
}, | ||
], | ||
}); | ||
|
||
ruleTester.run('no-duplicate-prefix ft test', rule, { | ||
valid: ['test("foo", function () {})', 'xtest("foo", function () {})'], | ||
invalid: [ | ||
{ | ||
code: 'test("test foo", function () {})', | ||
errors: [{ messageId: 'duplicatePrefix', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'xtest("test foo", function () {})', | ||
errors: [{ messageId: 'duplicatePrefix', column: 1, line: 1 }], | ||
}, | ||
], | ||
}); | ||
|
||
ruleTester.run('no-duplicate-prefix ft it', rule, { | ||
valid: [ | ||
'it("foo", function () {})', | ||
'fit("foo", function () {})', | ||
'xit("foo", function () {})', | ||
], | ||
invalid: [ | ||
{ | ||
code: 'it("it foo", function () {})', | ||
errors: [{ messageId: 'duplicatePrefix', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'fit("it foo", function () {})', | ||
errors: [{ messageId: 'duplicatePrefix', column: 1, line: 1 }], | ||
}, | ||
{ | ||
code: 'xit("it foo", function () {})', | ||
errors: [{ messageId: 'duplicatePrefix', column: 1, line: 1 }], | ||
}, | ||
], | ||
}); | ||
|
||
ruleTester.run('no-duplicate-prefix ft nested', rule, { | ||
valid: [ | ||
` | ||
describe('foo', () => { | ||
it('bar', () => {}) | ||
})`, | ||
], | ||
invalid: [ | ||
{ | ||
code: ` | ||
describe('describe foo', () => { | ||
it('bar', () => {}) | ||
})`, | ||
errors: [{ messageId: 'duplicatePrefix', column: 7, line: 2 }], | ||
}, | ||
{ | ||
code: ` | ||
describe('foo', () => { | ||
it('it bar', () => {}) | ||
})`, | ||
errors: [{ messageId: 'duplicatePrefix', column: 9, line: 3 }], | ||
}, | ||
], | ||
}); |
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,56 @@ | ||
import { | ||
createRule, | ||
getNodeName, | ||
getNodeTitle, | ||
isDescribe, | ||
isTestCase, | ||
} from './utils'; | ||
|
||
function trimFXprefix(word: string) { | ||
return ['f', 'x'].includes(word.charAt(0)) ? word.substr(1) : word; | ||
} | ||
|
||
export default createRule({ | ||
name: __filename, | ||
meta: { | ||
docs: { | ||
category: 'Best Practices', | ||
description: 'Enforce valid titles', | ||
recommended: false, | ||
}, | ||
messages: { | ||
duplicatePrefix: 'should not have duplicate prefix', | ||
accidentalSpace: 'should not have space in the beginning', | ||
}, | ||
type: 'suggestion', | ||
schema: [], | ||
}, | ||
defaultOptions: [], | ||
create(context) { | ||
return { | ||
CallExpression(node) { | ||
if (!isDescribe(node) && !isTestCase(node)) return; | ||
|
||
const title = getNodeTitle(node); | ||
if (!title) return; | ||
|
||
if (title.charAt(0) === ' ') { | ||
context.report({ | ||
messageId: 'accidentalSpace', | ||
node, | ||
}); | ||
} | ||
|
||
const nodeName = trimFXprefix(getNodeName(node.callee)); | ||
const [firstWord] = title.split(' '); | ||
|
||
if (firstWord.toLowerCase() === nodeName) { | ||
context.report({ | ||
messageId: 'duplicatePrefix', | ||
node, | ||
}); | ||
} | ||
}, | ||
}; | ||
}, | ||
}); |