2014-01-21 00:00:52 +00:00
/ * !
* Bootstrap ' s Gruntfile
* http : //getbootstrap.com
2016-05-20 16:04:31 +00:00
* Copyright 2013 - 2016 The Bootstrap Authors
2016-01-01 20:31:38 +00:00
* Copyright 2013 - 2016 Twitter , Inc .
2014-01-21 00:00:52 +00:00
* Licensed under MIT ( https : //github.com/twbs/bootstrap/blob/master/LICENSE)
* /
2013-08-03 23:03:38 +00:00
2013-12-07 00:51:59 +00:00
module . exports = function ( grunt ) {
2013-09-18 16:50:02 +00:00
'use strict' ;
2013-08-03 23:03:38 +00:00
2013-12-03 11:07:57 +00:00
// Force use of Unix newlines
grunt . util . linefeed = '\n' ;
2013-12-08 10:24:47 +00:00
RegExp . quote = function ( string ) {
2014-01-17 19:51:53 +00:00
return string . replace ( /[-\\^$*+?.()|[\]{}]/g , '\\$&' ) ;
} ;
2013-12-28 22:33:32 +00:00
2014-01-17 19:51:53 +00:00
var fs = require ( 'fs' ) ;
2014-01-19 14:04:29 +00:00
var path = require ( 'path' ) ;
2015-09-25 22:32:42 +00:00
var isTravis = require ( 'is-travis' ) ;
2014-12-10 21:51:43 +00:00
2014-11-03 15:19:40 +00:00
var configBridge = grunt . file . readJSON ( './grunt/configBridge.json' , { encoding : 'utf8' } ) ;
Object . keys ( configBridge . paths ) . forEach ( function ( key ) {
configBridge . paths [ key ] . forEach ( function ( val , i , arr ) {
arr [ i ] = path . join ( './docs/assets' , val ) ;
} ) ;
} ) ;
2013-12-28 22:33:32 +00:00
2013-08-03 23:03:38 +00:00
// Project configuration.
grunt . initConfig ( {
// Metadata.
pkg : grunt . file . readJSON ( 'package.json' ) ,
2013-09-11 02:21:44 +00:00
banner : '/*!\n' +
2014-01-28 11:16:13 +00:00
' * Bootstrap v<%= pkg.version %> (<%= pkg.homepage %>)\n' +
' * Copyright 2011-<%= grunt.template.today("yyyy") %> <%= pkg.author %>\n' +
2015-08-10 06:16:43 +00:00
' * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)\n' +
2014-01-28 11:16:13 +00:00
' */\n' ,
2014-12-17 04:17:54 +00:00
jqueryCheck : 'if (typeof jQuery === \'undefined\') {\n' +
' throw new Error(\'Bootstrap\\\'s JavaScript requires jQuery\')\n' +
'}\n' ,
jqueryVersionCheck : '+function ($) {\n' +
' var version = $.fn.jquery.split(\' \')[0].split(\'.\')\n' +
2015-11-16 07:28:11 +00:00
' if ((version[0] < 2 && version[1] < 9) || (version[0] == 1 && version[1] == 9 && version[2] < 1) || (version[0] >= 3)) {\n' +
' throw new Error(\'Bootstrap\\\'s JavaScript requires at least jQuery v1.9.1 but less than v3.0.0\')\n' +
2014-12-17 04:17:54 +00:00
' }\n' +
'}(jQuery);\n\n' ,
2013-08-03 23:03:38 +00:00
// Task configuration.
clean : {
2014-08-14 00:47:16 +00:00
dist : 'dist' ,
docs : 'docs/dist'
2013-08-03 23:03:38 +00:00
} ,
2015-05-12 23:52:54 +00:00
// JS build configuration
2015-05-07 19:48:22 +00:00
babel : {
2015-05-13 19:48:34 +00:00
dev : {
2015-05-12 23:52:54 +00:00
options : {
sourceMap : true ,
modules : 'ignore'
2014-02-07 12:34:17 +00:00
} ,
2015-05-07 19:48:22 +00:00
files : {
2015-05-11 19:05:35 +00:00
'js/dist/util.js' : 'js/src/util.js' ,
'js/dist/alert.js' : 'js/src/alert.js' ,
'js/dist/button.js' : 'js/src/button.js' ,
'js/dist/carousel.js' : 'js/src/carousel.js' ,
'js/dist/collapse.js' : 'js/src/collapse.js' ,
'js/dist/dropdown.js' : 'js/src/dropdown.js' ,
'js/dist/modal.js' : 'js/src/modal.js' ,
2015-05-11 19:29:06 +00:00
'js/dist/scrollspy.js' : 'js/src/scrollspy.js' ,
2015-05-12 06:32:37 +00:00
'js/dist/tab.js' : 'js/src/tab.js' ,
2015-05-12 21:28:11 +00:00
'js/dist/tooltip.js' : 'js/src/tooltip.js' ,
'js/dist/popover.js' : 'js/src/popover.js'
2015-05-07 19:48:22 +00:00
}
2013-08-03 23:03:38 +00:00
} ,
2015-05-12 23:52:54 +00:00
dist : {
2014-03-17 07:07:21 +00:00
options : {
2015-05-12 23:52:54 +00:00
modules : 'ignore'
2014-03-17 07:07:21 +00:00
} ,
2015-05-12 23:52:54 +00:00
files : {
'<%= concat.bootstrap.dest %>' : '<%= concat.bootstrap.dest %>'
}
2013-08-03 23:03:38 +00:00
}
} ,
2013-08-08 06:06:29 +00:00
2015-05-12 23:52:54 +00:00
stamp : {
2013-08-03 23:03:38 +00:00
options : {
2015-05-12 23:52:54 +00:00
banner : '<%= banner %>\n<%= jqueryCheck %>\n<%= jqueryVersionCheck %>\n+function ($) {\n' ,
footer : '\n}(jQuery);'
2013-08-03 23:03:38 +00:00
} ,
bootstrap : {
2015-05-12 23:52:54 +00:00
files : {
src : '<%= concat.bootstrap.dest %>'
}
2013-08-03 23:03:38 +00:00
}
} ,
2013-08-08 06:06:29 +00:00
2013-08-03 23:03:38 +00:00
concat : {
2014-06-15 14:41:24 +00:00
options : {
2016-04-02 07:03:04 +00:00
// Custom function to remove all export and import statements
process : function ( src ) {
return src . replace ( /^(export|import).*/gm , '' ) ;
} ,
2013-08-03 23:03:38 +00:00
stripBanners : false
2014-06-15 14:41:24 +00:00
} ,
2013-08-03 23:03:38 +00:00
bootstrap : {
2015-01-03 21:58:44 +00:00
src : [
2015-05-12 23:52:54 +00:00
'js/src/util.js' ,
'js/src/alert.js' ,
'js/src/button.js' ,
'js/src/carousel.js' ,
'js/src/collapse.js' ,
'js/src/dropdown.js' ,
'js/src/modal.js' ,
'js/src/scrollspy.js' ,
'js/src/tab.js' ,
'js/src/tooltip.js' ,
'js/src/popover.js'
2015-01-03 21:58:44 +00:00
] ,
2013-08-03 23:03:38 +00:00
dest : 'dist/js/<%= pkg.name %>.js'
2015-01-03 21:58:44 +00:00
}
} ,
uglify : {
options : {
2015-05-06 20:34:14 +00:00
compress : {
warnings : false
2015-01-03 21:58:44 +00:00
} ,
2015-05-06 20:34:14 +00:00
mangle : true ,
2015-11-16 07:32:59 +00:00
preserveComments : /^!|@preserve|@license|@cc_on/i
2013-09-19 14:41:14 +00:00
} ,
2015-05-06 20:34:14 +00:00
core : {
src : '<%= concat.bootstrap.dest %>' ,
2013-08-03 23:03:38 +00:00
dest : 'dist/js/<%= pkg.name %>.min.js'
2015-05-06 20:34:14 +00:00
} ,
2013-12-10 22:29:42 +00:00
docsJs : {
2014-11-03 15:19:40 +00:00
src : configBridge . paths . docsJs ,
2013-12-10 22:29:42 +00:00
dest : 'docs/assets/js/docs.min.js'
2013-08-03 23:03:38 +00:00
}
} ,
2014-03-09 23:09:36 +00:00
qunit : {
options : {
inject : 'js/tests/unit/phantom.js'
} ,
files : 'js/tests/index.html'
} ,
2015-05-12 23:52:54 +00:00
// CSS build configuration
2014-12-09 03:02:25 +00:00
scsslint : {
options : {
2015-09-06 09:16:01 +00:00
bundleExec : true ,
2015-09-29 22:48:56 +00:00
config : 'scss/.scss-lint.yml' ,
2015-06-19 07:14:52 +00:00
reporterOutput : null
} ,
2016-01-04 02:09:09 +00:00
core : {
src : [ 'scss/*.scss' , '!scss/_normalize.scss' ]
} ,
docs : {
2016-02-09 21:34:47 +00:00
src : [ 'docs/assets/scss/*.scss' , '!docs/assets/scss/docs.scss' ]
2016-01-04 02:09:09 +00:00
}
2014-12-09 03:02:25 +00:00
} ,
2013-12-22 07:25:18 +00:00
cssmin : {
2014-03-11 17:48:14 +00:00
options : {
2015-03-09 04:31:58 +00:00
// TODO: disable `zeroUnits` optimization once clean-css 3.2 is released
// and then simplify the fix for https://github.com/twbs/bootstrap/issues/14837 accordingly
2015-08-25 12:37:19 +00:00
compatibility : 'ie9' ,
2014-06-24 22:53:10 +00:00
keepSpecialComments : '*' ,
2015-06-05 01:05:59 +00:00
sourceMap : true ,
2015-12-08 05:51:04 +00:00
advanced : false
2014-03-11 17:48:14 +00:00
} ,
2014-12-01 04:29:47 +00:00
core : {
2015-06-18 17:19:50 +00:00
files : [
{
expand : true ,
cwd : 'dist/css' ,
src : [ '*.css' , '!*.min.css' ] ,
dest : 'dist/css' ,
ext : '.min.css'
}
]
2014-05-19 07:07:31 +00:00
} ,
2014-03-11 17:48:14 +00:00
docs : {
2014-12-01 04:29:47 +00:00
src : 'docs/assets/css/docs.min.css' ,
2014-01-29 19:50:10 +00:00
dest : 'docs/assets/css/docs.min.css'
2013-12-22 07:25:18 +00:00
}
} ,
2013-08-18 07:36:51 +00:00
copy : {
2013-12-31 19:38:32 +00:00
docs : {
2015-02-20 09:22:06 +00:00
expand : true ,
cwd : 'dist/' ,
src : [
'**/*'
] ,
dest : 'docs/dist/'
2013-08-18 07:36:51 +00:00
}
} ,
2013-08-03 23:03:38 +00:00
connect : {
server : {
options : {
port : 3000 ,
base : '.'
2013-05-04 14:55:52 +00:00
}
2013-08-03 23:03:38 +00:00
}
} ,
2013-08-12 22:01:06 +00:00
jekyll : {
2014-11-14 13:00:02 +00:00
options : {
2015-08-25 05:43:47 +00:00
bundleExec : true ,
2015-10-28 05:20:47 +00:00
config : '_config.yml' ,
incremental : false
2014-11-14 13:00:02 +00:00
} ,
docs : { } ,
github : {
options : {
raw : 'github: true'
}
}
2013-08-12 22:01:06 +00:00
} ,
2015-01-19 23:08:34 +00:00
htmllint : {
2013-08-12 22:01:06 +00:00
options : {
2015-01-19 23:08:34 +00:00
ignore : [
'Element “img” is missing required attribute “src”.' ,
2015-08-26 15:15:47 +00:00
'Attribute “autocomplete” is only allowed when the input type is “color”, “date”, “datetime”, “datetime-local”, “email”, “month”, “number”, “password”, “range”, “search”, “tel”, “text”, “time”, “url”, or “week”.' ,
2015-01-19 23:08:34 +00:00
'Attribute “autocomplete” not allowed on element “button” at this point.' ,
'Element “div” not allowed as child of element “progress” in this context. (Suppressing further errors from this subtree.)' ,
2015-05-27 22:49:55 +00:00
'Consider using the “h1” element as a top-level heading only (all “h1” elements are treated as top-level headings by many screen readers and other tools).' ,
2016-01-11 07:53:17 +00:00
'The “datetime” input type is not supported in all browsers. Please be sure to test, and consider using a polyfill.' ,
2016-01-06 23:52:12 +00:00
'The “color” input type is not supported in all browsers. Please be sure to test, and consider using a polyfill.' ,
'The “date” input type is not supported in all browsers. Please be sure to test, and consider using a polyfill.' ,
'The “datetime-local” input type is not supported in all browsers. Please be sure to test, and consider using a polyfill.' ,
'The “month” input type is not supported in all browsers. Please be sure to test, and consider using a polyfill.' ,
'The “time” input type is not supported in all browsers. Please be sure to test, and consider using a polyfill.' ,
2016-01-26 12:55:26 +00:00
'The “week” input type is not supported in all browsers. Please be sure to test, and consider using a polyfill.'
2013-10-24 06:25:17 +00:00
]
2013-08-12 22:01:06 +00:00
} ,
2015-11-19 09:49:12 +00:00
src : [ '_gh_pages/**/*.html' , 'js/tests/visual/*.html' ]
2013-08-12 22:01:06 +00:00
} ,
2013-08-03 23:03:38 +00:00
watch : {
src : {
2016-06-05 00:46:36 +00:00
files : '<%= concat.bootstrap.src %>' ,
2015-05-13 19:48:34 +00:00
tasks : [ 'babel:dev' ]
2013-08-03 23:03:38 +00:00
} ,
2015-01-09 10:26:16 +00:00
sass : {
files : 'scss/**/*.scss' ,
2015-08-13 03:14:14 +00:00
tasks : [ 'dist-css' , 'docs' ]
2015-08-15 05:45:55 +00:00
} ,
docs : {
files : 'docs/assets/scss/**/*.scss' ,
tasks : [ 'dist-css' , 'docs' ]
2013-08-03 23:03:38 +00:00
}
2013-11-02 01:15:25 +00:00
} ,
2013-12-04 02:42:31 +00:00
'saucelabs-qunit' : {
all : {
options : {
build : process . env . TRAVIS _JOB _ID ,
2014-01-15 23:55:47 +00:00
concurrency : 10 ,
2014-06-24 19:12:21 +00:00
maxRetries : 3 ,
2015-01-05 20:40:43 +00:00
maxPollRetries : 4 ,
2015-03-01 08:20:00 +00:00
urls : [ 'http://127.0.0.1:3000/js/tests/index.html?hidepassed' ] ,
2014-03-17 03:30:04 +00:00
browsers : grunt . file . readYAML ( 'grunt/sauce_browsers.yml' )
2013-12-04 02:42:31 +00:00
}
}
2014-01-20 21:06:13 +00:00
} ,
exec : {
2016-06-20 23:18:21 +00:00
postcss : {
command : 'npm run postcss'
} ,
'postcss-docs' : {
command : 'npm run postcss-docs'
}
2015-08-19 05:47:26 +00:00
} ,
buildcontrol : {
options : {
dir : '_gh_pages' ,
commit : true ,
push : true ,
message : 'Built %sourceName% from commit %sourceCommit% on branch %sourceBranch%'
} ,
pages : {
options : {
remote : 'git@github.com:twbs/derpstrap.git' ,
branch : 'gh-pages'
}
}
2015-11-16 16:05:29 +00:00
} ,
compress : {
main : {
options : {
archive : 'bootstrap-<%= pkg.version %>-dist.zip' ,
mode : 'zip' ,
level : 9 ,
pretty : true
} ,
files : [
{
expand : true ,
cwd : 'dist/' ,
src : [ '**' ] ,
dest : 'bootstrap-<%= pkg.version %>-dist'
}
]
}
2013-08-03 23:03:38 +00:00
}
2015-11-16 16:05:29 +00:00
2013-08-03 23:03:38 +00:00
} ) ;
2013-05-04 14:55:52 +00:00
2013-08-03 23:03:38 +00:00
// These plugins provide necessary tasks.
2014-12-15 18:18:27 +00:00
require ( 'load-grunt-tasks' ) ( grunt , { scope : 'devDependencies' ,
// Exclude Sass compilers. We choose the one to load later on.
pattern : [ 'grunt-*' , '!grunt-sass' , '!grunt-contrib-sass' ] } ) ;
2014-03-07 06:46:15 +00:00
require ( 'time-grunt' ) ( grunt ) ;
2013-05-04 14:55:52 +00:00
2013-08-12 22:01:06 +00:00
// Docs HTML validation task
2015-08-25 05:43:47 +00:00
grunt . registerTask ( 'validate-html' , [ 'jekyll:docs' , 'htmllint' ] ) ;
2013-08-12 22:01:06 +00:00
2014-05-18 22:52:42 +00:00
var runSubset = function ( subset ) {
return ! process . env . TWBS _TEST || process . env . TWBS _TEST === subset ;
} ;
2014-05-18 22:53:40 +00:00
var isUndefOrNonZero = function ( val ) {
return val === undefined || val !== '0' ;
} ;
2014-05-18 22:52:42 +00:00
2013-08-03 23:03:38 +00:00
// Test task.
2013-12-15 03:09:44 +00:00
var testSubtasks = [ ] ;
// Skip core tests if running a different subset of the test suite
2014-11-19 23:43:23 +00:00
if ( runSubset ( 'core' ) &&
2014-12-01 04:29:47 +00:00
// Skip core tests if this is a Savage build
2014-12-15 18:18:27 +00:00
process . env . TRAVIS _REPO _SLUG !== 'twbs-savage/bootstrap' ) {
2016-06-05 00:46:36 +00:00
testSubtasks = testSubtasks . concat ( [ 'dist-css' , 'dist-js' , 'test-scss' , 'qunit' , 'docs' ] ) ;
2013-12-15 03:09:44 +00:00
}
// Skip HTML validation if running a different subset of the test suite
2014-05-18 22:53:40 +00:00
if ( runSubset ( 'validate-html' ) &&
2015-09-25 22:32:42 +00:00
isTravis &&
// Skip HTML5 validator when [skip validator] is in the commit message
2014-05-18 22:53:40 +00:00
isUndefOrNonZero ( process . env . TWBS _DO _VALIDATOR ) ) {
2013-12-15 03:09:44 +00:00
testSubtasks . push ( 'validate-html' ) ;
}
2013-12-04 02:42:31 +00:00
// Only run Sauce Labs tests if there's a Sauce access key
2014-01-17 19:51:53 +00:00
if ( typeof process . env . SAUCE _ACCESS _KEY !== 'undefined' &&
2013-12-15 03:09:44 +00:00
// Skip Sauce if running a different subset of the test suite
2014-05-18 22:53:40 +00:00
runSubset ( 'sauce-js-unit' ) &&
// Skip Sauce on Travis when [skip sauce] is in the commit message
isUndefOrNonZero ( process . env . TWBS _DO _SAUCE ) ) {
2015-08-26 07:55:24 +00:00
testSubtasks . push ( 'babel:dev' ) ;
2013-12-04 02:42:31 +00:00
testSubtasks . push ( 'connect' ) ;
testSubtasks . push ( 'saucelabs-qunit' ) ;
2013-08-06 07:39:35 +00:00
}
grunt . registerTask ( 'test' , testSubtasks ) ;
2013-05-04 14:55:52 +00:00
2013-08-03 23:03:38 +00:00
// JS distribution task.
2016-06-10 16:28:03 +00:00
grunt . registerTask ( 'dist-js' , [ 'babel:dev' , 'concat' , 'babel:dist' , 'stamp' , 'uglify:core' ] ) ;
2013-05-04 14:55:52 +00:00
2016-01-04 02:09:09 +00:00
grunt . registerTask ( 'test-scss' , [ 'scsslint:core' ] ) ;
2014-12-09 03:02:25 +00:00
2013-08-03 23:03:38 +00:00
// CSS distribution task.
2014-12-15 18:18:27 +00:00
// Supported Compilers: sass (Ruby) and libsass.
( function ( sassCompilerName ) {
require ( './grunt/bs-sass-compile/' + sassCompilerName + '.js' ) ( grunt ) ;
} ) ( process . env . TWBS _SASS || 'libsass' ) ;
2015-08-10 04:45:08 +00:00
// grunt.registerTask('sass-compile', ['sass:core', 'sass:extras', 'sass:docs']);
grunt . registerTask ( 'sass-compile' , [ 'sass:core' , 'sass:docs' ] ) ;
2014-12-15 18:18:27 +00:00
2016-06-20 23:18:21 +00:00
grunt . registerTask ( 'dist-css' , [ 'sass-compile' , 'exec:postcss' , 'cssmin:core' , 'cssmin:docs' ] ) ;
2013-08-18 07:36:51 +00:00
2013-08-03 23:03:38 +00:00
// Full distribution task.
2014-12-01 04:29:47 +00:00
grunt . registerTask ( 'dist' , [ 'clean:dist' , 'dist-css' , 'dist-js' ] ) ;
2013-05-04 14:55:52 +00:00
2013-08-03 23:03:38 +00:00
// Default task.
2014-12-01 04:29:47 +00:00
grunt . registerTask ( 'default' , [ 'clean:dist' , 'test' ] ) ;
2013-08-08 06:06:29 +00:00
2014-08-14 00:47:16 +00:00
// Docs task.
2016-06-20 23:18:21 +00:00
grunt . registerTask ( 'docs-css' , [ 'cssmin:docs' , 'exec:postcss-docs' ] ) ;
2016-01-04 08:22:03 +00:00
grunt . registerTask ( 'lint-docs-css' , [ 'scsslint:docs' ] ) ;
2014-12-10 21:51:43 +00:00
grunt . registerTask ( 'docs-js' , [ 'uglify:docsJs' ] ) ;
2016-06-05 00:46:36 +00:00
grunt . registerTask ( 'docs' , [ 'lint-docs-css' , 'docs-css' , 'docs-js' , 'clean:docs' , 'copy:docs' ] ) ;
2015-12-09 02:25:11 +00:00
grunt . registerTask ( 'docs-github' , [ 'jekyll:github' ] ) ;
2014-08-14 00:47:16 +00:00
2015-12-06 20:11:10 +00:00
grunt . registerTask ( 'prep-release' , [ 'dist' , 'docs' , 'docs-github' , 'compress' ] ) ;
2014-11-14 13:00:02 +00:00
2015-08-19 05:49:26 +00:00
// Publish to GitHub
grunt . registerTask ( 'publish' , [ 'buildcontrol:pages' ] ) ;
2013-09-18 06:04:09 +00:00
} ;