Fix CLI consistency: remove emojis from help strings, fix apm config invocation, update descriptions#212
Conversation
…ig group, update uninstall description, fix --yes trailing period - Add invoke_without_command=True to config group so bare `apm config` shows config - Remove emojis from command help strings (init, install, update, compile) - Remove emojis from compile option descriptions (5 options) - Remove emojis from deps subcommand help strings (list, tree, clean, update, info) - Fix trailing period on runtime remove --yes option - Update uninstall help to reflect full scope - Remove emojis from all docs/cli-reference.md section headings Co-authored-by: danielmeppiel <51440732+danielmeppiel@users.noreply.github.com>
apm config invocation, update descriptions
There was a problem hiding this comment.
Pull request overview
This PR aims to align the CLI and CLI reference docs with the “no emojis in output” policy, while also fixing apm config so that running it without subcommands shows the configuration view rather than Click help.
Changes:
- Removed emojis from various CLI command/help strings and from
docs/cli-reference.mdsection headings. - Fixed
apm configbare invocation by enablinginvoke_without_command=True. - Updated help/description strings (e.g.,
uninstallscope wording, explicit--yeshelp text forruntime remove).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/apm_cli/commands/deps.py | Removes emojis from deps subcommand help strings. |
| src/apm_cli/cli.py | Removes emojis from top-level/option help strings; fixes apm config invocation; tweaks uninstall and runtime remove help text. |
| docs/cli-reference.md | Removes emojis from CLI reference headings to match updated CLI output/help strings. |
|
|
||
|
|
||
| @deps.command(help="🌳 Show dependency tree structure") | ||
| @deps.command(help="Show dependency tree structure") |
There was a problem hiding this comment.
There are trailing spaces at the end of this decorator line. This can cause noisy diffs and may fail formatting/lint checks; please remove the extra whitespace.
|
|
||
| @cli.group(help="Configure APM CLI") | ||
| @cli.group(help="Configure APM CLI", invoke_without_command=True) | ||
| @click.pass_context | ||
| def config(ctx): | ||
| """Configure APM CLI settings.""" |
There was a problem hiding this comment.
Now that apm config runs without a subcommand, its output becomes a primary user-facing surface. The configuration table title includes an emoji (see the config_table = Table(... title=...) a few lines above), which seems to conflict with this PR’s “no emojis in output” goal; please remove emoji characters from this output as well.
|
|
||
| @cli.group(help="Configure APM CLI") | ||
| @cli.group(help="Configure APM CLI", invoke_without_command=True) | ||
| @click.pass_context | ||
| def config(ctx): | ||
| """Configure APM CLI settings.""" |
There was a problem hiding this comment.
This change alters default CLI behavior (apm config now executes and prints config instead of showing help). There are existing Click/CliRunner tests for other CLI commands, but none covering apm config’s bare invocation; please add a test that invokes config with no subcommand and asserts a successful exit code and expected output.
| ### `apm uninstall` - Remove APM packages | ||
|
|
||
| Remove installed APM packages and their integrated files. | ||
|
|
There was a problem hiding this comment.
The uninstall section summary doesn’t mention that apm uninstall also removes entries from apm.yml (which is part of the command’s behavior and is called out later in the table/behavior list). Consider updating this one-line description to match the more complete scope described elsewhere (and the updated CLI help string).
Description
Addresses all 5 findings from the CLI Consistency Report (3 medium, 2 low).
apm configwithout subcommands — The config group had display logic for bareapm configbut lackedinvoke_without_command=True, so Click showed help text (exit 2) instead of the config table (exit 0).Emoji removal — 4 top-level commands, 5
compileoptions, and 5depssubcommands had emojis in help strings, violating the "no emojis in output" policy. Removed all of them.--yestrailing period —@click.confirmation_optiononruntime removeused Click's default help text which ends with a period. Added explicithelp=without it.uninstalldescription — Updated from "Remove APM packages from apm.yml and apm_modules" → "Remove APM packages, their integrated files, and apm.yml entries" to reflect actual scope (prompts, agents, hooks, lockfile entries).Docs — Removed emojis from all
docs/cli-reference.mdsection headings to match CLI output.Type of change
Testing
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.