visualwidth - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0

package.json

 {
   "name": "visualwidth",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "unicode character visual width",
@@ -10,3 +10,3 @@ "main": "visualwidth.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node ./t/test.js"
   },
@@ -22,3 +22,6 @@ "repository": {
   "author": "Tokuhiro Matsuno <[e-mail]>",
-  "license": "MIT"
+  "license": "MIT",
+  "devDependencies": {
+    "tape": "^3.0.3"
+  }
 }

t/test.js

@@ -1,30 +0,58 @@
-subtest('width', function () {
-    is(width('あいうえお'), 10);
-    is(width('...'), 3);
-    is(width('Shinjuku'), 8);
-    is(width('…'), 2);
-    is(width("\u2026"), 2); // ambiguous char should be full width
+var test =require('tape');
+var vw = require('../');
+
+test('vw.width', function (t) {
+    t.equals(vw.width('あいうえお'), 10);
+    t.equals(vw.width('...'), 3);
+    t.equals(vw.width('Shinjuku'), 8);
+    t.equals(vw.width('…'), 2);
+    t.equals(vw.width("\u2026"), 2); // ambiguous char should be full width
+    t.end();
 });
-subtest('width/surrogate pair', function () {
-    is(width(String.fromCharCode(0xD800, 0xDC00)), 1); // U+10000 LINEAR B SYLLABLE B008 A (first non-BMP code point)    ( half width )
-    is(width(String.fromCharCode(0xD840, 0xDC0B)), 2);
-    is(width(String.fromCharCode(0xD869, 0xDEB2)), 2);
-    is(width(String.fromCharCode(0xD840, 0xDC0B) + String.fromCharCode(0xD869, 0xDEB2)), 4);
+
+test('vw short for vw.width', function (t) {
+  t.equals(vw.width('あいうえお'), 10);
+  t.end();
+})
+
+test('vw.width/surrogate pair', function (t) {
+    t.equals(vw.width(String.fromCharCode(0xD800, 0xDC00)), 1); // U+10000 LINEAR B SYLLABLE B008 A (first non-BMP code point)    ( half width )
+    t.equals(vw.width(String.fromCharCode(0xD840, 0xDC0B)), 2);
+    t.equals(vw.width(String.fromCharCode(0xD869, 0xDEB2)), 2);
+    t.equals(vw.width(String.fromCharCode(0xD840, 0xDC0B) + String.fromCharCode(0xD869, 0xDEB2)), 4);
+    t.end();
 });
 
-subtest('truncate', function () {
-    is(truncate('DOUTOR 新宿アイランド店', 15, '...'), 'DOUTOR 新宿...');
-    is(truncate('無印良品 アキバ・トリム', 20, '...'), '無印良品 アキバ・...');
-    is(truncate('VILLAGE VANGUARD 渋谷宇田川', 15, '...'), 'VILLAGE VANG...');
-    is(truncate('VILLAGE VANGUARD 渋谷宇田川', 15, '...').length, 15);
-    is(truncate('Shinjuku', 15, '…'), 'Shinjuku');
-    is(truncate('あいうえお', 12, '...'), 'あいうえお');
-    is(truncate('あいうえお', 11, '...'), 'あいうえお');
-    is(truncate('あいうえお', 10, '...'), 'あいうえお');
-    is(truncate('あいうえお', 9,  '...'), 'あいう...');
-    is(truncate('あいうえお', 8,  '...'), 'あい...');
-    is(truncate('あいうえお', 7,  '...'), 'あい...');
-    is(truncate('あいうえお', 6,  '...'), 'あ...');
-    is(truncate('あいうえお', 5,  '...'), 'あ...');
+test('truncate', function (t) {
+    t.equals(vw.truncate('DOUTOR 新宿アイランド店', 15, '...'), 'DOUTOR 新宿...');
+    t.equals(vw.truncate('無印良品 アキバ・トリム', 20, '...'), '無印良品 アキバ・...');
+    t.equals(vw.truncate('VILLAGE VANGUARD 渋谷宇田川', 15, '...'), 'VILLAGE VANG...');
+    t.equals(vw.truncate('VILLAGE VANGUARD 渋谷宇田川', 15, '...').length, 15);
+    t.equals(vw.truncate('Shinjuku', 15, '…'), 'Shinjuku');
+    t.equals(vw.truncate('あいうえお', 12, '...'), 'あいうえお');
+    t.equals(vw.truncate('あいうえお', 11, '...'), 'あいうえお');
+    t.equals(vw.truncate('あいうえお', 10, '...'), 'あいうえお');
+    t.equals(vw.truncate('あいうえお', 9,  '...'), 'あいう...');
+    t.equals(vw.truncate('あいうえお', 8,  '...'), 'あい...');
+    t.equals(vw.truncate('あいうえお', 7,  '...'), 'あい...');
+    t.equals(vw.truncate('あいうえお', 6,  '...'), 'あ...');
+    t.equals(vw.truncate('あいうえお', 5,  '...'), 'あ...');
+    t.end();
 });
 
+test('terminal characters', function (t) {
+    t.equals(vw.width('\x1B[0mH', true), 1);
+    t.equals(vw.width('\x1B[0mH'), 5);
+    t.equals(vw.width('\x1B[31mH\x1B[0m', true), 1);
+    t.equals(vw.width('\x1B[31mあ\x1B[0m', true), 2);
+    t.equals(vw.width('\x1B[31mあ\x1B[0mB', true), 3);
+    t.end();
+});
+
+test('truncate terminal characters', function (t) {
+    t.equals(vw.truncate('\x1B[31mHello World', 10, '...', true), '\x1B[31mHello W...');
+    t.equals(vw.truncate('\x1B[31mHello World\x1B[0m', 10, '...', true), '\x1B[31mHello W...');
+    t.equals(vw.truncate('\x1B[31mHello World', 10, '\x1B[0m...', true), '\x1B[31mHello W\x1B[0m...');
+    t.equals(vw.truncate('私の\x1B[31mモンスター\x1B[0mハンター', 12, '\x1B[0m…', true), '私の\x1b[31mモンス\x1b[0m…');
+    t.end();
+});

visualwidth.js

@@ -9,5 +9,5 @@ // http://tokuhirom.mit-license.org
 if (typeof exports !== 'undefined') {
-    VisualWidth = exports;
+    module.exports = VisualWidth = width;
 } else {
-    global.VisualWidth = VisualWidth = {};
+    global.VisualWidth = VisualWidth = width;
 }
@@ -17,6 +17,10 @@ VisualWidth.truncate = truncate;
 
-function width(string) {
+function width(string, terminal) {
     var counter=0,
         i, l, c, cp;
 
+    if (terminal) {
+        string = string.replace(/\x1B\[[0-9;]*m/g, '')
+    }
+
     for (i=0, l=string.length; i<l; i++) {
@@ -50,22 +54,38 @@ c = string.charCodeAt(i);
 
-function truncate(string, length, suffix) {
+function truncate(string, length, suffix, terminal) {
     var ret = '',
         c, clen,
         counter=0,
-        chars = string.split(''),
+        chars,
         i, l,
-        slen = width(suffix);
+        max,
+        terminalBlock;
 
-    if (width(string) <= length) {
+    if (width(string, terminal) <= length) {
         return string;
     }
 
+    chars = string.split('')
+    max = length - width(suffix, terminal)
+
     for (i=0, l=chars.length; i<l && counter < length; i++) {
         c = chars[i];
-        clen = width(c);
-        if (counter + clen + slen > length) {
+        if (terminalBlock) {
+            if (c === "m") {
+                terminalBlock = false
+            }
+            ret += c;
+            continue;
+        }
+        if (c === "\x1B") {
+            terminalBlock = true;
+        ret += c;
+            continue;
+        }
+        clen = width(c, terminal);
+        counter += clen;
+        if (counter > max) {
             return ret + suffix;
         }
         ret += c;
-        counter += clen;
     }
@@ -72,0 +92,0 @@ return ret; // maybe fatal

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Non-existent author

Supply chain risk

The package was published by an npm account that no longer exists.

Found 1 instance in 1 package

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

16

increased by6.67%

Number of high supply chain risk alerts

0

decreased by-100%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

12330

decreased by-79.57%

Dev dependency count

1

increased byInfinity%

Number of package files

8

decreased by-38.46%

Lines of code

148

decreased by-91.59%

Number of medium supply chain risk alerts

2

increased by100%

No dependency changes