gulpfile.js 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314
  1. var gulp = require("gulp");
  2. var uglify = require("gulp-uglify");
  3. var typescript = require("gulp-typescript");
  4. var sourcemaps = require("gulp-sourcemaps");
  5. var srcToVariable = require("gulp-content-to-variable");
  6. var appendSrcToVariable = require("./gulp-appendSrcToVariable");
  7. var addDtsExport = require("./gulp-addDtsExport");
  8. var addModuleExports = require("./gulp-addModuleExports");
  9. var merge2 = require("merge2");
  10. var concat = require("gulp-concat");
  11. var rename = require("gulp-rename");
  12. var cleants = require('gulp-clean-ts-extends');
  13. var changedInPlace = require('gulp-changed-in-place');
  14. var runSequence = require('run-sequence');
  15. var replace = require("gulp-replace");
  16. var uncommentShader = require("./gulp-removeShaderComments");
  17. var expect = require('gulp-expect-file');
  18. var optimisejs = require('gulp-optimize-js');
  19. var webserver = require('gulp-webserver');
  20. var path = require('path');
  21. var config = require("./config.json");
  22. var debug = require('gulp-debug');
  23. var includeShadersStream;
  24. var shadersStream;
  25. var workersStream;
  26. var extendsSearchRegex = /var\s__extends[\s\S]+?\};/g;
  27. var decorateSearchRegex = /var\s__decorate[\s\S]+?\};/g;
  28. /**
  29. * TS configurations shared in the gulp file.
  30. */
  31. var tsConfig = {
  32. noExternalResolve: true,
  33. target: 'ES5',
  34. declarationFiles: true,
  35. typescript: require('typescript'),
  36. experimentalDecorators: true,
  37. isolatedModules: false
  38. };
  39. var tsProject = typescript.createProject(tsConfig);
  40. var externalTsConfig = {
  41. noExternalResolve: false,
  42. target: 'ES5',
  43. declarationFiles: true,
  44. typescript: require('typescript'),
  45. experimentalDecorators: true,
  46. isolatedModules: false
  47. };
  48. /*
  49. * Shader Management.
  50. */
  51. function shadersName(filename) {
  52. return filename.replace('.fragment', 'Pixel')
  53. .replace('.vertex', 'Vertex')
  54. .replace('.fx', 'Shader');
  55. }
  56. function includeShadersName(filename) {
  57. return filename.replace('.fx', '');
  58. }
  59. /*
  60. * Main necessary files stream Management.
  61. */
  62. gulp.task("includeShaders", function (cb) {
  63. includeShadersStream = config.includeShadersDirectories.map(function (shadersDef) {
  64. return gulp.src(shadersDef.files).
  65. pipe(expect.real({ errorOnFailure: true }, shadersDef.files)).
  66. pipe(uncommentShader()).
  67. pipe(srcToVariable({
  68. variableName: shadersDef.variable, asMap: true, namingCallback: includeShadersName
  69. }));
  70. });
  71. cb();
  72. });
  73. gulp.task("shaders", ["includeShaders"], function (cb) {
  74. shadersStream = config.shadersDirectories.map(function (shadersDef) {
  75. return gulp.src(shadersDef.files).
  76. pipe(expect.real({ errorOnFailure: true }, shadersDef.files)).
  77. pipe(uncommentShader()).
  78. pipe(srcToVariable({
  79. variableName: shadersDef.variable, asMap: true, namingCallback: shadersName
  80. }));
  81. });
  82. cb();
  83. });
  84. gulp.task("workers", function (cb) {
  85. workersStream = config.workers.map(function (workerDef) {
  86. return gulp.src(workerDef.files).
  87. pipe(expect.real({ errorOnFailure: true }, workerDef.files)).
  88. pipe(uglify()).
  89. pipe(srcToVariable({
  90. variableName: workerDef.variable
  91. }));
  92. });
  93. cb();
  94. });
  95. /*
  96. * Compiles all typescript files and creating a js and a declaration file.
  97. */
  98. gulp.task('typescript-compile', function () {
  99. var tsResult = gulp.src(config.core.typescript)
  100. .pipe(sourcemaps.init())
  101. .pipe(typescript(tsProject));
  102. //If this gulp task is running on travis, file the build!
  103. if (process.env.TRAVIS) {
  104. var error = false;
  105. tsResult.on('error', function () {
  106. error = true;
  107. }).on('end', function () {
  108. if (error) {
  109. console.log('Typescript compile failed');
  110. process.exit(1);
  111. }
  112. });
  113. }
  114. return merge2([
  115. tsResult.dts
  116. .pipe(concat(config.build.declarationFilename))
  117. //.pipe(addDtsExport("BABYLON"))
  118. .pipe(gulp.dest(config.build.outputDirectory)),
  119. tsResult.js
  120. .pipe(sourcemaps.write("./",
  121. {
  122. includeContent:false,
  123. sourceRoot: (filePath) => {
  124. var repeatCount = filePath.relative.split(path.sep).length - 1;
  125. return '../'.repeat(repeatCount);
  126. }
  127. }))
  128. .pipe(gulp.dest(config.build.srcOutputDirectory))
  129. ])
  130. });
  131. /**
  132. * External library Build (mat, post processes, ...).
  133. */
  134. gulp.task('materialsLibrary', function () {
  135. return buildExternalLibraries(config.materialsLibrary);
  136. });
  137. gulp.task('postProcessesLibrary', function () {
  138. return buildExternalLibraries(config.postProcessesLibrary);
  139. });
  140. gulp.task('proceduralTexturesLibrary', function () {
  141. return buildExternalLibraries(config.proceduralTexturesLibrary);
  142. });
  143. /**
  144. * Helper methods to build external library (mat, post processes, ...).
  145. */
  146. var buildExternalLibraries = function(settings) {
  147. var tasks = settings.libraries.map(function (library) {
  148. return buildExternalLibrary(library, settings);
  149. });
  150. return merge2(tasks);
  151. }
  152. var buildExternalLibrary= function(library, settings) {
  153. var compilOutput = gulp.src(library.file, { base: '../../' })
  154. .pipe(sourcemaps.init())
  155. .pipe(typescript(externalTsConfig));
  156. var js = compilOutput.js;
  157. var shader = gulp.src(library.shaderFiles)
  158. .pipe(uncommentShader())
  159. .pipe(appendSrcToVariable("BABYLON.Effect.ShadersStore", true, shadersName));
  160. return merge2(js, shader)
  161. .pipe(cleants())
  162. .pipe(replace(extendsSearchRegex, ""))
  163. .pipe(concat(library.output))
  164. .pipe(sourcemaps.write('.temp', {
  165. includeContent:false,
  166. sourceRoot: function (file) {
  167. return '../';
  168. }
  169. }))
  170. .pipe(gulp.dest(settings.build.distOutputDirectory));
  171. }
  172. /**
  173. * Build tasks to concat minify uflify optimise the BJS js in different flavor (workers...).
  174. */
  175. gulp.task("buildCore", ["shaders"], function () {
  176. return merge2(
  177. gulp.src(config.core.files).
  178. pipe(expect.real({ errorOnFailure: true }, config.core.files)),
  179. shadersStream,
  180. includeShadersStream
  181. )
  182. .pipe(concat(config.build.minCoreFilename))
  183. .pipe(cleants())
  184. .pipe(replace(extendsSearchRegex, ""))
  185. .pipe(replace(decorateSearchRegex, ""))
  186. .pipe(addModuleExports("BABYLON"))
  187. .pipe(uglify())
  188. .pipe(optimisejs())
  189. .pipe(gulp.dest(config.build.outputDirectory));
  190. });
  191. gulp.task("buildNoWorker", ["shaders"], function () {
  192. return merge2(
  193. gulp.src(config.core.files).
  194. pipe(expect.real({ errorOnFailure: true }, config.core.files)),
  195. gulp.src(config.extras.files).
  196. pipe(expect.real({ errorOnFailure: true }, config.extras.files)),
  197. shadersStream,
  198. includeShadersStream
  199. )
  200. .pipe(concat(config.build.minNoWorkerFilename))
  201. .pipe(cleants())
  202. .pipe(replace(extendsSearchRegex, ""))
  203. .pipe(replace(decorateSearchRegex, ""))
  204. .pipe(addModuleExports("BABYLON"))
  205. .pipe(uglify())
  206. .pipe(optimisejs())
  207. .pipe(gulp.dest(config.build.outputDirectory));
  208. });
  209. gulp.task("build", ["workers", "shaders"], function () {
  210. return merge2(
  211. gulp.src(config.core.files).
  212. pipe(expect.real({ errorOnFailure: true }, config.core.files)),
  213. gulp.src(config.extras.files).
  214. pipe(expect.real({ errorOnFailure: true }, config.extras.files)),
  215. shadersStream,
  216. includeShadersStream,
  217. workersStream
  218. )
  219. .pipe(concat(config.build.filename))
  220. .pipe(cleants())
  221. .pipe(replace(extendsSearchRegex, ""))
  222. .pipe(replace(decorateSearchRegex, ""))
  223. .pipe(addModuleExports("BABYLON"))
  224. .pipe(gulp.dest(config.build.outputDirectory))
  225. .pipe(rename(config.build.minFilename))
  226. .pipe(uglify())
  227. .pipe(optimisejs())
  228. .pipe(gulp.dest(config.build.outputDirectory));
  229. });
  230. /**
  231. * The default task, concat and min the main BJS files.
  232. */
  233. gulp.task('default', function (cb) {
  234. runSequence("buildNoWorker", "build", "buildCore", cb);
  235. });
  236. /**
  237. * Build the releasable files.
  238. */
  239. gulp.task("typescript", function (cb) {
  240. runSequence("typescript-compile", "default", cb);
  241. });
  242. gulp.task("typescript-libraries", ["materialsLibrary", "postProcessesLibrary", "proceduralTexturesLibrary"], function () {
  243. });
  244. gulp.task("typescript-all", function (cb) {
  245. runSequence("typescript", "typescript-libraries", cb);
  246. });
  247. /**
  248. * Watch ts files and fire repective tasks.
  249. */
  250. gulp.task('watch', ['typescript-compile'], function () {
  251. var tasks = [gulp.watch(config.core.typescript, ['typescript-compile'])];
  252. config.materialsLibrary.libraries.map(function (material) {
  253. tasks.push(gulp.watch(material.file, () => buildExternalLibrary(material, config.materialsLibrary)));
  254. tasks.push(gulp.watch(material.shaderFiles, () => buildExternalLibrary(material, config.materialsLibrary)));
  255. });
  256. config.postProcessesLibrary.libraries.map(function (postProcess) {
  257. tasks.push(gulp.watch(postProcess.file, buildExternalLibrary(postProcess, config.postProcessesLibrary)));
  258. tasks.push(gulp.watch(postProcess.shaderFiles, buildExternalLibrary(postProcess, config.postProcessesLibrary)));
  259. });
  260. config.proceduralTexturesLibrary.libraries.map(function (proceduralTexture) {
  261. tasks.push(gulp.watch(proceduralTexture.file, buildExternalLibrary(proceduralTexture, config.proceduralTexturesLibrary)));
  262. tasks.push(gulp.watch(proceduralTexture.shaderFiles, buildExternalLibrary(proceduralTexture, config.proceduralTexturesLibrary)));
  263. });
  264. return tasks;
  265. });
  266. /**
  267. * Embedded webserver for test convenience.
  268. */
  269. gulp.task('webserver', function () {
  270. gulp.src('../../.').pipe(webserver({
  271. port: 1338,
  272. livereload: false
  273.     }));
  274. });
  275. /**
  276. * Combine Webserver and Watch as long as vscode does not handle multi tasks.
  277. */
  278. gulp.task('run', ['watch', 'webserver'], function () {
  279. });