chore: add a config file

Author: domthomas-dev

README.md

@@ -12,6 +12,26 @@ composer require domthomas-dev/laravel-localized-enum
 
 The package will automatically register its service provider.
 
+## Configuration
+
+Optionally, you can publish the configuration file:
+
+```bash
+php artisan vendor:publish --tag=localized-enum-config
+```
+
+This will create a `config/localized-enum.php` file where you can customize:
+
+```php
+return [
+    // Default label type when none is specified
+    'default_label' => 'label',
+    
+    // Translation file name (without .php extension)
+    'translation_file' => 'enums',
+];
+```
+
 ## Usage
 
 ### Basic Usage
@@ -179,13 +199,15 @@ $options = ContactType::options(label: 'description', locale: 'fr');
 The package automatically generates translation keys using this format:
 
 ```
-enums.{EnumClass}.{label_type}.{case_name}
+{translation_file}.{EnumClass}.{label_type}.{case_name}
 ```
 
-For example:
+For example (with default config):
 - `App\Enums\ContactType::EMAIL` → `enums.App\Enums\ContactType.label.EMAIL`
 - With description: `enums.App\Enums\ContactType.description.EMAIL`
 
+You can customize the translation file name and default label type in the configuration.
+
 ### Utility Methods
 
 ```php
@@ -211,7 +233,7 @@ echo ContactType::EMAIL->label(); // "EMAIL" (if no translation found)
 
 ### Translation Structure
 
-The translation structure uses the enum class as the top-level key:
+The translation structure uses the enum class as the top-level key in your translation files (default: `resources/lang/{locale}/enums.php`):
 
 ```php
 use App\Enums\ContactType;
@@ -235,6 +257,9 @@ return [
 ];
 ```
 
+**Note**: If you change the `translation_file` config to something other than 'enums', make sure to update your file names accordingly (e.g., `translations.php` if you set it to 'translations').
+```
+
 ## Testing
 
 ```bash

config/localized-enum.php

@@ -0,0 +1,25 @@
+<?php
+
+return [
+    /*
+    |--------------------------------------------------------------------------
+    | Default Label Type
+    |--------------------------------------------------------------------------
+    |
+    | This value determines the default label type used when no specific
+    | label type is provided to the label() method.
+    |
+    */
+    'default_label' => 'label',
+
+    /*
+    |--------------------------------------------------------------------------
+    | Translation File Name
+    |--------------------------------------------------------------------------
+    |
+    | This value determines the name of the translation file that contains
+    | the enum translations. The file should be located in your lang directory.
+    |
+    */
+    'translation_file' => 'enums',
+];

src/LocalizedEnum.php

@@ -28,8 +28,10 @@ public function label(?string $label = null, ?string $locale = null): string
      */
     protected function getLocalizationKey(?string $label = null): string
     {
-        $labelType = $label ?: 'label';
-        return 'enums.' . static::class . '.' . $labelType . '.' . $this->name;
+        $label ??= config('localized-enum.default_label', 'label');
+        $translationFile = config('localized-enum.translation_file', 'enums');
+        
+        return $translationFile . '.' . static::class . '.' . $label . '.' . $this->name;
     }
 
     /**

src/LocalizedEnumServiceProvider.php

@@ -11,14 +11,20 @@ class LocalizedEnumServiceProvider extends ServiceProvider
      */
     public function boot(): void
     {
-        //
+        if ($this->app->runningInConsole()) {
+            $this->publishes([
+                __DIR__.'/../config/localized-enum.php' => config_path('localized-enum.php'),
+            ], 'localized-enum-config');
+        }
     }
 
     /**
      * Register any application services.
      */
     public function register(): void
     {
-        //
+        $this->mergeConfigFrom(
+            __DIR__.'/../config/localized-enum.php', 'localized-enum'
+        );
     }
 }

tests/TestCase.php

@@ -21,31 +21,11 @@ protected function getPackageProviders($app)
 
     public function getEnvironmentSetUp($app)
     {
+        // Set up config for testing
+        $app['config']->set('localized-enum.default_label', 'label');
+        $app['config']->set('localized-enum.translation_file', 'enums');
+        
         // Set up translations for testing
         $app['translator']->addNamespace('test', __DIR__ . '/lang');
-        
-        // Set up test translations
-        $app['translator']->setLoaded([
-            'test::enums' => [
-                'DomThomas\LocalizedEnum\Tests\Enums\TestEnum' => [
-                    'label' => [
-                        'FIRST' => 'First Option',
-                        'SECOND' => 'Second Option',
-                        'THIRD' => 'Third Option',
-                    ],
-                    'description' => [
-                        'FIRST' => 'First option description',
-                        'SECOND' => 'Second option description',
-                        'THIRD' => 'Third option description',
-                    ],
-                ],
-                'DomThomas\LocalizedEnum\Tests\Enums\StatusEnum' => [
-                    'label' => [
-                        'ACTIVE' => 'Active Status',
-                        'INACTIVE' => 'Inactive Status',
-                    ],
-                ],
-            ],
-        ]);
     }
 }