create-shapio 0.5.4 → 0.5.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-shapio",
-  "version": "0.5.4",
+  "version": "0.5.6",
   "description": "Scaffold a new Shapio project (npx create-shapio my-cms) or a site starter (--site astro|next|sveltekit)",
   "license": "Apache-2.0",
   "homepage": "https://shapio.dev",

package/templates/astro/astro.config.mjs

@@ -1,5 +1,6 @@
 import { writeFile } from 'node:fs/promises';
 import { defineConfig } from 'astro/config';
+import { devStaticPaths } from './src/integrations/devStaticPaths.ts';
 
 // `.env` (written by `npm run seed`) for the settings this file reads; the environment wins.
 try {
@@ -46,7 +47,8 @@ export default defineConfig({
   trailingSlash: 'always',
   build: { format: 'directory' },
   server: { headers: { 'Content-Security-Policy': FRAME_ANCESTORS } },
-  integrations: [frameAncestorsHeaders],
+  // devStaticPaths: in `astro dev`, an article created after the server started gets its page without a restart.
+  integrations: [frameAncestorsHeaders, devStaticPaths()],
   /**
    * Incremental builds: a page whose `cacheKey` (src/lib/cacheKey.ts) and code are unchanged is restored from
    * the previous build instead of rendered. The cache lives in Astro's cacheDir, `node_modules/.astro`, which

package/templates/astro/package.json

@@ -22,8 +22,8 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@shapio/client": "^0.5.4",
-    "@shapio/visual": "^0.5.4",
+    "@shapio/client": "^0.5.6",
+    "@shapio/visual": "^0.5.6",
     "astro": "7.3.5"
   },
   "devDependencies": {

package/templates/astro/src/integrations/devStaticPaths.test.ts

@@ -0,0 +1,40 @@
+import { describe, expect, it } from 'vitest';
+import { DEV_WINDOW_MS } from '../lib/snapshotResolver.js';
+import { staticPathsRefresher } from './devStaticPaths.js';
+
+describe('staticPathsRefresher', () => {
+  it('clears for a page request at most once per dev read window', () => {
+    let time = 0;
+    const shouldClear = staticPathsRefresher(() => time);
+    expect(shouldClear('/en/articles/a-post/')).toBe(true);
+    time += DEV_WINDOW_MS - 1;
+    expect(shouldClear('/en/articles/another/')).toBe(false);
+    expect(shouldClear('/fr/')).toBe(false);
+    time += 1;
+    expect(shouldClear('/fr/articles/bonjour/?v=1')).toBe(true);
+  });
+
+  it('treats the root and every locale path as a page', () => {
+    for (const url of ['/', '/en/', '/en/colophon/', '/fr/a-page/', undefined]) {
+      expect(staticPathsRefresher(() => 0)(url)).toBe(true);
+    }
+  });
+
+  it('ignores tooling and file requests', () => {
+    const shouldClear = staticPathsRefresher(() => 0);
+    for (const url of [
+      '/_astro/x.css',
+      '/@vite/client',
+      '/@fs/Users/me/node_modules/astro/dist/runtime.js',
+      '/@id/astro:scripts/page.js',
+      '/src/styles/site.css',
+      '/node_modules/.vite/deps/chunk.js',
+      '/favicon.svg',
+      '/build.json',
+      '/en/articles/cover.webp?w=400',
+    ]) {
+      expect(shouldClear(url)).toBe(false);
+    }
+    expect(shouldClear('/en/')).toBe(true);
+  });
+});

package/templates/astro/src/integrations/devStaticPaths.ts

@@ -0,0 +1,82 @@
+import type { AstroIntegration } from 'astro';
+import { DEV_WINDOW_MS } from '../lib/snapshotResolver.js';
+
+/**
+ * `astro dev` caches each dynamic route's getStaticPaths result until the route module changes. Content comes
+ * from Shapio, not from files, so an article (or a draft, in drafts mode) created after the dev server started
+ * has no path and its page 404s.
+ *
+ * This integration clears that cache before a page request, at most once per DEV_WINDOW_MS (the window the
+ * content reads reuse), so getStaticPaths runs again with fresh content. Every page of the starter is a dynamic
+ * route (`/[locale]/…`), so every request counts as a page request except Astro's and Vite's own (`/_astro/`,
+ * `/@vite`, `/@fs`, `/@id`, `/src/`, `/node_modules/`) and anything that looks like a file. It relies on an Astro
+ * internal: Astro clears its route cache when the `astro:content-changed` event reaches the ssr and prerender
+ * Vite environments (astro/dist/vite-plugin-app/createAstroServerApp.js, sent by
+ * astro/dist/content/vite-plugin-content-virtual-mod.js). Dev only: `astro build` never runs
+ * `astro:server:setup`, and the hook does nothing unless the command is `dev`.
+ */
+
+/** Path prefixes of Astro's and Vite's own dev requests (assets, modules, the client): never a page. */
+export const TOOLING_PATH_PREFIXES = ['/_astro/', '/@vite', '/@fs', '/@id', '/src/', '/node_modules/'];
+
+/** The Vite environments that run Astro's renderer and hold its route cache. */
+const RENDER_ENVIRONMENTS = ['ssr', 'prerender'];
+
+/** A last path segment with an extension (`favicon.svg`, `build.json`): a file, not a page. */
+const looksLikeFile = (pathname: string) =>
+  /\.[A-Za-z0-9]+$/.test(pathname.slice(pathname.lastIndexOf('/') + 1));
+
+const isPageRequest = (pathname: string) =>
+  !TOOLING_PATH_PREFIXES.some((prefix) => pathname.startsWith(prefix)) && !looksLikeFile(pathname);
+
+/**
+ * Whether a request should clear the route cache: a page request, when the last clear is at least
+ * DEV_WINDOW_MS old.
+ */
+export const staticPathsRefresher = (now: () => number = Date.now) => {
+  let lastClearAt: number | undefined;
+  return (url: string | undefined): boolean => {
+    if (!isPageRequest(new URL(url ?? '/', 'http://localhost').pathname)) {
+      return false;
+    }
+    const at = now();
+    if (lastClearAt !== undefined && at - lastClearAt < DEV_WINDOW_MS) {
+      return false;
+    }
+    lastClearAt = at;
+    return true;
+  };
+};
+
+/** The dev server Astro hands `astro:server:setup` (Vite's; vite is not a direct dependency here). */
+type DevServer = Parameters<NonNullable<AstroIntegration['hooks']['astro:server:setup']>>[0]['server'];
+
+const clearRouteCache = (server: DevServer) => {
+  for (const name of RENDER_ENVIRONMENTS) {
+    server.environments[name]?.hot.send('astro:content-changed', {});
+  }
+};
+
+export const devStaticPaths = (): AstroIntegration => {
+  let isDev = false;
+  return {
+    name: 'dev-static-paths',
+    hooks: {
+      'astro:config:setup': ({ command }) => {
+        isDev = command === 'dev';
+      },
+      'astro:server:setup': ({ server }) => {
+        if (!isDev) {
+          return;
+        }
+        const shouldClear = staticPathsRefresher();
+        server.middlewares.use((request, _response, next) => {
+          if (shouldClear(request.url)) {
+            clearRouteCache(server);
+          }
+          next();
+        });
+      },
+    },
+  };
+};

package/templates/next/package.json

@@ -18,9 +18,9 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@shapio/client": "^0.5.4",
-    "@shapio/local": "0.5.4",
-    "@shapio/visual": "^0.5.4",
+    "@shapio/client": "^0.5.6",
+    "@shapio/local": "0.5.6",
+    "@shapio/visual": "^0.5.6",
     "next": "16.3.8",
     "react": "19.3.0",
     "react-dom": "19.3.0"

package/templates/sveltekit/package.json

@@ -23,8 +23,8 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@shapio/client": "^0.5.4",
-    "@shapio/visual": "^0.5.4"
+    "@shapio/client": "^0.5.6",
+    "@shapio/visual": "^0.5.6"
   },
   "devDependencies": {
     "@sveltejs/adapter-static": "4.0.0",