@cjser/cli-truncate 6.0.0-cjser.2

package/dist-cjser/index.cjs

@@ -0,0 +1,160 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/@cjser/cli-truncate/index.js
+var index_exports = {};
+__export(index_exports, {
+  default: () => cliTruncate
+});
+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);
+function getIndexOfNearestSpace(string, wantedIndex, shouldSearchRight) {
+  if (string.charAt(wantedIndex) === " ") {
+    return wantedIndex;
+  }
+  const direction = shouldSearchRight ? 1 : -1;
+  for (let index = 0; index <= 3; index++) {
+    const finalIndex = wantedIndex + index * direction;
+    if (string.charAt(finalIndex) === " ") {
+      return finalIndex;
+    }
+  }
+  return wantedIndex;
+}
+function cliTruncate(text, columns, options = {}) {
+  const {
+    position = "end",
+    space = false,
+    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}`);
+  }
+  if (columns < 1) {
+    return "";
+  }
+  const length = (0, import_string_width.default)(text);
+  if (length <= columns) {
+    return text;
+  }
+  if (columns === 1) {
+    return truncationCharacter;
+  }
+  const ANSI = {
+    ESC: 27,
+    LEFT_BRACKET: 91,
+    LETTER_M: 109
+  };
+  const isSgrParameter = (code) => code >= 48 && code <= 57 || code === 59;
+  function leadingSgrSpanEndIndex(string) {
+    let index = 0;
+    while (index + 2 < string.length && string.codePointAt(index) === ANSI.ESC && string.codePointAt(index + 1) === ANSI.LEFT_BRACKET) {
+      let j = index + 2;
+      while (j < string.length && isSgrParameter(string.codePointAt(j))) {
+        j++;
+      }
+      if (j < string.length && string.codePointAt(j) === ANSI.LETTER_M) {
+        index = j + 1;
+        continue;
+      }
+      break;
+    }
+    return index;
+  }
+  function trailingSgrSpanStartIndex(string) {
+    let start = string.length;
+    while (start > 1 && string.codePointAt(start - 1) === ANSI.LETTER_M) {
+      let j = start - 2;
+      while (j >= 0 && isSgrParameter(string.codePointAt(j))) {
+        j--;
+      }
+      if (j >= 1 && string.codePointAt(j - 1) === ANSI.ESC && string.codePointAt(j) === ANSI.LEFT_BRACKET) {
+        start = j - 1;
+        continue;
+      }
+      break;
+    }
+    return start;
+  }
+  function appendWithInheritedStyleFromEnd(visible, suffix) {
+    const start = trailingSgrSpanStartIndex(visible);
+    if (start === visible.length) {
+      return visible + suffix;
+    }
+    return visible.slice(0, start) + suffix + visible.slice(start);
+  }
+  function prependWithInheritedStyleFromStart(prefix, visible) {
+    const end = leadingSgrSpanEndIndex(visible);
+    if (end === 0) {
+      return prefix + visible;
+    }
+    return visible.slice(0, end) + prefix + visible.slice(end);
+  }
+  if (position === "start") {
+    if (preferTruncationOnSpace) {
+      const nearestSpace = getIndexOfNearestSpace(text, length - columns + 1, true);
+      const right2 = (0, import_slice_ansi.default)(text, nearestSpace, length).trim();
+      return prependWithInheritedStyleFromStart(truncationCharacter, right2);
+    }
+    if (space) {
+      truncationCharacter += " ";
+    }
+    const right = (0, import_slice_ansi.default)(text, length - columns + (0, import_string_width.default)(truncationCharacter), length);
+    return prependWithInheritedStyleFromStart(truncationCharacter, right);
+  }
+  if (position === "middle") {
+    if (space) {
+      truncationCharacter = ` ${truncationCharacter} `;
+    }
+    const half = Math.floor(columns / 2);
+    if (preferTruncationOnSpace) {
+      const spaceNearFirstBreakPoint = getIndexOfNearestSpace(text, half);
+      const spaceNearSecondBreakPoint = getIndexOfNearestSpace(text, length - (columns - half) + 1, 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);
+  }
+  if (position === "end") {
+    if (preferTruncationOnSpace) {
+      const nearestSpace = getIndexOfNearestSpace(text, columns - 1);
+      const left2 = (0, import_slice_ansi.default)(text, 0, nearestSpace);
+      return appendWithInheritedStyleFromEnd(left2, truncationCharacter);
+    }
+    if (space) {
+      truncationCharacter = ` ${truncationCharacter}`;
+    }
+    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

@@ -0,0 +1,118 @@
+export type Options = {
+	/**
+	The position to truncate the string.
+
+	@default 'end'
+	*/
+	readonly position?: 'start' | 'middle' | 'end';
+
+	/**
+	Add a space between the text and the ellipsis.
+
+	@default false
+
+	@example
+	```
+	import cliTruncate from '@cjser/cli-truncate';
+
+	cliTruncate('unicorns', 5, {position: 'end', space: true});
+	//=> 'uni …'
+
+	cliTruncate('unicorns', 5, {position: 'end', space: false});
+	//=> 'unic…'
+
+	cliTruncate('unicorns', 6, {position: 'start', space: true});
+	//=> '… orns'
+
+	cliTruncate('unicorns', 7, {position: 'middle', space: true});
+	//=> 'uni … s'
+	```
+	*/
+	readonly space?: boolean;
+
+	/**
+	Truncate the string from a whitespace if it is within 3 characters from the actual breaking point.
+
+	@default false
+
+	@example
+	```
+	import cliTruncate from '@cjser/cli-truncate';
+
+	cliTruncate('unicorns rainbow dragons', 20, {position: 'start', preferTruncationOnSpace: true});
+	//=> '…rainbow dragons'
+
+	cliTruncate('unicorns rainbow dragons', 20, {position: 'middle', preferTruncationOnSpace: true});
+	//=> 'unicorns…dragons'
+
+	cliTruncate('unicorns rainbow dragons', 6, {position: 'end', preferTruncationOnSpace: true});
+	//=> 'unico…'
+	````
+	*/
+	readonly preferTruncationOnSpace?: boolean;
+
+	/**
+	The character to use at the breaking point.
+
+	@default '…'
+
+	@example
+	```
+	import cliTruncate from '@cjser/cli-truncate';
+
+	cliTruncate('unicorns', 5, {position: 'end'});
+	//=> 'unic…'
+
+	cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: '.'});
+	//=> 'unic.'
+
+	cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: ''});
+	//=> 'unico'
+	*/
+	readonly truncationCharacter?: string;
+};
+
+/**
+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.
+
+@example
+```
+import cliTruncate from '@cjser/cli-truncate';
+
+cliTruncate('unicorn', 4);
+//=> 'uni…'
+
+// Truncate at different positions
+cliTruncate('unicorn', 4, {position: 'start'});
+//=> '…orn'
+
+cliTruncate('unicorn', 4, {position: 'middle'});
+//=> 'un…n'
+
+cliTruncate('\u001B[31municorn\u001B[39m', 4);
+//=> '\u001B[31muni…\u001B[39m'
+
+// Note: When truncating styled text (ANSI escapes), the truncation character inherits the style at the breaking point for `position: 'start'` and `position: 'end'`. This does not apply to `position: 'middle'`.
+
+// Truncate Unicode surrogate pairs
+cliTruncate('uni\uD83C\uDE00corn', 5);
+//=> 'uni\uD83C\uDE00…'
+
+// Truncate fullwidth characters
+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);
+//=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…'
+```
+*/
+export default function cliTruncate(
+	text: string,
+	columns: number,
+	options?: Options,
+): string;

