isutf8 2.1.0 → 4.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Denis Seleznev, hcodes@yandex.ru
+Copyright (c) 2021 Denis Seleznev, hcodes@yandex.ru
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,8 +1,7 @@
 [![NPM Version](https://img.shields.io/npm/v/isutf8.svg?style=flat)](https://www.npmjs.org/package/isutf8)
 [![NPM Downloads](https://img.shields.io/npm/dm/isutf8.svg?style=flat)](https://www.npmjs.org/package/isutf8)
-[![Dependency Status](https://img.shields.io/david/hcodes/isutf8.svg?style=flat)](https://david-dm.org/hcodes/isutf8)
-[![Build Status](https://img.shields.io/travis/hcodes/isutf8.svg?style=flat)](https://travis-ci.org/hcodes/isutf8)
-[![Coverage Status](https://img.shields.io/coveralls/hcodes/isutf8.svg?branch=master)](https://coveralls.io/r/hcodes/isutf8)
+[![Bundlephobia](https://badgen.net/bundlephobia/minzip/isutf8)](https://bundlephobia.com/result?p=isutf8)
+[![install size](https://packagephobia.com/badge?p=isutf8)](https://packagephobia.com/result?p=isutf8)
 
 isutf8
 ======
@@ -13,6 +12,8 @@ Quick check if a Node.js Buffer or Uint8Array is UTF-8.
 `npm install isutf8`
 
 ## Usage
+
+### CommonJS
 ```js
 'use strict';
 
@@ -28,5 +29,18 @@ console.log(isUtf8(arr)); // => true
 
 ```
 
+### ES Modules or TypeScript
+```js
+import isUtf8 from 'isutf8';
+
+const buf = Buffer.from([0xd0, 0x90]);
+console.log(isUtf8(buf)); // => true
+
+// or 
+
+const arr = new Uint8Array([0xd0, 0x90]);
+console.log(isUtf8(arr)); // => true
+```
+
 ## License
 [MIT License](./LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="node" />
+/**
+ * Check if a Node.js Buffer or Uint8Array is UTF-8.
+ */
+export default function isUtf8(buf?: Buffer | Uint8Array): boolean;

package/dist/index.esm.js

@@ -0,0 +1,79 @@
+/*
+    https://tools.ietf.org/html/rfc3629
+
+    UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4
+
+    UTF8-1    = %x00-7F
+
+    UTF8-2    = %xC2-DF UTF8-tail
+
+    UTF8-3    = %xE0 %xA0-BF UTF8-tail
+                %xE1-EC 2( UTF8-tail )
+                %xED %x80-9F UTF8-tail
+                %xEE-EF 2( UTF8-tail )
+
+    UTF8-4    = %xF0 %x90-BF 2( UTF8-tail )
+                %xF1-F3 3( UTF8-tail )
+                %xF4 %x80-8F 2( UTF8-tail )
+
+    UTF8-tail = %x80-BF
+*/
+/**
+ * Check if a Node.js Buffer or Uint8Array is UTF-8.
+ */
+function isUtf8(buf) {
+    if (!buf) {
+        return false;
+    }
+    var i = 0;
+    var len = buf.length;
+    while (i < len) {
+        // UTF8-1 = %x00-7F
+        if (buf[i] <= 0x7F) {
+            i++;
+            continue;
+        }
+        // UTF8-2 = %xC2-DF UTF8-tail
+        if (buf[i] >= 0xC2 && buf[i] <= 0xDF) {
+            // if(buf[i + 1] >= 0x80 && buf[i + 1] <= 0xBF) {
+            if (buf[i + 1] >> 6 === 2) {
+                i += 2;
+                continue;
+            }
+            else {
+                return false;
+            }
+        }
+        // UTF8-3 = %xE0 %xA0-BF UTF8-tail
+        // UTF8-3 = %xED %x80-9F UTF8-tail
+        if (((buf[i] === 0xE0 && buf[i + 1] >= 0xA0 && buf[i + 1] <= 0xBF) ||
+            (buf[i] === 0xED && buf[i + 1] >= 0x80 && buf[i + 1] <= 0x9F)) && buf[i + 2] >> 6 === 2) {
+            i += 3;
+            continue;
+        }
+        // UTF8-3 = %xE1-EC 2( UTF8-tail )
+        // UTF8-3 = %xEE-EF 2( UTF8-tail )
+        if (((buf[i] >= 0xE1 && buf[i] <= 0xEC) ||
+            (buf[i] >= 0xEE && buf[i] <= 0xEF)) &&
+            buf[i + 1] >> 6 === 2 &&
+            buf[i + 2] >> 6 === 2) {
+            i += 3;
+            continue;
+        }
+        // UTF8-4 = %xF0 %x90-BF 2( UTF8-tail )
+        //          %xF1-F3 3( UTF8-tail )
+        //          %xF4 %x80-8F 2( UTF8-tail )
+        if (((buf[i] === 0xF0 && buf[i + 1] >= 0x90 && buf[i + 1] <= 0xBF) ||
+            (buf[i] >= 0xF1 && buf[i] <= 0xF3 && buf[i + 1] >> 6 === 2) ||
+            (buf[i] === 0xF4 && buf[i + 1] >= 0x80 && buf[i + 1] <= 0x8F)) &&
+            buf[i + 2] >> 6 === 2 &&
+            buf[i + 3] >> 6 === 2) {
+            i += 4;
+            continue;
+        }
+        return false;
+    }
+    return true;
+}
+
+export { isUtf8 as default };

package/{index.js → dist/index.js}

@@ -1,4 +1,5 @@
 'use strict';
+
 /*
     https://tools.ietf.org/html/rfc3629
 
@@ -19,88 +20,61 @@
 
     UTF8-tail = %x80-BF
 */
-
 /**
- * Check if a Node.js Buffer or Uint8Array is utf-8
- *
- * @param {Buffer|Uint8Array} buf
- * @returns {boolean}
+ * Check if a Node.js Buffer or Uint8Array is UTF-8.
  */
 function isUtf8(buf) {
     if (!buf) {
         return false;
     }
-
-    var i = 0, len = buf.length;
-
-    while(i < len) {
+    var i = 0;
+    var len = buf.length;
+    while (i < len) {
         // UTF8-1 = %x00-7F
         if (buf[i] <= 0x7F) {
             i++;
-
             continue;
         }
-
         // UTF8-2 = %xC2-DF UTF8-tail
         if (buf[i] >= 0xC2 && buf[i] <= 0xDF) {
             // if(buf[i + 1] >= 0x80 && buf[i + 1] <= 0xBF) {
             if (buf[i + 1] >> 6 === 2) {
                 i += 2;
-
                 continue;
-            } else {
+            }
+            else {
                 return false;
             }
         }
-
         // UTF8-3 = %xE0 %xA0-BF UTF8-tail
         // UTF8-3 = %xED %x80-9F UTF8-tail
-        if (
-                (
-                    (buf[i] === 0xE0 && buf[i + 1] >= 0xA0 && buf[i + 1] <= 0xBF) ||
-                    (buf[i] === 0xED && buf[i + 1] >= 0x80 && buf[i + 1] <= 0x9F)
-                ) && buf[i + 2] >> 6 === 2
-            ) {
+        if (((buf[i] === 0xE0 && buf[i + 1] >= 0xA0 && buf[i + 1] <= 0xBF) ||
+            (buf[i] === 0xED && buf[i + 1] >= 0x80 && buf[i + 1] <= 0x9F)) && buf[i + 2] >> 6 === 2) {
             i += 3;
-
             continue;
         }
-
         // UTF8-3 = %xE1-EC 2( UTF8-tail )
         // UTF8-3 = %xEE-EF 2( UTF8-tail )
-        if (
-                (
-                    (buf[i] >= 0xE1 && buf[i] <= 0xEC) ||
-                    (buf[i] >= 0xEE && buf[i] <= 0xEF)
-                ) &&
-                buf[i + 1] >> 6 === 2 &&
-                buf[i + 2] >> 6 === 2
-        ) {
+        if (((buf[i] >= 0xE1 && buf[i] <= 0xEC) ||
+            (buf[i] >= 0xEE && buf[i] <= 0xEF)) &&
+            buf[i + 1] >> 6 === 2 &&
+            buf[i + 2] >> 6 === 2) {
             i += 3;
-
             continue;
         }
-
         // UTF8-4 = %xF0 %x90-BF 2( UTF8-tail )
         //          %xF1-F3 3( UTF8-tail )
         //          %xF4 %x80-8F 2( UTF8-tail )
-        if (
-                (
-                    (buf[i] === 0xF0 && buf[i + 1] >= 0x90 && buf[i + 1] <= 0xBF) ||
-                    (buf[i] >= 0xF1 && buf[i] <= 0xF3 && buf[i + 1] >> 6 === 2) ||
-                    (buf[i] === 0xF4  && buf[i + 1] >= 0x80 && buf[i + 1] <= 0x8F)
-                ) &&
+        if (((buf[i] === 0xF0 && buf[i + 1] >= 0x90 && buf[i + 1] <= 0xBF) ||
+            (buf[i] >= 0xF1 && buf[i] <= 0xF3 && buf[i + 1] >> 6 === 2) ||
+            (buf[i] === 0xF4 && buf[i + 1] >= 0x80 && buf[i + 1] <= 0x8F)) &&
             buf[i + 2] >> 6 === 2 &&
-            buf[i + 3] >> 6 === 2
-        ) {
+            buf[i + 3] >> 6 === 2) {
             i += 4;
-
             continue;
         }
-
         return false;
     }
-
     return true;
 }
 

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "isutf8",
-  "description": "Check if a Node.js Buffer or Uint8Array is utf-8",
-  "version": "2.1.0",
+  "description": "Check if a Node.js Buffer or Uint8Array is UTF-8",
+  "version": "4.0.0",
   "author": {
     "name": "Denis Seleznev",
     "email": "hcodes@yandex.ru",
     "url": "https://github.com/hcodes"
   },
-  "main": "index.js",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
   "homepage": "https://github.com/hcodes/isutf8",
   "license": "MIT",
   "repository": {
@@ -24,22 +25,32 @@
     "Uint8Array"
   ],
   "engines": {
-    "node": ">= 0.12"
+    "node": ">= 12"
   },
   "devDependencies": {
-    "chai": "^4.2.0",
-    "eslint": "^6.2.2",
-    "mocha": "^6.2.0",
-    "nyc": "^14.1.1"
+    "@rollup/plugin-typescript": "^8.3.0",
+    "@types/jest": "^27.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.2.0",
+    "@typescript-eslint/parser": "^5.2.0",
+    "del-cli": "^4.0.1",
+    "eslint": "^8.1.0",
+    "jest": "^27.3.1",
+    "rollup": "^2.58.3",
+    "ts-jest": "^27.0.7",
+    "tslib": "^2.3.1",
+    "typescript": "^4.4.4"
   },
   "scripts": {
-    "test": "npm run-script eslint && npm run-script unit-test",
-    "eslint": "./node_modules/.bin/eslint .",
-    "unit-test": "nyc mocha -u bdd -R spec --recursive test"
+    "test": "npm run eslint && npm run unit",
+    "eslint": "eslint --ext .ts",
+    "clean": "del-cli dist/*",
+    "unit": "jest --config ./jest.config.js",
+    "build": "npm run clean && rollup --config rollup.config.js"
   },
+  "typings": "dist/index.d.ts",
   "files": [
-    "index.js",
     "LICENSE",
-    "README.md"
+    "README.md",
+    "dist"
   ]
 }

package/CHANGELOG.md

@@ -1,15 +0,0 @@
-# Changelog
-
-## v2.1.0
-- Add support for `Uint8Array`.
-- Updated dev deps in package.json.
-
-## v2.0.4
-- Updated dev deps in package.json.
-
-## v2.0.3
-- Updated dev deps in package.json.
-
-## v2.0.2
-- Added package-lock.json.
-- Updated the example in README.md.