feat(routing): implement routing helper facade

Author: mentAl-maZe

.gitignore

@@ -2,3 +2,4 @@
 node_modules/
 npm-debug.log
 yarn-error.log
+.vscode

README.md

@@ -49,9 +49,9 @@ Options:
 
 By default the package automatically adds a route for nuxt pages.
 
-`config('nuxt.prefix').'/{path?}'`
+`Nuxt::route('/{path?}')->where('path', '.*')->name('nuxt');`
 
-This route is named `'nuxt'` and can be used to redirect to using Laravels route helper.
+This route is named `'nuxt'` and can be used with Laravels route helper.
 
 ```php
 route('nuxt');
@@ -65,12 +65,15 @@ You can disable/enable automatic routing with the `'routing'` setting in `config
 
 ## Manual Routing
 
-If you would like to manually define routes for nuxt you can use the included Controller.
+The package provides a simple facade which might be used to register nuxt routes.  
+Routes will automatically be prefixed with the configured path and a controller will be attached which handles internal redirection to nuxt.  
+The method returns a `Illuminate\Routing\Route` instance and may be used as normal.
+
+In `routes/web.php`:
 
 ```php
 
-use M2S\LaravelNuxt\Http\Controllers\NuxtController;
+use M2S\LaravelNuxt\Facades\Nuxt;
 
-// Be sure to use the defined 'prefix', as nuxt uses this internally for route resolution
-Route::get('app/example/route', NuxtController::class);
+Nuxt::route('example/route')->name('nuxt.example');
 ```

composer.json

@@ -42,7 +42,10 @@
         "laravel": {
             "providers": [
                 "M2S\\LaravelNuxt\\LaravelNuxtServiceProvider"
-            ]
+            ],
+            "aliases": {
+                "Nuxt": "M2S\\LaravelNuxt\\Facades\\Nuxt"
+            }
         }
     }
 }

phpmd.xml

@@ -6,7 +6,11 @@
     <exclude-pattern>*/views/*</exclude-pattern>
     <rule ref="rulesets/cleancode.xml/BooleanArgumentFlag" />
     <rule ref="rulesets/cleancode.xml/ElseExpression" />
-    <rule ref="rulesets/cleancode.xml/StaticAccess" />
+    <rule ref="rulesets/cleancode.xml/StaticAccess">
+        <properties>
+            <property name="exceptions" value="\Illuminate\Support\Facades\Route" />
+        </properties>
+    </rule>
     <rule ref="rulesets/codesize.xml" />
     <rule ref="rulesets/controversial.xml/Superglobals" />
     <rule ref="rulesets/controversial.xml/CamelCaseClassName" />

routes/nuxt.php

@@ -1,11 +1,5 @@
 <?php
 
-use Illuminate\Support\Facades\Route;
-use M2S\LaravelNuxt\Http\Controllers\NuxtController;
+use M2S\LaravelNuxt\Facades\Nuxt;
 
-$prefix = rtrim(config('nuxt.prefix'), '/');
-
-Route::get(
-    "$prefix/{path?}",
-    NuxtController::class
-)->name('nuxt')->where('path', '.*');
+Nuxt::route('{path?}')->name('nuxt')->where('path', '.*');

src/Console/Commands/InstallCommand.php

@@ -59,9 +59,9 @@ public function __construct()
     public function handle()
     {
         $source = base_path($this->argument('source'));
-        $prefixConfig = trim(config('nuxt.prefix'), '/');
         $yarn = $this->option('yarn') ?: $this->confirm('Use yarn package manager?');
         $typescript = $this->option('typescript') ?: $this->confirm('Use typescript runtime?');
+        $prefixConfig = trim(config('nuxt.prefix'), '/');
         $prefix = trim($this->option('prefix') ?: $prefixConfig, '/');
 
         $this->installNuxtRemote($source, $yarn);

src/Facades/Nuxt.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace M2S\LaravelNuxt\Facades;
+
+use Illuminate\Support\Facades\Route;
+use M2S\LaravelNuxt\Http\Controllers\NuxtController;
+
+class Nuxt
+{
+    public static function route(string $path)
+    {
+        return Route::get(
+            '/'.trim(config('nuxt.prefix'), '/').'/'.trim($path, '/'),
+            NuxtController::class
+        );
+    }
+}