If you haven't used grunt before, be sure to check out the Getting Started guide.

From the same directory as your project's Gruntfile and package.json, install this plugin with the following command:

npm install package --save-dev

Once that's done, add this line to your project's Gruntfile:

grunt.loadNpmTasks('package');

If the plugin has been installed correctly, running grunt --help at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a devDependency, which ensures that it will be installed whenever the npm install command is run.

Type: String Default value: ', '

A string value that is used to do something with whatever.

Type: String Default value: '.'

A string value that is used to do something else with whatever else.

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  package: {
    options: {},
    files: {
      'test/actual/': ['test/fixtures/*.js']
    }
  }
});

In this example, custom options are used to do something else with whatever else. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result in this case would be Testing: 1 2 3 !!!

grunt.initConfig({
  package: {
    options: {
      separator: ': ',
      punctuation: ' !!!',
    },
    files: {
      'test/actual/': ['test/fixtures/*.js']
    }
  }
});

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, and build the documentation with grunt-readme.

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

Brian Woodward

• github/doowb
• twitter/doowb

Copyright (c) 2015 undefined, contributors. Released under the license

This file was generated by grunt-readme on Wednesday, March 18, 2015.