@cjser/cli-truncate 6.0.0-cjser.2 → 6.1.0-cjser.2

package/dist-cjser/index.cjs

@@ -26,7 +26,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// packages/@cjser/cli-truncate/index.js
+// packages/@cjser/cli-truncate.tmp-26-1782663828634/index.js
 var index_exports = {};
 __export(index_exports, {
   default: () => cliTruncate
@@ -34,6 +34,7 @@ __export(index_exports, {
 module.exports = __toCommonJS(index_exports);
 var import_slice_ansi = __toESM(require("@cjser/slice-ansi"), 1);
 var import_string_width = __toESM(require("@cjser/string-width"), 1);
+var validPositions = /* @__PURE__ */ new Set(["start", "middle", "end"]);
 function getIndexOfNearestSpace(string, wantedIndex, shouldSearchRight) {
   if (string.charAt(wantedIndex) === " ") {
     return wantedIndex;
@@ -47,6 +48,23 @@ function getIndexOfNearestSpace(string, wantedIndex, shouldSearchRight) {
   }
   return wantedIndex;
 }
+function validateInput(text, columns, position, truncationCharacter) {
+  if (typeof text !== "string") {
+    throw new TypeError(`Expected \`input\` to be a string, got ${typeof text}`);
+  }
+  if (typeof columns !== "number") {
+    throw new TypeError(`Expected \`columns\` to be a number, got ${typeof columns}`);
+  }
+  if (!Number.isFinite(columns)) {
+    throw new TypeError(`Expected \`columns\` to be a finite number, got ${columns}`);
+  }
+  if (!validPositions.has(position)) {
+    throw new TypeError(`Expected \`options.position\` to be either \`start\`, \`middle\` or \`end\`, got ${position}`);
+  }
+  if (typeof truncationCharacter !== "string") {
+    throw new TypeError(`Expected \`options.truncationCharacter\` to be a string, got ${typeof truncationCharacter}`);
+  }
+}
 function cliTruncate(text, columns, options = {}) {
   const {
     position = "end",
@@ -54,12 +72,7 @@ function cliTruncate(text, columns, options = {}) {
     preferTruncationOnSpace = false
   } = options;
   let { truncationCharacter = "\u2026" } = options;
-  if (typeof text !== "string") {
-    throw new TypeError(`Expected \`input\` to be a string, got ${typeof text}`);
-  }
-  if (typeof columns !== "number") {
-    throw new TypeError(`Expected \`columns\` to be a number, got ${typeof columns}`);
-  }
+  validateInput(text, columns, position, truncationCharacter);
   if (columns < 1) {
     return "";
   }
@@ -135,14 +148,18 @@ function cliTruncate(text, columns, options = {}) {
   if (position === "middle") {
     if (space) {
       truncationCharacter = ` ${truncationCharacter} `;
+      if ((0, import_string_width.default)(truncationCharacter) >= columns) {
+        truncationCharacter = truncationCharacter.trim();
+      }
     }
-    const half = Math.floor(columns / 2);
+    const truncationWidth = (0, import_string_width.default)(truncationCharacter);
+    const half = Math.min(Math.floor(columns / 2), Math.max(0, columns - truncationWidth));
     if (preferTruncationOnSpace) {
       const spaceNearFirstBreakPoint = getIndexOfNearestSpace(text, half);
-      const spaceNearSecondBreakPoint = getIndexOfNearestSpace(text, length - (columns - half) + 1, true);
+      const spaceNearSecondBreakPoint = getIndexOfNearestSpace(text, length - (columns - half) + truncationWidth, true);
       return (0, import_slice_ansi.default)(text, 0, spaceNearFirstBreakPoint) + truncationCharacter + (0, import_slice_ansi.default)(text, spaceNearSecondBreakPoint, length).trim();
     }
-    return (0, import_slice_ansi.default)(text, 0, half) + truncationCharacter + (0, import_slice_ansi.default)(text, length - (columns - half) + (0, import_string_width.default)(truncationCharacter), length);
+    return (0, import_slice_ansi.default)(text, 0, half) + truncationCharacter + (0, import_slice_ansi.default)(text, length - (columns - half) + truncationWidth, length);
   }
   if (position === "end") {
     if (preferTruncationOnSpace) {
@@ -156,5 +173,4 @@ function cliTruncate(text, columns, options = {}) {
     const left = (0, import_slice_ansi.default)(text, 0, columns - (0, import_string_width.default)(truncationCharacter));
     return appendWithInheritedStyleFromEnd(left, truncationCharacter);
   }
-  throw new Error(`Expected \`options.position\` to be either \`start\`, \`middle\` or \`end\`, got ${position}`);
 }

package/index.d.ts

@@ -76,7 +76,7 @@ export type Options = {
 Truncate a string to a specific width in the terminal.
 
 @param text - The text to truncate.
-@param columns - The number of columns to occupy in the terminal.
+@param columns - The finite number of columns to occupy in the terminal.
 
 @example
 ```
@@ -107,7 +107,7 @@ cliTruncate('안녕하세요', 3);
 
 // Truncate the paragraph to the terminal width
 const paragraph = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.';
-cliTruncate(paragraph, process.stdout.columns);
+cliTruncate(paragraph, process.stdout.columns ?? 80);
 //=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…'
 ```
 */

package/index.js

@@ -1,6 +1,8 @@
 import sliceAnsi from '@cjser/slice-ansi';
 import stringWidth from '@cjser/string-width';
 
+const validPositions = new Set(['start', 'middle', 'end']);
+
 function getIndexOfNearestSpace(string, wantedIndex, shouldSearchRight) {
 	if (string.charAt(wantedIndex) === ' ') {
 		return wantedIndex;
@@ -18,6 +20,28 @@ function getIndexOfNearestSpace(string, wantedIndex, shouldSearchRight) {
 	return wantedIndex;
 }
 
+function validateInput(text, columns, position, truncationCharacter) {
+	if (typeof text !== 'string') {
+		throw new TypeError(`Expected \`input\` to be a string, got ${typeof text}`);
+	}
+
+	if (typeof columns !== 'number') {
+		throw new TypeError(`Expected \`columns\` to be a number, got ${typeof columns}`);
+	}
+
+	if (!Number.isFinite(columns)) {
+		throw new TypeError(`Expected \`columns\` to be a finite number, got ${columns}`);
+	}
+
+	if (!validPositions.has(position)) {
+		throw new TypeError(`Expected \`options.position\` to be either \`start\`, \`middle\` or \`end\`, got ${position}`);
+	}
+
+	if (typeof truncationCharacter !== 'string') {
+		throw new TypeError(`Expected \`options.truncationCharacter\` to be a string, got ${typeof truncationCharacter}`);
+	}
+}
+
 export default function cliTruncate(text, columns, options = {}) {
 	const {
 		position = 'end',
@@ -27,13 +51,7 @@ export default function cliTruncate(text, columns, options = {}) {
 
 	let {truncationCharacter = '…'} = options;
 
-	if (typeof text !== 'string') {
-		throw new TypeError(`Expected \`input\` to be a string, got ${typeof text}`);
-	}
-
-	if (typeof columns !== 'number') {
-		throw new TypeError(`Expected \`columns\` to be a number, got ${typeof columns}`);
-	}
+	validateInput(text, columns, position, truncationCharacter);
 
 	if (columns < 1) {
 		return '';
@@ -132,20 +150,30 @@ export default function cliTruncate(text, columns, options = {}) {
 	if (position === 'middle') {
 		if (space) {
 			truncationCharacter = ` ${truncationCharacter} `;
+
+			// Drop the padding spaces if the padded character does not fit, so the
+			// truncation character itself never exceeds the budget.
+			if (stringWidth(truncationCharacter) >= columns) {
+				truncationCharacter = truncationCharacter.trim();
+			}
 		}
 
-		const half = Math.floor(columns / 2);
+		const truncationWidth = stringWidth(truncationCharacter);
+		// Reserve room for the truncation character before splitting the budget
+		// between the two sides, otherwise small budgets overflow (e.g. a width of
+		// 4 was returned for `columns: 2`).
+		const half = Math.min(Math.floor(columns / 2), Math.max(0, columns - truncationWidth));
 
 		if (preferTruncationOnSpace) {
 			const spaceNearFirstBreakPoint = getIndexOfNearestSpace(text, half);
-			const spaceNearSecondBreakPoint = getIndexOfNearestSpace(text, length - (columns - half) + 1, true);
+			const spaceNearSecondBreakPoint = getIndexOfNearestSpace(text, length - (columns - half) + truncationWidth, true);
 			return sliceAnsi(text, 0, spaceNearFirstBreakPoint) + truncationCharacter + sliceAnsi(text, spaceNearSecondBreakPoint, length).trim();
 		}
 
 		return (
 			sliceAnsi(text, 0, half)
 			+ truncationCharacter
-			+ sliceAnsi(text, length - (columns - half) + stringWidth(truncationCharacter), length)
+			+ sliceAnsi(text, length - (columns - half) + truncationWidth, length)
 		);
 	}
 
@@ -163,6 +191,4 @@ export default function cliTruncate(text, columns, options = {}) {
 		const left = sliceAnsi(text, 0, columns - stringWidth(truncationCharacter));
 		return appendWithInheritedStyleFromEnd(left, truncationCharacter);
 	}
-
-	throw new Error(`Expected \`options.position\` to be either \`start\`, \`middle\` or \`end\`, got ${position}`);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cjser/cli-truncate",
-  "version": "6.0.0-cjser.2",
+  "version": "6.1.0-cjser.2",
   "description": "Truncate a string to a specific width in the terminal",
   "license": "MIT",
   "repository": {
@@ -57,16 +57,16 @@
   "types": "./index.d.ts",
   "main": "./dist-cjser/index.cjs",
   "cjser": {
-    "sourceVersion": "6.0.0",
+    "sourceVersion": "6.1.0",
     "cjserVersion": 2,
     "original": {
       "name": "cli-truncate",
-      "version": "6.0.0",
+      "version": "6.1.0",
       "exports": {
         "types": "./index.d.ts",
         "default": "./index.js"
       },
-      "repository": "sindresorhus/cli-truncate",
+      "repository": "github:sindresorhus/cli-truncate",
       "dependencies": {
         "slice-ansi": "^9.0.0",
         "string-width": "^8.2.0"

package/readme.md

@@ -44,7 +44,7 @@ cliTruncate('안녕하세요', 3);
 
 // Truncate the paragraph to the terminal width
 const paragraph = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa.';
-cliTruncate(paragraph, process.stdout.columns);
+cliTruncate(paragraph, process.stdout.columns ?? 80);
 //=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…'
 ```
 
@@ -62,7 +62,7 @@ The text to truncate.
 
 Type: `number`
 
-The number of columns to occupy in the terminal.
+The finite number of columns to occupy in the terminal.
 
 #### options