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

For example,ban-ts-comment options separate out adirectiveConfigSchema ref representing a union offalse,"allow-with-description", or an object withdescriptionFormat?: string. Seehttps://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 fromschema: [ ... ] toschema: { ... } usingJSON schema's native tuple validation on just the rules causing complaints. It's a little bit uglier code but fixes the errors.

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

08025e0

Copy link

nx-cloudbot commentedAug 23, 2022•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commitcd2d9a1. 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

Sent with 💌 fromNxCloud.

Copy link

Contributor

typescript-eslintbot commentedAug 23, 2022

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 visitorsper day.

Copy link

netlifybot commentedAug 23, 2022•
edited
Loading

✅ Deploy Preview fortypescript-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 yourNetlify site settings.

Merge branch 'main' into fix-schema-definition-logs

840d72a

JoshuaKGoldberg commented

Aug 23, 2022

View reviewed changes

packages/eslint-plugin/src/rules/array-type.ts

		description:
		'The array type expected for readonly cases. If omitted, the value for `default` will be used.',
		},
		prefixItems: [

Copy link

MemberAuthor

JoshuaKGoldbergAug 23, 2022•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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

cc@bchery 😁

JoshuaKGoldberg commented

Aug 23, 2022

View reviewed changes

packages/eslint-plugin/src/rules/array-type.ts OutdatedShow resolvedHide resolved

JoshuaKGoldberg commented

Aug 23, 2022

View reviewed changes

packages/eslint-plugin/src/rules/ban-ts-comment.ts OutdatedShow resolvedHide resolved

JoshuaKGoldberg added4 commits

August 23, 2022 10:06

Fix: copy over meta.schema.prefixItems

54ccf96

A little more precise

65f20b1

Correct precision

0b6749c

Turns out it was I who had to docusaurus clear all along

74b7d44

JoshuaKGoldberg marked this pull request as ready for review

August 23, 2022 15:06

JoshuaKGoldberg requested a review frombradzacher

August 23, 2022 15:06

This was referencedAug 23, 2022

Bug: Strange logging "can't resolve reference" after update to version 5.34.0#5525

Closed

chore: fail tests that log to the console#5533

Merged

JoshuaKGoldberg added2 commits

August 24, 2022 15:13

Merge branch 'main'

392d84e

fix explicit-member-accessibility

295d5be

bradzacher approved these changes

Aug 24, 2022

View reviewed changes

Copy link

Member

bradzacher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

JoshuaKGoldbergenabled auto-merge (squash)

August 24, 2022 19:50

Merge branch 'main' into fix-schema-definition-logs

cd2d9a1

Copy link

codecovbot commentedAug 24, 2022•
edited
Loading

Codecov Report

Merging#5531 (295d5be) intomain (96b6639) willincrease coverage by2.17%.
The diff coverage isn/a.

❗ Current head295d5be differs from pull request most recent headcd2d9a1. Consider uploading reports for the commitcd2d9a1 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
... and70 more

JoshuaKGoldberg merged commitdbf8b56 intotypescript-eslint:main

Aug 24, 2022

JoshuaKGoldberg deleted the fix-schema-definition-logs branch

August 24, 2022 20:17

Copy link

MemberAuthor

JoshuaKGoldberg commentedAug 24, 2022

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

If this exact issue is still happening for you, please go throughhttps://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! ❤️

Copy link

WesleyMConner commentedAug 24, 2022

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

No longer see the issue. :)

takurinton mentioned this pull request

Aug 26, 2022

chore(deps-dev): bump @typescript-eslint/eslint-plugin from 5.33.0 to 5.35.1voyagegroup/ingred-ui#948

Merged

jarham added a commit to symcode-fi/vue-tools-test that referenced this pull request

Aug 30, 2022

chore(deps): downgrade @typescript-eslint/eslint-plugin

82dfb30

Untiltypescript-eslint/typescript-eslint#5531gets merged.

crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request

Sep 1, 2022

