create-keboola-app 0.0.0 → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,43 @@
+# create-keboola-app
+
+## 0.1.1
+
+### Patch Changes
+
+- A generated app pins `nwsapi`, so a userEvent test does not hang.
+
+  nwsapi 2.2.26 — jsdom's selector engine — answers `:modal`, `:fullscreen` and `:open` through a helper that falls back to the element's own `matches`. Under jsdom that is nwsapi itself, so the two recurse, and `:modal` doubles the work per level through its `|| isFullscreen` branch. `@floating-ui/dom` probes `:modal` on every popper placement, which is once per dropdown or tooltip interaction: measured at 9s where 2.2.25 takes 26ms, so a test driving a menu with `userEvent` hits its timeout instead of asserting.
+
+  Generated apps now ship a `pnpm-workspace.yaml` holding `nwsapi` at 2.2.25 — the only file pnpm reads `overrides` from. It carries the reason and the condition for removing it.
+
+- Name the generated app in its own chrome. The breadcrumb was hard-coded to the template's own
+  name, so every scaffold shipped labelled after the template rather than the name the user passed
+  — the first thing on screen, and the one place the app names itself back to the reader. The
+  extract step now parameterises it alongside the page title and the store's storage keys.
+
+  A `boilerplate-identity` sanitize pattern makes this class of leak a red build instead of a
+  silent default: any un-templated mention of the source app's name fails extraction, so a rewrite
+  that stops matching is caught rather than shipped.
+
+## 0.1.0
+
+### Minor Changes
+
+- Initial release. `npm create keboola-app` scaffolds a Keboola-shaped frontend app — Vite,
+  React 19, TanStack Router/Query/Form, Zustand, `@keboola/design` with
+  `@keboola/brand-registry`, oxlint/oxfmt and vitest — from a minimal shell plus the blocks you
+  pick: `kpi`, `chart`, `grid`, `crud`, `assistant`. Blocks are independent, so any combination
+  compiles.
+
+  Interactive by default, and fully flag-driven for agents and CI:
+  `--name`, `--blocks`, `--yes`, `--json`, `--workspace`. Nothing prompts without a terminal,
+  every failure exits non-zero with the reason on stderr, and nothing is fetched at scaffold
+  time. The generated app carries its own `README.md` and `AGENTS.md`, which point at
+  `node_modules/@keboola/*/AGENTS.md` so an agent reads the contract for the version actually
+  installed.
+
+### Patch Changes
+
+- In `--workspace` mode the generated app inherits the host repo's `engines`, and the monorepo entry point is `pnpm scaffold:app`.
+
+  The template carries a standalone `engines.node` floor for apps generated outside a monorepo. Inside one that floor is not a default but a disagreement: it was the lowest value across every workspace, so syncpack wanted to rewrite the other 21 manifests and `pnpm deps:check` went red on a freshly scaffolded app. Workspace mode now reads the root manifest's `engines` instead, and the gate asserts it.

package/dist/cli.js

@@ -196,6 +196,29 @@ const writeManifest = (opts) => {
 	};
 	writeFileSync(join(targetDir, "package.json"), `${JSON.stringify(pkg, null, 2)}\n`);
 };
