Skip to content

Please add a .npmignore #164

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

Closed
SimonSchick opened this issue Jun 7, 2018 · 3 comments
Closed

Please add a .npmignore #164

SimonSchick opened this issue Jun 7, 2018 · 3 comments

Comments

@SimonSchick
Copy link

See #82

You are shipping dozens of files useless to the consumer:

node_modules/resolve/.editorconfig
node_modules/resolve/.eslintignore
node_modules/resolve/.eslintrc
node_modules/resolve/.travis.yml
node_modules/resolve/appveyor.yml

node_modules/resolve/readme.markdown
node_modules/resolve/example/
node_modules/resolve/example/async.js
node_modules/resolve/example/sync.js

node_modules/resolve/test/core.js
node_modules/resolve/test/dotdot.js
node_modules/resolve/test/faulty_basedir.js
node_modules/resolve/test/filter.js
node_modules/resolve/test/filter_sync.js
node_modules/resolve/test/mock.js
node_modules/resolve/test/mock_sync.js
node_modules/resolve/test/module_dir.js
node_modules/resolve/test/node-modules-paths.js
node_modules/resolve/test/node_path.js
node_modules/resolve/test/nonstring.js
node_modules/resolve/test/pathfilter.js
node_modules/resolve/test/precedence.js
node_modules/resolve/test/resolver.js
node_modules/resolve/test/resolver_sync.js
node_modules/resolve/test/subdirs.js
node_modules/resolve/test/symlinks.js
node_modules/resolve/test/dotdot/
node_modules/resolve/test/dotdot/index.js
node_modules/resolve/test/dotdot/abc/
node_modules/resolve/test/dotdot/abc/index.js
node_modules/resolve/test/module_dir/
node_modules/resolve/test/module_dir/xmodules/
node_modules/resolve/test/module_dir/xmodules/aaa/
node_modules/resolve/test/module_dir/xmodules/aaa/index.js
node_modules/resolve/test/module_dir/ymodules/
node_modules/resolve/test/module_dir/ymodules/aaa/
node_modules/resolve/test/module_dir/ymodules/aaa/index.js
node_modules/resolve/test/module_dir/zmodules/
node_modules/resolve/test/module_dir/zmodules/bbb/
node_modules/resolve/test/module_dir/zmodules/bbb/main.js
node_modules/resolve/test/module_dir/zmodules/bbb/package.json
node_modules/resolve/test/node_path/
node_modules/resolve/test/node_path/x/
node_modules/resolve/test/node_path/x/aaa/
node_modules/resolve/test/node_path/x/aaa/index.js
node_modules/resolve/test/node_path/x/ccc/
node_modules/resolve/test/node_path/x/ccc/index.js
node_modules/resolve/test/node_path/y/
node_modules/resolve/test/node_path/y/bbb/
node_modules/resolve/test/node_path/y/bbb/index.js
node_modules/resolve/test/node_path/y/ccc/
node_modules/resolve/test/node_path/y/ccc/index.js
node_modules/resolve/test/pathfilter/
node_modules/resolve/test/pathfilter/deep_ref/
node_modules/resolve/test/pathfilter/deep_ref/main.js
node_modules/resolve/test/precedence/
node_modules/resolve/test/precedence/aaa.js
node_modules/resolve/test/precedence/bbb.js
node_modules/resolve/test/precedence/aaa/
node_modules/resolve/test/precedence/aaa/index.js
node_modules/resolve/test/precedence/aaa/main.js
node_modules/resolve/test/precedence/bbb/
node_modules/resolve/test/precedence/bbb/main.js
node_modules/resolve/test/resolver/
node_modules/resolve/test/resolver/cup.coffee
node_modules/resolve/test/resolver/foo.js
node_modules/resolve/test/resolver/mug.coffee
node_modules/resolve/test/resolver/mug.js
node_modules/resolve/test/resolver/baz/
node_modules/resolve/test/resolver/baz/doom.js
node_modules/resolve/test/resolver/baz/package.json
node_modules/resolve/test/resolver/baz/quux.js
node_modules/resolve/test/resolver/dot_main/
node_modules/resolve/test/resolver/dot_main/index.js
node_modules/resolve/test/resolver/dot_main/package.json
node_modules/resolve/test/resolver/dot_slash_main/
node_modules/resolve/test/resolver/dot_slash_main/index.js
node_modules/resolve/test/resolver/dot_slash_main/package.json
node_modules/resolve/test/resolver/incorrect_main/
node_modules/resolve/test/resolver/incorrect_main/index.js
node_modules/resolve/test/resolver/incorrect_main/package.json
node_modules/resolve/test/resolver/other_path/
node_modules/resolve/test/resolver/other_path/root.js
node_modules/resolve/test/resolver/other_path/lib/
node_modules/resolve/test/resolver/other_path/lib/other-lib.js
node_modules/resolve/test/resolver/quux/
node_modules/resolve/test/resolver/quux/foo/
node_modules/resolve/test/resolver/quux/foo/index.js
node_modules/resolve/test/resolver/same_names/
node_modules/resolve/test/resolver/same_names/foo.js
node_modules/resolve/test/resolver/same_names/foo/
node_modules/resolve/test/resolver/same_names/foo/index.js
node_modules/resolve/test/resolver/symlinked/
node_modules/resolve/test/resolver/symlinked/_/
node_modules/resolve/test/resolver/symlinked/_/symlink_target/
node_modules/resolve/test/resolver/symlinked/_/symlink_target/.gitkeep
node_modules/resolve/test/resolver/without_basedir/
node_modules/resolve/test/resolver/without_basedir/main.js
@ljharb
Copy link
Member

ljharb commented Jun 7, 2018

None of these files are useless; npm explore resolve && npm install && npm test should always work (for all modules).

See not just #82, but #149 (review), #132 (review), #128 (review), #59 (comment).

@ljharb ljharb closed this as completed Jun 7, 2018
@SimonSchick
Copy link
Author

SimonSchick commented Jun 7, 2018

This seems like an extremely niche use case, anyone who wants to run the tests could simply install the github version via: npm i [email protected]:browserify/resolve.git#VERSION.

This modules is installed millions of times per week, I highly doubt that even 0.0001% of those installs ever access the test folder.

Also this doesn't explain why examples ci, and editorconfig files are bundled.

@ljharb
Copy link
Member

ljharb commented Jun 7, 2018

When you're offline, you don't have github available to you, but you do have your previously installed node_modules.

I'd be fine adding an npmignore for the travis-ci config, if you think those few scant bytes would be an improvement. Examples serve as documentation, and altho the editorconfig isn't currently enforced by tests, that's a check I've meant to add.

The reality is that most of this "weight" gets gzipped down to being negligible, so it's just not a real problem in practice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants