@ipld/dag-cbor - npm Package Compare versions

Comparing version 7.0.3 to 8.0.0

package.json

 {
   "name": "@ipld/dag-cbor",
-  "version": "7.0.3",
+  "version": "8.0.0",
   "description": "JS implementation of DAG-CBOR",
-  "main": "./cjs/index.js",
-  "types": "./types/index.d.ts",
-  "scripts": {
-    "lint": "standard *.js test/*.js",
-    "build": "npm run build:js && npm run build:types",
-    "build:js": "ipjs build --tests --main && npm run build:copy",
-    "build:copy": "cp -a tsconfig.json index.js dist/ && mkdir -p dist/test && cp test/*.js dist/test/",
-    "build:types": "npm run build:copy && cd dist && tsc --build",
-    "test:cjs": "npm run build:js && mocha dist/cjs/node-test/test-*.js && npm run test:cjs:browser",
-    "test:esm": "npm run build:js && mocha dist/esm/node-test/test-*.js && npm run test:esm:browser",
-    "test:node": "c8 --check-coverage --branches 100 --functions 100 --lines 100 mocha test/test-*.js",
-    "test:cjs:browser": "polendina --page --worker --serviceworker --cleanup dist/cjs/browser-test/test-*.js",
-    "test:esm:browser": "polendina --page --worker --serviceworker --cleanup dist/esm/browser-test/test-*.js",
-    "test:ts": "npm run build:types && npm run test --prefix test/ts-use",
-    "test": "npm run lint && npm run test:node && npm run test:esm && npm run test:ts",
-    "test:ci": "npm run lint && npm run test:node && npm run test:esm && npm run test:cjs && npm run test:ts",
-    "coverage": "c8 --reporter=html mocha test/test-*.js && npm_config_yes=true npx st -d coverage -p 8080"
-  },
-  "keywords": [
-    "ipfs",
-    "ipld",
-    "multiformats"
-  ],
   "author": "Rod <[e-mail]> (http://r.va.gg/)",
-  "license": "(Apache-2.0 AND MIT)",
-  "exports": {
-    "browser": "./esm/index.js",
-    "require": "./cjs/index.js",
-    "import": "./esm/index.js"
-  },
-  "dependencies": {
-    "cborg": "^1.6.0",
-    "multiformats": "^9.5.4"
-  },
-  "devDependencies": {
-    "buffer": "^6.0.3",
-    "c8": "^7.10.0",
-    "chai": "^4.3.4",
-    "ipjs": "^5.2.0",
-    "ipld-garbage": "^5.0.0",
-    "mocha": "^10.0.0",
-    "polendina": "~3.1.0",
-    "standard": "^17.0.0",
-    "typescript": "~4.8.2"
-  },
-  "standard": {
-    "ignore": [
-      "dist"
-    ]
-  },
-  "directories": {
-    "test": "test"
-  },
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/ipld/js-dag-cbor#readme",
   "repository": {
@@ -65,13 +15,50 @@ "type": "git",
   },
-  "homepage": "https://github.com/ipld/js-dag-cbor#readme",
+  "keywords": [
+    "ipfs",
+    "ipld",
+    "multiformats"
+  ],
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
   "typesVersions": {
     "*": {
       "*": [
-        "types/*"
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
       ],
-      "types/*": [
-        "types/*"
+      "src/*": [
+        "*",
+        "dist/*",
+        "dist/src/*",
+        "dist/src/*/index"
       ]
     }
   },
+  "files": [
+    "src",
+    "dist",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./src/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    },
+    "ignorePatterns": [
+      "test/ts-use"
+    ]
+  },
   "release": {
@@ -104,11 +91,11 @@ "branches": [
             {
-              "type": "chore",
+              "type": "docs",
               "release": "patch"
             },
             {
-              "type": "docs",
+              "type": "test",
               "release": "patch"
             },
             {
-              "type": "test",
+              "type": "deps",
               "release": "patch"
@@ -143,5 +130,9 @@ },
                 "type": "docs",
-                "section": "Trivial Changes"
+                "section": "Documentation"
               },
               {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
                 "type": "test",
@@ -155,8 +146,3 @@ "section": "Tests"
       "@semantic-release/changelog",
-      [
-        "@semantic-release/npm",
-        {
-          "pkgRoot": "dist"
-        }
-      ],
+      "@semantic-release/npm",
       "@semantic-release/github",
@@ -166,3 +152,26 @@ "@semantic-release/git"
   },
-  "browser": "./cjs/index.js"
+  "scripts": {
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "build": "aegir build",
+    "release": "aegir release",
+    "test": "npm run lint && aegir test",
+    "test:ts": "npm run test --prefix test/ts-use",
+    "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",
+    "test:electron-main": "aegir test -t electron-main",
+    "dep-check": "aegir dep-check"
+  },
+  "dependencies": {
+    "cborg": "^1.6.0",
+    "multiformats": "^10.0.2"
+  },
+  "devDependencies": {
+    "@ipld/garbage": "^6.0.0",
+    "aegir": "^37.5.6",
+    "buffer": "^6.0.3"
+  }
 }

README.md

@@ -1,5 +0,21 @@
-# @ipld/dag-cbor
+# @ipld/dag-cbor <!-- omit in toc -->
 
-JS implementation of `dag-cbor`.
+[![codecov](https://img.shields.io/codecov/c/github/ipld/js-dag-cbor.svg?style=flat-square)](https://codecov.io/gh/ipld/js-dag-cbor)
+[![CI](https://img.shields.io/github/workflow/status/ipld/js-dag-cbor/test%20&%20maybe%20release/master?style=flat-square)](https://github.com/ipld/js-dag-cbor/actions/workflows/js-test-and-release.yml)
 
+> JS implementation of DAG-CBOR
+
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
+- [Spec](#spec)
+- [License](#license)
+- [Contribute](#contribute)
+
+## Install
+
+```console
+$ npm i @ipld/dag-cbor
+```
+
 This is the *new* interface meant for use by itself or with `multiformats` and
@@ -32,4 +48,15 @@ `@ipld/block`. It is not used by `js-ipld-format` which is currently
 
-# Spec
+## Spec
 
 The [`dag-cbor` specification is in the IPLD specs repo](https://github.com/ipld/specs/blob/master/block-layer/codecs/dag-cbor.md).
+
+## 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

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

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

3

decreased by-66.67%

Number of lines in readme file

62

increased by77.14%

Is type module

Yes

Worsened metrics

Total package byte prevSize

43015

decreased by-10.55%

Number of package files

7

decreased by-53.33%

License quality

80

decreased by-20%

Lines of code

237

decreased by-81.48%

Dependency changes

• + Addedmultiformats@10.0.3(transitive)

• - Removedmultiformats@9.9.0(transitive)

• Updatedmultiformats@^10.0.2