uint8arrays - npm Package Compare versions

Comparing version 2.1.10 to 3.0.0-rc.0

CHANGELOG.md

@@ -0,1 +1,17 @@
+# [3.0.0-rc.0](https://github.com/achingbrain/uint8arrays/compare/v2.1.10...v3.0.0-rc.0) (2021-08-16)
+
+
+### chore
+
+* switch to esm ([#22](https://github.com/achingbrain/uint8arrays/issues/22)) ([ce698bc](https://github.com/achingbrain/uint8arrays/commit/ce698bcdadbb469fa6104d6f6adffa20d2336eb7))
+
+
+### BREAKING CHANGES
+
+* built content includes ESM and CJS and has switched to named exports for the external API
+
+Co-authored-by: Alex Potsides <[e-mail]>
+
+
+
 ## [2.1.10](https://github.com/achingbrain/uint8arrays/compare/v2.1.8...v2.1.10) (2021-08-01)
@@ -2,0 +18,0 @@

package.json

 {
   "name": "uint8arrays",
-  "version": "2.1.10",
+  "version": "3.0.0-rc.0",
   "description": "Utility functions to make dealing with Uint8Arrays easier",
-  "main": "index.js",
+  "main": "src/index.js",
   "author": "Alex Potsides <[e-mail]>",
   "homepage": "https://github.com/achingbrain/uint8arrays",
   "bugs": "https://github.com/achingbrain/uint8arrays/issues",
-  "types": "dist/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "*": [
-        "dist/*"
-      ],
-      "index.js": [
-        "dist/index.d.ts"
-      ]
-    }
-  },
-  "files": [
-    "compare.js",
-    "concat.js",
-    "equals.js",
-    "from-string.js",
-    "index.js",
-    "to-string.js",
-    "xor.js",
-    "dist/**/*.ts",
-    "dist/**/*.map",
-    "dist/**/*.js",
-    "util/*.js"
-  ],
+  "type": "module",
+  "types": "types/src/index.d.ts",
   "repository": {
@@ -38,3 +16,2 @@ "type": "git",
   "scripts": {
-    "prepare": "aegir build --no-bundle",
     "test": "aegir test",
@@ -52,3 +29,3 @@ "lint": "aegir ts -p check && aegir lint",
   "devDependencies": {
-    "aegir": "^34.0.2",
+    "aegir": "^35.0.0",
     "util": "^0.12.4"
@@ -58,2 +35,5 @@ },
     "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    },
     "ignorePatterns": [
@@ -63,10 +43,42 @@ "!.aegir.js"
   },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "types/src",
+        "types/src/*"
+      ]
+    }
+  },
+  "exports": {
+    ".": {
+      "import": "./src/index.js"
+    },
+    "./compare": {
+      "import": "./src/compare.js"
+    },
+    "./concat": {
+      "import": "./src/concat.js"
+    },
+    "./equals": {
+      "import": "./src/equals.js"
+    },
+    "./from-string": {
+      "import": "./src/from-string.js"
+    },
+    "./to-string": {
+      "import": "./src/to-string.js"
+    },
+    "./xor": {
+      "import": "./src/xor.js"
+    }
+  },
   "contributors": [
     "achingbrain <[e-mail]>",
+    "Irakli Gozalishvili <[e-mail]>",
     "Cayman <[e-mail]>",
-    "Irakli Gozalishvili <[e-mail]>",
     "Hugo Dias <[e-mail]>",
     "Mircea Nistor <[e-mail]>",
-    "Rafael Ramalho <[e-mail]>"
+    "Rafael Ramalho <[e-mail]>",
+    "Vasco Santos <[e-mail]>"
   ]
 }

README.md

@@ -28,3 +28,3 @@ # Uint8Arrays <!-- omit in toc -->
 ```js
-const compare = require('uint8arrays/compare')
+import { compare } from 'uint8arrays/compare'
 
@@ -54,3 +54,3 @@ const arrays = [
 ```js
-const concat = require('uint8arrays/concat')
+import { concat } from 'uint8arrays/concat'
 
@@ -75,3 +75,3 @@ const arrays = [
 ```js
-const equals = require('uint8arrays/equals')
+import { equals } from 'uint8arrays/equals'
 
@@ -96,3 +96,3 @@ const a = Uint8Array.from([0, 1, 2])
 ```js
-const fromString = require('uint8arrays/from-string')
+import { fromString } from 'uint8arrays/from-string'
 
@@ -114,3 +114,3 @@ console.info(fromString('hello world')) // Uint8Array[104, 101 ...
 ```js
-const toString = require('uint8arrays/to-string')
+import { toString } from 'uint8arrays/to-string'
 
@@ -130,5 +130,5 @@ console.info(toString(Uint8Array.from([104, 101...]))) // 'hello world'
 ```js
-const xor = require('uint8arrays/xor')
+import { xor } from 'uint8arrays/xor'
 
 console.info(xor(Uint8Array.from([1, 0]), Uint8Array.from([0, 1]))) // Uint8Array[1, 1]
 ```

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

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

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

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

Improved metrics

Total package byte prevSize

24611

increased by17.23%

Lines of code

421

increased by27.19%

Is type module

Yes

Worsened metrics

Number of package files

20

decreased by-25.93%

Number of low quality alerts

1

increased byInfinity%

No dependency changes