Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/juliangut/grunt-climb
Grunt plugin for running climb
https://github.com/juliangut/grunt-climb
Last synced: 23 days ago
JSON representation
Grunt plugin for running climb
- Host: GitHub
- URL: https://github.com/juliangut/grunt-climb
- Owner: juliangut
- License: bsd-3-clause
- Created: 2015-11-22T16:27:40.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-20T17:40:00.000Z (over 8 years ago)
- Last Synced: 2024-10-05T17:17:47.364Z (about 1 month ago)
- Language: JavaScript
- Size: 16.6 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://npmjs.org/package/grunt-climb)
[](https://github.com/juliangut/grunt-climb/blob/master/LICENSE)
[](https://npmjs.org/package/grunt-climb)
[](https://npmjs.org/package/grunt-climb)
# climb Grunt plugin
Grunt plugin for running [climb](https://github.com/vinkla/climb)
> This plugin requires vinkla/climb:~0.8
Be aware that vinkla/climb has been discontinued due to `outdated` discovery capability has been added directly to [Composer](https://getcomposer.org/doc/03-cli.md#outdated)
## Getting Started
This plugin requires Grunt `>=0.4.0`
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:
```shell
npm install grunt-climb --save-dev
```
Make sure you have climb installed
```shell
composer require vinkla/climb
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-climb');
```
## The "climb" task
### Overview
In your project's Gruntfile, add a section named `climb` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
climb: {
options: {
// Task-specific options go here.
},
your_target: {
options: {
// Target-specific options go here.
}
},
},
});
```
### Options
#### options.bin
Type: `String`
Default value: `'climb'`
Climb executable binary.
In case you do not provide climb binary path you need to have it on PATH environment variable otherwise plugin will raise an error
#### options.output
Type: `String`
Default value: `undefined`
Output path to save climb report.
Output file name will be climb-output
#### options.exclude
Type: `Array`
Default value: `undefined`
List of packages to be excluded from the check.
#### options.onlyOutdated
Type: `Boolean`
Default value: `false`
Only check outdated dependencies.
#### options.onlyUpgradable
Type: `Boolean`
Default value: `false`
Only check upgradable dependencies.
#### directory
Type: `String`
Default value: `undefined`
Path to directory containing composer files (composer.json and composer.lock).
### Usage Example
```js
grunt.initConfig({
climb: {
command: {
options: {
bin: 'vendor/bin/climb',
exclude: [
'vinkla/climb'
],
onlyOutdated: true,
output: 'path/to/output'
},
directory: 'path/to/composer/files'
}
},
});
```
## Contributing
Found a bug or have a feature request? [Please open a new issue](https://github.com/juliangut/grunt-climb/issues). Have a look at existing issues before.
See file [CONTRIBUTING.md](https://github.com/juliangut/grunt-climb/blob/master/CONTRIBUTING.md)
## License
See file [LICENSE](https://github.com/juliangut/grunt-climb/blob/master/LICENSE) included with the source code for a copy of the license terms.