Fix CLI consistency report gaps#1972
Open
WilliamK112 wants to merge 2 commits into
Open
Conversation
Signed-off-by: Ching Wei Kang <WilliamK112@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Addresses gaps from the CLI consistency report (Issue #1968) by improving CLI help text consistency, adding missing CLI reference docs, and adding regression tests to keep help output aligned with docs.
Changes:
- Added/updated CLI help text for
config get,deps clean --yes,init --yes, and improved the deprecatedunpacktop-level summary. - Extended integration coverage to regression-test
apm --helpandapm config get --helpoutput. - Updated docs: added
apm doctorreference page and expanded the reference index command table.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| tests/integration/test_wave6_init_pack_coverage.py | Adds regression assertion that top-level help names the unpack replacement. |
| tests/integration/test_wave4_cli_commands_coverage.py | Adds regression assertion that config get --help documents list-all behavior. |
| src/apm_cli/commands/pack.py | Adds short_help for deprecated unpack to surface replacement in apm --help. |
| src/apm_cli/commands/init.py | Aligns --yes help wording with the consistency report. |
| src/apm_cli/commands/deps/cli.py | Aligns deps clean --yes help wording. |
| src/apm_cli/commands/config.py | Updates config get command help to mention omit-KEY list-all behavior. |
| README.md | Updates the “CLI Reference” link target. |
| docs/src/content/docs/reference/index.md | Adds missing commands (incl. doctor) to the reference index table. |
| docs/src/content/docs/reference/cli/init.md | Updates init --yes wording to match CLI help. |
| docs/src/content/docs/reference/cli/doctor.md | Adds the missing apm doctor CLI reference page. |
| docs/src/content/docs/reference/cli/deps.md | Updates deps clean --yes wording to match CLI help. |
Signed-off-by: Ching Wei Kang <WilliamK112@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.
Summary
Fixes #1968.
apm doctorCLI reference page and link it from the reference indexconfig get,deps clean --yes,init --yes, and deprecatedunpackhelp textconfig get --helpand the top-levelunpackreplacement summaryVerification
uv run pytest tests/integration/test_wave4_cli_commands_coverage.py::TestConfigCommand tests/integration/test_wave6_deps_cli_coverage.py::TestDepsClean tests/integration/test_wave6_init_pack_coverage.py::TestInitBasic tests/integration/test_wave6_init_pack_coverage.py::TestPackBasic -quv run ruff check src/apm_cli/commands/config.py src/apm_cli/commands/deps/cli.py src/apm_cli/commands/init.py src/apm_cli/commands/pack.py tests/integration/test_wave4_cli_commands_coverage.py tests/integration/test_wave6_init_pack_coverage.pyuv run ruff format --check src/apm_cli/commands/config.py src/apm_cli/commands/deps/cli.py src/apm_cli/commands/init.py src/apm_cli/commands/pack.py tests/integration/test_wave4_cli_commands_coverage.py tests/integration/test_wave6_init_pack_coverage.pyuv run apm --helpuv run apm config get --helpuv run apm deps clean --helpuv run apm init --helpuv run apm doctor --helpgit diff --checkcd docs && npm ci && npm run build(passes; existing Astro/Vite warnings only, internal links valid)Signed-off-by: WilliamK112 WilliamK112@users.noreply.github.com