pixl-cli 1.1.2 → 1.1.3

package/README.md

@@ -20,6 +20,8 @@
 	* [Displaying Info Boxes](#displaying-info-boxes)
 		+ [Centering Text](#centering-text)
 		+ [Word-Wrapping Text](#word-wrapping-text)
+	* [Displaying Definition Lists](#displaying-definition-lists)
+	* [Displaying Dashboard Grids](#displaying-dashboard-grids)
 	* [Displaying Tables](#displaying-tables)
 	* [Graphical Progress Bars](#graphical-progress-bars)
 		+ [Configuration](#configuration)
@@ -491,7 +493,7 @@ You can customize the dashboard grid with these options:
 | `unitWidth` | Target outer width used to select the responsive column count.  Defaults to `20`. |
 | `minCols` | Preferred minimum number of columns.  Defaults to `3`.  Extremely narrow terminals may use fewer to avoid overflow. |
 | `maxCols` | Maximum number of columns.  Defaults to `5`. |
-| `gap` | Horizontal spaces between units and blank lines between grid rows.  Defaults to `1`. |
+| `gap` | Horizontal spaces between units.  Grid rows use `gap - 1` blank lines.  Defaults to `1`, producing no vertical blank line. |
 | `indent` | Horizontal margin in characters on both sides of the grid.  Defaults to `0`. |
 | `valueStyles` | An array of [chalk](https://www.npmjs.com/package/chalk) styles or functions for values.  Defaults to `["bold"]`. |
 | `labelStyles` | An array of styles or functions for labels.  Defaults to `["gray"]`. |

package/cli.js

@@ -176,7 +176,11 @@ var cli = module.exports = {
 		output.push( indent + this.applyStyles("┌" + this.repeat("─", width) + "┐", styles) );
 		
 		// left, content, right
-		var lines = text.split(/\n/);
+		// Styled text normally carries its SGR modes across newlines, but the styled
+		// right border resets those modes before the next content line.  Make each
+		// line self-contained before inserting borders between them.
+		var safeText = (styles && styles.length) ? Util.preserveAnsiLineStyles(text) : text;
+		var lines = safeText.split(/\n/);
 		while (vspace-- > 0) {
 			lines.unshift( "" );
 			lines.push( "" );
@@ -290,7 +294,7 @@ var cli = module.exports = {
 	
 	dashGrid: function(rows, args) {
 		// Render a responsive grid of equal-sized dashboard units.  Each unit has a
-		// centered value, a centered label, two blank spacer rows and its own border.
+		// centered value, a centered label, a blank spacer row and its own border.
 		var self = this;
 		if (!rows || !rows.length) return '';
 		if (!args) args = {};
@@ -375,7 +379,7 @@ var cli = module.exports = {
 		} );
 		
 		var renderUnit = function(unit) {
-			// The interior layout is: blank, value, blank, label.
+			// The interior layout is: value, blank, label.
 			var top = self.applyStyles(
 				'┌' + self.repeat('─', innerWidth) + '┐', borderStyles
 			);
@@ -388,7 +392,6 @@ var cli = module.exports = {
 			
 			return [
 				top,
-				// blank,
 				leftBorder + centerCell(truncate(unit.value)) + rightBorder,
 				blank,
 				leftBorder + centerCell(truncate(unit.label)) + rightBorder,
@@ -401,7 +404,7 @@ var cli = module.exports = {
 			var gridRow = units.slice(rowIdx, rowIdx + numCols).map(renderUnit);
 			
 			// Join corresponding lines from each unit to form one complete grid row.
-			for (var lineIdx = 0; lineIdx < 6; lineIdx++) {
+			for (var lineIdx = 0; lineIdx < gridRow[0].length; lineIdx++) {
 				output.push(
 					indent + gridRow.map( function(unit) {
 						return unit[lineIdx];
@@ -409,9 +412,10 @@ var cli = module.exports = {
 				);
 			}
 			
-			// The same gap controls vertical blank lines between rows of units.
+			// Adjacent text lines already provide one row of vertical separation, so
+			// subtract one when translating the horizontal gap into blank lines.
 			if (rowIdx + numCols < units.length) {
-				for (var gapIdx = 0; gapIdx < gap; gapIdx++) output.push('');
+				for (var gapIdx = 0; gapIdx < Math.max(0, gap - 1); gapIdx++) output.push('');
 			}
 		}
 		

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "pixl-cli",
-	"version": "1.1.2",
+	"version": "1.1.3",
 	"description": "Tools for building command-line apps for Node.js.",
 	"author": "Joseph Huckaby <jhuckaby@gmail.com>",
 	"homepage": "https://github.com/jhuckaby/pixl-cli",

package/util.js

@@ -32,8 +32,36 @@ function splitAnsiGraphemes(text) {
 	return units;
 }
 
+function preserveAnsiLineStyles(text) {
+	// A styled multi-line string normally relies on terminal modes carrying across
+	// newline characters.  Callers such as cli.box() insert independently styled
+	// borders between those lines, whose reset codes can cancel the content styles.
+	// Close all modes at each line ending, then restore the exact SGR state after the
+	// next border by replaying the original SGR history at the next line's start.
+	var lines = text.split('\n');
+	if (lines.length < 2) return text;
+	
+	var sgrHistory = '';
+	var sgrPattern = /^(?:\u001B\[|\u009B)[0-9:;]*m$/;
+	var reset = '\u001b[0m';
+	
+	return lines.map( function(line, idx) {
+		var reopen = sgrHistory;
+		
+		// Only sequences from the original text enter the history.  Synthetic reset
+		// and replay sequences added here must not accumulate on subsequent lines.
+		splitAnsiGraphemes(line).forEach( function(unit) {
+			if (unit.ansi && unit.text.match(sgrPattern)) sgrHistory += unit.text;
+		} );
+		
+		if ((idx < lines.length - 1) && sgrHistory) line += reset;
+		return reopen + line;
+	} ).join('\n');
+}
+
 module.exports = {
 	ansiPattern: ansiPattern,
 	graphemeSegmenter: graphemeSegmenter,
-	splitAnsiGraphemes: splitAnsiGraphemes
+	splitAnsiGraphemes: splitAnsiGraphemes,
+	preserveAnsiLineStyles: preserveAnsiLineStyles
 };