fix(formatter_json): avoid example binary name collision#22904
Merged
graphite-app[bot] merged 1 commit intoJun 2, 2026
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR resolves a Cargo example binary name collision between oxc_formatter and oxc_formatter_json by aligning the JSON formatter example’s documented invocation with its non-colliding example target name.
Changes:
- Update the JSON formatter example usage docs to use
--example json_formatterinstead of--example formatter. - Keep the CLI examples accurate after renaming the example target to avoid
target/debug/examples/formattercollisions.
Member
Merge activity
|
Cargo currently warns when checking examples for both `oxc_formatter` and `oxc_formatter_json` because each crate has an implicit `formatter` example target. That makes both packages try to write `target/debug/examples/formatter`. This renames the JSON formatter example to `json_formatter` and updates the usage comments in the example so the command stays accurate. Checked with: ```sh cargo check --examples -p oxc_formatter -p oxc_formatter_json ```
c4ac823 to
2c86896
Compare
Boshen
added a commit
that referenced
this pull request
Jun 8, 2026
# Oxlint ### 🚀 Features - e805174 linter: Add schema for `jest/vitest/max-expects` (#23105) (Sysix) - 7850577 linter: Add schema for `jest/vitest/expect-expect` (#23104) (Sysix) - 75f641a linter: Add schema for `jest/vitest/consistent-test-it` (#23103) (Sysix) - 5125f89 linter/unicorn: Support no-null `checkArguments` option (#23098) (camc314) - b8b9797 linter: Add schema for `import-max-dependencies` (#23096) (Sysix) - 65cb47a linter/eslint: Support no-unused-expressions `ignoreDirectives` option (#23097) (camc314) - f6c36d5 linter: Add schema for `import/prefer-default-export` (#23091) (Sysix) - 0d4a5d1 linter: Add schema for `eslint/sort-vars` (#23090) (Sysix) - fdb5bf5 linter: Add schema for `eslint/radix` (#23082) (Sysix) - 05b4dcf linter: Add schema for `eslint/prefer-const` (#23081) (Sysix) - 5a06c4d linter/vue: Implement next-tick-style rule (#23041) (Alex Peshkov) - e38a36a linter: Add schema for `eslint/operator-assignment` (#23080) (Sysix) - 907cee7 linter: Add schema for `eslint/no-warning-comments` (#23075) (Sysix) - 9470bb2 linter: Add schema for `eslint/no-unused-vars` (#23073) (Sysix) - 234b5cf linter: Add schema for `eslint/no-shadow` (#23072) (Sysix) - de0dd8b linter: Add schema for `eslint/no-restricted-exports` (#23020) (Sysix) - faa3e0d linter: Add schema for `eslint/no-param-reassign` (#23018) (Sysix) - dbc9c27 linter: Add schema for `eslint/no-magic-numbers` (#23017) (Sysix) - 38d3569 linter: Add schema for `eslint/no-inner-declarations` (#23016) (Sysix) - 008fa41 linter: Add schema for `eslint/no-constant-condition` (#22991) (Sysix) - ca44623 linter: Add schema for `eslint/no-empty-function` (#22988) (Sysix) - 43eb04d linter: Add schema for `eslint/id-match` (#22987) (Sysix) - a800f27 linter: Add schema for `eslint/capitalized-comments` (#22984) (Sysix) - 96e2d32 linter: Add schema for `eslint/id-length` (#22963) (Sysix) - 545493f linter: Add schema for `eslint/complexity` (#22960) (Sysix) - 5f0b558 linter: Add schema for `eslint/class-methods-use-this` (#22959) (Sysix) - 719b720 linter: Add schema for simple rule configurations (#22948) (Sysix) - fd00966 linter: Add right schema for `eslint/max-*` rules (#22923) (Sysix) - 1226d78 linter: Fill schema with rule configurations (#22907) (Sysix) - 8f423c1 linter/vue: Implement `require-direct-export` rule (#17623) (yefan) - 78e915b linter/vue: Implement no-reserved-props rule (#22914) (bab) - 0f200a9 linter/vue: Implement require-prop-types rule (#22083) (Alex Peshkov) - 5da9da9 linter/vue: Implement no-reserved-keys rule (#21780) (bab) - 75e14a8 linter/vue: Implement prop-name-casing rule (#22892) (bab) - 85efabf semantic: Make building the class table optional, off by default (#22862) (Boshen) ### 🐛 Bug Fixes - a49b0cf linter/no-map-spread: Remove ineffective autofix (#22956) (camc314) - cf53285 parser: Report reserved type-declaration names in the parser (#23035) (Boshen) - 0383e61 linter: Fix schema for rules without a config (#22946) (Sysix) - 4d722e0 parser: Report duplicate switch `default` clause in the parser (#23012) (Boshen) - 6cb34b8 linter/plugins: Make spreading `Token` instances keep `loc` property (#22947) (Nicolas Le Cam) - 27de044 linter/plugins: Make spreading `Comment` instances keep `loc` property (#22238) (Nicolas Le Cam) - 742fd0b linter/double-comparisons: Make fixer a suggestion (#22968) (camc314) - 93f4494 linter: Respect default child config plugin when extending parent config (#22903) (Sysix) - 594ed86 linter: Deny unknown options for some rules (#22924) (Sysix) - 3253038 linter/expect-expect: Align default rule options (#22890) (camc314) - bbe44ea linter: Respect default plugins from extended config (#22896) (Sysix) ### ⚡ Performance - 0b7ce7e linter/plugins: Create global prop vars at top level of modules (#22928) (overlookmotel) - 0f7c319 linter/plugins: Define class `#loc` setter functions as `const`s (#22919) (overlookmotel) ### 📚 Documentation - 7b0380d linter: Remove preserve-caught-error note (#22994) (camc314) - dadafe3 oxlint, oxfmt: Mention migrate skills in npm READMEs (#22965) (Boshen) # Oxfmt ### 🚀 Features - 3da77e0 oxfmt: Format `parser:json5` files by `oxc_formatter_json` (#22990) (leaysgur) - c786f0d oxfmt: Format `parser:jsonc` files by `oxc_formatter_json` (#22913) (leaysgur) - 27a6db8 formatter_json: Implement jsonc variant (#22912) (leaysgur) ### 🐛 Bug Fixes - 2aedd52 oxfmt: Avoid JS promise rejects for all TSFN call sites (#23107) (leaysgur) - 01e0871 formatter,formatter_json: Handle PS/LS as line terminator (#22978) (leaysgur) - 23902d9 formatter_json: Handle CR only line breaks (#22977) (leaysgur) - 136b72b formatter_json: Use line_suffix for line comment outside array (#22931) (leaysgur) - 44e40fa formatter_json: Expand line comment inside array (#22911) (leaysgur) - 2c86896 formatter_json: Avoid example binary name collision (#22904) (camc314) ### 📚 Documentation - cc69d8d formatter_json: Update AGENTS.md (#22981) (leaysgur) - 0490721 formatter_json: Update AGENTS.md (#22976) (leaysgur) - dadafe3 oxlint, oxfmt: Mention migrate skills in npm READMEs (#22965) (Boshen) - f88961a oxfmt: Annotate each config option with supported languages (#22953) (leaysgur) - 7e514bf formatter_json: Update AGENTS.md (#22930) (leaysgur) Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
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.
Cargo currently warns when checking examples for both
oxc_formatterandoxc_formatter_jsonbecause each crate has an implicitformatterexample target. That makes both packages try to writetarget/debug/examples/formatter.This renames the JSON formatter example to
json_formatterand updates the usage comments in the example so the command stays accurate.Checked with: