@multi-user-domain/mud-lib - npm Package Compare versions

Comparing version 1.0.0 to 1.2.0

package.json

 {
   "name": "@multi-user-domain/mud-lib",
-  "version": "1.0.0",
-  "main": "dist/index.js",
-  "module": "dist/index.es.js",
+  "version": "1.2.0",
+  "main": "dist/cjs/index.js",
+  "module": "dist/es/index.es.js",
   "author": "Matt Tennison <[e-mail]>",
@@ -13,8 +13,14 @@ "license": "MIT",
     "@babel/preset-typescript": "^7.14.5",
+    "@rollup/plugin-babel": "^5.3.0",
+    "@rollup/plugin-commonjs": "^20.0.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.0.5",
+    "@rollup/plugin-replace": "^3.0.0",
     "@rollup/plugin-typescript": "^8.2.5",
     "@semantic-release/git": "^9.0.0",
     "@semantic-release/npm": "^7.1.3",
-    "@testing-library/react": "^12.0.0",
     "@types/jest": "^26.0.24",
     "@types/react": "^17.0.15",
+    "@rdfjs/types": "^1.0.1",
+    "@types/n3": "^1.10.0",
     "babel-jest": "^27.0.6",
@@ -27,5 +33,4 @@ "commitizen": "^4.2.4",
     "prettier": "2.3.2",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
     "rollup": "^2.55.1",
+    "rollup-plugin-polyfill-node": "^0.7.0",
     "semantic-release": "^17.4.4",
@@ -41,12 +46,9 @@ "tslib": "^2.3.0",
     "test": "jest",
-    "prepublishOnly": "yarn lint && yarn test",
+    "prepublishOnly": "yarn lint",
     "cm": "cz",
     "semantic-release": "semantic-release"
   },
-  "peerDependencies": {
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2"
-  },
+  "peerDependencies": {},
   "lint-staged": {
-    "*.{js,css,md}": "prettier --write"
+    "*.{js,jsx,css,md,ts,tsx}": "prettier --write"
   },
@@ -61,3 +63,8 @@ "config": {
     "url": "https://github.com/Multi-User-Domain/mud-lib.git"
+  },
+  "dependencies": {
+    "@inrupt/lit-generated-vocab-common": "^0.3.11",
+    "@inrupt/solid-client": "^0.4.0",
+    "@rdfjs/dataset": "1.1.1"
   }
 }

README.md

@@ -5,2 +5,5 @@ # mud-lib
 
+![npm bundle size](https://img.shields.io/bundlephobia/min/@multi-user-domain/mud-lib)
+![npm (scoped)](https://img.shields.io/npm/v/@multi-user-domain/mud-lib)
+
 ## Tech used
@@ -14,5 +17,11 @@
 - Hygen
+- Semantic Release
+- Commitizen
 
 ## Getting Started
 
+Install: `npm install @multi-user-domain/mud-lib` or `yarn add @multi-user-domain/mud-lib`
+
+## Contributing
+
 ### Adding a new component
@@ -25,1 +34,18 @@
 ```
+
+### Testing local changes in another project
+
+To test local changes in another project using this library (e.g. in [mud-react](https://github.com/Multi-User-Domain/mud-react)), you can use `npm link` or `yarn link`, commands which create an operating system link to the local version of the library:
+
+```
+cd /path/to/mud-lib/
+yarn link
+cd /path/to/other/project/
+yarn link "@multi-user-domain/mud-lib"
+```
+
+Sometimes this can lead to an error `Invalid Hook Call` in the project using mud-lib. If this happens and when you run `npm ls react` it displays more than one version of React, the issue is because the bundler "sees" two Reacts - one in the library folder and one in the application folder. The [React docs describe this problem](https://reactjs.org/warnings/invalid-hook-call-warning.html), one possible fix is to run `yarn link` from `/path/to/mud-lib/node_modules/react` (and then `yarn link react` from your application folder) to make the library use the application's React copy.
+
+### Releasing
+
+Releases are automated via semantic release, which runs on all pushes to the master and next branches. If you push to master, the release will go out as a proper release in npm under the 'latest' tag. If you push to next, it goes out under the 'next' tag.

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

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

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

303287

increased by9166.33%

Lines of code

5313

increased by15080%

Number of lines in readme file

49

increased by113.04%

Worsened metrics

Dependency count

3

increased by50%

Dev dependency count

28

increased by21.74%

Number of package files

3

decreased by-62.5%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@inrupt/lit-generated-vocab-common@^0.3.11

• + Added@inrupt/solid-client@^0.4.0

• + Added@rdfjs/dataset@1.1.1

• + Added@inrupt/lit-generated-vocab-common@0.3.11(transitive)

• + Added@inrupt/lit-vocab-term@0.3.5(transitive)

• + Added@inrupt/solid-client@0.4.0(transitive)

• + Added@rdfjs/data-model@1.1.21.3.4(transitive)

• + Added@rdfjs/dataset@1.1.1(transitive)

• + Added@rdfjs/types@1.1.22.0.1(transitive)

• + Added@types/n3@1.21.1(transitive)

• + Added@types/node@22.13.0(transitive)

• + Added@types/rdf-js@2.0.123.0.04.0.2(transitive)

• + Added@types/rdfjs__dataset@1.0.5(transitive)

• + Addedabort-controller@3.0.0(transitive)

• + Addedbase64-js@1.5.1(transitive)

• + Addedbuffer@6.0.3(transitive)

• + Addedcross-fetch@3.2.0(transitive)

• + Addedevent-target-shim@5.0.1(transitive)

• + Addedevents@3.3.0(transitive)

• + Addedhttp-link-header@1.1.3(transitive)

• + Addedieee754@1.2.1(transitive)

• + Addedn3@1.23.1(transitive)

• + Addednode-fetch@2.7.0(transitive)

• + Addedprocess@0.11.10(transitive)

• + Addedqueue-microtask@1.2.3(transitive)

• + Addedrdf-js@4.0.2(transitive)

• + Addedreadable-stream@4.7.0(transitive)

• + Addedsafe-buffer@5.2.1(transitive)

• + Addedstring_decoder@1.3.0(transitive)

• + Addedtr46@0.0.3(transitive)

• + Addedundici-types@6.20.0(transitive)

• + Addedwebidl-conversions@3.0.1(transitive)

• + Addedwhatwg-url@5.0.0(transitive)

• - Removedjs-tokens@4.0.0(transitive)

• - Removedloose-envify@1.4.0(transitive)

• - Removedobject-assign@4.1.1(transitive)

• - Removedreact@17.0.2(transitive)

• - Removedreact-dom@17.0.2(transitive)

• - Removedscheduler@0.20.2(transitive)