+/**
+* `pnpm-workspace.yaml` for a standalone app.
+*
+* - It is the only file pnpm 11 reads `overrides` from; the `pnpm` field in `package.json` is
+*   ignored with a warning.
+* - Written only outside a monorepo. Under `--workspace` the app inherits the root's file, and a
+*   nested one would declare a second workspace root inside the first.
+*/
+const writeWorkspaceConfig = (targetDir) => {
+	writeFileSync(join(targetDir, "pnpm-workspace.yaml"), `# pnpm reads \`overrides\` from this file only — the \`pnpm\` field in package.json is ignored.
+overrides:
+  # jsdom's selector engine, held at the last release that does not re-enter itself.
+  #
+  # - 2.2.26 answers \`:modal\`, \`:fullscreen\` and \`:open\` through a \`matchesNative\` helper
+  #   that falls back to the element's own \`matches\` — under jsdom that is nwsapi again, so the
+  #   two recurse, and \`:modal\` doubles the work per level via its \`|| isFullscreen\` branch.
+  # - \`@floating-ui/dom\` probes \`:modal\` on every popper placement, so one dropdown or tooltip
+  #   interaction costs ~9s instead of ~30ms and a userEvent test hits its timeout.
+  # - Remove the pin once nwsapi stops resolving its own \`matches\` back into itself:
+  #   https://github.com/dperini/nwsapi
+  nwsapi: 2.2.25
+`);
+};
 const scaffold = (opts) => {
 	const { templateDir, targetDir, appName, blocks, workspace } = opts;
 	if (existsSync(targetDir)) throw new Error(`${targetDir} already exists. Choose another name or remove the directory first.`);
@@ -231,6 +254,10 @@ const scaffold = (opts) => {
 		packageName
 	});
 	written.push("package.json");
+	if (!workspace) {
+		writeWorkspaceConfig(targetDir);
+		written.push("pnpm-workspace.yaml");
+	}
 	return {
 		path: targetDir,
 		appName,

package/dist/extract.js

@@ -47,9 +47,19 @@ const decideRegion = (regionId) => {
 	if (id === null || !isBlockId(id)) throw new Error(`unknown region id "${regionId}" — expected "internal" or "block:<blockId>"`);
 	return "keep-with-markers";
 };
-/** Per-file rewrites that turn boilerplate identity into placeholders. */
+/**
+* Per-file rewrites that turn this app's identity into placeholders.
+*
+* - Every rewrite has a matching assertion in `extract.test.ts`, and the sanitize scan fails
+*   the build on any surviving mention of this app's name — a rewrite that stops matching is
+*   a red build, not a scaffold that quietly names itself after the template.
+* - Match structurally, not by the literal name. The name must not appear here: the packed
+*   tarball is scanned too, and a rewrite that spells its own needle makes the scanner match
+*   its own implementation.
+*/
 const parameterise = (file, text) => {
 	if (file === "index.html") return text.replace(/<title>[^<]*<\/title>/, "<title>__APP_TITLE__</title>");
+	if (file === "src/components/AppChrome.tsx") return text.replace(/(<Link to="\/">)[^<]*(<\/Link>)/, "$1__APP_TITLE__$2");
 	if (file === "src/store.ts") return text.replaceAll(/'boilerplate\/([^']+)'/g, "'__APP_NAME__/$1'");
 	return text;
 };

package/dist/template/oxlint.config.ts

