chore: add doc-renderer for generating & updating detailed rule docs

[Foxeye-Rinx]

Problems:

• The new rule document (generated by npm run new) was unclear about which part is the header and which part is the body.

• In tools/update-docs.ts, when generating notes and adding them to the header section:

  • The process is too much like cutting and pasting manually on the string, it reduces the readability
  • The code for producing the new header (with notes included) is quite fragmented and long
  • Includes legacy/redundant code header.replace(/\$/g, "$$$$")
  • Inefficient and fragmented code, it creates two new items for the notes then join() it with '\n' later to create the trailing '\n\n'

      if (notes.length >= 1) {
        notes.push("", "")
      }
      ...
      const header = `\n${title}\n\n${notes.join("\n")}`

This PR:

• Create renderRuleHeader function and a RuleDocHeader type to clarify the structure of the header. Then applies this to both the generation and update tools for the detailed rule Markdown files

type RuleDocHeader = {
  ruleId: string
  description: string
  notes: string[]
}
const header = renderRuleHeader({ ruleId, description, notes })

• Make it clear there are \n\n between each part of the header in the renderRuleHeader function

Overview of this PR with image:

This renderer can be used anywhere to produce the header part of the md(x) files

Tested step:

• I ran npm run update and saw no changes, which is my expectation.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 0f44c8a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[ota-meshi]

That's great! Thank you!