Skip to content
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(lowercase-name): support ignoreTopLevelDescribe option #611

Merged
merged 1 commit into from
Jun 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/rules/lowercase-name.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,21 @@ Example of **correct** code for the `{ "allowedPrefixes": ["GET"] }` option:

describe('GET /live');
```

### `ignoreTopLevelDescribe`

This option can be set to allow only the top-level `describe` blocks to have a
title starting with an upper-case letter.

Example of **correct** code for the `{ "ignoreTopLevelDescribe": true }` option:

```js
/* eslint jest/lowercase-name: ["error", { "ignoreTopLevelDescribe": true }] */
describe('MyClass', () => {
describe('#myMethod', () => {
it('does things', () => {
//
});
});
});
```
113 changes: 113 additions & 0 deletions src/rules/__tests__/lowercase-name.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { TSESLint } from '@typescript-eslint/experimental-utils';
import dedent from 'dedent';
import resolveFrom from 'resolve-from';
import rule from '../lowercase-name';
import { DescribeAlias, TestCaseName } from '../utils';
Expand Down Expand Up @@ -251,3 +252,115 @@ ruleTester.run('lowercase-name with allowedPrefixes', rule, {
],
invalid: [],
});

ruleTester.run('lowercase-name with ignoreTopLevelDescribe', rule, {
valid: [
{
code: 'describe("MyClass", () => {});',
options: [{ ignoreTopLevelDescribe: true }],
},
{
code: dedent`
describe('MyClass', () => {
describe('#myMethod', () => {
it('does things', () => {
//
});
});
});
`,
options: [{ ignoreTopLevelDescribe: true }],
},
],
invalid: [
{
code: 'it("Works!", () => {});',
options: [{ ignoreTopLevelDescribe: true }],
output: 'it("works!", () => {});',
errors: [
{
messageId: 'unexpectedLowercase',
data: { method: TestCaseName.it },
column: 4,
line: 1,
},
],
},
{
code: dedent`
describe('MyClass', () => {
describe('MyMethod', () => {
it('Does things', () => {
//
});
});
});
`,
options: [{ ignoreTopLevelDescribe: true }],
output: dedent`
describe('MyClass', () => {
describe('myMethod', () => {
it('does things', () => {
//
});
});
});
`,
errors: [
{
messageId: 'unexpectedLowercase',
data: { method: DescribeAlias.describe },
column: 12,
line: 2,
},
{
messageId: 'unexpectedLowercase',
data: { method: TestCaseName.it },
column: 8,
line: 3,
},
],
},
{
code: dedent`
describe('MyClass', () => {
describe('MyMethod', () => {
it('Does things', () => {
//
});
});
});
`,
options: [{ ignoreTopLevelDescribe: false }],
output: dedent`
describe('myClass', () => {
describe('myMethod', () => {
it('does things', () => {
//
});
});
});
`,
errors: [
{
messageId: 'unexpectedLowercase',
data: { method: DescribeAlias.describe },
column: 10,
line: 1,
},
{
messageId: 'unexpectedLowercase',
data: { method: DescribeAlias.describe },
column: 12,
line: 2,
},
{
messageId: 'unexpectedLowercase',
data: { method: TestCaseName.it },
column: 8,
line: 3,
},
],
},
],
});
25 changes: 23 additions & 2 deletions src/rules/lowercase-name.ts
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ export default createRule<
Partial<{
ignore: readonly IgnorableFunctionExpressions[];
allowedPrefixes: readonly string[];
ignoreTopLevelDescribe: boolean;
}>,
],
'unexpectedLowercase'
Expand Down Expand Up @@ -98,18 +99,38 @@ export default createRule<
items: { type: 'string' },
additionalItems: false,
},
ignoreTopLevelDescribe: {
type: 'boolean',
default: false,
},
},
additionalProperties: false,
},
],
} as const,
defaultOptions: [{ ignore: [], allowedPrefixes: [] }],
create(context, [{ ignore = [], allowedPrefixes = [] }]) {
defaultOptions: [
{ ignore: [], allowedPrefixes: [], ignoreTopLevelDescribe: false },
],
create(
context,
[{ ignore = [], allowedPrefixes = [], ignoreTopLevelDescribe }],
) {
let numberOfDescribeBlocks = 0;

return {
CallExpression(node: TSESTree.CallExpression) {
if (!isJestFunctionWithLiteralArg(node)) {
return;
}

if (isDescribe(node)) {
numberOfDescribeBlocks++;

if (ignoreTopLevelDescribe && numberOfDescribeBlocks === 1) {
return;
}
}

const erroneousMethod = jestFunctionName(node, allowedPrefixes);

if (erroneousMethod && !ignore.includes(node.callee.name)) {
Expand Down