WIP: mono repo with fastify, and koa middleware libs

.gitignore

@@ -1,16 +1,8 @@
-.vscode
-.idea
 .DS_Store
+/_old
+!.vscode/launch.json
+.vscode/settings.json
+.idea
 node_modules
-*.orig
 dist
-/sample
-/coverage
-.coveralls.yml
-.nyc_output
-secrets.zip
-jest
-junk
-/a_reference
-/sample2
-README.md.sav
+ignore

.gitpod.yml

@@ -1,2 +1,3 @@
 tasks:
-  - init: npm install
+  - init: npm install && npm install lerna -g
+    command: lerna bootstrap && lerna run compile

.prettierrc.json

@@ -1,4 +1,5 @@
 {
-  "singleQuote": true,
-  "trailingComma": "all"
-}
+    "singleQuote": true,
+    "trailingComma": "all"
+  }
+

.travis.yml

@@ -4,22 +4,18 @@ node_js:
 - '14'
 - '12'
 - '10'
-before_install:
-- 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then openssl aes-256-cbc -K $encrypted_deba340dfe89_key -iv $encrypted_deba340dfe89_iv
-  -in secrets.zip.enc -out secrets.zip -d; fi'
-- 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then unzip secrets.zip; fi'
 install:
-- npm install
+- npm install lerna -g
+- lerna bootstrap
 script:
-- npm run compile
-- npm run test:coverage
-- 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run coveralls; fi'
-- 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then npm run codacy; fi'
+- lerna run compile
+- lerna run test:coverage
+- if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then lerna run coveralls; fi
+- if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then lerna run codacy; fi
 env:
   global:
