@chabokan.net/cli 0.8.10 → 0.9.0

package/dist/ui.js

@@ -0,0 +1,70 @@
+import chalk from 'chalk';
+import { printTable } from '@oclif/table';
+// Windows terminals outside Windows Terminal often cannot render these glyphs.
+const richGlyphs = process.platform !== 'win32' || Boolean(process.env.WT_SESSION);
+const symbols = {
+    success: richGlyphs ? '✔' : 'v',
+    error: richGlyphs ? '✖' : 'x',
+    warning: richGlyphs ? '⚠' : '!',
+    info: richGlyphs ? 'ℹ' : 'i',
+    arrow: richGlyphs ? '→' : '->',
+};
+export function success(message) {
+    return `${chalk.green(symbols.success)} ${message}`;
+}
+export function error(message) {
+    return `${chalk.red(symbols.error)} ${message}`;
+}
+export function warning(message) {
+    return `${chalk.yellow(symbols.warning)} ${message}`;
+}
+export function info(message) {
+    return `${chalk.cyan(symbols.info)} ${message}`;
+}
+/** A dimmed follow-up line telling the user what to do next. */
+export function hint(message) {
+    return chalk.dim(`  ${symbols.arrow} ${message}`);
+}
+/** Highlights a command the user is meant to run. */
+export function cmd(command) {
+    return chalk.cyan(command);
+}
+/** Highlights a value the user supplied or chose, such as a service name. */
+export function value(text) {
+    return chalk.bold(text);
+}
+function formatCell(cellValue) {
+    if (cellValue === null || cellValue === undefined) {
+        return '';
+    }
+    if (typeof cellValue === 'object') {
+        return JSON.stringify(cellValue);
+    }
+    return String(cellValue);
+}
+/**
+ * Renders an array of API records as a table without assuming which fields
+ * it contains — the columns are whichever keys are present on the first row.
+ * Used for endpoints whose response shape isn't fixed enough to hard-code a
+ * column list against.
+ */
+export function printRecords(records) {
+    const columns = [...new Set(records.flatMap((record) => Object.keys(record)))];
+    const data = records.map((record) => {
+        const row = {};
+        for (const column of columns) {
+            row[column] = formatCell(record[column]);
+        }
+        return row;
+    });
+    printTable({ data, columns });
+}
+/**
+ * Renders a single API record as Field/Value rows. Preferred over
+ * `printRecords` for one object with many fields, which would otherwise
+ * produce one very wide, mostly-empty table.
+ */
+export function printRecord(record) {
+    const data = Object.entries(record).map(([Field, val]) => ({ Field, Value: formatCell(val) }));
+    printTable({ data, columns: ['Field', 'Value'] });
+}