Repository navigation
📝 document yarn format --write in AGENTS.md - #5125
Draft
thomas-lebeau wants to merge 1 commit into
Draft
thomas-lebeau wants to merge 1 commit into
thomas-lebeau wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
AGENTS.mdlistedyarn formatunder "Format code", but the script isprettier --check .: it only reports issues and never modifies files. Agents (and humans) following it after a bulk edit believe the code was formatted when it wasn't, and theformatCI job fails afterwards — this happened on #5022. Agents also tend to fall back to callingyarn prettierdirectly, which can diverge from what CI checks.Changes
Documentation only, root
AGENTS.md"Key Commands":yarn formatas a check (--check, does not modify files).yarn format --writeto fix formatting (Yarn appends the flag; Prettier 3 accepts--check --write, rewrites the files and lists them).yarn formatscript rather thanyarn prettier, and to check its output after scripted/bulk edits.Test instructions
Checklist