2
* Bootstrap's Gruntfile
3
* http://getbootstrap.com
4
* Copyright 2013-2014 Twitter, Inc.
5
* Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
8
module.exports = function (grunt) {
11
// Force use of Unix newlines
12
grunt.util.linefeed = '\n';
14
RegExp.quote = function (string) {
15
return string.replace(/[-\\^$*+?.()|[\]{}]/g, '\\$&');
18
var fs = require('fs');
19
var path = require('path');
20
var generateGlyphiconsData = require('./docs/grunt/bs-glyphicons-data-generator.js');
21
var BsLessdocParser = require('./docs/grunt/bs-lessdoc-parser.js');
22
var generateRawFilesJs = require('./docs/grunt/bs-raw-files-generator.js');
23
var updateShrinkwrap = require('./test-infra/shrinkwrap.js');
25
// Project configuration.
29
pkg: grunt.file.readJSON('package.json'),
31
' * Bootstrap v<%= pkg.version %> (<%= pkg.homepage %>)\n' +
32
' * Copyright 2011-<%= grunt.template.today("yyyy") %> <%= pkg.author %>\n' +
33
' * Licensed under <%= _.pluck(pkg.licenses, "type") %> (<%= _.pluck(pkg.licenses, "url") %>)\n' +
35
jqueryCheck: 'if (typeof jQuery === \'undefined\') { throw new Error(\'Bootstrap requires jQuery\') }\n\n',
37
// Task configuration.
44
jshintrc: 'js/.jshintrc'
47
src: ['Gruntfile.js', 'docs/grunt/*.js', 'test-infra/shrinkwrap.js']
53
src: 'js/tests/unit/*.js'
56
src: ['docs/assets/js/application.js', 'docs/assets/js/customizer.js']
62
config: 'js/.jscs.json',
65
src: ['Gruntfile.js', 'docs/grunt/*.js', 'test-infra/shrinkwrap.js']
71
src: 'js/tests/unit/*.js'
74
src: ['docs/assets/js/application.js', 'docs/assets/js/customizer.js']
80
csslintrc: 'less/.csslintrc'
83
'dist/css/bootstrap.css',
84
'dist/css/bootstrap-theme.css',
85
'docs/assets/css/docs.css'
91
banner: '<%= banner %>\n<%= jqueryCheck %>',
109
dest: 'dist/js/<%= pkg.name %>.js'
116
banner: '<%= banner %>',
119
src: '<%= concat.bootstrap.dest %>',
120
dest: 'dist/js/<%= pkg.name %>.min.js'
124
preserveComments: 'some',
128
'docs/assets/js/vendor/less.min.js',
129
'docs/assets/js/vendor/jszip.js',
130
'docs/assets/js/vendor/uglify.min.js',
131
'docs/assets/js/vendor/blob.js',
132
'docs/assets/js/vendor/filesaver.js',
133
'docs/assets/js/raw-files.min.js',
134
'docs/assets/js/customizer.js'
136
dest: 'docs/assets/js/customize.min.js'
140
preserveComments: 'some',
144
'docs/assets/js/vendor/holder.js',
145
'docs/assets/js/application.js'
147
dest: 'docs/assets/js/docs.min.js'
156
outputSourceFiles: true,
157
sourceMapURL: '<%= pkg.name %>.css.map',
158
sourceMapFilename: 'dist/css/<%= pkg.name %>.css.map'
161
'dist/css/<%= pkg.name %>.css': 'less/bootstrap.less'
168
outputSourceFiles: true,
169
sourceMapURL: '<%= pkg.name %>-theme.css.map',
170
sourceMapFilename: 'dist/css/<%= pkg.name %>-theme.css.map'
173
'dist/css/<%= pkg.name %>-theme.css': 'less/theme.less'
182
'dist/css/<%= pkg.name %>.min.css': 'dist/css/<%= pkg.name %>.css',
183
'dist/css/<%= pkg.name %>-theme.min.css': 'dist/css/<%= pkg.name %>-theme.css'
191
keepSpecialComments: '*',
192
noAdvanced: true, // turn advanced optimizations off until the issue is fixed in clean-css
194
selectorsMergeMode: 'ie8'
197
'docs/assets/css/docs.css',
198
'docs/assets/css/pygments-manni.css'
200
dest: 'docs/assets/css/docs.min.css'
208
banner: '<%= banner %>'
212
'dist/css/<%= pkg.name %>.css',
213
'dist/css/<%= pkg.name %>.min.css',
214
'dist/css/<%= pkg.name %>-theme.css',
215
'dist/css/<%= pkg.name %>-theme.min.css'
224
config: 'less/.csscomb.json'
227
'dist/css/<%= pkg.name %>.css': 'dist/css/<%= pkg.name %>.css',
228
'dist/css/<%= pkg.name %>-theme.css': 'dist/css/<%= pkg.name %>-theme.css'
253
inject: 'js/tests/unit/phantom.js'
255
files: 'js/tests/*.html'
276
var filePath = path.join(__dirname, 'less/variables.less');
277
var fileContent = fs.readFileSync(filePath, {encoding: 'utf8'});
278
var parser = new BsLessdocParser(fileContent);
279
return {sections: parser.parseFile()};
283
'docs/_includes/customizer-variables.html': 'docs/customizer-variables.jade',
284
'docs/_includes/nav-customize.html': 'docs/customizer-nav.jade'
296
'Bad value X-UA-Compatible for attribute http-equiv on element meta.',
297
'Element img is missing required attribute src.'
301
src: '_gh_pages/**/*.html'
307
files: '<%= jshint.src.src %>',
308
tasks: ['jshint:src', 'qunit']
311
files: '<%= jshint.test.src %>',
312
tasks: ['jshint:test', 'qunit']
315
files: 'less/*.less',
322
pattern: (function () {
323
var old = grunt.option('oldver');
324
return old ? RegExp.quote(old) : old;
326
replacement: grunt.option('newver'),
334
build: process.env.TRAVIS_JOB_ID,
336
urls: ['http://127.0.0.1:3000/js/tests/index.html'],
337
browsers: grunt.file.readYAML('test-infra/sauce_browsers.yml')
344
command: 'npm update'
347
command: 'npm shrinkwrap --dev'
353
// These plugins provide necessary tasks.
354
require('load-grunt-tasks')(grunt, {scope: 'devDependencies'});
355
grunt.loadNpmTasks('browserstack-runner');
357
// Docs HTML validation task
358
grunt.registerTask('validate-html', ['jekyll', 'validation']);
361
var testSubtasks = [];
362
// Skip core tests if running a different subset of the test suite
363
if (!process.env.TWBS_TEST || process.env.TWBS_TEST === 'core') {
364
testSubtasks = testSubtasks.concat(['dist-css', 'csslint', 'jshint', 'jscs', 'qunit', 'build-customizer-html']);
366
// Skip HTML validation if running a different subset of the test suite
367
if (!process.env.TWBS_TEST || process.env.TWBS_TEST === 'validate-html') {
368
testSubtasks.push('validate-html');
370
// Only run Sauce Labs tests if there's a Sauce access key
371
if (typeof process.env.SAUCE_ACCESS_KEY !== 'undefined' &&
372
// Skip Sauce if running a different subset of the test suite
373
(!process.env.TWBS_TEST || process.env.TWBS_TEST === 'sauce-js-unit')) {
374
testSubtasks.push('connect');
375
testSubtasks.push('saucelabs-qunit');
377
// Only run BrowserStack tests if there's a BrowserStack access key
378
if (typeof process.env.BROWSERSTACK_KEY !== 'undefined' &&
379
// Skip BrowserStack if running a different subset of the test suite
380
(!process.env.TWBS_TEST || process.env.TWBS_TEST === 'browserstack-js-unit')) {
381
testSubtasks.push('browserstack_runner');
383
grunt.registerTask('test', testSubtasks);
385
// JS distribution task.
386
grunt.registerTask('dist-js', ['concat', 'uglify']);
388
// CSS distribution task.
389
grunt.registerTask('dist-css', ['less', 'cssmin', 'csscomb', 'usebanner']);
391
// Docs distribution task.
392
grunt.registerTask('dist-docs', 'copy:docs');
394
// Full distribution task.
395
grunt.registerTask('dist', ['clean', 'dist-css', 'copy:fonts', 'dist-docs', 'dist-js']);
398
grunt.registerTask('default', ['test', 'dist', 'build-glyphicons-data', 'build-customizer', 'update-shrinkwrap']);
400
// Version numbering task.
401
// grunt change-version-number --oldver=A.B.C --newver=X.Y.Z
402
// This can be overzealous, so its changes should always be manually reviewed!
403
grunt.registerTask('change-version-number', 'sed');
405
grunt.registerTask('build-glyphicons-data', generateGlyphiconsData);
407
// task for building customizer
408
grunt.registerTask('build-customizer', ['build-customizer-html', 'build-raw-files']);
409
grunt.registerTask('build-customizer-html', 'jade');
410
grunt.registerTask('build-raw-files', 'Add scripts/less files to customizer.', function () {
411
var banner = grunt.template.process('<%= banner %>');
412
generateRawFilesJs(banner);
415
// Task for updating the npm packages used by the Travis build.
416
grunt.registerTask('update-shrinkwrap', ['exec:npmUpdate', 'exec:npmShrinkWrap', '_update-shrinkwrap']);
417
grunt.registerTask('_update-shrinkwrap', function () { updateShrinkwrap.call(this, grunt); });