Skip to content

Package is published with .idea IDE configuration files #126

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.

Sign up for GitHub

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

Jump to bottom
Closed
thibaudcolas opened this issue Sep 5, 2020 · 2 comments
Closed

Package is published with .idea IDE configuration files #126

thibaudcolas opened this issue Sep 5, 2020 · 2 comments
Labels
enhancement

Comments

@thibaudcolas
Copy link
Contributor

The published package contains your IDE’s configuration files, which I assume is unintended:

$ la node_modules/sass-resources-loader
total 64
drwxr-xr-x  11 thibaudcolas  staff   352 Aug 26 15:44 .idea/
-rw-r--r--   1 thibaudcolas  staff  2004 Oct 26  1985 CHANGELOG.md
-rw-r--r--   1 thibaudcolas  staff  1435 Oct 26  1985 CODE_OF_CONDUCT.md
-rw-r--r--   1 thibaudcolas  staff  2582 Oct 26  1985 CONTRIBUTING.md
-rw-r--r--   1 thibaudcolas  staff  1053 Oct 26  1985 LICENSE
-rw-r--r--   1 thibaudcolas  staff  7136 Oct 26  1985 README.md
-rw-r--r--   1 thibaudcolas  staff   115 Oct 26  1985 jest.config.js
drwxr-xr-x   4 thibaudcolas  staff   128 Aug 26 15:44 lib/
-rw-r--r--   1 thibaudcolas  staff  2618 Aug 26 15:45 package.json

I’d suggest removing the .npmignore file, and using the package.json’s files field instead:

"files": [
    "lib"
  ],

This will result in the list below (a few files are included no matter what):

$ la node_modules/sass-resources-loader
total 64
-rw-r--r--   1 thibaudcolas  staff  2004 Oct 26  1985 CHANGELOG.md
-rw-r--r--   1 thibaudcolas  staff  1053 Oct 26  1985 LICENSE
-rw-r--r--   1 thibaudcolas  staff  7136 Oct 26  1985 README.md
drwxr-xr-x   4 thibaudcolas  staff   128 Aug 26 15:44 lib/
-rw-r--r--   1 thibaudcolas  staff  2618 Aug 26 15:45 package.json
@justin808
Copy link
Member

I agree. @thibaudcolas could you create a PR and confirm this works for you?

@justin808 justin808 mentioned this issue Sep 5, 2020
Closed
@thibaudcolas thibaudcolas mentioned this issue Sep 16, 2020
Merged
justin808 pushed a commit that referenced this issue Sep 19, 2020
@thibaudcolas
Package cleanup: reduce published files and dependencies (#126, #127) (…
d2d1c44 
…#128)

* Switch to package.json files property to limit published package files
* Move development-only dependencies to devDependencies
@justin808
Copy link
Member

Fixed in #128

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@thibaudcolas @justin808