@thi.ng/compare - npm Package Compare versions

Comparing version 1.3.34 to 2.0.0

CHANGELOG.md

@@ -6,16 +6,26 @@ # Change Log
 
-## [1.3.34](https://github.com/thi-ng/umbrella/compare/@thi.ng/compare@[e-mail]/compare@1.3.34) (2021-09-03)
+# [2.0.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/compare@[e-mail]/compare@2.0.0) (2021-10-12)
 
-**Note:** Version bump only for package @thi.ng/compare
 
+### Build System
 
+* major update of ALL pkgs (export maps, ESM only) ([0d1d6ea](https://github.com/thi-ng/umbrella/commit/0d1d6ea9fab2a645d6c5f2bf2591459b939c09b6))
 
 
+### BREAKING CHANGES
 
-# [1.3.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/compare@[e-mail]/compare@1.3.0) (2020-04-05)
+* discontinue CommonJS & UMD versions
 
+- only ESM modules will be published from now on
+- CJS obsolete due to ESM support in recent versions of node:
+  - i.e. launch NodeJS via:
+  - `node --experimental-specifier-resolution=node --experimental-repl-await`
+  - in the node REPL use `await import(...)` instead of `require()`
+- UMD obsolete due to widespread browser support for ESM
 
-### Features
+Also:
+- normalize/restructure/reorg all package.json files
+- cleanup all build scripts, remove obsolete
+- switch from mocha to @thi.ng/testament for all tests
 
-* **compare:** fix [#215](https://github.com/thi-ng/umbrella/issues/215), add sort key getter support for compareByKeysX() ([f364b4e](https://github.com/thi-ng/umbrella/commit/f364b4e62dcd2ed13689a1ef97799cb53af3ef71))
 
@@ -26,40 +36,36 @@
 
-# [1.2.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/compare@[e-mail]/compare@1.2.0) (2020-03-01)
+#  [1.3.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/compare@[e-mail]/compare@1.3.0) (2020-04-05) 
 
+###  Features 
 
-### Features
+- **compare:** fix [#215](https://github.com/thi-ng/umbrella/issues/215), add sort key getter support for compareByKeysX() ([f364b4e](https://github.com/thi-ng/umbrella/commit/f364b4e62dcd2ed13689a1ef97799cb53af3ef71)) 
 
-* **compare:** add HOFs, restructure, update deps & docs ([ed2c41c](https://github.com/thi-ng/umbrella/commit/ed2c41c120f6447b05022d74e510017a1f4a6257))
+#  [1.2.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/compare@[e-mail]/compare@1.2.0) (2020-03-01) 
 
+###  Features 
 
+- **compare:** add HOFs, restructure, update deps & docs ([ed2c41c](https://github.com/thi-ng/umbrella/commit/ed2c41c120f6447b05022d74e510017a1f4a6257)) 
 
+#  [1.1.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/compare@[e-mail]/compare@1.1.0) (2019-11-30) 
 
+###  Features 
 
-# [1.1.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/compare@[e-mail]/compare@1.1.0) (2019-11-30)
+- **compare:** add compareNumAsc/Desc numeric comparators ([2b8fafc](https://github.com/thi-ng/umbrella/commit/2b8fafc9eca040b649ade479203537bbd9ba54ef)) 
 
-### Features
+#  [1.0.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/compare@[e-mail]/compare@1.0.0) (2019-01-21) 
 
-* **compare:** add compareNumAsc/Desc numeric comparators ([2b8fafc](https://github.com/thi-ng/umbrella/commit/2b8fafc9eca040b649ade479203537bbd9ba54ef))
+###  Build System 
 
-# [1.0.0](https://github.com/thi-ng/umbrella/compare/@thi.ng/compare@[e-mail]/compare@1.0.0) (2019-01-21)
+- update package build scripts & outputs, imports in ~50 packages ([b54b703](https://github.com/thi-ng/umbrella/commit/b54b703)) 
 
-### Build System
+###  BREAKING CHANGES 
 
-* update package build scripts & outputs, imports in ~50 packages ([b54b703](https://github.com/thi-ng/umbrella/commit/b54b703))
+- enabled multi-outputs (ES6 modules, CJS, UMD) 
+- build scripts now first build ES6 modules in package root, then call   `scripts/bundle-module` to build minified CJS & UMD bundles in `/lib` 
+- all imports MUST be updated to only refer to package level   (not individual files anymore). tree shaking in user land will get rid of   all unused imported symbols. 
 
-### BREAKING CHANGES
+#  0.1.0 (2018-05-10) 
 
-* enabled multi-outputs (ES6 modules, CJS, UMD)
+###  Features 
 
-- build scripts now first build ES6 modules in package root, then call
-  `scripts/bundle-module` to build minified CJS & UMD bundles in `/lib`
-- all imports MUST be updated to only refer to package level
-  (not individual files anymore). tree shaking in user land will get rid of
-  all unused imported symbols.
-
-<a name="0.1.0"></a>
-# 0.1.0 (2018-05-10)
-
-### Features
-
-* **compare:** add new package [@thi](https://github.com/thi).ng/compare ([e4a87c4](https://github.com/thi-ng/umbrella/commit/e4a87c4))
+- **compare:** add new package [@thi](https://github.com/thi).ng/compare ([e4a87c4](https://github.com/thi-ng/umbrella/commit/e4a87c4))

package.json

 {
     "name": "@thi.ng/compare",
-    "version": "1.3.34",
+    "version": "2.0.0",
     "description": "Comparators with support for types implementing the @thi.ng/api/ICompare interface",
+    "type": "module",
     "module": "./index.js",
-    "main": "./lib/index.js",
-    "umd:main": "./lib/index.umd.js",
     "typings": "./index.d.ts",
+    "sideEffects": false,
     "repository": {
@@ -27,23 +27,17 @@ "type": "git",
     "scripts": {
-        "build": "yarn clean && yarn build:es6 && node ../../scripts/bundle-module",
-        "build:release": "yarn clean && yarn build:es6 && node ../../scripts/bundle-module all",
-        "build:es6": "tsc --declaration",
-        "build:test": "rimraf build && tsc -p test/tsconfig.json",
-        "build:check": "tsc --isolatedModules --noEmit",
-        "test": "mocha test",
-        "cover": "nyc mocha test && nyc report --reporter=lcov",
-        "clean": "rimraf *.js *.d.ts *.map .nyc_output build coverage doc lib",
-        "doc:readme": "ts-node -P ../../tools/tsconfig.json ../../tools/src/readme.ts",
-        "doc": "typedoc --excludePrivate --out doc --theme ../../tools/doc/typedoc-theme src/index.ts",
+        "build": "yarn clean && tsc --declaration",
+        "clean": "rimraf *.js *.d.ts *.map doc",
+        "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
         "doc:ae": "mkdir -p .ae/doc .ae/temp && node_modules/.bin/api-extractor run --local --verbose",
-        "pub": "yarn build:release && yarn publish --access public"
+        "doc:readme": "yarn doc:stats && ../../scripts/node-esm ../../tools/src/readme.ts",
+        "doc:stats": "../../scripts/node-esm ../../tools/src/module-stats.ts",
+        "pub": "yarn build && yarn publish --access public",
+        "test": "testament test"
     },
     "dependencies": {
-        "@thi.ng/api": "^7.2.0"
+        "@thi.ng/api": "^8.0.0"
     },
-    "files": [
-        "*.js",
-        "*.d.ts",
-        "lib"
-    ],
+    "devDependencies": {
+        "@thi.ng/testament": "^0.1.0"
+    },
     "keywords": [
@@ -57,4 +51,24 @@ "comparator",
     },
-    "sideEffects": false,
-    "gitHead": "d971cb3f9b215a95483f78f1a8614015e331146f"
+    "files": [
+        "*.js",
+        "*.d.ts"
+    ],
+    "exports": {
+        ".": {
+            "import": "./index.js"
+        },
+        "./compare": {
+            "import": "./compare.js"
+        },
+        "./keys": {
+            "import": "./keys.js"
+        },
+        "./numeric": {
+            "import": "./numeric.js"
+        },
+        "./reverse": {
+            "import": "./reverse.js"
+        }
+    },
+    "gitHead": "9ac1344b38b565eb894306fbf72233b6c0b2d115"
 }

README.md

@@ -25,5 +25,4 @@ <!-- This file is generated - DO NOT EDIT! -->
 
-Comparators with optional support for types implementing the
-[@thi.ng/api
-`ICompare`](https://github.com/thi-ng/umbrella/tree/develop/packages/api/src/api/compare.ts)
+Comparators with optional support for types implementing the [@thi.ng/api
+`ICompare`](https://github.com/thi-ng/umbrella/tree/develop/packages/api/src/compare.ts)
 interface.
@@ -48,11 +47,19 @@
 
+ES module import:
+
 ```html
-// ES module
-<script type="module" src="https://unpkg.com/@thi.ng/compare?module" crossorigin></script>
+<script type="module" src="https://cdn.skypack.dev/@thi.ng/compare"></script>
+```
 
-// UMD
-<script src="https://unpkg.com/@thi.ng/compare/lib/index.umd.js" crossorigin></script>
+[Skypack documentation](https://docs.skypack.dev/)
+
+For NodeJS (v14.6+):
+
+```text
+node --experimental-specifier-resolution=node --experimental-repl-await
+
+> const compare = await import("@thi.ng/compare");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 396 bytes / CJS: 471 bytes / UMD: 519 bytes
+Package sizes (gzipped, pre-treeshake): ESM: 396 bytes
 
@@ -71,6 +78,7 @@ ## Dependencies
 
-| Screenshot                                                                                                          | Description                                               | Live demo                                              | Source                                                                              |
-|:--------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------|:-------------------------------------------------------|:------------------------------------------------------------------------------------|
-|                                                                                                                     | Full umbrella repo doc string search w/ paginated results | [Demo](https://demo.thi.ng/umbrella/rdom-search-docs/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/rdom-search-docs) |
-| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/triple-query.png" width="240"/> | Triple store query results & sortable table               | [Demo](https://demo.thi.ng/umbrella/triple-query/)     | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/triple-query)     |
+| Screenshot                                                                                                             | Description                                                                 | Live demo                                              | Source                                                                              |
+|:-----------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------|:-------------------------------------------------------|:------------------------------------------------------------------------------------|
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/dominant-colors.png" width="240"/> | Color palette generation via dominant color extraction from uploaded images | [Demo](https://demo.thi.ng/umbrella/dominant-colors/)  | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/dominant-colors)  |
+|                                                                                                                        | Full umbrella repo doc string search w/ paginated results                   | [Demo](https://demo.thi.ng/umbrella/rdom-search-docs/) | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/rdom-search-docs) |
+| <img src="https://raw.githubusercontent.com/thi-ng/umbrella/develop/assets/examples/triple-query.png" width="240"/>    | Triple store query results & sortable table                                 | [Demo](https://demo.thi.ng/umbrella/triple-query/)     | [Source](https://github.com/thi-ng/umbrella/tree/develop/examples/triple-query)     |
 
@@ -77,0 +85,0 @@ ## API

No alert changes

Improved metrics

Number of lines in readme file

179

increased by4.68%

Is type module

Yes

Worsened metrics

Total package byte prevSize

27604

decreased by-24.21%

Dev dependency count

1

increased byInfinity%

Number of package files

14

decreased by-22.22%

Lines of code

162

decreased by-31.06%

Dependency changes

• + [e-mail]/api@8.11.19(transitive)

• - [e-mail]/api@7.2.0(transitive)

• [e-mail]/api@^8.0.0