neon 8.10.0 → 8.10.2

package/README.md

@@ -1007,7 +1007,7 @@ Default table output is `Feedback received. Thank you!`. `--output json` and `--
 
 ## Search neon.com (`docs search`)
 
-`neon docs search <query>` searches neon.com: the docs, API reference, PostgreSQL tutorial, guides, FAQs, changelog, and blog. It does not log in and does not use your Neon account. It uses the same search as the neon.com search box.
+`neon docs search <query>` searches neon.com: the docs, API reference, PostgreSQL tutorial, guides, FAQs, changelog, and blog. It does not log in and does not use your Neon account. It uses the same search as the neon.com search box. The search service records the query, the CLI version, and the detected coding agent; `--no-analytics` turns that off.
 
 ```bash
 neon docs search "reset a branch"
@@ -1015,7 +1015,7 @@ neon docs search "create branch" --category api --category docs
 neon docs search "pg_dump" --limit 5 --output json
 ```
 
-`--category` limits results to `docs`, `api`, `postgresql`, `guides`, `faqs`, `blog`, or `changelog`; repeat it for more than one. `--limit` is 1 to 40, default 10. Default table output is one row per page: title, the section that matched, and URL. `--output json` and `--output yaml` print an array of hits with `title`, `url`, `category`, `breadcrumb`, `heading`, and `excerpt`, in rank order. No match prints `No results for "<query>".` and exits 0 (`[]` in JSON).
+`--category` limits results to `docs`, `api`, `postgresql`, `guides`, `faqs`, `blog`, or `changelog`; repeat it for more than one. `--limit` is 1 to 40, default 10. Default output is one block per result: `Title › Section` on one line, cut to the terminal width, and the full URL under it. `--output json` and `--output yaml` print an array of hits with `title`, `url`, `category`, `breadcrumb`, `heading`, and `excerpt`, in rank order. No match prints `No results for "<query>".` and exits 0 (`[]` in JSON).
 
 ## Install the Neon plugin (`plugins`)
 
@@ -1543,7 +1543,7 @@ Global options are supported with any Neon CLI command.
 
 - <a id="analytics"></a>`--analytics`
 
-  Analytics are enabled by default to gather information about the CLI commands and options that are used by our customers. This data collection assists in offering support, and allows for a better understanding of typical usage patterns so that we can improve user experience. Neon does not collect user-defined data, such as project IDs or command payloads, except the question passed to `neon ask --prompt`. When the CLI fails on an internal bug (a JavaScript `TypeError`, `ReferenceError`, `RangeError`, or `SyntaxError`), it also sends that error to Neon's Sentry: the error type, the message only when it is a standard JavaScript message that names nothing but code (any other message is replaced), the stack trace with file paths cut to the package (`neon/dist/...`), the CLI and Node.js versions, and whether it ran in CI or a coding agent. To opt-out of analytics data collection and error reports, specify `--no-analytics` or `--analytics false`.
+  Analytics are enabled by default to gather information about the CLI commands and options that are used by our customers. This data collection assists in offering support, and allows for a better understanding of typical usage patterns so that we can improve user experience. Neon does not collect user-defined data, such as project IDs or command payloads, except the question passed to `neon ask --prompt` and the query passed to `neon docs search`. The Neon search service records each `neon docs search` query with the CLI version and the detected coding agent; with `--no-analytics` it records nothing. When the CLI fails on an internal bug (a JavaScript `TypeError`, `ReferenceError`, `RangeError`, or `SyntaxError`), it also sends that error to Neon's Sentry: the error type, the message only when it is a standard JavaScript message that names nothing but code (any other message is replaced), the stack trace with file paths cut to the package (`neon/dist/...`), the CLI and Node.js versions, and whether it ran in CI or a coding agent. To opt-out of analytics data collection and error reports, specify `--no-analytics` or `--analytics false`.
 
 - <a id="version"></a>`-v, --version`
 

package/dist/commands/docs.js

@@ -1,7 +1,11 @@
 import { t as __exportAll } from "../_chunks/rolldown-runtime-8H4AJuhK.js";
+import { getCliAgent, isCi } from "../env.js";
+import pkg_default from "../pkg.js";
 import { isNetworkError } from "../errors.js";
+import { resolveOutputWidth, stripAnsi, truncateTo } from "../human_table.js";
 import { writer } from "../writer.js";
 import { single } from "../utils/flags.js";
+import chalk from "chalk";
 //#region src/commands/docs.ts
 var docs_exports = /* @__PURE__ */ __exportAll({
 	DEFAULT_SITE_SEARCH_URL: () => DEFAULT_SITE_SEARCH_URL,
@@ -11,8 +15,10 @@ var docs_exports = /* @__PURE__ */ __exportAll({
 	builder: () => builder,
 	command: () => command,
 	describe: () => describe,
+	formatSearchResults: () => formatSearchResults,
 	parseSearchHits: () => parseSearchHits,
-	resolveSiteSearchUrl: () => resolveSiteSearchUrl
+	resolveSiteSearchUrl: () => resolveSiteSearchUrl,
+	siteSearchHeaders: () => siteSearchHeaders
 });
 const DEFAULT_SITE_SEARCH_URL = "https://br-frosty-cell-a5smzg39-assistant.compute.c-1.us-east-2.aws.neon.tech/site-search";
 const SITE_SEARCH_CATEGORIES = [
@@ -76,22 +82,56 @@ const search = async (props) => {
 		}),
 		query,
 		limit: props.limit,
-		categories: props.category ? [...new Set(props.category)] : void 0
+		categories: props.category ? [...new Set(props.category)] : void 0,
+		headers: siteSearchHeaders({
+			analytics: props.analytics,
+			agent: getCliAgent(process.env),
+			version: pkg_default.version
+		})
 	});
-	writer(props).end(hits, {
-		fields: [
-			"title",
-			"heading",
-			"url"
-		],
-		emptyMessage: `No results for "${query}".`,
-		renderColumns: { heading: (hit) => sectionOf(hit) }
+	const emptyMessage = `No results for "${query}".`;
+	if (props.output === "json" || props.output === "yaml") {
+		writer(props).end(hits, {
+			fields: [
+				"title",
+				"heading",
+				"url"
+			],
+			emptyMessage
+		});
+		return;
+	}
+	const text = formatSearchResults(hits, {
+		emptyMessage,
+		width: resolveOutputWidth(process.stdout, void 0, {
+			stdout: process.stdout,
+			envColumns: process.env.COLUMNS
+		})
 	});
+	process.stdout.write(process.env.NO_COLOR || isCi() ? stripAnsi(text) : text);
 };
+function formatSearchResults(hits, opts) {
+	if (hits.length === 0) return `\n${opts.emptyMessage}\n`;
+	return hits.map((hit) => {
+		const section = sectionOf(hit).split(" > ").filter(Boolean);
+		const line = [hit.title, ...section].join(" › ");
+		const shown = opts.width === void 0 ? line : truncateTo(line, opts.width);
+		return `${chalk.bold(shown)}\n  ${chalk.cyan(hit.url)}\n`;
+	}).join("\n");
+}
 function sectionOf(hit) {
 	const parts = hit.heading.split(" > ");
 	return (parts[0] === hit.title ? parts.slice(1) : parts).join(" > ");
 }
+function siteSearchHeaders(opts) {
+	return {
+		"Content-Type": "application/json",
+		"User-Agent": `neon/${opts.version}`,
+		"x-neon-source": "cli",
+		...opts.agent ? { "x-neon-client": encodeURIComponent(opts.agent) } : {},
+		...opts.analytics ? {} : { "x-neon-analytics": "off" }
+	};
+}
 function isTimeout(error) {
 	return error instanceof Error && (error.name === "TimeoutError" || error.name === "AbortError");
 }
@@ -100,7 +140,7 @@ async function searchSite(opts) {
 	try {
 		const response = await fetch(opts.url, {
 			method: "POST",
-			headers: { "Content-Type": "application/json" },
+			headers: opts.headers,
 			body: JSON.stringify({
 				query: opts.query,
 				limit: opts.limit,
@@ -154,4 +194,4 @@ function parseSearchHits(raw) {
 	});
 }
 //#endregion
-export { DEFAULT_SITE_SEARCH_URL, MAX_LIMIT, MAX_QUERY_LENGTH, SITE_SEARCH_CATEGORIES, builder, command, describe, parseSearchHits, resolveSiteSearchUrl, docs_exports as t };
+export { DEFAULT_SITE_SEARCH_URL, MAX_LIMIT, MAX_QUERY_LENGTH, SITE_SEARCH_CATEGORIES, builder, command, describe, formatSearchResults, parseSearchHits, resolveSiteSearchUrl, siteSearchHeaders, docs_exports as t };

package/dist/human_table.js

@@ -226,4 +226,4 @@ function charWidth(code) {
 	return 1;
 }
 //#endregion
-export { displayWidth, formatHumanChunk, parseColumns, resolveOutputWidth, stripAnsi, titleCaseField };
+export { displayWidth, formatHumanChunk, parseColumns, resolveOutputWidth, stripAnsi, titleCaseField, truncateTo };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neon",
-  "version": "8.10.0",
+  "version": "8.10.2",
   "description": "CLI tool for Neon, the cloud backend primitives built around Lakebase Postgres",
   "keywords": [
     "neon",
@@ -70,8 +70,8 @@
     "yaml": "^2.9.0",
     "yargs": "17.7.2",
     "yoctocolors": "^2.1.2",
-    "@neon/config": "1.9.3",
     "@neon/realtime": "0.1.2",
+    "@neon/config": "1.9.3",
     "@neon/sdk": "7.4.0",
     "@neon/config-runtime": "1.10.2"
   },