Skip to content

chore: add files field to limit npm package contents#12

Merged
Saturate merged 1 commit into
mainfrom
chore/npm-files-field
Apr 10, 2026
Merged

chore: add files field to limit npm package contents#12
Saturate merged 1 commit into
mainfrom
chore/npm-files-field

Conversation

@Saturate
Copy link
Copy Markdown
Owner

Summary

Adds files field to package.json so only the necessary files are published to npm:

  • dist/ (compiled JS + types + sourcemaps)
  • README.md
  • CHANGELOG.md
  • LICENSE
  • package.json (always included)

Excludes .github/, src/, test/, biome.json, cliff.toml, tsconfig.json, etc.

Test plan

  • pnpm pack --dry-run confirms correct file list
  • Installed from tarball in a temp project, verified library imports and CLI both work

Only publish dist/, README, CHANGELOG, and LICENSE. Excludes .github/,
src/, test/, and config files from the npm package.
@Saturate Saturate merged commit 4b0ef4b into main Apr 10, 2026
2 checks passed
@Saturate Saturate deleted the chore/npm-files-field branch April 10, 2026 09:33
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.

1 participant