Skip to content

RuleCreator's types do not support rules without a documentation URL #4133

@JoshuaKGoldberg

Description

@JoshuaKGoldberg
  • I have tried restarting my IDE and the issue persists. N/A
  • I have updated to the latest version of the packages.
  • I have read the FAQ and my problem is not listed.

Repro

Going off the code snippet here: #4124 (comment)

The recommended RuleCreator adds a requirement to provide a urlCreator: (ruleName: string) => string parameter. However, when writing rules that don't have a dedicated docs page -such as local one-of rules with eslint-plugin-local-rules, there should not be a url attached.

Can we make that urlCreator optional so that the docs doesn't attach a url if not needed?

Versions

package version
@typescript-eslint/experimental-utils 5.3.1
TypeScript N/A
node N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    package: utilsIssues related to the @typescript-eslint/utils packagetriageWaiting for team members to take a look

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions