fix(eslint-plugin): correct rule schemas to pass ajv validation

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing open issue: fixes Bug: Strange logging "can't resolve reference" after update to version 5.34.0 #5525
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

Many rules use one or both of the following JSON schema features:

• Using a tuple (fixed size array) of size two for their options schema.
• Using schema refs to repeat types. Those types get printed as individual interfaces or unions on https://typescript-eslint.io.

For example, ban-ts-comment options separate out a directiveConfigSchema ref representing a union of false, "allow-with-description", or an object with descriptionFormat?: string. See https://typescript-eslint.io/rules/ban-ts-comment/#options.

Although what we use to auto-generate much of the rule docs on typescript-eslint.io works for rules that both use the array format and schema refs (#5386), the settings used by ESLint during runtime validation are apparently much more strict.

This PR switches from schema: [ ... ] to schema: { ... } using JSON schema's native tuple validation on just the rules causing complaints. It's a little bit uglier code but fixes the errors.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit cd2d9a1. 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=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 18 - nx test @typescript-eslint/visitor-keys
• 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 18 - nx test @typescript-eslint/scope-manager
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=typecheck --all --parallel
• Node 18 - nx test @typescript-eslint/eslint-plugin-tslint
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/parser
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/visitor-keys --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 14 - nx test @typescript-eslint/scope-manager --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/typescript-estree --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/type-utils --coverage=false
• Node 14 - nx test @typescript-eslint/parser --coverage=false
• Node 18 - nx test @typescript-eslint/ast-spec
• 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 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 14 - nx test @typescript-eslint/ast-spec --coverage=false
• Node 14 - nx test @typescript-eslint/utils --coverage=false
• 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 14 - nx test @typescript-eslint/eslint-plugin-tslint --coverage=false
• Node 18 - nx test @typescript-eslint/eslint-plugin-internal
• Node 14 - nx test @typescript-eslint/eslint-plugin-internal --coverage=false
• 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
• 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, @JoshuaKGoldberg!

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	cd2d9a1
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6306812970caa50008f52555
😎 Deploy Preview	https://deploy-preview-5531--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.

[JoshuaKGoldberg]

This syntax is a little more heavyweight than schema: [ ... ] arrays. It would be nice if someone could figure out a way to use $refs within arrays. I couldn't.

cc @bchery 😁

[bradzacher]

[codecov]

Codecov Report

Merging #5531 (295d5be) into main (96b6639) will increase coverage by 2.17%.
The diff coverage is n/a.

❗ Current head 295d5be differs from pull request most recent head cd2d9a1. Consider uploading reports for the commit cd2d9a1 to get more accurate results

@@            Coverage Diff             @@
##             main    #5531      +/-   ##
==========================================
+ Coverage   91.75%   93.92%   +2.17%     
==========================================
  Files         366      290      -76     
  Lines       12380    10024    -2356     
  Branches     3611     3016     -595     
==========================================
- Hits        11359     9415    -1944     
+ Misses        669      330     -339     
+ Partials      352      279      -73     

Flag	Coverage Δ
unittest	93.92% <ø> (+2.17%)	⬆️

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

Impacted Files	Coverage Δ
packages/eslint-plugin/src/rules/array-type.ts	97.14% <ø> (ø)
packages/eslint-plugin/src/rules/ban-ts-comment.ts	96.96% <ø> (ø)
...-plugin/src/rules/explicit-member-accessibility.ts	97.43% <ø> (ø)
...es/eslint-plugin/src/rules/parameter-properties.ts	94.11% <ø> (ø)
...gin-internal/src/rules/no-poorly-typed-ts-props.ts
packages/eslint-plugin-tslint/src/custom-linter.ts
...ckages/typescript-estree/src/jsx/xhtml-entities.ts
...lugin-internal/src/rules/plugin-test-formatting.ts
packages/type-utils/src/getTokenAtPosition.ts
packages/visitor-keys/src/visitor-keys.ts
... and 70 more

[JoshuaKGoldberg]

This is released in @typescript-eslint/eslint-plugin@5.35.1! ✨ Please update all packages under @typescript-eslint/ in your package.jsons to the latest version, same version.

If this exact issue is still happening for you, please go through https://github.com/typescript-eslint/typescript-eslint/issues/new/choose to file a new issue. Be sure to check all versions of your installed packages.

Thanks for your patience all - and apologies again for the disruption! ❤️

[WesleyMConner]

@typescript-eslint/eslint-plugin 5.34.0 → 5.35.1
@typescript-eslint/parser 5.34.0 → 5.35.1

No longer see the issue. :)