package/index.js

@@ -0,0 +1,168 @@
+import sliceAnsi from '@cjser/slice-ansi';
+import stringWidth from '@cjser/string-width';
+
+function getIndexOfNearestSpace(string, wantedIndex, shouldSearchRight) {
+	if (string.charAt(wantedIndex) === ' ') {
+		return wantedIndex;
+	}
+
+	const direction = shouldSearchRight ? 1 : -1;
+
+	for (let index = 0; index <= 3; index++) {
+		const finalIndex = wantedIndex + (index * direction);
+		if (string.charAt(finalIndex) === ' ') {
+			return finalIndex;
+		}
+	}
+
+	return wantedIndex;
+}
+
+export default function cliTruncate(text, columns, options = {}) {
+	const {
+		position = 'end',
+		space = false,
+		preferTruncationOnSpace = false,
+	} = 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}`);
+	}
+
+	if (columns < 1) {
+		return '';
+	}
+
+	const length = stringWidth(text);
+
+	if (length <= columns) {
+		return text;
+	}
+
+	if (columns === 1) {
+		return truncationCharacter;
+	}
+
+	// ANSI escape sequence constants
+	const ANSI = {
+		ESC: 27,
+		LEFT_BRACKET: 91,
+		LETTER_M: 109,
+	};
+
+	const isSgrParameter = code => (code >= 48 && code <= 57) || code === 59; // 0-9 or ;
+
+	function leadingSgrSpanEndIndex(string) {
+		let index = 0;
+		while (index + 2 < string.length && string.codePointAt(index) === ANSI.ESC && string.codePointAt(index + 1) === ANSI.LEFT_BRACKET) {
+			let j = index + 2;
+			while (j < string.length && isSgrParameter(string.codePointAt(j))) {
+				j++;
+			}
+
+			if (j < string.length && string.codePointAt(j) === ANSI.LETTER_M) {
+				index = j + 1;
+				continue;
+			}
+
+			break;
+		}
+
+		return index;
+	}
+
+	function trailingSgrSpanStartIndex(string) {
+		let start = string.length;
+		while (start > 1 && string.codePointAt(start - 1) === ANSI.LETTER_M) {
+			let j = start - 2;
+			while (j >= 0 && isSgrParameter(string.codePointAt(j))) {
+				j--;
+			}
+
+			if (j >= 1 && string.codePointAt(j - 1) === ANSI.ESC && string.codePointAt(j) === ANSI.LEFT_BRACKET) {
+				start = j - 1;
+				continue;
+			}
+
+			break;
+		}
+
+		return start;
+	}
+
+	function appendWithInheritedStyleFromEnd(visible, suffix) {
+		const start = trailingSgrSpanStartIndex(visible);
+		if (start === visible.length) {
+			return visible + suffix;
+		}
+
+		return visible.slice(0, start) + suffix + visible.slice(start);
+	}
+
+	function prependWithInheritedStyleFromStart(prefix, visible) {
+		const end = leadingSgrSpanEndIndex(visible);
+		if (end === 0) {
+			return prefix + visible;
+		}
+
+		return visible.slice(0, end) + prefix + visible.slice(end);
+	}
+
+	if (position === 'start') {
+		if (preferTruncationOnSpace) {
+			const nearestSpace = getIndexOfNearestSpace(text, length - columns + 1, true);
+			const right = sliceAnsi(text, nearestSpace, length).trim();
+			return prependWithInheritedStyleFromStart(truncationCharacter, right);
+		}
+
+		if (space) {
+			truncationCharacter += ' ';
+		}
+
+		const right = sliceAnsi(text, length - columns + stringWidth(truncationCharacter), length);
+		return prependWithInheritedStyleFromStart(truncationCharacter, right);
+	}
+
+	if (position === 'middle') {
+		if (space) {
+			truncationCharacter = ` ${truncationCharacter} `;
+		}
+
+		const half = Math.floor(columns / 2);
+
+		if (preferTruncationOnSpace) {
+			const spaceNearFirstBreakPoint = getIndexOfNearestSpace(text, half);
+			const spaceNearSecondBreakPoint = getIndexOfNearestSpace(text, length - (columns - half) + 1, 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)
+		);
+	}
+
+	if (position === 'end') {
+		if (preferTruncationOnSpace) {
+			const nearestSpace = getIndexOfNearestSpace(text, columns - 1);
+			const left = sliceAnsi(text, 0, nearestSpace);
+			return appendWithInheritedStyleFromEnd(left, truncationCharacter);
+		}
+
+		if (space) {
+			truncationCharacter = ` ${truncationCharacter}`;
+		}
+
+		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/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@cjser/cli-truncate",
+  "version": "6.0.0-cjser.2",
+  "description": "Truncate a string to a specific width in the terminal",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://code.moenext.com/3rdeye/cjser.git"
+  },
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "author": {
+    "name": "Sindre Sorhus",
+    "email": "sindresorhus@gmail.com",
+    "url": "https://sindresorhus.com"
+  },
+  "type": "module",
+  "exports": {
+    "types": "./index.d.ts",
+    "require": "./dist-cjser/index.cjs",
+    "default": "./index.js"
+  },
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "dist-cjser"
+  ],
+  "keywords": [
+    "truncate",
+    "ellipsis",
+    "text",
+    "limit",
+    "slice",
+    "cli",
+    "terminal",
+    "term",
+    "shell",
+    "width",
+    "ansi",
+    "string"
+  ],
+  "dependencies": {
+    "@cjser/slice-ansi": "9.0.0-cjser.2",
+    "@cjser/string-width": "8.2.1-cjser.2"
+  },
+  "devDependencies": {
+    "ava": "^7.0.0",
+    "tsd": "^0.33.0",
+    "xo": "^2.0.2"
+  },
+  "types": "./index.d.ts",
+  "main": "./dist-cjser/index.cjs",
+  "cjser": {
+    "sourceVersion": "6.0.0",
+    "cjserVersion": 2,
+    "original": {
+      "name": "cli-truncate",
+      "version": "6.0.0",
+      "exports": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "repository": "sindresorhus/cli-truncate",
+      "dependencies": {
+        "slice-ansi": "^9.0.0",
+        "string-width": "^8.2.0"
+      },
+      "files": [
+        "index.js",
+        "index.d.ts"
+      ],
+      "scripts": {
+        "test": "xo && ava && tsd"
+      }
+    }
+  }
+}

package/readme.md

@@ -0,0 +1,158 @@
+# cli-truncate
+
+> Truncate a string to a specific width in the terminal
+
+Gracefully handles [ANSI escapes](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles). Like a string styled with [`chalk`](https://github.com/chalk/chalk). It also supports Unicode surrogate pairs and fullwidth characters.
+
+## Install
+
+```sh
+npm install cli-truncate
+```
+
+## Usage
+
+```js
+import cliTruncate from 'cli-truncate';
+
+cliTruncate('unicorn', 4);
+//=> 'uni…'
+
+// Truncate at different positions
+cliTruncate('unicorn', 4, {position: 'start'});
+//=> '…orn'
+
+cliTruncate('unicorn', 4, {position: 'middle'});
+//=> 'un…n'
+
+cliTruncate('unicorns rainbow dragons', 6, {position: 'end'});
+//=> 'unico…'
+
+cliTruncate('\u001B[31municorn\u001B[39m', 4);
+//=> '\u001B[31muni…\u001B[39m'
+
+> [!NOTE]
+> When truncating styled text (ANSI escapes), the truncation character inherits the style at the breaking point for `position: 'start'` and `position: 'end'`. This does not apply to `position: 'middle'`.
+
+// Truncate Unicode surrogate pairs
+cliTruncate('uni\uD83C\uDE00corn', 5);
+//=> 'uni\uD83C\uDE00…'
+
+// Truncate fullwidth characters
+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);
+//=> 'Lorem ipsum dolor sit amet, consectetuer adipiscing…'
+```
+
+## API
+
+### cliTruncate(text, columns, options?)
+
+#### text
+
+Type: `string`
+
+The text to truncate.
+
+#### columns
+
+Type: `number`
+
+The number of columns to occupy in the terminal.
+
+#### options
+
+Type: `object`
+
+##### position
+
+Type: `string`\
+Default: `'end'`\
+Values: `'start' | 'middle' | 'end'`
+
+The position to truncate the string.
+
+##### space
+
+Type: `boolean`\
+Default: `false`
+
+Add a space between the text and the ellipsis.
+
+```js
+import cliTruncate from 'cli-truncate';
+
+cliTruncate('unicorns', 5, {space: false});
+//=> 'unic…'
+
+cliTruncate('unicorns', 5, {space: true});
+//=> 'uni …'
+
+cliTruncate('unicorns', 6, {position: 'start', space: true});
+//=> '… orns'
+
+cliTruncate('unicorns', 7, {position: 'middle', space: true});
+//=> 'uni … s'
+```
+
+##### preferTruncationOnSpace
+
+Type: `boolean`\
+Default: `false`
+
+Truncate the string from a whitespace if it is within 3 characters from the actual breaking point.
+
+```js
+import cliTruncate from 'cli-truncate';
+
+cliTruncate('unicorns rainbow dragons', 20, {position: 'start', preferTruncationOnSpace: true});
+//=> '…rainbow dragons'
+
+// Without preferTruncationOnSpace
+cliTruncate('unicorns rainbow dragons', 20, {position: 'start'});
+//=> '…rns rainbow dragons'
+
+cliTruncate('unicorns rainbow dragons', 20, {position: 'middle', preferTruncationOnSpace: true});
+//=> 'unicorns…dragons'
+
+cliTruncate('unicorns rainbow dragons', 6, {position: 'end', preferTruncationOnSpace: true});
+//=> 'unico…'
+
+// preferTruncationOnSpace has no effect if space isn't found within 3 characters
+cliTruncate('unicorns rainbow dragons', 6, {position: 'middle', preferTruncationOnSpace: true});
+//=> 'uni…ns'
+```
+
+##### truncationCharacter
+
+Type: `string`\
+Default: `…`
+
+The character to use at the breaking point.
+
+```js
+import cliTruncate from 'cli-truncate';
+
+cliTruncate('unicorns', 5, {position: 'end'});
+//=> 'unic…'
+
+cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: '.'});
+//=> 'unic.'
+
+cliTruncate('unicorns', 5, {position: 'end', truncationCharacter: ''});
+//=> 'unico'
+```
+
+## Related
+
+- [wrap-ansi](https://github.com/chalk/wrap-ansi) - Wordwrap a string with ANSI escape codes
+- [slice-ansi](https://github.com/chalk/slice-ansi) - Slice a string with ANSI escape codes
+
+## cjser
+
+This package is a CommonJS-compatible build generated by cjser for projects that still need `require()` support. The source version matches the original npm package version, with a cjser prerelease suffix for this generated build.
+Original repository: https://github.com/sindresorhus/cli-truncate