Skip to content

Commit

Permalink
Enhance "all" configuration and update documentation (#578)
Browse files Browse the repository at this point in the history 
* feat: update all rules

* docs: update README

* update: delete of "⚠️ This rule _warns_ in the 🌐 `all` config."

* Revert "update: delete of "⚠️ This rule _warns_ in the 🌐 `all` config.""

This reverts commit a087a49.

* docs: Add notes for all config to rule documentation

* docs: fix readme

* docs: fix readme
  • Loading branch information
@y-hsgw
y-hsgw authored Dec 1, 2024
1 parent 541f8b7 commit ec2366e
Show file tree
Hide file tree
Showing 10 changed files with 73 additions and 17 deletions.
49 changes: 41 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,39 @@ export default [
]
```

### Shareable configurations

#### Recommended
This plugin exports a recommended configuration that enforces good testing practices.

To enable this configuration with `eslint.config.js`, use `vitest.configs.recommended`:

```js
import vitest from "@vitest/eslint-plugin";

export default [
{
files: ["tests/**"], // or any other pattern
...vitest.configs.recommended,
}
]
```


#### All
If you want to enable all rules instead of only some you can do so by adding the all configuration to your `eslint.config.js` config file:

```js
import vitest from "@vitest/eslint-plugin";

export default [
{
files: ["tests/**"], // or any other pattern
...vitest.configs.all,
}
]
```

### Rules

<!-- begin auto-generated rules list -->
Expand All @@ -122,11 +155,11 @@ export default [
| :----------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------- | :- | :- | :- | :- | :- |
| [consistent-test-filename](docs/rules/consistent-test-filename.md) | require .spec test file pattern | | 🌐 | | | |
| [consistent-test-it](docs/rules/consistent-test-it.md) | enforce using test or it but not both | | 🌐 | 🔧 | | |
| [expect-expect](docs/rules/expect-expect.md) | enforce having expectation in test body | ✅ | | | | |
| [expect-expect](docs/rules/expect-expect.md) | enforce having expectation in test body | ✅ | 🌐 | | | |
| [max-expects](docs/rules/max-expects.md) | enforce a maximum number of expect per test | | 🌐 | | | |
| [max-nested-describe](docs/rules/max-nested-describe.md) | require describe block to be less than set max value or default value | | 🌐 | | | |
| [no-alias-methods](docs/rules/no-alias-methods.md) | disallow alias methods | | 🌐 | 🔧 | | |
| [no-commented-out-tests](docs/rules/no-commented-out-tests.md) | disallow commented out tests | ✅ | | | | |
| [no-commented-out-tests](docs/rules/no-commented-out-tests.md) | disallow commented out tests | ✅ | 🌐 | | | |
| [no-conditional-expect](docs/rules/no-conditional-expect.md) | disallow conditional expects | | 🌐 | | | |
| [no-conditional-in-test](docs/rules/no-conditional-in-test.md) | disallow conditional tests | | 🌐 | | | |
| [no-conditional-tests](docs/rules/no-conditional-tests.md) | disallow conditional tests | | 🌐 | | | |
Expand All @@ -135,8 +168,8 @@ export default [
| [no-duplicate-hooks](docs/rules/no-duplicate-hooks.md) | disallow duplicate hooks and teardown hooks | | 🌐 | | | |
| [no-focused-tests](docs/rules/no-focused-tests.md) | disallow focused tests | | 🌐 | 🔧 | | |
| [no-hooks](docs/rules/no-hooks.md) | disallow setup and teardown hooks | | 🌐 | | | |
| [no-identical-title](docs/rules/no-identical-title.md) | disallow identical titles | ✅ | | 🔧 | | |
| [no-import-node-test](docs/rules/no-import-node-test.md) | disallow importing `node:test` | ✅ | | 🔧 | | |
| [no-identical-title](docs/rules/no-identical-title.md) | disallow identical titles | ✅ | 🌐 | 🔧 | | |
| [no-import-node-test](docs/rules/no-import-node-test.md) | disallow importing `node:test` | ✅ | 🌐 | 🔧 | | |
| [no-interpolation-in-snapshots](docs/rules/no-interpolation-in-snapshots.md) | disallow string interpolation in snapshots | | 🌐 | 🔧 | | |
| [no-large-snapshots](docs/rules/no-large-snapshots.md) | disallow large snapshots | | 🌐 | | | |
| [no-mocks-import](docs/rules/no-mocks-import.md) | disallow importing from __mocks__ directory | | 🌐 | | | |
Expand Down Expand Up @@ -167,12 +200,12 @@ export default [
| [prefer-todo](docs/rules/prefer-todo.md) | enforce using `test.todo` | | 🌐 | 🔧 | | |
| [prefer-vi-mocked](docs/rules/prefer-vi-mocked.md) | Prefer `vi.mocked()` over `fn as Mock` | | 🌐 | 🔧 | | |
| [require-hook](docs/rules/require-hook.md) | require setup and teardown to be within a hook | | 🌐 | | | |
| [require-local-test-context-for-concurrent-snapshots](docs/rules/require-local-test-context-for-concurrent-snapshots.md) | require local Test Context for concurrent snapshot tests | ✅ | | | | |
| [require-local-test-context-for-concurrent-snapshots](docs/rules/require-local-test-context-for-concurrent-snapshots.md) | require local Test Context for concurrent snapshot tests | ✅ | 🌐 | | | |
| [require-to-throw-message](docs/rules/require-to-throw-message.md) | require toThrow() to be called with an error message | | 🌐 | | | |
| [require-top-level-describe](docs/rules/require-top-level-describe.md) | enforce that all tests are in a top-level describe | | 🌐 | | | |
| [valid-describe-callback](docs/rules/valid-describe-callback.md) | enforce valid describe callback | ✅ | | | | |
| [valid-expect](docs/rules/valid-expect.md) | enforce valid `expect()` usage | ✅ | | 🔧 | | |
| [valid-title](docs/rules/valid-title.md) | enforce valid titles | ✅ | | 🔧 | | |
| [valid-describe-callback](docs/rules/valid-describe-callback.md) | enforce valid describe callback | ✅ | 🌐 | | | |
| [valid-expect](docs/rules/valid-expect.md) | enforce valid `expect()` usage | ✅ | 🌐 | 🔧 | | |
| [valid-title](docs/rules/valid-title.md) | enforce valid titles | ✅ | 🌐 | 🔧 | | |

<!-- end auto-generated rules list -->

Expand Down
3 changes: 2 additions & 1 deletion docs/rules/expect-expect.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

💼 This rule is enabled in the ✅ `recommended` config.

⚠️ This rule _warns_ in the 🌐 `all` config.

<!-- end auto-generated rule header -->


Expand Down Expand Up @@ -88,4 +90,3 @@ checkForMe('myLogic', () => {
})
})
```

2 changes: 2 additions & 0 deletions docs/rules/no-commented-out-tests.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

💼 This rule is enabled in the ✅ `recommended` config.

⚠️ This rule _warns_ in the 🌐 `all` config.

<!-- end auto-generated rule header -->

## Rule Details
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/no-identical-title.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

💼 This rule is enabled in the ✅ `recommended` config.

⚠️ This rule _warns_ in the 🌐 `all` config.

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/no-import-node-test.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

💼 This rule is enabled in the ✅ `recommended` config.

⚠️ This rule _warns_ in the 🌐 `all` config.

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/require-local-test-context-for-concurrent-snapshots.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

💼 This rule is enabled in the ✅ `recommended` config.

⚠️ This rule _warns_ in the 🌐 `all` config.

<!-- end auto-generated rule header -->

## Rule details
Expand Down
16 changes: 9 additions & 7 deletions docs/rules/valid-describe-callback.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,34 +2,36 @@

💼 This rule is enabled in the ✅ `recommended` config.

⚠️ This rule _warns_ in the 🌐 `all` config.

<!-- end auto-generated rule header -->


This rule validates the second parameter of a `describe()` function is a callback.
This rule validates the second parameter of a `describe()` function is a callback.

- should not contain parameters
- should not contain parameters
- should not contain any `return` statements

The following are considered warnings:

```js
// callback function parameters are not allowed
describe("myfunc", done => {
//
//
})


describe("myfunc", () => {
// no return statements are allowed in a block of a callback function
return Promise.resolve().then(() => {
//
//
})
})

// returning a value from a describe block is not allowed
// returning a value from a describe block is not allowed
describe("myfunc", () => {
it("should do something", () => {
//
//
})
})
```
Expand All @@ -42,7 +44,7 @@ describe("myfunc", async () => {
})
describe("myfunc", () => {
it("should do something", () => {
//
//
})
})
```
2 changes: 2 additions & 0 deletions docs/rules/valid-expect.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

💼 This rule is enabled in the ✅ `recommended` config.

⚠️ This rule _warns_ in the 🌐 `all` config.

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->
Expand Down
2 changes: 2 additions & 0 deletions docs/rules/valid-title.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

💼 This rule is enabled in the ✅ `recommended` config.

⚠️ This rule _warns_ in the 🌐 `all` config.

🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).

<!-- end auto-generated rule header -->
Expand Down
10 changes: 9 additions & 1 deletion src/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,15 @@ const allRules = {
[paddingAroundDescribeBlocksName]: 'warn',
[paddingAroundExpectGroupsName]: 'warn',
[paddingAroundTestBlocksName]: 'warn',
[validExpectInPromiseName]: 'warn'
[validExpectInPromiseName]: 'warn',
[expectedExpect]: 'warn',
[noIdenticalTitleName]: 'warn',
[noCommentedOutTestsName]: 'warn',
[validTitleName]: 'warn',
[validExpectName]: 'warn',
[validDescribeCallbackName]: 'warn',
[requireLocalTestContextForConcurrentSnapshotsName]: 'warn',
[noImportNodeTestName]: 'warn'
} as const

const recommended = {
Expand Down

0 comments on commit ec2366e

Please sign in to comment.