eslint-vitest-rule-tester
v3.1.0TypeScript
ESLint rule tester with Vitest
0/weekUpdated 2 days agoMITUnpacked: 283.1 KB
Published by Anthony Fu
npm install eslint-vitest-rule-testereslint-vitest-rule-tester
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]
ESLint rule tester with Vitest.
Provides a better testing experience, supports snapshoting, and does not require globals: true in Vitest.
> This module requires ESLint v9.10+.
Who is using?
- ESLint Stylistic
- eslint-plugin-command
- eslint-plugin-antfu
- eslint-plugin-perfectionist
- eslint-plugin-de-morgan
Install
``bash`
npm i -D eslint-vitest-rule-tester
Usage
$3
Simliar style to ESLint's RuleTester (test cases with implicit test suites)
`ts
import { run, runClassic } from 'eslint-vitest-rule-tester'
import { expect } from 'vitest'
// Classic RuleTester.run style
runClassic('rule-name', rule, {
valid: [
// ...
],
invalid: [
// ...
],
}, {
parserOptions: {
ecmaVersion: 2020,
sourceType: 'module',
},
})
// Or everyting-in-one-object style
run({
name: 'rule-name',
rule,
parserOptions: {
ecmaVersion: 2020,
sourceType: 'module',
},
valid: [
// test cases
],
invalid: [
// test cases
],
})
`
Feature Extensions
#### output
output field can be a function to do custom assertions. This would also be compatible with snapshot testing.
`ts
import { run, } from 'eslint-vitest-rule-tester'
import { expect } from 'vitest'
run({
name: 'rule-name',
rule,
invalid: [
{
code: 'let foo = 1',
output(output) {
expect(output.slice(0, 3)).toBe('let')
expect(output)
.toMatchInlineSnapshot("const foo = 1;")`
// Any custom assertion...
},
},
],
})
#### errors
errors field can be a function to do custom assertion, same as output.
`ts
import { run } from 'eslint-vitest-rule-tester'
import { expect } from 'vitest'
run({
name: 'rule-name',
rule,
invalid: [
{
code: 'let foo = 1',
errors(errors) {
expect(errors).toHaveLength(1)
expect(errors.map(e => e.messageId))
.toMatchInlineSnapshot(["error-message-id"])`
// Any custom assertion...
},
},
],
})
#### onResult hook
onResult field can be a function to do custom assertions with the entire result object.
`ts
import { run } from 'eslint-vitest-rule-tester'
import { expect } from 'vitest'
run({
name: 'rule-name',
rule,
invalid: [
'let foo = 1',
],
onResult(testCase, result) {
if (testCase.type === 'invalid')
expect(result).toMatchSnapshot()
// here you can't use toMatchInlineSnapshot because it's not in the test case`
},
})
$3
`ts
import { createRuleTester } from 'eslint-vitest-rule-tester'
import { describe, expect, it } from 'vitest'
describe('rule-name', () => {
const { valid, invalid } = createRuleTester({
name: 'rule-name',
rule,
configs: {
// flat config options
languageOptions: {
parserOptions: {
ecmaVersion: 2020,
sourceType: 'module',
},
},
}
})
it('valid case 1', () => {
valid('const foo = 1')
})
it('invalid case 1 with snapshot', () => {
const { result } = await invalid({
code: 'const foo = 1',
errors: ['error-message-id'],
})
expect(result.output).toMatchSnapshot()
})
})
``
Sponsors
License
MIT License © 2024-PRESENT Anthony Fu
[npm-version-src]: https://img.shields.io/npm/v/eslint-vitest-rule-tester?style=flat&colorA=080f12&colorB=1fa669
[npm-version-href]: https://npmjs.com/package/eslint-vitest-rule-tester
[npm-downloads-src]: https://img.shields.io/npm/dm/eslint-vitest-rule-tester?style=flat&colorA=080f12&colorB=1fa669
[npm-downloads-href]: https://npmjs.com/package/eslint-vitest-rule-tester
[bundle-src]: https://img.shields.io/bundlephobia/minzip/eslint-vitest-rule-tester?style=flat&colorA=080f12&colorB=1fa669&label=minzip
[bundle-href]: https://bundlephobia.com/result?p=eslint-vitest-rule-tester
[license-src]: https://img.shields.io/github/license/antfu/eslint-vitest-rule-tester.svg?style=flat&colorA=080f12&colorB=1fa669
[license-href]: https://github.com/antfu/eslint-vitest-rule-tester/blob/main/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12?style=flat&colorA=080f12&colorB=1fa669
[jsdocs-href]: https://www.jsdocs.io/package/eslint-vitest-rule-tester