Gruntfile.js 11 KB

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