CLI-1731: ACLI documentation expose MEO commands that should be hidden

[jigar-shah-acquia]

Motivation

Fixes #CLI-1731 ACLI documentation expose MEO commands that should be hidden

---

Proposed changes

• src/Command/Api/ApiCommandHelper.php

  • generateApiListCommands(): Replaced the inner loop that used break with a call to a new helper. Visibility is now computed via namespaceHasVisibleCommand().
  • New namespaceHasVisibleCommand(array $apiCommands, string $namespace): bool: Encapsulates “does this namespace have at least one non-hidden command?” and uses early return true instead of break, removing the Break_ mutation at that site.
  • No change in end-user behavior; list commands are still created only for namespaces that have at least one visible command.

• src/Command/Self/MakeDocsCommand.php

  • execute(): Replaced inline $command['hidden'] ?? false with self::isCommandHiddenInDocs($command).
  • New isCommandHiddenInDocs(array $command): bool: Public static helper that returns $command['hidden'] ?? false so the “hidden in docs” rule is testable and the FalseValue/Coalesce mutations can be killed by direct unit tests.
  • No change in behavior: commands without a hidden key are still included; commands with hidden => true are still excluded.

---

Alternatives considered

N/A

Testing steps

1. Follow the contribution guide to set up your development environment or download a pre-built acli.phar for this PR.
2. If running from source, clear the kernel cache to pick up new and changed commands: ./bin/acli ckc
3. Check for regressions
   • Run the full PHPUnit suite: ./vendor/bin/phpunit
   • Run API list–related tests: ./vendor/bin/phpunit tests/phpunit/src/Commands/Api/ApiCommandHelperTest.php tests/phpunit/src/Commands/Api/ApiListCommandTest.php
   • Run docs-related tests: ./vendor/bin/phpunit tests/phpunit/src/Commands/Self/MakeDocsCommandTest.php
   • From source, run ./bin/acli api and ./bin/acli api:accounts (or another namespace) and confirm list output and subcommands are unchanged.
4. Check new functionality
   • Run Infection (if configured) and confirm the previously surviving mutations in ApiCommandHelper.php (e.g. LogicalAnd, ConcatOperandRemoval, Break_) and MakeDocsCommand.php (FalseValue, Coalesce) are killed.
   • Optionally run docs dump and confirm hidden commands are excluded and non-hidden are included: ./bin/acli self:make-docs --dump=/tmp/acli-docs and inspect index.json and presence/absence of self:make-docs.json.

[Copilot]

Pull request overview

This PR addresses CLI-1731 by ensuring hidden commands are excluded from generated ACLI documentation, and adds targeted unit tests to lock in the intended “hidden in docs” and API namespace visibility behavior.

Changes:

• Update docs generation to skip commands marked as hidden in the Symfony JSON descriptor output.
• Refactor API list-command generation to use a helper for “namespace has at least one visible command”.
• Add/extend PHPUnit coverage to verify hidden-command exclusion and API namespace list-command creation behavior.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
src/Command/Self/MakeDocsCommand.php	Filters out hidden commands during JSON docs dump via isCommandHiddenInDocs() helper.
tests/phpunit/src/Commands/Self/MakeDocsCommandTest.php	Adds tests to validate hidden-command handling and exclusion from dumped docs/index.
src/Command/Api/ApiCommandHelper.php	Refactors namespace visibility check into namespaceHasVisibleCommand() and gates list-command creation on visibility.
tests/phpunit/src/Commands/Api/ApiCommandHelperTest.php	Adds new tests for list-command creation rules based on namespace visibility/hidden state.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[codecov]

Codecov Report

❌ Patch coverage is 96.55172% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 92.33%. Comparing base (747540a) to head (06b16ac).
⚠️ Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
src/Command/Api/ApiCommandHelper.php	94.44%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #1970      +/-   ##
============================================
+ Coverage     92.30%   92.33%   +0.02%     
- Complexity     1921     1932      +11     
============================================
  Files           122      122              
  Lines          7009     7035      +26     
============================================
+ Hits           6470     6496      +26     
  Misses          539      539              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[github-actions]

Try the dev build for this PR: https://acquia-cli.s3.amazonaws.com/build/pr/1970/acli.phar

curl -OL https://acquia-cli.s3.amazonaws.com/build/pr/1970/acli.phar
chmod +x acli.phar

[anujkaushal]

LGTM

➜  cli git:(CLI-1731) ./bin/acli self:make-docs --dump=/tmp/acli-docs/1
➜  cli git:(CLI-1731) cd /tmp/acli-docs/1

➜  1 ls -l | grep -i v3
➜  1 ls -l | grep -i site-instances
➜  1

[danepowell]

This seems brittle; I foresee a time when we have to add or remove commands and no one thinks to look here to hide/unhide them.

We already track which individual commands are hidden. It seems like you could simply hide any namespace that has no visible commands.

I leave it to you to decide, maybe that's too much effort, given how we build the command list iteratively. If so, I don't want to hold up this ticket.

[jigar-shah-acquia]

@danepowell I have updated the logic for the namespaceHasHiddenCommand function as suggested. Please take a look so I can proceed with merging.