Code Monkey home page Code Monkey logo

grunt-modernizr's Introduction

grunt-modernizr

Build Status

tl;dr: grunt-modernizr sifts through your project files, gathers up your references to Modernizr tests and outputs a lean, mean Modernizr machine.

grunt-modernizr is a Modernizr builder for your project. It is based on the Modernizr team's Modulizr tool.

This highly configurable task allows you to configure and export a custom Modernizr build. Use Modernizr's annotated source for development, and let this tool worry about optimization.

When you're ready to build, grunt-modernizr will crawl your project for Modernizr test references and save out a minified, uglified, customized version using only the tests you've used in your JavaScript or (S)CSS.

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-modernizr

Then add this line to your project's grunt.js gruntfile:

grunt.loadNpmTasks("grunt-modernizr");

Documentation

Command Line

Run the task with grunt modernizr.

Cache Busting

Bust the cache of locally downloaded files by running grunt modernizr:bust

Config Options

Add a modernizr config object to your grunt.js file:

modernizr: {

	// Based on default settings on http://modernizr.com/download/
	"extra" : {
		"shiv" : true,
		"printshiv" : false,
		"load" : true,
		"mq" : false,
		"cssclasses" : true
	},

	// Based on default settings on http://modernizr.com/download/
	"extensibility" : {
		"addtest" : false,
		"prefixed" : false,
		"teststyles" : false,
		"testprops" : false,
		"testallprops" : false,
		"hasevents" : false,
		"prefixes" : false,
		"domprefixes" : false
	},

	// By default, source is uglified before saving
	"uglify" : true,

	// Define any tests you want to impliticly include.
	"tests" : [],

	// By default, this task will crawl your project for references to Modernizr tests.
	// Set to false to disable.
	"parseFiles" : true,

	// When parseFiles = true, this task will crawl all *.js, *.css, *.scss files, except files
	// that are in node_modules/. You can override this by defining a "files" array below.
	"files" : {

		// [REQUIRED] Path to the build you're using for development.
		dev: "!lib/modernizr-dev.js", // development file

		// source files to include/exclude (defaults below)
		src: [
			"**/*.{js,css,scss}",
			"!node_modules/**/*",
			"!lib/cache/**/*"
		],

		// [REQUIRED] Path to save out the built file
		dest: 'build/modernizr-custom.js'

	},

	// When parseFiles = true, matchCommunityTests = true will attempt to
	// match user-contributed tests.
	"matchCommunityTests" : false,

	// Have custom Modernizr tests? Add paths to their location here.
	"customTests" : []
}

Required

files.dev (String)

Path to the local build file you're using for development. This parameter is needed so grunt-modernizr can skip your dev file when traversing your project to avoid triggering false positives. If you're using a remote file for development, set this option to remote.

Optional

files.dest (String)

Path to save the customized Modernizr build. It defaults to lib/modernizr-custom.js.

extra (Object)

An object of extra configuration options. Check the extra section on modernizr.com/download for complete options. Defaults are as they appear on the official site.

extensibility (Object)

An object of extensibility options. Check the section on modernizr.com/download for complete options. Defaults are as they appear on the official site.

uglify (Boolean)

By default, the source is uglified before save. Set to false to disable.

tests (Array)

Define any tests you want to impliticly include. Test names are lowercased, separated by underscores (if needed). Check out the full set of test options here.

parseFiles (Boolean)

By default, this task will crawl your project for references to Modernizr tests. Set to false to disable.

files.src (Array)

When parseFiles = true, this task will crawl all *.js, *.css, *.scss files. You can override this by defining a custom files.src array. The object supports all minimatch options.

matchCommunityTests (Boolean)

When parseFiles = true, setting this boolean to true will attempt to match user-contributed tests. Check out the full set of community tests here

customTests (Array)

Have custom Modernizr tests? Add paths to their location here. The object supports all minimatch options.

excludeFiles (Array)

Files added here will be excluded when looking for Modernizr refs. The object supports all minimatch options.

License

Copyright (c) 2012 Richard Herrera Licensed under the MIT license.

grunt-modernizr's People

Contributors

adamcbrewer avatar doctyper avatar drublic avatar fhemberger avatar moox 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.