Skip to content

Rule proposal: require-meta-docs-url #55

Closed
@mysticatea

Description

@mysticatea

Since eslint/eslint#9788, meta.docs.url is the official place to show the link to rule documentation. It would be good if there is a rule to enforce to write the link. Additionally, it's awesome if the rule is fixable.

{
    "eslint-plugin/require-meta-docs-url": [
        "error",
        { "pattern": "https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/{{name}}.md" }
    ]
}
  • pattern (string) ... the URL pattern. Default is undefined. If this option is specified, the rule fixes meta.docs.url automatically. It replaces the {{name}} placeholder to rule name (path.basename(context.getFilename(), ".js")).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions