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

add .npmignore #35

Closed
wants to merge 1 commit into from
Closed

add .npmignore #35

wants to merge 1 commit into from

Conversation

CaryLandholt
Copy link

During npm publish, certain files and directories can be ignored from the package.
See https://npmjs.org/doc/developers.html#Keeping-files-out-of-your-package.
This reduces the package size.
Package consumers need only the minimum files necessary to execute the package functionality.

Keeping

  • AUTHORS
  • CHANGELOG
  • CONTRIBUTING.md
  • LICENSE-MIT

Ignoring

  • docs
  • test
  • .jshintrc
  • .travis.yml
  • Gruntfile.js

@shama
Copy link
Member

shama commented Sep 15, 2013

Hey @CaryLandholt I really appreciate these PRs. This is something I've been meaning to do with the contrib plugins. I just want to check in with the rest of the team so hold off on these for now until we get a response on this issue: gruntjs/gruntjs.com#65

@CaryLandholt
Copy link
Author

You bet - thanks!

@XhmikosR
Copy link
Member

Alternatively, you could specify the files to install in package.json, files section. This way, you have one less file, and the same result.

@shama
Copy link
Member

shama commented Sep 17, 2013

@XhmikosR Good idea, I think that is the way we are currently leaning. Just giving that issue a bit more time for other core devs to respond.

@CaryLandholt
Copy link
Author

@XhmikosR, are you suggesting to use the files array configuration inside the package.json file?
This sounds like the inverse of .npmignore (include files vs. exclude files). Is this correct?

@XhmikosR
Copy link
Member

Yeah, that's what I was suggesting. It is the inverse but the result is the same.

@vladikoff
Copy link
Member

@shama what was the ignore pattern that we agreed upon? was it to only include LICENSE and tasks ?
Should @CaryLandholt update this to address that?

@shama
Copy link
Member

shama commented Oct 26, 2013

If @CaryLandholt wants to address it that would be great. Otherwise I'll write a script that does this for all the contrib tasks soon. See: gruntjs/gruntjs.com#65 (comment)

@vladikoff
Copy link
Member

Hey @CaryLandholt if you have time, could you updated this PR based on gruntjs/gruntjs.com#65 ?

@vladikoff
Copy link
Member

Seems inactive, closing. This should be addressed in the future script across all contrib plugins

@vladikoff vladikoff closed this Dec 10, 2013
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.

4 participants