Skip to content

Lint rule docs: link to playground with rule enabled? #974

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

One of the best parts of having an online playground like https://playground.oxc.rs is being able to quickly check how a lint rule behaves. It'd be nice if each lint rule's docs linked to the playground configured to have just that rule enabled. Would you be open to adding this to rule docs?

Example:

A nice followup / "bonus" feature would be to have each rule docs page example link to the equivalent code (and rule options, if configured) in the playground.

For reference, typescript-eslint rule docs such as https://typescript-eslint.io/rules/prefer-namespace-keyword do both of those. See that page's "Try this rule in the playground" and "Open in Playground" links.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Priority

    None yet

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions