neonctl 2.27.1 → 2.28.0

package/README.md

@@ -388,12 +388,15 @@ export default defineConfig({
 });
 ```
 
-Three sub-commands plus a top-level alias drive it:
+Three sub-commands plus two top-level aliases drive it:
 
 ```bash
 # Inspect the branch's live Neon state (read-only — never mutates)
 neon config status
 
+# `neon status` is an alias for `neon config status`
+neon status
+
 # Dry-run diff: show exactly what `apply` would change
 neon config plan
 
@@ -419,6 +422,35 @@ The branch is chosen with `--branch <id|name>`; without it the project's default
 
 **Output**: `status` prints the project, branch, and reverse-engineered config; `plan` / `apply` print the planned/applied changes and any conflicts as tables. Pass `--output json` (or `--output yaml`) to emit the full machine-readable result (`PushResult`) for piping into other tools or CI.
 
+**`config status --current-branch`** (alias `neon status --current-branch`) prints _only_ the branch pinned in the local `.neon` file — no network, no auth, no analytics — and exits non-zero when none is pinned. This behavior lets it safely drive a shell prompt. Example [starship](https://starship.rs) segment:
+
+```toml
+[custom.neon]
+description = "Current Neon database branch"
+format = "[$symbol$output]($style) "
+style = "bold green"
+# `symbol` below uses a Nerd Font glyph; swap it for a plain
+# label/emoji if you don't have a Nerd Font installed.
+symbol = " "
+command = "neon status --current-branch"
+# Starship evaluates this on EVERY prompt render. To keep prompts instant
+# everywhere outside a Neon project, do a zero-subprocess walk-up for an
+# ancestor `.neon` first (the same walk the CLI does, stopping at $HOME and /).
+# Only when one is found do we invoke the CLI, whose exit code is the real
+# gate: non-zero (no branch pinned) hides the segment cleanly.
+when = '''
+d="$PWD"
+while [ "$d" != "$HOME" ] && [ "$d" != / ]; do
+  if [ -e "$d/.neon" ]; then
+    neon status --current-branch >/dev/null 2>&1
+    exit $?
+  fi
+  d=$(dirname "$d")
+done
+exit 1
+'''
+```
+
 ```bash
 # CI gate: fail the build if the branch has drifted from the policy
 neon config plan --project-id polished-snowflake-12345678 --output json

package/dist/analytics.js

@@ -1,13 +1,19 @@
 import { readFileSync } from 'node:fs';
 import { join } from 'node:path';
 import { Analytics } from '@segment/analytics-node';
-import { isAxiosError } from 'axios';
 import { CREDENTIALS_FILE } from './config.js';
+import { isCurrentBranchProbe } from './context.js';
 import { getGithubEnvVars, isCi } from './env.js';
 import { log } from './log.js';
 import pkg from './pkg.js';
-import { getApiClient } from './api.js';
+import { getApiClient, isNeonApiError } from './api.js';
 const WRITE_KEY = '3SQXn5ejjXWLEJ8xU2PRYhAotLtTaeeV';
+/**
+ * Raw-argv fallback for the offline `--current-branch` probe. The init
+ * middleware runs before validation, where the parsed `currentBranch` flag may
+ * not be populated yet, so we also scan `process.argv` directly to be safe.
+ */
+const hasCurrentBranchArgv = () => process.argv.includes('--current-branch');
 let client;
 let clientInitialized = false;
 let userId = '';
@@ -20,6 +26,13 @@ export const initAnalyticsClientMiddleware = (args) => {
     if (!args.analytics || clientInitialized) {
         return;
     }
+    // The offline `--current-branch` probe must make zero network calls. This
+    // middleware runs before validation, so guard on the raw argv too (in case
+    // the parsed `currentBranch` flag isn't populated this early): never create
+    // the Segment client, which keeps trackEvent/closeAnalytics no-ops downstream.
+    if (isCurrentBranchProbe(args) || hasCurrentBranchArgv()) {
+        return;
+    }
     clientInitialized = true;
     client = new Analytics({
         writeKey: WRITE_KEY,
@@ -38,6 +51,9 @@ export const analyticsMiddleware = async (args) => {
     if (!client || !args.analytics) {
         return;
     }
+    if (isCurrentBranchProbe(args)) {
+        return;
+    }
     try {
         const credentialsPath = join(args.configDir, CREDENTIALS_FILE);
         const credentials = readFileSync(credentialsPath, { encoding: 'utf-8' });
@@ -98,8 +114,8 @@ export const sendError = (err, errCode) => {
     if (!client) {
         return;
     }
-    const axiosError = isAxiosError(err) ? err : undefined;
-    const requestId = axiosError?.response?.headers['x-neon-ret-request-id'];
+    const apiError = isNeonApiError(err) ? err : undefined;
+    const requestId = apiError?.headers?.['x-neon-ret-request-id'];
     if (requestId) {
         log.debug('Failed request ID: %s', requestId);
     }
@@ -110,7 +126,7 @@ export const sendError = (err, errCode) => {
             message: err.message,
             stack: err.stack,
             errCode,
-            statusCode: axiosError?.response?.status,
+            statusCode: apiError?.status,
             requestId: requestId,
         },
     });