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.

54 lines
2.5 KiB

<?php
/*
* Commande d'exécution depuis un fichier autodoc.txt (de la Zone de SPIP par défaut)…
*/
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.
1 year ago
namespace Spip\Autodoc\Command;
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.
1 year ago
use Spip\Autodoc\Generator;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
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.
1 year ago
use Symfony\Component\Console\Command\Command;
/**
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.
1 year ago
* Déclaration et exécution de l'application depuis un fichier de type autodoc.txt
*/
class FromFile extends Command
{
protected function configure()
{
$this
->setName('from:file')
->setDescription("Exécuter l'autodoc sur un fichier de type autodoc.txt.")
->setHelp("Le fichier source des données doit indiquer une liste de sources GIT et leur préfixes de stockage.
Pour chaque ligne, une documentation sera générée. Lorsque le contenu est un plugin de SPIP, certaines informations seront extraites du paquet.xml et du fichier de langue.
Exemple de fichier :
https://git.spip.net/spip-contrib-extensions/a2a.git@master;a2a
https://git.spip.net/spip-contrib-extensions/champs_extras_core@master;cextras
")
->addArgument('file', InputArgument::OPTIONAL, "Chemin du fichier brut.", 'https://git.spip.net/spip-contrib-outils/archivelists/raw/branch/master/autodoc.txt')
->addOption('sorties', 's', InputOption::VALUE_OPTIONAL, "Répertoire stockant toutes les documentations générées. Chemin absolu ou relatif au répertoire 'work'. <comment>Défaut : 'output'</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('avec_boussole_spip', null, InputOption::VALUE_NONE, "Intègre le JS de la boussole SPIP en entête topnav.")
->addOption('prefixe', 'p', InputOption::VALUE_OPTIONAL, "Préfixe de plugin. Lui seul sera actualisé si présent.")
->addOption('force', '', InputOption::VALUE_NONE, "Force la génération de la documentation même si le plugin n'a eu de modifications depuis la fois précédente.")
;
}
protected function execute(InputInterface $input, OutputInterface $output)
{
$file = $input->getArgument('file');
$output->writeln("\nExécuter autodoc sur un fichier : <info>$file</info>.");
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.
1 year ago
$generator = new Generator($input, $output);
$generator->generateFromFile($file);
}
}