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

Configuring .npmignore #65

Closed
shama opened this issue Sep 15, 2013 · 10 comments
Closed

Configuring .npmignore #65

shama opened this issue Sep 15, 2013 · 10 comments

Comments

@shama
Copy link
Member

shama commented Sep 15, 2013

I think we should configure the .npmignore files within the contrib plugins to only include relevant files to run the task. No docs, tests or Gruntfile.js. That way we can alleviate a little bit of the time and space it takes to install the tasks.

Any objections or something I'm missing by doing this?

/cc @cowboy @vladikoff @sindresorhus @jsoverson

@jsoverson
Copy link
Member

That's probably a good idea. Personally, I like having all that extra in npm modules so that I can debug more easily when necessary, but I doubt that's a common use.

@sindresorhus
Copy link
Member

Definitely, but we should rather use the files property in package.json to include files, instead of ignoring.

https://npmjs.org/doc/json.html#files

Huge 👍 from me though.

@shama
Copy link
Member Author

shama commented Oct 19, 2013

Ok, let's do that ^. @CaryLandholt let me know if you have any interest in doing this otherwise I'll write a script and take care of this soon. Thanks!

@shama
Copy link
Member Author

shama commented Oct 19, 2013

Just for clarification, let's include:

{
  "files": [
    "tasks/",
    "AUTHORS",
    "CHANGELOG",
    "CONTRIBUTING.md",
    "LICENSE-MIT",
    "package.json",
    "README.md"
  ]
}

@sindresorhus
Copy link
Member

no need for AUTHORS, CHANGELOG, CONTRIBUTING.md in the package. And package.json and readme.md is always included, so no need to specify.

@shama
Copy link
Member Author

shama commented Oct 19, 2013

Cool, did not know that... so that makes it really simple:

{
  "files": [
    "tasks",
    "LICENSE-MIT"
  ]
}

EDIT: Removed the /. Thanks Sindre!

@sindresorhus
Copy link
Member

yup, you can drop the / too.

shama added a commit to gruntjs/grunt-contrib-stylus that referenced this issue Dec 3, 2013
shama added a commit to gruntjs/grunt-contrib-bump that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-clean that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-coffee that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-compass that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-compress that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-concat that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-connect that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-copy that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-cssmin that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-handlebars that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-imagemin that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-jasmine that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-pug that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-jst that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-less that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-nodeunit that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-qunit that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-requirejs that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-stylus that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-symlink that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-uglify that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-yuidoc that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-watch that referenced this issue Dec 15, 2013
@shama
Copy link
Member Author

shama commented Dec 15, 2013

The deed is done.

@shama shama closed this as completed Dec 15, 2013
@sindresorhus
Copy link
Member

Hah, nice. Thanks @shama

shama added a commit to gruntjs/grunt-contrib-csslint that referenced this issue Dec 15, 2013
shama added a commit to gruntjs/grunt-contrib-htmlmin that referenced this issue Dec 15, 2013
paazmaya added a commit to paazmaya/grunt-image-profile that referenced this issue Dec 16, 2013
paazmaya added a commit to paazmaya/grunt-hgactivity that referenced this issue Dec 16, 2013
paazmaya added a commit to paazmaya/grunt-html2md that referenced this issue Dec 16, 2013
@cowboy
Copy link
Member

cowboy commented Dec 16, 2013

Yay!

johnnyfreeman pushed a commit to johnnyfreeman/grunt-contrib-coffee that referenced this issue Dec 20, 2013
jgerigmeyer added a commit to oddbird/grunt-qunit-istanbul that referenced this issue Mar 14, 2014
…merge-from-upstream

* 'master' of github.com:gruntjs/grunt-contrib-qunit: (29 commits)
  Update copyright to 2014
  Style and Doc Fixes
  Squashed commit of the following:
  0.4.0
  Update grunt-lib-phantomjs to v0.5.0.
  Explicitly set files to publish to npm. Ref gruntjs/gruntjs.com#65
  Update qunit-overview.md, include CentOS dependencies. Closes asciidiscogh-49
  0.3.0 Fixes asciidiscoGH-47.
  Update to latest phantom dependency.
  Remove Gruntfile.js as main in package.json
  removing confusing error message
  Propagate error.onError events from Phantom. Closes asciidiscoGH-11.
  Update README
  Update readme to document PhantomJS OS dependencies. Fixes asciidisco#43
  Revert "Cleanup trailing whitespace in docs". Necessary for hard linebreaks.
  Cleanup trailing whitespace in docs
  Add `force` option
  Update QUnit to latest; cleanup QUnit markup
  Add new events for fail conditions, so that reporters can still report on the test
  Bump v0.2.2
  ...

Conflicts:
	CHANGELOG
	Gruntfile.js
	README.md
	package.json
	phantomjs/bridge.js
	tasks/qunit.js
jgerigmeyer added a commit to oddbird/grunt-qunit-istanbul that referenced this issue Mar 14, 2014
…:gruntjs/grunt-contrib-qunit into merge-upstream

* github.com:gruntjs/grunt-contrib-qunit: (26 commits)
  0.4.0
  Update grunt-lib-phantomjs to v0.5.0.
  Explicitly set files to publish to npm. Ref gruntjs/gruntjs.com#65
  Update qunit-overview.md, include CentOS dependencies. Closes asciidiscogh-49
  0.3.0 Fixes asciidiscoGH-47.
  Update to latest phantom dependency.
  Remove Gruntfile.js as main in package.json
  removing confusing error message
  Propagate error.onError events from Phantom. Closes asciidiscoGH-11.
  Update README
  Update readme to document PhantomJS OS dependencies. Fixes asciidisco#43
  Revert "Cleanup trailing whitespace in docs". Necessary for hard linebreaks.
  Cleanup trailing whitespace in docs
  Add `force` option
  Update QUnit to latest; cleanup QUnit markup
  Add new events for fail conditions, so that reporters can still report on the test
  Bump v0.2.2
  Remove broken link in docs
  Update devDeps
  Update copyright
  ...

Conflicts:
	README.md
	package.json
	phantomjs/bridge.js
	tasks/qunit.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants