Giter VIP home page Giter VIP logo

onlywhen's Introduction

grunt-onlywhen

Only CODE_SNIPPET when BUILD_TYPE

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

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

grunt.loadNpmTasks('grunt-onlywhen');

The "onlywhen" task

Overview

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

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

Options

options.build_type

Type: String Default value: grunt sub-task

The build type that should be used to determine which code snippets are shown

Usage Examples

Custom Options

This is the most basic example of a page being built for two configurations (develop and dist).

index.html

<!-- onlywhen:develop -->
<p class="banner">This only shows up during development</p>
<!-- /onlywhen -->
<p>... just some regular html ...</p>

Gruntfile.js

grunt.initConfig({
	onlywhen: {
		develop: {
			files: {
				'tmp/index.html': ['index.html']
			}
		},
		dist: {
			files: {
				'tmp/index.html': ['index.html']
			}		
		}
	}
});

Running grunt onlywhen:develop will render an html page in the tmp directory including a banner, but grunt onlywhen:dist will strip out then banner.

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

0.1.0 first release

onlywhen's People

Contributors

billymoon avatar

Stargazers

Kevin Sheedy avatar

Watchers

Kevin Sheedy avatar James Cloos avatar  avatar

Forkers

gruntjs-updater

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.