node-emoji - npm Package Compare versions

Comparing version 2.0.2 to 2.1.0

.github/Development.md

@@ -38,1 +38,15 @@ # Development
 ```
+
+## Type Checking
+
+Separately from building, [TypeScript](https://typescriptlang.org)'s compiler can be used to type check code:
+
+```shell
+npm run compile
+```
+
+You can run with with [TypeScript's `-w`/`--watch` mode](https://www.typescriptlang.org/docs/handbook/compiler-options.html) to continuously rerun the type checker as you make changes:
+
+```shell
+npm run compile -- -w
+```

jest.config.json

@@ -10,3 +10,5 @@ {
   },
-  "transform": {}
+  "transform": {
+    "src.+\\.(t|j)s$": "@swc/jest"
+  }
 }

lib/index.js

@@ -1,11 +0,11 @@
-// src/emojify.js
+// src/emojify.ts
 import { assert as assert2, default as is } from "@sindresorhus/is";
 
-// src/findByName.js
+// src/findByName.ts
 import { assert } from "@sindresorhus/is";
 
-// src/data.js
+// src/data.ts
 import emojilib from "emojilib";
 
-// src/utils.js
+// src/utils.ts
 import charRegex from "char-regex";
@@ -28,3 +28,3 @@ var charRegexMatcher = charRegex();
 
-// src/data.js
+// src/data.ts
 var emojiData = Object.entries(emojilib.lib).map(
@@ -38,3 +38,3 @@ ([name, { char: emoji }]) => [name, emoji]
 
-// src/findByName.js
+// src/findByName.ts
 var findByName = (name) => {
@@ -47,7 +47,7 @@ assert.string(name);
 
-// src/emojify.js
+// src/emojify.ts
 var emojify = (input, { fallback, format = (name) => name } = {}) => {
   const fallbackFunction = fallback === void 0 ? fallback : asFunction(fallback);
   assert2.string(input);
-  assert2.any([is.undefined, is.function], fallbackFunction);
+  assert2.any([is.undefined, is.function_], fallbackFunction);
   assert2.function_(format);
@@ -66,3 +66,3 @@ return input.replace(/:([a-zA-Z0-9_\-+]+):/g, (part) => {
 
-// src/findByCode.js
+// src/findByCode.ts
 import { assert as assert3 } from "@sindresorhus/is";
@@ -76,3 +76,3 @@ var findByCode = (code) => {
 
-// src/find.js
+// src/find.ts
 var find = (codeOrName) => {
@@ -82,3 +82,3 @@ return findByCode(codeOrName) || findByName(codeOrName);
 
-// src/get.js
+// src/get.ts
 import { assert as assert4 } from "@sindresorhus/is";
@@ -90,3 +90,3 @@ var get = (codeOrName) => {
 
-// src/has.js
+// src/has.ts
 import { assert as assert5 } from "@sindresorhus/is";
@@ -98,3 +98,3 @@ var has = (codeOrName) => {
 
-// src/random.js
+// src/random.ts
 var random = () => {
@@ -105,3 +105,3 @@ const [name, emoji] = randomItem(emojiData);
 
-// src/replace.js
+// src/replace.ts
 import { assert as assert6 } from "@sindresorhus/is";
@@ -129,3 +129,3 @@ var replace = (input, replacement, { preserveSpaces = false } = {}) => {
 
-// src/search.js
+// src/search.ts
 import { assert as assert7 } from "@sindresorhus/is";
@@ -138,9 +138,9 @@ var search = (keyword) => {
 
-// src/strip.js
+// src/strip.ts
 var strip = (input, { preserveSpaces } = {}) => replace(input, "", { preserveSpaces });
 
-// src/unemojify.js
+// src/unemojify.ts
 import { assert as assert9 } from "@sindresorhus/is";
 
-// src/which.js
+// src/which.ts
 import { assert as assert8 } from "@sindresorhus/is";
@@ -158,3 +158,3 @@ import skinTone from "skin-tone";
 
-// src/unemojify.js
+// src/unemojify.ts
 var unemojify = (input) => {
@@ -161,0 +161,0 @@ assert9.string(input);

package.json

 {
   "name": "node-emoji",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "Friendly emoji lookups and parsing utilities for Node.js",
@@ -26,14 +26,18 @@ "author": "Daniel Bugl <[e-mail]>",
   "dependencies": {
-    "@sindresorhus/is": "^5.3.0",
-    "char-regex": "^2.0.1",
+    "@sindresorhus/is": "^3.1.2",
+    "char-regex": "^1.0.2",
     "emojilib": "^2.4.0",
-    "skin-tone": "^3.0.0",
-    "tsup": "^6.7.0"
+    "skin-tone": "^2.0.0"
   },
   "devDependencies": {
+    "@swc/core": "^1.3.58",
+    "@swc/jest": "^0.2.26",
     "cross-env": "^7.0.3",
-    "jest": "^29.5.0"
+    "jest": "^29.5.0",
+    "tsup": "^6.7.0",
+    "typescript": "^5.0.4"
   },
   "scripts": {
-    "build": "tsup ./src/index.js --format esm,cjs --out-dir lib",
+    "build": "tsup ./src/index.ts --format esm,cjs --out-dir lib --dts",
+    "compile": "tsc",
     "coverage": "npm run test -- --coverage",
@@ -49,2 +53,3 @@ "prepublishOnly": "npm run coverage",
   },
+  "types": "./lib/index.d.ts",
   "main": "./lib/index.js",
@@ -51,0 +56,0 @@ "license": "MIT",

README.md

@@ -142,3 +142,3 @@ # node-emoji
 - **`input`** (`string`): The input string.
-- **`replacement`** (`string | (emoji: string, index: number, string: InputValueType) => string`): The character to replace the emoji with. Can be either a string or a callback that returns a string.
+- **`replacement`** (`string | (emoji: string, index: number, string: string) => string`): The character to replace the emoji with. Can be either a string or a callback that returns a string.
 
@@ -207,3 +207,3 @@ ```js
 
