Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
74 lines (52 sloc) 1.71 KB

grunt-cortex-validate

Validate important properties of package.json

Getting Started

This plugin requires Grunt ~0.4.1

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-cortex-validate --save-dev

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

grunt.loadNpmTasks('grunt-cortex-validate');

The "cortex_validate" task

Overview

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

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

Options

options.pkg

Type: String

Default value: 'package.json'

The file path of the package.json to be checked

options.registry

Type: String

Default value: 'http://registry.npmjs.org'

Npm server location. It will be usefull if you use your self-built npm server.

options.exportFile

Type: String

Default value: undefined

"Cortex_validate" will save the current exact version of each dependency to options.exportFile

Usage Examples

grunt.initConfig({
  cortex_validate: {
    options: {
      pkg: 'package.json',
      registry: 'http://registry.yourdomain.com',
      exportFile: 'exactDependencies.json'
    }
  },
})