fix(build): Update contributing.md and fix npm ci (#417)

* fix(build): Update contributing.md and fix npm ci

Changes:
- Update CONTRIBUTING.md to use
> aws-lambda-powertools-typescript@0.0.1 preinstall
> (cd packages/commons && npm ci); (cd packages/logger && npm ci); (cd packages/metrics && npm ci); (cd packages/tracing && npm ci);

> @aws-lambda-powertools/commons@0.2.0 prepare
> npm run build

> @aws-lambda-powertools/commons@0.2.0 build
> tsc

added 586 packages, and audited 587 packages in 4s

84 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

> @aws-lambda-powertools/logger@0.2.0 prepare
> npm run build

> @aws-lambda-powertools/logger@0.2.0 build
> tsc

added 488 packages, and audited 489 packages in 4s

72 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

> @aws-lambda-powertools/metrics@0.2.0 prepare
> npm run build

> @aws-lambda-powertools/metrics@0.2.0 build
> tsc

added 822 packages, and audited 852 packages in 10s

91 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

> @aws-lambda-powertools/tracer@0.2.0 prepare
> npm run build

> @aws-lambda-powertools/tracer@0.2.0 build
> tsc

added 836 packages, and audited 859 packages in 8s

72 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities

added 1327 packages, removed 2761 packages, changed 10 packages, and audited 1383 packages in 40s

100 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities
- Add a preinstall task to install all of the sub packages

closes #415

* fix(build): Update contributing.md and fix npm ci

Changes:
- Update CONTRIBUTING.md to use npm ci
- Add a preinstall task to install all of the sub packages

closes #415

* chore: leave as npm install for now

* fix(all): setup up project references

* docs: update to use npm ci

Author: Michael Brewer

CONTRIBUTING.md

@@ -7,6 +7,7 @@ Please read through this document before submitting any issues or pull requests
 information to effectively respond to your bug report or contribution.
 
 ## Security issue notifications
+
 If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public GitHub issue.
 
 ## Reporting Bugs/Feature Requests
@@ -35,7 +36,7 @@ Contributions via pull requests are much appreciated. Before sending us a pull r
 To send us a pull request, please follow these steps:
 
 1. Fork the repository.
-2. Install dependencies: `npm install`
+2. Install dependencies: `npm ci`
 3. Prepare utilities like commit hooks: `npm run init-environment`
 4. Create a new branch to focus on the specific change you are contributing e.g. `git checkout -b improv/logger-debug-sampling`
 5. Run all tests, and code baseline checks: `npm run test`
@@ -54,8 +55,9 @@ You might find useful to run both the documentation website and the API referenc
 * **Docs website**:
 
 You can build and start a local docs website by running these two commands.
-  - `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
-  - `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
+
+* `npm run docs-buildDockerImage` OR `docker build -t squidfunk/mkdocs-material ./docs/`
+* `npm run docs-runLocalDocker` OR `docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material`
 
 ### Conventions
 
@@ -89,4 +91,4 @@ TODO
 
 See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
 
-We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.
+We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

packages/commons/tsconfig.json

@@ -1,5 +1,6 @@
 {
     "compilerOptions": {
+        "composite": true,
         "experimentalDecorators": true,
         "noImplicitAny": true,
         "target": "ES2020",

packages/logger/tsconfig.json

@@ -26,5 +26,10 @@
     "types": [
         "jest",
         "node"
+    ],
+    "references": [
+        {
+            "path": "../commons"
+        }
     ]
 }

packages/metrics/tsconfig.json

@@ -28,5 +28,10 @@
     "types": [
         "jest",
         "node"
+    ],
+    "references": [
+        {
+            "path": "../commons"
+        }
     ]
 }

packages/tracing/tsconfig.json

@@ -28,5 +28,10 @@
     "types": [
         "jest",
         "node"
+    ],
+    "references": [
+        {
+            "path": "../commons"
+        }
     ]
 }