neon 4.14.6 → 4.15.0

package/README.md

@@ -440,8 +440,8 @@ The branch argument is **optional**: run `neon checkout` with no branch in an in
 
 Branch **id vs name** is detected automatically (a `br-…` value is treated as an id):
 
-- **id** — matched strictly by id. A non-existent id is a hard "not found" error (ids are server-assigned, so checkout never creates one).
-- **name** — matched by name. If the name doesn't exist, in an interactive terminal `checkout` offers to **create** it (equivalent to `neon branch create --name <name>`: branched from the project's default branch with a read-write compute), then checks it out. In a non-interactive context a missing name is the usual "not found" error.
+- **id** — matched strictly by id. A non-existent id is a hard "not found" error (ids are server-assigned, so checkout never creates one, including with `--create`).
+- **name** — matched by name. If the name doesn't exist, pass `--create` to create it (equivalent to `neon branch create --name <name>`: branched from the project's default branch with a read-write compute, or from `neon.ts` when that file is present), then check it out. `--create` is a no-op when the name already exists. Without `--create`, an interactive terminal offers to create the branch; in CI or with no TTY the error names `--create`.
 
 The project is resolved through the standard neon chain, each entry winning over the next:
 
@@ -457,11 +457,15 @@ The resolved branch is then written (by name) to the same `.neon` file `link` us
 $ neon checkout main --project-id polished-snowflake-12345678
 INFO: Checked out branch br-main-branch-87654321 on project polished-snowflake-12345678. Updated /path/to/cwd/.neon.
 
+$ neon checkout dev --create --project-id polished-snowflake-12345678
+INFO: Created branch dev (br-dev-branch-12345678).
+INFO: Checked out branch br-dev-branch-12345678 on project polished-snowflake-12345678. Updated /path/to/cwd/.neon.
+
 $ cat .neon
 {
   "orgId": "org-abc123",
   "projectId": "polished-snowflake-12345678",
-  "branch": "main"
+  "branch": "dev"
 }
 ```
 

package/dist/commands/checkout.js

@@ -28,7 +28,7 @@ const formatCheckoutPolicyFailure = (opts) => {
 	return [
 		`Branch ${opts.branchName} (${opts.branchId}) was created and checked out, but applying neon.ts to it failed: ${opts.failure}`,
 		`The branch is usable but does not match the policy, and \`${cli} checkout\` never reconciles a branch that already exists.`,
