Docs: unable to clone & install for development

[dreamorosi]

Bug description

Reported by @michaelbrewer on the Slack Dev channel.

Unable to install package after clean clone of repo, see screenshot above.

Expected Behavior

Be able to git clone ... & npm install.

Current Behavior

Throws an error for missing import of @aws-lambda-powertools/commons (see screenshot).

Possible Solution

N/A

Steps to Reproduce

1. git clone
2. npm i

Environment

• Powertools version used: 0.2.0
• Packaging format (Layers, npm): npm
• AWS Lambda function runtime: N/A - local development
• Debugging logs:

npm --version
8.3.0

node --version
17.3.0

Running on Apple Silicon

Related issues, RFCs

N/A

[michaelbrewer]

Following Makefile works for me now when i run make dev

dev:
	cd packages/commons; npm ci
	cd packages/logger; npm ci
	cd packages/metrics; npm ci
	cd packages/tracing; npm ci
	npm ci
	npm run init-environment

[michaelbrewer]

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

A fix is up, to confirm it works just run:

git clean -fdx
npm ci
npm run init-environment
npm run test

[simonireilly]

Looks like the packages don't know how to build their references.

// packages/metrics/tsconfig.json
  "references": [
    {
      "path": "../commons"
    }
  ]

Use this to declare a list of modules this package depends on.

When running tsc --build it will build its references first, then import them.

When using vscode it does this in a background thread continuously to maintain accurate intellisense.

I can put a PR in for this, as it's probably the long term fix, over maintaining a topographical build command.

[michaelbrewer]

@simonireilly - cool. i just wanted a fix to allow for people to work from the project :)

[simonireilly]

@simonireilly - cool. i just wanted a fix to allow for people to work from the project :)

Totally, user experience and pragmatism first 🙏

[michaelbrewer]

@simonireilly - i updated the PR to make the project references work

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

@dreamorosi PR is ready to review

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.