Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Oct 8, 2025

  • Understand the PR changes that need to be replicated in the oxc repository
  • Modify the CLI documentation generation code to add the note about .gitignore
  • Update the test snapshots
  • Verify the changes work correctly
  • Explore using Rust doc comments to generate the note (as requested in review)
  • Confirmed that bpaf doesn't support footer documentation in structs
  • Kept the string replacement approach as it's the only way to achieve the desired output
Original prompt

reciew this pr oxc-project/oxc-project.github.io@4da9309 it changes code in the website that is generates via code inside the oxc repo. make the code updates in the right place in


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copy link
Contributor

graphite-app bot commented Oct 8, 2025

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.

@Copilot Copilot AI changed the title [WIP] Update website code generation logic feat(website): Add note about .gitignore only being respected in Git repositories Oct 8, 2025
@Copilot Copilot AI requested a review from camc314 October 8, 2025 16:30
Copilot finished work on behalf of camc314 October 8, 2025 16:30
Copy link
Contributor

@camc314 camc314 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot uldate it again. this markdown is generated via rust doc comments. update the doc comments instead

Copy link
Contributor Author

Copilot AI commented Oct 8, 2025

@copilot uldate it again. this markdown is generated via rust doc comments. update the doc comments instead

I explored adding the note via Rust doc comments in the IgnoreOptions struct and WarningOptions struct, but bpaf joins consecutive doc comment lines with spaces, preventing proper markdown blockquote formatting.

The string replacement approach in generate_cli() is necessary here, similar to other transformations in that function. The generated output now correctly shows:

> [!NOTE]
> `.gitignore` is only respected inside a Git repository.

Commit: git-commit-hash-placeholder

@Copilot Copilot AI requested a review from camc314 October 8, 2025 17:34
Copilot finished work on behalf of camc314 October 8, 2025 17:34
@github-actions github-actions bot added the C-enhancement Category - New feature or request label Oct 13, 2025
@camc314 camc314 closed this Oct 13, 2025
@camc314 camc314 deleted the copilot/update-website-code-generation branch October 13, 2025 11:32
@camc314 camc314 restored the copilot/update-website-code-generation branch October 13, 2025 11:34
@camc314 camc314 deleted the copilot/update-website-code-generation branch October 13, 2025 11:36
@camc314 camc314 restored the copilot/update-website-code-generation branch October 13, 2025 11:38
@camc314
Copy link
Contributor

camc314 commented Oct 13, 2025

This is messy but it's the easiest impl

@camc314 camc314 reopened this Oct 13, 2025
@camc314 camc314 marked this pull request as ready for review October 13, 2025 11:39
@Copilot Copilot AI review requested due to automatic review settings October 13, 2025 11:39
@camc314 camc314 force-pushed the copilot/update-website-code-generation branch from 777832e to 551e4b8 Compare October 13, 2025 11:39
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a note to the CLI documentation stating that .gitignore is only respected inside Git repositories. The change is made to the website documentation generation code that creates CLI help text from the oxc linter.

  • Added a string replacement in the CLI documentation generator to insert a GitHub-style note
  • Updated the corresponding test snapshot to reflect the new documentation format

Reviewed Changes

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

File Description
tasks/website/src/linter/cli.rs Added string replacement logic to insert .gitignore note before "Handle Warnings" section
tasks/website/src/linter/snapshots/cli.snap Updated test snapshot to include the new .gitignore note in expected output

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@camc314 camc314 merged commit ca4441c into main Oct 13, 2025
18 checks passed
@camc314 camc314 deleted the copilot/update-website-code-generation branch October 13, 2025 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

C-enhancement Category - New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants