Skip to content

dev: Add dependency diagram utility #4234

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 1 commit into from
Jan 8, 2024

Conversation

nkomonen-amazon
Copy link
Contributor

@nkomonen-amazon nkomonen-amazon commented Jan 5, 2024

Adding in this dependency diagram generating utility for toolkit Browser work since we can have transitive dependencies which break the toolkit from running in the Browser.

See the browser.md guide for more details here

This will help us to find dependencies more easily instead of manually searching.

License

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@nkomonen-amazon nkomonen-amazon requested a review from a team as a code owner January 5, 2024 16:31
Copy link
Contributor

@hayemaxi hayemaxi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!

docs/browser.md Outdated

### How to use

0. Ensure you have run `npm install --save-dev`
Copy link
Contributor

@justinmk3 justinmk3 Jan 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why is --save-dev needed? npm install should install dev deps by default

Since none of our modules are importing dependency-cruiser, can we change this instruction to:

npm install dependency-cruiser

Then our package-lock.json won't have the extra deps, and we won't need to maintain that dep.

Adding in this dependency diagram generating utility for toolkit Browser
work since we can have transitive dependencies which break the toolkit from
running in the Browser.

This will help us to find dependencies more easily instead of manually searching.

Signed-off-by: nkomonen <nkomonen@amazon.com>
@nkomonen-amazon nkomonen-amazon merged commit f355be2 into aws:master Jan 8, 2024
@nkomonen-amazon nkomonen-amazon deleted the depCruiser branch January 8, 2024 19:50
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants