feat: #6 lint route URL

Author: shaunthegeek

README.md

@@ -17,6 +17,8 @@ php artisan lint:publish
 
 ## use
 
+lint code:
+
 ```shell
 php artisan lint:check .
 php artisan lint:check app/ tests/
@@ -25,3 +27,11 @@ php artisan lint:staged
 ```
 
 The default standard is PSR-12, feel free to change the `phpcs.xml`.
+
+lint route URL:
+
+```shell
+php artisan lint:route
+```
+
+Slug(kebab-case) standard: lowercase ASCII letters, digits, and hyphens (a-z, 0–9, -)

composer.json

@@ -30,7 +30,8 @@
     "minimum-stability": "stable",
     "require": {
         "laravel/framework": ">=v6.18.38",
-        "squizlabs/php_codesniffer": "^3.5"
+        "squizlabs/php_codesniffer": "^3.5",
+        "ext-json": "*"
     },
     "require-dev": {
         "orchestra/testbench": ">=v4.8.0"

src/LintRouteCommand.php

@@ -0,0 +1,67 @@
+<?php
+
+namespace LaravelFans\Lint;
+
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\File;
+use Illuminate\Support\Str;
+
+class LintRouteCommand extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'lint:route
+        {--file=auto : route list json file}';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Lint routes';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        if ($this->option('file') == 'auto') {
+            Artisan::call('route:list', ['--json' => true]);
+            $json = Artisan::output();
+        } else {
+            $json = File::get($this->option('file'));
+        }
+        $routes = json_decode($json, true);
+        foreach ($routes as $route) {
+            if ($route['uri'] == '/') {
+                continue;
+            }
+            $this->info($route['uri']);
+            if (Str::endsWith($route['uri'], '/')) {
+                // https://docs.geostandaarden.nl/api/API-Designrules/#api-48-leave-off-trailing-slashes-from-api-endpoints
+                $this->error('API-48: Leave off trailing slashes from API endpoints');
+                return 1;
+            }
+            $tmp = explode('/', ltrim($route['uri'], '/'));
+            foreach ($tmp as $piece) {
+                // ignore variable
+                if (preg_match('/^\{[^{]+\}$/', $piece)) {
+                    continue;
+                }
+                if (!preg_match('/^[a-z0-9]+(\-[a-z0-9]+)*$/', $piece)) {
+                    $this->error('user-friendly URL should follow domain rules: '
+                        . 'lowercase ASCII letters, digits, and hyphens (a-z, 0–9, -)');
+                    return 1;
+                }
+            }
+        }
+
+        return 0;
+    }
+}

src/LintServiceProvider.php

@@ -17,6 +17,7 @@ public function boot()
             $this->commands([
                 LintCheckCommand::class,
                 LintPublishCommand::class,
+                LintRouteCommand::class,
                 LintStagedCommand::class,
             ]);
         }
@@ -32,6 +33,7 @@ public function provides()
         return [
             LintCheckCommand::class,
             LintPublishCommand::class,
+            LintRouteCommand::class,
             LintStagedCommand::class,
         ];
     }

tests/LintRouteCommandTest.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace LaravelFans\Lint\Tests;
+
+use Illuminate\Support\Facades\File;
+
+class LintRouteCommandTest extends TestCase
+{
+    public function testBadRoute()
+    {
+        $laravelPath = __DIR__ . '/../vendor/orchestra/testbench-core/laravel';
+        File::put($laravelPath . '/route.json', json_encode([
+            [
+                'method' => 'GET',
+                'uri' => 'user/',
+            ],
+        ]));
+        $this->artisan('lint:route', ['--file' => $laravelPath . '/route.json'])
+            ->assertExitCode(1);
+
+        File::put($laravelPath . '/route.json', json_encode([
+            [
+                'method' => 'GET',
+                'uri' => 'api/user/',
+            ],
+        ]));
+        $this->artisan('lint:route', ['--file' => $laravelPath . '/route.json'])
+            ->assertExitCode(1);
+
+        File::put($laravelPath . '/route.json', json_encode([
+            [
+                'method' => 'GET',
+                'uri' => 'user_profile',
+            ],
+        ]));
+        $this->artisan('lint:route', ['--file' => $laravelPath . '/route.json'])
+            ->assertExitCode(1);
+    }
+
+    public function testGoodRoute()
+    {
+        $laravelPath = __DIR__ . '/../vendor/orchestra/testbench-core/laravel';
+        File::put($laravelPath . '/route.json', json_encode([
+            [
+                'method' => 'GET',
+                'uri' => '/',
+            ],
+            [
+                'method' => 'GET',
+                'uri' => 'api/user',
+            ],
+            [
+                'method' => 'GET',
+                'uri' => '/user',
+            ],
+            [
+                'method' => 'GET|HEAD',
+                'uri' => 'api/photos/{photo}/comments/{comment}/edit',
+            ],
+            [
+                'method' => 'GET|HEAD',
+                'uri' => 'api/photos/{photo_id}/comments/{id}',
+            ],
+        ]));
+        $this->artisan('lint:route', ['--file' => $laravelPath . '/route.json'])
+            ->assertExitCode(0);
+    }
+}