gulpfile.js 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  1. const pkg = require('./package.json')
  2. const path = require('path')
  3. const glob = require('glob')
  4. const yargs = require('yargs')
  5. const colors = require('colors')
  6. const qunit = require('node-qunit-puppeteer')
  7. const {rollup} = require('rollup')
  8. const {terser} = require('rollup-plugin-terser')
  9. const babel = require('@rollup/plugin-babel').default
  10. const commonjs = require('@rollup/plugin-commonjs')
  11. const resolve = require('@rollup/plugin-node-resolve').default
  12. const gulp = require('gulp')
  13. const tap = require('gulp-tap')
  14. const zip = require('gulp-zip')
  15. const sass = require('gulp-sass')
  16. const header = require('gulp-header')
  17. const eslint = require('gulp-eslint')
  18. const minify = require('gulp-clean-css')
  19. const connect = require('gulp-connect')
  20. const autoprefixer = require('gulp-autoprefixer')
  21. const root = yargs.argv.root || '.'
  22. const port = yargs.argv.port || 8000
  23. const banner = `/*!
  24. * reveal.js ${pkg.version}
  25. * ${pkg.homepage}
  26. * MIT licensed
  27. *
  28. * Copyright (C) 2020 Hakim El Hattab, https://hakim.se
  29. */\n`
  30. // Prevents warnings from opening too many test pages
  31. process.setMaxListeners(20);
  32. const babelConfig = {
  33. babelHelpers: 'bundled',
  34. ignore: ['node_modules'],
  35. compact: false,
  36. extensions: ['.js', '.html'],
  37. plugins: [
  38. 'transform-html-import-to-string'
  39. ],
  40. presets: [[
  41. '@babel/preset-env',
  42. {
  43. corejs: 3,
  44. useBuiltIns: 'usage',
  45. modules: false
  46. }
  47. ]]
  48. };
  49. // Our ES module bundle only targets newer browsers with
  50. // module support. Browsers are targeted explicitly instead
  51. // of using the "esmodule: true" target since that leads to
  52. // polyfilling older browsers and a larger bundle.
  53. const babelConfigESM = JSON.parse( JSON.stringify( babelConfig ) );
  54. babelConfigESM.presets[0][1].targets = { browsers: [
  55. 'last 2 Chrome versions', 'not Chrome < 60',
  56. 'last 2 Safari versions', 'not Safari < 10.1',
  57. 'last 2 iOS versions', 'not iOS < 10.3',
  58. 'last 2 Firefox versions', 'not Firefox < 60',
  59. 'last 2 Edge versions', 'not Edge < 16',
  60. ] };
  61. let cache = {};
  62. // Creates a bundle with broad browser support, exposed
  63. // as UMD
  64. gulp.task('js-es5', () => {
  65. return rollup({
  66. cache: cache.umd,
  67. input: 'js/index.js',
  68. plugins: [
  69. resolve(),
  70. commonjs(),
  71. babel( babelConfig ),
  72. terser()
  73. ]
  74. }).then( bundle => {
  75. cache.umd = bundle.cache;
  76. return bundle.write({
  77. name: 'Reveal',
  78. file: './dist/reveal.js',
  79. format: 'umd',
  80. banner: banner,
  81. sourcemap: true
  82. });
  83. });
  84. })
  85. // Creates an ES module bundle
  86. gulp.task('js-es6', () => {
  87. return rollup({
  88. cache: cache.esm,
  89. input: 'js/index.js',
  90. plugins: [
  91. resolve(),
  92. commonjs(),
  93. babel( babelConfigESM ),
  94. terser()
  95. ]
  96. }).then( bundle => {
  97. cache.esm = bundle.cache;
  98. return bundle.write({
  99. file: './dist/reveal.esm.js',
  100. format: 'es',
  101. banner: banner,
  102. sourcemap: true
  103. });
  104. });
  105. })
  106. gulp.task('js', gulp.parallel('js-es5', 'js-es6'));
  107. // Creates a UMD and ES module bundle for each of our
  108. // built-in plugins
  109. gulp.task('plugins', () => {
  110. return Promise.all([
  111. { name: 'RevealHighlight', input: './plugin/highlight/plugin.js', output: './plugin/highlight/highlight' },
  112. { name: 'RevealMarkdown', input: './plugin/markdown/plugin.js', output: './plugin/markdown/markdown' },
  113. { name: 'RevealSearch', input: './plugin/search/plugin.js', output: './plugin/search/search' },
  114. { name: 'RevealNotes', input: './plugin/notes/plugin.js', output: './plugin/notes/notes' },
  115. { name: 'RevealZoom', input: './plugin/zoom/plugin.js', output: './plugin/zoom/zoom' },
  116. { name: 'RevealMath', input: './plugin/math/plugin.js', output: './plugin/math/math' },
  117. ].map( plugin => {
  118. return rollup({
  119. cache: cache[plugin.input],
  120. input: plugin.input,
  121. plugins: [
  122. resolve(),
  123. commonjs(),
  124. babel({
  125. ...babelConfig,
  126. ignore: [/node_modules\/(?!(highlight\.js|marked)\/).*/],
  127. }),
  128. terser()
  129. ]
  130. }).then( bundle => {
  131. cache[plugin.input] = bundle.cache;
  132. bundle.write({
  133. file: plugin.output + '.esm.js',
  134. name: plugin.name,
  135. format: 'es'
  136. })
  137. bundle.write({
  138. file: plugin.output + '.js',
  139. name: plugin.name,
  140. format: 'umd'
  141. })
  142. });
  143. } ));
  144. })
  145. gulp.task('css-themes', () => gulp.src(['./css/theme/source/*.{sass,scss}'])
  146. .pipe(sass())
  147. .pipe(gulp.dest('./dist/theme')))
  148. gulp.task('css-core', () => gulp.src(['css/reveal.scss'])
  149. .pipe(sass())
  150. .pipe(autoprefixer())
  151. .pipe(minify({compatibility: 'ie9'}))
  152. .pipe(header(banner))
  153. .pipe(gulp.dest('./dist')))
  154. gulp.task('css', gulp.parallel('css-themes', 'css-core'))
  155. gulp.task('qunit', () => {
  156. let serverConfig = {
  157. root,
  158. port: 8009,
  159. host: '0.0.0.0',
  160. name: 'test-server'
  161. }
  162. let server = connect.server( serverConfig )
  163. let testFiles = glob.sync('test/*.html' )
  164. let totalTests = 0;
  165. let failingTests = 0;
  166. let tests = Promise.all( testFiles.map( filename => {
  167. return new Promise( ( resolve, reject ) => {
  168. qunit.runQunitPuppeteer({
  169. targetUrl: `http://${serverConfig.host}:${serverConfig.port}/${filename}`,
  170. timeout: 20000,
  171. redirectConsole: false,
  172. puppeteerArgs: ['--allow-file-access-from-files']
  173. })
  174. .then(result => {
  175. if( result.stats.failed > 0 ) {
  176. console.log(`${'!'} ${filename} [${result.stats.passed}/${result.stats.total}] in ${result.stats.runtime}ms`.red);
  177. // qunit.printResultSummary(result, console);
  178. qunit.printFailedTests(result, console);
  179. }
  180. else {
  181. console.log(`${'✔'} ${filename} [${result.stats.passed}/${result.stats.total}] in ${result.stats.runtime}ms`.green);
  182. }
  183. totalTests += result.stats.total;
  184. failingTests += result.stats.failed;
  185. resolve();
  186. })
  187. .catch(error => {
  188. console.error(error);
  189. reject();
  190. });
  191. } )
  192. } ) );
  193. return new Promise( ( resolve, reject ) => {
  194. tests.then( () => {
  195. if( failingTests > 0 ) {
  196. reject( new Error(`${failingTests}/${totalTests} tests failed`.red) );
  197. }
  198. else {
  199. console.log(`${'✔'} Passed ${totalTests} tests`.green.bold);
  200. resolve();
  201. }
  202. } )
  203. .catch( () => {
  204. reject();
  205. } )
  206. .finally( () => {
  207. server.close();
  208. } );
  209. } );
  210. } )
  211. gulp.task('eslint', () => gulp.src(['./js/**', 'gulpfile.js'])
  212. .pipe(eslint())
  213. .pipe(eslint.format()))
  214. gulp.task('test', gulp.series( 'eslint', 'qunit' ))
  215. gulp.task('default', gulp.series(gulp.parallel('js', 'css', 'plugins'), 'test'))
  216. gulp.task('build', gulp.parallel('js', 'css', 'plugins'))
  217. gulp.task('package', gulp.series('default', () =>
  218. gulp.src([
  219. './index.html',
  220. './dist/**',
  221. './lib/**',
  222. './images/**',
  223. './plugin/**',
  224. './**.md'
  225. ]).pipe(zip('reveal-js-presentation.zip')).pipe(gulp.dest('./'))
  226. ))
  227. gulp.task('reload', () => gulp.src(['*.html', '*.md'])
  228. .pipe(connect.reload()));
  229. gulp.task('serve', () => {
  230. connect.server({
  231. root: root,
  232. port: port,
  233. host: '0.0.0.0',
  234. livereload: true
  235. })
  236. gulp.watch(['*.html', '*.md'], gulp.series('reload'))
  237. gulp.watch(['js/**'], gulp.series('js', 'reload', 'test'))
  238. gulp.watch(['plugin/**/plugin.js'], gulp.series('plugins', 'reload'))
  239. gulp.watch([
  240. 'css/theme/source/*.{sass,scss}',
  241. 'css/theme/template/*.{sass,scss}',
  242. ], gulp.series('css-themes', 'reload'))
  243. gulp.watch([
  244. 'css/*.scss',
  245. 'css/print/*.{sass,scss,css}'
  246. ], gulp.series('css-core', 'reload'))
  247. gulp.watch(['test/*.html'], gulp.series('test'))
  248. })