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

Comparing version 2.0.3 to 2.1.0

package.json

		{
		"name": "@matrixai/typescript-demo-lib",
		"version": "2.0.3",
		"version": "2.1.0",
		"bin": {
		@@ -30,6 +30,7 @@ "typescript-demo-lib": "dist/bin/typescript-demo-lib.js"
		"test": "jest",
		"lint": "eslint '{src,tests}/*/.{js,ts}'",
		"lintfix": "eslint '{src,tests}/*/.{js,ts}' --fix",
		"lint": "eslint '{src,tests,scripts}/*/.{js,ts}'",
		"lintfix": "eslint '{src,tests,scripts}/*/.{js,ts}' --fix",
		"lint-shell": "find ./src ./tests ./scripts -type f -regextype posix-extended -regex '.*\\.(sh)' -exec shellcheck {} +",
		"docs": "rimraf ./docs && typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src",
		"pkg": "./scripts/pkg.js --no-dict=leveldown.js",
		"pkg": "node ./scripts/pkg.js --no-dict=leveldown.js",
		"typescript-demo-lib": "ts-node -r tsconfig-paths/register --compiler typescript-cached-transpile --transpile-only src/bin/typescript-demo-lib.ts"
		@@ -56,7 +57,7 @@ },
		"jest-mock-process": "^1.4.0",
		"pkg": "5.6.0",
		"pkg": "5.7.0",
		"prettier": "^2.6.2",
		"rimraf": "^3.0.2",
		"ts-jest": "^28.0.5",
		"ts-node": "^10.4.0",
		"ts-node": "10.7.0",
		"tsconfig-paths": "^3.9.0",
		@@ -63,0 +64,0 @@ "typedoc": "^0.22.15",

README.md

		@@ -21,2 +21,5 @@ # TypeScript-Demo-Lib
		nix-build ./release.nix --attr docker
		nix-build ./release.nix --attr package.linux.x64.elf
		nix-build ./release.nix --attr package.windows.x64.exe
		nix-build ./release.nix --attr package.macos.x64.macho
		```
		@@ -161,24 +164,32 @@

		#### Integration into Nix
		### Docs Generation

		Nix build uses node2nix to create the dependencies of the node modules. this does a fairly good job of detecting dependencies but with native modules it may fail to detect CLI tools like `node-gyp-build`.
		```sh
		npm run docs
		```

		To ensure the proper dependencies exist while building we need to bring in these utilities during the build:
		See the docs at: https://matrixai.github.io/TypeScript-Demo-Lib/

		```
		buildInputs = attrs.buildInputs ++ [ nodePackages.node-gyp-build ];
		```
		### Publishing

		This has to be done to both `node2nixProd` and `node2nixDev`.
		Publishing is handled automatically by the staging pipeline.

		### Docs Generation
		Prerelease:

		```sh
		npm run docs
		# npm login
		npm version prepatch --preid alpha # premajor/preminor/prepatch
		git push --follow-tags
		```

		See the docs at: https://matrixai.github.io/TypeScript-Demo-Lib/
		Release:

		### Publishing
		```sh
		# npm login
		npm version patch # major/minor/patch
		git push --follow-tags
		```

		Manually:

		```sh
		@@ -185,0 +196,0 @@ # npm login

New alerts