Omit configurable main locale prefix from URL

Author: ivanvermeyen

config/localized-routes.php

@@ -7,4 +7,12 @@
      */
     'supported-locales' => [],
 
+    /**
+     * If you have a main locale and don't want
+     * to prefix it in the URL, specify it here.
+     *
+     * 'omit_url_prefix_for_locale' => 'en',
+     */
+    'omit_url_prefix_for_locale' => null,
+
 ];

src/Macros/LocalizedRoutesMacro.php

@@ -21,16 +21,25 @@ public static function register()
             $currentLocale = App::getLocale();
 
             $locales = Config::get('localized-routes.supported-locales', []);
+            $omitPrefix = Config::get('localized-routes.omit_url_prefix_for_locale');
 
             foreach ($locales as $locale) {
                 // Change the current locale so we can
                 // use it in the callback, for example
                 // to register translated route URI's.
                 App::setLocale($locale);
 
-                // Wrap the localized routes in a group and prepend
-                // the locale to the URI and the route name.
-                Route::prefix($locale)->name("{$locale}.")->group($callback);
+                // Create a new route and prepend
+                // the locale to the route name.
+                $route = Route::name("{$locale}.");
+
+                // Prefix the URL unless the locale
+                // is configured to be omitted.
+                if ($locale !== $omitPrefix) {
+                    $route->prefix($locale);
+                }
+
+                $route->group($callback);
             }
 
             // Restore the original locale.

tests/Unit/Macros/LocalizedRoutesMacroTest.php

@@ -69,6 +69,31 @@ public function it_registers_a_root_route_for_each_locale()
         $this->assertContains('nl', $uris);
     }
 
+    /** @test */
+    public function it_registers_a_url_without_prefix_for_a_configured_main_locale()
+    {
+        $this->setAvailableLocales(['en', 'nl']);
+
+        Config::set('localized-routes.omit_url_prefix_for_locale', 'en');
+
+        Route::localized(function () {
+            Route::get('about', function () {})
+                ->name('about');
+        });
+
+        $routes = $this->getRoutes();
+        $names = $routes->pluck('action.as');
+        $uris = $routes->pluck('uri');
+
+        $this->assertNotContains('about', $names);
+        $this->assertContains('en.about', $names);
+        $this->assertContains('nl.about', $names);
+
+        $this->assertNotContains('en/about', $uris);
+        $this->assertContains('about', $uris);
+        $this->assertContains('nl/about', $uris);
+    }
+
     /** @test */
     public function it_temporarily_changes_the_app_locale_when_registering_the_routes()
     {