feat(website): Add note about .gitignore only being respected in Git repositories (#14443)

Copilot · camc314 · web-flow · commit ca4441c543df · 2025-10-13T12:53:34.000+01:00
- [x] Understand the PR changes that need to be replicated in the oxc
repository
- [x] Modify the CLI documentation generation code to add the note about
.gitignore
- [x] Update the test snapshots
- [x] Verify the changes work correctly
- [x] Explore using Rust doc comments to generate the note (as requested
in review)
- [x] Confirmed that bpaf doesn't support footer documentation in
structs
- [x] Kept the string replacement approach as it's the only way to
achieve the desired output

Co-authored-by: copilot-swe-agent[bot] &lt;198982749+Copilot@users.noreply.github.com&gt;
Co-authored-by: camc314 &lt;18101008+camc314@users.noreply.github.com&gt;
diff --git a/tasks/website/src/linter/cli.rs b/tasks/website/src/linter/cli.rs
@@ -29,7 +29,7 @@ fn generate_cli() -> String {
     // Hack usage line
     let markdown = markdown.replacen("**Usage**:", "## Usage\n", 1);
 
-    markdown
+    let markdown = markdown
         .split('\n')
         .flat_map(|line| {
             // Hack the bug on the line containing `###`
@@ -50,5 +50,12 @@ fn generate_cli() -> String {
             }
         })
         .collect::<Vec<_>>()
-        .join("\n")
+        .join("\n");
+
+    // Add note about .gitignore only being respected inside Git repositories
+    // This note should appear after the ignore options and before "Handle Warnings"
+    markdown.replace(
+        "\n\n## Handle Warnings\n",
+        "\n\n> [!NOTE]\n> `.gitignore` is only respected inside a Git repository.\n\n## Handle Warnings\n"
+    )
 }
diff --git a/tasks/website/src/linter/snapshots/cli.snap b/tasks/website/src/linter/snapshots/cli.snap
@@ -101,6 +101,9 @@ Arguments:
 
 
 
+> [!NOTE]
+> `.gitignore` is only respected inside a Git repository.
+
 ## Handle Warnings
 - **`    --quiet`** &mdash; 
   Disable reporting on warnings, only errors are reported
