@matrixai/typescript-demo-lib - npm Package Compare versions

Comparing version 1.2.0 to 1.3.0

package.json

 {
   "name": "@matrixai/typescript-demo-lib",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "bin": {
@@ -20,3 +20,4 @@ "typescript-demo-lib": "dist/bin/typescript-demo-lib.js"
       "node_modules/utp-native/**/*",
-      "node_modules/fd-lock/**/*"
+      "node_modules/fd-lock/**/*",
+      "dist/**/*.json"
     ],
@@ -33,17 +34,17 @@ "scripts": [
     "lintfix": "eslint '{src,tests}/**/*.{js,ts}' --fix",
-    "docs": "rm -r ./docs || true; typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src && touch ./docs/.nojekyll",
-    "typescript-demo-lib": "ts-node -r tsconfig-paths/register --transpile-only src/bin/typescript-demo-lib.ts"
+    "docs": "rm -r ./docs || true; typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src",
+    "typescript-demo-lib": "ts-node -r tsconfig-paths/register --compiler typescript-cached-transpile --transpile-only src/bin/typescript-demo-lib.ts"
   },
   "dependencies": {
+    "fd-lock": "^1.2.0",
     "level": "^7.0.0",
     "threads": "^1.6.5",
     "utp-native": "^2.5.3",
-    "uuid": "^8.3.0",
-    "fd-lock": "^1.2.0"
+    "uuid": "^8.3.0"
   },
   "devDependencies": {
     "@types/jest": "^27.0.2",
-    "@types/node": "^14.14.35",
-    "@typescript-eslint/eslint-plugin": "^4.12.0",
-    "@typescript-eslint/parser": "^4.12.0",
+    "@types/node": "^16.11.7",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
     "eslint": "^7.17.0",
@@ -55,4 +56,4 @@ "eslint-config-prettier": "^7.1.0",
     "jest-mock-process": "^1.4.0",
-    "node-gyp-build": "4.2.3",
-    "pkg": "5.3.0",
+    "node-gyp-build": "4.4.0",
+    "pkg": "5.6.0",
     "prettier": "^2.2.1",
@@ -62,5 +63,6 @@ "ts-jest": "^27.0.5",
     "tsconfig-paths": "^3.9.0",
-    "typedoc": "^0.21.5",
-    "typescript": "^4.1.3"
+    "typedoc": "^0.22.15",
+    "typescript": "^4.5.2",
+    "typescript-cached-transpile": "0.0.6"
   }
 }

README.md

@@ -12,3 +12,3 @@ # TypeScript-Demo-Lib
 ```sh
-nix-build -E '(import ./pkgs.nix).callPackage ./default.nix {}'
+nix-build -E '(import ./pkgs.nix {}).callPackage ./default.nix {}'
 ```
@@ -87,2 +87,23 @@
 
+### Local Package Linking
+
+When developing on multiple NPM packages, it can be easier to use `npm link` so that changes are immediately reflected rather than repeatedly publishing packages. To do this, you need to use `npm link`. After linking a local directory, you need to provide `tsconfig.json` paths so TypeScript compiler can find the right files.
+
+For example when linking `@matrixai/db` located in `../js-db`:
+
+```sh
+npm link ../js-db
+```
+
+You would need to add these paths to `tsconfig.json`:
+
+```
+  "paths": {
+    "@": ["index"],
+    "@/*": ["*"],
+    "@matrixai/db": ["../node_modules/@matrixai/db/src"],
+    "@matrixai/db/*": ["../node_modules/@matrixai/db/src/*"]
+  },
+```
+
 ### Native Module Toolchain
@@ -89,0 +110,0 @@

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

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

37872

increased by2.31%

Number of lines in readme file

189

increased by12.5%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

19

increased by5.56%

No dependency changes