Skip to content

Conversation

@JasonWeinzierl
Copy link
Owner

The upstream repo will publish the docs folder to npm when published. But most ESLint plugins nowadays do not do this. We can gain some space savings by removing docs from the published artifacts.

Output from npm pack before removing docs:

npm notice package size: 62.7 kB
npm notice unpacked size: 378.7 kB

After removing docs:

npm notice package size: 48.4 kB
npm notice unpacked size: 298.8 kB

@JasonWeinzierl
Copy link
Owner Author

Unrelated note: we could gain additional space savings by removing the CJS build and only publishing ESM.

ESM-only:

npm notice package size: 27.3 kB
npm notice unpacked size: 158.0 kB

@github-actions
Copy link

LCOV of commit 189a7da during .github/workflows/ci.yml #503

Summary coverage rate:
  lines......: 96.7% (4333 of 4479 lines)
  functions..: 96.1% (270 of 281 functions)
  branches...: no data found

Files changed coverage rate: n/a

@JasonWeinzierl JasonWeinzierl merged commit cd82f47 into main Apr 18, 2025
3 checks passed
@JasonWeinzierl JasonWeinzierl deleted the stop-publishing-docs branch April 18, 2025 15:58
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.

2 participants