create-grist-widget 0.3.23 → 0.3.25

package/README.md

@@ -31,8 +31,10 @@ prompt that asks for both.
 | `list [--json]` | Print the available starting examples |
 
 Common flags for `create`/`init`: `--yes` skips interactive prompts and uses
-flags/defaults only; `--no-install` skips the automatic dependency install;
-`--pm <name>` picks a specific package manager instead of auto-detecting one.
+flags/defaults only; `--no-install` skips the automatic dependency install
+(which uses pnpm, whichever package manager runs the CLI: the widget's
+workflows only read `pnpm-lock.yaml`); `--pm <name>` installs with another
+package manager instead.
 `init` additionally takes `--name <name>` (default: the current directory's
 name) and `--force` (overwrite files that already exist and differ from the
 template — see below).

package/bin/create-grist-widget.mjs

@@ -26,12 +26,13 @@ import {
 } from "node:fs"
 import path from "node:path"
 import { fileURLToPath } from "node:url"
-import { execFileSync } from "node:child_process"
+import { execFileSync, execSync } from "node:child_process"
 import * as clack from "@clack/prompts"
 
 import { createComposer } from "../vendor/compose-example.mjs"
 import { checkGitGate } from "../src/git-gate.mjs"
 import { addedAgeExceptions } from "../src/age-exceptions.mjs"
+import { installPlan } from "../src/package-manager.mjs"
 
 const PKG_ROOT = path.join(path.dirname(fileURLToPath(import.meta.url)), "..")
 const TEMPLATE_DIR = path.join(PKG_ROOT, "template")
@@ -62,14 +63,6 @@ function titleCase(name) {
     .join(" ")
 }
 
