Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pgilad/grunt-dev-update
Automate the updating of your package.json packages with a grunt task
https://github.com/pgilad/grunt-dev-update
grunt-task javascript npm outdated-packages update
Last synced: about 2 months ago
JSON representation
Automate the updating of your package.json packages with a grunt task
- Host: GitHub
- URL: https://github.com/pgilad/grunt-dev-update
- Owner: pgilad
- License: mit
- Created: 2013-11-08T20:21:32.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2020-02-28T20:50:12.000Z (almost 5 years ago)
- Last Synced: 2024-10-24T12:27:17.006Z (2 months ago)
- Topics: grunt-task, javascript, npm, outdated-packages, update
- Language: JavaScript
- Homepage:
- Size: 108 KB
- Stars: 29
- Watchers: 4
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [grunt](http://gruntjs.com/)-dev-update
> Update your devDependencies and dependencies automatically with a grunt task
[](https://npmjs.org/package/grunt-dev-update)
[](https://npmjs.org/package/grunt-dev-update)
[](http://gruntjs.com/)
## Getting Started
This plugin requires Grunt.
If you haven't used [Grunt](http://gruntjs.com/) before,
be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide,
as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins.
Once you're familiar with that process, you may install this plugin with this command:
```bash
npm install --save-dev grunt-dev-update
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-dev-update');
```
The best way to load tasks is probably using [load-grunt-tasks](https://github.com/sindresorhus/load-grunt-tasks)
```bash
npm install --save-dev load-grunt-tasks
```
And then add to your gruntfile.js:
```js
require('load-grunt-tasks')(grunt);
```
## The "devUpdate" task
#### This plugin allows you to both update your dependencies and devDependencies with an automated task.
1. See outdated packages
2. Choose whether to just get notified, update them with a prompt, or automatically update them.
3. Determine whether to stay with semver rules when updating, or to update to latest version.
4. Update either or both your devDependencies and dependencies
*Q: Why not use `npm update` or `npm install`?*
**A: First, npm update doesn't work on dev dependencies. Second, npm update stays inside your semver matching in your package.json,
thirdly - npm isn't automated like your grunt tasks.**
### Overview
In your project's Gruntfile, add a task config named `devUpdate` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
devUpdate: {
main: {
options: {
//task options go here
}
}
}
})
```
### Options
#### options.reportUpdated
Type: `Boolean`
Default value: `false`
Whether to report an already updated package
#### options.updateType
Type: `String`
Default value: `report`
How devUpdate should handle the outdated packages. Valid options:
* `report` - Just report that the package is outdated.
* `prompt` - Prompt user to confirm update of every package
* `force` - Automatically force the update for the outdated packages.
* `fail` - Fail task if an outdated package was found.
#### options.packages
Type: `Object`
Default value: `{devDependencies: true}`
What kind of packages should be checked. Valid options:
* `dependencies` - Specify true to check **production dependencies**.
> Outdated **dependencies** are installed using the `--save` option.
* `devDependencies` - Specify true to check **development dependencies**. This is **true** by default.
> Outdated **devDependencies** are installed using the `--save-dev` option.
#### options.semver
Type: `Boolean`
Default value: `true`
`true` - Packages will be updated with `npm update` and will be installed up to your allowed version in
your `package.json`. Your allowed version is determined using [semver](http://semver.org).
`false` - Packages will be updated to the latest version there is, regardless of your `package.json` specifications.
**Warning** - this could break packages and only use this option if you're sure of what you're doing.
#### options.packageJson
Type: `null|Object|String`
Default value: `null`
This option allow you to manually configure the path of your **package.json**. Valid options:
* `null` - This will use `matchdep` own logic for finding your package.json (using `findup` to find
nearest package.json). This is the recommended and default option.
* `String` - specify a relative path from your **process.cwd()** to find your package.json.
* `Object` - pass in an object representing your package.json
For better understanding the `String` and `Object` option, please see [matchdep config](https://github.com/tkellen/node-matchdep#config).
#### options.reportOnlyPkgs
Type: `Array`
Default value: `[]`
Specify packages that will be checked for newer version but only reported if outdated.
This is useful if you are aware of packages that will be outdated, but don't want to update them.
### Usage Examples
#### Default Options
Example usage with all options specified with defaults:
```js
grunt.initConfig({
devUpdate: {
main: {
options: {
updateType: 'report', //just report outdated packages
reportUpdated: false, //don't report up-to-date packages
semver: true, //stay within semver when updating
packages: {
devDependencies: true, //only check for devDependencies
dependencies: false
},
packageJson: null, //use matchdep default findup to locate package.json
reportOnlyPkgs: [] //use updateType action on all packages
}
}
}
})
```
## 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](http://gruntjs.com/).
## License
MIT © [Gilad Peleg](https://www.giladpeleg.com)