Skip to content

fix: do not include yarn-related files in released bundle #379

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.

Sign up for GitHub

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

Merged
mikehardy merged 1 commit into from
Jan 9, 2026
Merged

fix: do not include yarn-related files in released bundle #379

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .npmignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ android/gradlew.bat
android/gradle/

.idea
yarn/
.yarn
.yarnrc.yml
Copy link
Collaborator

@mikehardy mikehardy Jan 9, 2026

Choose a reason for hiding this comment

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

there's a chance in the future this module may need patches or be typescript (requiring a post-install build step), and I usually like to make sure that in all normal cases you could run a yarn in the node_modules installed directory of a module in order to do patch-package style in-place development

But I can't see a way to ship .yarnrc.yml and the .yarn/plugins contents without bloating the normal build by at least 1.7kb already (the postinstall plugin) even though 99.9999% of people will never ever want or use it.

So, on balance I considered asking for the yarnrc and the plugins to stay in place, but I agree with leaving them - it wasn't just casually approved though, I did think about it - in case I or someone in the future looks through this and is curious about the thought process.

Cheers

Copy link
Contributor Author

@Simek Simek Jan 9, 2026

Choose a reason for hiding this comment

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

Thanks for the quick merge and providing your POV on that. I agree that .yarnrc.yml and the .yarn/plugins parts can be left in, they do not that that much space, and their overall contribution to the package size is ~1%, which should not be a problem., we are not taking several MBs here. 🙂

.release-it.json
coverage
yarn.lock
e2e/
Expand All @@ -61,10 +65,12 @@ e2e/
.nyc_output
android/.settings
*.coverage.json
*.tgz
.circleci
.eslintignore
type-test.ts
example
example-other
docs
.editorconfig
.eslintrc
Expand All @@ -73,4 +79,4 @@ docs
.prettierrc
tsconfig.json
type-test.tsx
typedocs
typedocs
Loading