feat(website): auto-generate rule docs pages

[DonIsaac]

AI-generated description because I'm lazy

TL;DR

This PR introduces the ability to generate documentation for linter rules and adds new methods and metadata for rule fix capabilities.

To see what this looks like, please check out oxc-project/oxc-project.github.io#165.

Screenshots

Hyperlinks to rule doc pages in auto-generated rules table

Example of a docs page

What changed?

• Added RuleFixMeta to indicate rule fix capabilities
• Introduced methods is_none and is_pending in RuleFixMeta
• Modified render_markdown_table in RuleTableSection to accept an optional link prefix
• Created new modules for rule documentation and HTML rendering
• Updated print_rules function to generate markdown for rules and detailed documentation pages

How to test?

Run the linter-rules task with appropriate arguments to generate the markdown table and documentation pages.
Verify the generated files for correctness and that all metadata is correctly displayed.

Why make this change?

To enhance the project documentation and provide clear rule fix capabilities, thereby improving the developer experience and easing the integration process.

---

[graphite-app]

Your org has enabled the Graphite merge queue for merging into main

Add the label “merge” to the PR and Graphite will automatically add it to the merge queue when it’s ready to merge. Or use the label “hotfix” to add to the merge queue as a hot fix.

You must have a Graphite account and log in to Graphite in order to use the merge queue. Sign up using this link.

[DonIsaac]

• feat(linter): add fix emoji to rules table and doc pages #4715
• test(linter): ensure rule docs have valid syntax #4644
• feat(website): auto-generate rule docs pages #4640 👈
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @DonIsaac and the rest of your teammates on Graphite

[DonIsaac]

I think #1783 will help us add documentation for rule configs. We can implement JsonSchema for those configs, then add config_schema(&self) -> Option<Self::Schema> to RuleMeta to render config sections.

[DonIsaac]

I think we also need tests on rule documentation to ensure they produce valid markdown. I'm seeing errors in the website's build pipeline.

Edit: Added this to a down-stack PR, but it doesn't run textlint. It just ensures the MD parses correctly.

[codspeed-hq]

CodSpeed Performance Report

Merging #4640 will not alter performance

_{Comparing don/08-04-feat_website_auto-generate_rule_docs_pages (f629514) with main (d191823)}

Summary

✅ 29 untouched benchmarks

[Boshen]

Let me defer this merge to the next release. I'll work on releasing the current version first.

[graphite-app]

Merge activity

• Aug 9, 8:10 PM EDT: The merge label 'merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
• Aug 9, 8:10 PM EDT: Boshen added this pull request to the Graphite merge queue.
• Aug 9, 8:17 PM EDT: Boshen merged this pull request with the Graphite merge queue.