Repository navigation
fix: restrict npm package to essential files only - #13
Merged
Merged
Conversation
Add "files" field to package.json to prevent publishing dev files (.claude/, .env.local, .github/, .husky/, .mcp.json, etc.)
There was a problem hiding this comment.
Pull request overview
This pull request improves npm package publishing by implementing a whitelist approach for included files, replacing the previous blacklist approach using .npmignore. The change reduces package size from 29.9 kB to 20.4 kB by explicitly including only essential files needed for package consumers.
Changes:
- Added
filesfield topackage.jsonto whitelistdist/,README.md,LICENSE, andCHANGELOG.md - Removed
.npmignorefile that was previously used to blacklist development and configuration files
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| package.json | Added files array to explicitly whitelist essential files for npm publishing |
| .npmignore | Removed blacklist approach in favor of whitelist via files field in package.json |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
filesfield topackage.jsonto whitelist onlydist/,README.md,LICENSE, andCHANGELOG.md.npmignoreworkaround.claude/,.env.local,.github/,.husky/,.mcp.json,CLAUDE.md,docs/, etc.)Test plan
npm pack --dry-runconfirms only essential files included