@awsless/clui 0.0.5 → 0.0.7

package/README.MD

@@ -0,0 +1,87 @@
+
+# @awsless/clui
+
+The @awsless/clui package combines a couple of useful npm packages to create easy to use & beautiful terminal applications.
+
+Special thanks to:
+- @clack/prompts
+- cli-table3
+- chalk
+
+## Setup
+
+Install with (NPM):
+
+```
+npm i @awsless/clui
+```
+
+## Basic Usage
+
+```ts
+import { log, prompt, color } from '@awsless/clui';
+
+log.intro(color.blue.bold('Create a blog post'))
+
+const title = await prompt.text({ message: 'Title:' })
+const message = await prompt.text({ message: 'Message:' })
+
+log.list('Preview post', {
+	title,
+	message,
+})
+
+const ok = await prompt.confirm({ message: 'Are you sure?' })
+
+if(!ok) {
+	log.error('Canceled')
+	return
+}
+
+await log.task({
+	initialMessage: 'Creating post...',
+	successMessage: 'You blog post was successfully created!',
+	async task() {
+		// Create your blog post
+	}
+})
+
+log.outro('The end!')
+
+```
+
+## Supported Prompts
+
+- prompt.text
+- prompt.password
+- prompt.integer
+- prompt.float
+- prompt.confirm
+- prompt.select
+- prompt.multiSelect
+
+## Supported Logs
+
+- log.intro
+- log.outro
+- log.note
+- log.message
+- log.step
+- log.info
+- log.warning
+- log.error
+- log.success
+- log.list
+- log.table
+- log.task
+
+## Supported Ansi Helpers:
+
+- ansi.wrap
+- ansi.length
+- ansi.truncate
+- ansi.pad
+
+## License
+
+MIT

package/dist/index.cjs

@@ -42,17 +42,21 @@ module.exports = __toCommonJS(index_exports);
 // src/symbols.ts
 var symbols_exports = {};
 __export(symbols_exports, {
+  ellipsis: () => ellipsis,
   error: () => error,
   info: () => info,
+  message: () => message,
   step: () => step,
   success: () => success,
   warning: () => warning
 });
+var message = "\u2502";
 var step = "\u25C7";
 var error = "\xD7";
 var success = "\u25C6";
 var warning = "\u25B2";
 var info = "\xB7";
+var ellipsis = "\u2026";
 
 // src/prompts.ts
 var prompts_exports = {};