-  - secure: x+Nxbq8RrOVJyQ7JWNRpXdBmp61rXPKulYPxUwGeIe/ZJwX1QHsy2HAAB2m7aRvAMBAqr2urBaIKgPBmBklyY0elRTD/chUdT5cJiPhMIxBghqkQ1NYqx/WzcCBUrZbRzoQcpAES7sJnUs0PMujKv3wMsujoFJ9b9Z+trHMqD0IztBlg45azAh4A6ApVcDB8j4L+g42kps6d4r5jUt2d4uW537PKXpsnWJMaaj2Pw7pxU2H5kBaeNGnvlK+w9k3porToop7OUG+HBTN2BjofdF1PSHm8fizzFL6/h2x39cLYMxFvHb7oVUKBiWQe8PBXD5+k/X0RgPJMZO9AggMHln5MIihTowGvuSLK/3d95ta/qXTmzG0Csv4J8xWD+koCJm0xpSzsrBSUOPt5ZKN71o0VmLmc7U4Z0aEplZyVcMdTbwA1XeoeXD4UU1fD7BlzYl4oOTB8HlucJILwAZFg0upPB33lQchAUIgoUCDxze3OoG3V1Odcw4u64bXlPrdqgCg8AQZgnrYP+EzKczjGd7pBQZRVxKyq+44JV8JOUAXEka3qQRPvmw5wcAaXgsqU7uv1C6FcQb+j/ZKQ6GlWu8qDzouRR+OqbKeLk2lOvtU08Y32tn6u14+vVNbmsG3iXxGf2+esGcETFP/0EYluPGpo257h/9qC1yMN8ZExey0=
-  - secure: l5s8AWcMM9Ih8aq1OElM47vBI+NS06EB/7k19r7xsurU6+t7s1CoqdJn3HDzUfKax54HtJZzkbAAnfIhVJNIvC9srInW0fRCbD6hW9qS8o0HYDb7dakFa1/CxzoQv8Wz+xus9+Gx2IUJPGJ4ZzVGak704KW0Ds5CFnzQTorohyl/2a6jlODd2gAZMciJA0ZjQGiQPRYpt73cHa5QN03n5Buybp/m0ErsA2Wc7OZONTl0oW0hoQ0A8hICUP1nIbrZjavw8tIf5cComp9GxuatbFCRCaOu5kgbM/O5x0bKJkJutVabO1HC2dYd78o+X7e9ApH+Oly9cLEsuLyYLWnH5Kbdv2j/Huz6wP8H6is4FQUgasTUCcV5+9og6mSccoKDHIvuy0c5lkC30wuaiXJAAWSeohZ8lM6SnrDNp7Q+5mWx5ooVo4A6AGLdXNFeIkqmBat59eNijlnspkJ7MRp2+5mVI+rTyX+fwjLw6Z/1oY5GA9NY061+yPs8LL0BQYkm5r1et3lTIWGo3bJeLIZM4Dsh+VXv1Z8q7oz1PkhSwbmQH19FyQdeohgyzokidbQhGTgk8tO2ol1j2tZMPkwAh3MTRU4Gpmo641Qye69TMhBrhIb5ebmTFXt8HnRbfJT0x/hLjLdCd8hUzo27ICu7yCqZTR74RfIdBvIumSvGQJQ=
-
+  - secure: fMTLwwfm5nb7t0dP0HDoVBPprRUvGrs8VXwaTMqJvUn2jHjab8cbSo/Kkf7IAooMtSItk0NsXeH7YsZpjiEcXmEpwuHVgaRIGy0Kp0U6PXhtUNzAxiTi32/gR8HhyGUKRJpxH73A3LFVH9ybDlSUI5FNvAhtfwCjlYqiU/jiiwQfvlp/N52FwnN439rtx0leyHTOWMieTzltl7gJ1f7dNziQR2J0/aQeQYnjhy5VTXcYn0gJhJtvFWQ/A9IECbVmXcn/Qm9HQA3ooCYSO8bBrcuMxbs2TCDqHReudtRwhZNXIVZWryLYq9z2qAmG0kyxbjTlnol8FviDTHllfsqJnuT2denEwJZSelJwe0QPxYsQlI5Q8FktuE/q/O/Wqgq7LUZu83wVQO2hG5KEXCz5v24H8viVQ1pFe0WxJhaRvywB7oUimy4xZQ53v74YsJhFTmXvRlziuxVPXg+wYyaehGS1yo+k2UifJHJCPaabUu0D+0Scm1YI8TqIrEbP1aoVqMSrm9qALEGKXEXKQrOy4uum7tlXWNAFgESYOAx+wgpewHe5LGdBSUKha1AKSzyQRnlQXNTY/k4JRnwo/TLe35GVN0JAx78I23tw+uV7WL+bjDT95Lhm5lebSCyOOD2tDHxvNq9VVwyAw3xAU7aBRuupdWLM/eJ9/2K0L1T8OZA=
+  - secure: XN0VoTOd+d6RINBNw3v3+kRnCBPat+kIgc11Z4CWpGQxkJWpvqCof0L1O/yhcxeLJuK1Kskh7qF+fob9N2pRDqw0tLlfpVmtyp4YF2PP4lj2TN6J1K8duPB9Y29COoVFb98CFjiyc4D22ByN6Ej6PAYoZrUbXXg/y+2vm6ATkjzJayhPgsFQ06/5vWSTzdaKiwBlnLDjzeUpID5XvOonxPOk/Xrjwp54zKzD1kPs1D5PBxB0QTZtMOSM4udvns95qWUvzXv+yfml9RC4rnFDiWrQkrnYAaN1yNW4Cd7xoR/TiFmtkBinhrrco/+giclz8YSwUkuv9rXMbvdF5hDUbB9rfCvxmue6F9Nz0KQ15EYV/iB3e4kO8vpS+d+/H295cRueU6+70HD7NpfSthE7xHdTxR9/8wPKAHMZq230YZHAxKZkDCII8C9yhBIvQ49hleocckrlBeajTXs36HSeCgtXjZ/JeLRZlQ9Y+Z/zNnKRq/Sm2C95CfEl/YRrNaEaB6eu34Y7lIGqKapU1ka3mENEJaoNjNFEbXupKPWQeb3Qg+ssChqPEalFhozVBNErLX2PJCMaxBxm9jZFTLtLkBAk9GBBDjgnofIayX3zhuymlS72t9ptEh1LjPLVlRUAwyiPOgw5odDh2lHJGh9fllq9q1bsbiSxHchvUTF1nao=
 branches:
   only:
-  - /.*/
+  - "/.*/"

.vscode/launch.json

