Browse Source

Transmettre le verbose à phpDocumentor, même si ça semble le faire tout seul ?

master
Matthieu Marcillaud 9 months ago
parent
commit
7328fba326
  1. 39
      README.md
  2. 9
      src/Stage/PhpDocumentorStage.php

39
README.md

@ -8,35 +8,36 @@
### Intallation de phpDocumentor
Télécharger la dernière archive phpDocumentor.phar dans son répertoire de travail.
https://github.com/phpDocumentor/phpDocumentor/releases
Télécharger la dernière archive phpDocumentor.phar dans son répertoire de travail.
https://github.com/phpDocumentor/phpDocumentor/releases
Exemple:
```bash
wget https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.3.0/phpDocumentor.phar
```
Exemple:
```bash
wget https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.3.0/phpDocumentor.phar
```
### Installation de l’application
```bash
git clone https://git.spip.net/spip-galaxie/code.spip.net_autodoc autodoc && cd autodoc
composer install
cd ..
```
```bash
git clone https://git.spip.net/spip-galaxie/code.spip.net_autodoc autodoc && cd autodoc
composer install
cd ..
```
En fonction de l'usage et du contenu de phpdoc.xml, il faudra créer un/des répertoires avec accès en écriture.
```bash
mkdir var
```
```bash
mkdir var
```
### Mises à jour
```bash
cd autodoc && git pull
composer update
cd ..
```
```bash
cd autodoc && git pull
composer update
cd ..
```
## Usage

9
src/Stage/PhpDocumentorStage.php

@ -3,6 +3,7 @@
namespace Spip\Autodoc\Stage;
use Spip\Autodoc\Context;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\Filesystem\Path;
class PhpDocumentorStage implements StageInterface
@ -18,6 +19,14 @@ class PhpDocumentorStage implements StageInterface
if ($context->has('phpdocumentor_force') and $context->get('phpdocumentor_force')) {
$cmd .= ' --force';
}
/** @var SymfonyStyle */
$io = $context->get('io');
$cmd .= match (true) {
$io->isDebug() => ' -vvv',
$io->isVeryVerbose() => ' -vv',
$io->isVerbose() => ' -v',
default => '',
};
$context->get('logger')->debug("Run: ".$cmd);
passthru($cmd);

Loading…
Cancel
Save