2015-04-16 12:30:59 +02:00
/ * !
* Bootstrap ' s Gruntfile
* http : //getbootstrap.com
2018-09-11 12:59:44 +02:00
* Copyright 2013 - 2016 Twitter , Inc .
2015-04-16 12:30:59 +02:00
* Licensed under MIT ( https : //github.com/twbs/bootstrap/blob/master/LICENSE)
* /
module . exports = function ( grunt ) {
'use strict' ;
// Force use of Unix newlines
grunt . util . linefeed = '\n' ;
RegExp . quote = function ( string ) {
return string . replace ( /[-\\^$*+?.()|[\]{}]/g , '\\$&' ) ;
} ;
var fs = require ( 'fs' ) ;
var path = require ( 'path' ) ;
var generateGlyphiconsData = require ( './grunt/bs-glyphicons-data-generator.js' ) ;
var BsLessdocParser = require ( './grunt/bs-lessdoc-parser.js' ) ;
var getLessVarsData = function ( ) {
var filePath = path . join ( _ _dirname , 'less/variables.less' ) ;
var fileContent = fs . readFileSync ( filePath , { encoding : 'utf8' } ) ;
var parser = new BsLessdocParser ( fileContent ) ;
return { sections : parser . parseFile ( ) } ;
} ;
var generateRawFiles = require ( './grunt/bs-raw-files-generator.js' ) ;
var generateCommonJSModule = require ( './grunt/bs-commonjs-generator.js' ) ;
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 ) ;
} ) ;
} ) ;
// Project configuration.
grunt . initConfig ( {
// Metadata.
pkg : grunt . file . readJSON ( 'package.json' ) ,
banner : '/*!\n' +
' * Bootstrap v<%= pkg.version %> (<%= pkg.homepage %>)\n' +
' * Copyright 2011-<%= grunt.template.today("yyyy") %> <%= pkg.author %>\n' +
2015-09-16 21:01:58 +02:00
' * Licensed under the <%= pkg.license %> license\n' +
2015-04-16 12:30:59 +02:00
' */\n' ,
jqueryCheck : configBridge . config . jqueryCheck . join ( '\n' ) ,
jqueryVersionCheck : configBridge . config . jqueryVersionCheck . join ( '\n' ) ,
// Task configuration.
clean : {
dist : 'dist' ,
docs : 'docs/dist'
} ,
jshint : {
options : {
jshintrc : 'js/.jshintrc'
} ,
grunt : {
options : {
jshintrc : 'grunt/.jshintrc'
} ,
2015-09-16 21:01:58 +02:00
src : [ 'Gruntfile.js' , 'package.js' , 'grunt/*.js' ]
2015-04-16 12:30:59 +02:00
} ,
core : {
src : 'js/*.js'
} ,
test : {
options : {
jshintrc : 'js/tests/unit/.jshintrc'
} ,
src : 'js/tests/unit/*.js'
} ,
assets : {
src : [ 'docs/assets/js/src/*.js' , 'docs/assets/js/*.js' , '!docs/assets/js/*.min.js' ]
}
} ,
jscs : {
options : {
config : 'js/.jscsrc'
} ,
grunt : {
src : '<%= jshint.grunt.src %>'
} ,
core : {
src : '<%= jshint.core.src %>'
} ,
test : {
src : '<%= jshint.test.src %>'
} ,
assets : {
options : {
requireCamelCaseOrUpperCaseIdentifiers : null
} ,
src : '<%= jshint.assets.src %>'
}
} ,
concat : {
options : {
banner : '<%= banner %>\n<%= jqueryCheck %>\n<%= jqueryVersionCheck %>' ,
stripBanners : false
} ,
bootstrap : {
src : [
'js/transition.js' ,
'js/alert.js' ,
'js/button.js' ,
'js/carousel.js' ,
'js/collapse.js' ,
'js/dropdown.js' ,
'js/modal.js' ,
'js/tooltip.js' ,
'js/popover.js' ,
'js/scrollspy.js' ,
'js/tab.js' ,
'js/affix.js'
] ,
dest : 'dist/js/<%= pkg.name %>.js'
}
} ,
uglify : {
options : {
2015-09-16 21:01:58 +02:00
compress : {
warnings : false
} ,
mangle : true ,
2018-09-11 12:59:44 +02:00
preserveComments : /^!|@preserve|@license|@cc_on/i
2015-04-16 12:30:59 +02:00
} ,
core : {
src : '<%= concat.bootstrap.dest %>' ,
dest : 'dist/js/<%= pkg.name %>.min.js'
} ,
customize : {
src : configBridge . paths . customizerJs ,
dest : 'docs/assets/js/customize.min.js'
} ,
docsJs : {
src : configBridge . paths . docsJs ,
dest : 'docs/assets/js/docs.min.js'
}
} ,
qunit : {
options : {
inject : 'js/tests/unit/phantom.js'
} ,
files : 'js/tests/index.html'
} ,
less : {
compileCore : {
options : {
strictMath : true ,
sourceMap : true ,
outputSourceFiles : true ,
sourceMapURL : '<%= pkg.name %>.css.map' ,
sourceMapFilename : 'dist/css/<%= pkg.name %>.css.map'
} ,
src : 'less/bootstrap.less' ,
dest : 'dist/css/<%= pkg.name %>.css'
} ,
compileTheme : {
options : {
strictMath : true ,
sourceMap : true ,
outputSourceFiles : true ,
sourceMapURL : '<%= pkg.name %>-theme.css.map' ,
sourceMapFilename : 'dist/css/<%= pkg.name %>-theme.css.map'
} ,
src : 'less/theme.less' ,
dest : 'dist/css/<%= pkg.name %>-theme.css'
}
} ,
autoprefixer : {
options : {
browsers : configBridge . config . autoprefixerBrowsers
} ,
core : {
options : {
map : true
} ,
src : 'dist/css/<%= pkg.name %>.css'
} ,
theme : {
options : {
map : true
} ,
src : 'dist/css/<%= pkg.name %>-theme.css'
} ,
docs : {
2015-09-16 21:01:58 +02:00
src : [ 'docs/assets/css/src/docs.css' ]
2015-04-16 12:30:59 +02:00
} ,
examples : {
expand : true ,
cwd : 'docs/examples/' ,
src : [ '**/*.css' ] ,
dest : 'docs/examples/'
}
} ,
csslint : {
options : {
csslintrc : 'less/.csslintrc'
} ,
dist : [
'dist/css/bootstrap.css' ,
'dist/css/bootstrap-theme.css'
] ,
examples : [
'docs/examples/**/*.css'
] ,
docs : {
options : {
ids : false ,
'overqualified-elements' : false
} ,
src : 'docs/assets/css/src/docs.css'
}
} ,
cssmin : {
options : {
// 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
compatibility : 'ie8' ,
keepSpecialComments : '*' ,
2018-09-11 12:59:44 +02:00
sourceMap : true ,
sourceMapInlineSources : true ,
2015-04-16 12:30:59 +02:00
advanced : false
} ,
minifyCore : {
src : 'dist/css/<%= pkg.name %>.css' ,
dest : 'dist/css/<%= pkg.name %>.min.css'
} ,
minifyTheme : {
src : 'dist/css/<%= pkg.name %>-theme.css' ,
dest : 'dist/css/<%= pkg.name %>-theme.min.css'
} ,
docs : {
src : [
2018-09-11 12:59:44 +02:00
'docs/assets/css/ie10-viewport-bug-workaround.css' ,
2015-04-16 12:30:59 +02:00
'docs/assets/css/src/pygments-manni.css' ,
'docs/assets/css/src/docs.css'
] ,
dest : 'docs/assets/css/docs.min.css'
}
} ,
csscomb : {
options : {
config : 'less/.csscomb.json'
} ,
dist : {
expand : true ,
cwd : 'dist/css/' ,
src : [ '*.css' , '!*.min.css' ] ,
dest : 'dist/css/'
} ,
examples : {
expand : true ,
cwd : 'docs/examples/' ,
src : '**/*.css' ,
dest : 'docs/examples/'
} ,
docs : {
src : 'docs/assets/css/src/docs.css' ,
dest : 'docs/assets/css/src/docs.css'
}
} ,
copy : {
fonts : {
expand : true ,
2018-09-11 12:59:44 +02:00
src : 'fonts/**' ,
2015-04-16 12:30:59 +02:00
dest : 'dist/'
} ,
docs : {
expand : true ,
cwd : 'dist/' ,
src : [
'**/*'
] ,
dest : 'docs/dist/'
}
} ,
connect : {
server : {
options : {
port : 3000 ,
base : '.'
}
}
} ,
jekyll : {
options : {
2018-09-11 12:59:44 +02:00
bundleExec : true ,
config : '_config.yml' ,
incremental : false
2015-04-16 12:30:59 +02:00
} ,
docs : { } ,
github : {
options : {
raw : 'github: true'
}
}
} ,
2015-09-16 21:01:58 +02:00
htmlmin : {
dist : {
options : {
2018-09-11 12:59:44 +02:00
collapseBooleanAttributes : true ,
2015-09-16 21:01:58 +02:00
collapseWhitespace : true ,
conservativeCollapse : true ,
2018-09-11 12:59:44 +02:00
decodeEntities : false ,
minifyCSS : {
compatibility : 'ie8' ,
keepSpecialComments : 0
} ,
2015-09-16 21:01:58 +02:00
minifyJS : true ,
2018-09-11 12:59:44 +02:00
minifyURLs : false ,
processConditionalComments : true ,
2015-09-16 21:01:58 +02:00
removeAttributeQuotes : true ,
2018-09-11 12:59:44 +02:00
removeComments : true ,
removeOptionalAttributes : true ,
removeOptionalTags : true ,
removeRedundantAttributes : true ,
removeScriptTypeAttributes : true ,
removeStyleLinkTypeAttributes : true ,
removeTagWhitespace : false ,
sortAttributes : true ,
sortClassName : true
2015-09-16 21:01:58 +02:00
} ,
expand : true ,
cwd : '_gh_pages' ,
dest : '_gh_pages' ,
src : [
'**/*.html' ,
'!examples/**/*.html'
]
}
} ,
2018-09-11 12:59:44 +02:00
pug : {
2015-04-16 12:30:59 +02:00
options : {
pretty : true ,
data : getLessVarsData
} ,
customizerVars : {
2018-09-11 12:59:44 +02:00
src : 'docs/_pug/customizer-variables.pug' ,
2015-04-16 12:30:59 +02:00
dest : 'docs/_includes/customizer-variables.html'
} ,
customizerNav : {
2018-09-11 12:59:44 +02:00
src : 'docs/_pug/customizer-nav.pug' ,
2015-04-16 12:30:59 +02:00
dest : 'docs/_includes/nav/customize.html'
}
} ,
htmllint : {
options : {
ignore : [
'Attribute "autocomplete" not allowed on element "button" at this point.' ,
2018-09-11 12:59:44 +02:00
'Attribute "autocomplete" is only allowed when the input type is "color", "date", "datetime", "datetime-local", "email", "hidden", "month", "number", "password", "range", "search", "tel", "text", "time", "url", or "week".' ,
2015-04-16 12:30:59 +02:00
'Element "img" is missing required attribute "src".'
]
} ,
src : '_gh_pages/**/*.html'
} ,
watch : {
src : {
files : '<%= jshint.core.src %>' ,
2015-09-16 21:01:58 +02:00
tasks : [ 'jshint:core' , 'qunit' , 'concat' ]
2015-04-16 12:30:59 +02:00
} ,
test : {
files : '<%= jshint.test.src %>' ,
tasks : [ 'jshint:test' , 'qunit' ]
} ,
less : {
files : 'less/**/*.less' ,
tasks : 'less'
}
} ,
'saucelabs-qunit' : {
all : {
options : {
build : process . env . TRAVIS _JOB _ID ,
throttled : 10 ,
maxRetries : 3 ,
maxPollRetries : 4 ,
urls : [ 'http://127.0.0.1:3000/js/tests/index.html?hidepassed' ] ,
browsers : grunt . file . readYAML ( 'grunt/sauce_browsers.yml' )
}
}
} ,
exec : {
npmUpdate : {
command : 'npm update'
}
} ,
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'
}
]
}
}
} ) ;
// These plugins provide necessary tasks.
require ( 'load-grunt-tasks' ) ( grunt , { scope : 'devDependencies' } ) ;
require ( 'time-grunt' ) ( grunt ) ;
// Docs HTML validation task
grunt . registerTask ( 'validate-html' , [ 'jekyll:docs' , 'htmllint' ] ) ;
var runSubset = function ( subset ) {
return ! process . env . TWBS _TEST || process . env . TWBS _TEST === subset ;
} ;
var isUndefOrNonZero = function ( val ) {
return val === undefined || val !== '0' ;
} ;
// Test task.
var testSubtasks = [ ] ;
// Skip core tests if running a different subset of the test suite
if ( runSubset ( 'core' ) &&
// Skip core tests if this is a Savage build
process . env . TRAVIS _REPO _SLUG !== 'twbs-savage/bootstrap' ) {
testSubtasks = testSubtasks . concat ( [ 'dist-css' , 'dist-js' , 'csslint:dist' , 'test-js' , 'docs' ] ) ;
}
// Skip HTML validation if running a different subset of the test suite
if ( runSubset ( 'validate-html' ) &&
// Skip HTML5 validator on Travis when [skip validator] is in the commit message
isUndefOrNonZero ( process . env . TWBS _DO _VALIDATOR ) ) {
testSubtasks . push ( 'validate-html' ) ;
}
// Only run Sauce Labs tests if there's a Sauce access key
if ( typeof process . env . SAUCE _ACCESS _KEY !== 'undefined' &&
// Skip Sauce if running a different subset of the test suite
runSubset ( 'sauce-js-unit' ) &&
// Skip Sauce on Travis when [skip sauce] is in the commit message
isUndefOrNonZero ( process . env . TWBS _DO _SAUCE ) ) {
testSubtasks . push ( 'connect' ) ;
testSubtasks . push ( 'saucelabs-qunit' ) ;
}
grunt . registerTask ( 'test' , testSubtasks ) ;
grunt . registerTask ( 'test-js' , [ 'jshint:core' , 'jshint:test' , 'jshint:grunt' , 'jscs:core' , 'jscs:test' , 'jscs:grunt' , 'qunit' ] ) ;
// JS distribution task.
grunt . registerTask ( 'dist-js' , [ 'concat' , 'uglify:core' , 'commonjs' ] ) ;
// CSS distribution task.
grunt . registerTask ( 'less-compile' , [ 'less:compileCore' , 'less:compileTheme' ] ) ;
2015-09-16 21:01:58 +02:00
grunt . registerTask ( 'dist-css' , [ 'less-compile' , 'autoprefixer:core' , 'autoprefixer:theme' , 'csscomb:dist' , 'cssmin:minifyCore' , 'cssmin:minifyTheme' ] ) ;
2015-04-16 12:30:59 +02:00
// Full distribution task.
grunt . registerTask ( 'dist' , [ 'clean:dist' , 'dist-css' , 'copy:fonts' , 'dist-js' ] ) ;
// Default task.
grunt . registerTask ( 'default' , [ 'clean:dist' , 'copy:fonts' , 'test' ] ) ;
grunt . registerTask ( 'build-glyphicons-data' , function ( ) { generateGlyphiconsData . call ( this , grunt ) ; } ) ;
// task for building customizer
grunt . registerTask ( 'build-customizer' , [ 'build-customizer-html' , 'build-raw-files' ] ) ;
2018-09-11 12:59:44 +02:00
grunt . registerTask ( 'build-customizer-html' , 'pug' ) ;
2015-04-16 12:30:59 +02:00
grunt . registerTask ( 'build-raw-files' , 'Add scripts/less files to customizer.' , function ( ) {
var banner = grunt . template . process ( '<%= banner %>' ) ;
generateRawFiles ( grunt , banner ) ;
} ) ;
grunt . registerTask ( 'commonjs' , 'Generate CommonJS entrypoint module in dist dir.' , function ( ) {
var srcFiles = grunt . config . get ( 'concat.bootstrap.src' ) ;
var destFilepath = 'dist/js/npm.js' ;
generateCommonJSModule ( grunt , srcFiles , destFilepath ) ;
} ) ;
// Docs task.
grunt . registerTask ( 'docs-css' , [ 'autoprefixer:docs' , 'autoprefixer:examples' , 'csscomb:docs' , 'csscomb:examples' , 'cssmin:docs' ] ) ;
grunt . registerTask ( 'lint-docs-css' , [ 'csslint:docs' , 'csslint:examples' ] ) ;
grunt . registerTask ( 'docs-js' , [ 'uglify:docsJs' , 'uglify:customize' ] ) ;
grunt . registerTask ( 'lint-docs-js' , [ 'jshint:assets' , 'jscs:assets' ] ) ;
grunt . registerTask ( 'docs' , [ 'docs-css' , 'lint-docs-css' , 'docs-js' , 'lint-docs-js' , 'clean:docs' , 'copy:docs' , 'build-glyphicons-data' , 'build-customizer' ] ) ;
2018-09-11 12:59:44 +02:00
grunt . registerTask ( 'docs-github' , [ 'jekyll:github' , 'htmlmin' ] ) ;
2015-04-16 12:30:59 +02:00
2018-09-11 12:59:44 +02:00
grunt . registerTask ( 'prep-release' , [ 'dist' , 'docs' , 'docs-github' , 'compress' ] ) ;
2015-04-16 12:30:59 +02:00
} ;