Adds sort-from-directories-to-files option

Author: raphaelstolt

.gitattributes

@@ -13,6 +13,7 @@ bin/release-version export-ignore
 bin/start-watchman export-ignore
 box.json.dist export-ignore
 CHANGELOG.md export-ignore
+composer.json export-ignore
 example/ export-ignore
 LICENSE.md export-ignore
 lpv-logo.png export-ignore

CHANGELOG.md

@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ### Added
 
+- Option to sort ignored artifacts from directories to files. Closes [#30](https://github.com/raphaelstolt/lean-package-validator/issues/30).
 - Further PHP preset expansion.
 
 ## [v4.1.1] - 2025-01-14

src/Analyser.php

@@ -2,6 +2,7 @@
 
 namespace Stolt\LeanPackage;
 
+use PHPStan\Type\Php\DateIntervalDynamicReturnTypeExtension;
 use Stolt\LeanPackage\Exceptions\InvalidGlobPattern;
 use Stolt\LeanPackage\Exceptions\InvalidGlobPatternFile;
 use Stolt\LeanPackage\Exceptions\NonExistentGlobPatternFile;
@@ -71,14 +72,22 @@ class Analyser
     private bool $staleExportIgnoresComparison = false;
 
     /**
-     * Whether to do a strict alignment comparsion of the export-ignores
+     * Whether to do a strict alignment comparison of the export-ignores
      * in the .gitattributes files against the expected ones
      * or not.
      *
      * @var boolean
      */
     private bool $strictAlignmentComparison = false;
 
+    /**
+     * Whether to sort the export-ignores
+     * in the .gitattributes from directories to files or not.
+     *
+     * @var boolean
+     */
+    private bool $sortFromDirectoriesToFiles = false;
+
     /**
      * Whether at least one export-ignore pattern has
      * a preceding slash or not.
@@ -317,6 +326,13 @@ public function enableStrictOrderComparison(): Analyser
         return $this;
     }
 
+    public function sortFromDirectoriesToFiles(): Analyser
+    {
+        $this->sortFromDirectoriesToFiles = true;
+
+        return $this;
+    }
+
     /**
      * Guard for strict order comparison.
      *
@@ -550,12 +566,18 @@ public function getExpectedGitattributesContent(array $postfixlessExportIgnores
         \sort($postfixlessExportIgnores, SORT_STRING | SORT_FLAG_CASE);
 
         if (\count($postfixlessExportIgnores) > 0) {
-            if ($this->isAlignExportIgnoresEnabled() || $this->isStrictAlignmentComparisonEnabled()) {
+            if ($this->sortFromDirectoriesToFiles === false && ($this->isAlignExportIgnoresEnabled() || $this->isStrictAlignmentComparisonEnabled())) {
                 $postfixlessExportIgnores = $this->getAlignedExportIgnoreArtifacts(
                     $postfixlessExportIgnores
                 );
             }
 
+            if ($this->sortFromDirectoriesToFiles) {
+                $postfixlessExportIgnores = $this->getByDirectoriesToFilesExportIgnoreArtifacts(
+                    $postfixlessExportIgnores
+                );
+            }
+
             $content = \implode(" export-ignore" . $this->preferredEol, $postfixlessExportIgnores)
                 . " export-ignore" . $this->preferredEol;
 
@@ -898,6 +920,22 @@ private function getAlignedExportIgnoreArtifacts(array $artifacts): array
         }, $artifacts);
     }
 
+    private function getByDirectoriesToFilesExportIgnoreArtifacts(array $artifacts): array
+    {
+        $directories = \array_filter($artifacts, function ($artifact) {
+            if (\strpos($artifact, DIRECTORY_SEPARATOR)) {
+                return $artifact;
+            }
+        });
+        $files = \array_filter($artifacts, function ($artifact) {
+            if (\strpos($artifact, DIRECTORY_SEPARATOR) === false) {
+                return $artifact;
+            }
+        });
+
+        return \array_merge($directories, $files);
+    }
+
     /**
      * Is existing .gitattributes file having all export-ignore(s).
      *

src/Commands/ValidateCommand.php

@@ -102,6 +102,7 @@ protected function configure(): void
         $keepLicenseDescription = 'Do not export-ignore the license file';
         $keepReadmeDescription = 'Do not export-ignore the README file';
         $keepGlobPatternDescription = 'Do not export-ignore matching glob pattern e.g. <comment>{LICENSE.*,README.*,docs*}</comment>';
+        $sortDescription = 'Sort from directories to files';
 
         $alignExportIgnoresDescription = 'Align export-ignores on create or overwrite';
 
@@ -163,6 +164,12 @@ protected function configure(): void
             InputOption::VALUE_NONE,
             $alignExportIgnoresDescription
         );
+        $this->addOption(
+            'sort-from-directories-to-files',
+            's',
+            InputOption::VALUE_NONE,
+            $sortDescription
+        );
         $this->addOption(
             'omit-header',
             null,
@@ -226,14 +233,22 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $reportStaleExportIgnores = $input->getOption('report-stale-export-ignores');
 
         $enforceStrictOrderComparison = $input->getOption('enforce-strict-order');
+        $sortFromDirectoriesToFiles = $input->getOption('sort-from-directories-to-files');
 
-        if ($enforceStrictOrderComparison) {
+        if ($enforceStrictOrderComparison && $sortFromDirectoriesToFiles === false) {
             $verboseOutput = '+ Enforcing strict order comparison.';
             $output->writeln($verboseOutput, OutputInterface::VERBOSITY_VERBOSE);
 
             $this->analyser->enableStrictOrderComparison();
         }
 
+        if ($sortFromDirectoriesToFiles) {
+            $verboseOutput = '+ Sorting from files to directories.';
+            $output->writeln($verboseOutput, OutputInterface::VERBOSITY_VERBOSE);
+
+            $this->analyser->sortFromDirectoriesToFiles();
+        }
+
         if ($reportStaleExportIgnores) {
             $verboseOutput = '+ Enforcing stale export ignores comparison.';
             $output->writeln($verboseOutput, OutputInterface::VERBOSITY_VERBOSE);

tests/AnalyserTest.php

@@ -1238,6 +1238,41 @@ public function exportIgnoresAreAligned(): void
         );
     }
 
+    #[Test]
+    public function exportIgnoresAreSortedFromDirectoriesToFiles(): void
+    {
+        $artifactFilenames = [
+            'LICENSE.txt',
+            'README.md',
+            'phpspec.yml.dist',
+        ];
+
+        $this->createTemporaryFiles(
+            $artifactFilenames,
+            ['specs', 'docs']
+        );
+
+        $expectedGitattributesContent = <<<CONTENT
+* text=auto eol=lf
+
+docs/ export-ignore
+specs/ export-ignore
+.gitattributes export-ignore
+LICENSE.txt export-ignore
+phpspec.yml.dist export-ignore
+README.md export-ignore
+
+CONTENT;
+
+        $analyser = (new Analyser(new Finder(new PhpPreset())))->setDirectory($this->temporaryDirectory)->sortFromDirectoriesToFiles();
+        $actualGitattributesContent = $analyser->getExpectedGitattributesContent();
+
+        $this->assertEquals(
+            $expectedGitattributesContent,
+            $actualGitattributesContent
+        );
+    }
+
     #[Test]
     #[Ticket('https://github.com/raphaelstolt/lean-package-validator/issues/4')]
     public function precedingSlashesAreDetected(): void