Eases language-specific preset definitions

raphaelstolt · raphaelstolt · commit 7da19b6e4b35 · 2025-08-26T16:44:42.000+02:00
diff --git a/src/Presets/CommonPreset.php b/src/Presets/CommonPreset.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stolt\LeanPackage\Presets;
+
+class CommonPreset
+{
+    protected function getCommonGlob(): array
+    {
+        return [
+            '.*',
+            '*.txt',
+            '*.{md,MD}',
+            '*.rst',
+            '*.toml',
+            '*.xml',
+            '*.yml',
+            '*.dist.*',
+            'llms.*',
+            '*.dist',
+            '{B,b}uild*',
+            '{D,d}ist',
+            '{D,d}oc*',
+            '{A,a}rt*',
+            '{A,a}sset*',
+            '{T,t}ool*',
+            '{T,t}est*',
+            '{S,s}pec*',
+            '{E,e}xample*',
+            'LICENSE',
+            '{M,m}ake',
+            '*.{png,gif,jpeg,jpg,webp}',
+        ];
+    }
+}
diff --git a/src/Presets/Finder.php b/src/Presets/Finder.php
@@ -25,10 +25,14 @@ public function getAvailablePresets(): array
     {
         $dir = new \DirectoryIterator(\dirname(__FILE__));
         $availablePresets = [];
+
         foreach ($dir as $fileinfo) {
             if (!$fileinfo->isDot()) {
                 $presetsParts = \explode(self::PRESET_SUFFIX, $fileinfo->getBasename());
                 if (\count($presetsParts) == 2) {
+                    if ($presetsParts[0] === 'Common') {
+                        continue;
+                    }
                     $availablePresets[] = $presetsParts[0];
                 }
             }
diff --git a/src/Presets/GoPreset.php b/src/Presets/GoPreset.php
@@ -6,28 +6,17 @@
 
 use Stolt\LeanPackage\Preset;
 
-final class GoPreset implements Preset
+final class GoPreset extends CommonPreset implements Preset
 {
     public function getPresetGlob(): array
     {
-        return [
-            '.*',
-            '*.lock',
-            '*.txt',
-            '*.rst',
-            '*.{md,MD}',
-            '*.xml',
-            '*.yml',
-            '*.dist.*',
-            '*.dist',
-            '{B,b}uild*',
-            '{D,d}oc*',
-            '{T,t}ool*',
-            '{T,t}est*',
-            '{S,s}pec*',
-            '{E,e}xample*',
-            'LICENSE',
-            '{{M,m}ake,{V,v}agrant'
-        ];
+        return \array_unique(\array_merge($this->getCommonGlob(), [
+            'go.*',
+            'cmd/**',
+            'pkg/**',
+            'internal/**',
+            '*.go',
+            '*_test.go',
+        ]));
     }
 }
diff --git a/src/Presets/PhpPreset.php b/src/Presets/PhpPreset.php
@@ -6,20 +6,12 @@
 
 use Stolt\LeanPackage\Preset;
 
-final class PhpPreset implements Preset
+final class PhpPreset extends CommonPreset implements Preset
 {
     public function getPresetGlob(): array
     {
-        return [
-            '.*',
+        return \array_unique(\array_merge($this->getCommonGlob(), [
             '*.lock',
-            '*.txt',
-            '*.rst',
-            '*.{md,MD}',
-            '*.{png,gif,jpeg,jpg,webp}',
-            '*.xml',
-            '*.yml',
-            '*.toml',
             'phpunit*',
             'appveyor.yml',
             'box.json',
@@ -37,20 +29,8 @@ public function getPresetGlob(): array
             'renovate.json',
             '*debugbar.json',
             'ecs*',
-            'llms.*',
-            '*.dist.*',
-            '*.dist',
-            '{B,b}uild*',
-            '{D,d}oc*',
-            '{T,t}ool*',
-            '{T,t}est*',
-            '{S,s}pec*',
-            '{A,a}rt*',
-            '{A,a}sset*',
-            '{E,e}xample*',
-            'LICENSE',
-            '{{M,m}ake,{B,b}ox,{V,v}agrant,{P,p}hulp}file',
-            'RMT'
-        ];
+            'RMT',
+            '{{M,m}ake,{B,b}ox,{V,v}agrant,{P,p}hulp}file'
+        ]));
     }
 }
diff --git a/src/Presets/PythonPreset.php b/src/Presets/PythonPreset.php
@@ -6,34 +6,16 @@
 
 use Stolt\LeanPackage\Preset;
 
-final class PythonPreset implements Preset
+final class PythonPreset extends CommonPreset implements Preset
 {
     public function getPresetGlob(): array
     {
-        return [
-            '.*',
-            '*.txt',
-            '*.rst',
+        return \array_unique(\array_merge($this->getCommonGlob(), [
             '*.py[cod]',
-            '*.toml',
             'setup.*',
             'requirements*.txt',
             'Pipfile',
             'Pipfile.lock',
-            '*.{md,MD}',
-            '*.xml',
-            '*.yml',
-            '*.dist.*',
-            '*.dist',
-            '{B,b}uild*',
-            '{D,d}oc*',
-            '{D,d}ist',
-            '{T,t}ool*',
-            '{T,t}est*',
-            '{S,s}pec*',
-            '{E,e}xample*',
-            'LICENSE',
-            '{{M,m}ake'
-        ];
+        ]));
     }
 }
diff --git a/tests/AnalyserTest.php b/tests/AnalyserTest.php
@@ -418,10 +418,6 @@ public function hasGitattributesFileFailsOnNonExistingGitattributesFile(): void
     #[Test]
     public function collectExpectedExportIgnoresReturnsExpectedEntries(): void
     {
-        $temporaryGitattributesFile = $this->temporaryDirectory
-            . DIRECTORY_SEPARATOR
-            . '.gitattributes';
-
         $artifactFilenames = [
             'README.md',
             'Makefile',
@@ -434,7 +430,7 @@ public function collectExpectedExportIgnoresReturnsExpectedEntries(): void
             ['documentation']
         );
 
-        $expectedExportIgnores = [
+        $expectedExportIgnores =[
             '.buildignore',
             '.travis.yml',
             'documentation/',
@@ -446,6 +442,9 @@ public function collectExpectedExportIgnoresReturnsExpectedEntries(): void
 
         $actualExportIgnores = $analyser->collectExpectedExportIgnores();
 
+        \sort($expectedExportIgnores);
+        \sort($actualExportIgnores);
+
         $this->assertEquals(
             $expectedExportIgnores,
             $actualExportIgnores
@@ -1526,51 +1525,58 @@ public function returnsExpectedDefaultGlobPatterns(): void
         $analyser = (new Analyser(new Finder(new PhpPreset())))->setDirectory($this->temporaryDirectory);
 
         $expectedDefaultGlobPatterns = [
-            '.*',
+            '*.dist',
+            '*.dist.*',
             '*.lock',
-            '*.txt',
             '*.rst',
-            '*.{md,MD}',
-            '*.{png,gif,jpeg,jpg,webp}',
+            '*.toml',
+            '*.txt',
             '*.xml',
             '*.yml',
-            '*.toml',
-            'phpunit*',
-            'appveyor.yml',
-            'box.json',
-            'composer-dependency-analyser*',
-            'collision-detector*',
-            'captainhook.json',
-            'peck.json',
-            'infection*',
-            'phpstan*',
-            'sonar*',
-            'rector*',
-            'phpkg.con*',
-            'package*',
-            'pint.json',
-            'renovate.json',
-            '*debugbar.json',
-            'ecs*',
-            'llms.*',
-            '*.dist.*',
-            '*.dist',
-            '{B,b}uild*',
-            '{D,d}oc*',
-            '{T,t}ool*',
-            '{T,t}est*',
-            '{S,s}pec*',
-            '{A,a}rt*',
-            '{A,a}sset*',
-            '{E,e}xample*',
-            'LICENSE',
-            '{{M,m}ake,{B,b}ox,{V,v}agrant,{P,p}hulp}file',
-            'RMT'
+            '*.{md,MD}',
+            '*.{png,gif,jpeg,jpg,webp}',
+             '*debugbar.json',
+             '.*',
+             'LICENSE',
+             'RMT',
+             'appveyor.yml',
+             'box.json',
+             'captainhook.json',
+             'collision-detector*',
+             'composer-dependency-analyser*',
+             'ecs*',
+             'infection*',
+             'llms.*',
+             'package*',
+             'peck.json',
+             'phpkg.con*',
+             'phpstan*',
+             'phpunit*',
+             'pint.json',
+             'rector*',
+             'renovate.json',
+             'sonar*',
+             '{A,a}rt*',
+             '{A,a}sset*',
+             '{B,b}uild*',
+             '{D,d}ist',
+             '{D,d}oc*',
+             '{E,e}xample*',
+             '{M,m}ake',
+             '{S,s}pec*',
+             '{T,t}est*',
+             '{T,t}ool*',
+             '{{M,m}ake,{B,b}ox,{V,v}agrant,{P,p}hulp}file',
         ];
 
+        $defaultGlobPattern = $analyser->getDefaultGlobPattern();
+
+        \sort($defaultGlobPattern);
+        \sort($expectedDefaultGlobPatterns);
+
         $this->assertEquals(
             $expectedDefaultGlobPatterns,
-            $analyser->getDefaultGlobPattern()
+            $defaultGlobPattern
         );
     }
 }
diff --git a/tests/Commands/InitCommandTest.php b/tests/Commands/InitCommandTest.php
@@ -63,14 +63,28 @@ public function createsExpectedDefaultLpvFile(): void
 
         $expectedDefaultLpvFileContent = <<<CONTENT
 .*
-*.lock
 *.txt
-*.rst
 *.{md,MD}
-*.{png,gif,jpeg,jpg,webp}
+*.rst
+*.toml
 *.xml
 *.yml
-*.toml
+*.dist.*
+llms.*
+*.dist
+{B,b}uild*
+{D,d}ist
+{D,d}oc*
+{A,a}rt*
+{A,a}sset*
+{T,t}ool*
+{T,t}est*
+{S,s}pec*
+{E,e}xample*
+LICENSE
+{M,m}ake
+*.{png,gif,jpeg,jpg,webp}
+*.lock
 phpunit*
 appveyor.yml
 box.json
@@ -88,20 +102,8 @@ public function createsExpectedDefaultLpvFile(): void
 renovate.json
 *debugbar.json
 ecs*
-llms.*
-*.dist.*
-*.dist
-{B,b}uild*
-{D,d}oc*
-{T,t}ool*
-{T,t}est*
-{S,s}pec*
-{A,a}rt*
-{A,a}sset*
-{E,e}xample*
-LICENSE
-{{M,m}ake,{B,b}ox,{V,v}agrant,{P,p}hulp}file
 RMT
+{{M,m}ake,{B,b}ox,{V,v}agrant,{P,p}hulp}file
 CONTENT;
 
         $this->assertSame($expectedDisplay, $commandTester->getDisplay());

Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,14 @@ public function getAvailablePresets(): array`
`25`	`25`	`{`
`26`	`26`	`$dir = new \DirectoryIterator(\dirname(__FILE__));`
`27`	`27`	`$availablePresets = [];`
	`28`	`+`
`28`	`29`	`foreach ($dir as $fileinfo) {`
`29`	`30`	`if (!$fileinfo->isDot()) {`
`30`	`31`	`$presetsParts = \explode(self::PRESET_SUFFIX, $fileinfo->getBasename());`
`31`	`32`	`if (\count($presetsParts) == 2) {`
	`33`	`+ if ($presetsParts[0] === 'Common') {`
	`34`	`+ continue;`
	`35`	`+ }`
`32`	`36`	`$availablePresets[] = $presetsParts[0];`
`33`	`37`	`}`
`34`	`38`	`}`