Skip to content

feat(occ): add default help text with docs link to all commands #54180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AndyScherzinger merged 3 commits into from
Sep 2, 2025
Merged

feat(occ): add default help text with docs link to all commands #54180

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fcc811
feat(occ): add default help text with docs link to all commands
joshtrichards Jul 31, 2025
b4027c5
fix: add retrieval of customized base doc URL
joshtrichards Aug 30, 2025
2fa55ce
fix: review input
joshtrichards Sep 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions core/Command/Base.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,10 @@
private bool $interrupted = false;

protected function configure() {
// Some of our commands do not extend this class; and some of those that do do not call parent::configure()
$defaultHelp = 'More extensive and thorough documentation may be found at ' . \OCP\Server::get(\OCP\Defaults::class)->getDocBaseUrl() . PHP_EOL;
$this
->setHelp($this->defaultHelp)

Check failure on line 32 in core/Command/Base.php

View workflow job for this annotation

GitHub Actions / static-code-analysis

UndefinedThisPropertyFetch 

core/Command/Base.php:32:14: UndefinedThisPropertyFetch: Instance property OC\Core\Command\Base::$defaultHelp is not defined (see https://psalm.dev/041)
->addOption(
'output',
null,
Expand Down
Loading