juliangut / grunt-climb

Grunt plugin for running climb

climb Grunt plugin

Grunt plugin for running 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

Getting Started

This plugin requires Grunt >=0.4.0

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-climb --save-dev

Make sure you have climb installed

composer require vinkla/climb

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

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().

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

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. Have a look at existing issues before.

See file CONTRIBUTING.md

License

See file LICENSE included with the source code for a copy of the license terms.