Add: Logic for registering hidden files in specified environments

config/route-directory-macro.php

@@ -0,0 +1,11 @@
+<?php
+
+return [
+    /*
+     * List of environments in which hidden routes (route files with `.` prefix) should be registered.
+     *
+     * This is useful for working on new routes in certain environments (usually local), while
+     * ensuring they are not registered in any other environment (usually production).
+     */
+    'register_hidden_routes_in_environments' => [],
+];

src/LaravelRouteDirectoryMacroServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace AntoninMasek\LaravelRouteDirectoryMacro;
 
+use Illuminate\Support\Facades\App;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Route;
 use Spatie\LaravelPackageTools\Package;
@@ -12,7 +13,9 @@ class LaravelRouteDirectoryMacroServiceProvider extends PackageServiceProvider
 {
     public function configurePackage(Package $package): void
     {
-        $package->name('laravel-route-directory-macro');
+        $package
+            ->name('laravel-route-directory-macro')
+            ->hasConfigFile();
     }
 
     public function packageRegistered(): void
@@ -33,8 +36,13 @@ public function packageRegistered(): void
                 ? base_path($path)
                 : $path;
 
+            $allowHiddenFilesInEnvironments = config('route-directory-macro.register_hidden_routes_in_environments');
+            $shouldLoadHiddenFiles = ! empty($allowHiddenFilesInEnvironments)
+                ? App::environment($allowHiddenFilesInEnvironments)
+                : false;
+
             $files = File::exists($path)
-                ? File::allFiles($path, false)
+                ? File::allFiles($path, $shouldLoadHiddenFiles)
                 : [];
 
             collect($files)

tests/MainTest.php

@@ -35,13 +35,6 @@
         ->toEqual(['web', 'auth']);
 });
 
-it('does not load hidden files', function () {
-    Route::loadFromDirectory('routes/app');
-
-    $secretRoute = RoutesInspector::getRoute('secret.index');
-    expect($secretRoute)->toBeNull('It loaded hidden file');
-});
-
 it('only loads php files', function () {
     Route::loadFromDirectory('routes/app');
 
@@ -140,3 +133,55 @@
     Route::loadFromDirectory('routes/public');
     expect(RoutesInspector::getRoutesCount())->toEqual(1);
 });
+
+it('does not load hidden files by default', function () {
+    Route::loadFromDirectory('routes/app');
+    config()->set('route-directory-macro.register_hidden_routes_in_environments', null);
+
+    $secretRoute = RoutesInspector::getRoute('secret.index');
+    expect($secretRoute)->toBeNull('It loaded hidden file');
+});
+
+it('does not load hidden files when config value is empty', function () {
+    Route::loadFromDirectory('routes/app');
+
+    $secretRoute = RoutesInspector::getRoute('secret.index');
+    expect($secretRoute)->toBeNull('It loaded hidden file');
+});
+
+it('does not load hidden files when config value does not contain current environment', function () {
+    $currentEnvironment = \Illuminate\Support\Facades\App::environment();
+    config()->set('route-directory-macro.register_hidden_routes_in_environments', [$currentEnvironment.'_test']);
+
+    Route::loadFromDirectory('routes/app');
+
+    $secretRoute = RoutesInspector::getRoute('secret.index');
+    expect($secretRoute)->toBeNull('It loaded hidden file');
+});
+
+it('does load hidden files in specified environment', function () {
+    $currentEnvironment = \Illuminate\Support\Facades\App::environment();
+    config()->set('route-directory-macro.register_hidden_routes_in_environments', [$currentEnvironment]);
+
+    Route::loadFromDirectory('routes/app');
+
+    $secretRoute = RoutesInspector::getRoute('secret.index');
+    expect($secretRoute)->not()->toBeNull(
+        'It did not load hidden file when explicitly allowed via config',
+    );
+});
+
+it('does load hidden files in specified environment even when more environments are specified', function () {
+    $currentEnvironment = \Illuminate\Support\Facades\App::environment();
+    config()->set('route-directory-macro.register_hidden_routes_in_environments', [
+        'local',
+        $currentEnvironment,
+    ]);
+
+    Route::loadFromDirectory('routes/app');
+
+    $secretRoute = RoutesInspector::getRoute('secret.index');
+    expect($secretRoute)->not()->toBeNull(
+        'It did not load hidden file when explicitly allowed via config',
+    );
+});