Skip to content

Docs: Add descriptions to rule schema options #5392

Closed
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

From discussion in #5058 (comment) and #5386 (comment) & #5386 (comment): it'd be great to use JSON schema description fields on rule options per https://json-schema.org/draft/2020-12/json-schema-core.html#name-schema-vocabularies. That way auto-generated rule docs (#5058) will be more informative.

This will likely involve turning a lot of type string literal union types into enums.

Affected URL(s)

http://typescript-eslint.io/rules/*

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issuedocumentationDocumentation ("docs") that needs adding/updatinglocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions