Gruntfile.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512
  1. /*!
  2. * Bootstrap's Gruntfile
  3. * http://getbootstrap.com
  4. * Copyright 2013-2015 Twitter, Inc.
  5. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
  6. */
  7. module.exports = function (grunt) {
  8. 'use strict';
  9. // Force use of Unix newlines
  10. grunt.util.linefeed = '\n';
  11. RegExp.quote = function (string) {
  12. return string.replace(/[-\\^$*+?.()|[\]{}]/g, '\\$&');
  13. };
  14. var fs = require('fs');
  15. var path = require('path');
  16. var npmShrinkwrap = require('npm-shrinkwrap');
  17. var generateGlyphiconsData = require('./grunt/bs-glyphicons-data-generator.js');
  18. var BsLessdocParser = require('./grunt/bs-lessdoc-parser.js');
  19. var getLessVarsData = function () {
  20. var filePath = path.join(__dirname, 'less/variables.less');
  21. var fileContent = fs.readFileSync(filePath, { encoding: 'utf8' });
  22. var parser = new BsLessdocParser(fileContent);
  23. return { sections: parser.parseFile() };
  24. };
  25. var generateRawFiles = require('./grunt/bs-raw-files-generator.js');
  26. var generateCommonJSModule = require('./grunt/bs-commonjs-generator.js');
  27. var configBridge = grunt.file.readJSON('./grunt/configBridge.json', { encoding: 'utf8' });
  28. Object.keys(configBridge.paths).forEach(function (key) {
  29. configBridge.paths[key].forEach(function (val, i, arr) {
  30. arr[i] = path.join('./docs/assets', val);
  31. });
  32. });
  33. // Project configuration.
  34. grunt.initConfig({
  35. // Metadata.
  36. pkg: grunt.file.readJSON('package.json'),
  37. banner: '/*!\n' +
  38. ' * Bootstrap v<%= pkg.version %> (<%= pkg.homepage %>)\n' +
  39. ' * Copyright 2011-<%= grunt.template.today("yyyy") %> <%= pkg.author %>\n' +
  40. ' * Licensed under <%= pkg.license.type %> (<%= pkg.license.url %>)\n' +
  41. ' */\n',
  42. jqueryCheck: configBridge.config.jqueryCheck.join('\n'),
  43. jqueryVersionCheck: configBridge.config.jqueryVersionCheck.join('\n'),
  44. // Task configuration.
  45. clean: {
  46. dist: 'dist',
  47. docs: 'docs/dist'
  48. },
  49. jshint: {
  50. options: {
  51. jshintrc: 'js/.jshintrc'
  52. },
  53. grunt: {
  54. options: {
  55. jshintrc: 'grunt/.jshintrc'
  56. },
  57. src: ['Gruntfile.js', 'grunt/*.js']
  58. },
  59. core: {
  60. src: 'js/*.js'
  61. },
  62. test: {
  63. options: {
  64. jshintrc: 'js/tests/unit/.jshintrc'
  65. },
  66. src: 'js/tests/unit/*.js'
  67. },
  68. assets: {
  69. src: ['docs/assets/js/src/*.js', 'docs/assets/js/*.js', '!docs/assets/js/*.min.js']
  70. }
  71. },
  72. jscs: {
  73. options: {
  74. config: 'js/.jscsrc'
  75. },
  76. grunt: {
  77. src: '<%= jshint.grunt.src %>'
  78. },
  79. core: {
  80. src: '<%= jshint.core.src %>'
  81. },
  82. test: {
  83. src: '<%= jshint.test.src %>'
  84. },
  85. assets: {
  86. options: {
  87. requireCamelCaseOrUpperCaseIdentifiers: null
  88. },
  89. src: '<%= jshint.assets.src %>'
  90. }
  91. },
  92. concat: {
  93. options: {
  94. banner: '<%= banner %>\n<%= jqueryCheck %>\n<%= jqueryVersionCheck %>',
  95. stripBanners: false
  96. },
  97. bootstrap: {
  98. src: [
  99. 'js/transition.js',
  100. 'js/alert.js',
  101. 'js/button.js',
  102. 'js/carousel.js',
  103. 'js/collapse.js',
  104. 'js/dropdown.js',
  105. 'js/modal.js',
  106. 'js/tooltip.js',
  107. 'js/popover.js',
  108. 'js/scrollspy.js',
  109. 'js/tab.js',
  110. 'js/affix.js'
  111. ],
  112. dest: 'dist/js/<%= pkg.name %>.js'
  113. }
  114. },
  115. uglify: {
  116. options: {
  117. preserveComments: 'some'
  118. },
  119. core: {
  120. src: '<%= concat.bootstrap.dest %>',
  121. dest: 'dist/js/<%= pkg.name %>.min.js'
  122. },
  123. customize: {
  124. src: configBridge.paths.customizerJs,
  125. dest: 'docs/assets/js/customize.min.js'
  126. },
  127. docsJs: {
  128. src: configBridge.paths.docsJs,
  129. dest: 'docs/assets/js/docs.min.js'
  130. }
  131. },
  132. qunit: {
  133. options: {
  134. inject: 'js/tests/unit/phantom.js'
  135. },
  136. files: 'js/tests/index.html'
  137. },
  138. less: {
  139. compileCore: {
  140. options: {
  141. strictMath: true,
  142. sourceMap: true,
  143. outputSourceFiles: true,
  144. sourceMapURL: '<%= pkg.name %>.css.map',
  145. sourceMapFilename: 'dist/css/<%= pkg.name %>.css.map'
  146. },
  147. src: 'less/bootstrap.less',
  148. dest: 'dist/css/<%= pkg.name %>.css'
  149. },
  150. compileTheme: {
  151. options: {
  152. strictMath: true,
  153. sourceMap: true,
  154. outputSourceFiles: true,
  155. sourceMapURL: '<%= pkg.name %>-theme.css.map',
  156. sourceMapFilename: 'dist/css/<%= pkg.name %>-theme.css.map'
  157. },
  158. src: 'less/theme.less',
  159. dest: 'dist/css/<%= pkg.name %>-theme.css'
  160. }
  161. },
  162. autoprefixer: {
  163. options: {
  164. browsers: configBridge.config.autoprefixerBrowsers
  165. },
  166. core: {
  167. options: {
  168. map: true
  169. },
  170. src: 'dist/css/<%= pkg.name %>.css'
  171. },
  172. theme: {
  173. options: {
  174. map: true
  175. },
  176. src: 'dist/css/<%= pkg.name %>-theme.css'
  177. },
  178. docs: {
  179. src: ['docs/assets/css/anchor.css', 'docs/assets/css/src/docs.css']
  180. },
  181. examples: {
  182. expand: true,
  183. cwd: 'docs/examples/',
  184. src: ['**/*.css'],
  185. dest: 'docs/examples/'
  186. }
  187. },
  188. csslint: {
  189. options: {
  190. csslintrc: 'less/.csslintrc'
  191. },
  192. dist: [
  193. 'dist/css/bootstrap.css',
  194. 'dist/css/bootstrap-theme.css'
  195. ],
  196. examples: [
  197. 'docs/examples/**/*.css'
  198. ],
  199. docs: {
  200. options: {
  201. ids: false,
  202. 'overqualified-elements': false
  203. },
  204. src: 'docs/assets/css/src/docs.css'
  205. }
  206. },
  207. cssmin: {
  208. options: {
  209. // TODO: disable `zeroUnits` optimization once clean-css 3.2 is released
  210. // and then simplify the fix for https://github.com/twbs/bootstrap/issues/14837 accordingly
  211. compatibility: 'ie8',
  212. keepSpecialComments: '*',
  213. advanced: false
  214. },
  215. minifyCore: {
  216. src: 'dist/css/<%= pkg.name %>.css',
  217. dest: 'dist/css/<%= pkg.name %>.min.css'
  218. },
  219. minifyTheme: {
  220. src: 'dist/css/<%= pkg.name %>-theme.css',
  221. dest: 'dist/css/<%= pkg.name %>-theme.min.css'
  222. },
  223. docs: {
  224. src: [
  225. 'docs/assets/css/src/pygments-manni.css',
  226. 'docs/assets/css/src/anchor.css',
  227. 'docs/assets/css/src/docs.css'
  228. ],
  229. dest: 'docs/assets/css/docs.min.css'
  230. }
  231. },
  232. usebanner: {
  233. options: {
  234. position: 'top',
  235. banner: '<%= banner %>'
  236. },
  237. files: {
  238. src: 'dist/css/*.css'
  239. }
  240. },
  241. csscomb: {
  242. options: {
  243. config: 'less/.csscomb.json'
  244. },
  245. dist: {
  246. expand: true,
  247. cwd: 'dist/css/',
  248. src: ['*.css', '!*.min.css'],
  249. dest: 'dist/css/'
  250. },
  251. examples: {
  252. expand: true,
  253. cwd: 'docs/examples/',
  254. src: '**/*.css',
  255. dest: 'docs/examples/'
  256. },
  257. docs: {
  258. src: 'docs/assets/css/src/docs.css',
  259. dest: 'docs/assets/css/src/docs.css'
  260. }
  261. },
  262. copy: {
  263. fonts: {
  264. expand: true,
  265. src: 'fonts/*',
  266. dest: 'dist/'
  267. },
  268. docs: {
  269. expand: true,
  270. cwd: 'dist/',
  271. src: [
  272. '**/*'
  273. ],
  274. dest: 'docs/dist/'
  275. }
  276. },
  277. connect: {
  278. server: {
  279. options: {
  280. port: 3000,
  281. base: '.'
  282. }
  283. }
  284. },
  285. jekyll: {
  286. options: {
  287. config: '_config.yml'
  288. },
  289. docs: {},
  290. github: {
  291. options: {
  292. raw: 'github: true'
  293. }
  294. }
  295. },
  296. jade: {
  297. options: {
  298. pretty: true,
  299. data: getLessVarsData
  300. },
  301. customizerVars: {
  302. src: 'docs/_jade/customizer-variables.jade',
  303. dest: 'docs/_includes/customizer-variables.html'
  304. },
  305. customizerNav: {
  306. src: 'docs/_jade/customizer-nav.jade',
  307. dest: 'docs/_includes/nav/customize.html'
  308. }
  309. },
  310. htmllint: {
  311. options: {
  312. ignore: [
  313. 'Attribute "autocomplete" not allowed on element "button" at this point.',
  314. 'Attribute "autocomplete" not allowed on element "input" at this point.',
  315. 'Element "img" is missing required attribute "src".'
  316. ]
  317. },
  318. src: '_gh_pages/**/*.html'
  319. },
  320. watch: {
  321. src: {
  322. files: '<%= jshint.core.src %>',
  323. tasks: ['jshint:src', 'qunit', 'concat']
  324. },
  325. test: {
  326. files: '<%= jshint.test.src %>',
  327. tasks: ['jshint:test', 'qunit']
  328. },
  329. less: {
  330. files: 'less/**/*.less',
  331. tasks: 'less'
  332. }
  333. },
  334. sed: {
  335. versionNumber: {
  336. pattern: (function () {
  337. var old = grunt.option('oldver');
  338. return old ? RegExp.quote(old) : old;
  339. })(),
  340. replacement: grunt.option('newver'),
  341. recursive: true
  342. }
  343. },
  344. 'saucelabs-qunit': {
  345. all: {
  346. options: {
  347. build: process.env.TRAVIS_JOB_ID,
  348. throttled: 10,
  349. maxRetries: 3,
  350. maxPollRetries: 4,
  351. urls: ['http://127.0.0.1:3000/js/tests/index.html?hidepassed'],
  352. browsers: grunt.file.readYAML('grunt/sauce_browsers.yml')
  353. }
  354. }
  355. },
  356. exec: {
  357. npmUpdate: {
  358. command: 'npm update'
  359. }
  360. },
  361. compress: {
  362. main: {
  363. options: {
  364. archive: 'bootstrap-<%= pkg.version %>-dist.zip',
  365. mode: 'zip',
  366. level: 9,
  367. pretty: true
  368. },
  369. files: [
  370. {
  371. expand: true,
  372. cwd: 'dist/',
  373. src: ['**'],
  374. dest: 'bootstrap-<%= pkg.version %>-dist'
  375. }
  376. ]
  377. }
  378. }
  379. });
  380. // These plugins provide necessary tasks.
  381. require('load-grunt-tasks')(grunt, { scope: 'devDependencies' });
  382. require('time-grunt')(grunt);
  383. // Docs HTML validation task
  384. grunt.registerTask('validate-html', ['jekyll:docs', 'htmllint']);
  385. var runSubset = function (subset) {
  386. return !process.env.TWBS_TEST || process.env.TWBS_TEST === subset;
  387. };
  388. var isUndefOrNonZero = function (val) {
  389. return val === undefined || val !== '0';
  390. };
  391. // Test task.
  392. var testSubtasks = [];
  393. // Skip core tests if running a different subset of the test suite
  394. if (runSubset('core') &&
  395. // Skip core tests if this is a Savage build
  396. process.env.TRAVIS_REPO_SLUG !== 'twbs-savage/bootstrap') {
  397. testSubtasks = testSubtasks.concat(['dist-css', 'dist-js', 'csslint:dist', 'test-js', 'docs']);
  398. }
  399. // Skip HTML validation if running a different subset of the test suite
  400. if (runSubset('validate-html') &&
  401. // Skip HTML5 validator on Travis when [skip validator] is in the commit message
  402. isUndefOrNonZero(process.env.TWBS_DO_VALIDATOR)) {
  403. testSubtasks.push('validate-html');
  404. }
  405. // Only run Sauce Labs tests if there's a Sauce access key
  406. if (typeof process.env.SAUCE_ACCESS_KEY !== 'undefined' &&
  407. // Skip Sauce if running a different subset of the test suite
  408. runSubset('sauce-js-unit') &&
  409. // Skip Sauce on Travis when [skip sauce] is in the commit message
  410. isUndefOrNonZero(process.env.TWBS_DO_SAUCE)) {
  411. testSubtasks.push('connect');
  412. testSubtasks.push('saucelabs-qunit');
  413. }
  414. grunt.registerTask('test', testSubtasks);
  415. grunt.registerTask('test-js', ['jshint:core', 'jshint:test', 'jshint:grunt', 'jscs:core', 'jscs:test', 'jscs:grunt', 'qunit']);
  416. // JS distribution task.
  417. grunt.registerTask('dist-js', ['concat', 'uglify:core', 'commonjs']);
  418. // CSS distribution task.
  419. grunt.registerTask('less-compile', ['less:compileCore', 'less:compileTheme']);
  420. grunt.registerTask('dist-css', ['less-compile', 'autoprefixer:core', 'autoprefixer:theme', 'usebanner', 'csscomb:dist', 'cssmin:minifyCore', 'cssmin:minifyTheme']);
  421. // Full distribution task.
  422. grunt.registerTask('dist', ['clean:dist', 'dist-css', 'copy:fonts', 'dist-js']);
  423. // Default task.
  424. grunt.registerTask('default', ['clean:dist', 'copy:fonts', 'test']);
  425. // Version numbering task.
  426. // grunt change-version-number --oldver=A.B.C --newver=X.Y.Z
  427. // This can be overzealous, so its changes should always be manually reviewed!
  428. grunt.registerTask('change-version-number', 'sed');
  429. grunt.registerTask('build-glyphicons-data', function () { generateGlyphiconsData.call(this, grunt); });
  430. // task for building customizer
  431. grunt.registerTask('build-customizer', ['build-customizer-html', 'build-raw-files']);
  432. grunt.registerTask('build-customizer-html', 'jade');
  433. grunt.registerTask('build-raw-files', 'Add scripts/less files to customizer.', function () {
  434. var banner = grunt.template.process('<%= banner %>');
  435. generateRawFiles(grunt, banner);
  436. });
  437. grunt.registerTask('commonjs', 'Generate CommonJS entrypoint module in dist dir.', function () {
  438. var srcFiles = grunt.config.get('concat.bootstrap.src');
  439. var destFilepath = 'dist/js/npm.js';
  440. generateCommonJSModule(grunt, srcFiles, destFilepath);
  441. });
  442. // Docs task.
  443. grunt.registerTask('docs-css', ['autoprefixer:docs', 'autoprefixer:examples', 'csscomb:docs', 'csscomb:examples', 'cssmin:docs']);
  444. grunt.registerTask('lint-docs-css', ['csslint:docs', 'csslint:examples']);
  445. grunt.registerTask('docs-js', ['uglify:docsJs', 'uglify:customize']);
  446. grunt.registerTask('lint-docs-js', ['jshint:assets', 'jscs:assets']);
  447. grunt.registerTask('docs', ['docs-css', 'lint-docs-css', 'docs-js', 'lint-docs-js', 'clean:docs', 'copy:docs', 'build-glyphicons-data', 'build-customizer']);
  448. grunt.registerTask('prep-release', ['jekyll:github', 'compress']);
  449. // Task for updating the cached npm packages used by the Travis build (which are controlled by test-infra/npm-shrinkwrap.json).
  450. // This task should be run and the updated file should be committed whenever Bootstrap's dependencies change.
  451. grunt.registerTask('update-shrinkwrap', ['exec:npmUpdate', '_update-shrinkwrap']);
  452. grunt.registerTask('_update-shrinkwrap', function () {
  453. var done = this.async();
  454. npmShrinkwrap({ dev: true, dirname: __dirname }, function (err) {
  455. if (err) {
  456. grunt.fail.warn(err);
  457. }
  458. var dest = 'test-infra/npm-shrinkwrap.json';
  459. fs.renameSync('npm-shrinkwrap.json', dest);
  460. grunt.log.writeln('File ' + dest.cyan + ' updated.');
  461. done();
  462. });
  463. });
  464. };