feat: adds configuration (squash 0)

Author: raphaelstolt

src/Commands/LintCommand.php

@@ -5,6 +5,7 @@
 namespace Stolt\ReadmeLint\Commands;
 
 use Stolt\ReadmeLint\Configuration;
+use Stolt\ReadmeLint\Configuration\Resolver as ConfigurationResolver;
 use Stolt\ReadmeLint\Linter;
 use Stolt\ReadmeLint\LintIssue;
 use Stolt\ReadmeLint\Rules\BadgeRule;
@@ -39,7 +40,7 @@ protected function configure(): void
             'rules',
             null,
             InputOption::VALUE_OPTIONAL,
-            "Comma-separated list of lint rules to apply (e.g. RequiredSectionsRule, MaxLineLengthRule)"
+            'Comma-separated list of lint rules to apply (e.g. RequiredSectionsRule, MaxLineLengthRule)'
         )->addOption(
             'config',
             null,
@@ -68,18 +69,20 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
         $linter = (new Linter($path));
         $rulesResolver = new Resolver();
+        $configurationResolver = new ConfigurationResolver();
 
-        $viaOptionSetConfigPath = (string) $input->getOption('config');
+        $viaOptionSetConfigurationPath = (string) $input->getOption('config');
         $viaOptionSetRules = (string) $input->getOption('rules');
 
-        if ($viaOptionSetConfigPath !== '') {
-            if (!\file_exists($viaOptionSetConfigPath)) {
-                $output->writeln('Configuration file <error>not</error> found at <info>' . $viaOptionSetConfigPath . '</info>');
+        $configurationPath = $configurationResolver->resolveConfigurationPath($viaOptionSetConfigurationPath);
 
+        if ($configurationPath !== null) {
+            if (!\file_exists($configurationPath)) {
+                $output->writeln('Configuration file <error>not</error> found at <info>' . $configurationPath . '</info>');
                 return Command::FAILURE;
             }
 
-            $config = require $viaOptionSetConfigPath;
+            $config = require $configurationPath;
 
             if ($config instanceof Configuration) {
                 $linter->addRules($config->getRulesToApply());
@@ -90,10 +93,16 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                     $linter->addRules($resolved);
                 }
             }
-        } elseif ($viaOptionSetRules !== '') {
+        }
+
+        // Override config rules with --rules option if provided
+        if ($viaOptionSetRules !== '') {
             $names = \array_values(\array_filter(\array_map('trim', \explode(',', $viaOptionSetRules))));
+            // Clear previously added rules and use only the ones from --rules option
+            $linter = (new Linter($path));
             $linter->addRules($rulesResolver->resolveRulesByNames($names));
-        } else {
+        } elseif ($configurationPath === null) {
+            // No config found and no rules option provided, use defaults
             $linter->addRules([
                 new RequiredSectionsRule(),
                 new BadgeRule(),

src/Configuration.php

@@ -21,6 +21,8 @@ final class Configuration
     /**
      * @param Linter $linter
      * @throws ReflectionException
+     *
+     * TODO: Remove linter dependency from configuration.
      */
     public function __construct(Linter $linter)
     {

src/Configuration/Resolver.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stolt\ReadmeLint\Configuration;
+
+final class Resolver
+{
+    /**
+     * Resolves the configuration file path to use.
+     *
+     * Priority:
+     * 1. Explicit --config option of the Lint command
+     * 2. .readme-lint.php in the current directory
+     * 3. null (no config)
+     */
+    public function resolveConfigurationPath(?string $explicitConfigurationPath): ?string
+    {
+        if ($explicitConfigurationPath !== null && $explicitConfigurationPath !== '') {
+            return $explicitConfigurationPath;
+        }
+
+        $defaultConfigPath = \getcwd() . DIRECTORY_SEPARATOR . '.readme-lint.php';
+
+        // TODO: Validate that the file is valid PHP and returns a configuration object or array.
+
+        if (\file_exists($defaultConfigPath)) {
+            return $defaultConfigPath;
+        }
+
+        return null;
+    }
+}

tests/Fixtures/.readme-lint.php

@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+use Stolt\ReadmeLint\Configuration;
+use Stolt\ReadmeLint\Linter;
+
+return (new Configuration(new Linter(\getcwd())))
+    ->addRulesToApply(['NoTodoCommentRule', 'LogoPresenceRule']);

tests/Unit/Configuration/ResolverTest.php

@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+
+namespace Tests\Unit\Configuration;
+
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+final class ResolverTest extends TestCase
+{
+    #[Test]
+    public function resolvesConfigurationFromArrayFormat(): void
+    {
+        $this->markTestIncomplete('Missing unit tests.');
+        // TODO: Add tests.
+    }
+}