Skip to content

docs: keep every formatter out of vendored and agent paths - #59

Open
baronunread wants to merge 1 commit into
dmmulroy:mainfrom
baronunread:docs/formatter-ignores
Open

baronunread wants to merge 1 commit into
dmmulroy:mainfrom
baronunread:docs/formatter-ignores

Conversation

@baronunread

Copy link
Copy Markdown

The install steps only add formatter ignores for Vite+ (fmt.ignorePatterns). In repositories that use a standalone formatter, the vendored plugin and agent directories get formatted, so later updates start from a whitespace-only diff against upstream. This makes the three-way merge in references/update.md noisier.

This change extends step 3 (and the README) to:

  • merge the same ignore patterns into whatever the formatter reads: .oxfmtrc.json, .prettierignore (also read by bun fmt), bunfig.toml [fmt], biome.json, dprint.json;
  • exclude the same paths in pre-commit hooks that format staged files. Some formatters (oxfmt, bun fmt) exit with an error when every file passed to them is ignored, which blocks commits that touch only agent assets.

The step's completion criterion now includes the formatter ignores. Docs only; pnpm check passes.

🤖 Generated with Claude Code

The install steps only covered Vite+'s fmt.ignorePatterns. Standalone
formatters (oxfmt, Prettier, bun fmt, Biome, dprint) and staged-file
format hooks rewrote the vendored plugin, so later updates started from
a whitespace-only diff against upstream.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant