Migrates internal tooling to Mago

raphaelstolt · raphaelstolt · commit a8bd1e05ed03 · 2025-10-16T16:44:43.000+02:00
diff --git a/.gitattributes b/.gitattributes
@@ -18,6 +18,7 @@ example/ export-ignore
 LICENSE.md export-ignore
 llms.txt export-ignore
 lpv-logo.png export-ignore
+mago.toml export-ignore
 peck.json export-ignore
 phpstan.neon.dist export-ignore
 phpunit.xml.dist export-ignore
diff --git a/composer.json b/composer.json
@@ -44,8 +44,8 @@
     "scripts": {
         "lpv:test": "phpunit",
         "lpv:test-with-coverage": "export XDEBUG_MODE=coverage && phpunit --coverage-html coverage-reports",
-        "lpv:cs-fix": "php-cs-fixer --allow-risky=yes fix . -vv || true",
-        "lpv:cs-lint": "php-cs-fixer fix --diff --stop-on-violation --verbose --dry-run --allow-risky=yes",
+        "lpv:cs-fix": "mago lint --fix",
+        "lpv:cs-lint": "mago lint",
         "lpv:configure-commit-template": "git config --add commit.template .gitmessage",
         "lpv:application-version-guard": "php bin/application-version --verify-tag-match=bin",
         "lpv:application-phar-version-guard": "php bin/application-version --verify-tag-match=phar",
@@ -65,9 +65,13 @@
     "config": {
         "preferred-install": "dist",
         "sort-packages": true,
-        "optimize-autoloader": true
+        "optimize-autoloader": true,
+        "allow-plugins": {
+            "carthage-software/mago": true
+        }
     },
     "require-dev": {
+        "carthage-software/mago": "^0.26.1",
         "friendsofphp/php-cs-fixer": "^3.70.1",
         "mockery/mockery": "^1.0",
         "peckphp/peck": "^0.1.2",
diff --git a/mago.toml b/mago.toml
@@ -0,0 +1,17 @@
+# Mago configuration file
+# For more information, see https://mago.carthage.software/#/getting-started/configuration
+php_version = "8.1.0"
+
+[source]
+paths = ["src/", "tests/"]
+includes = ["vendor"]
+excludes = []
+
+[format]
+print_width = 120
+tab_width = 4
+use_tabs = false
+
+[linter]
+default_plugins = true
+plugins = ["symfony", "php-unit"]
diff --git a/src/Analyser.php b/src/Analyser.php
@@ -211,7 +211,7 @@ public function setGlobPatternFromFile(string $file): Analyser
         );
 
         $globPatterns = [];
-        \array_filter($globPatternLines, function ($line) use (&$globPatterns) {
+        \array_filter($globPatternLines, function (string $line) use (&$globPatterns) {
             if (\trim($line) !== '') {
                 $globPatterns[] = \trim($line);
             }
@@ -253,7 +253,7 @@ private function guardGlobPattern(string $pattern): void
 
         $globPatterns = \explode(',', $bracesContent);
 
-        if (\count($globPatterns) == 1) {
+        if (\count($globPatterns) === 1) {
             $invalidGlobPattern = true;
         }
 
@@ -652,8 +652,8 @@ public function getPresentExportIgnoresToPreserve(array $globPatternMatchingExpo
                 $pattern = \trim($pattern);
 
                 if ($patternMatches
-                    && !\in_array($pattern, $globPatternMatchingExportIgnores)
-                    && !\in_array($pattern, $basenamedGlobPatternMatchingExportIgnores)
+                    && !\in_array($pattern, $globPatternMatchingExportIgnores, strict: true)
+                    && !\in_array($pattern, $basenamedGlobPatternMatchingExportIgnores, strict: true)
                 ) {
                     return $exportIgnoresToPreserve[] = \trim($pattern);
                 }
@@ -688,7 +688,7 @@ public function collectExpectedExportIgnores(): array
         }
 
         foreach ($globMatches as $filename) {
-            if (!\in_array($filename, $ignoredGlobMatches)) {
+            if (!\in_array($filename, $ignoredGlobMatches, strict: true)) {
                 if (\is_dir($filename)) {
                     $expectedExportIgnores[] = $filename . '/';
                     continue;
@@ -830,7 +830,7 @@ public function getPresentNonExportIgnoresContent(): string
         $exportIgnoresPlacementPlaceholderSet = false;
         $exportIgnoresPlacementPlaceholder = self::EXPORT_IGNORES_PLACEMENT_PLACEHOLDER;
 
-        \array_filter($gitattributesLines, function ($line) use (
+        \array_filter($gitattributesLines, function (string $line) use (
             &$nonExportIgnoreLines,
             &$exportIgnoresPlacementPlaceholderSet,
             &$exportIgnoresPlacementPlaceholder
@@ -872,7 +872,7 @@ public function getPresentExportIgnores(bool $applyGlob = true, string $gitattri
         );
 
         $exportIgnores = [];
-        \array_filter($gitattributesLines, function ($line) use (&$exportIgnores, &$applyGlob) {
+        \array_filter($gitattributesLines, function (string $line) use (&$exportIgnores, &$applyGlob) {
             if (\strstr($line, 'export-ignore', true)) {
                 list($line, $void) = \explode('export-ignore', $line);
                 if ($applyGlob) {
@@ -912,7 +912,7 @@ private function getAlignedExportIgnoreArtifacts(array $artifacts): array
     {
         $longestArtifact = \max(\array_map('strlen', $artifacts));
 
-        return \array_map(function ($artifact) use (&$longestArtifact) {
+        return \array_map(function (string $artifact) use (&$longestArtifact) {
             if (\strlen($artifact) < $longestArtifact) {
                 return $artifact . \str_repeat(
                     ' ',
@@ -930,7 +930,7 @@ private function getByDirectoriesToFilesExportIgnoreArtifacts(array $artifacts):
                 return $artifact;
             }
         });
-        $files = \array_filter($artifacts, function ($artifact) {
+        $files = \array_filter($artifacts, function (string $artifact) {
             if (\strpos($artifact, '/') === false) {
                 return $artifact;
             }
diff --git a/src/Archive.php b/src/Archive.php
@@ -1,5 +1,8 @@
 <?php
 
+declare(strict_types=1);
+
+
 namespace Stolt\LeanPackage;
 
 use PharData;
@@ -166,7 +169,7 @@ public function compareArchive(array $unexpectedArtifacts): array
             if ($archiveFile instanceof \SplFileInfo) {
                 if ($archiveFile->isDir()) {
                     $file = \basename($archiveFile) . '/';
-                    if (\in_array($file, $unexpectedArtifacts)) {
+                    if (\in_array($file, $unexpectedArtifacts, strict: true)) {
                         $foundUnexpectedArtifacts[] = $file;
                     }
                     continue;
@@ -179,7 +182,7 @@ public function compareArchive(array $unexpectedArtifacts): array
                     }
                 }
 
-                if (\in_array($file, $unexpectedArtifacts)) {
+                if (\in_array($file, $unexpectedArtifacts, strict: true)) {
                     $foundUnexpectedArtifacts[] = $file;
                 }
             }
diff --git a/src/Archive/Validator.php b/src/Archive/Validator.php
@@ -1,5 +1,8 @@
 <?php
 
+declare(strict_types=1);
+
+
 namespace Stolt\LeanPackage\Archive;
 
 use Stolt\LeanPackage\Archive;
diff --git a/src/Commands/InitCommand.php b/src/Commands/InitCommand.php
@@ -122,7 +122,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $this->analyser->setDirectory($directory);
             } catch (\RuntimeException $e) {
                 $warning = "Warning: The provided directory "
-                    . "'$directory' does not exist or is not a directory.";
+                    . "'{$directory}' does not exist or is not a directory.";
                 $outputContent = '<error>' . $warning . '</error>';
                 $output->writeln($outputContent);
 
@@ -145,7 +145,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return Command::FAILURE;
         }
 
-        if ($chosenPreset && \in_array(\strtolower($chosenPreset), \array_map('strtolower', $this->finder->getAvailablePresets()))) {
+        if ($chosenPreset && \in_array(\strtolower($chosenPreset), \array_map('strtolower', $this->finder->getAvailablePresets()), strict: true)) {
             $verboseOutput = '+ Loading preset ' . $chosenPreset . '.';
             $output->writeln($verboseOutput, OutputInterface::VERBOSITY_VERBOSE);
             $globPatternFromPreset = true;
@@ -158,7 +158,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return Command::FAILURE;
         }
 
-        $lpvFileContent = \implode("\n", $defaultGlobPattern);
+        $lpvFileContent = \implode(PHP_EOL, $defaultGlobPattern);
 
         if ($input->getOption('dry-run') === true) {
             $output->writeln($lpvFileContent);
@@ -187,7 +187,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             return Command::FAILURE;
         }
 
-        $info = "<info>Created default '$defaultLpvFile' file.</info>";
+        $info = "<info>Created default '{$defaultLpvFile}' file.</info>";
         $output->writeln($info);
 
         return Command::SUCCESS;
diff --git a/src/Commands/TreeCommand.php b/src/Commands/TreeCommand.php
@@ -61,7 +61,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         if (!\is_dir($this->directoryToOperateOn)) {
             $warning = "Warning: The provided directory "
-                . "'$this->directoryToOperateOn' does not exist or is not a directory.";
+                . "'{$this->directoryToOperateOn}' does not exist or is not a directory.";
             $outputContent = '<error>' . $warning . '</error>';
             $output->writeln($outputContent);
 
diff --git a/src/Commands/ValidateCommand.php b/src/Commands/ValidateCommand.php
@@ -241,7 +241,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $this->analyser->setDirectory($directory);
             } catch (\RuntimeException $e) {
                 $warning = "Warning: The provided directory "
-                    . "'$directory' does not exist or is not a directory.";
+                    . "'{$directory}' does not exist or is not a directory.";
                 $outputContent = '<error>' . $warning . '</error>';
                 $output->writeln($outputContent);
 
@@ -370,7 +370,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $this->analyser->setKeepGlobPattern($keepGlobPattern);
             } catch (InvalidGlobPattern $e) {
                 $warning = "Warning: The provided glob pattern "
-                    . "'$keepGlobPattern' is considered invalid.";
+                    . "'{$keepGlobPattern}' is considered invalid.";
                 $outputContent = '<error>' . $warning . '</error>';
                 $output->writeln($outputContent);
 
@@ -391,13 +391,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         if ($globPattern || $globPattern === '') {
             try {
-                $verboseOutput = "+ Using glob pattern <info>$globPattern</info>.";
+                $verboseOutput = "+ Using glob pattern <info>{$globPattern}</info>.";
                 $output->writeln($verboseOutput, OutputInterface::VERBOSITY_VERBOSE);
 
                 $this->analyser->setGlobPattern((string) $globPattern);
             } catch (InvalidGlobPattern $e) {
                 $warning = "Warning: The provided glob pattern "
-                    . "'$globPattern' is considered invalid.";
+                    . "'{$globPattern}' is considered invalid.";
                 $outputContent = '<error>' . $warning . '</error>';
                 $output->writeln($outputContent);
 
@@ -420,7 +420,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
             } catch (NonExistentGlobPatternFile $e) {
                 $warning = "Warning: The provided glob pattern file "
-                    . "'$globPatternFile' doesn't exist.";
+                    . "'{$globPatternFile}' doesn't exist.";
                 $outputContent = '<error>' . $warning . '</error>';
                 $output->writeln($outputContent);
 
@@ -429,7 +429,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 return Command::FAILURE;
             } catch (InvalidGlobPatternFile $e) {
                 $warning = "Warning: The provided glob pattern file "
-                    . "'$globPatternFile' is considered invalid.";
+                    . "'{$globPatternFile}' is considered invalid.";
                 $outputContent = '<error>' . $warning . '</error>';
                 $output->writeln($outputContent);
 
diff --git a/src/Exceptions/GitArchiveNotValidatedYet.php b/src/Exceptions/GitArchiveNotValidatedYet.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Stolt\LeanPackage\Exceptions;
 
 class GitArchiveNotValidatedYet extends \Exception
diff --git a/src/Exceptions/GitHeadNotAvailable.php b/src/Exceptions/GitHeadNotAvailable.php
@@ -1,7 +1,8 @@
 <?php
 
-namespace Stolt\LeanPackage\Exceptions;
+declare(strict_types=1);
 
+namespace Stolt\LeanPackage\Exceptions;
 class GitHeadNotAvailable extends \Exception
 {
 }
diff --git a/src/Exceptions/GitNotAvailable.php b/src/Exceptions/GitNotAvailable.php
@@ -1,6 +1,8 @@
 <?php
-namespace Stolt\LeanPackage\Exceptions;
 
+declare(strict_types=1);
+
+namespace Stolt\LeanPackage\Exceptions;
 class GitNotAvailable extends \Exception
 {
 }
diff --git a/src/Exceptions/GitattributesCreationFailed.php b/src/Exceptions/GitattributesCreationFailed.php
@@ -1,7 +1,8 @@
 <?php
 
-namespace Stolt\LeanPackage\Exceptions;
+declare(strict_types=1);
 
+namespace Stolt\LeanPackage\Exceptions;
 class GitattributesCreationFailed extends \Exception
 {
 }
diff --git a/src/Exceptions/InvalidGlobPattern.php b/src/Exceptions/InvalidGlobPattern.php
@@ -1,7 +1,8 @@
 <?php
 
-namespace Stolt\LeanPackage\Exceptions;
+declare(strict_types=1);
 
+namespace Stolt\LeanPackage\Exceptions;
 class InvalidGlobPattern extends \Exception
 {
 }
diff --git a/src/Exceptions/InvalidGlobPatternFile.php b/src/Exceptions/InvalidGlobPatternFile.php
@@ -1,7 +1,8 @@
 <?php
 
-namespace Stolt\LeanPackage\Exceptions;
+declare(strict_types=1);
 
+namespace Stolt\LeanPackage\Exceptions;
 class InvalidGlobPatternFile extends \Exception
 {
 }
diff --git a/src/Exceptions/NoLicenseFilePresent.php b/src/Exceptions/NoLicenseFilePresent.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Stolt\LeanPackage\Exceptions;
 
 class NoLicenseFilePresent extends \Exception
diff --git a/src/Exceptions/NonExistentGlobPatternFile.php b/src/Exceptions/NonExistentGlobPatternFile.php
@@ -1,7 +1,8 @@
 <?php
 
-namespace Stolt\LeanPackage\Exceptions;
+declare(strict_types=1);
 
+namespace Stolt\LeanPackage\Exceptions;
 class NonExistentGlobPatternFile extends \Exception
 {
 }
diff --git a/src/Exceptions/PresetNotAvailable.php b/src/Exceptions/PresetNotAvailable.php
@@ -1,7 +1,8 @@
 <?php
 
-namespace Stolt\LeanPackage\Exceptions;
+declare(strict_types=1);
 
+namespace Stolt\LeanPackage\Exceptions;
 class PresetNotAvailable extends \Exception
 {
 
diff --git a/src/Exceptions/TreeNotAvailable.php b/src/Exceptions/TreeNotAvailable.php
@@ -1,6 +1,8 @@
 <?php
-namespace Stolt\LeanPackage\Exceptions;
 
+declare(strict_types=1);
+
+namespace Stolt\LeanPackage\Exceptions;
 class TreeNotAvailable extends \Exception
 {
 }
diff --git a/src/GitattributesFileRepository.php b/src/GitattributesFileRepository.php
@@ -98,7 +98,7 @@ public function applyOverwriteHeaderPolicy(string $contentToWrite): string
             return $contentToWrite;
         }
 
-        $presentContent = (string) @\file_get_contents($gitattributesPath);
+        $presentContent = (string) \file_get_contents($gitattributesPath);
         if ($presentContent === '') {
             return $contentToWrite;
         }
diff --git a/src/Helpers/Str.php b/src/Helpers/Str.php
@@ -1,5 +1,8 @@
 <?php
 
+declare(strict_types=1);
+
+
 namespace Stolt\LeanPackage\Helpers;
 
 class Str
diff --git a/src/Presets/Finder.php b/src/Presets/Finder.php
@@ -29,7 +29,7 @@ public function getAvailablePresets(): array
         foreach ($dir as $fileinfo) {
             if (!$fileinfo->isDot()) {
                 $presetsParts = \explode(self::PRESET_SUFFIX, $fileinfo->getBasename());
-                if (\count($presetsParts) == 2) {
+                if (\count($presetsParts) === 2) {
                     if ($presetsParts[0] === 'Common') {
                         continue;
                     }
@@ -62,7 +62,7 @@ public function getPresetByLanguageName(string $name): Preset
     {
         $name = \ucfirst(\strtolower($name));
 
-        if (!\in_array($name, $this->getAvailablePresets())) {
+        if (!\in_array($name, $this->getAvailablePresets(), strict: true)) {
             $message = \sprintf('Preset for %s not available. Maybe contribute it?.', $name);
             throw new PresetNotAvailable($message);
         }
diff --git a/src/Tree.php b/src/Tree.php
diff --git a/tests/CommandTester.php b/tests/CommandTester.php
diff --git a/tests/Commands/UpdateCommandTest.php b/tests/Commands/UpdateCommandTest.php
diff --git a/tests/Commands/ValidateCommandTest.php b/tests/Commands/ValidateCommandTest.php
diff --git a/tests/TestCase.php b/tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,8 @@`
`1`	`1`	`<?php`
`2`	`2`
	`3`	`+declare(strict_types=1);`
	`4`	`+`
	`5`	`+`
`3`	`6`	`namespace Stolt\LeanPackage;`
`4`	`7`
`5`	`8`	`use PharData;`
`@@ -166,7 +169,7 @@ public function compareArchive(array $unexpectedArtifacts): array`
`166`	`169`	`if ($archiveFile instanceof \SplFileInfo) {`
`167`	`170`	`if ($archiveFile->isDir()) {`
`168`	`171`	`$file = \basename($archiveFile) . '/';`
`169`		`- if (\in_array($file, $unexpectedArtifacts)) {`
	`172`	`+ if (\in_array($file, $unexpectedArtifacts, strict: true)) {`
`170`	`173`	`$foundUnexpectedArtifacts[] = $file;`
`171`	`174`	`}`
`172`	`175`	`continue;`
`@@ -179,7 +182,7 @@ public function compareArchive(array $unexpectedArtifacts): array`
`179`	`182`	`}`
`180`	`183`	`}`
`181`	`184`
`182`		`- if (\in_array($file, $unexpectedArtifacts)) {`
	`185`	`+ if (\in_array($file, $unexpectedArtifacts, strict: true)) {`
`183`	`186`	`$foundUnexpectedArtifacts[] = $file;`
`184`	`187`	`}`
`185`	`188`	`}`