Skip to content
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

chore: move TypeScript type dependencies to dev dependencies #1383

Merged
merged 2 commits into from
Jan 18, 2024
Merged

chore: move TypeScript type dependencies to dev dependencies #1383

merged 2 commits into from
Jan 18, 2024

Conversation

fxOne
Copy link
Contributor

@fxOne fxOne commented Jan 5, 2024

What/Why/How?

Currently, @types/node is a dependency in the @redocly/openapi-core package. As these are only TypeScript types, they are not needed in production and can be moved to a dev dependency.

Also, there is already a @types/node@17.0.31 in the root package. My question would be whether the dependency there should be sufficient and whether the dependency should be changed to a more up-to-date version.

Reference

Testing

Screenshots (optional)

Check yourself

  • Code is linted
  • Tested with redoc/reference-docs/workflows (internal)
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

@fxOne fxOne requested a review from a team as a code owner January 5, 2024 11:13
Copy link

changeset-bot bot commented Jan 5, 2024

⚠️ No Changeset found

Latest commit: eda23fb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@tatomyr
Copy link
Contributor

tatomyr commented Jan 5, 2024

Thank you for spotting this on!
You absolutely can try updating the types to a newer version unless there're massive issues with that.

@tatomyr tatomyr changed the title Moving TypeScript type dependencies to dev dependencies chore: move TypeScript type dependencies to dev dependencies Jan 5, 2024
@lornajane
Copy link
Contributor

@tatomyr Do we need to wait for the types dependency to be updated, or would this pull request be useful as it is?

@tatomyr
Copy link
Contributor

tatomyr commented Jan 16, 2024

@lornajane no we don't. If @fxOne won't update this, I'll merge this MR as it is before the next release.

@fxOne
Copy link
Contributor Author

fxOne commented Jan 17, 2024

@tatomyr I have updated @types/node to the latest version.

Copy link
Contributor

@tatomyr tatomyr left a comment

Choose a reason for hiding this comment

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

Thank you @fxOne for improving Redocly CLI! 😄

@tatomyr tatomyr merged commit 94db1ea into Redocly:main Jan 18, 2024
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants