You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

78 lines
3.3 KiB

Mise à jour vers PhpDocumentor v3 Une bonne partie de l’application Autodoc disparait pour plusieurs raisons : - On cherche à simplifier la maintenance de cette doc en ne créant pas de thème personnalisé, car effectivement, la syntaxe PHP évolue bien plus vite que le temps disponible pour adapter les templates aux évolutions. On préfère user juste d’un peu de cosmétique avec un peu de CSS. Le thème complet d’avant disparait. - L’application est devenue un .phar et les surcharges sont improbables là où le code d’origine ne l’a pas explicitement prévu. Je n’ai absolument pas l’énergie de me replonger à gérer des passes de compilation comme avant pour retrouver les balises ou pipelines dans le code (je ne sais même pas si c’est faisable sur cette version). Cette partie disparait aussi. - On bascule sur du PHP 8.0 minimum. On s’appuie sur différentes librairies dont toujours symfony/console, mais aussi symfony/filesystem et League/Pipeline. On gère les téléchargements et mises à jour Git avec l’outil checkout (qui est donc nécessaire). Le fichier phpDocumentor.phar est aussi nécessaire dans le répertoire de travail, tout comme la création d’un répertoire `var` écrivable. Une décoration spécifique du thème par défaut (css, svg), est copiée dans la config générée (var/config/templates), et est alors utilisée par phpDocumentor (sur le même principe de surcharge que les squelettes SPIP) Les commandes from:directory, from:git, from:plugin, from:spip sont adaptées. La commande from:file (lecture d’un fichier archivelist.txt) reste à faire.
10 months ago
<?php
/*
* Commande d'exécution depuis une source répertoire …
*/
namespace Spip\Autodoc\Command;
use League\Pipeline\InterruptibleProcessor;
use League\Pipeline\Pipeline;
use Spip\Autodoc\Context;
use Spip\Autodoc\Stage\CheckStage;
use Spip\Autodoc\Stage\PackageStage;
use Spip\Autodoc\Stage\PhpDocumentorConfigStage;
use Spip\Autodoc\Stage\PhpDocumentorStage;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Command\Command;
/**
* Déclaration et exécution de l'application depuis un répertoire…
*/
class FromDirectory extends Command
{
protected function configure()
{
$this
->setName('from:directory')
->setDescription('Exécuter l’autodoc sur un répertoire donné')
->setHelp('Si le répertoire cible est un plugin SPIP, certaines informations seront extraites du paquet.xml et du fichier de langue.')
->addArgument('source', InputArgument::REQUIRED, 'Chemin du répertoire. <comment>Exemple : "/home/user/www/spip/plugins/fabrique"</comment>')
->addOption('prefix', 'p', InputOption::VALUE_OPTIONAL, 'Préfixe servant au stockage des données si pas de paquet.xml <comment>Défaut: "default"</comment>')
->addOption('output', 'o', InputOption::VALUE_OPTIONAL, 'Répertoire recevant le HTML généré. Chemin absolu ou relatif au répertoire "work". <comment>Défaut: "var/output/{prefixe}"</comment>')
->addOption('topnav', null, InputOption::VALUE_OPTIONAL, 'URL d’un fichier JS à charger dans le head html. <comment>Exemple: "//boussole.spip.net/?page=spipnav.js&lang=fr"</comment>')
->addOption('topnav_spip', null, InputOption::VALUE_NONE, 'Intègre le JS de la boussole SPIP en entête topnav.')
->addOption('force', '', InputOption::VALUE_NONE, 'Force l’analyse de tous les fichiers, même s’ils n’ont pas été modifiés.');
}
protected function execute(InputInterface $input, OutputInterface $output)
{
$context = new Context($input, $output);
/** @var SymfonyStyle */
$io = $context->get('io');
$io->title("Autodoc " . $this->getName());
$source = $input->getArgument('source');
$io->text("Source: <info>$source</info>.");
$context->set('input_directory', $source);
$context->set('output_directory', $input->getOption('output'));
if ($input->hasOption('prefix')) {
$context->set('default_prefix', $input->getOption('prefix'));
}
$context->set('topnav', $input->getOption('topnav'));
$context->set('topnav_spip', $input->getOption('topnav_spip'));
$context->set('phpdocumentor_force', $input->getOption('force'));
$this->pipeline($context);
return Command::SUCCESS;
}
protected function pipeline(Context $context): void
{
$processor = new InterruptibleProcessor(fn (Context $context) => $context->empty('errors'));
$pipeline = (new Pipeline($processor))
->pipe(new CheckStage())
->pipe(new PackageStage())
->pipe(new PhpDocumentorConfigStage())
->pipe(new PhpDocumentorStage());
Mise à jour vers PhpDocumentor v3 Une bonne partie de l’application Autodoc disparait pour plusieurs raisons : - On cherche à simplifier la maintenance de cette doc en ne créant pas de thème personnalisé, car effectivement, la syntaxe PHP évolue bien plus vite que le temps disponible pour adapter les templates aux évolutions. On préfère user juste d’un peu de cosmétique avec un peu de CSS. Le thème complet d’avant disparait. - L’application est devenue un .phar et les surcharges sont improbables là où le code d’origine ne l’a pas explicitement prévu. Je n’ai absolument pas l’énergie de me replonger à gérer des passes de compilation comme avant pour retrouver les balises ou pipelines dans le code (je ne sais même pas si c’est faisable sur cette version). Cette partie disparait aussi. - On bascule sur du PHP 8.0 minimum. On s’appuie sur différentes librairies dont toujours symfony/console, mais aussi symfony/filesystem et League/Pipeline. On gère les téléchargements et mises à jour Git avec l’outil checkout (qui est donc nécessaire). Le fichier phpDocumentor.phar est aussi nécessaire dans le répertoire de travail, tout comme la création d’un répertoire `var` écrivable. Une décoration spécifique du thème par défaut (css, svg), est copiée dans la config générée (var/config/templates), et est alors utilisée par phpDocumentor (sur le même principe de surcharge que les squelettes SPIP) Les commandes from:directory, from:git, from:plugin, from:spip sont adaptées. La commande from:file (lecture d’un fichier archivelist.txt) reste à faire.
10 months ago
$pipeline->process($context);
}
}