feat(configuration-option): adds option and default value

Author: nunomaduro

README.md

@@ -34,6 +34,30 @@ To check your project for spelling mistakes, run:
 ./vendor/bin/peck
 ```
 
+## Configuration
+
+Peck can be configured using a `peck.json` file in the root of your project. Here's an example configuration:
+
+```json
+{
+    "ignore": {
+        "words": [
+            "config",
+            "namespace"
+        ],
+        "directories": [
+            "app/MyNamespace"
+        ]
+    }
+}
+```
+
+You can also specify the path to the configuration file using the `--config` option:
+
+```bash
+./vendor/bin/peck --config relative/path/to/peck.json
+```
+
 ---
 
 Peck is an open-sourced software licensed under the **[MIT license](https://opensource.org/licenses/MIT)**.

bin/peck

@@ -3,6 +3,7 @@
 
 declare(strict_types=1);
 
+use Peck\Console\Commands\CheckCommand;
 use Symfony\Component\Console\Application;
 
 foreach ([
@@ -22,9 +23,9 @@ $application = new Application(
 );
 
 $application->add(
-    new \Peck\Console\Commands\DefaultCommand(),
+    new CheckCommand(),
 );
 
-$application->setDefaultCommand('default');
+$application->setDefaultCommand('check');
 
 $application->run();

src/Config.php

@@ -37,6 +37,8 @@ public function __construct(
      */
     public static function resolveConfigFilePathUsing(Closure $closure): void
     {
+        self::flush();
+
         self::$resolveConfigFilePathUsing = $closure;
     }
 
@@ -59,12 +61,12 @@ public static function instance(): self
         }
 
         $basePath = dirname(array_keys(ClassLoader::getRegisteredLoaders())[0]);
-        $filePath = self::$resolveConfigFilePathUsing instanceof Closure
+        $filePath = $basePath.'/'.(self::$resolveConfigFilePathUsing instanceof Closure
             ? (self::$resolveConfigFilePathUsing)()
-            : ($basePath.'/peck.json');
+            : 'peck.json');
 
         $contents = file_exists($filePath)
-            ? (string) file_get_contents($basePath.'/peck.json')
+            ? (string) file_get_contents($filePath)
             : '{}';
 
         /** @var array{

src/Console/Commands/DefaultCommand.php src/Console/Commands/CheckCommand.phpsrc/Console/Commands/DefaultCommand.php renamed to src/Console/Commands/CheckCommand.php

@@ -5,11 +5,13 @@
 namespace Peck\Console\Commands;
 
 use Composer\Autoload\ClassLoader;
+use Peck\Config;
 use Peck\Kernel;
 use Peck\ValueObjects\Issue;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
 use function Termwind\render;
@@ -20,14 +22,17 @@
  *
  * @internal
  */
-#[AsCommand(name: 'default')]
-final class DefaultCommand extends Command
+#[AsCommand(name: 'check')]
+final class CheckCommand extends Command
 {
     /**
      * Executes the command.
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
+        $configurationPath = $input->getOption('config');
+        Config::resolveConfigFilePathUsing(fn (): mixed => $configurationPath);
+
         $kernel = Kernel::default();
 
         $issues = $kernel->handle([
@@ -63,7 +68,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
      */
     protected function configure(): void
     {
-        $this->setDescription('Checks for misspellings in the given directory.');
+        $this->setDescription('Checks for misspellings in the given directory.')
+            ->addOption('config', 'c', InputOption::VALUE_OPTIONAL, 'The configuration file to use.', 'peck.json');
     }
 
     /**