-
Notifications
You must be signed in to change notification settings - Fork 228
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add lowercase-description rule
- Loading branch information
1 parent
eb0a2a2
commit e87088c
Showing
5 changed files
with
169 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
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,22 @@ | ||
# Enforce lowercase descriptions in it() (lowercase-description) | ||
|
||
## Rule details | ||
|
||
Enforce `it()` tests to have descriptions that begin with a lowercase letter. | ||
This provides more readable test failures. This rule is not enabled by default. | ||
|
||
The following pattern is considered a warning: | ||
|
||
```js | ||
it('Adds 1 + 2 to equal 3', () => { | ||
expect(sum(1, 2)).toBe(3); | ||
}); | ||
``` | ||
|
||
The following pattern is not considered a warning: | ||
|
||
```js | ||
it('adds 1 + 2 to equal 3', () => { | ||
expect(sum(1, 2)).toBe(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,79 @@ | ||
'use strict'; | ||
|
||
const RuleTester = require('eslint').RuleTester; | ||
const rules = require('../..').rules; | ||
|
||
const ruleTester = new RuleTester({ | ||
parserOptions: { | ||
ecmaVersion: 6, | ||
}, | ||
}); | ||
|
||
const errMessage = | ||
'it(), test() and describe() descriptions should begin with lowercase'; | ||
const errors = [{ message: errMessage, column: 1, line: 1 }]; | ||
|
||
ruleTester.run('lowercase-description', rules['lowercase-description'], { | ||
valid: [ | ||
"it(' ', function () {})", | ||
'it(" ", function () {})', | ||
'it(` `, function () {})', | ||
"it('foo', function () {})", | ||
'it("foo", function () {})', | ||
'it(`foo`, function () {})', | ||
'it("<Foo/>", function () {})', | ||
'it("123 foo", function () {})', | ||
'it(42, function () {})', | ||
"test('foo', function () {})", | ||
'test("foo", function () {})', | ||
'test(`foo`, function () {})', | ||
'test("<Foo/>", function () {})', | ||
'test("123 foo", function () {})', | ||
'test("42", function () {})', | ||
"describe('foo', function () {})", | ||
'describe("foo", function () {})', | ||
'describe(`foo`, function () {})', | ||
'describe("<Foo/>", function () {})', | ||
'describe("123 foo", function () {})', | ||
'describe("42", function () {})', | ||
], | ||
|
||
invalid: [ | ||
{ | ||
code: "it('Foo', function () {})", | ||
errors, | ||
}, | ||
{ | ||
code: 'it("Foo", function () {})', | ||
errors, | ||
}, | ||
{ | ||
code: 'it(`Foo`, function () {})', | ||
errors, | ||
}, | ||
{ | ||
code: "test('Foo', function () {})", | ||
errors, | ||
}, | ||
{ | ||
code: 'test("Foo", function () {})', | ||
errors, | ||
}, | ||
{ | ||
code: 'test(`Foo`, function () {})', | ||
errors, | ||
}, | ||
{ | ||
code: "describe('Foo', function () {})", | ||
errors, | ||
}, | ||
{ | ||
code: 'describe("Foo", function () {})', | ||
errors, | ||
}, | ||
{ | ||
code: 'describe(`Foo`, function () {})', | ||
errors, | ||
}, | ||
], | ||
}); |
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 @@ | ||
'use strict'; | ||
|
||
const ruleMsg = | ||
'it(), test() and describe() descriptions should begin with lowercase'; | ||
|
||
const isItTestOrDescribeFunction = node => { | ||
return ( | ||
node.type === 'CallExpression' && | ||
node.callee && | ||
(node.callee.name === 'it' || | ||
node.callee.name === 'test' || | ||
node.callee.name === 'describe') | ||
); | ||
}; | ||
|
||
const isItDescription = node => { | ||
return ( | ||
node.arguments && | ||
node.arguments[0] && | ||
(node.arguments[0].type === 'Literal' || | ||
node.arguments[0].type === 'TemplateLiteral') | ||
); | ||
}; | ||
|
||
const testDescription = node => { | ||
const type = node.arguments[0].type; | ||
if (type === 'Literal') { | ||
return node.arguments[0].value; | ||
} | ||
if (type === 'TemplateLiteral') { | ||
return node.arguments[0].quasis[0].value.raw; | ||
} | ||
}; | ||
|
||
const descriptionBeginsWithLowerCase = node => { | ||
if (isItTestOrDescribeFunction(node) && isItDescription(node)) { | ||
const description = testDescription(node); | ||
if (!description[0]) { | ||
return true; | ||
} | ||
return description[0] === description[0].toLowerCase(); | ||
} | ||
return true; | ||
}; | ||
|
||
module.exports = { | ||
meta: { | ||
docs: { | ||
url: | ||
'https://github.com/jest-community/eslint-plugin-jest/blob/master/docs/rules/lowercase-description.md', | ||
}, | ||
}, | ||
create(context) { | ||
return { | ||
CallExpression(node) { | ||
if (!descriptionBeginsWithLowerCase(node)) { | ||
context.report({ | ||
message: ruleMsg, | ||
node: node, | ||
}); | ||
} | ||
}, | ||
}; | ||
}, | ||
}; |