Hate keeping version numbers and other properties up-to-date in multiple JSON package management files? Enter grunt-heritage. Automatically copy properties from a parent file (package.json
) into child files (bower.json
, component.json
, etc.).
This plugin requires Grunt ~0.4.1
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-heritage --save-dev
One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-heritage');
In your project's Gruntfile, add a section named heritage
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
heritage: {
options: {
parent: "package.json", // default
properties: ["name", "description", "version"], // default
children: ["bower.json"] // required
}
}
})
Type: String
Default value: 'package.json'
The file to pull properties from.
Type: Array
Default value: ['name', 'description', 'version']
The property names to copy into child files.
Type: Array
Default value: []
The files to write the parent properties to.
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.
0.1.0 - Initial release.