grunt-env-check

Automate environment checking on system

Getting Started

This plugin requires Grunt ~0.4.5

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

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

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

The "env" task

Overview

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

grunt.initConfig({
  env: {
    your_target: {
      options: {},
      environments: []
    }
  },
});

Options

options.ask

Type: Boolean Default value: false

A Boolean value to allow user to set environment variable before proceed to start the application

Usage Examples

If you set options.ask to true, it will prompt user to set it if they do not have it on their working environment before proceed. In this example, grunt-env-check will prompt user to set the environment

grunt.initConfig({
  env: {
    dev: {
      options: {
        ask: true
      }, {
        environments: ['NODE_ENV']
      }
    }
  },
});

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

MIT © Yu Jin Lim