Automation - Scripts and runners

README.md

@@ -1,30 +1,35 @@
-# React Hooks
+# 🎒 React Hooks
+
 A modular collection of React hooks.
 
 🦄 TypeScript support • 🐐 Fully tested • 👾 Server rendering compatible
 
 ![Travis](https://img.shields.io/travis/com/simmo/hooks?style=flat-square)
 ![License](https://img.shields.io/github/license/simmo/hooks?style=flat-square)
 
+## Help
+
+Run `yarn go`
+
 ## Packages
 
 See `./packages/*` for individual package installation details.
 
-| Package | Version | Description |
-| ------- | ------- | ----------- |
-| [@hooks/before-unload](packages/before-unload) | ![npm](https://img.shields.io/npm/v/@hooks/before-unload?style=flat-square) | React hook to provide a message before the page is unloaded |
-| [@hooks/boolean](packages/boolean) | ![npm](https://img.shields.io/npm/v/@hooks/boolean?style=flat-square) | React hook to store a boolean |
-| [@hooks/geo-location](packages/geo-location) | ![npm](https://img.shields.io/npm/v/@hooks/geo-location?style=flat-square) | React hook to return geo location details |
-| [@hooks/interval](packages/interval) | ![npm](https://img.shields.io/npm/v/@hooks/interval?style=flat-square) | React hook to wrap setInterval |
-| [@hooks/media-query](packages/media-query) | ![npm](https://img.shields.io/npm/v/@hooks/media-query?style=flat-square) | React hook to respond to media queries |
-| [@hooks/mount](packages/mount) | ![npm](https://img.shields.io/npm/v/@hooks/mount?style=flat-square) | React hook to execute callback on component mount |
-| [@hooks/network-status](packages/network-status) | ![npm](https://img.shields.io/npm/v/@hooks/network-status?style=flat-square) | React hook return network status details |
-| [@hooks/previous](packages/previous) | ![npm](https://img.shields.io/npm/v/@hooks/previous?style=flat-square) | React hook to remember a value between renders |
-| [@hooks/queue](packages/queue) | ![npm](https://img.shields.io/npm/v/@hooks/queue?style=flat-square) | React hook to manage a queue |
-| [@hooks/raf](packages/raf) | ![npm](https://img.shields.io/npm/v/@hooks/raf?style=flat-square) | React hook to wrap requestAnimationFrame |
-| [@hooks/render-count](packages/render-count) | ![npm](https://img.shields.io/npm/v/@hooks/render-count?style=flat-square) | React hook to record the render count |
-| [@hooks/stack](packages/stack) | ![npm](https://img.shields.io/npm/v/@hooks/stack?style=flat-square) | React hook to manage a stack |
-| [@hooks/store](packages/store) | ![npm](https://img.shields.io/npm/v/@hooks/store?style=flat-square) | React hook to provide an observable global store |
-| [@hooks/timeout](packages/timeout) | ![npm](https://img.shields.io/npm/v/@hooks/timeout?style=flat-square) | React hook to delay function execution |
-| [@hooks/title](packages/title) | ![npm](https://img.shields.io/npm/v/@hooks/title?style=flat-square) | React hook to set the document title |
-| [@hooks/unmount](packages/unmount) | ![npm](https://img.shields.io/npm/v/@hooks/unmount?style=flat-square) | React hook execute a callback on component unmount |
+| Package                                          | Version                                                                      | Description                                                        |
+| ------------------------------------------------ | ---------------------------------------------------------------------------- | ------------------------------------------------------------------ |
+| [@hooks/before-unload](packages/before-unload)   | ![npm](https://img.shields.io/npm/v/@hooks/before-unload?style=flat-square)  | React hook to provide a message prompt before the page is unloaded |
+| [@hooks/boolean](packages/boolean)               | ![npm](https://img.shields.io/npm/v/@hooks/boolean?style=flat-square)        | React hook to store a boolean                                      |
+| [@hooks/geo-location](packages/geo-location)     | ![npm](https://img.shields.io/npm/v/@hooks/geo-location?style=flat-square)   | React hook to return geo location details                          |
+| [@hooks/interval](packages/interval)             | ![npm](https://img.shields.io/npm/v/@hooks/interval?style=flat-square)       | React hook to wrap setInterval                                     |
+| [@hooks/media-query](packages/media-query)       | ![npm](https://img.shields.io/npm/v/@hooks/media-query?style=flat-square)    | React hook to respond to media queries                             |
+| [@hooks/mount](packages/mount)                   | ![npm](https://img.shields.io/npm/v/@hooks/mount?style=flat-square)          | React hook to execute callback on component mount                  |
+| [@hooks/network-status](packages/network-status) | ![npm](https://img.shields.io/npm/v/@hooks/network-status?style=flat-square) | React hook return network status details                           |
+| [@hooks/previous](packages/previous)             | ![npm](https://img.shields.io/npm/v/@hooks/previous?style=flat-square)       | React hook to remember a value between renders                     |
+| [@hooks/queue](packages/queue)                   | ![npm](https://img.shields.io/npm/v/@hooks/queue?style=flat-square)          | React hook to manage a queue                                       |
+| [@hooks/raf](packages/raf)                       | ![npm](https://img.shields.io/npm/v/@hooks/raf?style=flat-square)            | React hook to wrap requestAnimationFrame                           |
+| [@hooks/render-count](packages/render-count)     | ![npm](https://img.shields.io/npm/v/@hooks/render-count?style=flat-square)   | React hook to record the render count                              |
+| [@hooks/stack](packages/stack)                   | ![npm](https://img.shields.io/npm/v/@hooks/stack?style=flat-square)          | React hook to manage a stack                                       |
+| [@hooks/store](packages/store)                   | ![npm](https://img.shields.io/npm/v/@hooks/store?style=flat-square)          | React hook to provide an observable global store                   |
+| [@hooks/timeout](packages/timeout)               | ![npm](https://img.shields.io/npm/v/@hooks/timeout?style=flat-square)        | React hook to delay function execution                             |
+| [@hooks/title](packages/title)                   | ![npm](https://img.shields.io/npm/v/@hooks/title?style=flat-square)          | React hook to set the document title                               |
+| [@hooks/unmount](packages/unmount)               | ![npm](https://img.shields.io/npm/v/@hooks/unmount?style=flat-square)        | React hook execute a callback on component unmount                 |

package.json

@@ -8,7 +8,7 @@
     "lint": "eslint --ext .tsx,.ts ./packages",
     "report": "node ./scripts/build-report.js",
     "lerna": "lerna",
-    "readme": "node ./scripts/generateReadme"
+    "go": "node ./scripts"
   },
   "prettier": {
     "arrowParens": "avoid",
@@ -72,13 +72,16 @@
     "@types/testing-library__react-hooks": "^3.2.0",
     "@typescript-eslint/eslint-plugin": "^2.26.0",
     "@typescript-eslint/parser": "^2.26.0",
+    "chalk": "^4.0.0",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.9.0",
     "eslint-plugin-prettier": "^3.1.2",
     "eslint-plugin-react-hooks": "^3.0.0",
+    "inquirer": "^7.1.0",
     "jest": "^25.2.7",
     "jest-serializer-path": "^0.1.15",
     "lerna": "^3.20.2",
+    "listr": "^0.14.3",
     "ora": "^4.0.3",
     "prettier": "^2.0.1",
     "react": "^16.12.0",

packages/before-unload/README.md

@@ -1,4 +1,4 @@
-# @hooks/before-unload
+# 🎒 @hooks/before-unload
 
 React hook to provide a message prompt before the page is unloaded
 

packages/before-unload/package.json

@@ -21,8 +21,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/boolean/README.md

@@ -1,4 +1,4 @@
-# @hooks/boolean
+# 🎒 @hooks/boolean
 
 React hook to store a boolean
 

packages/boolean/package.json

@@ -22,8 +22,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/geo-location/README.md

@@ -1,4 +1,4 @@
-# @hooks/geo-location
+# 🎒 @hooks/geo-location
 
 React hook to return geo location details
 

packages/geo-location/package.json

@@ -24,8 +24,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/interval/README.md

@@ -1,4 +1,4 @@
-# @hooks/interval
+# 🎒 @hooks/interval
 
 React hook to wrap setInterval
 

packages/interval/package.json

@@ -22,8 +22,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/media-query/README.md

@@ -1,4 +1,4 @@
-# @hooks/media-query
+# 🎒 @hooks/media-query
 
 React hook to respond to media queries
 

packages/media-query/package.json

@@ -23,8 +23,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/mount/README.md

@@ -1,4 +1,4 @@
-# @hooks/mount
+# 🎒 @hooks/mount
 
 React hook to execute callback on component mount
 

packages/mount/package.json

@@ -21,10 +21,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme",
-    "tsdoc": "typedoc --json ./docs.json --exclude *.test.ts ./",
-    "read": "node ./read"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/network-status/README.md

@@ -1,4 +1,4 @@
-# @hooks/network-status
+# 🎒 @hooks/network-status
 
 React hook return network status details
 

packages/network-status/package.json

@@ -22,8 +22,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/previous/README.md

@@ -1,4 +1,4 @@
-# @hooks/previous
+# 🎒 @hooks/previous
 
 React hook to remember a value between renders
 

packages/previous/package.json

@@ -21,10 +21,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme",
-    "tsdoc": "typedoc --json ./docs.json --exclude *.test.ts ./",
-    "read": "node ./read"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/queue/README.md

@@ -1,4 +1,4 @@
-# @hooks/queue
+# 🎒 @hooks/queue
 
 React hook to manage a queue
 

packages/queue/package.json

@@ -21,10 +21,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme",
-    "tsdoc": "typedoc --json ./docs.json --exclude *.test.ts ./",
-    "read": "node ./read"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/raf/README.md

@@ -1,4 +1,4 @@
-# @hooks/raf
+# 🎒 @hooks/raf
 
 React hook to wrap requestAnimationFrame
 

packages/raf/package.json

@@ -24,8 +24,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/render-count/README.md

@@ -1,4 +1,4 @@
-# @hooks/render-count
+# 🎒 @hooks/render-count
 
 React hook to record the render count
 

packages/render-count/package.json

@@ -21,8 +21,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/stack/README.md

@@ -1,4 +1,4 @@
-# @hooks/stack
+# 🎒 @hooks/stack
 
 React hook to manage a stack
 

packages/stack/package.json

@@ -21,10 +21,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme",
-    "tsdoc": "typedoc --json ./docs.json --exclude *.test.ts ./",
-    "read": "node ./read"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/store/README.md

@@ -1,4 +1,4 @@
-# @hooks/store
+# 🎒 @hooks/store
 
 React hook to provide an observable global store
 

packages/store/package.json

@@ -20,8 +20,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/timeout/README.md

@@ -1,4 +1,4 @@
-# @hooks/timeout
+# 🎒 @hooks/timeout
 
 React hook to delay function execution
 

packages/timeout/package.json

@@ -23,8 +23,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/title/README.md

@@ -1,4 +1,4 @@
-# @hooks/title
+# 🎒 @hooks/title
 
 React hook to set the document title
 

packages/title/package.json

@@ -21,8 +21,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

packages/unmount/README.md

@@ -1,4 +1,4 @@
-# @hooks/unmount
+# 🎒 @hooks/unmount
 
 React hook execute a callback on component unmount
 

packages/unmount/package.json

@@ -21,10 +21,7 @@
   "license": "MIT",
   "scripts": {
     "prepublishOnly": "yarn build",
-    "build": "node ../../scripts/build",
-    "docs": "node ../../scripts/generateProjectReadme",
-    "tsdoc": "typedoc --json ./docs.json --exclude *.test.ts ./",
-    "read": "node ./read"
+    "build": "node ../../scripts/build"
   },
   "publishConfig": {
     "access": "public"

scripts/.eslintrc

@@ -0,0 +1,6 @@
+{
+  "rules": {
+    "@typescript-eslint/no-var-requires": 0,
+    "no-undef": 0
+  }
+}