@@ -19,10 +19,8 @@ export default defineConfig({
     },
   },
   jsPlugins: [
-    // Local design-system + brand-safety lint rules — see
-    // packages/eslint-plugin-design. Aliased to `design` so rule IDs read
-    // `design/<rule>` in lint output. Boilerplate is the canonical scaffold
-    // cloned by `pnpm scaffold:app`, so every generated app inherits these.
+    // Local design-system + brand-safety lint rules. Aliased to `design` so rule
+    // IDs read `design/<rule>` in lint output.
     { name: 'design', specifier: '@keboola/eslint-plugin-design' },
   ],
   rules: {

package/dist/template/package.json

@@ -15,8 +15,8 @@
     "type-check": "tsc"
   },
   "dependencies": {
-    "@keboola/brand-registry": "^1.9.2",
-    "@keboola/design": "^11.0.1",
+    "@keboola/brand-registry": "^1.9.4",
+    "@keboola/design": "^11.3.0",
     "@tanstack/react-form": "^1.29.1",
     "@tanstack/react-query": "^5.96.2",
     "@tanstack/react-router": "^1.120.4",
@@ -28,9 +28,9 @@
     "zustand": "^5.0.8"
   },
   "devDependencies": {
-    "@keboola/eslint-plugin-design": "^0.4.2",
-    "@keboola/oxlint-config": "^10.0.1",
-    "@keboola/tsconfig": "^0.2.0",
+    "@keboola/eslint-plugin-design": "^0.4.3",
+    "@keboola/oxlint-config": "^10.0.2",
+    "@keboola/tsconfig": "^0.2.1",
     "@tailwindcss/vite": "^4.3.3",
     "@tanstack/react-query-devtools": "^5.96.2",
     "@testing-library/jest-dom": "^6.8.0",

package/dist/template/src/components/AppChrome.tsx

@@ -89,7 +89,7 @@ export function AppChrome({ children }: { children: ReactNode }) {
               <Navbar.Menu marker="forward-slash">
                 <Navbar.MenuItem>
                   <Navbar.MenuButton asChild>
-                    <Link to="/">Boilerplate</Link>
+                    <Link to="/">__APP_TITLE__</Link>
                   </Navbar.MenuButton>
                 </Navbar.MenuItem>
               </Navbar.Menu>

package/package.json

@@ -1,10 +1,9 @@
 {
   "name": "create-keboola-app",
-  "version": "0.0.0",
+  "version": "0.1.1",
   "description": "Scaffold a Keboola-shaped frontend app — Vite + React 19 + TanStack Router/Query/Form + Zustand + @keboola/design — from a minimal shell plus the blocks you pick",
   "license": "MIT",
   "type": "module",
-  "bin": "./dist/cli.js",
   "files": [
     "dist",
     "README.md",
@@ -16,17 +15,6 @@
   "engines": {
     "node": ">=20"
   },
-  "scripts": {
-    "build": "tsdown && node dist/extract.js",
-    "lint": "pnpm lint:format && pnpm lint:oxlint",
-    "lint:fix": "oxlint --fix . && oxfmt",
-    "lint:format": "oxfmt --check",
-    "lint:oxlint": "oxlint . --quiet",
-    "knip:check": "pnpm --dir ../.. exec knip --workspace packages/create-keboola-app",
-    "knip:fix": "pnpm --dir ../.. exec knip --workspace packages/create-keboola-app --fix-type types,exports,files",
-    "test": "vitest run --passWithNoTests --reporter=dot",
-    "type-check": "tsc"
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/keboola/ui.git",
@@ -50,8 +38,6 @@
     "@tanstack/router-generator": "^1.120.4"
   },
   "devDependencies": {
-    "@keboola/oxlint-config": "workspace:^",
-    "@keboola/tsconfig": "workspace:^",
     "@types/node": "24.12.0",
     "@typescript/native": "npm:typescript@^7.0.2",
     "oxfmt": "^0.57.0",
@@ -59,6 +45,22 @@
     "tsdown": "^0.22.14",
     "typescript": "npm:@typescript/typescript6@^6.0.2",
     "vite": "^8.1.5",
-    "vitest": "^4.1.10"
+    "vitest": "^4.1.10",
+    "@keboola/oxlint-config": "^10.0.2",
+    "@keboola/tsconfig": "^0.2.1"
+  },
+  "scripts": {
+    "build": "tsdown && node dist/extract.js",
+    "lint": "pnpm lint:format && pnpm lint:oxlint",
+    "lint:fix": "oxlint --fix . && oxfmt",
+    "lint:format": "oxfmt --check",
+    "lint:oxlint": "oxlint . --quiet",
+    "knip:check": "pnpm --dir ../.. exec knip --workspace packages/create-keboola-app",
+    "knip:fix": "pnpm --dir ../.. exec knip --workspace packages/create-keboola-app --fix-type types,exports,files",
+    "test": "vitest run --passWithNoTests --reporter=dot",
+    "type-check": "tsc"
+  },
+  "bin": {
+    "create-keboola-app": "./dist/cli.js"
   }
-}
+}