grunt-autoupdate
v0.0.1
Published
Auto updates the node_modules if the package.json version changed
Downloads
63
Maintainers
Readme
grunt-autoupdate
Auto updates the node_modules folder if the package.json version changed.
Why? If your node_modules folder is not under version control, then you would probably have to notify the team that the package.json changed and everyone would have to run "npm update". While this workflow could work, this is not very reliable!
Now you have grunt-autoupdate.
Getting Started
This plugin requires Grunt.
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-autoupdate --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-autoupdate');
The "autoupdate" task
Overview
The task doesn't require any configuration.
Simply add it to your default task, or make sure it's the first task being executed.
grunt.registerTask('default', ['autoupdate']);
Log example
In case the package.json version changed, this is what you can expect to see:
$ grunt
Running "autoupdate" task
New package.json version detected (from 0.0.2 to 0.0.3)
Running npm update...
... done!
>> Please run 'grunt' again
Done, without errors.
Options
options.pkgFile
Type: String
Default value: '.pkg'
The path to the cached file, which holds the previous version of the package.
Usage Examples
Default Options
grunt.initConfig({
autoupdate: {
options: {}
},
})
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
- 2014-04-26 v0.0.1 Prevents the following tasks from being executed.
- 2014-04-23 v0.0.1-beta2 MVP.
- 2014-04-19 v0.0.1-beta1 First Beta. Not production ready/tested.
License
Copyright (c) 2014 Erwan Jegouzo. Licensed under the MIT license.