Skip to content

update peer dependencies for openapi3 emitter #6666

New issue

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

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

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

skywing918
Copy link
Member

Add all dev dependencies starting with @typespec into peer dependencies.

Copy link
Contributor

github-actions bot commented Mar 25, 2025

All changed packages have been documented.

  • @typespec/openapi3
Show changes

@typespec/openapi3 - internal ✏️

Add all dev dependencies starting with @typespec into peer dependencies.

@wanlwanl
Copy link
Member

wanlwanl commented Mar 25, 2025

vscode extension needs to know the rest library is expected.
@chunyu3 could you add more details that why you want to add to peer dependencies?

Copy link
Member

@timotheeguerin timotheeguerin left a comment

Choose a reason for hiding this comment

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

At least 2 of those dependencies shouldn't be here. Xml also not being describe doesn't hurt as it is a completely optional thing.

Can you explain more why this pr is needed

"@typespec/versioning": "workspace:^"
"@typespec/versioning": "workspace:^",
"@typespec/rest": "workspace:^",
"@typespec/tspd": "workspace:^",
Copy link
Member

Choose a reason for hiding this comment

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

Tspd is a dev depedency that's not even published

@@ -69,7 +69,10 @@
"@typespec/http": "workspace:^",
"@typespec/json-schema": "workspace:^",
"@typespec/openapi": "workspace:^",
"@typespec/versioning": "workspace:^"
"@typespec/versioning": "workspace:^",
"@typespec/rest": "workspace:^",
Copy link
Member

Choose a reason for hiding this comment

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

can you explain more why rest is expected it is not a dependency? it is not used in any of openapi3 code.

@chrisradek
Copy link
Member

I believe these are being added because of #6664 - but the solution shouldn't be to add every library that might be used by the target TypeSpec file as a peer dependency of openapi3. openapi3 should only include libraries it depends on as peerDependencies.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
emitter:openapi3 Issues for @typespec/openapi3 emitter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants