Merge pull request #12 from takamin/useColor

Involving issue 11: escape sequences in a text are not counted for column width

Author: takamin

lib/index.js

@@ -130,6 +130,14 @@
     DataCell.prototype.setData = function(data) {
         this.data = data;
     };
+    DataCell.prototype.visibleLength = function() {
+        if(typeof(this.data) != "string") {
+            return ("" + this.data).length;
+        }
+        // Remove escape sequences for text style from the string
+        var s = this.data.replace(/\x1b[^m]*m/g, '');
+        return s.length;
+    };
 
     //
     // Column class
@@ -147,11 +155,10 @@
         return this.width;
     };
     Column.prototype.setCellAt = function(row, cell) {
-        var data = cell.getData();
-        var s = "" + data;
-        var width = s.length;
+        var width = cell.visibleLength();
         this.cellAtRow[row] = cell;
         if(this.opt.autoAlign) {
+            var data = cell.getData();
             if(typeof(data) == "number") {
                 this.updateNumWidth(data);
                 width = this.getNumMaxWidth();

package.json

@@ -1,23 +1,34 @@
 {
-    "name": "list-it",
-    "version": "0.3.0",
-    "description":
-        "This module is used to create a preformatted text table.",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/takamin/list-it"
-	},
-    "directories": {
-        "lib": "./lib"
-    },
-    "main": "./lib/index.js",
-    "scripts": {
-        "test": "node ./test/test.js"
-    },
-    "keywords": [ "console", "pre", "text", "column", "table", "format", "cli" ],
-    "author": "Koji Takami",
-    "license": "MIT",
-    "devDependencies": {
-         "chai": "^3.5.0"
-    }
+  "name": "list-it",
+  "version": "0.3.1",
+  "description": "This module is used to create a preformatted text table.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/takamin/list-it"
+  },
+  "directories": {
+    "lib": "./lib"
+  },
+  "main": "./lib/index.js",
+  "scripts": {
+    "test": "node ./test/test.js"
+  },
+  "keywords": [
+    "console",
+    "pre",
+    "text",
+    "column",
+    "table",
+    "format",
+    "cli"
+  ],
+  "author": "Koji Takami",
+  "license": "MIT",
+  "devDependencies": {
+    "ansi-escape-sequences": "^2.2.2",
+    "chai": "^3.5.0"
+  },
+  "dependencies": {
+    "ansi-escape-sequences": "^2.2.2"
+  }
 }

test/test.js

@@ -4,6 +4,24 @@
     var chai = require('chai');
     var should = chai.should();
     var assert = chai.assert;
+    var ansi = require('ansi-escape-sequences');
+    var style = {};
+    var fg = {};
+    var bg = {};
+    Object.keys(ansi.style).forEach(function(key) {
+        var value = ansi.style[key];
+        if(/^bg-/.test(key)) {
+            bg[key.substr(3)] = value;
+        } else {
+            fg[key] = value;
+        }
+    });
+    Object.keys(fg).forEach(function(key) {
+        if( !(key in bg) ) {
+            style[key] = fg[key];
+            delete fg[key];
+        }
+    });
     var col = 0;
     var logbuf = listit.buffer();
     process.on("exit", function() {
@@ -15,16 +33,25 @@
         func();
         titles = titles.slice(0, titles.length - 1);
     }
+    function styled(message, styles) {
+        var args = Array.apply(null, arguments);
+        styles = args.slice(1);
+        styles.push(message, ansi.style.reset);
+        return styles.join('');
+    }
     function it(name, test) {
         logbuf.d(titles.join(" ") + " " + name);
         try {
             test();
-            logbuf.d("OK");
+            logbuf.d(styled(" PASS ",
+                        bg.green, fg.white));
             logbuf.nl();
         } catch(ex) {
-            logbuf.d("FAIL");
+            logbuf.d(styled(" FAIL ",
+                        bg.red, fg.white, style.bold));
             logbuf.nl();
             test();
+            console.error(ex);
         }
     }
     describe("listit.buffer", function() {
@@ -223,7 +250,7 @@
                         "C 333.3 D   -4.444");
                 });
             });
-            describe("bidimentional data", function() {
+            describe("bidimensional data", function() {
                 it("no autoAlign", function() {
                     var buffer = new listit.buffer();
                     buffer.d([
@@ -247,4 +274,19 @@
             });
         });
     });
+    describe("Do not count escape sequences for column width,", function() {
+        Object.keys(ansi.style).forEach(function(key) {
+            var style = ansi.style[key];
+            it("style " + key + "#1", function() {
+                var buffer = new listit.buffer();
+                buffer.d([ styled("A", style), "B" ], ["C", "D"]);
+                assert.equal(buffer.toString(), styled("A", style) + " B\n" + "C D");
+            });
+            it("style " + key + "#2", function() {
+                var buffer = new listit.buffer();
+                buffer.d([ "A", styled("B", style) ], ["C", "D"]);
+                assert.equal(buffer.toString(), "A " + styled("B", style) + "\n" + "C D");
+            });
+        });
+    });
 }());