@@ -144,7 +148,7 @@ __export(logs_exports, {
   info: () => info2,
   intro: () => intro,
   list: () => list,
-  message: () => message,
+  message: () => message2,
   note: () => note,
   outro: () => outro,
   step: () => step2,
@@ -159,25 +163,26 @@ var import_cli_table3 = __toESM(require("cli-table3"), 1);
 // src/ansi.ts
 var ansi_exports = {};
 __export(ansi_exports, {
-  padString: () => padString,
-  stringLength: () => import_string_length.default,
-  subString: () => subString,
-  wrapString: () => wrapString
+  length: () => length,
+  pad: () => pad,
+  truncate: () => truncate,
+  wrap: () => wrap
 });
-var import_ansi_substring = __toESM(require("ansi-substring"), 1);
+var import_ansi_truncate = __toESM(require("ansi-truncate"), 1);
 var import_string_length = __toESM(require("string-length"), 1);
 var import_wrap_ansi = __toESM(require("wrap-ansi"), 1);
-var wrapString = (lines, width, options) => {
-  return (0, import_wrap_ansi.default)(typeof lines === "string" ? lines : lines.join("\n"), width, options);
+var wrap = (value, width, options) => {
+  return (0, import_wrap_ansi.default)(value, width, options);
 };
-var subString = (message2, width) => {
-  const length = (0, import_string_length.default)(message2);
-  if (length > width - 1) {
-    return (0, import_ansi_substring.default)(message2, 0, width - 1) + "\u2026";
-  }
-  return (0, import_ansi_substring.default)(message2, 0, width);
+var length = (value) => {
+  return (0, import_string_length.default)(value);
+};
+var truncate = (value, width) => {
+  return (0, import_ansi_truncate.default)(value, width, {
+    ellipsis
+  });
 };
-var padString = (texts) => {
+var pad = (texts) => {
   const size = Math.max(...texts.map((text2) => (0, import_string_length.default)(text2)));
   return (text2, padding = 0, fill) => {
     return text2.padEnd(size + padding, fill);
@@ -191,37 +196,37 @@ var color = import_chalk.default;
 // src/logs.ts
 var endMargin = 3;
 var intro = (title = "") => {
-  (0, import_prompts3.intro)(subString(title, process.stdout.columns - 6 - endMargin));
+  (0, import_prompts3.intro)(truncate(title, process.stdout.columns - 6 - endMargin));
 };
 var outro = (title = "") => {
-  (0, import_prompts3.outro)(subString(title, process.stdout.columns - 6 - endMargin));
+  (0, import_prompts3.outro)(truncate(title, process.stdout.columns - 6 - endMargin));
 };
-var note = (title, message2) => {
+var note = (title, message3) => {
   const width = process.stdout.columns - 6 - endMargin;
   (0, import_prompts3.note)(
-    wrapString(message2, width, {
+    wrap(message3, width, {
       hard: true
     }),
-    subString(title, width)
+    truncate(title, width)
   );
 };
-var logMessage = (symbol, message2) => {
+var logMessage = (symbol, message3) => {
   import_prompts3.log.message(
-    wrapString(message2, process.stdout.columns - 6 - endMargin, {
+    wrap(message3, process.stdout.columns - 6 - endMargin, {
       hard: true,
       trim: false
     }),
     { symbol }
   );
 };
-var message = (message2, symbol = color.gray("\u2502")) => logMessage(symbol, message2);
-var error2 = (message2) => logMessage(color.red(error), message2);
-var info2 = (message2) => logMessage(color.blue(info), message2);
-var step2 = (message2) => logMessage(color.green(step), message2);
-var warning2 = (message2) => logMessage(color.yellow(warning), message2);
-var success2 = (message2) => logMessage(color.green(success), message2);
+var message2 = (message3, symbol = color.gray(message)) => logMessage(symbol, message3);
+var error2 = (message3) => logMessage(color.red(error), message3);
+var info2 = (message3) => logMessage(color.blue(info), message3);
+var step2 = (message3) => logMessage(color.green(step), message3);
+var warning2 = (message3) => logMessage(color.yellow(warning), message3);
+var success2 = (message3) => logMessage(color.green(success), message3);
 var list = (title, data) => {
-  const padName = padString(Object.keys(data));
+  const padName = pad(Object.keys(data));
   note(
     title,
     Object.entries(data).map(([name, value]) => {
@@ -233,12 +238,12 @@ var task = async (opts) => {
   let last;
   const spin = (0, import_prompts3.spinner)();
   spin.start(opts.initialMessage);
-  const stop = (message2, code) => {
-    spin.stop(subString(message2 ?? last ?? opts.initialMessage, process.stdout.columns - 6 - endMargin), code);
+  const stop = (message3, code) => {
+    spin.stop(truncate(message3 ?? last ?? opts.initialMessage, process.stdout.columns - 6 - endMargin), code);
   };
   try {
     const result = await opts.task((m) => {
-      spin.message(subString(m, process.stdout.columns - 6 - endMargin));
+      spin.message(truncate(m, process.stdout.columns - 6 - endMargin));
       last = m;
     });
     stop(opts.successMessage);
@@ -250,21 +255,21 @@ var task = async (opts) => {
 };
 var table = (props) => {
   import_prompts3.log.message();
-  const length = Math.max(props.head.length, ...props.body.map((b) => b.length));
+  const length2 = Math.max(props.head.length, ...props.body.map((b) => b.length));
   const padding = 2;
-  const totalPadding = padding * 2 * length;
+  const totalPadding = padding * 2 * length2;
   const border = 1;
-  const totalBorder = (length - 1) * border + 2;
+  const totalBorder = (length2 - 1) * border + 2;
   const windowSize = process.stdout.columns;
-  const max = windowSize - totalPadding - totalBorder - endMargin;
-  const contentSizes = Array.from({ length }).map((_, i) => {
-    return Math.max(props.head[i]?.length ?? 0, ...props.body.map((b) => String(b[i])?.length));
+  const maxTableSize = windowSize - totalPadding - totalBorder - endMargin;
+  const contentSizes = Array.from({ length: length2 }).map((_, i) => {
+    return Math.max(length(props.head[i] ?? ""), ...props.body.map((b) => length(String(b[i]))));
   });
-  const columnSizes = Array.from({ length }).map(() => {
+  const columnSizes = Array.from({ length: length2 }).map(() => {
     return 0;
   });
   let leftover = Math.min(
-    max,
+    maxTableSize,
     contentSizes.reduce((total, size) => total + size, 0)
   );
   while (leftover > 0) {
@@ -280,7 +285,7 @@ var table = (props) => {
   const table2 = new import_cli_table3.default({
     head: props.head.map(
       (value, x) => "\n" + color.reset.whiteBright.bold(
-        wrapString(value, columnSizes[x], {
+        wrap(value, columnSizes[x], {
           hard: true
         })
       )
@@ -305,7 +310,7 @@ var table = (props) => {
         if (typeof value === "number") {
           return color.blue(value);
         }
-        return wrapString(value, columnSizes[x], {
+        return wrap(value, columnSizes[x], {
           hard: true
         });
       });

package/dist/index.d.cts

@@ -1,16 +1,18 @@
 import { TextOptions, PasswordOptions, ConfirmOptions, SelectOptions, MultiSelectOptions } from '@clack/prompts';
-import stringLength from 'string-length';
 import { Options } from 'wrap-ansi';
 import * as chalk from 'chalk';
 
+declare const message$1 = "\u2502";
 declare const step$1 = "\u25C7";
 declare const error$1 = "\u00D7";
 declare const success$1 = "\u25C6";
 declare const warning$1 = "\u25B2";
 declare const info$1 = "\u00B7";
+declare const ellipsis = "\u2026";
 
+declare const symbols_ellipsis: typeof ellipsis;
 declare namespace symbols {
-  export { error$1 as error, info$1 as info, step$1 as step, success$1 as success, warning$1 as warning };
+  export { symbols_ellipsis as ellipsis, error$1 as error, info$1 as info, message$1 as message, step$1 as step, success$1 as success, warning$1 as warning };
 }
 
 declare const text: (opts: TextOptions) => Promise<string>;
@@ -76,16 +78,17 @@ declare namespace logs {
   export { logs_error as error, logs_info as info, logs_intro as intro, logs_list as list, logs_message as message, logs_note as note, logs_outro as outro, logs_step as step, logs_success as success, logs_table as table, logs_task as task, logs_warning as warning };
 }
 
-declare const wrapString: (lines: string | string[], width: number, options?: Options) => string;
-declare const subString: (message: string, width: number) => any;
-declare const padString: (texts: string[]) => (text: string, padding?: number, fill?: string) => string;
+declare const wrap: (value: string, width: number, options?: Options) => string;
+declare const length: (value: string) => number;
+declare const truncate: (value: string, width: number) => string;
+declare const pad: (texts: string[]) => (text: string, padding?: number, fill?: string) => string;
 
-declare const ansi_padString: typeof padString;
-declare const ansi_stringLength: typeof stringLength;
-declare const ansi_subString: typeof subString;
-declare const ansi_wrapString: typeof wrapString;
+declare const ansi_length: typeof length;
+declare const ansi_pad: typeof pad;
+declare const ansi_truncate: typeof truncate;
+declare const ansi_wrap: typeof wrap;
 declare namespace ansi {
-  export { ansi_padString as padString, ansi_stringLength as stringLength, ansi_subString as subString, ansi_wrapString as wrapString };
+  export { ansi_length as length, ansi_pad as pad, ansi_truncate as truncate, ansi_wrap as wrap };
 }
 
 declare const color: chalk.ChalkInstance;

package/dist/index.d.ts

@@ -1,16 +1,18 @@
 import { TextOptions, PasswordOptions, ConfirmOptions, SelectOptions, MultiSelectOptions } from '@clack/prompts';
-import stringLength from 'string-length';
 import { Options } from 'wrap-ansi';
 import * as chalk from 'chalk';
 
+declare const message$1 = "\u2502";
 declare const step$1 = "\u25C7";
 declare const error$1 = "\u00D7";
 declare const success$1 = "\u25C6";
 declare const warning$1 = "\u25B2";
 declare const info$1 = "\u00B7";
+declare const ellipsis = "\u2026";
 
+declare const symbols_ellipsis: typeof ellipsis;
 declare namespace symbols {
-  export { error$1 as error, info$1 as info, step$1 as step, success$1 as success, warning$1 as warning };
+  export { symbols_ellipsis as ellipsis, error$1 as error, info$1 as info, message$1 as message, step$1 as step, success$1 as success, warning$1 as warning };
 }
 
 declare const text: (opts: TextOptions) => Promise<string>;
@@ -76,16 +78,17 @@ declare namespace logs {
   export { logs_error as error, logs_info as info, logs_intro as intro, logs_list as list, logs_message as message, logs_note as note, logs_outro as outro, logs_step as step, logs_success as success, logs_table as table, logs_task as task, logs_warning as warning };
 }
 
-declare const wrapString: (lines: string | string[], width: number, options?: Options) => string;
-declare const subString: (message: string, width: number) => any;
-declare const padString: (texts: string[]) => (text: string, padding?: number, fill?: string) => string;
+declare const wrap: (value: string, width: number, options?: Options) => string;
+declare const length: (value: string) => number;
+declare const truncate: (value: string, width: number) => string;
+declare const pad: (texts: string[]) => (text: string, padding?: number, fill?: string) => string;
 
-declare const ansi_padString: typeof padString;
-declare const ansi_stringLength: typeof stringLength;
-declare const ansi_subString: typeof subString;
-declare const ansi_wrapString: typeof wrapString;
+declare const ansi_length: typeof length;
+declare const ansi_pad: typeof pad;
+declare const ansi_truncate: typeof truncate;
+declare const ansi_wrap: typeof wrap;
 declare namespace ansi {
-  export { ansi_padString as padString, ansi_stringLength as stringLength, ansi_subString as subString, ansi_wrapString as wrapString };
+  export { ansi_length as length, ansi_pad as pad, ansi_truncate as truncate, ansi_wrap as wrap };
 }
 
 declare const color: chalk.ChalkInstance;

package/dist/index.js

@@ -7,17 +7,21 @@ var __export = (target, all) => {
 // src/symbols.ts
 var symbols_exports = {};
 __export(symbols_exports, {
+  ellipsis: () => ellipsis,
   error: () => error,
   info: () => info,
+  message: () => message,
   step: () => step,
   success: () => success,
   warning: () => warning
 });
+var message = "\u2502";
 var step = "\u25C7";
 var error = "\xD7";
 var success = "\u25C6";
 var warning = "\u25B2";
 var info = "\xB7";
+var ellipsis = "\u2026";
 
 // src/prompts.ts
 var prompts_exports = {};
@@ -115,7 +119,7 @@ __export(logs_exports, {
   info: () => info2,
   intro: () => intro,
   list: () => list,
-  message: () => message,
+  message: () => message2,
   note: () => note,
   outro: () => outro,
   step: () => step2,
@@ -130,26 +134,27 @@ import Table from "cli-table3";
 // src/ansi.ts
 var ansi_exports = {};
 __export(ansi_exports, {
-  padString: () => padString,
-  stringLength: () => stringLength,
-  subString: () => subString,
-  wrapString: () => wrapString
+  length: () => length,
+  pad: () => pad,
+  truncate: () => truncate,
+  wrap: () => wrap
 });
-import ansiSubstring from "ansi-substring";
-import stringLength from "string-length";
-import wrapAnsi from "wrap-ansi";
-var wrapString = (lines, width, options) => {
-  return wrapAnsi(typeof lines === "string" ? lines : lines.join("\n"), width, options);
+import ansiTruncate from "ansi-truncate";
+import ansiLength from "string-length";
+import ansiWrap from "wrap-ansi";
+var wrap = (value, width, options) => {
+  return ansiWrap(value, width, options);
 };
-var subString = (message2, width) => {
-  const length = stringLength(message2);
-  if (length > width - 1) {
-    return ansiSubstring(message2, 0, width - 1) + "\u2026";
-  }
-  return ansiSubstring(message2, 0, width);
+var length = (value) => {
+  return ansiLength(value);
+};
+var truncate = (value, width) => {
+  return ansiTruncate(value, width, {
+    ellipsis
+  });
 };
-var padString = (texts) => {
-  const size = Math.max(...texts.map((text2) => stringLength(text2)));
+var pad = (texts) => {
+  const size = Math.max(...texts.map((text2) => ansiLength(text2)));
   return (text2, padding = 0, fill) => {
     return text2.padEnd(size + padding, fill);
   };
@@ -162,37 +167,37 @@ var color = chalk;
 // src/logs.ts
 var endMargin = 3;
 var intro = (title = "") => {
-  p_intro(subString(title, process.stdout.columns - 6 - endMargin));
+  p_intro(truncate(title, process.stdout.columns - 6 - endMargin));
 };
 var outro = (title = "") => {
-  p_outro(subString(title, process.stdout.columns - 6 - endMargin));
+  p_outro(truncate(title, process.stdout.columns - 6 - endMargin));
 };
-var note = (title, message2) => {
+var note = (title, message3) => {
   const width = process.stdout.columns - 6 - endMargin;
   p_note(
-    wrapString(message2, width, {
+    wrap(message3, width, {
       hard: true
     }),
-    subString(title, width)
+    truncate(title, width)
   );
 };
-var logMessage = (symbol, message2) => {
+var logMessage = (symbol, message3) => {
   log.message(
-    wrapString(message2, process.stdout.columns - 6 - endMargin, {
+    wrap(message3, process.stdout.columns - 6 - endMargin, {
       hard: true,
       trim: false
     }),
     { symbol }
   );
 };
-var message = (message2, symbol = color.gray("\u2502")) => logMessage(symbol, message2);
-var error2 = (message2) => logMessage(color.red(error), message2);
-var info2 = (message2) => logMessage(color.blue(info), message2);
-var step2 = (message2) => logMessage(color.green(step), message2);
-var warning2 = (message2) => logMessage(color.yellow(warning), message2);
-var success2 = (message2) => logMessage(color.green(success), message2);
+var message2 = (message3, symbol = color.gray(message)) => logMessage(symbol, message3);
+var error2 = (message3) => logMessage(color.red(error), message3);
+var info2 = (message3) => logMessage(color.blue(info), message3);
+var step2 = (message3) => logMessage(color.green(step), message3);
+var warning2 = (message3) => logMessage(color.yellow(warning), message3);
+var success2 = (message3) => logMessage(color.green(success), message3);
 var list = (title, data) => {
-  const padName = padString(Object.keys(data));
+  const padName = pad(Object.keys(data));
   note(
     title,
     Object.entries(data).map(([name, value]) => {
@@ -204,12 +209,12 @@ var task = async (opts) => {
   let last;
   const spin = spinner();
   spin.start(opts.initialMessage);
-  const stop = (message2, code) => {
-    spin.stop(subString(message2 ?? last ?? opts.initialMessage, process.stdout.columns - 6 - endMargin), code);
+  const stop = (message3, code) => {
+    spin.stop(truncate(message3 ?? last ?? opts.initialMessage, process.stdout.columns - 6 - endMargin), code);
   };
   try {
     const result = await opts.task((m) => {
-      spin.message(subString(m, process.stdout.columns - 6 - endMargin));
+      spin.message(truncate(m, process.stdout.columns - 6 - endMargin));
       last = m;
     });
     stop(opts.successMessage);
@@ -221,21 +226,21 @@ var task = async (opts) => {
 };
 var table = (props) => {
   log.message();
-  const length = Math.max(props.head.length, ...props.body.map((b) => b.length));
+  const length2 = Math.max(props.head.length, ...props.body.map((b) => b.length));
   const padding = 2;
-  const totalPadding = padding * 2 * length;
+  const totalPadding = padding * 2 * length2;
   const border = 1;
-  const totalBorder = (length - 1) * border + 2;
+  const totalBorder = (length2 - 1) * border + 2;
   const windowSize = process.stdout.columns;
-  const max = windowSize - totalPadding - totalBorder - endMargin;
-  const contentSizes = Array.from({ length }).map((_, i) => {
-    return Math.max(props.head[i]?.length ?? 0, ...props.body.map((b) => String(b[i])?.length));
+  const maxTableSize = windowSize - totalPadding - totalBorder - endMargin;
+  const contentSizes = Array.from({ length: length2 }).map((_, i) => {
+    return Math.max(length(props.head[i] ?? ""), ...props.body.map((b) => length(String(b[i]))));
   });
-  const columnSizes = Array.from({ length }).map(() => {
+  const columnSizes = Array.from({ length: length2 }).map(() => {
     return 0;
   });
   let leftover = Math.min(
-    max,
+    maxTableSize,
     contentSizes.reduce((total, size) => total + size, 0)
   );
   while (leftover > 0) {
@@ -251,7 +256,7 @@ var table = (props) => {
   const table2 = new Table({
     head: props.head.map(
       (value, x) => "\n" + color.reset.whiteBright.bold(
-        wrapString(value, columnSizes[x], {
+        wrap(value, columnSizes[x], {
           hard: true
         })
       )
@@ -276,7 +281,7 @@ var table = (props) => {
         if (typeof value === "number") {
           return color.blue(value);
         }
-        return wrapString(value, columnSizes[x], {
+        return wrap(value, columnSizes[x], {
           hard: true
         });
       });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awsless/clui",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "license": "MIT",
   "type": "module",
   "repository": {
@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "@clack/prompts": "^0.11.0",
-    "ansi-substring": "^1.0.3",
+    "ansi-truncate": "^1.2.0",
     "chalk": "^5.4.1",
     "cli-table3": "^0.6.5",
     "string-length": "^6.0.0",