Gruntfile.js 10.45 KiB
/* jshint node: true */
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 btoa = require('btoa')
  // 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' +
              ' * Licensed under <%= _.pluck(pkg.licenses, "type") %> (<%= _.pluck(pkg.licenses, "url") %>)\n' +
              ' */\n',
    jqueryCheck: 'if (typeof jQuery === "undefined") { throw new Error("Bootstrap requires jQuery") }\n\n',
    // Task configuration.
    clean: {
      dist: ['dist']
    jshint: {
      options: {
        jshintrc: 'js/.jshintrc'
      gruntfile: {
        src: 'Gruntfile.js'
      src: {
        src: ['js/*.js']
      test: {
        src: ['js/tests/unit/*.js']
      assets: {
        src: ['docs/assets/js/application.js', 'docs/assets/js/customizer.js']
    jscs: {
      options: {
        config: 'js/.jscs.json',
      gruntfile: {
        src: ['Gruntfile.js']
      src: {
        src: ['js/*.js']
      test: {
        src: ['js/tests/unit/*.js']
      assets: {
        src: ['docs/assets/js/application.js', 'docs/assets/js/customizer.js']
    csslint: {
      options: {
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
csslintrc: 'less/.csslintrc' }, src: [ 'dist/css/bootstrap.css', 'dist/css/bootstrap-theme.css', 'docs/assets/css/docs.css' ] }, concat: { options: { banner: '<%= banner %>\n<%= jqueryCheck %>', 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: { bootstrap: { options: { banner: '<%= banner %>\n', report: 'min' }, src: ['<%= concat.bootstrap.dest %>'], dest: 'dist/js/<%= pkg.name %>.min.js' }, customize: { options: { banner: '/*!\n' + ' * Bootstrap Docs (<%= pkg.homepage %>)\n' + ' * Copyright 2011-<%= grunt.template.today("yyyy") %> <%= pkg.author %>\n' + ' * Licensed under the Creative Commons Attribution 3.0 Unported License. For\n' + ' * details, see http://creativecommons.org/licenses/by/3.0/.\n' + ' */\n', report: 'min' }, src: [ 'docs/assets/js/less.js', 'docs/assets/js/jszip.js', 'docs/assets/js/uglify.js', 'docs/assets/js/filesaver.js', 'docs/assets/js/raw-files.js', 'docs/assets/js/customizer.js' ], dest: 'docs/assets/js/customize.min.js' }, docsJs: { options: { report: 'min' }, src: [ 'docs/assets/js/holder.js', 'docs/assets/js/application.js' ],
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
dest: 'docs/assets/js/docs.min.js' } }, less: { compileCore: { options: { strictMath: true, sourceMap: true, outputSourceFiles: true, sourceMapURL: '<%= pkg.name %>.css.map', sourceMapFilename: 'dist/css/<%= pkg.name %>.css.map' }, files: { 'dist/css/<%= pkg.name %>.css': 'less/bootstrap.less' } }, compileTheme: { options: { strictMath: true, sourceMap: true, outputSourceFiles: true, sourceMapURL: '<%= pkg.name %>-theme.css.map', sourceMapFilename: 'dist/css/<%= pkg.name %>-theme.css.map' }, files: { 'dist/css/<%= pkg.name %>-theme.css': 'less/theme.less' } }, minify: { options: { cleancss: true, report: 'min' }, files: { 'dist/css/<%= pkg.name %>.min.css': 'dist/css/<%= pkg.name %>.css', 'dist/css/<%= pkg.name %>-theme.min.css': 'dist/css/<%= pkg.name %>-theme.css' } } }, usebanner: { dist: { options: { position: 'top', banner: '<%= banner %>' }, files: { src: [ 'dist/css/<%= pkg.name %>.css', 'dist/css/<%= pkg.name %>.min.css', 'dist/css/<%= pkg.name %>-theme.css', 'dist/css/<%= pkg.name %>-theme.min.css', ] } } }, csscomb: { sort: { options: { config: 'less/.csscomb.json' }, files: { 'dist/css/<%= pkg.name %>.css': ['dist/css/<%= pkg.name %>.css'], 'dist/css/<%= pkg.name %>-theme.css': ['dist/css/<%= pkg.name %>-theme.css'] } } },
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
copy: { fonts: { expand: true, src: ['fonts/*'], dest: 'dist/' }, docs: { expand: true, cwd: './dist', src: [ '{css,js}/*.min.*', 'css/*.map', 'fonts/*' ], dest: 'docs/dist' } }, qunit: { options: { inject: 'js/tests/unit/phantom.js' }, files: ['js/tests/*.html'] }, connect: { server: { options: { port: 3000, base: '.' } } }, jekyll: { docs: {} }, validation: { options: { charset: 'utf-8', doctype: 'HTML5', failHard: true, reset: true, relaxerror: [ 'Bad value X-UA-Compatible for attribute http-equiv on element meta.', 'Element img is missing required attribute src.' ] }, files: { src: ['_gh_pages/**/*.html'] } }, watch: { src: { files: '<%= jshint.src.src %>', tasks: ['jshint:src', 'qunit'] }, test: { files: '<%= jshint.test.src %>', tasks: ['jshint:test', 'qunit'] }, less: { files: 'less/*.less', tasks: ['less'] } }, sed: {
281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350
versionNumber: { pattern: (function () { var old = grunt.option('oldver') return old ? RegExp.quote(old) : old })(), replacement: grunt.option('newver'), recursive: true } }, 'saucelabs-qunit': { all: { options: { build: process.env.TRAVIS_JOB_ID, concurrency: 3, urls: ['http://127.0.0.1:3000/js/tests/index.html'], browsers: grunt.file.readYAML('test-infra/sauce_browsers.yml') } } } }); // These plugins provide necessary tasks. require('load-grunt-tasks')(grunt, {scope: 'devDependencies'}); // Docs HTML validation task grunt.registerTask('validate-html', ['jekyll', 'validation']); // Test task. var testSubtasks = []; // Skip core tests if running a different subset of the test suite if (!process.env.TWBS_TEST || process.env.TWBS_TEST === 'core') { testSubtasks = testSubtasks.concat(['dist-css', 'csslint', 'jshint', 'jscs', 'qunit']); } // Skip HTML validation if running a different subset of the test suite if (!process.env.TWBS_TEST || process.env.TWBS_TEST === 'validate-html') { 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 && (!process.env.TWBS_TEST || process.env.TWBS_TEST === 'sauce-js-unit')) { testSubtasks.push('connect'); testSubtasks.push('saucelabs-qunit'); } grunt.registerTask('test', testSubtasks); // JS distribution task. grunt.registerTask('dist-js', ['concat', 'uglify']); // CSS distribution task. grunt.registerTask('dist-css', ['less', 'csscomb', 'usebanner']); // Docs distribution task. grunt.registerTask('dist-docs', ['copy:docs']); // Full distribution task. grunt.registerTask('dist', ['clean', 'dist-css', 'copy:fonts', 'dist-docs', 'dist-js']); // Default task. grunt.registerTask('default', ['test', 'dist', 'build-glyphicons-data', 'build-customizer']); // Version numbering task. // grunt change-version-number --oldver=A.B.C --newver=X.Y.Z // This can be overzealous, so its changes should always be manually reviewed! grunt.registerTask('change-version-number', ['sed']); grunt.registerTask('build-glyphicons-data', function () { // Pass encoding, utf8, so `readFileSync` will return a string instead of a
351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392
// buffer var glyphiconsFile = fs.readFileSync('less/glyphicons.less', 'utf8') var glpyhiconsLines = glyphiconsFile.split('\n') // Use any line that starts with ".glyphicon-" and capture the class name var iconClassName = /^\.(glyphicon-[^\s]+)/ var glyphiconsData = '# This file is generated via Grunt task. **Do not edit directly.** \n' + '# See the \'build-glyphicons-data\' task in Gruntfile.js.\n\n'; for (var i = 0, len = glpyhiconsLines.length; i < len; i++) { var match = glpyhiconsLines[i].match(iconClassName) if (match != null) { glyphiconsData += '- ' + match[1] + '\n' } } // Create the `_data` directory if it doesn't already exist if (!fs.existsSync('docs/_data')) fs.mkdirSync('docs/_data') fs.writeFileSync('docs/_data/glyphicons.yml', glyphiconsData) }); // task for building customizer grunt.registerTask('build-customizer', 'Add scripts/less files to customizer.', function () { function getFiles(type) { var files = {} fs.readdirSync(type) .filter(function (path) { return type == 'fonts' ? true : new RegExp('\\.' + type + '$').test(path) }) .forEach(function (path) { var fullPath = type + '/' + path return files[path] = (type == 'fonts' ? btoa(fs.readFileSync(fullPath)) : fs.readFileSync(fullPath, 'utf8')) }) return 'var __' + type + ' = ' + JSON.stringify(files) + '\n' } var files = getFiles('js') + getFiles('less') + getFiles('fonts') fs.writeFileSync('docs/assets/js/raw-files.js', files) }); };