create-ncblock 0.0.39 → 0.0.41

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-ncblock",
-	"version": "0.0.39",
+	"version": "0.0.41",
 	"description": "Create a Notion custom view block project.",
 	"type": "module",
 	"bin": {

package/scripts/init.ts

@@ -18,6 +18,7 @@ import { resolveInitArgs } from "./utils/resolveInitArgs"
 import {
 	getTemplateByName,
 	getTemplates,
+	isWorkerTemplate,
 	scaffoldTemplate,
 	type TemplateMetadata,
 } from "./utils/templates"
@@ -542,6 +543,7 @@ async function main() {
 	)
 	const dest = resolve(dir)
 	const templateDir = resolve(templateBaseDir, selectedTemplate.name)
+	const workerShaped = isWorkerTemplate(templateDir)
 
 	const destNonEmpty = existsSync(dest) && readdirSync(dest).length > 0
 	if (destNonEmpty) {
@@ -578,7 +580,10 @@ async function main() {
 	// downstream walks a positional block/view ID up to its parent database.
 	const blockIdArg = args.block as string | undefined
 	const promptedCollection =
-		args.collection === undefined && blockIdArg === undefined && installDeps
+		!workerShaped &&
+		args.collection === undefined &&
+		blockIdArg === undefined &&
+		installDeps
 			? (await ask("Database URL/ID (enter to skip):", "skip")).trim()
 			: undefined
 	const collectionOverride =
@@ -640,12 +645,14 @@ async function main() {
 		step("Initialized git repo")
 	}
 
-	writeInitialTarget(dest, { env: resolved.env, blockId })
-	step(`Seeded .notion/target.json`)
-	if (classified?.kind === "view") {
-		console.log(
-			`    ${c.dim}(view ID resolved — using as block id, database ${databaseId ?? "(none)"})${c.reset}`,
-		)
+	if (!workerShaped) {
+		writeInitialTarget(dest, { env: resolved.env, blockId })
+		step(`Seeded .notion/target.json`)
+		if (classified?.kind === "view") {
+			console.log(
+				`    ${c.dim}(view ID resolved — using as block id, database ${databaseId ?? "(none)"})${c.reset}`,
+			)
+		}
 	}
 
 	let connected = false
@@ -660,7 +667,7 @@ async function main() {
 		execSync(`${pm} ${installArgs}`, { cwd: dest, stdio: "inherit" })
 		step("Installed dependencies")
 
-		if (databaseId) {
+		if (databaseId && !workerShaped) {
 			console.log("")
 			try {
 				runNcblock(dest, ["connect", databaseId, "--quiet"])
@@ -676,8 +683,6 @@ async function main() {
 		}
 	}
 
-	const deployCommand = blockId ? `npx ncblock deploy dist/` : undefined
-
 	console.log(`\n${c.bold}  Ready!${c.reset} Next steps:\n`)
 	if (dest !== resolve(".")) {
 		console.log(`  cd ${formatShellPath(dest)}`)
@@ -685,22 +690,33 @@ async function main() {
 	if (!installDeps) {
 		console.log(`  ${pm} install`)
 	}
-	console.log(`  ${pm} run build`)
-	if (deployCommand) {
-		console.log(`  ${deployCommand}`)
+
+	if (workerShaped) {
+		// Workers build and bind their views/data sources as part of deploy; data
+		// sources are wired in code (see AGENTS.md). Carry a non-prod env through.
+		const envFlag =
+			resolved.env === "production" ? "" : ` --env=${resolved.env}`
+		console.log(`  ntn${envFlag} workers deploy`)
+		console.log("")
 	} else {
-		console.log(
-			`\n  Then, go back to the instructions in Notion and paste the ${c.bold}ntn deploy${c.reset} command.`,
-		)
-	}
+		const deployCommand = blockId ? `npx ncblock deploy dist/` : undefined
+		console.log(`  ${pm} run build`)
+		if (deployCommand) {
+			console.log(`  ${deployCommand}`)
+		} else {
+			console.log(
+				`\n  Then, go back to the instructions in Notion and paste the ${c.bold}ntn deploy${c.reset} command.`,
+			)
+		}
 
-	if (installDeps && !connected) {
-		console.log(
-			`\n  ${c.yellow}No data source connected yet.${c.reset} To wire one up:`,
-		)
-		console.log(`    npx ncblock connect <database-url-or-id>`)
+		if (installDeps && !connected) {
+			console.log(
+				`\n  ${c.yellow}No data source connected yet.${c.reset} To wire one up:`,
+			)
+			console.log(`    npx ncblock connect <database-url-or-id>`)
+		}
+		console.log("")
 	}
-	console.log("")
 
 	closePromptInterface()
 }

package/scripts/utils/templates.ts

@@ -117,6 +117,17 @@ export function getTemplateByName(
 	)
 }
 
+// A template is worker-backed if @notionhq/workers is in its dependencies.
+export function isWorkerTemplate(templateDir: string): boolean {
+	const pkgPath = resolve(templateDir, "package.json")
+	if (!existsSync(pkgPath)) {
+		return false
+	}
+	return Boolean(
+		readTemplatePackageJson(pkgPath).dependencies?.["@notionhq/workers"],
+	)
+}
+
 type ScaffoldTemplateOptions = {
 	root: string
 	templateDir: string
@@ -157,6 +168,12 @@ function copyDirectoryContents(
 	targetDir: string,
 	options: {
 		overwrite: boolean
+		/**
+		 * Entry names to skip at the top level only. Root README.md and
+		 * package.json are rewritten by scaffoldTemplate rather than copied;
+		 * nested ones (e.g. a view subproject's package.json) must copy
+		 * through untouched.
+		 */
 		exclude?: Set<string>
 	},
 ) {
@@ -174,7 +191,17 @@ function copyDirectoryContents(
 		const targetPath = resolve(targetDir, targetName)
 
 		if (entry.isDirectory()) {
-			copyDirectoryContents(sourcePath, targetPath, options)
+			// Skip local-only artifacts (node_modules, dist, .notion) at every
+			// level, not just the template root. These are gitignored or
+			// machine-local — e.g. a view subproject's `.notion/` deploy binding —
+			// so they only exist in dirty checkouts and must never leak into a
+			// scaffold; the top-level `exclude` set doesn't reach nested dirs.
+			if (TEMPLATE_LOCAL_ARTIFACTS.has(entry.name)) {
+				continue
+			}
+			copyDirectoryContents(sourcePath, targetPath, {
+				overwrite: options.overwrite,
+			})
 			continue
 		}
 
@@ -229,9 +256,12 @@ export function scaffoldTemplate({
 		overwrite,
 		// README.md and package.json are rendered below with the app name and
 		// SDK dependency rewritten for the standalone scaffolded project.
+		// workers.json is a developer's local deploy binding (workspace + worker
+		// id); copying it would make every scaffold deploy over the same worker.
 		exclude: new Set([
 			"README.md",
 			"package.json",
+			"workers.json",
 			...TEMPLATE_LOCAL_ARTIFACTS,
 		]),
 	})
@@ -244,14 +274,25 @@ export function scaffoldTemplate({
 		})
 	}
 
-	// Scaffolded projects are standalone, not workspace members. If the user
-	// scaffolds inside an existing pnpm workspace (e.g. this repo), pnpm walks
-	// up, finds the workspace root, and the install ends up partial. A local
-	// .npmrc with `ignore-workspace=true` makes pnpm treat the project as
-	// standalone regardless of where it lives.
+	// pnpm settings a standalone scaffold needs, with the reason for each inline.
+	const npmrcSettings: [key: string, value: string][] = [
+		// Treat the project as standalone, not a workspace member. If the user
+		// scaffolds inside an existing pnpm workspace (e.g. this repo), pnpm would
+		// otherwise walk up, find the workspace root, and do a partial install.
+		["ignore-workspace", "true"],
+		// Lay node_modules out as a flat tree of real directories instead of
+		// symlinks into .pnpm. Worker deploys (`ntn workers deploy --local-build`)
+		// ship node_modules verbatim, and the symlink layout leaves transitive
+		// deps unresolvable in the deploy sandbox (the SDK's `@notionhq/client`
+		// import crashes with ERR_MODULE_NOT_FOUND).
+		["node-linker", "hoisted"],
+	]
 	const npmrcPath = resolve(dest, ".npmrc")
 	if (overwrite || !existsSync(npmrcPath)) {
-		writeFileSync(npmrcPath, "ignore-workspace=true\n")
+		const npmrc = npmrcSettings
+			.map(([key, value]) => `${key}=${value}`)
+			.join("\n")
+		writeFileSync(npmrcPath, `${npmrc}\n`)
 	}
 
 	const readmeTarget = resolve(dest, "README.md")
@@ -263,9 +304,13 @@ export function scaffoldTemplate({
 		})
 	}
 
+	// Worker templates ship their own AGENTS.md (a symlink copyDirectoryContents
+	// skips), so materialize it instead of the generic custom-block guide.
 	const agentsTarget = resolve(dest, "AGENTS.md")
 	if (overwrite || !existsSync(agentsTarget)) {
-		const agentsSource = resolve(root, "scripts/scaffold-assets/AGENTS.md")
+		const agentsSource = isWorkerTemplate(templateDir)
+			? resolve(templateDir, "AGENTS.md")
+			: resolve(root, "scripts/scaffold-assets/AGENTS.md")
 		writeRenderedFile({
 			sourcePath: agentsSource,
 			targetPath: agentsTarget,

package/sdk-version.json

@@ -1 +1 @@
-{"version":"0.0.39"}
+{"version":"0.0.41"}