@lark-apaas/miaoda-cli 0.1.1 → 0.1.2-alpha.4d0ff57

package/dist/utils/output.js

@@ -7,6 +7,27 @@ exports.emitOk = emitOk;
 exports.emitPaged = emitPaged;
 const config_1 = require("./config");
 const error_1 = require("./error");
+const colors_1 = require("./colors");
+/**
+ * 服务端错误码 → CLI 兜底 hint 文案。
+ *
+ * 服务端错误协议只有 `{code, msg}` 两个字段（dataloom InnerExecuteSQL 等 IDL
+ * 没有 hint / next_actions 通道），所以服务端给的错误本身永远没有 hint。
+ * 这里是 CLI 展示层为常见错误码补一份 spec 一致的 actionable 引导，按错误码
+ * 落到 next_actions。
+ *
+ * 仅在 next_actions 已经为空时介入——保留 handler / enrichSqlError 自己塞过的
+ * 具体 hint（如 did-you-mean、shared.resolveAppId 等），它们优先级更高。
+ */
+const SERVER_ERROR_HINTS = {
+    // SELECT 结果集超过 1000 行硬拦：spec 多行引导。
+    // key 用 BIZ_ERR_MAP 映射后的语义 code（不是原始服务端 k_dl_xxx），保持
+    // 与 help / 文档里宣传的 RESULT_SET_TOO_LARGE 一致。
+    RESULT_SET_TOO_LARGE: [
+        "Add `LIMIT <n>` to your SQL to narrow the result.",
+        "For counts, use `SELECT count(*) FROM ...`; for aggregation, use GROUP BY with filters.",
+    ],
+};
 function isJsonMode() {
     const cfg = (0, config_1.getConfig)();
     return cfg.output === "json" || Boolean(cfg.json);
@@ -36,23 +57,56 @@ function emit(data) {
  */
 function emitError(err) {
     const info = toErrorInfo(err);
+    // 没人给过 next_actions 才走错误码兜底；handler 已经塞过具体 hint 时不覆盖
+    const hints = info.next_actions && info.next_actions.length > 0
+        ? info.next_actions
+        : (SERVER_ERROR_HINTS[info.code] ?? []);
     if (isJsonMode()) {
         const errObj = {
             code: info.code,
             message: info.message,
         };
-        if (info.next_actions && info.next_actions.length > 0) {
-            errObj.hint = info.next_actions.join(" ");
+        if (hints.length > 0) {
+            // JSON 输出压平成单行，更便于机器消费（脚本 / agent 拼字符串）
+            errObj.hint = hints.join(" ");
         }
         if (typeof info.statement_index === "number") {
             errObj.statement_index = info.statement_index;
         }
+        // PRD 多语句失败 envelope 额外字段：completed / rolled_back
+        if (Array.isArray(info.completed)) {
+            errObj.completed = info.completed;
+        }
+        if (typeof info.rolled_back === "boolean") {
+            errObj.rolled_back = info.rolled_back;
+        }
         process.stderr.write(JSON.stringify({ error: errObj }) + "\n");
     }
     else {
-        process.stderr.write(`Error: ${info.message}\n`);
-        if (info.next_actions && info.next_actions.length > 0) {
-            process.stderr.write(`  hint: ${info.next_actions.join(" ")}\n`);
+        // stderr 染色：picocolors 默认按 stdout.isTTY 判断；stderr 通常也是 tty，
+        // 这里复用 stdout 探测保持简单（stderr only-pipe 的极端场景留作后续优化）
+        // 多语句失败时 Error 行末尾追加 "(at statement K of N)"，与 PRD spec 对齐
+        let errorLine = `${colors_1.c.fail("Error:")} ${info.message}`;
+        if (typeof info.statement_index === "number") {
+            const k = info.statement_index + 1;
+            const n = info.total_statements;
+            errorLine +=
+                typeof n === "number" && n > 0
+                    ? ` (at statement ${String(k)} of ${String(n)})`
+                    : ` (at statement ${String(k)})`;
+        }
+        process.stderr.write(errorLine + "\n");
+        // 多行 hint：第一行带 "hint:" 标签，后续行用 8 空格缩进对齐 "  hint: " 之后的列。
+        // 对应 spec 期望的格式：
+        //   Error: ...
+        //     hint: 第一条建议
+        //           第二条建议
+        if (hints.length > 0) {
+            const [first, ...rest] = hints;
+            process.stderr.write(`  ${colors_1.c.muted("hint:")} ${first}\n`);
+            for (const line of rest) {
+                process.stderr.write(`        ${line}\n`);
+            }
         }
     }
 }

package/dist/utils/render.js

@@ -1,4 +1,14 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatSize = formatSize;
+exports.formatTime = formatTime;
+exports.visibleWidth = visibleWidth;
+exports.renderAlignedTable = renderAlignedTable;
+exports.renderTsv = renderTsv;
+exports.renderKeyValue = renderKeyValue;
+exports.isStdoutTty = isStdoutTty;
+exports.parseDuration = parseDuration;
+exports.parseSize = parseSize;
 /**
  * CLI 渲染 / 解析工具：跨域共用的格式化、表格渲染、字符串解析。
  *
@@ -9,18 +19,12 @@
  *   - 终端探测：isStdoutTty
  *   - 字符串解析：parseDuration / parseSize
  *
+ * 彩色高亮的语义层封装见 ./colors.ts。表头 / key 标签等结构性元素由本文件
+ * 主动调用 colors.c 染色；业务文案的染色（成功/失败 prefix 等）由 handler 自治。
+ *
  * JSON envelope 输出（emit / emitOk / emitPaged / emitError）见 ./output.ts。
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatSize = formatSize;
-exports.formatTime = formatTime;
-exports.visibleWidth = visibleWidth;
-exports.renderAlignedTable = renderAlignedTable;
-exports.renderTsv = renderTsv;
-exports.renderKeyValue = renderKeyValue;
-exports.isStdoutTty = isStdoutTty;
-exports.parseDuration = parseDuration;
-exports.parseSize = parseSize;
+const colors_1 = require("./colors");
 /** 将字节数格式化为人类可读（`24 KB` / `2.1 MB` / `1.5 GB`）。 */
 function formatSize(bytes) {
     if (!Number.isFinite(bytes) || bytes < 0)
@@ -77,20 +81,21 @@ const ANSI_SGR_RE = /\[[0-9;]*m/g;
  * 不实现合字 / 零宽字符（ZWJ / 变体选择符）等极端情况，CLI 表格场景够用。
  */
 function charWidth(cp) {
-    if ((cp >= 0x1100 && cp <= 0x115F) || // Hangul Jamo
-        cp === 0x2329 || cp === 0x232A ||
-        (cp >= 0x2E80 && cp <= 0x303E) || // CJK Radicals / Punctuation
-        (cp >= 0x3041 && cp <= 0x33FF) || // Hiragana / Katakana / CJK Symbols
-        (cp >= 0x3400 && cp <= 0x4DBF) || // CJK Ext A
-        (cp >= 0x4E00 && cp <= 0x9FFF) || // CJK Unified
-        (cp >= 0xA000 && cp <= 0xA4CF) || // Yi
-        (cp >= 0xAC00 && cp <= 0xD7A3) || // Hangul Syllables
-        (cp >= 0xF900 && cp <= 0xFAFF) || // CJK Compat Ideographs
-        (cp >= 0xFE30 && cp <= 0xFE4F) || // CJK Compat Forms
-        (cp >= 0xFF00 && cp <= 0xFF60) || // Fullwidth Forms
-        (cp >= 0xFFE0 && cp <= 0xFFE6) ||
-        (cp >= 0x20000 && cp <= 0x2FFFD) || // CJK Ext B-F
-        (cp >= 0x30000 && cp <= 0x3FFFD) // CJK Ext G-H
+    if ((cp >= 0x1100 && cp <= 0x115f) || // Hangul Jamo
+        cp === 0x2329 ||
+        cp === 0x232a ||
+        (cp >= 0x2e80 && cp <= 0x303e) || // CJK Radicals / Punctuation
+        (cp >= 0x3041 && cp <= 0x33ff) || // Hiragana / Katakana / CJK Symbols
+        (cp >= 0x3400 && cp <= 0x4dbf) || // CJK Ext A
+        (cp >= 0x4e00 && cp <= 0x9fff) || // CJK Unified
+        (cp >= 0xa000 && cp <= 0xa4cf) || // Yi
+        (cp >= 0xac00 && cp <= 0xd7a3) || // Hangul Syllables
+        (cp >= 0xf900 && cp <= 0xfaff) || // CJK Compat Ideographs
+        (cp >= 0xfe30 && cp <= 0xfe4f) || // CJK Compat Forms
+        (cp >= 0xff00 && cp <= 0xff60) || // Fullwidth Forms
+        (cp >= 0xffe0 && cp <= 0xffe6) ||
+        (cp >= 0x20000 && cp <= 0x2fffd) || // CJK Ext B-F
+        (cp >= 0x30000 && cp <= 0x3fffd) // CJK Ext G-H
     ) {
         return 2;
     }
@@ -109,7 +114,8 @@ function padVisibleEnd(s, targetWidth) {
     const w = visibleWidth(s);
     return w >= targetWidth ? s : s + " ".repeat(targetWidth - w);
 }
-/** 渲染 TTY 对齐表格（多行，列宽按最长内容；ANSI 转义不计入列宽）。 */
+/** 渲染 TTY 对齐表格（多行，列宽按最长内容；ANSI 转义不计入列宽）。
+ *  表头按 spec 用 bold + cyan 染色；ANSI 序列由 visibleWidth 剥离不影响列宽。 */
 function renderAlignedTable(headers, rows) {
     const colWidths = headers.map((h, i) => {
         let w = visibleWidth(h);
@@ -121,9 +127,15 @@ function renderAlignedTable(headers, rows) {
         return w;
     });
     const lines = [];
-    lines.push(headers.map((h, i) => padVisibleEnd(h, colWidths[i])).join("  ").trimEnd());
+    lines.push(headers
+        .map((h, i) => colors_1.c.header(padVisibleEnd(h, colWidths[i])))
+        .join("  ")
+        .trimEnd());
     for (const row of rows) {
-        lines.push(row.map((cell, i) => padVisibleEnd(cell || "", colWidths[i])).join("  ").trimEnd());
+        lines.push(row
+            .map((cell, i) => padVisibleEnd(cell || "", colWidths[i]))
+            .join("  ")
+            .trimEnd());
     }
     return lines.join("\n");
 }
@@ -136,7 +148,7 @@ function renderTsv(headers, rows) {
     }
     return lines.join("\n");
 }
-/** 渲染 key-value 多行（用于 stat 等单条详情）。key 右对齐。 */
+/** 渲染 key-value 多行（用于 stat 等单条详情）。key 右对齐 + bold cyan 染色。 */
 function renderKeyValue(pairs, isTty) {
     if (pairs.length === 0)
         return "";
@@ -144,9 +156,7 @@ function renderKeyValue(pairs, isTty) {
         return pairs.map(([k, v]) => `${k}\t${v}`).join("\n");
     }
     const keyWidth = Math.max(...pairs.map(([k]) => k.length));
-    return pairs
-        .map(([k, v]) => `${k.padStart(keyWidth)}:  ${v}`)
-        .join("\n");
+    return pairs.map(([k, v]) => `${colors_1.c.header(k.padStart(keyWidth))}:  ${v}`).join("\n");
 }
 /** 通用 isTTY 判定（stdout 是否交互终端）。Node 运行时 isTTY 为 true 或 undefined；TS 类型上 tty.WriteStream 定义为固定 true，绕开做运行时判断。 */
 function isStdoutTty() {
@@ -162,11 +172,16 @@ function parseDuration(input) {
     const n = Number(m[1]);
     const unit = m[2] || "s";
     switch (unit) {
-        case "s": return n;
-        case "m": return n * 60;
-        case "h": return n * 3600;
-        case "d": return n * 86400;
-        default: return n;
+        case "s":
+            return n;
+        case "m":
+            return n * 60;
+        case "h":
+            return n * 3600;
+        case "d":
+            return n * 86400;
+        default:
+            return n;
     }
 }
 /** 解析 size 字符串 `1MB` / `500KB` / `1GB` → 字节。 */
@@ -178,10 +193,15 @@ function parseSize(input) {
     const n = Number(m[1]);
     const unit = (m[2] || "B").toUpperCase();
     switch (unit) {
-        case "B": return Math.round(n);
-        case "KB": return Math.round(n * 1024);
-        case "MB": return Math.round(n * 1024 * 1024);
-        case "GB": return Math.round(n * 1024 * 1024 * 1024);
-        default: return Math.round(n);
+        case "B":
+            return Math.round(n);
+        case "KB":
+            return Math.round(n * 1024);
+        case "MB":
+            return Math.round(n * 1024 * 1024);
+        case "GB":
+            return Math.round(n * 1024 * 1024 * 1024);
+        default:
+            return Math.round(n);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lark-apaas/miaoda-cli",
-  "version": "0.1.1",
+  "version": "0.1.2-alpha.4d0ff57",
   "description": "Miaoda 平台命令行工具，面向 Agent 调用",
   "type": "commonjs",
   "bin": {
@@ -26,7 +26,8 @@
   },
   "dependencies": {
     "@lark-apaas/http-client": "^0.1.5",
-    "commander": "^13.1.0"
+    "commander": "^13.1.0",
+    "picocolors": "^1.1.1"
   },
   "devDependencies": {
     "@types/node": "^22.15.3",
@@ -34,7 +35,12 @@
     "@typescript-eslint/parser": "^8.58.2",
     "@vitest/coverage-v8": "^4.1.4",
     "eslint": "^9.25.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-boundaries": "^6.0.2",
+    "eslint-plugin-import": "^2.32.0",
     "husky": "^9.1.7",
+    "prettier": "^3.8.3",
     "tsc-alias": "^1.8.11",
     "tsx": "^4.19.4",
     "typescript": "^5.8.3",
@@ -45,6 +51,8 @@
     "build": "bash scripts/build.sh",
     "typecheck": "tsc --noEmit -p tsconfig.json",
     "lint": "eslint src/ --max-warnings 0",
+    "format": "prettier --write src/",
+    "format:check": "prettier --check src/",
     "test": "vitest run",
     "test:watch": "vitest",
     "test:integration": "vitest run --config vitest.integration.config.ts",