wcwidth.js - npm Package Compare versions

Comparing version 0.0.4 to 1.0.0

INSTALL.md

@@ -1,8 +0,8 @@
-How To Build and Install wcwidth.js
+How to build and install wcwidth.js
 ===================================
 
 This package does not provide an automated way to build or install the library
-except using [`npm`](http://npmjs.org/package/wcwidth.js) because wcwidth.js is
-intended to runs on top of [`node.js`](http://nodejs.org) that is a javascript
-interpreter. If you have `node.js` installed,
+except using [`npm`](http://npmjs.org/package/wcwidth.js) because `wcwidth.js`
+is intended to runs on top of [`node.js`](http://nodejs.org). If you have
+`node.js` in your system,
 
@@ -9,0 +9,0 @@ npm install wcwidth.js

LICENSE.md

@@ -1,7 +0,7 @@
-wcwidth.js: JavaScript Portng of Markus Kuhn's wcwidth() Implementation
-=======================================================================
+wcwidth.js: a javascript portng of C's wcwidth()
+================================================
 
-Copyright (C) 2012 by Jun Woong.
+Copyright (C) 2012-2014 by Jun Woong and Tim Oxley.
 
-This package is a JavaScript porting of `wcwidth()` implementation
+This package is a javascript porting of `wcwidth()` implementation
 [by Markus Kuhn](http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c).
@@ -24,7 +24,7 @@
 OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
-BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
-IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGE.
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+OF SUCH DAMAGE.

package.json

 {
   "name": "wcwidth.js",
-  "version": "0.0.4",
-  "description": "A JavaScript porting of C's wcwidth() and wcswidth()",
+  "version": "1.0.0",
+  "description": "a javascript porting of C's wcwidth()",
   "author": {
@@ -11,2 +11,7 @@ "name": "Woong Jun",
   "contributors": [
+    {
+      "name": "Tim Oxley",
+      "email": "[e-mail]",
+      "url": "http://campjs.com/"
+    }
   ],
@@ -22,9 +27,10 @@ "homepage": "http://code.woong.org/wcwidth.js",
   },
-  "main": "wcwidth.js",
+  "main": "index.js",
   "dependencies": {
-    "underscore": ">= 1.3.0"
+    "defaults": "^1.0.0"
   },
   "devDependencies": {
+    "tape": "^2.13.4"
   },
-  "engines": { "node": ">= 0.8.0" },
+  "engines": { "node": ">=0.8.0" },
   "licenses": "MIT",
@@ -36,3 +42,10 @@ "keywords": [
     "wcwidth", "wcswidth"
-  ]
+  ],
+  "directories": {
+    "doc": "doc",
+    "test": "test"
+  },
+  "scripts": {
+    "test": "tape test/*.js"
+  }
 }

README.md

@@ -1,61 +0,99 @@
-wcwidth.js: A JavaScript Porting of Markus Kuhn's wcwidth() Implementation
-==========================================================================
+wcwidth.js: a javascript porting of C's wcwidth()
+=================================================
 
-`wcwidth.js` is a simple JavaScript porting of `wcwidth()` implemented in C
+`wcwidth.js` is a simple javascript porting of `wcwidth()` implemented in C
 [by Markus Kuhn](http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c).
 
-`wcwidth()` and its string version, `wcswidth()` are defined by IEEE Std
-1002.1-2001, a.k.a. POSIX.1-2001, and return the number of columns used to
-represent the given wide character and string. Markus's implementation assumes
-the wide character given to those functions to be encoded in ISO 10646, which
-is almost true for JavaScript's characters.
+[`wcwidth()`](http://www.opengroup.org/onlinepubs/007904975/functions/wcwidth.html)
+and its string version,
+[`wcswidth()`](http://www.opengroup.org/onlinepubs/007904975/functions/wcswidth.html)
+are defined by IEEE Std 1002.1-2001, a.k.a. POSIX.1-2001, and return the number
+of columns used to represent a wide character and string on fixed-width output
+devices like terminals. Markus's implementation assumes wide characters to be
+encoded in [ISO 10646](http://en.wikipedia.org/wiki/Universal_Character_Set),
+which is _almost_ true for JavaScript; _almost_ because JavaScript uses
+[UCS-2](http://en.wikipedia.org/wiki/UTF-16) and has problems with surrogate
+pairs. `wcwidth.js` converts surrogate pairs to Unicode code points to handle
+them correctly.
 
-For convenience, `wcwidth.js` sets the getter of the property named `wcwidth`
-for the string type. You don't need to invoke a function to get the width of
-strings, but inspecting the `wcwidth` property is enough. The following code
-snippet shows how to use `wcwidth.js`:
+Following the original implementation, this library defines the column width of
+an ISO 10646 character as follows:
+- the null character (`U+0000`) has a column width of `opts.null` (whose
+  default value is 0);
+- other
+  [C0/C1 control characters](http://en.wikipedia.org/wiki/C0_and_C1_control_codes)
+  and `DEL` will lead to a column width of `opts.control` (whose default value
+  is 0);
+- non-spacing and enclosing combining characters
+  ([general category code](http://www.unicode.org/reports/tr44/#GC_Values_Table)
+  `Mn` or `Me`) in the Unicode database) have a column width of 0;
+- `SOFT HYPHEN` (`U+00AD`) has a column width of 1;
+- other format characters (general category code `Cf` in the Unicode database)
+  and `ZERO WIDTH SPACE` (`U+200B`) have a column width of 0;
+- Hangul Jamo medial vowels and final consonants (`U+1160`-`U+11FF`) have a
+  column width of 0;
+- spacing characters in the East Asian Wide (`W`) or East Asian Full-width
+  (`F`) category as defined in
+  [Unicode Technical Report #11](http://www.unicode.org/reports/tr11/) have a
+  column width of 2; and
+- all remaining characters (including all printable
+  [ISO 8859-1](http://en.wikipedia.org/wiki/ISO/IEC_8859-1) and
+  [WGL4 characters](http://en.wikipedia.org/wiki/Windows_Glyph_List_4), Unicode
+  control characters, etc.) have a column width of 1.
 
-    var wcwidth = require('wcwidth')({
-        nul:         0,
-        control:     -1,
-        monkeypatch: true
-    });    // equivalent to var wcwidth = require('wcwidth')();
+A surrogate high or low value which constitutes no pair is considered to have a
+column width of 1 according to the behavior of widespread terminals.
 
-    console.log("한글".wcwidth);    // prints 4
-    console.log("\0".wcwidth);      // prints 0
-    console.log("\t".wcwidth);      // prints -1
+See the
+[documentation](https://github.com/mycoboco/wcwidth.js/blob/master/doc/index.md)
+from the C implementation for details.
 
-The argument `{ nul: 0, control: -1, monkeypatch: true }` (which are the
-default values, in fact) tells `wcwidth.js` to return 0 for the NUL character
-and -1 for non-printable control characters. Setting a negative value to `nul`
-or `control` makes the `wcwidth` property set to -1 for any string that
-contains NUL or control characters respectively. If you plan to replace each
-control character with, say, `???` when printing, you can 'require'
-`wcwidth.js` as follows:
+`wcwidth.js` is simple to use:
 
-    var wcwidth = require('wcwidth')({
+    var wcwidth = require('wcwidth.js')
+
+    wcwidth('한글')    // 4
+    wcwidth('\0')      // 0; NUL
+    wcwidth('\t')      // 0; control characters
+
+If you plan to replace `NUL` or control characters with, say, `???` before
+printing, use `wcwidth.config()` that returns a closure to run `wcwidth` with
+your configuration:
+
+    var mywidth = wcwidth.config({
+        nul:     3,
         control: 3
-    });    // leaving nul as 0
+    })
 
-    console.log("\t".wcwidth);    // prints 3
-    console.log("\0".wcwidth);    // prints 0
+    mywidth('\0\f')      // 6
+    mywidth('한\t글')    // 7
 
-The last option `monkeypatch` allows `wcwidth.js` to monkey-patch
-`String.prototype` to provide the getter `wcwidth`. Even if it is convenient to
-have a getter that looks like the native one, it is sometimes unwanted as
-adding a getter into `String.prototype` may break node.js's module system; you
-are not guaranteed to have the version your code `require`s through the getter
-if other modules you're using also depend on other versions of `wcwidth.js`
-(thanks to [timoxley](https://github.com/timoxley) for the information). By
-setting `monkeypatch` to `false`, `wcwidth.js` touches no global object and
-provides no getter but a callable method explained below.
+Setting these options to -1 gives a function that returns -1 for a string
+containing an instance of `NUL` or control characters:
 
-`wcwidth.js` also provides a method. Since JavaScript has no character type,
-it is meaningless to have two versions while POSIX does for C. The method also
-accepts a code value that can be obtained by the `charCodeAt()` method.
+    mywidth = wcwidth.config({
+        nul:     0,
+        control: -1
+    })
 
-    console.log(wcwidth('한'));                 // prints 2
-    console.log(wcwidth('글'.charCodeAt(0));    // prints 2
-    console.log(wcwidth('한글'));               // prints 4
+    mywidth('java\0script')    // 10
+    mywidth('java\tscript')    // -1
 
+This is useful when detecting if a string has non-printable characters.
+
+Due to the risk of monkey-patching, the `String` getter is no longer provided.
+Even if discouraged, you can still monkey-patch by yourself as follows:
+
+    String.prototype.__defineGetter__('wcwidth', function () {
+        return wcwidth(this);
+    })
+    '한글'.wcwidth    // 4
+
+JavaScript has no character type, thus meaningless to have two versions of
+`wcwidth` while POSIX does for C. `wcwidth` also accepts a code value obtained
+by `charCodeAt()`:
+
+    wcwidth('한')                  // prints 2
+    wcwidth('글'.charCodeAt(0))    // prints 2
+
 `INSTALL.md` explains how to build and install the library. For the copyright
@@ -62,0 +100,0 @@ issues, see the accompanying `LICENSE.md` file.

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

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20020

increased by12.29%

Number of package files

9

increased by50%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

104

increased by57.58%

Worsened metrics

Dev dependency count

1

increased byInfinity%

Lines of code

221

decreased by-7.92%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addeddefaults@^1.0.0

• + Addedclone@1.0.4(transitive)

• + Addeddefaults@1.0.4(transitive)

• - Removedunderscore@>= 1.3.0

• - Removedunderscore@1.13.7(transitive)