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

[meta] ship only the dist #504

Closed
wants to merge 1 commit into from
Closed

[meta] ship only the dist #504

wants to merge 1 commit into from

Conversation

osher
Copy link

@osher osher commented May 5, 2024

This will reduce your on-disk footprint from 300k to ~56k, and your package tar from 78k to 23k :)

I see you do care about your footprint, but you ship your entire repo, and your entry point was the lib/index...

Here's your current state:

$ tree node_modules/qs/
node_modules/qs/
├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── dist
│   └── qs.js
├── lib
│   ├── formats.js
│   ├── index.js
│   ├── parse.js
│   ├── stringify.js
│   └── utils.js
├── package.json
└── test
    ├── empty-keys-cases.js
    ├── parse.js
    ├── stringify.js
    └── utils.js
$ du -h node_modules/qs
116.0K  node_modules/qs/test
52.0K   node_modules/qs/dist
8.0K    node_modules/qs/.github
44.0K   node_modules/qs/lib
300.0K  node_modules/qs
$

And the diff in result of npm pack:

$ ls -la qs-*                                                                                                                                                  <aws:lwf>
-rw-r--r-- 1 osher osher 78637 May  5 19:20 qs-6.12.1.before-change.tgz
-rw-r--r-- 1 osher osher 23127 May  5 19:20 qs-6.12.1.tgz

Copy link

coderabbitai bot commented May 5, 2024

Important

Auto Review Skipped

Auto reviews are limited to the following labels: coderabbit. Please add one of these labels to enable auto reviews.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@osher osher force-pushed the patch-1 branch 2 times, most recently from 828f37e to ec2e69f Compare May 5, 2024 16:28
Copy link
Owner

@ljharb ljharb left a comment

Choose a reason for hiding this comment

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

a) the "files" field is dangerous and should never be used; this is what npmignore is for
b) this breaks what "main" is; the dist is intentionally never used in modern toolchains and will be removed entirely in v7
c) the tests are quite intentionally shipped and will forever be.

@ljharb
Copy link
Owner

ljharb commented May 6, 2024

Duplicate of #429. Duplicate of #400. Duplicate of #389. Duplicate of #356. Duplicate of #250.

The only files that currently show up in npm pack --dry-run that could be excluded are .github/FUNDING.yml - every other file is 100% necessary in the published package.

This is also the same as browserify/resolve#308; please stop sending unsolicited PRs. Nobody is accidentally shipping tests at this point.

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