@@ -0,0 +1,65 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Run Mocha Tests",
+      "cwd": "${workspaceFolder}/packages/express-openapi-validator",
+      "program": "node_modules/mocha/bin/_mocha",
+      "args": [
+        "-r",
+        "source-map-support/register",
+        "-r",
+        "ts-node/register",
+        "--timeout",
+        "999999",
+        "--colors",
+        "test/**/*.spec.ts"
+      ],
+      "env": { "TS_NODE_FILES": "true" },
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "protocol": "inspector"
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Koa Mocha Tests",
+      "cwd": "${workspaceFolder}/packages/koa-openapi-validator",
+      "program": "node_modules/mocha/bin/_mocha",
+      "args": [
+        "-r",
+        "source-map-support/register",
+        "-r",
+        "ts-node/register",
+        "--timeout",
+        "999999",
+        "--colors",
+        "test/**/*.spec.ts"
+      ],
+      "env": { "TS_NODE_FILES": "true" },
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen",
+      "protocol": "inspector"
+    },
+    {
+      "name": "Node Attach",
+      "port": 9229,
+      "request": "attach",
+      "skipFiles": ["<node_internals>/**"],
+      "type": "pwa-node"
+    },
+    {
+      "name": "7-Fastify Attach",
+      "port": 9320,
+      "request": "attach", 
+      "skipFiles": ["<node_internals>/**"],
+      "cwd": "${workspaceFolder}/packages/examples/7-fastify-standard",
+      "type": "pwa-node"
+    }
+  ]
+}

CONTRIBUTING.md

@@ -4,6 +4,10 @@ Contributors are welcome!
 
 See something that needs fixing? Got an idea for a new feature? Contribute a [Pull Request](#Create-a-Pull-Request)!
 
+## Background
+
+This project is set up as a mono-repo. We use `lerna` to manage dependencies. Thus, after the initial `npm install` (to get lerna), you will use `lerna bootstrap` in place of `npm install`. This will ensure all local package / dependies are compiled/transpiled.
+
 ## Easy path to contribution
 Click the Gitpod badge to setup a ready to code dev env in the cloud.
 
@@ -20,23 +24,73 @@ Click the Gitpod badge to setup a ready to code dev env in the cloud.
    git clone <forked-repo>
    ```
 
-2. Install the dependencies
+2. Install the dependencies for each package in the mono repo
+
+   ```shell
+   # install lerna and common deps
+   npm install 
+
+   # run lerna bootstrap to install module dependencies
+   # note: use lerna bootstrap, rather than npm install
+   lerna bootstrap && lerna run compile
+   ```
+
+   _**Tip:**_ Run `lerna clean && lerna bootstrap && lerna run compile` to reset the project, e.g. clean, install, and compile all packages.
+
+3. Navigate to the package dir you'd like to modify
+
+   **Packages:**
+   - [express-openapi-validator](/packages/express-openapi-validator) - the express middleware 
+   - [koa-openapi-validator](/packages/koa-openapi-validator) - the koa middleware 
+   - [fastify-openapi-validator](/packages/fastify-openapi-validator) - the fastify middleware 
+   - [openapi-core](/packages/openapi-core) - core schema load and preprocess logic
+
 
    ```shell
-   # From the project directory, run
-   npm i
+   # for example, navigate the express validator package
+   cd packages/express-openapi-validator
    ```
+3a. Compile sources for each package in the mono repo
+
+```shell
+   lerna run compile
+```
+
+3b. Compile sources a single package
+
+```shell
+   cd packages express-openapi-validator
+   npm run compile
+```
 
-Be [Create a Pull Request](#create-a-pull-request) once you've written you code.
+4. Be [Create a Pull Request](#create-a-pull-request) once you've written you code.
 
 ## Run the tests
 
-3. Run the tests
+1a. Run all tests in the mono repo
+
+   ```shell
+    # compile any changes
+   lerna run compile
+   lerna run test
+   ```
+
+1b. Run tests in one package
+
+   Run tests in the current package:
 
    ```shell
-   npm test
+   lerna run test --scope express-openapi-validator
+   # or if in the package directory, you can run
+   npm run test
    ```
 
+## Debug
+
+If you are using VSCode, see the debugger. There are configurations:
+- Run Mocha Tests - allows to step through Mocha tests
+- 7-Fastify Attach - allows to start the fastify example and step through code
+
 ## Develop
 
 - Write code
@@ -58,11 +112,18 @@ Be [Create a Pull Request](#create-a-pull-request) once you've written you code.
 6. From the Github UI, Click Create pull request to open a new pull request
 7. Detailed steps with example here:
 
-## Project structure
+## Package
+Only maintainers have permissions to perform the publish actions:
 
-`src` contains the source code
-`test` contains the tests
+prerelease
+```shell
+lerna publish prerelease --dist-tag beta --preid beta
+```
 
+release
+```shell
+lerna publish patch # minor
+```
 ## Need help?
 
 Reach out on [gitter](https://gitter.im/cdimascio-oss/community).