-		`Fix the cause above, then run \`${cli} deploy --update-existing${envArg}\` to apply the policy to it — or, if your policy only configures new branches (keyed on \`!branch.exists\`), delete the branch and check it out again: \`${cli} branches delete ${opts.branchName}\` then \`${cli} checkout ${opts.branchName}${envArg}\`.`
+		`Fix the cause above, then run \`${cli} deploy --update-existing${envArg}\` to apply the policy to it — or, if your policy only configures new branches (keyed on \`!branch.exists\`), delete the branch and check it out again: \`${cli} branches delete ${opts.branchName}\` then \`${cli} checkout ${opts.branchName} --create${envArg}\`.`
 	].join("\n");
 };
 const builder = (argv) => argv.usage("$0 checkout [id|name] [options]").positional("id", {
@@ -44,6 +44,11 @@ const builder = (argv) => argv.usage("$0 checkout [id|name] [options]").position
 		type: "boolean",
 		default: true
 	},
+	create: {
+		describe: "Create the named branch if it does not exist, then check it out",
+		type: "boolean",
+		default: false
+	},
 	...envFlag,
 	env: {
 		...envFlag.env,
@@ -52,12 +57,14 @@ const builder = (argv) => argv.usage("$0 checkout [id|name] [options]").position
 }).example([
 	["$0 checkout", "Pick a branch interactively from the project in the closest .neon file"],
 	["$0 checkout main", "Pin the branch named \"main\" in the closest .neon file"],
-	["$0 checkout feat --env .env.local", "Create feat from neon.ts, loading Function env from .env.local first"],
+	["$0 checkout dev --create", "Create and pin a missing branch named dev"],
+	["$0 checkout feat --create --env .env.local", "Create feat from neon.ts, loading Function env from .env.local first"],
 	["$0 checkout br-cool-snow-12345678 --project-id project-id-123", "Pin a branch by id for an explicit project"]
 ]);
 const handler = async (props) => {
 	const previousBranch = contextBranch(readContextFile(props.contextFile));
 	if (previousBranch) log.info("%s Currently on branch %s", chalk.dim("→"), chalk.cyan.bold(previousBranch));
+	if (props.create && !props.id?.trim()) throw new Error(`No branch specified. Pass a branch name with --create (e.g. \`${getCliName()} checkout dev --create\`).`);
 	const projectId = await resolveProjectId(props);
 	const { branchId, branchName, created, policyApplied, policyFailure } = await resolveBranchId(props, projectId);
 	const orgId = await resolveOrgId(props, projectId);
@@ -137,8 +144,10 @@ const resolveBranchId = async (props, projectId) => {
 		created: false,
 		policyApplied: false
 	};
-	if (isCi() || !process.stdout.isTTY) throw new Error(notFoundMessage(ref, branches));
-	log.error(notFoundMessage(ref, branches));
+	if (props.create) return createCheckoutBranch(props, projectId, ref, branches);
+	const missingName = notFoundMessage(ref, branches, { suggestCreate: true });
+	if (isCi() || !process.stdout.isTTY) throw new Error(missingName);
+	log.error(missingName);
 	const { create } = await prompts({
 		type: "confirm",
 		name: "create",
@@ -178,7 +187,7 @@ const createCheckoutBranch = async (props, projectId, name, branches) => {
 		policyApplied: false
 	};
 };
-const notFoundMessage = (ref, branches) => `Branch ${ref} not found.\nAvailable branches: ${branches.map((b) => b.name).join(", ")}`;
+const notFoundMessage = (ref, branches, opts) => `Branch ${ref} not found.${opts?.suggestCreate ? " Pass --create to create it." : ""}\nAvailable branches: ${branches.map((b) => b.name).join(", ")}`;
 /**
 * Resolve the org id to heal into the context file.
 *

package/dist/commands/config.js

@@ -2,7 +2,7 @@ import { t as __exportAll } from "../_chunks/rolldown-runtime-8H4AJuhK.js";
 import { isCi } from "../env.js";
 import { log } from "../log.js";
 import { getApiClient } from "../api.js";
-import { contextBranch, readContextFile } from "../context.js";
+import { contextBranch, ensureDirectoryGitignored, readContextFile } from "../context.js";
 import { getCliName } from "../utils/cli_name.js";
 import { toNeonConfigView } from "../config_format.js";
 import { declaredNeonServices } from "../config_services.js";
@@ -229,6 +229,7 @@ const initCmd = async (props) => {
 		const args = installArgs(pm, missing);
 		if (props.install === false) log.info("Install the Neon config packages to use neon.ts: %s", formatInstallCommand(pm, missing));
 		else {
+			ensureDirectoryGitignored(join(cwd, "node_modules"));
 			log.info("Installing %s with %s…", missing.join(", "), pm);
 			if (!await run(pm, args, cwd)) log.warning("Could not install the config packages automatically. Run by hand: %s", formatInstallCommand(pm, missing));
 		}

package/dist/context.js

@@ -199,21 +199,33 @@ const setContext = (file, context) => {
 * must not be blocked by a `.gitignore` write error.
 */
 const ensureGitignored = (file) => {
+	ensureGitignoreEntry(file, basenameOf(file));
+};
+/**
+* Make sure a directory is ignored by the `.gitignore` in its parent. The written entry keeps
+* the conventional trailing slash, while coverage checks also recognize an existing entry
+* without one.
+*/
+const ensureDirectoryGitignored = (directory) => {
+	const normalized = directory.replace(/[\\/]+$/, "");
+	ensureGitignoreEntry(directory, `${basenameOf(normalized)}/`);
+};
+const ensureGitignoreEntry = (path, entry) => {
 	try {
-		const dir = dirname(file);
-		const entry = basenameOf(file);
+		const dir = dirname(path);
 		const gitignorePath = resolve(dir, GITIGNORE_FILE);
+		const coveredEntry = entry.replace(/\/$/, "");
 		if (!existsSync(gitignorePath)) {
 			writeFileSync(gitignorePath, `${entry}\n`);
 			return;
 		}
 		const current = readFileSync(gitignorePath, "utf-8");
-		if (hasGitignoreEntry(current, entry)) return;
+		if (hasGitignoreEntry(current, coveredEntry)) return;
 		const addition = `${current.length > 0 && !current.endsWith("\n") ? "\n" : ""}${entry}\n`;
 		writeFileSync(gitignorePath, current + addition);
 	} catch (err) {
 		const message = err instanceof Error ? err.message : String(err);
-		log.debug("Failed to update .gitignore next to %s: %s", file, message);
+		log.debug("Failed to update .gitignore next to %s: %s", path, message);
 	}
 };
 const basenameOf = (file) => {
@@ -248,4 +260,4 @@ const globToRegExp = (pattern) => {
 	return new RegExp(`^${source}$`);
 };
 //#endregion
-export { applyContext, contextBranch, currentContextFile, enrichFromContext, ensureGitignored, isApiKeysCommand, isAskCommand, isClaimCommand, isConfigInit, isCurrentBranchProbe, isInspectDbUrl, isMcpCommand, isMcpOauth, isPluginsCommand, isProfileCommand, isSkillsCommand, readContextFile, setContext, updateContextFile, walkContextFile };
+export { applyContext, contextBranch, currentContextFile, enrichFromContext, ensureDirectoryGitignored, ensureGitignored, isApiKeysCommand, isAskCommand, isClaimCommand, isConfigInit, isCurrentBranchProbe, isInspectDbUrl, isMcpCommand, isMcpOauth, isPluginsCommand, isProfileCommand, isSkillsCommand, readContextFile, setContext, updateContextFile, walkContextFile };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neon",
-  "version": "4.14.6",
+  "version": "4.15.0",
   "description": "CLI tool for Neon, the cloud backend primitives built around Lakebase Postgres",
   "keywords": [
     "neon",
@@ -63,9 +63,9 @@
     "yaml": "^2.9.0",
     "yargs": "17.7.2",
     "yoctocolors": "^2.1.2",
-    "@neon/config-runtime": "1.2.3",
-    "@neon/config": "1.3.2",
-    "@neon/sdk": "4.0.0"
+    "@neon/config": "1.3.3",
+    "@neon/config-runtime": "1.2.4",
+    "@neon/sdk": "4.1.0"
   },
   "optionalDependencies": {
     "@napi-rs/keyring": "1.3.0",
@@ -98,8 +98,8 @@
     "typescript": "^5.9.0",
     "vitest": "^3.0.9",
     "@neon-internals/cli-core": "0.0.0",
+    "@neon-internals/env-core": "0.0.11",
     "@neon/e2e-harness": "0.0.0",
-    "@neon-internals/env-core": "0.0.10",
     "@neon/functions": "0.9.0"
   },
   "publishConfig": {