unicode-search 1.0.0 → 1.1.1

package/README.md

@@ -1,27 +1,37 @@
+[![NPM Version](https://img.shields.io/npm/v/unicode-search)](https://www.npmjs.com/package/unicode-search)
+[![Build status](https://github.com/Lucas-C/unicode-search/workflows/CI%20pipeline/badge.svg)](https://github.com/Lucas-C/unicode-search/actions/workflows/build.yml?query=branch%3Amaster)
+[![Known Vulnerabilities](https://snyk.io/test/github/lucas-c/unicode-search/badge.svg)](https://snyk.io/test/github/lucas-c/unicode-search)
+
 # unicode-search
 
 Command-line interface to search UTF8 characters by name from a JSON cache, without requiring an Internet connection.
 
+https://www.npmjs.com/package/unicode-search
+
 Inspired by https://github.com/eversport/node-unicodetable
 
+Online, I would recommend to use this tag-based searched: http://graphemica.com/characters/tags/
 
-## Installation
 
+## Installation
 ```
-yarn global add unicode-search
+npm install -g unicode-search
 ```
 
- Or
+You can also directly invoke `unicode-search` using `npx`:
 
 ```
-npm install -g unicode-search
+npx unicode-search --help
 ```
 
 
 ## Usage
 
 ```
-unicode-search -c So "check mark"
+unicode-search -b Emoticons -k name,string "check mark"
+```
+```
+unicode-search -b Emoticons -k name,string > all_emoticons.txt
 ```
 
 ### Options
@@ -41,7 +51,14 @@ The following is for your quick reference (may not be the latest version):
   Options:
 
     -V, --version          output the version number
+    -b, --block [name]     Filter by block name, e.g. "Emoticon"
     -c, --category [name]  Filter by category name, e.g. "So"
+    -k, --keys [keys]      Output only the selected field(s), e.g. "name,string"
     -h, --help             output usage information
-
 ```
+
+# Release checklist
+1. `version=1.X.Y`
+1. `sed -i "s/\"version\": \"1.\+\"/\"version\": \"$version\"/" package.json`
+1. `npm pack --dry-run && npm publish` to upload on [npmjs.com](https://www.npmjs.com/package/unicode-search)
+1. `git commit -am "New release: $version" && git push && git tag $version && git push --tags`

package/package.json

@@ -1,32 +1,32 @@
 {
   "name": "unicode-search",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Command-line interface to search unicode characters by keywords",
   "license": "GPL-3.0",
-  "repository": "git@github.com:Lucas-C/unicode-search.git",
+  "repository": {
+    "url": "git+ssh://git@github.com/Lucas-C/unicode-search.git"
+  },
   "author": "Lucas Cimon <lucas.cimon@gmail.com>",
   "bin": {
-    "unicode-search": "./unicode-search.bundle.js"
+    "unicode-search": "unicode-search.bundle.js"
   },
   "scripts": {
-    "upgrade": "yarn upgrade --latest",
-    "transpile": "babel ./generateUnicodeDataJson.js --out-file ./generateUnicodeDataJson.bundle.js && babel ./unicode-search.js --out-file ./unicode-search.bundle.js",
-    "prepublish": "npm run transpile && npm run generateUnicodeDataJson",
-    "download": "wget \"https://unicode.org/Public/10.0.0/ucd/UnicodeData.txt\" -O UnicodeData.txt",
-    "generateUnicodeDataJson": "npm run download && node generateUnicodeDataJson.bundle.js",
-    "unicode-search": "node unicode-search.bundle.js"
+    "test": "standard --fix",
+    "prepublish": "npm run transpile && npm run generateDistJsons",
+    "transpile": "babel ./generateDistJsons.js --out-file ./generateDistJsons.bundle.js && babel ./unicode-search.js --out-file ./unicode-search.bundle.js",
+    "generateDistJsons": "npm run download && node generateDistJsons.bundle.js",
+    "download": "wget \"https://unicode.org/Public/10.0.0/ucd/UnicodeData.txt\" -O UnicodeData.txt && wget \"https://unicode.org/Public/10.0.0/ucd/Blocks.txt\" -O Blocks.txt"
   },
   "dependencies": {
-    "commander": "==2.11.0"
+    "commander": "^14.0.3"
   },
   "devDependencies": {
-    "babel-cli": "^6.26.0",
-    "babel-preset-env": "^1.6.0",
+    "@babel/cli": "^7.28.6",
+    "@babel/preset-env": "^7.29.0",
     "bufferstream": "^0.6.2",
-    "standard": "^10.0.3"
+    "standard": "^17.1.2"
   },
   "files": [
-    "unicode-search.js",
     "unicode-search.bundle.js",
     "UnicodeData.json"
   ],

package/unicode-search.bundle.js

@@ -1,26 +1,93 @@
 #!/usr/bin/env node
-'use strict';
+"use strict";
 
-require('core-js/modules/es7.object.values');
-
-const commander = require('commander');
-const pkg = require('./package.json');
-
-commander.version(pkg.version).option('-c, --category [name]', 'Filter by category name, e.g. "So"').parse(process.argv);
-
-let { category } = commander;
-
-const uppercaseKeyword = process.argv.pop().toUpperCase();
-
-const unicodeData = require('./UnicodeData.json');
-
-for (let uChar of Object.values(unicodeData)) {
-    if (category && uChar.category != category) {
-        continue;
+function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+var commander = require('commander');
+var pkg = require('./package.json');
+var PRETTY_CATEGORY = {
+  Cc: 'Other, Control',
+  Cf: 'Other, Format',
+  Cn: 'Other, Not Assigned',
+  Co: 'Other, Private Use',
+  Cs: 'Other, Surrogate',
+  LC: 'Letter, Cased',
+  Ll: 'Letter, Lowercase',
+  Lm: 'Letter, Modifier',
+  Lo: 'Letter, Other',
+  Lt: 'Letter, Titlecase',
+  Lu: 'Letter, Uppercase',
+  Mc: 'Mark, Spacing Combining',
+  Me: 'Mark, Enclosing',
+  Mn: 'Mark, Nonspacing',
+  Nd: 'Number, Decimal Digit',
+  Nl: 'Number, Letter',
+  No: 'Number, Other',
+  Pc: 'Punctuation, Connector',
+  Pd: 'Punctuation, Dash',
+  Pe: 'Punctuation, Close',
+  Pf: 'Punctuation, Final quote',
+  Pi: 'Punctuation, Initial quote',
+  Po: 'Punctuation, Other',
+  Ps: 'Punctuation, Open',
+  Sc: 'Symbol, Currency',
+  Sk: 'Symbol, Modifier',
+  Sm: 'Symbol, Math',
+  So: 'Symbol, Other',
+  Zl: 'Separator, Line',
+  Zp: 'Separator, Paragraph',
+  Zs: 'Separator, Space'
+};
+commander.version(pkg.version).option('-b, --block [name]', 'Filter by block name, e.g. "Emoticon"').option('-c, --category [name]', 'Filter by category name, e.g. "So"').option('-k, --keys [keys]', 'Output only the selected field(s), e.g. "name,string"').parse(process.argv);
+var block = commander.block,
+  category = commander.category,
+  keys = commander.keys;
+var uppercaseKeyword = (commander.args[0] || '').toUpperCase();
+var unicodeData = require('./UnicodeData.json');
+var blocks = require('./Blocks.json');
+var findBlockName = function findBlockName(codepoint) {
+  // yes, dichotomic search would be faster
+  // but we have only 260 entries
+  codepoint = codepoint.padStart(6, '0');
+  var index = -1;
+  var _iterator = _createForOfIteratorHelper(blocks),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var _block = _step.value;
+      if (_block.rangeStart > codepoint) break;
+      index++;
     }
-    if (uChar.name.indexOf(uppercaseKeyword) < 0) {
-        continue;
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return blocks[index].blockName;
+};
+for (var _i = 0, _Object$values = Object.values(unicodeData); _i < _Object$values.length; _i++) {
+  var uChar = _Object$values[_i];
+  if (category && uChar.category !== category) continue;
+  if (uppercaseKeyword && uChar.name.indexOf(uppercaseKeyword) < 0) continue;
+  uChar.block = findBlockName(uChar.value);
+  if (block && uChar.block.toLowerCase() !== block.toLowerCase()) continue;
+  uChar.categoryHumanReadble = PRETTY_CATEGORY[uChar.category];
+  uChar.string = String.fromCodePoint('0x' + uChar.value);
+  if (keys) {
+    var _iterator2 = _createForOfIteratorHelper(keys.split(',')),
+      _step2;
+    try {
+      for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+        var key = _step2.value;
+        console.log(uChar[key]);
+      }
+    } catch (err) {
+      _iterator2.e(err);
+    } finally {
+      _iterator2.f();
     }
+  } else {
     console.log(uChar);
-    console.log(String.fromCharCode(parseInt(uChar.value, 16)));
+  }
 }

package/unicode-search.js

@@ -1,27 +0,0 @@
-#!/usr/bin/env node
-import "core-js/modules/es7.object.values";
-
-const commander = require('commander')
-const pkg = require('./package.json')
-
-commander
-  .version(pkg.version)
-  .option('-c, --category [name]', 'Filter by category name, e.g. "So"')
-  .parse(process.argv)
-
-let { category } = commander
-
-const uppercaseKeyword = process.argv.pop().toUpperCase()
-
-const unicodeData = require('./UnicodeData.json')
-
-for (let uChar of Object.values(unicodeData)) {
-    if (category && uChar.category != category) {
-        continue
-    }
-    if (uChar.name.indexOf(uppercaseKeyword) < 0) {
-        continue
-    }
-    console.log(uChar)
-    console.log(String.fromCharCode(parseInt(uChar.value, 16)))
-}