dynamic-doctor - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

@@ -12,6 +12,6 @@ {
   },
-  "version": "0.0.1",
+  "version": "0.0.2",
   "license": "MIT",
   "bin": {
-    "dynamic-doctor": "./dist/cjs/bin/index.js"
+    "dynamic-doctor": "./dist/index.js"
   },
@@ -26,10 +26,17 @@ "keywords": [
   "scripts": {
-    "build": "rimraf dist && yarn build:cjs && yarn build:esm",
-    "build:cjs": "rimraf dist/cjs && tsc -p tsconfig.cjs.json && yarn copy:templates:cjs",
-    "build:esm": "rimraf dist/esm && tsc -p tsconfig.esm.json && yarn copy:templates:esm",
-    "lint": "eslint .",
+    "build": "rimraf dist && rollup -c",
+    "lint:eslint": "eslint .",
+    "lint:prettier": "prettier -c '**/*.{js,jsx,ts,tsx,json,md,css,scss,html}'",
     "copy:templates:cjs": "cp -r ./src/templates ./dist/cjs/src/templates",
     "copy:templates:esm": "cp -r ./src/templates ./dist/esm/src/templates",
-    "test": "jest"
+    "test": "jest",
+    "prepare": "husky install"
   },
+  "lint-staged": {
+    "**/*.{js,jsx,ts,tsx}": [
+      "npm run lint:eslint -- --fix --cache --cache-location tmp/.eslintcache ",
+      "npm run lint:prettier -- --write "
+    ],
+    ".circleci/config.yml": "circleci config validate"
+  },
   "dependencies": {
@@ -44,2 +51,6 @@ "chalk": "4.1.2",
     "@actions/core": "1.10.0",
+    "@babel/plugin-external-helpers": "^7.22.5",
+    "@commitlint/cli": "^17.7.1",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@rollup/plugin-typescript": "^11.1.2",
     "@types/chalk": "^2.2.0",
@@ -53,2 +64,3 @@ "@types/commander": "^2.12.2",
     "@typescript-eslint/parser": "^5.53.0",
+    "babel-preset-es2015": "^6.24.1",
     "eslint": "^8.34.0",
@@ -58,5 +70,11 @@ "eslint-config-prettier": "8.5.0",
     "fs-extra": "10.1.0",
+    "husky": "^8.0.3",
     "jest": "^29.6.1",
+    "lint-staged": "^14.0.1",
     "prettier": "2.8.1",
     "rimraf": "^5.0.1",
+    "rollup": "^3.28.1",
+    "rollup-plugin-commonjs": "^10.1.0",
+    "rollup-plugin-copy": "^3.4.0",
+    "rollup-plugin-preserve-shebangs": "^0.2.0",
     "semver": "7.3.8",
@@ -72,4 +90,3 @@ "ts-jest": "^29.0.5",
   ],
-  "main": "dist/cjs/src/index.js",
-  "module": "dist/esm/src/index.js"
+  "main": "dist/index.js"
 }

README.md

@@ -1,15 +0,28 @@
-# Dynamic-Doctor 💉
+# Dynamic-Doctor 🩺
 
-![Team Doctor 💉](https://github.com/dynamic-labs/DynamicDoctor/assets/107057105/f315c93c-2d75-424f-8436-d19a960f5d53)
+![Dynamic-Doctor 🩺](https://github.com/dynamic-labs/dynamic-doctor/assets/107057105/af7b4146-6c09-42d1-8578-2287645b5f84)
 
 ## Use case
 
-You can use this package to verify your Dynamic SDK setup and generate report which can be reviewed by Dynamic Team.
+You can use this package to verify your Dynamic SDK setup and generate a report that can be reviewed by the Dynamic Team.
 
-## Building
+## How to use
 
+1. Go to root directory of your project.
+2. Run `npx dynamic-doctor run`
+
+That's all!
+
+You will see a list of issues found and a file `dynamic-doctor-report-<timestamp>.html` will be generated in your root directory.
+
+### Reporting a bug
+
+Create an issue if you find any bug or want to suggest an improvement. [Create an issue](https://github.com/dynamic-labs/dynamic-doctor/issues/new)
+
+## Running locally
+
 1. Install dependencies `yarn`
 2. Run `yarn build`
 3. Next pack local library `yarn pack`
-4. Install package `npm i -g dynamic-doctor-v0.0.1.tgz`
+4. Install package `npm i -g dynamic-doctor-v0.0.2.tgz`
 
@@ -19,1 +32,9 @@ That's your setup!
 Now you can go to the directory you want to check and simply run `dynamic-doctor run`.
+
+## Contributing
+
+Please read [CONTRIBUTING.md](https://github.com/dynamic-labs/dynamic-doctor/blob/main/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
+
+## License
+
+This project is licensed under the MIT License - see the [License](https://github.com/dynamic-labs/dynamic-doctor/blob/main/LICENSE)

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

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

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

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

Found 2 instances in 1 package

Improved metrics

Number of lines in readme file

40

increased by110.53%

Number of low supply chain risk alerts

2

decreased by-83.33%

Number of medium supply chain risk alerts

3

decreased by-40%

Worsened metrics

Total package byte prevSize

109602

decreased by-4.3%

Dev dependency count

31

increased by55%

Number of package files

75

decreased by-72.73%

Lines of code

707

decreased by-52.87%

No dependency changes