Code Monkey home page Code Monkey logo

grunt-environment's Introduction

Grunt: Environment

Add environment-centric logic to your Grunt builds

Build Status status Dependency Status devDependency Status Gittip

NPM

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

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

grunt.initConfig({
  // ...

  environment: {
    default: 'development',
    environments: ['development', 'production'],
    version: function(){
      return grunt.file.readJSON('package.json')['version']
    },
    file: 'build.json'
  }

  // ...
});

grunt.loadNpmTasks('grunt-environment');

Any of the above options can also be a function except for the environments array.

The grunt-environment plugin will add the tasks environment:development and environment:production (for each entry in your environments array).

They will maintain state in a file called .grunt/environment.json in your project directory.

You can now use grunt.config.get('environment.env') in your other Grunt tasks to create conditions around these environments.

v0.2.0 adds the alias grunt.environment() to the current env value.

The additional keys timestamp and version are included as well.

You may find it useful to pass build as a variable into a template for your application to use at runtime.

Release History

0.3.0

  • No longer necessary to try/catch initialize manually after tasks are loaded
  • Adds grunt environment (with no subtask) to echo current environment from file

0.2.1

  • Small fixes

0.2.0

  • Adds grunt.environment() alias
  • Bit of overall refactoring
  • Moves default storage from build.json to .grunt/environment.json
  • Adds configurable options default, environments, version, file

0.1.0

  • First release

Bitdeli Badge

xrefs funcs top func library users authors Total views Views in the last 24 hours

grunt-environment's People

Contributors

logankoester avatar bitdeli-chef avatar colwilson avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.