search

event-catalog / create-eventcatalog

CLI tool that is used to create new catalogs
https://eventcatalog.dev
4 stars 5 forks source link

Missing Stoplight Dev Dependencies #32

Open p5 opened 3 months ago

p5 commented 3 months ago

Value Statement

As an EventCatalog user I want to be up and running with EventCatalog as quickly as possible So that I can provide value to my teams effectively

Notes

Currently, when creating a new project with $ npx @eventcatalog/create-eventcatalog@latest a package.json file is created with the following devdependencies:

When trying to start a development instance of EventCatalog, the user is facing errors about two missing dependencies:

It would be good to include these in the template so that the user can start a development instance without needing to manually configure anything or debug any issues.

I will create a PR for this shortly

boyney123 commented 2 months ago

Hey @p5

Interesting, I don't have this issue, curious what OS are you using?

p5 commented 2 months ago

Interesting, I don't have this issue, curious what OS are you using?

I'm running Fedora Workstation 40 with NodeJS 22 and Yarn 4.whatever

tamsanh commented 2 months ago

I've also just run into this issue with the same missing dependencies while using npm. Running Mac OS 14.6.1, node v20.12.2 via asdf

boyney123 commented 2 months ago

This is very strange, wonder why this is happening, and not for me. People still having this problem?

Tenzer commented 1 week ago

I am seeing the issue, but only if I try to set up a stock project using Yarn instead of npm.

When I run yarn install with "@eventcatalog/core": "2.13.3" specified as the only dependency, the following warning is emitted:

warning "@eventcatalog/core > @stoplight/json-schema-viewer@4.16.2" has unmet peer dependency "@stoplight/markdown-viewer@^5".
warning "@eventcatalog/core > @stoplight/json-schema-viewer@4.16.2" has unmet peer dependency "@stoplight/mosaic-code-viewer@^1.32".

I guess npm has differing behaviour to Yarn for peer dependencies?

boyney123 commented 1 week ago

Thanks @Tenzer , yeah I haven't actually tried with yarn or pnpm I know there a few things we have to do to set this up, but thats good to know, thanks for sharing what you found!

The warnings from npm, I'm looking at ways to get rid of these too.