@peteanderson/ansi 0.3.0 → 0.3.1

package/README.md

@@ -137,6 +137,11 @@ available).
 
 Returns the visible length of a string with all ANSI sequences removed (always available).
 
+### `padStart(text, targetLength)` and `padEnd(text, targetLength)`
+
+Pads a string to a target visible length using spaces. Accounts for ANSI sequences when calculating
+length.
+
 ### `features`
 
 Object containing the detected feature configuration:

package/dist/ansi.d.ts

@@ -8,6 +8,8 @@ declare const ansi: typeof makeAnsi & {
     scroll: ReturnType<typeof makeScroll>;
     reset: string;
     style: ReturnType<typeof makeStyle>;
+    padEnd: typeof padEnd;
+    padStart: typeof padStart;
     strip: typeof strip;
     visibleLength: typeof visibleLength;
     sanitize: typeof sanitize;
@@ -23,6 +25,8 @@ import { makeCaret } from "./caret";
 import { makeErase } from "./erase";
 import { makeScroll } from "./scroll";
 import { makeStyle } from "./sgr/style";
+import { padEnd } from "./pad";
+import { padStart } from "./pad";
 import { strip } from "./strip";
 import { visibleLength } from "./strip";
 import { sanitize } from "./strip";
@@ -36,6 +40,8 @@ type Ansi = ReturnType<typeof makeColor> & {
     scroll: ReturnType<typeof makeScroll>;
     reset: string;
     style: ReturnType<typeof makeStyle>;
+    padEnd: typeof padEnd;
+    padStart: typeof padStart;
     strip: typeof strip;
     visibleLength: typeof visibleLength;
     sanitize: typeof sanitize;

package/dist/ansi.js

@@ -2,6 +2,7 @@
 const { makeCaret } = require("./caret");
 const { makeErase } = require("./erase");
 const { getFeatures } = require("./features");
+const { padEnd, padStart } = require("./pad");
 const { makeScroll } = require("./scroll");
 const { makeColor, makeReset, makeStyle } = require("./sgr");
 const { simplify } = require("./simplify");
@@ -18,6 +19,9 @@ const { sanitize, strip, visibleLength } = require("./strip");
     reset : string;
     style : ReturnType<typeof makeStyle>;
 
+    padEnd   : typeof padEnd;
+    padStart : typeof padStart;
+
     strip         : typeof strip;
     visibleLength : typeof visibleLength;
     sanitize      : typeof sanitize;
@@ -37,6 +41,8 @@ function makeAnsi(...args) {
         reset: makeReset(features.colorDepth > 1),
         style: makeStyle(features.style),
         ...makeColor(features.colorDepth),
+        padEnd,
+        padStart,
         strip,
         visibleLength,
         sanitize,

package/dist/index.d.ts

@@ -47,6 +47,8 @@ declare const _exports: ((...args: Args) => Ansi) & {
     }>;
     reset: string;
     style: ReturnType<typeof import("./sgr/style").makeStyle>;
+    padEnd: (text: string, targetLength: number, fillString?: string) => string;
+    padStart: (text: string, targetLength: number, fillString?: string) => string;
     strip: (text: string) => string;
     visibleLength: (text: string) => number;
     sanitize: (text: string) => string;

package/dist/pad.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Pad the given text at the end with the specified fill string to the target visible length without
+ * counting ANSI escape codes.
+ * @type {(text: string, targetLength: number, fillString?: string) => string}
+ */
+export const padEnd: (text: string, targetLength: number, fillString?: string) => string;
+/**
+ * Pad the given text at the start with the specified fill string to the target visible length
+ * without counting ANSI escape codes.
+ * @type {(text: string, targetLength: number, fillString?: string) => string}
+ */
+export const padStart: (text: string, targetLength: number, fillString?: string) => string;

package/dist/pad.js

@@ -0,0 +1,15 @@
+"use strict";
+const { visibleLength } = require("./strip");
+/**
+ * Pad the given text at the end with the specified fill string to the target visible length without
+ * counting ANSI escape codes.
+ * @type {(text: string, targetLength: number, fillString?: string) => string}
+ */
+const padEnd = (text, targetLength, fillString = " ") => text + fillString.repeat(Math.max(0, targetLength - visibleLength(text)) / fillString.length);
+/**
+ * Pad the given text at the start with the specified fill string to the target visible length
+ * without counting ANSI escape codes.
+ * @type {(text: string, targetLength: number, fillString?: string) => string}
+ */
+const padStart = (text, targetLength, fillString = " ") => fillString.repeat(Math.max(0, targetLength - visibleLength(text)) / fillString.length) + text;
+module.exports = { padEnd, padStart };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name"            : "@peteanderson/ansi",
-	"version"         : "0.3.0",
+	"version"         : "0.3.1",
 	"description"     : "ANSI escape sequence generation with automatic feature detection",
 	"author"          : {
 		"name"  : "Pete Anderson",

package/src/ansi.js

@@ -3,6 +3,7 @@
 const {makeCaret}                       = require("./caret");
 const {makeErase}                       = require("./erase");
 const {getFeatures}                     = require("./features");
+const {padEnd, padStart}                = require("./pad");
 const {makeScroll}                      = require("./scroll");
 const {makeColor, makeReset, makeStyle} = require("./sgr");
 const {simplify}                        = require("./simplify");
@@ -20,6 +21,9 @@ const {sanitize, strip, visibleLength}  = require("./strip");
 	reset : string;
 	style : ReturnType<typeof makeStyle>;
 
+	padEnd   : typeof padEnd;
+	padStart : typeof padStart;
+
 	strip         : typeof strip;
 	visibleLength : typeof visibleLength;
 	sanitize      : typeof sanitize;
@@ -43,6 +47,9 @@ function makeAnsi(...args) {
 		style : makeStyle(features.style),
 		...makeColor(features.colorDepth),
 
+		padEnd,
+		padStart,
+
 		strip,
 		visibleLength,
 		sanitize,

package/src/pad.js

@@ -0,0 +1,21 @@
+"use strict";
+
+const {visibleLength} = require("./strip");
+
+/**
+ * Pad the given text at the end with the specified fill string to the target visible length without
+ * counting ANSI escape codes.
+ * @type {(text: string, targetLength: number, fillString?: string) => string}
+ */
+const padEnd = (text, targetLength, fillString = " ") =>
+	text + fillString.repeat(Math.max(0, targetLength - visibleLength(text)) / fillString.length);
+
+/**
+ * Pad the given text at the start with the specified fill string to the target visible length
+ * without counting ANSI escape codes.
+ * @type {(text: string, targetLength: number, fillString?: string) => string}
+ */
+const padStart = (text, targetLength, fillString = " ") =>
+	fillString.repeat(Math.max(0, targetLength - visibleLength(text)) / fillString.length) + text;
+
+module.exports = {padEnd, padStart};