Merge pull request #15 from takamin/fix-the-table-to-be-broken-by-japanese-chars

Fix a bug that table was broken by wide-chars

Author: takamin

README.md

@@ -12,6 +12,17 @@ You can put it to the console or a preformated text-file.
 
 When a autoAlign option is set, the numbers are aligned by its fraction point.
 
+CHANGES
+-------
+
+* v0.3.3 - Bug fix : Measure a width of wide-chars of east asian characters correctly
+by using the npm eastasianwidth.
+* v0.3.2 - Change Test : Support mocha to test.
+* v0.3.1 - Bug fix : Do not count escape sequences in data for column width.
+* v0.3.0 - Enhance : Several columns or rows can be added at a time.
+* v0.2.0 - Enhance : Auto align mode is available.
+* v0.1.0 - Initial release
+
 SAMPLE
 ------
 
@@ -92,6 +103,44 @@ NEPTUNE      102.0      49528        1638       11.0       23.5       16.1
 PLUTO          0.0146    2370        2095        0.7        1.3     -153.3
 ```
 
+### East asian characters
+
+__japanese-foods-jp.js__
+
+```
+var listit = require("list-it");
+var buf = listit.buffer();
+console.log(
+    buf
+        .d("1").d("寿司")
+            .d("酢とご飯とシーフード")
+            .d("健康的だ").nl()
+        .d("2").d("焼肉")
+            .d("日本のグリルされたお肉")
+            .d("ジューシー").nl()
+        .d("3").d("ラーメン")
+            .d("日本のスープに入った麺")
+            .d("大好き").nl()
+        .d("4").d("天ぷら")
+            .d("シーフードや野菜に衣をつけて揚げたもの")
+            .d("おいしー").nl()
+        .d("5").d("刺身")
+            .d("大変フレッシュな魚のスライス")
+            .d("食べてみて！あご落ちるぜ").nl()
+        .toString());
+```
+
+outputs:
+
+```
+$ node sample/japanese-food-jp.js
+1 寿司     酢とご飯とシーフード                   健康的だ
+2 焼肉     日本のグリルされたお肉                 ジューシー
+3 ラーメン 日本のスープに入った麺                 大好き
+4 天ぷら   シーフードや野菜に衣をつけて揚げたもの おいしー
+5 刺身     大変フレッシュな魚のスライス           食べてみて！あご落ちるぜ
+```
+
 
 METHODS
 -------

lib/index.js

@@ -1,5 +1,6 @@
 (function() {
     "use strict";
+    var eaw = require('eastasianwidth');
     var exports = {};
     var privates = {};
 
@@ -130,13 +131,18 @@
     DataCell.prototype.setData = function(data) {
         this.data = data;
     };
+
     DataCell.prototype.visibleLength = function() {
         if(typeof(this.data) != "string") {
             return ("" + this.data).length;
         }
+        return DataCell.visibleLength(this.data);
+    };
+
+    DataCell.visibleLength = function(data) {
         // Remove escape sequences for text style from the string
-        var s = this.data.replace(/\x1b[^m]*m/g, '');
-        return s.length;
+        var s = data.replace(/\x1b[^m]*m/g, '');
+        return eaw.length(s);
     };
 
     //
@@ -181,7 +187,7 @@
             }
         }
         var s = "" + data;
-        while(s.length < m) {
+        while(DataCell.visibleLength(s) < m) {
             s += ' ';
         }
         return s;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "list-it",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "This module is used to create a preformatted text table.",
   "repository": {
     "type": "git",
@@ -29,6 +29,7 @@
     "chai": "^3.5.0"
   },
   "dependencies": {
-    "ansi-escape-sequences": "^2.2.2"
+    "ansi-escape-sequences": "^2.2.2",
+    "eastasianwidth": "^0.1.1"
   }
 }

sample/japanese-food-jp.js

@@ -0,0 +1,20 @@
+var listit = require("../lib");
+var buf = listit.buffer();
+console.log(
+    buf
+        .d("1").d("寿司")
+            .d("酢とご飯とシーフード")
+            .d("健康的だ").nl()
+        .d("2").d("焼肉")
+            .d("日本のグリルされたお肉")
+            .d("ジューシー").nl()
+        .d("3").d("ラーメン")
+            .d("日本のスープに入った麺")
+            .d("大好き").nl()
+        .d("4").d("天ぷら")
+            .d("シーフードや野菜に衣をつけて揚げたもの")
+            .d("おいしー").nl()
+        .d("5").d("刺身")
+            .d("大変フレッシュな魚のスライス")
+            .d("食べてみて！あご落ちるぜ").nl()
+        .toString());

test/test.js

@@ -302,4 +302,21 @@
             });
         });
     });
+    describe("Measure a width of wide-chars correctly.", function() {
+        it("All Japanese", function() {
+            var buffer = new listit.buffer();
+            buffer
+                .d("1").d("寿司").d("酢とご飯とシーフード").d("健康的だ").nl()
+                .d("2").d("焼肉").d("日本のグリルされたお肉").d("ジューシー").nl()
+                .d("3").d("ラーメン").d("日本のスープに入った麺").d("大好き").nl()
+                .d("4").d("天ぷら").d("シーフードや野菜に衣をつけて揚げたもの").d("おいしー").nl()
+                .d("5").d("刺身").d("大変フレッシュな魚のスライス").d("食べてみて！あご落ちるぜ").nl();
+                assert.equal(buffer.toString(),
+                    "1 寿司     酢とご飯とシーフード                   健康的だ                \n" +
+                    "2 焼肉     日本のグリルされたお肉                 ジューシー              \n" +
+                    "3 ラーメン 日本のスープに入った麺                 大好き                  \n" +
+                    "4 天ぷら   シーフードや野菜に衣をつけて揚げたもの おいしー                \n" +
+                    "5 刺身     大変フレッシュな魚のスライス           食べてみて！あご落ちるぜ");
+        });
+    });
 }((typeof(describe) == "function") ? describe : false, (typeof(it) == "function") ? it : false));