wip

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to `laravel-package-tools` will be documented in this file.
 
+## 1.6.0 - 2021-05-23
+
+- add support for multiple config files
+
 ## 1.5.0 - 2021-03-10
 
 - add support for Blade view components

README.md

@@ -88,6 +88,15 @@ The `hasConfigFile` method will also make the config file publishable. Users of
 php artisan vendor:publish --tag=your-package-name-config
 ```
 
+Should your package have multiple config files, you can pass their names as an array to `hasConfigFile`
+
+```php
+$package
+    ->name('your-package-name')
+    ->hasConfigFile(['my-config-file', 'another-config-file']);
+```
+
+
 ### Working with views
 
 Any views your package provides, should be placed in the `<package root>/resources/views` directory.

src/Package.php

@@ -8,7 +8,7 @@ class Package
 {
     public string $name;
 
-    public ?string $configFileName = null;
+    public array $configFileNames = [];
 
     public bool $hasViews = false;
 
@@ -33,9 +33,15 @@ public function name(string $name): self
         return $this;
     }
 
-    public function hasConfigFile(string $configFileName = null): self
+    public function hasConfigFile($configFileName = null): self
     {
-        $this->configFileName = $configFileName ?? $this->shortName();
+        $configFileName =  $configFileName ?? $this->shortName();
+
+        if (! is_array($configFileName)) {
+            $configFileName = [$configFileName];
+        }
+
+        $this->configFileNames = $configFileName;
 
         return $this;
     }

src/PackageServiceProvider.php

@@ -27,7 +27,7 @@ public function register()
             throw InvalidPackage::nameIsRequired();
         }
 
-        if ($configFileName = $this->package->configFileName) {
+        foreach($this->package->configFileNames as $configFileName) {
             $this->mergeConfigFrom($this->package->basePath("/../config/{$configFileName}.php"), $configFileName);
         }
 
@@ -41,7 +41,7 @@ public function boot()
         $this->bootingPackage();
 
         if ($this->app->runningInConsole()) {
-            if ($configFileName = $this->package->configFileName) {
+            foreach($this->package->configFileNames as $configFileName) {
                 $this->publishes([
                     $this->package->basePath("/../config/{$configFileName}.php") => config_path("{$configFileName}.php"),
                 ], "{$this->package->shortName()}-config");

tests/PackageServiceProviderTests/PackageMultipleConfigTest.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace Spatie\LaravelPackageTools\Tests\PackageServiceProviderTests;
+
+use Spatie\LaravelPackageTools\Package;
+
+class PackageMultipleConfigTest extends PackageServiceProviderTestCase
+{
+    public function configurePackage(Package $package)
+    {
+        $package
+            ->name('laravel-package-tools')
+            ->hasConfigFile(['package-tools', 'alternative-config']);
+    }
+
+    /** @test */
+    public function it_can_register_multiple_config_files()
+    {
+        $this->assertEquals('value', config('package-tools.key'));
+
+        $this->assertEquals('alternative_value', config('alternative-config.alternative_key'));
+
+    }
+}

tests/TestPackage/config/alternative-config.php

@@ -0,0 +1,7 @@
+<?php
+
+return [
+    // this is a dummy config file
+
+    'alternative_key' => 'alternative_value',
+];