@vitest/eslint-plugin 1.4.3 β 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +81 -79
- package/dist/index.cjs +315 -193
- package/dist/index.d.cts +9 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.js +315 -193
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -185,84 +185,86 @@ export default defineConfig({
|
|
|
185
185
|
π Requires [type information](https://typescript-eslint.io/linting/typed-linting).\
|
|
186
186
|
β Deprecated.
|
|
187
187
|
|
|
188
|
-
| NameΒ Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β | Description | πΌ | β οΈ
|
|
189
|
-
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- | :-- |
|
|
190
|
-
| [consistent-
|
|
191
|
-
| [consistent-test-
|
|
192
|
-
| [consistent-
|
|
193
|
-
| [
|
|
194
|
-
| [
|
|
195
|
-
| [
|
|
196
|
-
| [max-
|
|
197
|
-
| [
|
|
198
|
-
| [no-
|
|
199
|
-
| [no-
|
|
200
|
-
| [no-conditional-
|
|
201
|
-
| [no-conditional-
|
|
202
|
-
| [no-
|
|
203
|
-
| [no-
|
|
204
|
-
| [no-
|
|
205
|
-
| [no-
|
|
206
|
-
| [no-
|
|
207
|
-
| [no-
|
|
208
|
-
| [no-
|
|
209
|
-
| [no-
|
|
210
|
-
| [no-
|
|
211
|
-
| [no-
|
|
212
|
-
| [no-
|
|
213
|
-
| [no-
|
|
214
|
-
| [no-restricted-
|
|
215
|
-
| [no-
|
|
216
|
-
| [no-
|
|
217
|
-
| [no-test-
|
|
218
|
-
| [
|
|
219
|
-
| [padding-around-after-
|
|
220
|
-
| [padding-around-
|
|
221
|
-
| [padding-around-
|
|
222
|
-
| [padding-around-before-
|
|
223
|
-
| [padding-around-
|
|
224
|
-
| [padding-around-
|
|
225
|
-
| [padding-around-
|
|
226
|
-
| [
|
|
227
|
-
| [prefer-called-once](docs/rules/prefer-called-once.md)
|
|
228
|
-
| [prefer-called-
|
|
229
|
-
| [prefer-called-
|
|
230
|
-
| [prefer-
|
|
231
|
-
| [prefer-
|
|
232
|
-
| [prefer-
|
|
233
|
-
| [prefer-
|
|
234
|
-
| [prefer-
|
|
235
|
-
| [prefer-expect-
|
|
236
|
-
| [prefer-expect-
|
|
237
|
-
| [prefer-
|
|
238
|
-
| [prefer-hooks-
|
|
239
|
-
| [prefer-
|
|
240
|
-
| [prefer-
|
|
241
|
-
| [prefer-
|
|
242
|
-
| [prefer-
|
|
243
|
-
| [prefer-
|
|
244
|
-
| [prefer-
|
|
245
|
-
| [prefer-
|
|
246
|
-
| [prefer-strict-
|
|
247
|
-
| [prefer-
|
|
248
|
-
| [prefer-to-be
|
|
249
|
-
| [prefer-to-be-
|
|
250
|
-
| [prefer-to-be-
|
|
251
|
-
| [prefer-to-
|
|
252
|
-
| [prefer-to-
|
|
253
|
-
| [prefer-
|
|
254
|
-
| [prefer-
|
|
255
|
-
| [
|
|
256
|
-
| [require-
|
|
257
|
-
| [require-
|
|
258
|
-
| [require-
|
|
259
|
-
| [require-
|
|
260
|
-
| [require-
|
|
261
|
-
| [
|
|
262
|
-
| [
|
|
263
|
-
| [valid-
|
|
264
|
-
| [valid-
|
|
265
|
-
| [
|
|
188
|
+
| NameΒ Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β Β | Description | πΌ | β οΈ | π« | π§ | π‘ | π | β |
|
|
189
|
+
| :----------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- | :-- | :---- | :-- | :-- | :-- | :-- | :-- |
|
|
190
|
+
| [consistent-each-for](docs/rules/consistent-each-for.md) | enforce using `.each` or `.for` consistently | | π | | | | | |
|
|
191
|
+
| [consistent-test-filename](docs/rules/consistent-test-filename.md) | require test file pattern | | π | | | | | |
|
|
192
|
+
| [consistent-test-it](docs/rules/consistent-test-it.md) | enforce using test or it but not both | | π | | π§ | | | |
|
|
193
|
+
| [consistent-vitest-vi](docs/rules/consistent-vitest-vi.md) | enforce using vitest or vi but not both | | π | | π§ | | | |
|
|
194
|
+
| [expect-expect](docs/rules/expect-expect.md) | enforce having expectation in test body | β
| π | | | | | |
|
|
195
|
+
| [hoisted-apis-on-top](docs/rules/hoisted-apis-on-top.md) | enforce hoisted APIs to be on top of the file | | π | | | π‘ | | |
|
|
196
|
+
| [max-expects](docs/rules/max-expects.md) | enforce a maximum number of expect per test | | π | | | | | |
|
|
197
|
+
| [max-nested-describe](docs/rules/max-nested-describe.md) | require describe block to be less than set max value or default value | | π | | | | | |
|
|
198
|
+
| [no-alias-methods](docs/rules/no-alias-methods.md) | disallow alias methods | | π | | π§ | | | |
|
|
199
|
+
| [no-commented-out-tests](docs/rules/no-commented-out-tests.md) | disallow commented out tests | β
| π | | | | | |
|
|
200
|
+
| [no-conditional-expect](docs/rules/no-conditional-expect.md) | disallow conditional expects | β
| π | | | | | |
|
|
201
|
+
| [no-conditional-in-test](docs/rules/no-conditional-in-test.md) | disallow conditional tests | | π | | | | | |
|
|
202
|
+
| [no-conditional-tests](docs/rules/no-conditional-tests.md) | disallow conditional tests | | π | | | | | |
|
|
203
|
+
| [no-disabled-tests](docs/rules/no-disabled-tests.md) | disallow disabled tests | | π β
| | | | | |
|
|
204
|
+
| [no-done-callback](docs/rules/no-done-callback.md) | disallow using a callback in asynchronous tests and hooks | | | | | π‘ | | β |
|
|
205
|
+
| [no-duplicate-hooks](docs/rules/no-duplicate-hooks.md) | disallow duplicate hooks and teardown hooks | | π | | | | | |
|
|
206
|
+
| [no-focused-tests](docs/rules/no-focused-tests.md) | disallow focused tests | β
| π | | π§ | | | |
|
|
207
|
+
| [no-hooks](docs/rules/no-hooks.md) | disallow setup and teardown hooks | | π | | | | | |
|
|
208
|
+
| [no-identical-title](docs/rules/no-identical-title.md) | disallow identical titles | β
| π | | π§ | | | |
|
|
209
|
+
| [no-import-node-test](docs/rules/no-import-node-test.md) | disallow importing `node:test` | β
| π | | π§ | | | |
|
|
210
|
+
| [no-importing-vitest-globals](docs/rules/no-importing-vitest-globals.md) | disallow importing Vitest globals | | | π | π§ | | | |
|
|
211
|
+
| [no-interpolation-in-snapshots](docs/rules/no-interpolation-in-snapshots.md) | disallow string interpolation in snapshots | β
| π | | π§ | | | |
|
|
212
|
+
| [no-large-snapshots](docs/rules/no-large-snapshots.md) | disallow large snapshots | | π | | | | | |
|
|
213
|
+
| [no-mocks-import](docs/rules/no-mocks-import.md) | disallow importing from **mocks** directory | β
| π | | | | | |
|
|
214
|
+
| [no-restricted-matchers](docs/rules/no-restricted-matchers.md) | disallow the use of certain matchers | | π | | | | | |
|
|
215
|
+
| [no-restricted-vi-methods](docs/rules/no-restricted-vi-methods.md) | disallow specific `vi.` methods | | π | | | | | |
|
|
216
|
+
| [no-standalone-expect](docs/rules/no-standalone-expect.md) | disallow using `expect` outside of `it` or `test` blocks | β
| π | | | | | |
|
|
217
|
+
| [no-test-prefixes](docs/rules/no-test-prefixes.md) | disallow using the `f` and `x` prefixes in favour of `.only` and `.skip` | | π | | π§ | | | |
|
|
218
|
+
| [no-test-return-statement](docs/rules/no-test-return-statement.md) | disallow return statements in tests | | π | | | | | |
|
|
219
|
+
| [padding-around-after-all-blocks](docs/rules/padding-around-after-all-blocks.md) | Enforce padding around `afterAll` blocks | | π | | π§ | | | |
|
|
220
|
+
| [padding-around-after-each-blocks](docs/rules/padding-around-after-each-blocks.md) | Enforce padding around `afterEach` blocks | | π | | π§ | | | |
|
|
221
|
+
| [padding-around-all](docs/rules/padding-around-all.md) | Enforce padding around vitest functions | | π | | π§ | | | |
|
|
222
|
+
| [padding-around-before-all-blocks](docs/rules/padding-around-before-all-blocks.md) | Enforce padding around `beforeAll` blocks | | π | | π§ | | | |
|
|
223
|
+
| [padding-around-before-each-blocks](docs/rules/padding-around-before-each-blocks.md) | Enforce padding around `beforeEach` blocks | | π | | π§ | | | |
|
|
224
|
+
| [padding-around-describe-blocks](docs/rules/padding-around-describe-blocks.md) | Enforce padding around `describe` blocks | | π | | π§ | | | |
|
|
225
|
+
| [padding-around-expect-groups](docs/rules/padding-around-expect-groups.md) | Enforce padding around `expect` groups | | π | | π§ | | | |
|
|
226
|
+
| [padding-around-test-blocks](docs/rules/padding-around-test-blocks.md) | Enforce padding around `test` blocks | | π | | π§ | | | |
|
|
227
|
+
| [prefer-called-exactly-once-with](docs/rules/prefer-called-exactly-once-with.md) | Prefer `toHaveBeenCalledExactlyOnceWith` over `toHaveBeenCalledOnce` and `toHaveBeenCalledWith` | β
| π | | π§ | | | |
|
|
228
|
+
| [prefer-called-once](docs/rules/prefer-called-once.md) | enforce using `toBeCalledOnce()` or `toHaveBeenCalledOnce()` | | | π | π§ | | | |
|
|
229
|
+
| [prefer-called-times](docs/rules/prefer-called-times.md) | enforce using `toBeCalledTimes(1)` or `toHaveBeenCalledTimes(1)` | | π | | π§ | | | |
|
|
230
|
+
| [prefer-called-with](docs/rules/prefer-called-with.md) | enforce using `toBeCalledWith()` or `toHaveBeenCalledWith()` | | π | | π§ | | | |
|
|
231
|
+
| [prefer-comparison-matcher](docs/rules/prefer-comparison-matcher.md) | enforce using the built-in comparison matchers | | π | | π§ | | | |
|
|
232
|
+
| [prefer-describe-function-title](docs/rules/prefer-describe-function-title.md) | enforce using a function as a describe title over an equivalent string | | π | | π§ | | | |
|
|
233
|
+
| [prefer-each](docs/rules/prefer-each.md) | enforce using `each` rather than manual loops | | π | | | | | |
|
|
234
|
+
| [prefer-equality-matcher](docs/rules/prefer-equality-matcher.md) | enforce using the built-in equality matchers | | π | | | π‘ | | |
|
|
235
|
+
| [prefer-expect-assertions](docs/rules/prefer-expect-assertions.md) | enforce using expect assertions instead of callbacks | | π | | | π‘ | | |
|
|
236
|
+
| [prefer-expect-resolves](docs/rules/prefer-expect-resolves.md) | enforce using `expect().resolves` over `expect(await ...)` syntax | | π | | π§ | | | |
|
|
237
|
+
| [prefer-expect-type-of](docs/rules/prefer-expect-type-of.md) | enforce using `expectTypeOf` instead of `expect(typeof ...)` | | π | | π§ | | | |
|
|
238
|
+
| [prefer-hooks-in-order](docs/rules/prefer-hooks-in-order.md) | enforce having hooks in consistent order | | π | | | | | |
|
|
239
|
+
| [prefer-hooks-on-top](docs/rules/prefer-hooks-on-top.md) | enforce having hooks before any test cases | | π | | | | | |
|
|
240
|
+
| [prefer-import-in-mock](docs/rules/prefer-import-in-mock.md) | prefer dynamic import in mock | | π | | π§ | | | |
|
|
241
|
+
| [prefer-importing-vitest-globals](docs/rules/prefer-importing-vitest-globals.md) | enforce importing Vitest globals | | π | | π§ | | | |
|
|
242
|
+
| [prefer-lowercase-title](docs/rules/prefer-lowercase-title.md) | enforce lowercase titles | | π | | π§ | | | |
|
|
243
|
+
| [prefer-mock-promise-shorthand](docs/rules/prefer-mock-promise-shorthand.md) | enforce mock resolved/rejected shorthands for promises | | π | | π§ | | | |
|
|
244
|
+
| [prefer-snapshot-hint](docs/rules/prefer-snapshot-hint.md) | enforce including a hint with external snapshots | | π | | | | | |
|
|
245
|
+
| [prefer-spy-on](docs/rules/prefer-spy-on.md) | enforce using `vi.spyOn` | | π | | π§ | | | |
|
|
246
|
+
| [prefer-strict-boolean-matchers](docs/rules/prefer-strict-boolean-matchers.md) | enforce using `toBe(true)` and `toBe(false)` over matchers that coerce types to boolean | | π | | π§ | | | |
|
|
247
|
+
| [prefer-strict-equal](docs/rules/prefer-strict-equal.md) | enforce strict equal over equal | | π | | | π‘ | | |
|
|
248
|
+
| [prefer-to-be](docs/rules/prefer-to-be.md) | enforce using toBe() | | π | | π§ | | | |
|
|
249
|
+
| [prefer-to-be-falsy](docs/rules/prefer-to-be-falsy.md) | enforce using toBeFalsy() | | | π | π§ | | | |
|
|
250
|
+
| [prefer-to-be-object](docs/rules/prefer-to-be-object.md) | enforce using toBeObject() | | π | | π§ | | | |
|
|
251
|
+
| [prefer-to-be-truthy](docs/rules/prefer-to-be-truthy.md) | enforce using `toBeTruthy` | | | π | π§ | | | |
|
|
252
|
+
| [prefer-to-contain](docs/rules/prefer-to-contain.md) | enforce using toContain() | | π | | π§ | | | |
|
|
253
|
+
| [prefer-to-have-length](docs/rules/prefer-to-have-length.md) | enforce using toHaveLength() | | π | | π§ | | | |
|
|
254
|
+
| [prefer-todo](docs/rules/prefer-todo.md) | enforce using `test.todo` | | π | | π§ | | | |
|
|
255
|
+
| [prefer-vi-mocked](docs/rules/prefer-vi-mocked.md) | require `vi.mocked()` over `fn as Mock` | | π | | π§ | | π | |
|
|
256
|
+
| [require-awaited-expect-poll](docs/rules/require-awaited-expect-poll.md) | ensure that every `expect.poll` call is awaited | | π | | | | | |
|
|
257
|
+
| [require-hook](docs/rules/require-hook.md) | require setup and teardown to be within a hook | | π | | | | | |
|
|
258
|
+
| [require-import-vi-mock](docs/rules/require-import-vi-mock.md) | require usage of import in vi.mock() | | π | | π§ | | | |
|
|
259
|
+
| [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 | β
| π | | | | | |
|
|
260
|
+
| [require-mock-type-parameters](docs/rules/require-mock-type-parameters.md) | enforce using type parameters with vitest mock functions | | π | | π§ | | | |
|
|
261
|
+
| [require-to-throw-message](docs/rules/require-to-throw-message.md) | require toThrow() to be called with an error message | | π | | | | | |
|
|
262
|
+
| [require-top-level-describe](docs/rules/require-top-level-describe.md) | enforce that all tests are in a top-level describe | | π | | | | | |
|
|
263
|
+
| [valid-describe-callback](docs/rules/valid-describe-callback.md) | enforce valid describe callback | β
| π | | | | | |
|
|
264
|
+
| [valid-expect](docs/rules/valid-expect.md) | enforce valid `expect()` usage | β
| π | | π§ | | | |
|
|
265
|
+
| [valid-expect-in-promise](docs/rules/valid-expect-in-promise.md) | require promises that have expectations in their chain to be valid | β
| π | | | | | |
|
|
266
|
+
| [valid-title](docs/rules/valid-title.md) | enforce valid titles | β
| π | | π§ | | | |
|
|
267
|
+
| [warn-todo](docs/rules/warn-todo.md) | disallow `.todo` usage | | | | | | | |
|
|
266
268
|
|
|
267
269
|
<!-- end auto-generated rules list -->
|
|
268
270
|
|
|
@@ -273,4 +275,4 @@ export default defineConfig({
|
|
|
273
275
|
|
|
274
276
|
### Licence
|
|
275
277
|
|
|
276
|
-
[MIT](https://github.com/veritem/eslint-plugin-vitest/blob/main/LICENSE) Licence © 2022 - present [veritem](https://github.com/veritem) and contributors
|
|
278
|
+
[MIT](https://github.com/veritem/eslint-plugin-vitest/blob/main/LICENSE) Licence © 2022 - present by [veritem](https://github.com/veritem) and contributors
|