-### emoji.which(emoji)
+### emoji.which(emoji, options?)
 
@@ -215,2 +215,4 @@ Get an emoji name from an emoji.
 1. **`emoji`** (`string`): The emoji to get the name of.
+1. **`options`** _(optional)_:
+   - **`markdown`** (`boolean`; default: `false`): Whether to return a `":emoji:"` string instead of `"emoji"`
 
@@ -217,0 +219,0 @@ ```js

New alerts

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

Improved metrics

Total package byte prevSize

42067

increased by8.19%

Dependency count

4

decreased by-20%

Number of package files

40

increased by8.11%

Lines of code

954

increased by10.8%

Number of lines in readme file

234

increased by0.86%

Published versions last year

7

increased by75%

Worsened metrics

Dev dependency count

6

increased by200%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Added@sindresorhus/is@3.1.2(transitive)

• + Addedchar-regex@1.0.2(transitive)

• + Addedskin-tone@2.0.0(transitive)

• - Removedtsup@^6.7.0

• - Removed@esbuild/android-arm@0.17.19(transitive)

• - Removed@esbuild/android-arm64@0.17.19(transitive)

• - Removed@esbuild/android-x64@0.17.19(transitive)

• - Removed@esbuild/darwin-arm64@0.17.19(transitive)

• - Removed@esbuild/darwin-x64@0.17.19(transitive)

• - Removed@esbuild/freebsd-arm64@0.17.19(transitive)

• - Removed@esbuild/freebsd-x64@0.17.19(transitive)

• - Removed@esbuild/linux-arm@0.17.19(transitive)

• - Removed@esbuild/linux-arm64@0.17.19(transitive)

• - Removed@esbuild/linux-ia32@0.17.19(transitive)

• - Removed@esbuild/linux-loong64@0.17.19(transitive)

• - Removed@esbuild/linux-mips64el@0.17.19(transitive)

• - Removed@esbuild/linux-ppc64@0.17.19(transitive)

• - Removed@esbuild/linux-riscv64@0.17.19(transitive)

• - Removed@esbuild/linux-s390x@0.17.19(transitive)

• - Removed@esbuild/linux-x64@0.17.19(transitive)

• - Removed@esbuild/netbsd-x64@0.17.19(transitive)

• - Removed@esbuild/openbsd-x64@0.17.19(transitive)

• - Removed@esbuild/sunos-x64@0.17.19(transitive)

• - Removed@esbuild/win32-arm64@0.17.19(transitive)

• - Removed@esbuild/win32-ia32@0.17.19(transitive)

• - Removed@esbuild/win32-x64@0.17.19(transitive)

• - Removed@isaacs/cliui@8.0.2(transitive)

• - Removed@jridgewell/gen-mapping@0.3.5(transitive)

• - Removed@jridgewell/resolve-uri@3.1.2(transitive)

• - Removed@jridgewell/set-array@1.2.1(transitive)

• - Removed@jridgewell/sourcemap-codec@1.4.15(transitive)

• - Removed@jridgewell/trace-mapping@0.3.25(transitive)

• - Removed@nodelib/fs.scandir@2.1.5(transitive)

• - Removed@nodelib/fs.stat@2.0.5(transitive)

• - Removed@nodelib/fs.walk@1.2.8(transitive)

• - Removed@pkgjs/parseargs@0.11.0(transitive)

• - Removed@sindresorhus/is@5.6.0(transitive)

• - Removedansi-regex@5.0.16.0.1(transitive)

• - Removedansi-styles@4.3.06.2.1(transitive)

• - Removedany-promise@1.3.0(transitive)

• - Removedanymatch@3.1.3(transitive)

• - Removedarray-union@2.1.0(transitive)

• - Removedbalanced-match@1.0.2(transitive)

• - Removedbinary-extensions@2.3.0(transitive)

• - Removedbrace-expansion@2.0.1(transitive)

• - Removedbraces@3.0.2(transitive)

• - Removedbundle-require@4.1.0(transitive)

• - Removedcac@6.7.14(transitive)

• - Removedchar-regex@2.0.1(transitive)

• - Removedchokidar@3.6.0(transitive)

• - Removedcolor-convert@2.0.1(transitive)

• - Removedcolor-name@1.1.4(transitive)

• - Removedcommander@4.1.1(transitive)

• - Removedcross-spawn@7.0.3(transitive)

• - Removeddebug@4.3.4(transitive)

• - Removeddir-glob@3.0.1(transitive)

• - Removedeastasianwidth@0.2.0(transitive)

• - Removedemoji-regex@8.0.09.2.2(transitive)

• - Removedesbuild@0.17.19(transitive)

• - Removedexeca@5.1.1(transitive)

• - Removedfast-glob@3.3.2(transitive)

• - Removedfastq@1.17.1(transitive)

• - Removedfill-range@7.0.1(transitive)

• - Removedforeground-child@3.1.1(transitive)

• - Removedfsevents@2.3.3(transitive)

• - Removedget-stream@6.0.1(transitive)

• - Removedglob@10.3.15(transitive)

• - Removedglob-parent@5.1.2(transitive)

• - Removedglobby@11.1.0(transitive)

• - Removedhuman-signals@2.1.0(transitive)

• - Removedignore@5.3.1(transitive)

• - Removedis-binary-path@2.1.0(transitive)

• - Removedis-extglob@2.1.1(transitive)

• - Removedis-fullwidth-code-point@3.0.0(transitive)

• - Removedis-glob@4.0.3(transitive)

• - Removedis-number@7.0.0(transitive)

• - Removedis-stream@2.0.1(transitive)

• - Removedisexe@2.0.0(transitive)

• - Removedjackspeak@2.3.6(transitive)

• - Removedjoycon@3.1.1(transitive)

• - Removedlilconfig@2.1.0(transitive)

• - Removedlines-and-columns@1.2.4(transitive)

• - Removedload-tsconfig@0.2.5(transitive)

• - Removedlodash.sortby@4.7.0(transitive)

• - Removedlru-cache@10.2.2(transitive)

• - Removedmerge-stream@2.0.0(transitive)

• - Removedmerge2@1.4.1(transitive)

• - Removedmicromatch@4.0.5(transitive)

• - Removedmimic-fn@2.1.0(transitive)

• - Removedminimatch@9.0.4(transitive)

• - Removedminipass@7.1.1(transitive)

• - Removedms@2.1.2(transitive)

• - Removedmz@2.7.0(transitive)

• - Removednormalize-path@3.0.0(transitive)

• - Removednpm-run-path@4.0.1(transitive)

• - Removedobject-assign@4.1.1(transitive)

• - Removedonetime@5.1.2(transitive)

• - Removedpath-key@3.1.1(transitive)

• - Removedpath-scurry@1.11.1(transitive)

• - Removedpath-type@4.0.0(transitive)

• - Removedpicomatch@2.3.1(transitive)

• - Removedpirates@4.0.6(transitive)

• - Removedpostcss-load-config@3.1.4(transitive)

• - Removedpunycode@2.3.1(transitive)

• - Removedqueue-microtask@1.2.3(transitive)

• - Removedreaddirp@3.6.0(transitive)

• - Removedresolve-from@5.0.0(transitive)

• - Removedreusify@1.0.4(transitive)

• - Removedrollup@3.29.4(transitive)

• - Removedrun-parallel@1.2.0(transitive)

• - Removedshebang-command@2.0.0(transitive)

• - Removedshebang-regex@3.0.0(transitive)

• - Removedsignal-exit@3.0.74.1.0(transitive)

• - Removedskin-tone@3.0.0(transitive)

• - Removedslash@3.0.0(transitive)

• - Removedsource-map@0.8.0-beta.0(transitive)

• - Removedstring-width@4.2.35.1.2(transitive)

• - Removedstrip-ansi@6.0.17.1.0(transitive)

• - Removedstrip-final-newline@2.0.0(transitive)

• - Removedsucrase@3.35.0(transitive)

• - Removedthenify@3.3.1(transitive)

• - Removedthenify-all@1.6.0(transitive)

• - Removedto-regex-range@5.0.1(transitive)

• - Removedtr46@1.0.1(transitive)

• - Removedtree-kill@1.2.2(transitive)

• - Removedts-interface-checker@0.1.13(transitive)

• - Removedtsup@6.7.0(transitive)

• - Removedwebidl-conversions@4.0.2(transitive)

• - Removedwhatwg-url@7.1.0(transitive)

• - Removedwhich@2.0.2(transitive)

• - Removedwrap-ansi@7.0.08.1.0(transitive)

• - Removedyaml@1.10.2(transitive)

• Updated@sindresorhus/is@^3.1.2

• Updatedchar-regex@^1.0.2

• Updatedskin-tone@^2.0.0