@paystack/inline-js - npm Package Compare versions

Comparing version 2.12.1 to 2.12.2

package.json

 {
   "name": "@paystack/inline-js",
-  "version": "2.12.1",
+  "version": "2.12.2",
   "description": "Client-side library to load the Paystack checkout form",
@@ -10,3 +10,4 @@ "main": "lib/inline.js",
     "lib",
-    "es"
+    "es",
+    "PUBLIC_DOCS"
   ],
@@ -31,56 +32,41 @@ "repository": {
   "devDependencies": {
+    "@babel/core": "^7.17.5",
+    "@babel/preset-env": "^7.16.11",
+    "@rollup/plugin-babel": "^5.3.1",
+    "@rollup/plugin-eslint": "^8.0.1",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "@rollup/plugin-replace": "^4.0.0",
     "axios-mock-adapter": "^1.16.0",
-    "babel-c": "^0.2.0",
-    "babel-cli": "^6.26.0",
-    "babel-eslint": "^8.2.3",
-    "babel-plugin-external-helpers": "^6.22.0",
-    "babel-polyfill": "^6.26.0",
-    "babel-preset-airbnb": "^2.4.0",
-    "babel-preset-env": "^1.7.0",
-    "babel-preset-es2015": "^6.24.1",
-    "babel-preset-stage-2": "^6.24.1",
+    "babel-jest": "^27.5.1",
     "commitizen": "^4.2.4",
     "cross-env": "^5.1.6",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^4.19.1",
-    "eslint-config-airbnb": "^16.1.0",
-    "eslint-config-prettier": "^2.9.0",
-    "eslint-plugin-import": "^2.16.0",
-    "eslint-plugin-jsx-a11y": "^6.2.1",
-    "eslint-plugin-react": "^7.12.4",
+    "eslint": "^8.10.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "fast-async": "^6.3.7",
-    "http-server": "^0.11.1",
+    "http-server": "^14.1.0",
     "husky": "^6.0.0",
-    "jest": "^23.6.0",
+    "jest": "^27.5.1",
     "jest-fetch-mock": "^3.0.3",
     "nodent-runtime": "^3.2.1",
-    "prettier-eslint": "^8.8.0",
+    "prettier": "^2.5.1",
     "rimraf": "^2.6.3",
-    "rollup": "^0.56.1",
-    "rollup-plugin-babel": "^3.0.4",
-    "rollup-plugin-commonjs": "^8.3.0",
-    "rollup-plugin-json": "^2.3.1",
-    "rollup-plugin-node-globals": "^1.2.1",
-    "rollup-plugin-node-resolve": "^3.3.0",
-    "rollup-plugin-replace": "^2.2.0",
-    "rollup-plugin-uglify": "^3.0.0",
-    "semantic-release": "^17.4.4"
+    "rollup": "^2.70.0",
+    "rollup-plugin-node-globals": "^1.4.0",
+    "rollup-plugin-terser": "^7.0.2",
+    "semantic-release": "^19.0.2"
   },
   "scripts": {
     "clean": "rimraf lib dist es",
-    "dev": "cross-env NODE_ENV=staging rollup --config rollup.config.js -o dist/inline.js && http-server ./dev -o",
-    "dev:local": "cross-env NODE_ENV=dev rollup --config rollup.config.js -o dist/inline.js && http-server ./dev -o",
-    "build:staging": "cross-env NODE_ENV=staging rollup --config rollup.config.js --output.format=iife --output.name=PaystackPop -o dist/inline.js",
+    "dev": "cross-env NODE_ENV=staging rollup --config rollup.config.js && http-server ./dev -o",
+    "dev:local": "cross-env NODE_ENV=dev rollup --config rollup.config.js && http-server ./dev -o",
+    "build:staging": "cross-env NODE_ENV=staging rollup --config rollup.config.js",
     "build:prod": "cross-env NODE_ENV=production rollup --config rollup.config.js",
-    "build": "npm run build:staging",
-    "test": "cross-env NODE_ENV=test jest",
-    "prepare": "husky install"
+    "build": "npm run build:prod",
+    "test": "jest",
+    "prepare": "husky install",
+    "lint": "npx eslint src"
   },
-  "jest": {
-    "testURL": "http://localhost/",
-    "automock": false,
-    "setupFiles": [
-      "./src/setupJest.js"
-    ]
-  },
   "release": {
@@ -109,3 +95,7 @@ "plugins": [
     }
+  },
+  "engines": {
+    "node": ">= 12.0.0",
+    "npm": ">= 6.0.0"
   }
 }

README.md

@@ -5,8 +5,14 @@ # Inline JS
 
+# Quick start
+### Requirements
 
-# Installation
+ ```
+ node >= 12.0.0
+ npm >= 6.0.0
+ ```
+### Setup
 
 Clone this repository 
 
-    git clone [e-mail]:PaystackHQ/popup-js.git
+    git clone https://github.com/PaystackHQ/inline-js.git
 
@@ -17,8 +23,18 @@ Install dependencies with:
 
-# Development
+# Local development
 
-To test Popup JS, run the command
+To test Inline JS locally, run the command;
+```
+npm run dev
+``` 
+This spins up a `http-server` serving the `dev` folder and you can then visit the different `HTML` files in that folder to test various APIs and payment flows.
 
-    npm run dev
 
+### Testing
+
+This project uses [Jest](https://jestjs.io/) for unit testing. To run all tests, use the command;
+```
+npm test
+```
+
 # Deployment
@@ -25,0 +41,0 @@

No alert changes

Improved metrics

Dev dependency count

27

decreased by-25%

Number of lines in readme file

50

increased by47.06%

Worsened metrics

Total package byte prevSize

313887

decreased by-1.36%

Lines of code

1113

decreased by-1.59%

No dependency changes