PR Checklist

• Addresses an existing open issue:fixesDocs: Automate the Options heading in rule docs pages #5058
• That issue was marked asaccepting prs
• Steps inCONTRIBUTING.md were taken

Overview

Uses even more fancy Markdown AST manipulations in thegenerated-rule-docs.ts Docusaurus plugin to automate the creation of much of the rules docs pages.

• ## How to Use, and `## Options are added if they don't yet exist
• Contents are added to the beginning of## Options:
  • Base rule extensions have a link to the base rule's options
  • An.eslintrc.cjs snippet adds in the suggested config usage
  • If the rule isn't configurable, theThis rule is not configurable. text is added
  • If the rule is configurable,json-schema-to-typescript andprettier are used to print the types anddefaultConfig
• description fields are used in rule schema metadata instead of.md explanations

Assorted other standardizations:

• Using Docusaurus admonitions for deprecation notices and the like
• Explaining default options is moved under## Options (e.g.ban-ts-comment.md)
• Properly using tabs in at leastban-types.md
• Listing out string literal options (e.g.comma-dangle.md)
• Using/* eslint ... */ comments in options examples

Some old todos from when this PR was a draft should be done:

• getOptions heading in right sidebar ✅
• see if json-schema-to-typescript can make shared types for repeated shapes this week I learned,definitions properties are the intended way to explicitly do that in json-schema ✨ ✅
• finish trimming down more rule docs.md files ✅