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

Move non-runtime related deps to devDependencies #175

Merged
merged 1 commit into from
Dec 14, 2023

Conversation

SalmonMode
Copy link
Contributor

Problem

The purpose of this change is to significantly reduce the size of the package when installed. The issue is fully described in #174.

Solution

The solution is to move the non-runtime related dependencies into the devDependencies section of the package.json file so that npm doesn't try to install them in a nested node_modules folder.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Infrastructure change (CI configs, etc)
  • Non-code change (docs, etc)
  • None of the above: dependency tweaks

Test Plan

The code compiled and the unit checks passed. The packages moved are either entirely type declaration files (i.e., <name>.d.ts) and/or needed only for compilation (and would be likely be included in the parent package anyway if actually needed). That said, if there's any doubts, we'd know for sure if it'd work after pruning the dev dependencies and trying it out.

Copy link
Contributor

@austin-denoble austin-denoble left a comment

Choose a reason for hiding this comment

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

This looks good, thank you for taking the initiative to clean our dependencies up a bit!

CI is failing due to the inability to share repo secrets with forks, I posted a draft PR just to validate the TS compile checks and integration tests: #176

@austin-denoble austin-denoble merged commit 7571850 into pinecone-io:main Dec 14, 2023
4 of 20 checks passed
@SalmonMode
Copy link
Contributor Author

Awesome! Glad I could help!

@netroy
Copy link

netroy commented Dec 21, 2023

I just discovered that this package was making up for over 10% of our docker image and was about to send this same PR 😅
Thanks for fixing it @SalmonMode 💟

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