grunt-check-dependencies

Checks if currently installed npm dependencies are installed in the exact same versions that are specified in package.json.

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-check-dependencies --save-dev

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

grunt.loadNpmTasks('grunt-check-dependencies');

The "checkDependencies" task

Overview

The checkDependencies task checks if the package has all necessary dependencies installed in right versions. If that's not the case, the task fails and advises to run npm install.

If in case of a missing package you want to invoke the npm install command automatically, set the npmInstall option to true.

In your project's Gruntfile, add a section named checkDependencies to the data object passed into grunt.initConfig().

grunt.initConfig({
    checkDependencies: {
        options: {
            // Task-specific options go here.
        },
        your_target: {
            // Target-specific file lists and/or options go here.
        },
    },
})

Options

The checkDependencies task accepts a couple of options:

{
    // Path to a directory containing the package to test. By default the current app is tested.
    packageDir: string,

    // Tells the task which sections of the package.json file should be checked.
    // Default is `['peerDependencies', 'dependencies', 'devDependencies']`.
    scopeList: array,

    // If true, on error, instead of failing the task, `npm install` will be invoked for the user.
    // `false` by default.
    npmInstall: boolean,
}

Usage Examples

The most basic (and probably most common) use of the task requires just providing a target, i.e.:

{
    checkDependencies: {
        this: {},
    },
}

If you want to automatically install missing packages, here's what you want:

{
    checkDependencies: {
        this: {
            options: {
                npmInstall: true,
            },
        },
    },
}

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

(Nothing yet)

License

Copyright (c) 2013 Michał Gołębiowski. Licensed under the MIT license.