Fix some optional config file boolean options not being honored #188
Conversation
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
Boolean CLI options with defaults (keepComments, sortComponentsProps, split) were not being respected when set in a config file. This happened because Commander.js always sets these options to their default values, and the subsequent Object.assign would overwrite config file values with CLI defaults. The fix applies the same pattern already used for lineWidth, sort, and bundle: explicitly check for config file values before the merge, using nullish coalescing to preserve CLI-specified values when present. Co-Authored-By: Claude Opus 4.5 <[email protected]>
jdechicchis
force-pushed
the
fix/config-file-boolean-options
branch
from
67f88a7 to
f04cd0e
Compare
thim81
reviewed
Jan 9, 2026
| exports[`openapi-format CLI command should respect boolean options from .openapiformatrc 1`] = ` | ||
| "================================================================================ | ||
| OpenAPI-Format CLI settings: | ||
| - .openapiformatrc: /Users/joseph/oss/openapi-format/.openapiformatrc |
Owner
There was a problem hiding this comment.
Can you rework this, since it should not snapshot your local user path.
Owner
|
hi @jdechicchis Nice that you spotted this. The test runs spotted a small issue with your local user ending up in the snapshot: If you correct this, the PR will be included in the next release. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I noticed that the
keepCommentsoption wasn't being honored when passing a config file like:openapi-format api.yaml -o api.yaml --configFile .openapi-format.json..openapi-format.jsoncontents:Passing the option as a CLI flag worked as expected:
openapi-format api.yaml -o api.yaml --keepComments.Upon some investigation, it appears the source of the bug is with how CLI flags with default values are handled in
bin/cli.js. It looks like there was already special handling for flags likelineWidthandsort. This PR adds similar handling forkeepComments,sortComponentsProps, andsplitNote, this fix could result in the format output differing once folks upgrade their
openapi-formatversion if their current formatting "relied" on these options not being honored when configured via a config file