feat(utils): add dependency constraint filtering for RuleTester

[bradzacher]

PR Checklist

• Addresses an existing open issue: ref Add automated regression testing against old TS versions #1752
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

While working on #5573 I realised that we need infrastructure that allows us to skip tests depending on dependency versions (i.e. the current ESLint or TS version).

This PR adds that functionality into our extended version of the RuleTester class.
You will be able to specify constraints like so:

ruleTester.run('my-rule', rule, {
  valid: [
    {
      code: 'const x = 1;',
      dependencyConstraints: {
        // enforces the semver ">=7.32.0"
        eslint: '7.32.0',

        // i also added this form which allows the user to fully control the semver.satisfies call
        'some-other-module': {
          type: 'semver',
          version: '~6',
          options: {
            includePrerelease: true,
          },
        },
      },
    },
  ],
  invalid: [
    {
      code: 'const x = 1;',
      errors: [ /* ... */ ],
      dependencyConstraints: {
        eslint: '7.32.0',
        // etc - same as above
      },
    },
  ],
});

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 98b6eb4. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 47 targets

• Node 18 - nx test @typescript-eslint/eslint-plugin
• Node 14 - nx test @typescript-eslint/eslint-plugin --coverage=false
• nx run-many --target=build --all --parallel --exclude website
• Node 18 - nx test @typescript-eslint/type-utils
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/utils
• nx run-many --target=typecheck --all --parallel
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/visitor-keys
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/parser
• Node 14 - nx test @typescript-eslint/ast-spec --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/eslint-plugin-internal --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/scope-manager
• Node 18 - nx test @typescript-eslint/ast-spec
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/typescript-estree --coverage=false
• Node 14 - nx test @typescript-eslint/type-utils --coverage=false
• Node 18 - nx test @typescript-eslint/eslint-plugin-internal
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/scope-manager --coverage=false
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/utils --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/eslint-plugin-tslint
• Node 14 - nx test @typescript-eslint/visitor-keys --coverage=false
• Node 14 - nx test @typescript-eslint/parser --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/eslint-plugin-tslint --coverage=false
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/typescript-estree
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website

---

Sent with 💌 from NxCloud.

[typescript-eslint]

Thanks for the PR, @bradzacher!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

---

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	98b6eb4
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6342746f4083cf0009129b9c
😎 Deploy Preview	https://deploy-preview-5750--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[codecov]

Codecov Report

Merging #5750 (98b6eb4) into main (6477f38) will decrease coverage by 2.47%.
The diff coverage is 91.56%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5750      +/-   ##
==========================================
- Coverage   93.82%   91.34%   -2.48%     
==========================================
  Files         134      340     +206     
  Lines        1506    10561    +9055     
  Branches      226     3108    +2882     
==========================================
+ Hits         1413     9647    +8234     
- Misses         60      647     +587     
- Partials       33      267     +234     

Flag	Coverage Δ
unittest	91.34% <91.56%> (-2.48%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...s/utils/src/eslint-utils/batchedSingleLineTests.ts	91.66% <ø> (ø)
packages/utils/src/ts-eslint/RuleTester.ts	100.00% <ø> (ø)
...s/utils/src/eslint-utils/rule-tester/RuleTester.ts	90.00% <90.00%> (ø)
packages/utils/src/eslint-utils/index.ts	100.00% <100.00%> (ø)
.../eslint-utils/rule-tester/dependencyConstraints.ts	100.00% <100.00%> (ø)
packages/utils/src/ts-eslint-scope/Scope.ts	52.17% <0.00%> (ø)
...es/eslint-plugin/src/rules/parameter-properties.ts	94.11% <0.00%> (ø)
...rc/rules/no-unnecessary-boolean-literal-compare.ts	90.36% <0.00%> (ø)
packages/utils/src/ts-eslint-scope/index.ts	100.00% <0.00%> (ø)
...utils/src/ast-utils/eslint-utils/PatternMatcher.ts	66.66% <0.00%> (ø)
... and 199 more

[JoshuaKGoldberg]

LGTM in general, very nicely done! I'm pumped to unblock the version-specific issues blocked by #1752.

Just requesting changes on discussing simplifying the API, if we can?

[JoshuaKGoldberg]

This is great, thanks @bradzacher! 🚀