@settlemint/sdk-utils 2.6.3 → 2.6.4-mainc8236602
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +181 -166
- package/dist/environment.cjs +122 -17
- package/dist/environment.cjs.map +1 -1
- package/dist/environment.js +122 -17
- package/dist/environment.js.map +1 -1
- package/dist/package-manager.cjs +122 -17
- package/dist/package-manager.cjs.map +1 -1
- package/dist/package-manager.js +122 -17
- package/dist/package-manager.js.map +1 -1
- package/dist/terminal.cjs +122 -17
- package/dist/terminal.cjs.map +1 -1
- package/dist/terminal.d.cts +22 -5
- package/dist/terminal.d.ts +22 -5
- package/dist/terminal.js +122 -17
- package/dist/terminal.js.map +1 -1
- package/package.json +1 -1
package/dist/terminal.cjs
CHANGED
|
@@ -34,11 +34,27 @@ console_table_printer = __toESM(console_table_printer);
|
|
|
34
34
|
|
|
35
35
|
//#region src/terminal/should-print.ts
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
38
|
-
*
|
|
37
|
+
* Determines whether terminal output should be printed based on environment variables.
|
|
38
|
+
*
|
|
39
|
+
* **Environment Variable Precedence:**
|
|
40
|
+
* 1. `SETTLEMINT_DISABLE_TERMINAL="true"` - Completely disables all terminal output (highest priority)
|
|
41
|
+
* 2. `CLAUDECODE`, `REPL_ID`, or `AGENT` (any truthy value) - Enables quiet mode, suppressing info/debug/status messages
|
|
42
|
+
*
|
|
43
|
+
* **Quiet Mode Behavior:**
|
|
44
|
+
* When quiet mode is active (Claude Code environments), this function returns `false` to suppress
|
|
45
|
+
* informational output. However, warnings and errors are always displayed regardless of quiet mode,
|
|
46
|
+
* as they are handled separately in the `note()` function with level-based filtering.
|
|
47
|
+
*
|
|
48
|
+
* @returns `true` if terminal output should be printed, `false` if suppressed
|
|
39
49
|
*/
|
|
40
50
|
function shouldPrint() {
|
|
41
|
-
|
|
51
|
+
if (process.env.SETTLEMINT_DISABLE_TERMINAL === "true") {
|
|
52
|
+
return false;
|
|
53
|
+
}
|
|
54
|
+
if (process.env.CLAUDECODE || process.env.REPL_ID || process.env.AGENT) {
|
|
55
|
+
return false;
|
|
56
|
+
}
|
|
57
|
+
return true;
|
|
42
58
|
}
|
|
43
59
|
|
|
44
60
|
//#endregion
|
|
@@ -131,9 +147,17 @@ var CommandError = class extends Error {
|
|
|
131
147
|
}
|
|
132
148
|
};
|
|
133
149
|
/**
|
|
150
|
+
* Checks if we're in quiet mode (Claude Code environment)
|
|
151
|
+
*/
|
|
152
|
+
function isQuietMode() {
|
|
153
|
+
return !!(process.env.CLAUDECODE || process.env.REPL_ID || process.env.AGENT);
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
134
156
|
* Executes a command with the given arguments in a child process.
|
|
135
157
|
* Pipes stdin to the child process and captures stdout/stderr output.
|
|
136
158
|
* Masks any sensitive tokens in the output before displaying or returning.
|
|
159
|
+
* In quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set),
|
|
160
|
+
* output is suppressed unless the command errors out.
|
|
137
161
|
*
|
|
138
162
|
* @param command - The command to execute
|
|
139
163
|
* @param args - Array of arguments to pass to the command
|
|
@@ -151,6 +175,8 @@ var CommandError = class extends Error {
|
|
|
151
175
|
*/
|
|
152
176
|
async function executeCommand(command, args, options) {
|
|
153
177
|
const { silent,...spawnOptions } = options ?? {};
|
|
178
|
+
const quietMode = isQuietMode();
|
|
179
|
+
const shouldSuppressOutput = quietMode ? silent !== false : !!silent;
|
|
154
180
|
const child = (0, node_child_process.spawn)(command, args, {
|
|
155
181
|
...spawnOptions,
|
|
156
182
|
env: {
|
|
@@ -160,23 +186,38 @@ async function executeCommand(command, args, options) {
|
|
|
160
186
|
});
|
|
161
187
|
process.stdin.pipe(child.stdin);
|
|
162
188
|
const output = [];
|
|
189
|
+
const stdoutOutput = [];
|
|
190
|
+
const stderrOutput = [];
|
|
163
191
|
return new Promise((resolve, reject) => {
|
|
164
192
|
child.stdout.on("data", (data) => {
|
|
165
193
|
const maskedData = maskTokens(data.toString());
|
|
166
|
-
if (!
|
|
194
|
+
if (!shouldSuppressOutput) {
|
|
167
195
|
process.stdout.write(maskedData);
|
|
168
196
|
}
|
|
169
197
|
output.push(maskedData);
|
|
198
|
+
stdoutOutput.push(maskedData);
|
|
170
199
|
});
|
|
171
200
|
child.stderr.on("data", (data) => {
|
|
172
201
|
const maskedData = maskTokens(data.toString());
|
|
173
|
-
if (!
|
|
202
|
+
if (!shouldSuppressOutput) {
|
|
174
203
|
process.stderr.write(maskedData);
|
|
175
204
|
}
|
|
176
205
|
output.push(maskedData);
|
|
206
|
+
stderrOutput.push(maskedData);
|
|
177
207
|
});
|
|
208
|
+
const showErrorOutput = () => {
|
|
209
|
+
if (quietMode && shouldSuppressOutput && output.length > 0) {
|
|
210
|
+
if (stdoutOutput.length > 0) {
|
|
211
|
+
process.stdout.write(stdoutOutput.join(""));
|
|
212
|
+
}
|
|
213
|
+
if (stderrOutput.length > 0) {
|
|
214
|
+
process.stderr.write(stderrOutput.join(""));
|
|
215
|
+
}
|
|
216
|
+
}
|
|
217
|
+
};
|
|
178
218
|
child.on("error", (err) => {
|
|
179
219
|
process.stdin.unpipe(child.stdin);
|
|
220
|
+
showErrorOutput();
|
|
180
221
|
reject(new CommandError(err.message, "code" in err && typeof err.code === "number" ? err.code : 1, output));
|
|
181
222
|
});
|
|
182
223
|
child.on("close", (code) => {
|
|
@@ -185,6 +226,7 @@ async function executeCommand(command, args, options) {
|
|
|
185
226
|
resolve(output);
|
|
186
227
|
return;
|
|
187
228
|
}
|
|
229
|
+
showErrorOutput();
|
|
188
230
|
reject(new CommandError(`Command "${command}" exited with code ${code}`, code, output));
|
|
189
231
|
});
|
|
190
232
|
});
|
|
@@ -215,12 +257,63 @@ const intro = (msg) => {
|
|
|
215
257
|
//#endregion
|
|
216
258
|
//#region src/terminal/note.ts
|
|
217
259
|
/**
|
|
218
|
-
*
|
|
219
|
-
*
|
|
260
|
+
* Applies color to a message if not already colored.
|
|
261
|
+
* @param msg - The message to colorize
|
|
262
|
+
* @param level - The severity level determining the color
|
|
263
|
+
* @returns Colorized message (yellow for warnings, red for errors, unchanged for info)
|
|
264
|
+
*/
|
|
265
|
+
function colorize(msg, level) {
|
|
266
|
+
if (msg.includes("\x1B[")) {
|
|
267
|
+
return msg;
|
|
268
|
+
}
|
|
269
|
+
if (level === "warn") {
|
|
270
|
+
return (0, yoctocolors.yellowBright)(msg);
|
|
271
|
+
}
|
|
272
|
+
if (level === "error") {
|
|
273
|
+
return (0, yoctocolors.redBright)(msg);
|
|
274
|
+
}
|
|
275
|
+
return msg;
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* Determines whether a message should be printed based on its level and quiet mode.
|
|
279
|
+
* @param level - The severity level of the message
|
|
280
|
+
* @returns true if the message should be printed, false otherwise
|
|
281
|
+
*/
|
|
282
|
+
function canPrint(level) {
|
|
283
|
+
if (level !== "info") {
|
|
284
|
+
return true;
|
|
285
|
+
}
|
|
286
|
+
return shouldPrint();
|
|
287
|
+
}
|
|
288
|
+
/**
|
|
289
|
+
* Prepares a message for display by converting Error objects and masking tokens.
|
|
290
|
+
* @param value - The message string or Error object
|
|
291
|
+
* @param level - The severity level (stack traces are included for errors)
|
|
292
|
+
* @returns Masked message text, optionally with stack trace
|
|
293
|
+
*/
|
|
294
|
+
function prepareMessage(value, level) {
|
|
295
|
+
let text;
|
|
296
|
+
if (value instanceof Error) {
|
|
297
|
+
text = value.message;
|
|
298
|
+
if (level === "error" && value.stack) {
|
|
299
|
+
text = `${text}\n\n${value.stack}`;
|
|
300
|
+
}
|
|
301
|
+
} else {
|
|
302
|
+
text = value;
|
|
303
|
+
}
|
|
304
|
+
return maskTokens(text);
|
|
305
|
+
}
|
|
306
|
+
/**
|
|
307
|
+
* Displays a note message with optional warning or error level formatting.
|
|
308
|
+
* Regular notes are displayed in normal text, warnings are shown in yellow, and errors in red.
|
|
220
309
|
* Any sensitive tokens in the message are masked before display.
|
|
310
|
+
* Warnings and errors are always displayed, even in quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set).
|
|
311
|
+
* When an Error object is provided with level "error", the stack trace is automatically included.
|
|
221
312
|
*
|
|
222
|
-
* @param message - The message to display as a note
|
|
223
|
-
*
|
|
313
|
+
* @param message - The message to display as a note. Can be either:
|
|
314
|
+
* - A string: Displayed directly with appropriate styling
|
|
315
|
+
* - An Error object: The error message is displayed, and for level "error", the stack trace is automatically included
|
|
316
|
+
* @param level - The note level: "info" (default), "warn" for warning styling, or "error" for error styling
|
|
224
317
|
* @example
|
|
225
318
|
* import { note } from "@settlemint/sdk-utils/terminal";
|
|
226
319
|
*
|
|
@@ -229,18 +322,31 @@ const intro = (msg) => {
|
|
|
229
322
|
*
|
|
230
323
|
* // Display warning note
|
|
231
324
|
* note("Low disk space remaining", "warn");
|
|
325
|
+
*
|
|
326
|
+
* // Display error note (string)
|
|
327
|
+
* note("Operation failed", "error");
|
|
328
|
+
*
|
|
329
|
+
* // Display error with stack trace automatically (Error object)
|
|
330
|
+
* try {
|
|
331
|
+
* // some operation
|
|
332
|
+
* } catch (error) {
|
|
333
|
+
* // If error is an Error object and level is "error", stack trace is included automatically
|
|
334
|
+
* note(error, "error");
|
|
335
|
+
* }
|
|
232
336
|
*/
|
|
233
337
|
const note = (message, level = "info") => {
|
|
234
|
-
if (!
|
|
338
|
+
if (!canPrint(level)) {
|
|
235
339
|
return;
|
|
236
340
|
}
|
|
237
|
-
const
|
|
341
|
+
const msg = prepareMessage(message, level);
|
|
238
342
|
console.log("");
|
|
239
343
|
if (level === "warn") {
|
|
240
|
-
console.warn((
|
|
241
|
-
|
|
344
|
+
console.warn(colorize(msg, level));
|
|
345
|
+
} else if (level === "error") {
|
|
346
|
+
console.error(colorize(msg, level));
|
|
347
|
+
} else {
|
|
348
|
+
console.log(msg);
|
|
242
349
|
}
|
|
243
|
-
console.log(maskedMessage);
|
|
244
350
|
};
|
|
245
351
|
|
|
246
352
|
//#endregion
|
|
@@ -335,9 +441,8 @@ var SpinnerError = class extends Error {
|
|
|
335
441
|
*/
|
|
336
442
|
const spinner = async (options) => {
|
|
337
443
|
const handleError = (error) => {
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
throw new SpinnerError(errorMessage, error);
|
|
444
|
+
note(error, "error");
|
|
445
|
+
throw new SpinnerError(error.message, error);
|
|
341
446
|
};
|
|
342
447
|
if (is_in_ci.default || !shouldPrint()) {
|
|
343
448
|
try {
|
package/dist/terminal.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"terminal.cjs","names":["code: number","output: string[]","items","originalError: Error","isInCi","spinner","table","Table"],"sources":["../src/terminal/should-print.ts","../src/terminal/ascii.ts","../src/logging/mask-tokens.ts","../src/terminal/cancel.ts","../src/terminal/execute-command.ts","../src/terminal/intro.ts","../src/terminal/note.ts","../src/terminal/list.ts","../src/terminal/outro.ts","../src/terminal/spinner.ts","../src/string.ts","../src/terminal/table.ts"],"sourcesContent":["/**\n * Returns true if the terminal should print, false otherwise.\n * @returns true if the terminal should print, false otherwise.\n */\nexport function shouldPrint() {\n return process.env.SETTLEMINT_DISABLE_TERMINAL !== \"true\";\n}\n","import { magentaBright } from \"yoctocolors\";\nimport { shouldPrint } from \"./should-print.js\";\n\n/**\n * Prints the SettleMint ASCII art logo to the console in magenta color.\n * Used for CLI branding and visual identification.\n *\n * @example\n * import { ascii } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Prints the SettleMint logo\n * ascii();\n */\nexport const ascii = (): void => {\n if (!shouldPrint()) {\n return;\n }\n console.log(\n magentaBright(`\n _________ __ __ .__ _____ .__ __\n / _____/ _____/ |__/ |_| | ____ / \\\\ |__| _____/ |_\n \\\\_____ \\\\_/ __ \\\\ __\\\\ __\\\\ | _/ __ \\\\ / \\\\ / \\\\| |/ \\\\ __\\\\\n / \\\\ ___/| | | | | |_\\\\ ___// Y \\\\ | | \\\\ |\n/_________/\\\\_____>__| |__| |____/\\\\_____>____|____/__|___|__/__|\n`),\n );\n};\n","/**\n * Masks sensitive SettleMint tokens in output text by replacing them with asterisks.\n * Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).\n *\n * @param output - The text string that may contain sensitive tokens\n * @returns The text with any sensitive tokens masked with asterisks\n * @example\n * import { maskTokens } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Masks a token in text\n * const masked = maskTokens(\"Token: sm_pat_****\"); // \"Token: ***\"\n */\nexport const maskTokens = (output: string): string => {\n return output.replace(/sm_(pat|aat|sat)_[0-9a-zA-Z]+/g, \"***\");\n};\n","import { maskTokens } from \"@/logging/mask-tokens.js\";\nimport { inverse, redBright } from \"yoctocolors\";\n\n/**\n * Error class used to indicate that the operation was cancelled.\n * This error is used to signal that the operation should be aborted.\n */\nexport class CancelError extends Error {}\n\n/**\n * Displays an error message in red inverse text and throws a CancelError.\n * Used to terminate execution with a visible error message.\n * Any sensitive tokens in the message are masked before display.\n *\n * @param msg - The error message to display\n * @returns never - Function does not return as it throws an error\n * @example\n * import { cancel } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Exits process with error message\n * cancel(\"An error occurred\");\n */\nexport const cancel = (msg: string): never => {\n console.log(\"\");\n console.log(inverse(redBright(maskTokens(msg))));\n console.log(\"\");\n throw new CancelError(msg);\n};\n","import { type SpawnOptionsWithoutStdio, spawn } from \"node:child_process\";\nimport { maskTokens } from \"../logging/mask-tokens.js\";\n\n/**\n * Options for executing a command, extending SpawnOptionsWithoutStdio\n */\nexport interface ExecuteCommandOptions extends SpawnOptionsWithoutStdio {\n /** Whether to suppress output to stdout/stderr */\n silent?: boolean;\n}\n\n/**\n * Error class for command execution errors\n * @extends Error\n */\nexport class CommandError extends Error {\n /**\n * Constructs a new CommandError\n * @param message - The error message\n * @param code - The exit code of the command\n * @param output - The output of the command\n */\n constructor(\n message: string,\n public readonly code: number,\n public readonly output: string[],\n ) {\n super(message);\n }\n}\n\n/**\n * Executes a command with the given arguments in a child process.\n * Pipes stdin to the child process and captures stdout/stderr output.\n * Masks any sensitive tokens in the output before displaying or returning.\n *\n * @param command - The command to execute\n * @param args - Array of arguments to pass to the command\n * @param options - Options for customizing command execution\n * @returns Array of output strings from stdout and stderr\n * @throws {CommandError} If the process fails to start or exits with non-zero code\n * @example\n * import { executeCommand } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Execute git clone\n * await executeCommand(\"git\", [\"clone\", \"repo-url\"]);\n *\n * // Execute silently\n * await executeCommand(\"npm\", [\"install\"], { silent: true });\n */\nexport async function executeCommand(\n command: string,\n args: string[],\n options?: ExecuteCommandOptions,\n): Promise<string[]> {\n const { silent, ...spawnOptions } = options ?? {};\n const child = spawn(command, args, { ...spawnOptions, env: { ...process.env, ...options?.env } });\n process.stdin.pipe(child.stdin);\n const output: string[] = [];\n return new Promise((resolve, reject) => {\n child.stdout.on(\"data\", (data: Buffer | string) => {\n const maskedData = maskTokens(data.toString());\n if (!silent) {\n process.stdout.write(maskedData);\n }\n output.push(maskedData);\n });\n child.stderr.on(\"data\", (data: Buffer | string) => {\n const maskedData = maskTokens(data.toString());\n if (!silent) {\n process.stderr.write(maskedData);\n }\n output.push(maskedData);\n });\n child.on(\"error\", (err) => {\n process.stdin.unpipe(child.stdin);\n reject(new CommandError(err.message, \"code\" in err && typeof err.code === \"number\" ? err.code : 1, output));\n });\n child.on(\"close\", (code) => {\n process.stdin.unpipe(child.stdin);\n if (code === 0 || code === null || code === 143) {\n resolve(output);\n return;\n }\n reject(new CommandError(`Command \"${command}\" exited with code ${code}`, code, output));\n });\n });\n}\n","import { maskTokens } from \"@/logging/mask-tokens.js\";\nimport { magentaBright } from \"yoctocolors\";\nimport { shouldPrint } from \"./should-print.js\";\n\n/**\n * Displays an introductory message in magenta text with padding.\n * Any sensitive tokens in the message are masked before display.\n *\n * @param msg - The message to display as introduction\n * @example\n * import { intro } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Display intro message\n * intro(\"Starting deployment...\");\n */\nexport const intro = (msg: string): void => {\n if (!shouldPrint()) {\n return;\n }\n console.log(\"\");\n console.log(magentaBright(maskTokens(msg)));\n console.log(\"\");\n};\n","import { maskTokens } from \"@/logging/mask-tokens.js\";\nimport { yellowBright } from \"yoctocolors\";\nimport { shouldPrint } from \"./should-print.js\";\n\n/**\n * Displays a note message with optional warning level formatting.\n * Regular notes are displayed in normal text, while warnings are shown in yellow.\n * Any sensitive tokens in the message are masked before display.\n *\n * @param message - The message to display as a note\n * @param level - The note level: \"info\" (default) or \"warn\" for warning styling\n * @example\n * import { note } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Display info note\n * note(\"Operation completed successfully\");\n *\n * // Display warning note\n * note(\"Low disk space remaining\", \"warn\");\n */\nexport const note = (message: string, level: \"info\" | \"warn\" = \"info\"): void => {\n if (!shouldPrint()) {\n return;\n }\n const maskedMessage = maskTokens(message);\n\n console.log(\"\");\n if (level === \"warn\") {\n console.warn(yellowBright(maskedMessage));\n return;\n }\n\n console.log(maskedMessage);\n};\n","import { note } from \"./note.js\";\n\n/**\n * Displays a list of items in a formatted manner, supporting nested items.\n *\n * @param title - The title of the list\n * @param items - The items to display, can be strings or arrays for nested items\n * @returns The formatted list\n * @example\n * import { list } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Simple list\n * list(\"Use cases\", [\"use case 1\", \"use case 2\", \"use case 3\"]);\n *\n * // Nested list\n * list(\"Providers\", [\n * \"AWS\",\n * [\"us-east-1\", \"eu-west-1\"],\n * \"Azure\",\n * [\"eastus\", \"westeurope\"]\n * ]);\n */\nexport function list(title: string, items: Array<string | string[]>) {\n const formatItems = (items: Array<string | string[]>): string => {\n return items\n .map((item) => {\n if (Array.isArray(item)) {\n return item.map((subItem) => ` • ${subItem}`).join(\"\\n\");\n }\n return ` • ${item}`;\n })\n .join(\"\\n\");\n };\n\n return note(`${title}:\\n\\n${formatItems(items)}`);\n}\n","import { maskTokens } from \"@/logging/mask-tokens.js\";\nimport { shouldPrint } from \"@/terminal/should-print.js\";\nimport { greenBright, inverse } from \"yoctocolors\";\n\n/**\n * Displays a closing message in green inverted text with padding.\n * Any sensitive tokens in the message are masked before display.\n *\n * @param msg - The message to display as conclusion\n * @example\n * import { outro } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Display outro message\n * outro(\"Deployment completed successfully!\");\n */\nexport const outro = (msg: string): void => {\n if (!shouldPrint()) {\n return;\n }\n console.log(\"\");\n console.log(inverse(greenBright(maskTokens(msg))));\n console.log(\"\");\n};\n","import isInCi from \"is-in-ci\";\nimport yoctoSpinner, { type Spinner } from \"yocto-spinner\";\nimport { redBright } from \"yoctocolors\";\nimport { maskTokens } from \"../logging/mask-tokens.js\";\nimport { note } from \"./note.js\";\nimport { shouldPrint } from \"./should-print.js\";\n\n/**\n * Error class used to indicate that the spinner operation failed.\n * This error is used to signal that the operation should be aborted.\n */\nexport class SpinnerError extends Error {\n constructor(\n message: string,\n public readonly originalError: Error,\n ) {\n super(message);\n this.name = \"SpinnerError\";\n }\n}\n\n/**\n * Options for configuring the spinner behavior\n */\nexport interface SpinnerOptions<R> {\n /** Message to display when spinner starts */\n startMessage: string;\n /** Async task to execute while spinner is active */\n task: (spinner?: Spinner) => Promise<R>;\n /** Message to display when spinner completes successfully */\n stopMessage: string;\n}\n\n/**\n * Displays a loading spinner while executing an async task.\n * Shows progress with start/stop messages and handles errors.\n * Spinner is disabled in CI environments.\n *\n * @param options - Configuration options for the spinner\n * @returns The result from the executed task\n * @throws Will exit process with code 1 if task fails\n * @example\n * import { spinner } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Show spinner during async task\n * const result = await spinner({\n * startMessage: \"Deploying...\",\n * task: async () => {\n * // Async work here\n * return \"success\";\n * },\n * stopMessage: \"Deployed successfully!\"\n * });\n */\nexport const spinner = async <R>(options: SpinnerOptions<R>): Promise<R> => {\n const handleError = (error: Error) => {\n const errorMessage = maskTokens(error.message);\n note(redBright(`${errorMessage}\\n\\n${error.stack}`));\n throw new SpinnerError(errorMessage, error);\n };\n if (isInCi || !shouldPrint()) {\n try {\n return await options.task();\n } catch (err) {\n return handleError(err as Error);\n }\n }\n const spinner = yoctoSpinner({ stream: process.stdout }).start(options.startMessage);\n try {\n const result = await options.task(spinner);\n spinner.success(options.stopMessage);\n // Ensure spinner success message renders before proceeding to avoid\n // terminal output overlap issues with subsequent messages\n await new Promise((resolve) => process.nextTick(resolve));\n return result;\n } catch (err) {\n spinner.error(redBright(`${options.startMessage} --> Error!`));\n return handleError(err as Error);\n }\n};\n","/**\n * Capitalizes the first letter of a string.\n *\n * @param val - The string to capitalize\n * @returns The input string with its first letter capitalized\n *\n * @example\n * import { capitalizeFirstLetter } from \"@settlemint/sdk-utils\";\n *\n * const capitalized = capitalizeFirstLetter(\"hello\");\n * // Returns: \"Hello\"\n */\nexport function capitalizeFirstLetter(val: string) {\n return String(val).charAt(0).toUpperCase() + String(val).slice(1);\n}\n\n/**\n * Converts a camelCase string to a human-readable string.\n *\n * @param s - The camelCase string to convert\n * @returns The human-readable string\n *\n * @example\n * import { camelCaseToWords } from \"@settlemint/sdk-utils\";\n *\n * const words = camelCaseToWords(\"camelCaseString\");\n * // Returns: \"Camel Case String\"\n */\nexport function camelCaseToWords(s: string) {\n const result = s.replace(/([a-z])([A-Z])/g, \"$1 $2\");\n const withSpaces = result.replace(/([A-Z])([a-z])/g, \" $1$2\");\n const capitalized = capitalizeFirstLetter(withSpaces);\n return capitalized.replace(/\\s+/g, \" \").trim();\n}\n\n/**\n * Replaces underscores and hyphens with spaces.\n *\n * @param s - The string to replace underscores and hyphens with spaces\n * @returns The input string with underscores and hyphens replaced with spaces\n *\n * @example\n * import { replaceUnderscoresAndHyphensWithSpaces } from \"@settlemint/sdk-utils\";\n *\n * const result = replaceUnderscoresAndHyphensWithSpaces(\"Already_Spaced-Second\");\n * // Returns: \"Already Spaced Second\"\n */\nexport function replaceUnderscoresAndHyphensWithSpaces(s: string) {\n return s.replace(/[-_]/g, \" \");\n}\n\n/**\n * Truncates a string to a maximum length and appends \"...\" if it is longer.\n *\n * @param value - The string to truncate\n * @param maxLength - The maximum length of the string\n * @returns The truncated string or the original string if it is shorter than the maximum length\n *\n * @example\n * import { truncate } from \"@settlemint/sdk-utils\";\n *\n * const truncated = truncate(\"Hello, world!\", 10);\n * // Returns: \"Hello, wor...\"\n */\nexport function truncate(value: string, maxLength: number) {\n if (value.length <= maxLength) {\n return value;\n }\n return `${value.slice(0, maxLength)}...`;\n}\n","import { Table } from \"console-table-printer\";\nimport { whiteBright } from \"yoctocolors\";\nimport { camelCaseToWords } from \"@/string.js\";\nimport { note } from \"./note.js\";\nimport { shouldPrint } from \"./should-print.js\";\n/**\n * Displays data in a formatted table in the terminal.\n *\n * @param title - Title to display above the table\n * @param data - Array of objects to display in table format\n * @example\n * import { table } from \"@settlemint/sdk-utils/terminal\";\n *\n * const data = [\n * { name: \"Item 1\", value: 100 },\n * { name: \"Item 2\", value: 200 }\n * ];\n *\n * table(\"My Table\", data);\n */\nexport function table(title: string, data: unknown[]): void {\n if (!shouldPrint()) {\n return;\n }\n\n note(title);\n\n if (!data || data.length === 0) {\n note(\"No data to display\");\n return;\n }\n\n const columnKeys = Object.keys(data[0] as Record<string, unknown>);\n const table = new Table({\n columns: columnKeys.map((key) => ({\n name: key,\n title: whiteBright(camelCaseToWords(key)),\n alignment: \"left\",\n })),\n });\n // biome-ignore lint/suspicious/noExplicitAny: Data structure varies based on table content\n table.addRows(data as Array<Record<string, any>>);\n table.printTable();\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,SAAgB,cAAc;AAC5B,QAAO,QAAQ,IAAI,gCAAgC;;;;;;;;;;;;;;;ACQrD,MAAa,cAAoB;AAC/B,KAAI,CAAC,aAAa,EAAE;AAClB;;AAEF,SAAQ,mCACQ;;;;;;EAMhB,CACC;;;;;;;;;;;;;;;;;ACbH,MAAa,cAAc,WAA2B;AACpD,QAAO,OAAO,QAAQ,kCAAkC,MAAM;;;;;;;;;ACNhE,IAAa,cAAb,cAAiC,MAAM;;;;;;;;;;;;;;AAevC,MAAa,UAAU,QAAuB;AAC5C,SAAQ,IAAI,GAAG;AACf,SAAQ,wDAAsB,WAAW,IAAI,CAAC,CAAC,CAAC;AAChD,SAAQ,IAAI,GAAG;AACf,OAAM,IAAI,YAAY,IAAI;;;;;;;;;ACX5B,IAAa,eAAb,cAAkC,MAAM;;;;;;;CAOtC,YACE,SACA,AAAgBA,MAChB,AAAgBC,QAChB;AACA,QAAM,QAAQ;EAHE;EACA;;;;;;;;;;;;;;;;;;;;;;AAyBpB,eAAsB,eACpB,SACA,MACA,SACmB;CACnB,MAAM,EAAE,OAAQ,GAAG,iBAAiB,WAAW,EAAE;CACjD,MAAM,sCAAc,SAAS,MAAM;EAAE,GAAG;EAAc,KAAK;GAAE,GAAG,QAAQ;GAAK,GAAG,SAAS;GAAK;EAAE,CAAC;AACjG,SAAQ,MAAM,KAAK,MAAM,MAAM;CAC/B,MAAMA,SAAmB,EAAE;AAC3B,QAAO,IAAI,SAAS,SAAS,WAAW;AACtC,QAAM,OAAO,GAAG,SAAS,SAA0B;GACjD,MAAM,aAAa,WAAW,KAAK,UAAU,CAAC;AAC9C,OAAI,CAAC,QAAQ;AACX,YAAQ,OAAO,MAAM,WAAW;;AAElC,UAAO,KAAK,WAAW;IACvB;AACF,QAAM,OAAO,GAAG,SAAS,SAA0B;GACjD,MAAM,aAAa,WAAW,KAAK,UAAU,CAAC;AAC9C,OAAI,CAAC,QAAQ;AACX,YAAQ,OAAO,MAAM,WAAW;;AAElC,UAAO,KAAK,WAAW;IACvB;AACF,QAAM,GAAG,UAAU,QAAQ;AACzB,WAAQ,MAAM,OAAO,MAAM,MAAM;AACjC,UAAO,IAAI,aAAa,IAAI,SAAS,UAAU,OAAO,OAAO,IAAI,SAAS,WAAW,IAAI,OAAO,GAAG,OAAO,CAAC;IAC3G;AACF,QAAM,GAAG,UAAU,SAAS;AAC1B,WAAQ,MAAM,OAAO,MAAM,MAAM;AACjC,OAAI,SAAS,KAAK,SAAS,QAAQ,SAAS,KAAK;AAC/C,YAAQ,OAAO;AACf;;AAEF,UAAO,IAAI,aAAa,YAAY,QAAQ,qBAAqB,QAAQ,MAAM,OAAO,CAAC;IACvF;GACF;;;;;;;;;;;;;;;;ACvEJ,MAAa,SAAS,QAAsB;AAC1C,KAAI,CAAC,aAAa,EAAE;AAClB;;AAEF,SAAQ,IAAI,GAAG;AACf,SAAQ,mCAAkB,WAAW,IAAI,CAAC,CAAC;AAC3C,SAAQ,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;ACDjB,MAAa,QAAQ,SAAiB,QAAyB,WAAiB;AAC9E,KAAI,CAAC,aAAa,EAAE;AAClB;;CAEF,MAAM,gBAAgB,WAAW,QAAQ;AAEzC,SAAQ,IAAI,GAAG;AACf,KAAI,UAAU,QAAQ;AACpB,UAAQ,mCAAkB,cAAc,CAAC;AACzC;;AAGF,SAAQ,IAAI,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;ACV5B,SAAgB,KAAK,OAAe,OAAiC;CACnE,MAAM,eAAe,YAA4C;AAC/D,SAAOC,QACJ,KAAK,SAAS;AACb,OAAI,MAAM,QAAQ,KAAK,EAAE;AACvB,WAAO,KAAK,KAAK,YAAY,SAAS,UAAU,CAAC,KAAK,KAAK;;AAE7D,UAAO,OAAO;IACd,CACD,KAAK,KAAK;;AAGf,QAAO,KAAK,GAAG,MAAM,OAAO,YAAY,MAAM,GAAG;;;;;;;;;;;;;;;;ACnBnD,MAAa,SAAS,QAAsB;AAC1C,KAAI,CAAC,aAAa,EAAE;AAClB;;AAEF,SAAQ,IAAI,GAAG;AACf,SAAQ,0DAAwB,WAAW,IAAI,CAAC,CAAC,CAAC;AAClD,SAAQ,IAAI,GAAG;;;;;;;;;ACVjB,IAAa,eAAb,cAAkC,MAAM;CACtC,YACE,SACA,AAAgBC,eAChB;AACA,QAAM,QAAQ;EAFE;AAGhB,OAAK,OAAO;;;;;;;;;;;;;;;;;;;;;;;;AAqChB,MAAa,UAAU,OAAU,YAA2C;CAC1E,MAAM,eAAe,UAAiB;EACpC,MAAM,eAAe,WAAW,MAAM,QAAQ;AAC9C,kCAAe,GAAG,aAAa,MAAM,MAAM,QAAQ,CAAC;AACpD,QAAM,IAAI,aAAa,cAAc,MAAM;;AAE7C,KAAIC,oBAAU,CAAC,aAAa,EAAE;AAC5B,MAAI;AACF,UAAO,MAAM,QAAQ,MAAM;WACpB,KAAK;AACZ,UAAO,YAAY,IAAa;;;CAGpC,MAAMC,uCAAuB,EAAE,QAAQ,QAAQ,QAAQ,CAAC,CAAC,MAAM,QAAQ,aAAa;AACpF,KAAI;EACF,MAAM,SAAS,MAAM,QAAQ,KAAKA,UAAQ;AAC1C,YAAQ,QAAQ,QAAQ,YAAY;AAGpC,QAAM,IAAI,SAAS,YAAY,QAAQ,SAAS,QAAQ,CAAC;AACzD,SAAO;UACA,KAAK;AACZ,YAAQ,iCAAgB,GAAG,QAAQ,aAAa,aAAa,CAAC;AAC9D,SAAO,YAAY,IAAa;;;;;;;;;;;;;;;;;;ACjEpC,SAAgB,sBAAsB,KAAa;AACjD,QAAO,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,aAAa,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE;;;;;;;;;;;;;;AAenE,SAAgB,iBAAiB,GAAW;CAC1C,MAAM,SAAS,EAAE,QAAQ,mBAAmB,QAAQ;CACpD,MAAM,aAAa,OAAO,QAAQ,mBAAmB,QAAQ;CAC7D,MAAM,cAAc,sBAAsB,WAAW;AACrD,QAAO,YAAY,QAAQ,QAAQ,IAAI,CAAC,MAAM;;;;;;;;;;;;;;AAehD,SAAgB,uCAAuC,GAAW;AAChE,QAAO,EAAE,QAAQ,SAAS,IAAI;;;;;;;;;;;;;;;AAgBhC,SAAgB,SAAS,OAAe,WAAmB;AACzD,KAAI,MAAM,UAAU,WAAW;AAC7B,SAAO;;AAET,QAAO,GAAG,MAAM,MAAM,GAAG,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;AChDtC,SAAgB,MAAM,OAAe,MAAuB;AAC1D,KAAI,CAAC,aAAa,EAAE;AAClB;;AAGF,MAAK,MAAM;AAEX,KAAI,CAAC,QAAQ,KAAK,WAAW,GAAG;AAC9B,OAAK,qBAAqB;AAC1B;;CAGF,MAAM,aAAa,OAAO,KAAK,KAAK,GAA8B;CAClE,MAAMC,UAAQ,IAAIC,4BAAM,EACtB,SAAS,WAAW,KAAK,SAAS;EAChC,MAAM;EACN,oCAAmB,iBAAiB,IAAI,CAAC;EACzC,WAAW;EACZ,EAAE,EACJ,CAAC;AAEF,SAAM,QAAQ,KAAmC;AACjD,SAAM,YAAY"}
|
|
1
|
+
{"version":3,"file":"terminal.cjs","names":["code: number","output: string[]","stdoutOutput: string[]","stderrOutput: string[]","text: string","items","originalError: Error","isInCi","spinner","table","Table"],"sources":["../src/terminal/should-print.ts","../src/terminal/ascii.ts","../src/logging/mask-tokens.ts","../src/terminal/cancel.ts","../src/terminal/execute-command.ts","../src/terminal/intro.ts","../src/terminal/note.ts","../src/terminal/list.ts","../src/terminal/outro.ts","../src/terminal/spinner.ts","../src/string.ts","../src/terminal/table.ts"],"sourcesContent":["/**\n * Determines whether terminal output should be printed based on environment variables.\n *\n * **Environment Variable Precedence:**\n * 1. `SETTLEMINT_DISABLE_TERMINAL=\"true\"` - Completely disables all terminal output (highest priority)\n * 2. `CLAUDECODE`, `REPL_ID`, or `AGENT` (any truthy value) - Enables quiet mode, suppressing info/debug/status messages\n *\n * **Quiet Mode Behavior:**\n * When quiet mode is active (Claude Code environments), this function returns `false` to suppress\n * informational output. However, warnings and errors are always displayed regardless of quiet mode,\n * as they are handled separately in the `note()` function with level-based filtering.\n *\n * @returns `true` if terminal output should be printed, `false` if suppressed\n */\nexport function shouldPrint(): boolean {\n if (process.env.SETTLEMINT_DISABLE_TERMINAL === \"true\") {\n return false;\n }\n // In quiet mode (Claude Code), suppress info/debug/status messages\n // Warnings and errors will still be displayed via note() with appropriate levels\n if (process.env.CLAUDECODE || process.env.REPL_ID || process.env.AGENT) {\n return false;\n }\n return true;\n}\n","import { magentaBright } from \"yoctocolors\";\nimport { shouldPrint } from \"./should-print.js\";\n\n/**\n * Prints the SettleMint ASCII art logo to the console in magenta color.\n * Used for CLI branding and visual identification.\n *\n * @example\n * import { ascii } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Prints the SettleMint logo\n * ascii();\n */\nexport const ascii = (): void => {\n if (!shouldPrint()) {\n return;\n }\n console.log(\n magentaBright(`\n _________ __ __ .__ _____ .__ __\n / _____/ _____/ |__/ |_| | ____ / \\\\ |__| _____/ |_\n \\\\_____ \\\\_/ __ \\\\ __\\\\ __\\\\ | _/ __ \\\\ / \\\\ / \\\\| |/ \\\\ __\\\\\n / \\\\ ___/| | | | | |_\\\\ ___// Y \\\\ | | \\\\ |\n/_________/\\\\_____>__| |__| |____/\\\\_____>____|____/__|___|__/__|\n`),\n );\n};\n","/**\n * Masks sensitive SettleMint tokens in output text by replacing them with asterisks.\n * Handles personal access tokens (PAT), application access tokens (AAT), and service account tokens (SAT).\n *\n * @param output - The text string that may contain sensitive tokens\n * @returns The text with any sensitive tokens masked with asterisks\n * @example\n * import { maskTokens } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Masks a token in text\n * const masked = maskTokens(\"Token: sm_pat_****\"); // \"Token: ***\"\n */\nexport const maskTokens = (output: string): string => {\n return output.replace(/sm_(pat|aat|sat)_[0-9a-zA-Z]+/g, \"***\");\n};\n","import { maskTokens } from \"@/logging/mask-tokens.js\";\nimport { inverse, redBright } from \"yoctocolors\";\n\n/**\n * Error class used to indicate that the operation was cancelled.\n * This error is used to signal that the operation should be aborted.\n */\nexport class CancelError extends Error {}\n\n/**\n * Displays an error message in red inverse text and throws a CancelError.\n * Used to terminate execution with a visible error message.\n * Any sensitive tokens in the message are masked before display.\n *\n * @param msg - The error message to display\n * @returns never - Function does not return as it throws an error\n * @example\n * import { cancel } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Exits process with error message\n * cancel(\"An error occurred\");\n */\nexport const cancel = (msg: string): never => {\n console.log(\"\");\n console.log(inverse(redBright(maskTokens(msg))));\n console.log(\"\");\n throw new CancelError(msg);\n};\n","import { type SpawnOptionsWithoutStdio, spawn } from \"node:child_process\";\nimport { maskTokens } from \"../logging/mask-tokens.js\";\n\n/**\n * Options for executing a command, extending SpawnOptionsWithoutStdio\n */\nexport interface ExecuteCommandOptions extends SpawnOptionsWithoutStdio {\n /** Whether to suppress output to stdout/stderr */\n silent?: boolean;\n}\n\n/**\n * Error class for command execution errors\n * @extends Error\n */\nexport class CommandError extends Error {\n /**\n * Constructs a new CommandError\n * @param message - The error message\n * @param code - The exit code of the command\n * @param output - The output of the command\n */\n constructor(\n message: string,\n public readonly code: number,\n public readonly output: string[],\n ) {\n super(message);\n }\n}\n\n/**\n * Checks if we're in quiet mode (Claude Code environment)\n */\nfunction isQuietMode(): boolean {\n return !!(process.env.CLAUDECODE || process.env.REPL_ID || process.env.AGENT);\n}\n\n/**\n * Executes a command with the given arguments in a child process.\n * Pipes stdin to the child process and captures stdout/stderr output.\n * Masks any sensitive tokens in the output before displaying or returning.\n * In quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set),\n * output is suppressed unless the command errors out.\n *\n * @param command - The command to execute\n * @param args - Array of arguments to pass to the command\n * @param options - Options for customizing command execution\n * @returns Array of output strings from stdout and stderr\n * @throws {CommandError} If the process fails to start or exits with non-zero code\n * @example\n * import { executeCommand } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Execute git clone\n * await executeCommand(\"git\", [\"clone\", \"repo-url\"]);\n *\n * // Execute silently\n * await executeCommand(\"npm\", [\"install\"], { silent: true });\n */\nexport async function executeCommand(\n command: string,\n args: string[],\n options?: ExecuteCommandOptions,\n): Promise<string[]> {\n const { silent, ...spawnOptions } = options ?? {};\n const quietMode = isQuietMode();\n // In quiet mode, suppress output unless explicitly overridden with silent: false\n const shouldSuppressOutput = quietMode ? silent !== false : !!silent;\n\n const child = spawn(command, args, { ...spawnOptions, env: { ...process.env, ...options?.env } });\n process.stdin.pipe(child.stdin);\n const output: string[] = [];\n const stdoutOutput: string[] = [];\n const stderrOutput: string[] = [];\n\n return new Promise((resolve, reject) => {\n child.stdout.on(\"data\", (data: Buffer | string) => {\n const maskedData = maskTokens(data.toString());\n if (!shouldSuppressOutput) {\n process.stdout.write(maskedData);\n }\n output.push(maskedData);\n stdoutOutput.push(maskedData);\n });\n child.stderr.on(\"data\", (data: Buffer | string) => {\n const maskedData = maskTokens(data.toString());\n if (!shouldSuppressOutput) {\n process.stderr.write(maskedData);\n }\n output.push(maskedData);\n stderrOutput.push(maskedData);\n });\n\n const showErrorOutput = () => {\n // In quiet mode, show output on error\n if (quietMode && shouldSuppressOutput && output.length > 0) {\n // Write stdout to stdout and stderr to stderr\n if (stdoutOutput.length > 0) {\n process.stdout.write(stdoutOutput.join(\"\"));\n }\n if (stderrOutput.length > 0) {\n process.stderr.write(stderrOutput.join(\"\"));\n }\n }\n };\n\n child.on(\"error\", (err) => {\n process.stdin.unpipe(child.stdin);\n showErrorOutput();\n reject(new CommandError(err.message, \"code\" in err && typeof err.code === \"number\" ? err.code : 1, output));\n });\n child.on(\"close\", (code) => {\n process.stdin.unpipe(child.stdin);\n if (code === 0 || code === null || code === 143) {\n resolve(output);\n return;\n }\n // In quiet mode, show output on error\n showErrorOutput();\n reject(new CommandError(`Command \"${command}\" exited with code ${code}`, code, output));\n });\n });\n}\n","import { maskTokens } from \"@/logging/mask-tokens.js\";\nimport { magentaBright } from \"yoctocolors\";\nimport { shouldPrint } from \"./should-print.js\";\n\n/**\n * Displays an introductory message in magenta text with padding.\n * Any sensitive tokens in the message are masked before display.\n *\n * @param msg - The message to display as introduction\n * @example\n * import { intro } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Display intro message\n * intro(\"Starting deployment...\");\n */\nexport const intro = (msg: string): void => {\n if (!shouldPrint()) {\n return;\n }\n console.log(\"\");\n console.log(magentaBright(maskTokens(msg)));\n console.log(\"\");\n};\n","import { maskTokens } from \"@/logging/mask-tokens.js\";\nimport { redBright, yellowBright } from \"yoctocolors\";\nimport { shouldPrint } from \"./should-print.js\";\n\n/**\n * Applies color to a message if not already colored.\n * @param msg - The message to colorize\n * @param level - The severity level determining the color\n * @returns Colorized message (yellow for warnings, red for errors, unchanged for info)\n */\nfunction colorize(msg: string, level: \"info\" | \"warn\" | \"error\"): string {\n // Don't re-colorize messages that already contain ANSI escape codes\n if (msg.includes(\"\\u001b[\")) {\n return msg;\n }\n if (level === \"warn\") {\n return yellowBright(msg);\n }\n if (level === \"error\") {\n return redBright(msg);\n }\n return msg;\n}\n\n/**\n * Determines whether a message should be printed based on its level and quiet mode.\n * @param level - The severity level of the message\n * @returns true if the message should be printed, false otherwise\n */\nfunction canPrint(level: \"info\" | \"warn\" | \"error\"): boolean {\n // Warnings and errors always print, even in quiet mode\n if (level !== \"info\") {\n return true;\n }\n // Info messages respect shouldPrint() which checks for quiet mode\n return shouldPrint();\n}\n\n/**\n * Prepares a message for display by converting Error objects and masking tokens.\n * @param value - The message string or Error object\n * @param level - The severity level (stack traces are included for errors)\n * @returns Masked message text, optionally with stack trace\n */\nfunction prepareMessage(value: string | Error, level: \"info\" | \"warn\" | \"error\"): string {\n let text: string;\n if (value instanceof Error) {\n text = value.message;\n // For errors, automatically include stack trace\n if (level === \"error\" && value.stack) {\n text = `${text}\\n\\n${value.stack}`;\n }\n } else {\n text = value;\n }\n return maskTokens(text);\n}\n\n/**\n * Displays a note message with optional warning or error level formatting.\n * Regular notes are displayed in normal text, warnings are shown in yellow, and errors in red.\n * Any sensitive tokens in the message are masked before display.\n * Warnings and errors are always displayed, even in quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set).\n * When an Error object is provided with level \"error\", the stack trace is automatically included.\n *\n * @param message - The message to display as a note. Can be either:\n * - A string: Displayed directly with appropriate styling\n * - An Error object: The error message is displayed, and for level \"error\", the stack trace is automatically included\n * @param level - The note level: \"info\" (default), \"warn\" for warning styling, or \"error\" for error styling\n * @example\n * import { note } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Display info note\n * note(\"Operation completed successfully\");\n *\n * // Display warning note\n * note(\"Low disk space remaining\", \"warn\");\n *\n * // Display error note (string)\n * note(\"Operation failed\", \"error\");\n *\n * // Display error with stack trace automatically (Error object)\n * try {\n * // some operation\n * } catch (error) {\n * // If error is an Error object and level is \"error\", stack trace is included automatically\n * note(error, \"error\");\n * }\n */\nexport const note = (message: string | Error, level: \"info\" | \"warn\" | \"error\" = \"info\"): void => {\n if (!canPrint(level)) {\n return;\n }\n\n const msg = prepareMessage(message, level);\n console.log(\"\");\n\n if (level === \"warn\") {\n console.warn(colorize(msg, level));\n } else if (level === \"error\") {\n console.error(colorize(msg, level));\n } else {\n console.log(msg);\n }\n};\n","import { note } from \"./note.js\";\n\n/**\n * Displays a list of items in a formatted manner, supporting nested items.\n *\n * @param title - The title of the list\n * @param items - The items to display, can be strings or arrays for nested items\n * @returns The formatted list\n * @example\n * import { list } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Simple list\n * list(\"Use cases\", [\"use case 1\", \"use case 2\", \"use case 3\"]);\n *\n * // Nested list\n * list(\"Providers\", [\n * \"AWS\",\n * [\"us-east-1\", \"eu-west-1\"],\n * \"Azure\",\n * [\"eastus\", \"westeurope\"]\n * ]);\n */\nexport function list(title: string, items: Array<string | string[]>) {\n const formatItems = (items: Array<string | string[]>): string => {\n return items\n .map((item) => {\n if (Array.isArray(item)) {\n return item.map((subItem) => ` • ${subItem}`).join(\"\\n\");\n }\n return ` • ${item}`;\n })\n .join(\"\\n\");\n };\n\n return note(`${title}:\\n\\n${formatItems(items)}`);\n}\n","import { maskTokens } from \"@/logging/mask-tokens.js\";\nimport { shouldPrint } from \"@/terminal/should-print.js\";\nimport { greenBright, inverse } from \"yoctocolors\";\n\n/**\n * Displays a closing message in green inverted text with padding.\n * Any sensitive tokens in the message are masked before display.\n *\n * @param msg - The message to display as conclusion\n * @example\n * import { outro } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Display outro message\n * outro(\"Deployment completed successfully!\");\n */\nexport const outro = (msg: string): void => {\n if (!shouldPrint()) {\n return;\n }\n console.log(\"\");\n console.log(inverse(greenBright(maskTokens(msg))));\n console.log(\"\");\n};\n","import isInCi from \"is-in-ci\";\nimport yoctoSpinner, { type Spinner } from \"yocto-spinner\";\nimport { redBright } from \"yoctocolors\";\nimport { note } from \"./note.js\";\nimport { shouldPrint } from \"./should-print.js\";\n\n/**\n * Error class used to indicate that the spinner operation failed.\n * This error is used to signal that the operation should be aborted.\n */\nexport class SpinnerError extends Error {\n constructor(\n message: string,\n public readonly originalError: Error,\n ) {\n super(message);\n this.name = \"SpinnerError\";\n }\n}\n\n/**\n * Options for configuring the spinner behavior\n */\nexport interface SpinnerOptions<R> {\n /** Message to display when spinner starts */\n startMessage: string;\n /** Async task to execute while spinner is active */\n task: (spinner?: Spinner) => Promise<R>;\n /** Message to display when spinner completes successfully */\n stopMessage: string;\n}\n\n/**\n * Displays a loading spinner while executing an async task.\n * Shows progress with start/stop messages and handles errors.\n * Spinner is disabled in CI environments.\n *\n * @param options - Configuration options for the spinner\n * @returns The result from the executed task\n * @throws Will exit process with code 1 if task fails\n * @example\n * import { spinner } from \"@settlemint/sdk-utils/terminal\";\n *\n * // Show spinner during async task\n * const result = await spinner({\n * startMessage: \"Deploying...\",\n * task: async () => {\n * // Async work here\n * return \"success\";\n * },\n * stopMessage: \"Deployed successfully!\"\n * });\n */\nexport const spinner = async <R>(options: SpinnerOptions<R>): Promise<R> => {\n const handleError = (error: Error) => {\n note(error, \"error\");\n throw new SpinnerError(error.message, error);\n };\n if (isInCi || !shouldPrint()) {\n try {\n return await options.task();\n } catch (err) {\n return handleError(err as Error);\n }\n }\n const spinner = yoctoSpinner({ stream: process.stdout }).start(options.startMessage);\n try {\n const result = await options.task(spinner);\n spinner.success(options.stopMessage);\n // Ensure spinner success message renders before proceeding to avoid\n // terminal output overlap issues with subsequent messages\n await new Promise((resolve) => process.nextTick(resolve));\n return result;\n } catch (err) {\n spinner.error(redBright(`${options.startMessage} --> Error!`));\n return handleError(err as Error);\n }\n};\n","/**\n * Capitalizes the first letter of a string.\n *\n * @param val - The string to capitalize\n * @returns The input string with its first letter capitalized\n *\n * @example\n * import { capitalizeFirstLetter } from \"@settlemint/sdk-utils\";\n *\n * const capitalized = capitalizeFirstLetter(\"hello\");\n * // Returns: \"Hello\"\n */\nexport function capitalizeFirstLetter(val: string) {\n return String(val).charAt(0).toUpperCase() + String(val).slice(1);\n}\n\n/**\n * Converts a camelCase string to a human-readable string.\n *\n * @param s - The camelCase string to convert\n * @returns The human-readable string\n *\n * @example\n * import { camelCaseToWords } from \"@settlemint/sdk-utils\";\n *\n * const words = camelCaseToWords(\"camelCaseString\");\n * // Returns: \"Camel Case String\"\n */\nexport function camelCaseToWords(s: string) {\n const result = s.replace(/([a-z])([A-Z])/g, \"$1 $2\");\n const withSpaces = result.replace(/([A-Z])([a-z])/g, \" $1$2\");\n const capitalized = capitalizeFirstLetter(withSpaces);\n return capitalized.replace(/\\s+/g, \" \").trim();\n}\n\n/**\n * Replaces underscores and hyphens with spaces.\n *\n * @param s - The string to replace underscores and hyphens with spaces\n * @returns The input string with underscores and hyphens replaced with spaces\n *\n * @example\n * import { replaceUnderscoresAndHyphensWithSpaces } from \"@settlemint/sdk-utils\";\n *\n * const result = replaceUnderscoresAndHyphensWithSpaces(\"Already_Spaced-Second\");\n * // Returns: \"Already Spaced Second\"\n */\nexport function replaceUnderscoresAndHyphensWithSpaces(s: string) {\n return s.replace(/[-_]/g, \" \");\n}\n\n/**\n * Truncates a string to a maximum length and appends \"...\" if it is longer.\n *\n * @param value - The string to truncate\n * @param maxLength - The maximum length of the string\n * @returns The truncated string or the original string if it is shorter than the maximum length\n *\n * @example\n * import { truncate } from \"@settlemint/sdk-utils\";\n *\n * const truncated = truncate(\"Hello, world!\", 10);\n * // Returns: \"Hello, wor...\"\n */\nexport function truncate(value: string, maxLength: number) {\n if (value.length <= maxLength) {\n return value;\n }\n return `${value.slice(0, maxLength)}...`;\n}\n","import { Table } from \"console-table-printer\";\nimport { whiteBright } from \"yoctocolors\";\nimport { camelCaseToWords } from \"@/string.js\";\nimport { note } from \"./note.js\";\nimport { shouldPrint } from \"./should-print.js\";\n/**\n * Displays data in a formatted table in the terminal.\n *\n * @param title - Title to display above the table\n * @param data - Array of objects to display in table format\n * @example\n * import { table } from \"@settlemint/sdk-utils/terminal\";\n *\n * const data = [\n * { name: \"Item 1\", value: 100 },\n * { name: \"Item 2\", value: 200 }\n * ];\n *\n * table(\"My Table\", data);\n */\nexport function table(title: string, data: unknown[]): void {\n if (!shouldPrint()) {\n return;\n }\n\n note(title);\n\n if (!data || data.length === 0) {\n note(\"No data to display\");\n return;\n }\n\n const columnKeys = Object.keys(data[0] as Record<string, unknown>);\n const table = new Table({\n columns: columnKeys.map((key) => ({\n name: key,\n title: whiteBright(camelCaseToWords(key)),\n alignment: \"left\",\n })),\n });\n // biome-ignore lint/suspicious/noExplicitAny: Data structure varies based on table content\n table.addRows(data as Array<Record<string, any>>);\n table.printTable();\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAcA,SAAgB,cAAuB;AACrC,KAAI,QAAQ,IAAI,gCAAgC,QAAQ;AACtD,SAAO;;AAIT,KAAI,QAAQ,IAAI,cAAc,QAAQ,IAAI,WAAW,QAAQ,IAAI,OAAO;AACtE,SAAO;;AAET,QAAO;;;;;;;;;;;;;;;ACVT,MAAa,cAAoB;AAC/B,KAAI,CAAC,aAAa,EAAE;AAClB;;AAEF,SAAQ,mCACQ;;;;;;EAMhB,CACC;;;;;;;;;;;;;;;;;ACbH,MAAa,cAAc,WAA2B;AACpD,QAAO,OAAO,QAAQ,kCAAkC,MAAM;;;;;;;;;ACNhE,IAAa,cAAb,cAAiC,MAAM;;;;;;;;;;;;;;AAevC,MAAa,UAAU,QAAuB;AAC5C,SAAQ,IAAI,GAAG;AACf,SAAQ,wDAAsB,WAAW,IAAI,CAAC,CAAC,CAAC;AAChD,SAAQ,IAAI,GAAG;AACf,OAAM,IAAI,YAAY,IAAI;;;;;;;;;ACX5B,IAAa,eAAb,cAAkC,MAAM;;;;;;;CAOtC,YACE,SACA,AAAgBA,MAChB,AAAgBC,QAChB;AACA,QAAM,QAAQ;EAHE;EACA;;;;;;AASpB,SAAS,cAAuB;AAC9B,QAAO,CAAC,EAAE,QAAQ,IAAI,cAAc,QAAQ,IAAI,WAAW,QAAQ,IAAI;;;;;;;;;;;;;;;;;;;;;;;AAwBzE,eAAsB,eACpB,SACA,MACA,SACmB;CACnB,MAAM,EAAE,OAAQ,GAAG,iBAAiB,WAAW,EAAE;CACjD,MAAM,YAAY,aAAa;CAE/B,MAAM,uBAAuB,YAAY,WAAW,QAAQ,CAAC,CAAC;CAE9D,MAAM,sCAAc,SAAS,MAAM;EAAE,GAAG;EAAc,KAAK;GAAE,GAAG,QAAQ;GAAK,GAAG,SAAS;GAAK;EAAE,CAAC;AACjG,SAAQ,MAAM,KAAK,MAAM,MAAM;CAC/B,MAAMA,SAAmB,EAAE;CAC3B,MAAMC,eAAyB,EAAE;CACjC,MAAMC,eAAyB,EAAE;AAEjC,QAAO,IAAI,SAAS,SAAS,WAAW;AACtC,QAAM,OAAO,GAAG,SAAS,SAA0B;GACjD,MAAM,aAAa,WAAW,KAAK,UAAU,CAAC;AAC9C,OAAI,CAAC,sBAAsB;AACzB,YAAQ,OAAO,MAAM,WAAW;;AAElC,UAAO,KAAK,WAAW;AACvB,gBAAa,KAAK,WAAW;IAC7B;AACF,QAAM,OAAO,GAAG,SAAS,SAA0B;GACjD,MAAM,aAAa,WAAW,KAAK,UAAU,CAAC;AAC9C,OAAI,CAAC,sBAAsB;AACzB,YAAQ,OAAO,MAAM,WAAW;;AAElC,UAAO,KAAK,WAAW;AACvB,gBAAa,KAAK,WAAW;IAC7B;EAEF,MAAM,wBAAwB;AAE5B,OAAI,aAAa,wBAAwB,OAAO,SAAS,GAAG;AAE1D,QAAI,aAAa,SAAS,GAAG;AAC3B,aAAQ,OAAO,MAAM,aAAa,KAAK,GAAG,CAAC;;AAE7C,QAAI,aAAa,SAAS,GAAG;AAC3B,aAAQ,OAAO,MAAM,aAAa,KAAK,GAAG,CAAC;;;;AAKjD,QAAM,GAAG,UAAU,QAAQ;AACzB,WAAQ,MAAM,OAAO,MAAM,MAAM;AACjC,oBAAiB;AACjB,UAAO,IAAI,aAAa,IAAI,SAAS,UAAU,OAAO,OAAO,IAAI,SAAS,WAAW,IAAI,OAAO,GAAG,OAAO,CAAC;IAC3G;AACF,QAAM,GAAG,UAAU,SAAS;AAC1B,WAAQ,MAAM,OAAO,MAAM,MAAM;AACjC,OAAI,SAAS,KAAK,SAAS,QAAQ,SAAS,KAAK;AAC/C,YAAQ,OAAO;AACf;;AAGF,oBAAiB;AACjB,UAAO,IAAI,aAAa,YAAY,QAAQ,qBAAqB,QAAQ,MAAM,OAAO,CAAC;IACvF;GACF;;;;;;;;;;;;;;;;AC1GJ,MAAa,SAAS,QAAsB;AAC1C,KAAI,CAAC,aAAa,EAAE;AAClB;;AAEF,SAAQ,IAAI,GAAG;AACf,SAAQ,mCAAkB,WAAW,IAAI,CAAC,CAAC;AAC3C,SAAQ,IAAI,GAAG;;;;;;;;;;;ACXjB,SAAS,SAAS,KAAa,OAA0C;AAEvE,KAAI,IAAI,SAAS,QAAU,EAAE;AAC3B,SAAO;;AAET,KAAI,UAAU,QAAQ;AACpB,uCAAoB,IAAI;;AAE1B,KAAI,UAAU,SAAS;AACrB,oCAAiB,IAAI;;AAEvB,QAAO;;;;;;;AAQT,SAAS,SAAS,OAA2C;AAE3D,KAAI,UAAU,QAAQ;AACpB,SAAO;;AAGT,QAAO,aAAa;;;;;;;;AAStB,SAAS,eAAe,OAAuB,OAA0C;CACvF,IAAIC;AACJ,KAAI,iBAAiB,OAAO;AAC1B,SAAO,MAAM;AAEb,MAAI,UAAU,WAAW,MAAM,OAAO;AACpC,UAAO,GAAG,KAAK,MAAM,MAAM;;QAExB;AACL,SAAO;;AAET,QAAO,WAAW,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCzB,MAAa,QAAQ,SAAyB,QAAmC,WAAiB;AAChG,KAAI,CAAC,SAAS,MAAM,EAAE;AACpB;;CAGF,MAAM,MAAM,eAAe,SAAS,MAAM;AAC1C,SAAQ,IAAI,GAAG;AAEf,KAAI,UAAU,QAAQ;AACpB,UAAQ,KAAK,SAAS,KAAK,MAAM,CAAC;YACzB,UAAU,SAAS;AAC5B,UAAQ,MAAM,SAAS,KAAK,MAAM,CAAC;QAC9B;AACL,UAAQ,IAAI,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;AChFpB,SAAgB,KAAK,OAAe,OAAiC;CACnE,MAAM,eAAe,YAA4C;AAC/D,SAAOC,QACJ,KAAK,SAAS;AACb,OAAI,MAAM,QAAQ,KAAK,EAAE;AACvB,WAAO,KAAK,KAAK,YAAY,SAAS,UAAU,CAAC,KAAK,KAAK;;AAE7D,UAAO,OAAO;IACd,CACD,KAAK,KAAK;;AAGf,QAAO,KAAK,GAAG,MAAM,OAAO,YAAY,MAAM,GAAG;;;;;;;;;;;;;;;;ACnBnD,MAAa,SAAS,QAAsB;AAC1C,KAAI,CAAC,aAAa,EAAE;AAClB;;AAEF,SAAQ,IAAI,GAAG;AACf,SAAQ,0DAAwB,WAAW,IAAI,CAAC,CAAC,CAAC;AAClD,SAAQ,IAAI,GAAG;;;;;;;;;ACXjB,IAAa,eAAb,cAAkC,MAAM;CACtC,YACE,SACA,AAAgBC,eAChB;AACA,QAAM,QAAQ;EAFE;AAGhB,OAAK,OAAO;;;;;;;;;;;;;;;;;;;;;;;;AAqChB,MAAa,UAAU,OAAU,YAA2C;CAC1E,MAAM,eAAe,UAAiB;AACpC,OAAK,OAAO,QAAQ;AACpB,QAAM,IAAI,aAAa,MAAM,SAAS,MAAM;;AAE9C,KAAIC,oBAAU,CAAC,aAAa,EAAE;AAC5B,MAAI;AACF,UAAO,MAAM,QAAQ,MAAM;WACpB,KAAK;AACZ,UAAO,YAAY,IAAa;;;CAGpC,MAAMC,uCAAuB,EAAE,QAAQ,QAAQ,QAAQ,CAAC,CAAC,MAAM,QAAQ,aAAa;AACpF,KAAI;EACF,MAAM,SAAS,MAAM,QAAQ,KAAKA,UAAQ;AAC1C,YAAQ,QAAQ,QAAQ,YAAY;AAGpC,QAAM,IAAI,SAAS,YAAY,QAAQ,SAAS,QAAQ,CAAC;AACzD,SAAO;UACA,KAAK;AACZ,YAAQ,iCAAgB,GAAG,QAAQ,aAAa,aAAa,CAAC;AAC9D,SAAO,YAAY,IAAa;;;;;;;;;;;;;;;;;;AC/DpC,SAAgB,sBAAsB,KAAa;AACjD,QAAO,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC,aAAa,GAAG,OAAO,IAAI,CAAC,MAAM,EAAE;;;;;;;;;;;;;;AAenE,SAAgB,iBAAiB,GAAW;CAC1C,MAAM,SAAS,EAAE,QAAQ,mBAAmB,QAAQ;CACpD,MAAM,aAAa,OAAO,QAAQ,mBAAmB,QAAQ;CAC7D,MAAM,cAAc,sBAAsB,WAAW;AACrD,QAAO,YAAY,QAAQ,QAAQ,IAAI,CAAC,MAAM;;;;;;;;;;;;;;AAehD,SAAgB,uCAAuC,GAAW;AAChE,QAAO,EAAE,QAAQ,SAAS,IAAI;;;;;;;;;;;;;;;AAgBhC,SAAgB,SAAS,OAAe,WAAmB;AACzD,KAAI,MAAM,UAAU,WAAW;AAC7B,SAAO;;AAET,QAAO,GAAG,MAAM,MAAM,GAAG,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;AChDtC,SAAgB,MAAM,OAAe,MAAuB;AAC1D,KAAI,CAAC,aAAa,EAAE;AAClB;;AAGF,MAAK,MAAM;AAEX,KAAI,CAAC,QAAQ,KAAK,WAAW,GAAG;AAC9B,OAAK,qBAAqB;AAC1B;;CAGF,MAAM,aAAa,OAAO,KAAK,KAAK,GAA8B;CAClE,MAAMC,UAAQ,IAAIC,4BAAM,EACtB,SAAS,WAAW,KAAK,SAAS;EAChC,MAAM;EACN,oCAAmB,iBAAiB,IAAI,CAAC;EACzC,WAAW;EACZ,EAAE,EACJ,CAAC;AAEF,SAAM,QAAQ,KAAmC;AACjD,SAAM,YAAY"}
|
package/dist/terminal.d.cts
CHANGED
|
@@ -63,6 +63,8 @@ declare class CommandError extends Error {
|
|
|
63
63
|
* Executes a command with the given arguments in a child process.
|
|
64
64
|
* Pipes stdin to the child process and captures stdout/stderr output.
|
|
65
65
|
* Masks any sensitive tokens in the output before displaying or returning.
|
|
66
|
+
* In quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set),
|
|
67
|
+
* output is suppressed unless the command errors out.
|
|
66
68
|
*
|
|
67
69
|
* @param command - The command to execute
|
|
68
70
|
* @param args - Array of arguments to pass to the command
|
|
@@ -119,12 +121,16 @@ declare function list(title: string, items: Array<string | string[]>): void;
|
|
|
119
121
|
//#endregion
|
|
120
122
|
//#region src/terminal/note.d.ts
|
|
121
123
|
/**
|
|
122
|
-
* Displays a note message with optional warning level formatting.
|
|
123
|
-
* Regular notes are displayed in normal text,
|
|
124
|
+
* Displays a note message with optional warning or error level formatting.
|
|
125
|
+
* Regular notes are displayed in normal text, warnings are shown in yellow, and errors in red.
|
|
124
126
|
* Any sensitive tokens in the message are masked before display.
|
|
127
|
+
* Warnings and errors are always displayed, even in quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set).
|
|
128
|
+
* When an Error object is provided with level "error", the stack trace is automatically included.
|
|
125
129
|
*
|
|
126
|
-
* @param message - The message to display as a note
|
|
127
|
-
*
|
|
130
|
+
* @param message - The message to display as a note. Can be either:
|
|
131
|
+
* - A string: Displayed directly with appropriate styling
|
|
132
|
+
* - An Error object: The error message is displayed, and for level "error", the stack trace is automatically included
|
|
133
|
+
* @param level - The note level: "info" (default), "warn" for warning styling, or "error" for error styling
|
|
128
134
|
* @example
|
|
129
135
|
* import { note } from "@settlemint/sdk-utils/terminal";
|
|
130
136
|
*
|
|
@@ -133,8 +139,19 @@ declare function list(title: string, items: Array<string | string[]>): void;
|
|
|
133
139
|
*
|
|
134
140
|
* // Display warning note
|
|
135
141
|
* note("Low disk space remaining", "warn");
|
|
142
|
+
*
|
|
143
|
+
* // Display error note (string)
|
|
144
|
+
* note("Operation failed", "error");
|
|
145
|
+
*
|
|
146
|
+
* // Display error with stack trace automatically (Error object)
|
|
147
|
+
* try {
|
|
148
|
+
* // some operation
|
|
149
|
+
* } catch (error) {
|
|
150
|
+
* // If error is an Error object and level is "error", stack trace is included automatically
|
|
151
|
+
* note(error, "error");
|
|
152
|
+
* }
|
|
136
153
|
*/
|
|
137
|
-
declare const note: (message: string, level?: "info" | "warn") => void;
|
|
154
|
+
declare const note: (message: string | Error, level?: "info" | "warn" | "error") => void;
|
|
138
155
|
//#endregion
|
|
139
156
|
//#region src/terminal/outro.d.ts
|
|
140
157
|
/**
|
package/dist/terminal.d.ts
CHANGED
|
@@ -63,6 +63,8 @@ declare class CommandError extends Error {
|
|
|
63
63
|
* Executes a command with the given arguments in a child process.
|
|
64
64
|
* Pipes stdin to the child process and captures stdout/stderr output.
|
|
65
65
|
* Masks any sensitive tokens in the output before displaying or returning.
|
|
66
|
+
* In quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set),
|
|
67
|
+
* output is suppressed unless the command errors out.
|
|
66
68
|
*
|
|
67
69
|
* @param command - The command to execute
|
|
68
70
|
* @param args - Array of arguments to pass to the command
|
|
@@ -119,12 +121,16 @@ declare function list(title: string, items: Array<string | string[]>): void;
|
|
|
119
121
|
//#endregion
|
|
120
122
|
//#region src/terminal/note.d.ts
|
|
121
123
|
/**
|
|
122
|
-
* Displays a note message with optional warning level formatting.
|
|
123
|
-
* Regular notes are displayed in normal text,
|
|
124
|
+
* Displays a note message with optional warning or error level formatting.
|
|
125
|
+
* Regular notes are displayed in normal text, warnings are shown in yellow, and errors in red.
|
|
124
126
|
* Any sensitive tokens in the message are masked before display.
|
|
127
|
+
* Warnings and errors are always displayed, even in quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set).
|
|
128
|
+
* When an Error object is provided with level "error", the stack trace is automatically included.
|
|
125
129
|
*
|
|
126
|
-
* @param message - The message to display as a note
|
|
127
|
-
*
|
|
130
|
+
* @param message - The message to display as a note. Can be either:
|
|
131
|
+
* - A string: Displayed directly with appropriate styling
|
|
132
|
+
* - An Error object: The error message is displayed, and for level "error", the stack trace is automatically included
|
|
133
|
+
* @param level - The note level: "info" (default), "warn" for warning styling, or "error" for error styling
|
|
128
134
|
* @example
|
|
129
135
|
* import { note } from "@settlemint/sdk-utils/terminal";
|
|
130
136
|
*
|
|
@@ -133,8 +139,19 @@ declare function list(title: string, items: Array<string | string[]>): void;
|
|
|
133
139
|
*
|
|
134
140
|
* // Display warning note
|
|
135
141
|
* note("Low disk space remaining", "warn");
|
|
142
|
+
*
|
|
143
|
+
* // Display error note (string)
|
|
144
|
+
* note("Operation failed", "error");
|
|
145
|
+
*
|
|
146
|
+
* // Display error with stack trace automatically (Error object)
|
|
147
|
+
* try {
|
|
148
|
+
* // some operation
|
|
149
|
+
* } catch (error) {
|
|
150
|
+
* // If error is an Error object and level is "error", stack trace is included automatically
|
|
151
|
+
* note(error, "error");
|
|
152
|
+
* }
|
|
136
153
|
*/
|
|
137
|
-
declare const note: (message: string, level?: "info" | "warn") => void;
|
|
154
|
+
declare const note: (message: string | Error, level?: "info" | "warn" | "error") => void;
|
|
138
155
|
//#endregion
|
|
139
156
|
//#region src/terminal/outro.d.ts
|
|
140
157
|
/**
|
package/dist/terminal.js
CHANGED
|
@@ -6,11 +6,27 @@ import { Table } from "console-table-printer";
|
|
|
6
6
|
|
|
7
7
|
//#region src/terminal/should-print.ts
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
10
|
-
*
|
|
9
|
+
* Determines whether terminal output should be printed based on environment variables.
|
|
10
|
+
*
|
|
11
|
+
* **Environment Variable Precedence:**
|
|
12
|
+
* 1. `SETTLEMINT_DISABLE_TERMINAL="true"` - Completely disables all terminal output (highest priority)
|
|
13
|
+
* 2. `CLAUDECODE`, `REPL_ID`, or `AGENT` (any truthy value) - Enables quiet mode, suppressing info/debug/status messages
|
|
14
|
+
*
|
|
15
|
+
* **Quiet Mode Behavior:**
|
|
16
|
+
* When quiet mode is active (Claude Code environments), this function returns `false` to suppress
|
|
17
|
+
* informational output. However, warnings and errors are always displayed regardless of quiet mode,
|
|
18
|
+
* as they are handled separately in the `note()` function with level-based filtering.
|
|
19
|
+
*
|
|
20
|
+
* @returns `true` if terminal output should be printed, `false` if suppressed
|
|
11
21
|
*/
|
|
12
22
|
function shouldPrint() {
|
|
13
|
-
|
|
23
|
+
if (process.env.SETTLEMINT_DISABLE_TERMINAL === "true") {
|
|
24
|
+
return false;
|
|
25
|
+
}
|
|
26
|
+
if (process.env.CLAUDECODE || process.env.REPL_ID || process.env.AGENT) {
|
|
27
|
+
return false;
|
|
28
|
+
}
|
|
29
|
+
return true;
|
|
14
30
|
}
|
|
15
31
|
|
|
16
32
|
//#endregion
|
|
@@ -103,9 +119,17 @@ var CommandError = class extends Error {
|
|
|
103
119
|
}
|
|
104
120
|
};
|
|
105
121
|
/**
|
|
122
|
+
* Checks if we're in quiet mode (Claude Code environment)
|
|
123
|
+
*/
|
|
124
|
+
function isQuietMode() {
|
|
125
|
+
return !!(process.env.CLAUDECODE || process.env.REPL_ID || process.env.AGENT);
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
106
128
|
* Executes a command with the given arguments in a child process.
|
|
107
129
|
* Pipes stdin to the child process and captures stdout/stderr output.
|
|
108
130
|
* Masks any sensitive tokens in the output before displaying or returning.
|
|
131
|
+
* In quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set),
|
|
132
|
+
* output is suppressed unless the command errors out.
|
|
109
133
|
*
|
|
110
134
|
* @param command - The command to execute
|
|
111
135
|
* @param args - Array of arguments to pass to the command
|
|
@@ -123,6 +147,8 @@ var CommandError = class extends Error {
|
|
|
123
147
|
*/
|
|
124
148
|
async function executeCommand(command, args, options) {
|
|
125
149
|
const { silent,...spawnOptions } = options ?? {};
|
|
150
|
+
const quietMode = isQuietMode();
|
|
151
|
+
const shouldSuppressOutput = quietMode ? silent !== false : !!silent;
|
|
126
152
|
const child = spawn(command, args, {
|
|
127
153
|
...spawnOptions,
|
|
128
154
|
env: {
|
|
@@ -132,23 +158,38 @@ async function executeCommand(command, args, options) {
|
|
|
132
158
|
});
|
|
133
159
|
process.stdin.pipe(child.stdin);
|
|
134
160
|
const output = [];
|
|
161
|
+
const stdoutOutput = [];
|
|
162
|
+
const stderrOutput = [];
|
|
135
163
|
return new Promise((resolve, reject) => {
|
|
136
164
|
child.stdout.on("data", (data) => {
|
|
137
165
|
const maskedData = maskTokens(data.toString());
|
|
138
|
-
if (!
|
|
166
|
+
if (!shouldSuppressOutput) {
|
|
139
167
|
process.stdout.write(maskedData);
|
|
140
168
|
}
|
|
141
169
|
output.push(maskedData);
|
|
170
|
+
stdoutOutput.push(maskedData);
|
|
142
171
|
});
|
|
143
172
|
child.stderr.on("data", (data) => {
|
|
144
173
|
const maskedData = maskTokens(data.toString());
|
|
145
|
-
if (!
|
|
174
|
+
if (!shouldSuppressOutput) {
|
|
146
175
|
process.stderr.write(maskedData);
|
|
147
176
|
}
|
|
148
177
|
output.push(maskedData);
|
|
178
|
+
stderrOutput.push(maskedData);
|
|
149
179
|
});
|
|
180
|
+
const showErrorOutput = () => {
|
|
181
|
+
if (quietMode && shouldSuppressOutput && output.length > 0) {
|
|
182
|
+
if (stdoutOutput.length > 0) {
|
|
183
|
+
process.stdout.write(stdoutOutput.join(""));
|
|
184
|
+
}
|
|
185
|
+
if (stderrOutput.length > 0) {
|
|
186
|
+
process.stderr.write(stderrOutput.join(""));
|
|
187
|
+
}
|
|
188
|
+
}
|
|
189
|
+
};
|
|
150
190
|
child.on("error", (err) => {
|
|
151
191
|
process.stdin.unpipe(child.stdin);
|
|
192
|
+
showErrorOutput();
|
|
152
193
|
reject(new CommandError(err.message, "code" in err && typeof err.code === "number" ? err.code : 1, output));
|
|
153
194
|
});
|
|
154
195
|
child.on("close", (code) => {
|
|
@@ -157,6 +198,7 @@ async function executeCommand(command, args, options) {
|
|
|
157
198
|
resolve(output);
|
|
158
199
|
return;
|
|
159
200
|
}
|
|
201
|
+
showErrorOutput();
|
|
160
202
|
reject(new CommandError(`Command "${command}" exited with code ${code}`, code, output));
|
|
161
203
|
});
|
|
162
204
|
});
|
|
@@ -187,12 +229,63 @@ const intro = (msg) => {
|
|
|
187
229
|
//#endregion
|
|
188
230
|
//#region src/terminal/note.ts
|
|
189
231
|
/**
|
|
190
|
-
*
|
|
191
|
-
*
|
|
232
|
+
* Applies color to a message if not already colored.
|
|
233
|
+
* @param msg - The message to colorize
|
|
234
|
+
* @param level - The severity level determining the color
|
|
235
|
+
* @returns Colorized message (yellow for warnings, red for errors, unchanged for info)
|
|
236
|
+
*/
|
|
237
|
+
function colorize(msg, level) {
|
|
238
|
+
if (msg.includes("\x1B[")) {
|
|
239
|
+
return msg;
|
|
240
|
+
}
|
|
241
|
+
if (level === "warn") {
|
|
242
|
+
return yellowBright(msg);
|
|
243
|
+
}
|
|
244
|
+
if (level === "error") {
|
|
245
|
+
return redBright(msg);
|
|
246
|
+
}
|
|
247
|
+
return msg;
|
|
248
|
+
}
|
|
249
|
+
/**
|
|
250
|
+
* Determines whether a message should be printed based on its level and quiet mode.
|
|
251
|
+
* @param level - The severity level of the message
|
|
252
|
+
* @returns true if the message should be printed, false otherwise
|
|
253
|
+
*/
|
|
254
|
+
function canPrint(level) {
|
|
255
|
+
if (level !== "info") {
|
|
256
|
+
return true;
|
|
257
|
+
}
|
|
258
|
+
return shouldPrint();
|
|
259
|
+
}
|
|
260
|
+
/**
|
|
261
|
+
* Prepares a message for display by converting Error objects and masking tokens.
|
|
262
|
+
* @param value - The message string or Error object
|
|
263
|
+
* @param level - The severity level (stack traces are included for errors)
|
|
264
|
+
* @returns Masked message text, optionally with stack trace
|
|
265
|
+
*/
|
|
266
|
+
function prepareMessage(value, level) {
|
|
267
|
+
let text;
|
|
268
|
+
if (value instanceof Error) {
|
|
269
|
+
text = value.message;
|
|
270
|
+
if (level === "error" && value.stack) {
|
|
271
|
+
text = `${text}\n\n${value.stack}`;
|
|
272
|
+
}
|
|
273
|
+
} else {
|
|
274
|
+
text = value;
|
|
275
|
+
}
|
|
276
|
+
return maskTokens(text);
|
|
277
|
+
}
|
|
278
|
+
/**
|
|
279
|
+
* Displays a note message with optional warning or error level formatting.
|
|
280
|
+
* Regular notes are displayed in normal text, warnings are shown in yellow, and errors in red.
|
|
192
281
|
* Any sensitive tokens in the message are masked before display.
|
|
282
|
+
* Warnings and errors are always displayed, even in quiet mode (when CLAUDECODE, REPL_ID, or AGENT env vars are set).
|
|
283
|
+
* When an Error object is provided with level "error", the stack trace is automatically included.
|
|
193
284
|
*
|
|
194
|
-
* @param message - The message to display as a note
|
|
195
|
-
*
|
|
285
|
+
* @param message - The message to display as a note. Can be either:
|
|
286
|
+
* - A string: Displayed directly with appropriate styling
|
|
287
|
+
* - An Error object: The error message is displayed, and for level "error", the stack trace is automatically included
|
|
288
|
+
* @param level - The note level: "info" (default), "warn" for warning styling, or "error" for error styling
|
|
196
289
|
* @example
|
|
197
290
|
* import { note } from "@settlemint/sdk-utils/terminal";
|
|
198
291
|
*
|
|
@@ -201,18 +294,31 @@ const intro = (msg) => {
|
|
|
201
294
|
*
|
|
202
295
|
* // Display warning note
|
|
203
296
|
* note("Low disk space remaining", "warn");
|
|
297
|
+
*
|
|
298
|
+
* // Display error note (string)
|
|
299
|
+
* note("Operation failed", "error");
|
|
300
|
+
*
|
|
301
|
+
* // Display error with stack trace automatically (Error object)
|
|
302
|
+
* try {
|
|
303
|
+
* // some operation
|
|
304
|
+
* } catch (error) {
|
|
305
|
+
* // If error is an Error object and level is "error", stack trace is included automatically
|
|
306
|
+
* note(error, "error");
|
|
307
|
+
* }
|
|
204
308
|
*/
|
|
205
309
|
const note = (message, level = "info") => {
|
|
206
|
-
if (!
|
|
310
|
+
if (!canPrint(level)) {
|
|
207
311
|
return;
|
|
208
312
|
}
|
|
209
|
-
const
|
|
313
|
+
const msg = prepareMessage(message, level);
|
|
210
314
|
console.log("");
|
|
211
315
|
if (level === "warn") {
|
|
212
|
-
console.warn(
|
|
213
|
-
|
|
316
|
+
console.warn(colorize(msg, level));
|
|
317
|
+
} else if (level === "error") {
|
|
318
|
+
console.error(colorize(msg, level));
|
|
319
|
+
} else {
|
|
320
|
+
console.log(msg);
|
|
214
321
|
}
|
|
215
|
-
console.log(maskedMessage);
|
|
216
322
|
};
|
|
217
323
|
|
|
218
324
|
//#endregion
|
|
@@ -307,9 +413,8 @@ var SpinnerError = class extends Error {
|
|
|
307
413
|
*/
|
|
308
414
|
const spinner = async (options) => {
|
|
309
415
|
const handleError = (error) => {
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
throw new SpinnerError(errorMessage, error);
|
|
416
|
+
note(error, "error");
|
|
417
|
+
throw new SpinnerError(error.message, error);
|
|
313
418
|
};
|
|
314
419
|
if (isInCi || !shouldPrint()) {
|
|
315
420
|
try {
|