Skip to content

Linter: Add test helpers to simplify linter rule tests #587

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.

Sign up for GitHub

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

Jump to bottom
Merged
marcoroth merged 2 commits into from
Oct 8, 2025
Merged

Linter: Add test helpers to simplify linter rule tests #587

marcoroth merged 2 commits into from
Oct 8, 2025

Conversation

@marcoroth
Copy link
Owner

@marcoroth marcoroth commented Oct 8, 2025 •
edited
Loading

This pull request implements linter test helpers to reduce the verbosity in the linter rule tests. The new createLinterTest() helper provides a cleaner API with expectError(), expectWarning(), expectNoOffenses(), and assertOffenses() functions.

Example:

import { SomeRule } from "../../src/rules/some-rule.js"
import { createLinterTest } from "../helpers/linter-test-helper.js"

const { expectNoOffenses, expectError, assertOffenses } = createLinterTest(SomeRule)

describe("SomeRule", () => {
  test("no offenses", () => {
    expectNoOffenses(`<div></div>`)
  })

  test("with offenses", () => {
    expectError("Error message.")
    expectWarning("Warning message.")

    assertOffenses(`<div></div>`)
  })
})

Resolves #461
@marcoroth marcoroth force-pushed the linter-test-helpers branch from 414828f to 7978955 Compare October 8, 2025 12:02
@marcoroth marcoroth merged commit 230dcf4 into main Oct 8, 2025
7 checks passed
@marcoroth marcoroth deleted the linter-test-helpers branch October 8, 2025 12:08
asilano pushed a commit to fac/herb that referenced this pull request Oct 21, 2025
@marcoroth @asilano
Linter: Add test helpers to simplify linter rule tests (marcoroth#587)
8d6adb1 
This pull request implements linter test helpers to reduce the verbosity
in the linter rule tests. The new `createLinterTest()` helper provides a
cleaner API with `expectError()`, `expectWarning()`,
`expectNoOffenses()`, and `assertOffenses()` functions.

Example:

```ts
import { SomeRule } from "../../src/rules/some-rule.js"
import { createLinterTest } from "../helpers/linter-test-helper.js"

const { expectNoOffenses, expectError, assertOffenses } = createLinterTest(SomeRule)

describe("SomeRule", () => {
  test("no offenses", () => {
    expectNoOffenses(`<div></div>`)
  })

  test("with offenses", () => {
    expectError("Error message.")
    expectWarning("Warning message.")

    assertOffenses(`<div></div>`)
  })
})
```

Resolves marcoroth#461
@asilano asilano mentioned this pull request Oct 21, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

javascript linter refactor

2 participants

@marcoroth