create-substrat 0.12.13 → 0.13.0

package/index.js

@@ -12,12 +12,13 @@
  * break at install time and damage the name it exists to protect.
  */
 
-import { cpSync, existsSync, mkdirSync, readdirSync, writeFileSync } from 'node:fs';
+import { cpSync, existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'node:fs';
 import { basename, dirname, join, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
 
 import { DEV_SERVERS } from './dev-servers.js';
 import { TEST_RUNNER, TSCONFIG, VITEST_CONFIG } from './project-files.js';
+import { offerLongPaths } from './windows.js';
 
 const HERE = dirname(fileURLToPath(import.meta.url));
 const TEMPLATE = join(HERE, 'template');
@@ -36,12 +37,12 @@ const TEMPLATE = join(HERE, 'template');
 // The runtime packages release together off one version line (the changesets `fixed`
 // group), so one constant is right for all of them. Engines do NOT share a line —
 // each versions on its own, so one pin per engine, deliberately.
-const SUBSTRAT = '^0.163.0';
-const ENGINE_WORKORDER = '^0.12.47';
-const ENGINE_INVOICING = '^0.11.47';
+const SUBSTRAT = '^0.164.0';
+const ENGINE_WORKORDER = '^0.12.48';
+const ENGINE_INVOICING = '^0.11.48';
 const BOUNDARY_LINT = '^0.8.0';
-const DEV_ISSUER = '^0.2.45';
-const ATTACHMENT_EXTRACTORS = '^0.2.24';
+const DEV_ISSUER = '^0.2.46';
+const ATTACHMENT_EXTRACTORS = '^0.2.25';
 
 const DOCS = 'https://substrat.net';
 
@@ -70,7 +71,7 @@ function usage() {
 function toPackageName(dir) {
   const name = basename(resolve(dir))
     .toLowerCase()
-    .replace(/[^a-z0-9-~]+/g, '-')
+    .replace(/[^a-z0-9-]+/g, '-')
     .replace(/^[-_.]+|[-_.]+$/g, '');
   return name || 'substrat-vertical';
 }
@@ -138,7 +139,13 @@ function packageJson(name) {
         // The local OIDC issuer `pnpm dev` signs you in at. A devDependency on
         // purpose: it is never imported by anything the worker bundles.
         '@substrat-run/dev-issuer': DEV_ISSUER,
-        '@cloudflare/workers-types': '^4.20250109.0',
+        // What `substrat push` builds the Worker with. The CLI runs the project's own
+        // wrangler and never downloads one, so a push builds with the version pinned here.
+        wrangler: '^4.151.0',
+        // Major 5, because wrangler 4.151+ peers on it: with 4 here, `npm install` of a new
+        // project stops on ERESOLVE. The template compiles against 5 (checked by installing a
+        // scaffold from npm); the workspace catalog, which template-check reads, is still on 4.
+        '@cloudflare/workers-types': '^5.20261023.1',
         '@types/better-sqlite3': '^9.6.0',
         '@types/node': '^22.0.0',
         concurrently: '^9.0.0',
@@ -200,7 +207,7 @@ pnpm typecheck
 `;
 }
 
-function main() {
+async function main() {
   const target = process.argv[2];
   if (target === '-h' || target === '--help') {
     usage();
@@ -227,6 +234,12 @@ function main() {
   // Generated configs — these need the project name, so they aren't in the template.
   const name = toPackageName(target);
   writeFileSync(join(dest, 'package.json'), packageJson(name));
+  // The gate key is the project's registry slug (the package name): a vertical may declare only
+  // its own slug and the engines' keys (#2388), so the template's `bikeshop` becomes the name.
+  for (const file of ['src/manifest.ts', 'src/provision.ts']) {
+    const path = join(dest, file);
+    writeFileSync(path, readFileSync(path, 'utf8').replace(/(entitlementKey: |ENTITLEMENT_KEYS = \[[^\]]*)'bikeshop'/, `$1'${name}'`));
+  }
   writeFileSync(join(dest, 'tsconfig.json'), TSCONFIG);
   writeFileSync(join(dest, 'vitest.config.ts'), VITEST_CONFIG);
   writeFileSync(join(dest, '.gitignore'), GITIGNORE);
@@ -250,6 +263,10 @@ function main() {
       '',
     ].join('\n'),
   );
+
+  // Windows only, and only when the setting is off: one question, then Windows' own prompt.
+  const longPaths = await offerLongPaths();
+  if (longPaths.length) process.stdout.write(`${longPaths.join('\n')}\n`);
 }
 
-main();
+main().catch((error) => fail(error instanceof Error ? error.message : String(error)));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-substrat",
-  "version": "0.12.13",
+  "version": "0.13.0",
   "description": "Scaffold a Substrat vertical — `npm create substrat <dir>`.",
   "license": "Apache-2.0",
   "repository": {
@@ -26,6 +26,7 @@
     "index.js",
     "dev-servers.js",
     "project-files.js",
+    "windows.js",
     "template"
   ],
   "engines": {
@@ -34,5 +35,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {}
+  "scripts": {
+    "test": "node --test windows.test.mjs"
+  }
 }

package/windows.js

@@ -0,0 +1,90 @@
+// Windows long paths, offered once when a project is scaffolded.
+//
+// A project's node_modules holds files deeper than Windows' old 260-character limit. Node, npm
+// and pnpm go past it on their own; many other programs (PowerShell, Python, installers) stop
+// there until the machine-wide `LongPathsEnabled` setting is on. Turning it on needs an
+// administrator, so the scaffold asks first and then has Windows run the one registry write
+// elevated: the person answers one question and Windows' own "allow this app" prompt.
+// `substrat doctor --fix` (@substrat-run/cli, doctor.ts) does the same later; the two keep the
+// same command and the same reading of `reg query`.
+
+import { execFileSync } from 'node:child_process';
+import { createInterface } from 'node:readline';
+
+const FILESYSTEM_KEY = 'HKLM\\SYSTEM\\CurrentControlSet\\Control\\FileSystem';
+
+/** Every argument is a constant: nothing a person or a project supplies reaches the shell. */
+export const ELEVATE_LONG_PATHS_SCRIPT =
+  'Start-Process -FilePath reg.exe -Verb RunAs -Wait -WindowStyle Hidden -ArgumentList ' +
+  `'add','${FILESYSTEM_KEY}','/v','LongPathsEnabled','/t','REG_DWORD','/d','1','/f'`;
+
+const LATER = 'npx @substrat-run/cli doctor --fix';
+
+/** `reg query`'s answer: on, or off (an absent value is Windows' default, which is off). */
+export function parseLongPaths(stdout) {
+  const m = stdout?.match(/LongPathsEnabled\s+REG_DWORD\s+0x([0-9a-f]+)/i);
+  return m ? parseInt(m[1], 16) !== 0 : false;
+}
+
+/** One question on the terminal; `undefined` when input ends (or Ctrl+C) before an answer. */
+function ask(question) {
+  const rl = createInterface({ input: process.stdin, output: process.stdout });
+  return new Promise((resolve) => {
+    rl.question(question, (answer) => {
+      resolve(answer.trim());
+      rl.close();
+    });
+    rl.on('close', () => resolve(undefined));
+  });
+}
+
+export const realSystem = () => ({
+  platform: process.platform,
+  interactive: Boolean(process.stdin.isTTY && process.stdout.isTTY),
+  query: () => {
+    try {
+      return execFileSync('reg.exe', ['query', FILESYSTEM_KEY, '/v', 'LongPathsEnabled'], {
+        encoding: 'utf8',
+        stdio: ['ignore', 'pipe', 'ignore'],
+        windowsHide: true,
+      });
+    } catch {
+      return undefined;
+    }
+  },
+  elevate: () => {
+    execFileSync('powershell.exe', ['-NoProfile', '-NonInteractive', '-Command', ELEVATE_LONG_PATHS_SCRIPT], {
+      stdio: ['ignore', 'ignore', 'pipe'],
+      windowsHide: true,
+    });
+  },
+  ask,
+});
+
+/**
+ * The lines to print after scaffolding, having offered to turn long paths on where that applies.
+ * Nothing on macOS and Linux, or when they are already on. Without a terminal to ask on (a coding
+ * agent) it changes nothing and says how to turn them on later. Never throws: a scaffold that
+ * has been written is not undone by a setting.
+ */
+export async function offerLongPaths(sys = realSystem()) {
+  if (sys.platform !== 'win32') return [];
+  if (parseLongPaths(sys.query())) return [];
+  const why = [
+    '  Windows long paths are off. A project\'s node_modules holds files deeper than',
+    '  260 characters, and many programs stop at that limit until it is turned on.',
+  ];
+  if (!sys.interactive) return [...why, `  Turn it on once (Windows asks you to allow it): ${LATER}`, ''];
+  const answer = await sys.ask([...why, '  Turn it on now? Windows will ask you to allow it. [Y/n] '].join('\n'));
+  if (answer === undefined || !(answer === '' || /^y/i.test(answer))) {
+    return ['', `  Left off. Turn it on later with: ${LATER}`, ''];
+  }
+  try {
+    sys.elevate();
+  } catch {
+    /* declined or failed: the re-read below says which */
+  }
+  return parseLongPaths(sys.query())
+    ? ['', '  ✓ Windows long paths turned on. Restart your terminal and editor so they see it.', '']
+    : ['', `  Long paths are still off (the permission prompt was declined). Later: ${LATER}`, ''];
+}