Add beachball config get and config list commands#1190
Merged
ecraig12345 merged 10 commits intomainfrom Mar 28, 2026
Merged
Conversation
Implements the `beachball config get <name>` command that displays the effective value of a specified config setting. For settings that can be overridden per-package (tag, defaultNpmTag, disallowedChangeTypes, gitTags, shouldPublish), it shows any package-level overrides. For disallowedChangeTypes, group overrides are also displayed. Supports `--package` to get the setting value for specific package(s). Co-authored-by: ecraig12345 <5864305+ecraig12345@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsoft/beachball/sessions/c8df7bfa-8b52-461a-aabf-b5e2a0cbd8e7
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.
Summary
Adds
beachball config get <name>andbeachball config listcommands for inspecting the effective beachball configuration.Currently the intent of these commands is to be read by humans or AI agents, not parsed. The format is similar to YAML, but keys are never quoted, and there's special logic for values such as functions, class instances, and undefined.
Fixes #1185
config get <name>Gets the value of a specific config setting, including any per-package or per-group overrides. Supports
--packageto query the effective value for specific packages (accounting for group membership). Note that logged string values will be quoted, which is different from e.g.git config.config listLists all config settings (including defaults), plus any group and per-package overrides, using YAML-like formatting. (Note that keys are not quoted, so it may not be valid YAML.)
Other changes
src/logging/formatValue.ts— New YAML-like value formatter with width-aware single-line/multi-line output, used by both commandssrc/options/getCliOptions.ts— Added_extraPositionalArgssupport for subcommand parsingsrc/help.tsanddocs/cli/config.md— Help text and doc site page for both commands.claude/skills/beachball-change-file/SKILL.md— Updated to usebeachball config getinstead of manually reading config files