create-nevela 0.1.0 → 0.1.2

package/template/laravel/src/Nevela.php

@@ -17,7 +17,7 @@ use Nevela\Laravel\Support\Naming;
 final class Nevela
 {
     /** Written by `pnpm release`; the same number as the repository's git tag. */
-    public const VERSION = '0.1.0';
+    public const VERSION = '0.1.2';
 
     /** @var array<string, Descriptor> */
     private static array $descriptors = [];

package/template/laravel/src/NevelaServiceProvider.php

@@ -1,65 +1,66 @@
-<?php
-
-namespace Nevela\Laravel;
-
-use Illuminate\Contracts\Debug\ExceptionHandler;
-use Illuminate\Support\Facades\Route;
-use Illuminate\Support\ServiceProvider;
-use Nevela\Laravel\Console\GenerateCommand;
-use Nevela\Laravel\Console\MakeResourceCommand;
-use Nevela\Laravel\Console\SeedCommand;
-use Nevela\Laravel\Console\UserCommand;
-use Nevela\Laravel\Http\FlareErrors;
-use Nevela\Laravel\Http\TokenController;
-
-final class NevelaServiceProvider extends ServiceProvider
-{
-    public function register(): void
-    {
-        $this->mergeConfigFrom(__DIR__.'/../config/nevela.php', 'nevela');
-    }
-
-    public function boot(): void
-    {
-        if ($this->app->runningInConsole()) {
-            $this->publishes([__DIR__.'/../config/nevela.php' => config_path('nevela.php')], 'nevela-config');
-            $this->commands([MakeResourceCommand::class, GenerateCommand::class, SeedCommand::class, UserCommand::class]);
-        }
-
-        $this->callAfterResolving(ExceptionHandler::class, function ($handler) {
-            if (method_exists($handler, 'renderable')) {
-                $handler->renderable(fn (\Throwable $e, $request) => FlareErrors::render($e, $request));
-            }
-        });
-
-        if (! $this->app->routesAreCached()) {
-            $this->registerRoutes();
-        }
-    }
-
-    private function registerRoutes(): void
-    {
-        $prefix = config('nevela.prefix', 'api');
-
-        if (config('nevela.auth.enabled', true)) {
-            Route::prefix($prefix)->middleware('api')->name('nevela.auth.')->group(function () {
-                Route::post('auth/token', [TokenController::class, 'store'])->middleware('throttle:6,1')->name('store');
-                Route::middleware('auth:sanctum')->group(function () {
-                    Route::get('auth/me', [TokenController::class, 'show'])->name('show');
-                    Route::delete('auth/token', [TokenController::class, 'destroy'])->name('destroy');
-                });
-            });
-        }
-
-        Route::prefix($prefix)->middleware(config('nevela.middleware', ['api', 'auth:sanctum']))->name('nevela.')->group(function () {
-            // The descriptors, so the web app (and tooling) can check it matches the API.
-            Route::get('_nevela/resources', fn () => response()->json([
-                'data' => array_map(fn ($d) => $d->toArray(), Nevela::all()),
-            ]))->name('resources');
-
-            if (is_file($routes = base_path('routes/nevela.php'))) {
-                require $routes;
-            }
-        });
-    }
-}
+<?php
+
+namespace Nevela\Laravel;
+
+use Illuminate\Contracts\Debug\ExceptionHandler;
+use Illuminate\Support\Facades\Route;
+use Illuminate\Support\ServiceProvider;
+use Nevela\Laravel\Console\GenerateCommand;
+use Nevela\Laravel\Console\MakeResourceCommand;
+use Nevela\Laravel\Console\SeedCommand;
+use Nevela\Laravel\Console\UpdateCommand;
+use Nevela\Laravel\Console\UserCommand;
+use Nevela\Laravel\Http\FlareErrors;
+use Nevela\Laravel\Http\TokenController;
+
+final class NevelaServiceProvider extends ServiceProvider
+{
+    public function register(): void
+    {
+        $this->mergeConfigFrom(__DIR__.'/../config/nevela.php', 'nevela');
+    }
+
+    public function boot(): void
+    {
+        if ($this->app->runningInConsole()) {
+            $this->publishes([__DIR__.'/../config/nevela.php' => config_path('nevela.php')], 'nevela-config');
+            $this->commands([MakeResourceCommand::class, GenerateCommand::class, SeedCommand::class, UserCommand::class, UpdateCommand::class]);
+        }
+
+        $this->callAfterResolving(ExceptionHandler::class, function ($handler) {
+            if (method_exists($handler, 'renderable')) {
+                $handler->renderable(fn (\Throwable $e, $request) => FlareErrors::render($e, $request));
+            }
+        });
+
+        if (! $this->app->routesAreCached()) {
+            $this->registerRoutes();
+        }
+    }
+
+    private function registerRoutes(): void
+    {
+        $prefix = config('nevela.prefix', 'api');
+
+        if (config('nevela.auth.enabled', true)) {
+            Route::prefix($prefix)->middleware('api')->name('nevela.auth.')->group(function () {
+                Route::post('auth/token', [TokenController::class, 'store'])->middleware('throttle:6,1')->name('store');
+                Route::middleware('auth:sanctum')->group(function () {
+                    Route::get('auth/me', [TokenController::class, 'show'])->name('show');
+                    Route::delete('auth/token', [TokenController::class, 'destroy'])->name('destroy');
+                });
+            });
+        }
+
+        Route::prefix($prefix)->middleware(config('nevela.middleware', ['api', 'auth:sanctum']))->name('nevela.')->group(function () {
+            // The descriptors, so the web app (and tooling) can check it matches the API.
+            Route::get('_nevela/resources', fn () => response()->json([
+                'data' => array_map(fn ($d) => $d->toArray(), Nevela::all()),
+            ]))->name('resources');
+
+            if (is_file($routes = base_path('routes/nevela.php'))) {
+                require $routes;
+            }
+        });
+    }
+}

package/template/laravel/src/Support/DashboardUpdate.php

@@ -0,0 +1,110 @@
+<?php
+
+namespace Nevela\Laravel\Support;
+
+/**
+ * Works out how to bring an app's dashboard up to a newer template without losing what
+ * the developer changed.
+ *
+ * Three versions of every file are compared: the template the app was created from
+ * (base), the newer template (next) and what is in the app now (yours). Only a file the
+ * developer hasn't touched is replaced. Pure on purpose: no filesystem, no network.
+ */
+final class DashboardUpdate
+{
+    public const UPDATE = 'update';      // you didn't change it; the template did
+    public const ADD = 'add';            // new in the template
+    public const CONFLICT = 'conflict';  // you changed it and so did the template
+    public const REMOVED = 'removed';    // gone from the template; you still have it unchanged
+
+    /**
+     * @param  array<string, string>  $base  path => contents, the template the app started from
+     * @param  array<string, string>  $next  path => contents, the template to move to
+     * @param  array<string, string|null>  $yours  path => contents in the app, null when the file is missing
+     * @return array<string, string> path => one of the constants above. Files needing nothing are left out.
+     */
+    public static function plan(array $base, array $next, array $yours): array
+    {
+        $plan = [];
+        foreach ($next as $path => $contents) {
+            $mine = $yours[$path] ?? null;
+            $before = $base[$path] ?? null;
+
+            if ($mine !== null && self::same($mine, $contents)) {
+                continue; // already there
+            }
+            if ($mine === null) {
+                // Not in the app. Add it if it is new; leave it out if you deleted it.
+                if ($before === null) {
+                    $plan[$path] = self::ADD;
+                }
+
+                continue;
+            }
+            if ($before !== null && self::same($before, $contents)) {
+                continue; // the template didn't change this file; your version stands
+            }
+            $plan[$path] = $before !== null && self::same($mine, $before) ? self::UPDATE : self::CONFLICT;
+        }
+
+        foreach ($base as $path => $contents) {
+            $mine = $yours[$path] ?? null;
+            if (! isset($next[$path]) && $mine !== null && self::same($mine, $contents)) {
+                $plan[$path] = self::REMOVED;
+            }
+        }
+
+        ksort($plan);
+
+        return $plan;
+    }
+
+    /**
+     * Move the app's package.json to the template's dependency versions, keeping its name
+     * and anything else the developer added.
+     *
+     * A dependency is moved when the app still has the version the old template had, or
+     * doesn't have it at all. One the developer pinned differently is left and reported.
+     *
+     * @return array{json: string, changed: array<string, string>, kept: array<string, string>}
+     */
+    public static function mergePackageJson(string $yours, string $base, string $next): array
+    {
+        $app = json_decode($yours, true, 512, JSON_THROW_ON_ERROR);
+        $old = json_decode($base, true, 512, JSON_THROW_ON_ERROR);
+        $new = json_decode($next, true, 512, JSON_THROW_ON_ERROR);
+        $changed = [];
+        $kept = [];
+
+        foreach (['dependencies', 'devDependencies'] as $section) {
+            foreach ($new[$section] ?? [] as $name => $version) {
+                $mine = $app[$section][$name] ?? null;
+                if ($mine === $version) {
+                    continue;
+                }
+                $before = $old[$section][$name] ?? null;
+                if ($mine === null || $mine === $before) {
+                    $app[$section][$name] = $version;
+                    $changed[$name] = ($mine ?? 'not installed').' → '.$version;
+                } else {
+                    $kept[$name] = "{$mine} (template: {$version})";
+                }
+            }
+            if (isset($app[$section])) {
+                ksort($app[$section]);
+            }
+        }
+
+        // npm's own formatting: two spaces, unescaped slashes, a trailing newline.
+        $json = json_encode($app, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
+        $json = preg_replace_callback('/^( {4})+/m', fn ($m) => str_repeat('  ', strlen($m[0]) / 4), $json);
+
+        return ['json' => $json."\n", 'changed' => $changed, 'kept' => $kept];
+    }
+
+    /** Equal apart from line endings: git on Windows may have rewritten them. */
+    public static function same(string $a, string $b): bool
+    {
+        return $a === $b || str_replace("\r\n", "\n", $a) === str_replace("\r\n", "\n", $b);
+    }
+}

package/template/web/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nevela-web",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "private": true,
   "type": "module",
   "scripts": {