brotli-cli - npm Package Compare versions

Comparing version 0.0.1 to 1.0.0

package.json

 {
   "name": "brotli-cli",
-  "version": "0.0.1",
-  "main": "index.js",
-  "repository": "https://github.com/dzek69/brotli-cli.git",
-  "author": "Jacek Nowacki <[e-mail]>",
+  "version": "1.0.0",
+  "repository": "[e-mail]:dzek69/brotli-cli.git",
+  "author": "Jacek Nowacki",
   "license": "MIT",
-  "bin": "index.js",
+  "scripts": {
+    "test": "NODE_ENV=test jest",
+    "docs": "typedoc src/index.ts --out docs --listInvalidSymbolLinks --includes tutorials",
+    "compile": "yarn compile:cjs",
+    "compile:cjs": "rm -rf dist && tsc --project tsconfig.cjs.json && node ./build-scripts/compile.cjs.after.mjs",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --ext .ts,.tsx,.js,.jsx,.mjs",
+    "lint:fix": "yarn lint --fix",
+    "prepack": "yarn compile",
+    "prepublishOnly": "yarn lint && yarn test && yarn docs",
+    "start:dev": "nodemon",
+    "start:dev:compatibility": "TS_NODE_FILES=true yarn start:dev"
+  },
+  "bin": "./dist/index.js",
+  "type": "module",
   "dependencies": {
+    "better-custom-error": "^4.0.1",
     "brotli": "^1.3.2",
-    "fs-extra": "^5.0.0"
+    "fast-glob": "^3.2.5",
+    "yargs": "^16.2.0"
   },
-  "engines": {
-    "node": ">=6.4.0"
+  "devDependencies": {
+    "@babel/core": "^7.12.10",
+    "@babel/preset-env": "^7.12.11",
+    "@babel/preset-typescript": "^7.12.7",
+    "@dzek69/eslint-config-base": "^2.0.0",
+    "@dzek69/eslint-config-typescript": "^0.2.4",
+    "@types/brotli": "^1.3.0",
+    "@typescript-eslint/eslint-plugin": "^4.11.1",
+    "@typescript-eslint/parser": "^4.11.1",
+    "eslint": "^7.14.0",
+    "fs-extra": "^9.0.1",
+    "husky": "^4.3.0",
+    "jest": "^26.6.3",
+    "must": "^0.13.4",
+    "nodemon": "^2.0.6",
+    "ts-node": "^9.0.0",
+    "typedoc": "^0.20.35",
+    "typescript": "^4.2.4"
+  },
+  "husky": {
+    "hooks": {
+      "pre-push": "yarn prepublishOnly && yarn compile"
+    }
+  },
+  "libraryTemplate": {
+    "version": "3.0.2",
+    "language": "typescript",
+    "fixDefaultForCommonJS": true
   }
 }

README.md

 # brotli-cli
 
-A basic Brotli CLI files compressor. W.I.P. CLI api will change.
+Brotli files compressor.
+Decompression feature will come.
 
@@ -12,6 +13,9 @@ Based on `brotli` npm module.
 1. `npm i -g brotli-cli`
-1. `brotli-cli file1.txt file2.svg file3.js`
+1. `brotli-cli compress file1.txt file2.svg file3.js`
 
 Files will be created in the same directory, but with `.br` extension appended. Overwriting will occur without asking.
 
+Run
+1. `brotli-cli help` for help and more examples.
+
 ### Local install
@@ -24,4 +28,10 @@
 
+### Run without installing
+
+You need npm 5.2+ for this:
+
+1. `npx brotli-cli file1.txt file2.svg file3.js`
+
 ## License
 
-MIT
+MIT

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

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

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

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

295321

increased by7663.43%

Number of package files

19

increased by280%

Lines of code

3624

increased by15656.52%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

36

increased by44%

Is type module

Yes

Worsened metrics

Dependency count

4

increased by100%

Dev dependency count

17

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedbetter-custom-error@^4.0.1

• + Addedfast-glob@^3.2.5

• + Addedyargs@^16.2.0

• + Added@nodelib/fs.scandir@2.1.5(transitive)

• + Added@nodelib/fs.stat@2.0.5(transitive)

• + Added@nodelib/fs.walk@1.2.8(transitive)

• + Addedansi-regex@5.0.1(transitive)

• + Addedansi-styles@4.3.0(transitive)

• + Addedbetter-custom-error@4.1.4(transitive)

• + Addedbraces@3.0.3(transitive)

• + Addedcliui@7.0.4(transitive)

• + Addedcolor-convert@2.0.1(transitive)

• + Addedcolor-name@1.1.4(transitive)

• + Addedemoji-regex@8.0.0(transitive)

• + Addedescalade@3.2.0(transitive)

• + Addedfast-glob@3.3.2(transitive)

• + Addedfastq@1.18.0(transitive)

• + Addedfill-range@7.1.1(transitive)

• + Addedget-caller-file@2.0.5(transitive)

• + Addedglob-parent@5.1.2(transitive)

• + Addedis-extglob@2.1.1(transitive)

• + Addedis-fullwidth-code-point@3.0.0(transitive)

• + Addedis-glob@4.0.3(transitive)

• + Addedis-number@7.0.0(transitive)

• + Addedmerge2@1.4.1(transitive)

• + Addedmicromatch@4.0.8(transitive)

• + Addedpicomatch@2.3.1(transitive)

• + Addedqueue-microtask@1.2.3(transitive)

• + Addedrequire-directory@2.1.1(transitive)

• + Addedreusify@1.0.4(transitive)

• + Addedrun-parallel@1.2.0(transitive)

• + Addedstring-width@4.2.3(transitive)

• + Addedstrip-ansi@6.0.1(transitive)

• + Addedto-regex-range@5.0.1(transitive)

• + Addedwrap-ansi@7.0.0(transitive)

• + Addedy18n@5.0.8(transitive)

• + Addedyargs@16.2.0(transitive)

• + Addedyargs-parser@20.2.9(transitive)

• - Removedfs-extra@^5.0.0

• - Removedfs-extra@5.0.0(transitive)

• - Removedgraceful-fs@4.2.11(transitive)

• - Removedjsonfile@4.0.0(transitive)

• - Removeduniversalify@0.1.2(transitive)