Gruntfile.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421
  1. /*!
  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)
  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 generateGlyphiconsData = require('./grunt/bs-glyphicons-data-generator.js');
  17. var BsLessdocParser = require('./grunt/bs-lessdoc-parser.js');
  18. var generateRawFilesJs = require('./grunt/bs-raw-files-generator.js');
  19. var updateShrinkwrap = require('./grunt/shrinkwrap.js');
  20. // Project configuration.
  21. grunt.initConfig({
  22. // Metadata.
  23. pkg: grunt.file.readJSON('package.json'),
  24. banner: '/*!\n' +
  25. ' * Bootstrap v<%= pkg.version %> (<%= pkg.homepage %>)\n' +
  26. ' * Copyright 2011-<%= grunt.template.today("yyyy") %> <%= pkg.author %>\n' +
  27. ' * Licensed under <%= pkg.license.type %> (<%= pkg.license.url %>)\n' +
  28. ' */\n',
  29. jqueryCheck: 'if (typeof jQuery === \'undefined\') { throw new Error(\'Bootstrap\\\'s JavaScript requires jQuery\') }\n\n',
  30. // Task configuration.
  31. clean: {
  32. dist: ['dist', 'docs/dist']
  33. },
  34. jshint: {
  35. options: {
  36. jshintrc: 'js/.jshintrc'
  37. },
  38. grunt: {
  39. options: {
  40. jshintrc: 'grunt/.jshintrc'
  41. },
  42. src: ['Gruntfile.js', 'grunt/*.js']
  43. },
  44. src: {
  45. src: 'js/*.js'
  46. },
  47. test: {
  48. src: 'js/tests/unit/*.js'
  49. },
  50. assets: {
  51. src: ['docs/assets/js/application.js', 'docs/assets/js/customizer.js']
  52. }
  53. },
  54. jscs: {
  55. options: {
  56. config: 'js/.jscs.json',
  57. },
  58. grunt: {
  59. src: ['Gruntfile.js', 'grunt/*.js']
  60. },
  61. src: {
  62. src: 'js/*.js'
  63. },
  64. test: {
  65. src: 'js/tests/unit/*.js'
  66. },
  67. assets: {
  68. src: ['docs/assets/js/application.js', 'docs/assets/js/customizer.js']
  69. }
  70. },
  71. csslint: {
  72. options: {
  73. csslintrc: 'less/.csslintrc'
  74. },
  75. src: [
  76. 'dist/css/bootstrap.css',
  77. 'dist/css/bootstrap-theme.css',
  78. 'docs/assets/css/docs.css',
  79. 'docs/examples/**/*.css'
  80. ]
  81. },
  82. concat: {
  83. options: {
  84. banner: '<%= banner %>\n<%= jqueryCheck %>',
  85. stripBanners: false
  86. },
  87. bootstrap: {
  88. src: [
  89. 'js/transition.js',
  90. 'js/alert.js',
  91. 'js/button.js',
  92. 'js/carousel.js',
  93. 'js/collapse.js',
  94. 'js/dropdown.js',
  95. 'js/modal.js',
  96. 'js/tooltip.js',
  97. 'js/popover.js',
  98. 'js/scrollspy.js',
  99. 'js/tab.js',
  100. 'js/affix.js'
  101. ],
  102. dest: 'dist/js/<%= pkg.name %>.js'
  103. }
  104. },
  105. uglify: {
  106. options: {
  107. report: 'min'
  108. },
  109. bootstrap: {
  110. options: {
  111. banner: '<%= banner %>'
  112. },
  113. src: '<%= concat.bootstrap.dest %>',
  114. dest: 'dist/js/<%= pkg.name %>.min.js'
  115. },
  116. customize: {
  117. options: {
  118. preserveComments: 'some'
  119. },
  120. src: [
  121. 'docs/assets/js/vendor/less.min.js',
  122. 'docs/assets/js/vendor/jszip.min.js',
  123. 'docs/assets/js/vendor/uglify.min.js',
  124. 'docs/assets/js/vendor/blob.js',
  125. 'docs/assets/js/vendor/filesaver.js',
  126. 'docs/assets/js/raw-files.min.js',
  127. 'docs/assets/js/customizer.js'
  128. ],
  129. dest: 'docs/assets/js/customize.min.js'
  130. },
  131. docsJs: {
  132. options: {
  133. preserveComments: 'some'
  134. },
  135. src: [
  136. 'docs/assets/js/vendor/holder.js',
  137. 'docs/assets/js/application.js'
  138. ],
  139. dest: 'docs/assets/js/docs.min.js'
  140. }
  141. },
  142. less: {
  143. compileCore: {
  144. options: {
  145. strictMath: true,
  146. sourceMap: true,
  147. outputSourceFiles: true,
  148. sourceMapURL: '<%= pkg.name %>.css.map',
  149. sourceMapFilename: 'dist/css/<%= pkg.name %>.css.map'
  150. },
  151. files: {
  152. 'dist/css/<%= pkg.name %>.css': 'less/bootstrap.less'
  153. }
  154. },
  155. compileTheme: {
  156. options: {
  157. strictMath: true,
  158. sourceMap: true,
  159. outputSourceFiles: true,
  160. sourceMapURL: '<%= pkg.name %>-theme.css.map',
  161. sourceMapFilename: 'dist/css/<%= pkg.name %>-theme.css.map'
  162. },
  163. files: {
  164. 'dist/css/<%= pkg.name %>-theme.css': 'less/theme.less'
  165. }
  166. },
  167. minify: {
  168. options: {
  169. cleancss: true,
  170. report: 'min'
  171. },
  172. files: {
  173. 'dist/css/<%= pkg.name %>.min.css': 'dist/css/<%= pkg.name %>.css',
  174. 'dist/css/<%= pkg.name %>-theme.min.css': 'dist/css/<%= pkg.name %>-theme.css'
  175. }
  176. }
  177. },
  178. cssmin: {
  179. compress: {
  180. options: {
  181. keepSpecialComments: '*',
  182. noAdvanced: true, // turn advanced optimizations off until the issue is fixed in clean-css
  183. report: 'min',
  184. selectorsMergeMode: 'ie8'
  185. },
  186. src: [
  187. 'docs/assets/css/docs.css',
  188. 'docs/assets/css/pygments-manni.css'
  189. ],
  190. dest: 'docs/assets/css/docs.min.css'
  191. }
  192. },
  193. usebanner: {
  194. dist: {
  195. options: {
  196. position: 'top',
  197. banner: '<%= banner %>'
  198. },
  199. files: {
  200. src: [
  201. 'dist/css/<%= pkg.name %>.css',
  202. 'dist/css/<%= pkg.name %>.min.css',
  203. 'dist/css/<%= pkg.name %>-theme.css',
  204. 'dist/css/<%= pkg.name %>-theme.min.css'
  205. ]
  206. }
  207. }
  208. },
  209. csscomb: {
  210. options: {
  211. config: 'less/.csscomb.json'
  212. },
  213. dist: {
  214. files: {
  215. 'dist/css/<%= pkg.name %>.css': 'dist/css/<%= pkg.name %>.css',
  216. 'dist/css/<%= pkg.name %>-theme.css': 'dist/css/<%= pkg.name %>-theme.css'
  217. }
  218. },
  219. examples: {
  220. expand: true,
  221. cwd: 'docs/examples/',
  222. src: ['**/*.css'],
  223. dest: 'docs/examples/'
  224. }
  225. },
  226. copy: {
  227. fonts: {
  228. expand: true,
  229. src: 'fonts/*',
  230. dest: 'dist/'
  231. },
  232. docs: {
  233. expand: true,
  234. cwd: './dist',
  235. src: [
  236. '{css,js}/*.min.*',
  237. 'css/*.map',
  238. 'fonts/*'
  239. ],
  240. dest: 'docs/dist'
  241. }
  242. },
  243. qunit: {
  244. options: {
  245. inject: 'js/tests/unit/phantom.js'
  246. },
  247. files: 'js/tests/index.html'
  248. },
  249. connect: {
  250. server: {
  251. options: {
  252. port: 3000,
  253. base: '.'
  254. }
  255. }
  256. },
  257. jekyll: {
  258. docs: {}
  259. },
  260. jade: {
  261. compile: {
  262. options: {
  263. pretty: true,
  264. data: function () {
  265. var filePath = path.join(__dirname, 'less/variables.less');
  266. var fileContent = fs.readFileSync(filePath, {encoding: 'utf8'});
  267. var parser = new BsLessdocParser(fileContent);
  268. return {sections: parser.parseFile()};
  269. }
  270. },
  271. files: {
  272. 'docs/_includes/customizer-variables.html': 'docs/jade/customizer-variables.jade',
  273. 'docs/_includes/nav-customize.html': 'docs/jade/customizer-nav.jade'
  274. }
  275. }
  276. },
  277. validation: {
  278. options: {
  279. charset: 'utf-8',
  280. doctype: 'HTML5',
  281. failHard: true,
  282. reset: true,
  283. relaxerror: [
  284. 'Bad value X-UA-Compatible for attribute http-equiv on element meta.',
  285. 'Element img is missing required attribute src.'
  286. ]
  287. },
  288. files: {
  289. src: '_gh_pages/**/*.html'
  290. }
  291. },
  292. watch: {
  293. src: {
  294. files: '<%= jshint.src.src %>',
  295. tasks: ['jshint:src', 'qunit']
  296. },
  297. test: {
  298. files: '<%= jshint.test.src %>',
  299. tasks: ['jshint:test', 'qunit']
  300. },
  301. less: {
  302. files: 'less/*.less',
  303. tasks: 'less'
  304. }
  305. },
  306. sed: {
  307. versionNumber: {
  308. pattern: (function () {
  309. var old = grunt.option('oldver');
  310. return old ? RegExp.quote(old) : old;
  311. })(),
  312. replacement: grunt.option('newver'),
  313. recursive: true
  314. }
  315. },
  316. 'saucelabs-qunit': {
  317. all: {
  318. options: {
  319. build: process.env.TRAVIS_JOB_ID,
  320. concurrency: 10,
  321. urls: ['http://127.0.0.1:3000/js/tests/index.html'],
  322. browsers: grunt.file.readYAML('test-infra/sauce_browsers.yml')
  323. }
  324. }
  325. },
  326. exec: {
  327. npmUpdate: {
  328. command: 'npm update'
  329. },
  330. npmShrinkWrap: {
  331. command: 'npm shrinkwrap --dev'
  332. }
  333. }
  334. });
  335. // These plugins provide necessary tasks.
  336. require('load-grunt-tasks')(grunt, {scope: 'devDependencies'});
  337. // Docs HTML validation task
  338. grunt.registerTask('validate-html', ['jekyll', 'validation']);
  339. // Test task.
  340. var testSubtasks = [];
  341. // Skip core tests if running a different subset of the test suite
  342. if (!process.env.TWBS_TEST || process.env.TWBS_TEST === 'core') {
  343. testSubtasks = testSubtasks.concat(['dist-css', 'csslint', 'jshint', 'jscs', 'qunit', 'build-customizer-html']);
  344. }
  345. // Skip HTML validation if running a different subset of the test suite
  346. if (!process.env.TWBS_TEST || process.env.TWBS_TEST === 'validate-html') {
  347. testSubtasks.push('validate-html');
  348. }
  349. // Only run Sauce Labs tests if there's a Sauce access key
  350. if (typeof process.env.SAUCE_ACCESS_KEY !== 'undefined' &&
  351. // Skip Sauce if running a different subset of the test suite
  352. (!process.env.TWBS_TEST || process.env.TWBS_TEST === 'sauce-js-unit')) {
  353. testSubtasks.push('connect');
  354. testSubtasks.push('saucelabs-qunit');
  355. }
  356. grunt.registerTask('test', testSubtasks);
  357. // JS distribution task.
  358. grunt.registerTask('dist-js', ['concat', 'uglify']);
  359. // CSS distribution task.
  360. grunt.registerTask('dist-css', ['less', 'cssmin', 'csscomb', 'usebanner']);
  361. // Docs distribution task.
  362. grunt.registerTask('dist-docs', 'copy:docs');
  363. // Full distribution task.
  364. grunt.registerTask('dist', ['clean', 'dist-css', 'copy:fonts', 'dist-js', 'dist-docs']);
  365. // Default task.
  366. grunt.registerTask('default', ['test', 'dist', 'build-glyphicons-data', 'build-customizer', 'update-shrinkwrap']);
  367. // Version numbering task.
  368. // grunt change-version-number --oldver=A.B.C --newver=X.Y.Z
  369. // This can be overzealous, so its changes should always be manually reviewed!
  370. grunt.registerTask('change-version-number', 'sed');
  371. grunt.registerTask('build-glyphicons-data', generateGlyphiconsData);
  372. // task for building customizer
  373. grunt.registerTask('build-customizer', ['build-customizer-html', 'build-raw-files']);
  374. grunt.registerTask('build-customizer-html', 'jade');
  375. grunt.registerTask('build-raw-files', 'Add scripts/less files to customizer.', function () {
  376. var banner = grunt.template.process('<%= banner %>');
  377. generateRawFilesJs(banner);
  378. });
  379. // Task for updating the npm packages used by the Travis build.
  380. grunt.registerTask('update-shrinkwrap', ['exec:npmUpdate', 'exec:npmShrinkWrap', '_update-shrinkwrap']);
  381. grunt.registerTask('_update-shrinkwrap', function () { updateShrinkwrap.call(this, grunt); });
  382. };