UPSTREAM BASELINE: nextcloud/spreed v22.0.12 (без изменений)
Type checking / changes (push) Has been cancelled
Type checking / test (push) Has been cancelled
Type checking / typescript-summary (push) Has been cancelled
Node tests / changes (push) Has been cancelled
Node tests / test (push) Has been cancelled
Node tests / test-summary (push) Has been cancelled
Type checking / changes (push) Has been cancelled
Type checking / test (push) Has been cancelled
Type checking / typescript-summary (push) Has been cancelled
Node tests / changes (push) Has been cancelled
Node tests / test (push) Has been cancelled
Node tests / test-summary (push) Has been cancelled
Источник: https://github.com/nextcloud/spreed/archive/refs/tags/v22.0.12.tar.gz С этого коммита ветка официального Nextcloud Talk отрезана (решение владельца 2026-07-06). Все дальнейшие изменения — только наши; версии релизов: 22.0.12-f7.N.
This commit is contained in:
@@ -0,0 +1,145 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
|
||||
* SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
*/
|
||||
|
||||
namespace OCA\Talk\Command\Developer;
|
||||
|
||||
use OC\Core\Command\Base;
|
||||
use OCP\App\IAppManager;
|
||||
use OCP\IConfig;
|
||||
use OCP\Server;
|
||||
use Symfony\Component\Console\Command\Command;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
class UpdateDocs extends Base {
|
||||
public function __construct(
|
||||
private IConfig $config,
|
||||
private IAppManager $appManager,
|
||||
) {
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
public function isEnabled(): bool {
|
||||
return $this->config->getSystemValue('debug', false) === true;
|
||||
}
|
||||
|
||||
#[\Override]
|
||||
protected function configure(): void {
|
||||
$this
|
||||
->setName('talk:developer:update-docs')
|
||||
->setDescription('Update documentation of commands')
|
||||
;
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int {
|
||||
$info = $this->appManager->getAppInfo('spreed');
|
||||
$documentation = "# Talk occ commands\n\n";
|
||||
foreach ($info['commands'] as $namespace) {
|
||||
if ($namespace === self::class
|
||||
|| $namespace === AgeChatMessages::class) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$command = $this->getCommand($namespace);
|
||||
$documentation .= $this->getDocumentation($command) . "\n";
|
||||
}
|
||||
|
||||
$handle = fopen(__DIR__ . '/../../../docs/occ.md', 'w');
|
||||
fwrite($handle, $documentation);
|
||||
fclose($handle);
|
||||
return 0;
|
||||
}
|
||||
|
||||
protected function getCommand(string $namespace): Command {
|
||||
$command = Server::get($namespace);
|
||||
// Clean full definition of command that have the default Symfony options
|
||||
$command->setApplication($this->getApplication());
|
||||
return $command;
|
||||
}
|
||||
|
||||
protected function getDocumentation(Command $command): string {
|
||||
$doc = '## ' . $command->getName() . "\n\n";
|
||||
$doc .= $command->getDescription() . "\n\n";
|
||||
$doc
|
||||
.= '### Usage' . "\n\n"
|
||||
. array_reduce(
|
||||
array_merge(
|
||||
[$command->getSynopsis()],
|
||||
$command->getAliases(),
|
||||
$command->getUsages()
|
||||
),
|
||||
function ($carry, $usage) {
|
||||
return $carry . '* `' . $usage . '`' . "\n";
|
||||
}
|
||||
);
|
||||
$doc .= $this->describeInputDefinition($command);
|
||||
|
||||
return $doc;
|
||||
}
|
||||
|
||||
protected function describeInputDefinition(Command $command): string {
|
||||
$definition = $command->getDefinition();
|
||||
$text = '';
|
||||
if (\count($definition->getArguments()) > 0) {
|
||||
$text .= "\n";
|
||||
$text .= "| Arguments | Description | Is required | Is array | Default |\n";
|
||||
$text .= '|---|---|---|---|---|';
|
||||
foreach ($definition->getArguments() as $argument) {
|
||||
$describeInputArgument = $this->describeInputArgument($argument);
|
||||
if ($describeInputArgument) {
|
||||
$text .= "\n" . $describeInputArgument;
|
||||
}
|
||||
}
|
||||
$text .= "\n";
|
||||
}
|
||||
|
||||
if (\count($definition->getOptions()) > 0) {
|
||||
$text .= "\n";
|
||||
|
||||
$text .= "| Options | Description | Accept value | Is value required | Is multiple | Default |\n";
|
||||
$text .= '|---|---|---|---|---|---|';
|
||||
foreach ($definition->getOptions() as $option) {
|
||||
$describeInputOption = $this->describeInputOption($option);
|
||||
if ($describeInputOption) {
|
||||
$text .= "\n" . $describeInputOption;
|
||||
}
|
||||
}
|
||||
$text .= "\n";
|
||||
}
|
||||
return $text;
|
||||
}
|
||||
|
||||
protected function describeInputArgument(InputArgument $argument): string {
|
||||
$description = $argument->getDescription();
|
||||
|
||||
return
|
||||
'| `' . ($argument->getName() ?: '<none>') . '` | '
|
||||
. ($description ? preg_replace('/\s*[\r\n]\s*/', ' ', $description) : '') . ' | '
|
||||
. ($argument->isRequired() ? 'yes' : 'no') . ' | '
|
||||
. ($argument->isArray() ? 'yes' : 'no') . ' | '
|
||||
. ($argument->isRequired() ? '*Required*' : '`' . str_replace("\n", '', var_export($argument->getDefault(), true)) . '`') . ' |';
|
||||
}
|
||||
|
||||
protected function describeInputOption(InputOption $option): string {
|
||||
$name = '--' . $option->getName();
|
||||
if ($option->getShortcut()) {
|
||||
$name .= '\|-' . str_replace('|', '\|-', $option->getShortcut());
|
||||
}
|
||||
$description = $option->getDescription();
|
||||
|
||||
return
|
||||
'| `' . $name . '` | '
|
||||
. ($description ? preg_replace('/\s*[\r\n]\s*/', ' ', $description) : '') . ' | '
|
||||
. ($option->acceptValue() ? 'yes' : 'no') . ' | '
|
||||
. ($option->isValueRequired() ? 'yes' : 'no') . ' | '
|
||||
. ($option->isArray() ? 'yes' : 'no') . ' | '
|
||||
. ($option->isValueRequired() ? '*Required*' : '`' . str_replace("\n", '', var_export($option->getDefault(), true)) . '`') . ' |';
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user