Adds new tree command

Author: raphaelstolt

CHANGELOG.md

@@ -7,6 +7,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## [Unreleased]
 
+## [v4.3.0] - 2025-02-07
+
+### Added
+- New `tree` command, that displays the source and dist package structure. Closes [#48](https://github.com/raphaelstolt/lean-package-validator/issues/48).  
+
 ## [v4.2.0] - 2025-02-06
 
 ### Added

README.md

@@ -192,6 +192,54 @@ The `--overwrite|-o` option overwrites an existing `.lpv` file.
 The `--preset` option allows to choose from a predefined set of glob pattern.
 Available presets are `PHP`, `Python`, and `Go`. With `PHP` being the default.
 
+The `tree` command allows you to inspect the __flat__ `source` and `dist package` structure of the given project.
+
+``` bash
+lean-package-validator tree [<directory>] --src
+
+Package: stolt/lean-package-validator
+.
+├── bin
+├── coverage-reports
+├── example
+├── .git
+├── .github
+├── .idea
+├── .phpunit.cache
+├── src
+├── tests
+├── vendor
+├── box.json.dist
+├── CHANGELOG.md
+├── composer.json
+├── composer.lock
+├── .editorconfig
+├── .gitattributes
+├── .gitignore
+├── .gitmessage
+├── LICENSE.md
+├── lpv-logo.png
+├── peck.json
+├── .php-cs-fixer.php
+├── phpstan.neon.dist
+├── phpunit.xml.dist
+└── README.md
+
+10 directories, 15 files
+```
+
+``` bash
+lean-package-validator tree [<directory>] --dist-package
+
+Package: stolt/lean-package-validator
+.
+├── bin
+├── composer.json
+└── src
+
+2 directories, 1 file
+```
+
 ## Utilisation via Composer scripts, cpx, or it's dedicated GitHub Action
 
 To avoid that changes coming from contributions or own modifications slip into release/dist archives it

bin/lean-package-validator

@@ -25,12 +25,14 @@ if (false === $autoloaded) {
 \define('VERSION', '4.2.0');
 
 use Stolt\LeanPackage\Commands\InitCommand;
+use Stolt\LeanPackage\Commands\TreeCommand;
 use Stolt\LeanPackage\Commands\ValidateCommand;
 use Stolt\LeanPackage\Analyser;
 use Stolt\LeanPackage\Archive;
 use Stolt\LeanPackage\Archive\Validator;
 use Stolt\LeanPackage\Presets\Finder;
 use Stolt\LeanPackage\Presets\PhpPreset;
+use Stolt\LeanPackage\Tree;
 use Symfony\Component\Console\Application;
 
 $finder = new Finder(new PhpPreset());
@@ -44,9 +46,10 @@ $validateCommand = new ValidateCommand(
     $analyser,
     new Validator($archive)
 );
+$treeCommand = new TreeCommand(new Tree($archive));
 
 $application = new Application('Lean package validator', VERSION);
 $application->addCommands(
-    [$initCommand, $validateCommand]
+    [$initCommand, $validateCommand, $treeCommand]
 );
 $application->run();

src/Commands/TreeCommand.php

@@ -0,0 +1,104 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stolt\LeanPackage\Commands;
+
+use Stolt\LeanPackage\Exceptions\GitNotAvailable;
+use Stolt\LeanPackage\Exceptions\TreeNotAvailable;
+use Stolt\LeanPackage\Helpers\Str as OsHelper;
+use Stolt\LeanPackage\Tree;
+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;
+
+final class TreeCommand extends Command
+{
+    private Tree $tree;
+
+    private string $directoryToOperateOn;
+
+    public function __construct(Tree $tree)
+    {
+        $this->tree = $tree;
+        parent::__construct();
+    }
+
+    /**
+     * Command configuration.
+     *
+     * @return void
+     */
+    protected function configure(): void
+    {
+        $this->directoryToOperateOn = WORKING_DIRECTORY;
+        $this->setName('tree');
+        $description = 'Displays the source structure of a given '
+            . "project/micro-package repository or it's dist package";
+        $this->setDescription($description);
+
+        $directoryDescription = 'The directory of a project/micro-package repository';
+
+        $this->addArgument(
+            'directory',
+            InputArgument::OPTIONAL,
+            $directoryDescription,
+            $this->directoryToOperateOn
+        );
+
+        $srcDescription = 'Show the flat src structure of the project/micro-package repository';
+        $distPackageDescription = 'Show the flat dist package structure of the project/micro-package';
+
+        $this->addOption('src', null, InputOption::VALUE_NONE, $srcDescription);
+        $this->addOption('dist-package', null, InputOption::VALUE_NONE, $distPackageDescription);
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $directory = (string) $input->getArgument('directory');
+
+        if ($directory !== $this->directoryToOperateOn) {
+            if (!\file_get_contents($directory) || !\is_dir($directory)) {
+                $warning = "Warning: The provided directory "
+                    . "'$directory' does not exist or is not a directory.";
+                $outputContent = '<error>' . $warning . '</error>';
+                $output->writeln($outputContent);
+
+                return Command::FAILURE;
+            }
+        }
+
+        $showSrcTree = $input->getOption('src');
+        $showDistPackageTree = $input->getOption('dist-package');
+
+        if ($showSrcTree) {
+            $verboseOutput = '+ Showing flat structure of package source.';
+            $output->writeln($verboseOutput, OutputInterface::VERBOSITY_VERBOSE);
+
+            $output->writeln('Package: <info>' . $this->getPackageName() . '</info>');
+            $output->write($this->tree->getTreeForSrc($this->directoryToOperateOn));
+
+            return Command::SUCCESS;
+        }
+
+        if ($showDistPackageTree) {
+            $verboseOutput = '+ Showing flat structure of dist package.';
+            $output->writeln($verboseOutput, OutputInterface::VERBOSITY_VERBOSE);
+
+            $output->writeln('Package: <info>' . $this->getPackageName() . '</info>');
+            $output->write($this->tree->getTreeForDistPackage($this->directoryToOperateOn));
+
+            return Command::SUCCESS;
+        }
+
+        return Command::FAILURE;
+    }
+
+    protected function getPackageName(): string
+    {
+        $composerContentAsJson = \json_decode(\file_get_contents('composer.json'), true);
+        return \trim($composerContentAsJson['name']);
+    }
+}

src/Exceptions/TreeNotAvailable.php

@@ -0,0 +1,6 @@
+<?php
+namespace Stolt\LeanPackage\Exceptions;
+
+class TreeNotAvailable extends \Exception
+{
+}

src/Tree.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace Stolt\LeanPackage;
+
+use Stolt\LeanPackage\Exceptions\GitNotAvailable;
+use Stolt\LeanPackage\Exceptions\TreeNotAvailable;
+use Stolt\LeanPackage\Helpers\Str as OsHelper;
+
+final class Tree
+{
+    private Archive $archive;
+
+    /**
+     * @throws TreeNotAvailable
+     * @throws GitNotAvailable
+     */
+    public function __construct(Archive $archive)
+    {
+        if (!$this->detectTreeCommand()) {
+            throw new TreeNotAvailable();
+        }
+
+        $this->archive = $archive;
+
+        if (!$this->archive->isGitCommandAvailable()) {
+            throw new GitNotAvailable();
+        }
+    }
+
+    public function getTreeForSrc(string $directory): string
+    {
+        \exec(
+            'tree -aL 1 --dirsfirst ' . \escapeshellarg($directory) . '  2>&1',
+            $output
+        );
+
+        $output[0] = '.';
+
+        return \implode(PHP_EOL, $output) . PHP_EOL;
+    }
+
+    public function getTreeForDistPackage(string $directory): string
+    {
+        $this->archive->createArchive();
+
+        \exec(
+            'tar --list --exclude="*/*" --file ' . \escapeshellarg($this->archive->getFilename()) . ' | tree -aL 1 --dirsfirst --fromfile . 2>&1',
+            $output
+        );
+
+        $this->archive->removeArchive();
+
+        return \implode(PHP_EOL, $output) . PHP_EOL;
+    }
+
+    protected function detectTreeCommand(string $command = 'tree'): bool
+    {
+        \exec('where ' . $command . ' 2>&1', $output, $returnValue);
+        if ((new OsHelper())->isWindows() === false) {
+            \exec('which ' . $command . ' 2>&1', $output, $returnValue);
+        }
+
+        return $returnValue === 0;
+    }
+}