Skip to content

Commit

Permalink
docs(prefer-lowercase-title): use new rule name (#951)
Browse files Browse the repository at this point in the history
  • Loading branch information
G-Rath authored Oct 14, 2021
1 parent a8a8ca2 commit 17cb163
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/rules/prefer-lowercase-title.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ it('adds 1 + 2 to equal 3', () => {

```json
{
"jest/lowercase-name": [
"jest/prefer-lowercase-name": [
"error",
{
"ignore": ["describe", "test"]
Expand All @@ -50,23 +50,23 @@ By default, none of these options are enabled (the equivalent of
Example of **correct** code for the `{ "ignore": ["describe"] }` option:

```js
/* eslint jest/lowercase-name: ["error", { "ignore": ["describe"] }] */
/* eslint jest/prefer-lowercase-name: ["error", { "ignore": ["describe"] }] */

describe('Uppercase description');
```

Example of **correct** code for the `{ "ignore": ["test"] }` option:

```js
/* eslint jest/lowercase-name: ["error", { "ignore": ["test"] }] */
/* eslint jest/prefer-lowercase-name: ["error", { "ignore": ["test"] }] */

test('Uppercase description');
```

Example of **correct** code for the `{ "ignore": ["it"] }` option:

```js
/* eslint jest/lowercase-name: ["error", { "ignore": ["it"] }] */
/* eslint jest/prefer-lowercase-name: ["error", { "ignore": ["it"] }] */

it('Uppercase description');
```
Expand All @@ -82,7 +82,7 @@ By default, nothing is allowed (the equivalent of `{ "allowedPrefixes": [] }`).
Example of **correct** code for the `{ "allowedPrefixes": ["GET"] }` option:

```js
/* eslint jest/lowercase-name: ["error", { "allowedPrefixes": ["GET"] }] */
/* eslint jest/prefer-lowercase-name: ["error", { "allowedPrefixes": ["GET"] }] */

describe('GET /live');
```
Expand All @@ -95,7 +95,7 @@ title starting with an upper-case letter.
Example of **correct** code for the `{ "ignoreTopLevelDescribe": true }` option:

```js
/* eslint jest/lowercase-name: ["error", { "ignoreTopLevelDescribe": true }] */
/* eslint jest/prefer-lowercase-name: ["error", { "ignoreTopLevelDescribe": true }] */
describe('MyClass', () => {
describe('#myMethod', () => {
it('does things', () => {
Expand Down

0 comments on commit 17cb163

Please sign in to comment.