feat(website): auto generate oxfmt docs

[Boshen]

Corresponding PR: oxc-project/website#643

The next PR will get the json schema auto generated as well.

[Boshen]

• feat(website): auto generate oxfmt docs #15985 👈 (View in Graphite)
• main

---

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

• 0-merge - adds this PR to the back of the merge queue
• hotfix - for urgent hot fixes, skip the queue and merge this PR next

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

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

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

[Copilot]

Pull request overview

This PR adds auto-generation of CLI documentation for the oxfmt formatter tool, mirroring the existing functionality for the oxlint linter. The implementation follows the established pattern of using bpaf's render_markdown method with post-processing to convert the output to VitePress-compatible markdown format.

Key changes include:

• New formatter module in the website task runner that generates CLI documentation from the oxfmt command structure
• Integration with the existing justfile build process to generate formatter documentation alongside linter documentation
• Minor documentation fixes in the oxfmt command definitions (typo correction and usage text cleanup)

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
tasks/website/src/main.rs	Added formatter command handler to the task runner CLI
tasks/website/src/lib.rs	Exported new formatter module
tasks/website/src/formatter/mod.rs	New module that re-exports CLI generation functionality
tasks/website/src/formatter/cli.rs	Implements CLI markdown generation following the linter pattern, with formatter-specific section adjustments
tasks/website/Cargo.toml	Added oxfmt dependency for CLI introspection
justfile	Added formatter-cli command to generate CLI documentation
apps/oxfmt/src/command.rs	Fixed documentation typo and added hide_usage attributes to simplify help output
Cargo.lock	Auto-generated dependency updates

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[codspeed-hq]

CodSpeed Performance Report

Merging #15985 will not alter performance

_{Comparing 11-23-feat_website_auto_generate_oxfmt_docs (91a3e0a) with main (889d2e7)¹}

Summary

✅ 42 untouched
⏩ 3 skipped²

Footnotes

1. No successful run was found on main (38b7bc4) during the generation of this report, so 889d2e7 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

2. 3 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

[leaysgur]

❯ cargo run -p website_formatter cli

error[E0609]: no field `external_formatter` on type `&FormatService`
  --> apps/oxfmt/src/service.rs:98:21
   |
98 |             || self.external_formatter.is_none()
   |                     ^^^^^^^^^^^^^^^^^^ unknown field
   |
   = note: available fields are: `allocator_pool`, `cwd`, `output_options`, `format_options`

error[E0308]: `if` and `else` have incompatible types
   --> apps/oxfmt/src/service.rs:101:16
    |
 96 |           let formatted = if cfg!(not(feature = "napi"))
    |  _________________________-
 97 | |             || self.format_options.embedded_language_formatting.is_off()
 98 | |             || self.external_formatter.is_none()
    | |________________________________________________- `if` and `else` have incompatible types
 99 |           {
100 |               base_formatter.format(&ret.program)
    |               ----------------------------------- expected because of this
101 |           } else {
    |  ________________^
102 | |             #[cfg(feature = "napi")]
103 | |             {
104 | |                 let Some(external_formatter) = &self.external_formatter else {
...   |
110 | |         };
    | |_________^ expected `Formatted<'_>`, found `()`

Some errors have detailed explanations: E0308, E0609.
For more information about an error, try `rustc --explain E0308`.
error: could not compile `oxfmt` (lib) due to 2 previous errors

As a result, nothing is printed. I will fix this first in another PR.

[leaysgur]

(Git operations failed, currently performing recovery operations...)

[leaysgur]

Will merge after CI.

Also, oxc-project/website#643

[leaysgur]

Merge activity

• Nov 26, 3:45 AM UTC: The merge label '0-merge' was detected. This PR will be added to the Graphite merge queue once it meets the requirements.
• Nov 26, 3:45 AM UTC: leaysgur added this pull request to the Graphite merge queue.
• Nov 26, 3:53 AM UTC: Merged by the Graphite merge queue.