Giter VIP home page Giter VIP logo

grunt-jade-usemin's Introduction

grunt-jade-usemin Built with Grunt

Grunt plugin for running UseMin on Jade files

Getting Started

This plugin requires Grunt.

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-jade-usemin --save-dev

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

grunt.loadNpmTasks('grunt-jade-usemin');

The "jadeUsemin" task

This project is based on the grunt-usemin Project. grunt-jade-usemin is meant to be an assisting tool in preparing projects for build. The plugin will scan the parsed .jade files and extract the scripts from them.

Those scripts are then concated and minified into a single minified file. jadeUsemin currently supports 2 types of sources to concat & minify: js and css.

How to use in a Jade file

This is most effectively used in conjunction with the environment variable in express i.e process.env or node env.

jadeUsemin simply scans for the following line: <!-- build:<type> <target -->. Where <target> can be either js or css.

jadeUsemin then adds the scripts/styles inside the lines until it meets the closing line: <!-- endbuild --> Which signifies the end of a usemin target.

for the following to work, you need to expose your env variable when rendering the jade file.

This is an example index.jade:

if env === 'development'
    //-<!-- build:js test/compiled/compiled.min.js -->
    script(src='/test/fixtures/script1.js')
    script(src='/test/fixtures/script2.js')
    //-<!-- endbuild -->
else
    script(src='/test/compiled/compiled.min.js')

Running jadeUsemin on this file will concat & uglify the script files script1.js and script2.js into a minified file compiled.min.js.

Another example is using jadeUsemin with css files:

//-<!-- build:css test/compiled/style.min.css -->
link(rel='stylesheet', href='/test/fixtures/style1.css')
link(rel='stylesheet', href='/test/fixtures/style2.css')
//-<!-- endbuild -->

jadeUsemin will create a minified css file called style.min.css which is a concated and minified version of both styles.

Gruntfile.js basic task

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

grunt.initConfig({
  jadeUsemin: {
    main: {
      options: {},
      files: {
        src: ['src/index.jade', 'src/index2.jade']
      }
    }
  },
})

Options

None yet

Usage Examples

Default Options

grunt.initConfig({
  jadeUsemin: {
    main: {
      options: {},
      files: {
        src: ['src/testing', 'src/123'],
      }
    }
  },
})

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

Copyright (c) 2013 Gilad Peleg. Licensed under the MIT license.

grunt-jade-usemin's People

Contributors

pgilad 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.