npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

grunt-package-modules

v1.0.0

Published

Packages node_modules dependencies at build time for addition to a distribution package.

Downloads

454

Readme

grunt-package-modules

Packages node_modules dependencies at build time for addition to a distribution package.

Checking node_modules in to source control is a lame solution to locking dependencies for a certain commit. npm shrinkwrap is great for locking dependencies to specific commits but doesn't directly help with distribution packaging.

The node_modules folder that is used for building your project is not viable for dist packaging because it will contain dev dependencies (like this grunt plugin) and can also contain host-specific binary node modules.

This task takes care of creating a fresh node_modules for including in a distribution tarball by effectively copying the package.json into a temp directory, and then executing npm install --production --ignore-scripts --prefix tempdir/ to install all production deps into tmpdir/node_modules.

This directory can then be the source of another plugin, like copy or compress, to package the fresh node_modules into its delicious-looking retail packaging.

This is a great module to use with the concurrent plugin so that the node modules will download while other parts of your packaging flow are executing (sassing, lessing, uglifying, compiling, and other transformation plugins verbified).

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-package-modules --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-package-modules');

The "packageModules" task

Overview

In your project's Gruntfile, add a section named package_modules to the data object passed into grunt.initConfig().

The src is the package.json that describes the dependencies that should be packaged up. The dest is the destination directory where the fresh node_modules directory should be placed, this is usually a temp directory.

grunt.initConfig({
  packageModules: {
    dist: {
      src: 'package.json',
      dest: '.tmp/module_packaging'
    },
  },
});

Examples

Here is an example that uses the copy and compress plugins to send the packaged modules to a dist tarball:

grunt.initConfig({
  packageModules: {
    dist: {
      src: 'package.json',
      dest: 'dist'
    },
  },
  copy: {
    dist: {
  	  files: [{
		// Copy project files to dist dir
        expand: true,
        dest: 'dist',
        src: [
          'lib/**/*'
        ]
      }]
    },
  },
  // tarball all the files in the dist dir into proj-dist.tar.gz
  compress: {
    dist: {
      options: {
	    archive: 'dist/proj-dist.tar.gz'
	  },
	  files: [{
	    expand: true,
		dot: true,
		cwd: 'dist',
        src: '**/*'
      }]
    }
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

v0.1.0 Initial Release

To Do

  • [ ] Tests
  • [ ] Possibly add support for npm shrinkwraping