uint8arrays - npm Package Compare versions

Comparing version 3.1.1 to 4.0.0

package.json

 {
   "name": "uint8arrays",
-  "version": "3.1.1",
+  "version": "4.0.0",
   "description": "Utility functions to make dealing with Uint8Arrays easier",
-  "main": "./cjs/src/index.js",
   "author": "Alex Potsides <[e-mail]>",
-  "homepage": "https://github.com/achingbrain/uint8arrays",
-  "bugs": "https://github.com/achingbrain/uint8arrays/issues",
-  "types": "types/src/index.d.ts",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/achingbrain/uint8arrays#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/achingbrain/uint8arrays.git"
+    "url": "git+https://github.com/achingbrain/uint8arrays.git"
   },
-  "scripts": {
-    "test": "aegir test",
-    "lint": "aegir ts -p check && aegir lint",
-    "release": "aegir release",
-    "release-minor": "aegir release --type minor",
-    "release-major": "aegir release --type major",
-    "build": "aegir build"
+  "bugs": {
+    "url": "https://github.com/achingbrain/uint8arrays/issues"
   },
-  "license": "MIT",
-  "dependencies": {
-    "multiformats": "^9.4.2"
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
   },
-  "devDependencies": {
-    "@types/benchmark": "^2.1.1",
-    "aegir": "^35.0.0",
-    "benchmark": "^2.1.4",
-    "util": "^0.12.4"
-  },
-  "eslintConfig": {
-    "extends": "ipfs",
-    "parserOptions": {
-      "sourceType": "module"
-    },
-    "ignorePatterns": [
-      "!.aegir.js"
-    ]
-  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
   "typesVersions": {
     "*": {
       "*": [
-        "types/src",
-        "types/src/*"
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
+      ],
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
       ]
     }
   },
+  "files": [
+    "src",
+    "dist/src",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
   "exports": {
     ".": {
-      "browser": "./esm/src/index.js",
-      "require": "./cjs/src/index.js",
-      "import": "./esm/src/index.js"
+      "types": "./dist/src/index.d.ts",
+      "import": "./src/index.js"
     },
     "./alloc": {
-      "browser": "./esm/src/alloc.js",
-      "require": "./cjs/src/alloc.js",
-      "import": "./esm/src/alloc.js"
+      "types": "./src/alloc.d.ts",
+      "import": "./src/alloc.js"
     },
     "./compare": {
-      "browser": "./esm/src/compare.js",
-      "require": "./cjs/src/compare.js",
-      "import": "./esm/src/compare.js"
+      "types": "./src/compare.d.ts",
+      "import": "./src/compare.js"
     },
     "./concat": {
-      "browser": "./esm/src/concat.js",
-      "require": "./cjs/src/concat.js",
-      "import": "./esm/src/concat.js"
+      "types": "./src/concat.d.ts",
+      "import": "./src/concat.js"
     },
     "./equals": {
-      "browser": "./esm/src/equals.js",
-      "require": "./cjs/src/equals.js",
-      "import": "./esm/src/equals.js"
+      "types": "./src/equals.d.ts",
+      "import": "./src/equals.js"
     },
     "./from-string": {
-      "browser": "./esm/src/from-string.js",
-      "require": "./cjs/src/from-string.js",
-      "import": "./esm/src/from-string.js"
+      "types": "./src/from-string.d.ts",
+      "import": "./src/from-string.js"
     },
     "./to-string": {
-      "browser": "./esm/src/to-string.js",
-      "require": "./cjs/src/to-string.js",
-      "import": "./esm/src/to-string.js"
+      "types": "./src/to-string.d.ts",
+      "import": "./src/to-string.js"
     },
     "./xor": {
-      "browser": "./esm/src/xor.js",
-      "require": "./cjs/src/xor.js",
-      "import": "./esm/src/xor.js"
+      "types": "./src/xor.d.ts",
+      "import": "./src/xor.js"
     }
   },
-  "contributors": [
-    "achingbrain <[e-mail]>",
-    "Cayman <[e-mail]>",
-    "Irakli Gozalishvili <[e-mail]>",
-    "Hugo Dias <[e-mail]>",
-    "Mircea Nistor <[e-mail]>",
-    "Rafael Ramalho <[e-mail]>",
-    "Vasco Santos <[e-mail]>"
-  ],
-  "browser": {
-    ".": "./cjs/src/index.js",
-    "./alloc": "./cjs/src/alloc.js",
-    "./compare": "./cjs/src/compare.js",
-    "./concat": "./cjs/src/concat.js",
-    "./equals": "./cjs/src/equals.js",
-    "./from-string": "./cjs/src/from-string.js",
-    "./to-string": "./cjs/src/to-string.js",
-    "./xor": "./cjs/src/xor.js"
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "release": {
+    "branches": [
+      "master"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "deps",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
+  "scripts": {
+    "clean": "aegir clean",
+    "test": "aegir test",
+    "test:node": "aegir test -t node --cov",
+    "test:chrome": "aegir test -t browser --cov",
+    "test:chrome-webworker": "aegir test -t webworker",
+    "test:firefox": "aegir test -t browser -- --browser firefox",
+    "test:firefox-webworker": "aegir test -t webworker -- --browser firefox",
+    "lint": "aegir lint",
+    "release": "aegir release",
+    "build": "aegir build"
+  },
+  "dependencies": {
+    "multiformats": "^10.0.0"
+  },
+  "devDependencies": {
+    "@types/benchmark": "^2.1.1",
+    "aegir": "^37.5.5",
+    "benchmark": "^2.1.4"
   }
-}
+}

README.md

@@ -1,5 +0,11 @@
-# Uint8Arrays <!-- omit in toc -->
+# uint8arrays <!-- omit in toc -->
 
-Some utility functions to make dealing with `Uint8Array`s more pleasant.
+[![codecov](https://img.shields.io/codecov/c/github/achingbrain/uint8arrays.svg?style=flat-square)](https://codecov.io/gh/achingbrain/uint8arrays)
+[![CI](https://img.shields.io/github/workflow/status/achingbrain/uint8arrays/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/achingbrain/uint8arrays/actions/workflows/js-test-and-release.yml)
 
+> Utility functions to make dealing with Uint8Arrays easier
+
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
 - [API](#api)
@@ -22,3 +28,32 @@ - [alloc(size)](#allocsize)
     - [Example](#example-7)
+- [License](#license)
+- [Contribute](#contribute)
 
+## Install
+
+```console
+$ npm i uint8arrays
+```
+
+- [Install](#install)
+- [API](#api)
+  - [alloc(size)](#allocsize)
+    - [Example](#example)
+  - [allocUnsafe(size)](#allocunsafesize)
+    - [Example](#example-1)
+  - [compare(a, b)](#comparea-b)
+    - [Example](#example-2)
+  - [concat(arrays, \[length])](#concatarrays-length)
+    - [Example](#example-3)
+  - [equals(a, b)](#equalsa-b)
+    - [Example](#example-4)
+  - [fromString(string, encoding = 'utf8')](#fromstringstring-encoding--utf8)
+    - [Example](#example-5)
+  - [toString(array, encoding = 'utf8')](#tostringarray-encoding--utf8)
+    - [Example](#example-6)
+  - [xor(a, b)](#xora-b)
+    - [Example](#example-7)
+- [License](#license)
+- [Contribute](#contribute)
+
 ## API
@@ -75,3 +110,3 @@
 
-### concat(arrays, [length])
+### concat(arrays, \[length])
 
@@ -161,1 +196,12 @@ Concatenate one or more array-likes and return a `Uint8Array` with their contents.
 ```
+
+## License
+
+Licensed under either of
+
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+
+## Contribute
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

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

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

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

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

3

decreased by-25%

Number of low maintenance alerts

0

decreased by-100%

Number of lines in readme file

205

increased by28.93%

Is type module

Yes

Worsened metrics

Total package byte prevSize

34993

decreased by-63.3%

Number of package files

53

decreased by-5.36%

Number of low license alerts

1

increased byInfinity%

License quality

80

decreased by-20%

Lines of code

468

decreased by-14.91%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedmultiformats@10.0.3(transitive)

• - Removedmultiformats@9.9.0(transitive)

• Updatedmultiformats@^10.0.0