Giter Club home page Giter Club logo

grunt-version-compile's Introduction

grunt-version-compile

NPM

Browserify centric plugin that allows multiple builds, rename files with known extensions in order to provide alternative versions of apps and components

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-version-compile --save-dev

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

grunt.loadNpmTasks('grunt-version-compile');

The "compileVersion" task

Overview

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

grunt.initConfig({
  compileVersion: {
    versions: [''],
    root: '',
    task: ''
  },
});

Options

options.versions

Type: Array of strings

An array of version names to use. These must match the filenames you want to scan for. So 'alt' will search for .alt.js or .alt.css files

options.root

Type: String Default value: '.'

So you can reduce the amount of scanning you do and restrict the search to a specific directory

options.task

Type: String

What task to run for each language. The language will be appended to the task, so if your task is build and your versions contains alt the task build:alt will be run, as well as just 'build'.

Usage Examples

This will:

  1. Run the build task
  2. Rename all .alt.js files found recursively in the lib directory to .js, renaming the existing file to -old.js
  3. Run the build:alt task. This allows you to have multiple outputs
  4. Rename all -old.js files back to their original name, and rename the .js files back to .alt.js
grunt.initConfig({
  compileVersion: {
      versions: ['alt'],
      root: 'lib',
      task: 'build'
    },
});

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 Initial release 0.1.1 Added support for Grunt v1 0.1.2 Updated repo location 0.1.3 Updated NPM badge path

grunt-version-compile's People

Contributors

silasl avatar

Watchers

 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.