crazywhalecc/static-php-cli
1
0
Fork 0
mirror of https://github.com/crazywhalecc/static-php-cli.git synced 2026-03-18 04:44:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add lint-config command to check and sort configuration files

Browse Source
This commit is contained in:
crazywhalecc 2026-02-06 10:17:58 +08:00
parent 39a207076e
commit fba2676d80
No known key found for this signature in database
GPG Key ID: 1F4BDD59391F2680
3 changed files with 94 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

97
captainhook.json
View File

@ -1,44 +1,53 @@
{ {
"pre-push": { "pre-push": {
"enabled": true, "enabled": true,
"actions": [ "actions": [
{ {
"action": "php vendor/bin/phpstan analyse --memory-limit 300M" "action": "php vendor/bin/phpstan analyse --memory-limit 300M"
} }
] ]
}, },
"pre-commit": { "pre-commit": {
"enabled": true, "enabled": true,
"actions": [ "actions": [
{ {
"action": "php vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --dry-run --diff {$STAGED_FILES|of-type:php} --sequential", "action": "php vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --dry-run --diff {$STAGED_FILES|of-type:php} --sequential",
"conditions": [ "conditions": [
{ {
"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\OfType", "exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\OfType",
"args": ["php"] "args": ["php"]
} }
] ]
} },
] {
}, "action": "bin/spc dev:lint-config --check",
"post-change": { "conditions": [
"enabled": true, {
"actions": [ "exec": "\\CaptainHook\\App\\Hook\\Condition\\FileStaged\\InDirectory",
{ "args": ["config"]
"action": "composer install", }
"options": [], ]
"conditions": [ }
{ ]
"exec": "\\CaptainHook\\App\\Hook\\Condition\\FileChanged\\Any", },
"args": [ "post-change": {
[ "enabled": true,
"composer.json", "actions": [
"composer.lock" {
] "action": "composer install",
] "options": [],
} "conditions": [
] {
} "exec": "\\CaptainHook\\App\\Hook\\Condition\\FileChanged\\Any",
] "args": [
} [
} "composer.json",
"composer.lock"
]
]
}
]
}
]
}
}

1
composer.json
View File

@ -50,6 +50,7 @@
"scripts": { "scripts": {
"analyse": "phpstan analyse --memory-limit 300M", "analyse": "phpstan analyse --memory-limit 300M",
"cs-fix": "php-cs-fixer fix", "cs-fix": "php-cs-fixer fix",
"lint-config": "bin/spc dev:lint-config",
"test": "vendor/bin/phpunit tests/ --no-coverage", "test": "vendor/bin/phpunit tests/ --no-coverage",
"build:phar": "vendor/bin/box compile" "build:phar": "vendor/bin/box compile"
}, },

50
src/StaticPHP/Command/Dev/LintConfigCommand.php
View File

@ -7,6 +7,7 @@ namespace StaticPHP\Command\Dev;
use StaticPHP\Command\BaseCommand; use StaticPHP\Command\BaseCommand;
use StaticPHP\Registry\Registry; use StaticPHP\Registry\Registry;
use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Yaml\Yaml; use Symfony\Component\Yaml\Yaml;
#[AsCommand('dev:lint-config', 'Lint configuration file format', ['dev:sort-config'])] #[AsCommand('dev:lint-config', 'Lint configuration file format', ['dev:sort-config'])]
@ -14,15 +15,28 @@ class LintConfigCommand extends BaseCommand
{ {
public function handle(): int public function handle(): int
{ {
$checkOnly = $this->input->getOption('check');
$hasChanges = false;
// get loaded configs // get loaded configs
$loded_configs = Registry::getLoadedArtifactConfigs(); $loded_configs = Registry::getLoadedArtifactConfigs();
foreach ($loded_configs as $file) { foreach ($loded_configs as $file) {
$this->sortConfigFile($file, 'artifact'); if ($this->sortConfigFile($file, 'artifact', $checkOnly)) {
$hasChanges = true;
}
} }
$loaded_pkg_configs = Registry::getLoadedPackageConfigs(); $loaded_pkg_configs = Registry::getLoadedPackageConfigs();
foreach ($loaded_pkg_configs as $file) { foreach ($loaded_pkg_configs as $file) {
$this->sortConfigFile($file, 'package'); if ($this->sortConfigFile($file, 'package', $checkOnly)) {
$hasChanges = true;
}
} }
if ($checkOnly && $hasChanges) {
$this->output->writeln('<error>Some config files need sorting. Run "bin/spc dev:lint-config" to fix them.</error>');
return static::FAILURE;
}
return static::SUCCESS; return static::SUCCESS;
} }
@ -88,22 +102,27 @@ class LintConfigCommand extends BaseCommand
return $a <=> $b; return $a <=> $b;
} }
private function sortConfigFile(mixed $file, string $config_type): void protected function configure(): void
{
$this->addOption('check', null, InputOption::VALUE_NONE, 'Check if config files need sorting without modifying them');
}
private function sortConfigFile(mixed $file, string $config_type, bool $checkOnly): bool
{ {
// read file content with different extensions // read file content with different extensions
$content = file_get_contents($file); $content = file_get_contents($file);
if ($content === false) { if ($content === false) {
$this->output->writeln("Failed to read artifact config file: {$file}"); $this->output->writeln("Failed to read config file: {$file}");
return; return false;
} }
$data = match (pathinfo($file, PATHINFO_EXTENSION)) { $data = match (pathinfo($file, PATHINFO_EXTENSION)) {
'json' => json_decode($content, true), 'json' => json_decode($content, true),
'yml', 'yaml' => Yaml::parse($content), // skip yaml files for now 'yml', 'yaml' => Yaml::parse($content),
default => null, default => null,
}; };
if (!is_array($data)) { if (!is_array($data)) {
$this->output->writeln("Invalid JSON format in artifact config file: {$file}"); $this->output->writeln("Invalid format in config file: {$file}");
return; return false;
} }
ksort($data); ksort($data);
foreach ($data as $artifact_name => &$config) { foreach ($data as $artifact_name => &$config) {
@ -115,7 +134,18 @@ class LintConfigCommand extends BaseCommand
'yml', 'yaml' => Yaml::dump($data, 4, 2), 'yml', 'yaml' => Yaml::dump($data, 4, 2),
default => null, default => null,
}; };
file_put_contents($file, $new_content);
$this->output->writeln("Sorted artifact config file: {$file}"); // Check if content has changed
if ($content !== $new_content) {
if ($checkOnly) {
$this->output->writeln("<comment>File needs sorting: {$file}</comment>");
return true;
}
file_put_contents($file, $new_content);
$this->output->writeln("Sorted config file: {$file}");
return true;
}
return false;
} }
} }