-function detectPackageManager() {
-  // e.g. "pnpm/9.1.0 npm-node/..." -> "pnpm". Set by every package manager's
-  // own `npm create`-equivalent invocation. Falls back to npm, matching
-  // what a bare `node bin/create-grist-widget.mjs` (no wrapping pm) should do.
-  const ua = process.env.npm_config_user_agent || ""
-  return ua.split("/")[0] || "npm"
-}
-
 function parseArgs(argv) {
   const out = { _: [] }
   for (let i = 0; i < argv.length; i++) {
@@ -102,8 +95,8 @@ Options (create / init):
                     (see "list" for ids)
   --yes            Skip interactive prompts, use defaults/flags only
   --no-install     Don't run the package manager install automatically
-  --pm <name>      Package manager for install (default: detected from how
-                    you invoked this — npm/pnpm/yarn/bun)
+  --pm <name>      Install with this package manager instead of pnpm (the
+                    widget's workflows use pnpm and only read its lockfile)
   --name <name>    (init only) Widget name — default: the current directory's name
   --force          (init only) Overwrite files that already exist and differ
                     from the template
@@ -169,33 +162,59 @@ function gitInitCommit(target) {
   }
 }
 
-function maybeInstall(target, { noInstall, pm }) {
-  if (noInstall) return false
-  const manager = pm || detectPackageManager()
+// Package managers are .cmd shims on Windows, which only a shell starts.
+function runCommand(cmd, args, options) {
+  if (process.platform === "win32") return execSync([cmd, ...args].join(" "), options)
+  return execFileSync(cmd, args, options)
+}
+
+function hasCommand(cmd) {
   try {
-    execFileSync(manager, ["install"], { cwd: target, stdio: "inherit" })
+    runCommand(cmd, ["--version"], { stdio: "ignore" })
     return true
   } catch {
-    console.warn(`\nCould not run "${manager} install" automatically — run it yourself.`)
     return false
   }
 }
 
+/** Returns whether the install ran, and why not when it was skipped. */
+function maybeInstall(target, { noInstall, pm }) {
+  const plan = installPlan({ noInstall, pm, hasPnpm: () => hasCommand("pnpm") })
+  if (plan.skip) return { installed: false, skipped: plan.skip }
+  try {
+    runCommand(plan.manager, ["install"], { cwd: target, stdio: "inherit" })
+    return { installed: true }
+  } catch {
+    console.warn(`\nCould not run "${plan.manager} install" automatically — run it yourself.`)
+    return { installed: false }
+  }
+}
+
 /**
- * Install (unless --no-install), returning which `minimumReleaseAgeExclude`
- * entries pnpm added to pnpm-workspace.yaml along the way. Runs before the
- * first commit, so the lockfile -- and those entries, without which every
- * later install rejects that lockfile -- are part of it.
+ * Install (unless --no-install, or pnpm is missing), returning which
+ * `minimumReleaseAgeExclude` entries pnpm added to pnpm-workspace.yaml along
+ * the way. Runs before the first commit, so the lockfile -- and those
+ * entries, without which every later install rejects that lockfile -- are
+ * part of it.
  */
 function installBeforeFirstCommit(target, args) {
   const workspaceFile = path.join(target, "pnpm-workspace.yaml")
   const read = () => (existsSync(workspaceFile) ? readFileSync(workspaceFile, "utf8") : "")
   const before = read()
-  const installed = maybeInstall(target, {
+  const { installed, skipped } = maybeInstall(target, {
     noInstall: Boolean(args["no-install"]),
     pm: typeof args.pm === "string" ? args.pm : null,
   })
-  return { installed, ageExceptions: installed ? addedAgeExceptions(before, read()) : [] }
+  return { installed, skipped, ageExceptions: installed ? addedAgeExceptions(before, read()) : [] }
+}
+
+function printNoPnpmNote(skipped) {
+  if (skipped !== "no-pnpm") return
+  console.log(
+    "\nNote: dependencies were not installed. This widget uses pnpm (its workflows install with it," +
+      "\nand only read pnpm-lock.yaml), and pnpm isn't installed. Install it (https://pnpm.io/installation)," +
+      "\nthen run `pnpm install` and commit pnpm-lock.yaml."
+  )
 }
 
 function printAgeExceptionsNote(ageExceptions) {
@@ -312,13 +331,14 @@ async function cmdCreate(argv) {
 
   // Install first, so the first commit includes the lockfile (pinned, with
   // integrity hashes; pnpm then freezes installs in CI by itself).
-  const { installed, ageExceptions } = installBeforeFirstCommit(target, args)
+  const { installed, skipped, ageExceptions } = installBeforeFirstCommit(target, args)
   const committed = gitInitCommit(target)
 
   printAgeExceptionsNote(ageExceptions)
+  printNoPnpmNote(skipped)
   console.log(`\nCreated ${rawName}/${exampleId ? ` (starting from "${exampleId}")` : ""}\n`)
   console.log(`  cd ${rawName}`)
-  if (!installed) console.log("  pnpm install   # or npm/yarn")
+  if (!installed) console.log("  pnpm install")
   console.log("  pnpm dev")
   if (committed) {
     console.log("\nGit is initialized on main (first commit done) with a dev branch ready.")
@@ -413,12 +433,13 @@ async function cmdInit(argv) {
   // or a real git clone where .git already carries whatever history it has).
   const gitAlreadyExists = existsSync(path.join(cwd, ".git"))
   // Install first, so a first commit includes the lockfile (see cmdCreate).
-  const { installed, ageExceptions } = installBeforeFirstCommit(cwd, args)
+  const { installed, skipped, ageExceptions } = installBeforeFirstCommit(cwd, args)
   const committed = gitAlreadyExists ? false : gitInitCommit(cwd)
 
   printAgeExceptionsNote(ageExceptions)
+  printNoPnpmNote(skipped)
   console.log(`\nInitialized ${rawName}/${exampleId ? ` (starting from "${exampleId}")` : ""} in the current directory.\n`)
-  if (!installed) console.log("  pnpm install   # or npm/yarn")
+  if (!installed) console.log("  pnpm install")
   console.log("  pnpm dev")
   if (gitAlreadyExists) {
     console.log("\nExisting git repository detected — no commit was made automatically.")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-grist-widget",
-  "version": "0.3.23",
+  "version": "0.3.25",
   "description": "Scaffold a new Grist custom widget from the grist-widget-sdk Vite template",
   "license": "MIT",
   "type": "module",

package/src/package-manager.mjs

@@ -0,0 +1,19 @@
+// Which package manager installs a new widget's dependencies.
+//
+// The scaffold is a pnpm project: its workflows install with pnpm, and
+// pnpm-workspace.yaml holds settings only pnpm reads (build-script
+// approvals, release-age exceptions). So the CLI installs with pnpm
+// whichever package manager runs it -- `npm create grist-widget` runs it
+// under npm. Installing with npm would commit a package-lock.json that the
+// workflows never read, and skip pnpm's 24 h release-age check.
+
+/**
+ * @param {{ noInstall?: boolean, pm?: string | null, hasPnpm: () => boolean }} options
+ *   `pm` is an explicit `--pm`; `hasPnpm` is only called when pnpm is the pick.
+ * @returns {{ manager: string } | { skip: "no-install" | "no-pnpm" }}
+ */
+export function installPlan({ noInstall, pm, hasPnpm }) {
+  if (noInstall) return { skip: "no-install" }
+  if (pm) return { manager: pm }
+  return hasPnpm() ? { manager: "pnpm" } : { skip: "no-pnpm" }
+}

package/template/README.md

@@ -38,9 +38,11 @@ This is the **source** template. It is consumed two ways:
 standalone `pnpm install` (pnpm 11) exits cleanly; inside the monorepo it's
 ignored (the root workspace governs).
 
-A scaffold's first commit includes `pnpm-lock.yaml` (unless it was made with
-`--no-install`): versions are pinned with their integrity hashes, CI installs
-exactly that, and Dependabot updates it. pnpm 11 won't install a version
+A scaffold's first commit includes `pnpm-lock.yaml`: the CLI installs with
+pnpm, even under `npm create`, unless it was run with `--no-install` or
+without pnpm installed. Versions are pinned with their integrity hashes, CI
+installs exactly that, and Dependabot updates it. A `package-lock.json` isn't
+used: the workflows install with pnpm. pnpm 11 won't install a version
 published less than 24 hours ago. So a widget scaffolded on the day of an SDK
 release also gets one `minimumReleaseAgeExclude` entry in
 `pnpm-workspace.yaml`, for that SDK version only, written by pnpm itself.

package/template/package.json

@@ -17,7 +17,7 @@
     "@tailwindcss/vite": "^4.3.3",
     "class-variance-authority": "^0.7.1",
     "clsx": "^2.1.1",
-    "grist-widget-sdk": "^0.3.20",
+    "grist-widget-sdk": "^0.3.25",
     "lucide-react": "^1.61.0",
     "radix-ui": "^1.8.1",
     "react": "^19.3.1",

package/template/tsconfig.app.json

@@ -1,28 +1,13 @@
 {
+  // Compiler settings come from grist-widget-sdk and update with it. This
+  // file keeps what is specific to this widget: its files, paths and types.
+  "extends": "grist-widget-sdk/tsconfig/app.json",
   "compilerOptions": {
+    // Also set in the base. Repeated so that a missing base (a grist-widget-sdk
+    // too old to ship it) fails the typecheck without writing .js files into src/.
+    "noEmit": true,
     "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
-    "target": "ES2022",
-    "useDefineForClassFields": true,
-    "lib": ["ES2022", "DOM", "DOM.Iterable"],
-    "module": "ESNext",
     "types": ["vite/client"],
-    "skipLibCheck": true,
-
-    /* Bundler mode */
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "moduleDetection": "force",
-    "noEmit": true,
-    "jsx": "react-jsx",
-
-    /* Linting */
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "erasableSyntaxOnly": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedSideEffectImports": true,
     "paths": {
       "@/*": ["./src/*"]
     }

package/template/tsconfig.node.json

@@ -1,26 +1,13 @@
 {
+  // Compiler settings come from grist-widget-sdk and update with it. This
+  // file keeps what is specific to this widget: its files and types.
+  "extends": "grist-widget-sdk/tsconfig/node.json",
   "compilerOptions": {
-    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
-    "target": "ES2023",
-    "lib": ["ES2023"],
-    "module": "ESNext",
-    "types": ["node"],
-    "skipLibCheck": true,
-
-    /* Bundler mode */
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "moduleDetection": "force",
+    // Also set in the base. Repeated so that a missing base (a grist-widget-sdk
+    // too old to ship it) fails the typecheck without writing a .js file.
     "noEmit": true,
-
-    /* Linting */
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "erasableSyntaxOnly": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedSideEffectImports": true
+    "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
+    "types": ["node"]
   },
   "include": ["vite.config.ts"]
 }