Update typescript-eslint monorepo to v5.35.1 (#1519)

bcad84e

This PR contains the following updates:| Package | Type | Update | Change ||---|---|---|---|| [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.33.1` -> `5.35.1`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.33.1/5.35.1) || [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.33.1` -> `5.35.1`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.33.1/5.35.1) |---### Release Notes<details><summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/eslint-plugin)</summary>### [`v5.35.1`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5351-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5350v5351-2022-08-24)[Compare Source](typescript-eslint/typescript-eslint@v5.35.0...v5.35.1)##### Bug Fixes-   **eslint-plugin:** correct rule schemas to pass ajv validation ([#&#8203;5531](typescript-eslint/typescript-eslint#5531)) ([dbf8b56](typescript-eslint/typescript-eslint@dbf8b56))### [`v5.35.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5350-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5340v5350-2022-08-24)[Compare Source](typescript-eslint/typescript-eslint@v5.34.0...v5.35.0)##### Features-   **eslint-plugin:** \[explicit-member-accessibility] suggest adding explicit accessibility specifiers ([#&#8203;5492](typescript-eslint/typescript-eslint#5492)) ([0edb94a](typescript-eslint/typescript-eslint@0edb94a))### [`v5.34.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5340-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5331v5340-2022-08-22)[Compare Source](typescript-eslint/typescript-eslint@v5.33.1...v5.34.0)##### Bug Fixes-   **eslint-plugin:** \[no-useless-constructor] handle parameter decorator ([#&#8203;5450](typescript-eslint/typescript-eslint#5450)) ([864dbcf](typescript-eslint/typescript-eslint@864dbcf))##### Features-   **eslint-plugin:** \[prefer-optional-chain] support suggesting `!foo || !foo.bar` as a valid match for the rule ([#&#8203;5266](typescript-eslint/typescript-eslint#5266)) ([aca935c](typescript-eslint/typescript-eslint@aca935c))#### [5.33.1](typescript-eslint/typescript-eslint@v5.33.0...v5.33.1) (2022-08-15)##### Bug Fixes-   missing placeholders in violation messages for `no-unnecessary-type-constraint` and `no-unsafe-argument` (and enable `eslint-plugin/recommended` rules internally) ([#&#8203;5453](typescript-eslint/typescript-eslint#5453)) ([d023910](typescript-eslint/typescript-eslint@d023910))</details><details><summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>### [`v5.35.1`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5351-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5350v5351-2022-08-24)[Compare Source](typescript-eslint/typescript-eslint@v5.35.0...v5.35.1)**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)### [`v5.35.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5350-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5340v5350-2022-08-24)[Compare Source](typescript-eslint/typescript-eslint@v5.34.0...v5.35.0)**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)### [`v5.34.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5340-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5331v5340-2022-08-22)[Compare Source](typescript-eslint/typescript-eslint@v5.33.1...v5.34.0)**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)#### [5.33.1](typescript-eslint/typescript-eslint@v5.33.0...v5.33.1) (2022-08-15)**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)</details>---### Configuration📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.--- - [x] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.---This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xNjkuMSIsInVwZGF0ZWRJblZlciI6IjMyLjE3My4wIn0=-->Co-authored-by: cabr2-bot <cabr2.help@gmail.com>Co-authored-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>Reviewed-on:https://codeberg.org/Calciumdibromid/CaBr2/pulls/1519Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request

Sep 1, 2022

Update typescript-eslint monorepo to v5.36.1 (#1530)

3e9e9f3

This PR contains the following updates:| Package | Type | Update | Change ||---|---|---|---|| [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.35.1` -> `5.36.1`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.35.1/5.36.1) || [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.35.1` -> `5.36.1`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.35.1/5.36.1) |---### Release Notes<details><summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/eslint-plugin)</summary>### [`v5.36.1`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5361-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5360v5361-2022-08-30)[Compare Source](typescript-eslint/typescript-eslint@v5.36.0...v5.36.1)**Note:** Version bump only for package [@&#8203;typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/eslint-plugin)### [`v5.36.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#&#8203;5360-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5351v5360-2022-08-30)[Compare Source](typescript-eslint/typescript-eslint@v5.35.1...v5.36.0)##### Bug Fixes-   **eslint-plugin:** revert [#&#8203;5266](typescript-eslint/typescript-eslint#5266) ([#&#8203;5564](typescript-eslint/typescript-eslint#5564)) ([7a8afe2](typescript-eslint/typescript-eslint@7a8afe2))##### Features-   support TypeScript 4.8 ([#&#8203;5551](typescript-eslint/typescript-eslint#5551)) ([81450ed](typescript-eslint/typescript-eslint@81450ed))#### [5.35.1](typescript-eslint/typescript-eslint@v5.35.0...v5.35.1) (2022-08-24)##### Bug Fixes-   **eslint-plugin:** correct rule schemas to pass ajv validation ([#&#8203;5531](typescript-eslint/typescript-eslint#5531)) ([dbf8b56](typescript-eslint/typescript-eslint@dbf8b56))</details><details><summary>typescript-eslint/typescript-eslint (@&#8203;typescript-eslint/parser)</summary>### [`v5.36.1`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5361-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5360v5361-2022-08-30)[Compare Source](typescript-eslint/typescript-eslint@v5.36.0...v5.36.1)**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)### [`v5.36.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#&#8203;5360-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5351v5360-2022-08-30)[Compare Source](typescript-eslint/typescript-eslint@v5.35.1...v5.36.0)**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)#### [5.35.1](typescript-eslint/typescript-eslint@v5.35.0...v5.35.1) (2022-08-24)**Note:** Version bump only for package [@&#8203;typescript-eslint/parser](https://github.com/typescript-eslint/parser)</details>---### Configuration📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.🔕 **Ignore**: Close this PR and you won't be reminded about these updates again.--- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.---This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzMi4xODIuNCIsInVwZGF0ZWRJblZlciI6IjMyLjE4Mi40In0=-->Co-authored-by: cabr2-bot <cabr2.help@gmail.com>Reviewed-on:https://codeberg.org/Calciumdibromid/CaBr2/pulls/1530Reviewed-by: crapStone <crapstone@noreply.codeberg.org>Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

github-actionsbot locked asresolvedand limited conversation to collaborators

Sep 24, 2022

Labels

None yet

3 participants

Movatterモバイル変換

Uh oh!

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

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

Uh oh!

Conversation

JoshuaKGoldberg commentedAug 23, 2022

PR Checklist

Overview

Uh oh!

nx-cloudbot commentedAug 23, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

typescript-eslintbot commentedAug 23, 2022

Uh oh!

netlifybot commentedAug 23, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

✅ Deploy Preview fortypescript-eslint ready!

Uh oh!

JoshuaKGoldbergAug 23, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bradzacher left a comment

Choose a reason for hiding this comment

Uh oh!

codecovbot commentedAug 24, 2022• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Codecov Report

Uh oh!

JoshuaKGoldberg commentedAug 24, 2022

Uh oh!

WesleyMConner commentedAug 24, 2022

Uh oh!

Uh oh!

nx-cloudbot commentedAug 23, 2022•
edited
Loading

netlifybot commentedAug 23, 2022•
edited
Loading

JoshuaKGoldbergAug 23, 2022•
edited
Loading

codecovbot commentedAug 24, 2022•
edited
Loading