gulpfile.js 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558
  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 sass = require("gulp-sass");
  22. var webpack = require("webpack-stream");
  23. var config = require("./config.json");
  24. var del = require("del");
  25. var debug = require("gulp-debug");
  26. var includeShadersStream;
  27. var shadersStream;
  28. var workersStream;
  29. var extendsSearchRegex = /var\s__extends[\s\S]+?\}\)\(\);/g;
  30. var decorateSearchRegex = /var\s__decorate[\s\S]+?\};/g;
  31. var referenceSearchRegex = /\/\/\/ <reference.*/g;
  32. /**
  33. * TS configurations shared in the gulp file.
  34. */
  35. var tsConfig = {
  36. noResolve: true,
  37. target: "ES5",
  38. declarationFiles: true,
  39. typescript: require("typescript"),
  40. experimentalDecorators: true,
  41. isolatedModules: false,
  42. noImplicitAny: true,
  43. noImplicitReturns: true,
  44. noImplicitThis: true,
  45. noUnusedLocals: true,
  46. strictNullChecks: true,
  47. strictFunctionTypes: true,
  48. types: []
  49. };
  50. var tsProject = typescript.createProject(tsConfig);
  51. var externalTsConfig = {
  52. noResolve: false,
  53. target: "ES5",
  54. declarationFiles: true,
  55. typescript: require("typescript"),
  56. experimentalDecorators: true,
  57. isolatedModules: false,
  58. noImplicitAny: true,
  59. noImplicitReturns: true,
  60. noImplicitThis: true,
  61. noUnusedLocals: true,
  62. strictNullChecks: true,
  63. types: []
  64. };
  65. var minimist = require("minimist");
  66. var commandLineOptions = minimist(process.argv.slice(2), {
  67. boolean: "public"
  68. });
  69. function processDependency(kind, dependency, filesToLoad) {
  70. if (dependency.dependUpon) {
  71. for (var i = 0; i < dependency.dependUpon.length; i++) {
  72. var dependencyName = dependency.dependUpon[i];
  73. var parent = config.workloads[dependencyName];
  74. processDependency(kind, parent, filesToLoad);
  75. }
  76. }
  77. var content = dependency[kind];
  78. if (!content) {
  79. return;
  80. }
  81. for (var i = 0; i < content.length; i++) {
  82. var file = content[i];
  83. if (filesToLoad.indexOf(file) === -1) {
  84. filesToLoad.push(file);
  85. }
  86. }
  87. }
  88. function determineFilesToProcess(kind) {
  89. var currentConfig = config.build.currentConfig;
  90. var buildConfiguration = config.buildConfigurations[currentConfig];
  91. var filesToLoad = [];
  92. for (var index = 0; index < buildConfiguration.length; index++) {
  93. var dependencyName = buildConfiguration[index];
  94. var dependency = config.workloads[dependencyName];
  95. if (kind === "directFiles" && !dependency) {
  96. filesToLoad.push("../../dist/preview release/" + dependencyName);
  97. }
  98. else if (dependency) {
  99. processDependency(kind, dependency, filesToLoad);
  100. }
  101. }
  102. if (kind === "shaderIncludes") {
  103. for (var index = 0; index < filesToLoad.length; index++) {
  104. filesToLoad[index] = "../../src/Shaders/ShadersInclude/" + filesToLoad[index] + ".fx";
  105. }
  106. } else if (kind === "shaders") {
  107. for (var index = 0; index < filesToLoad.length; index++) {
  108. var name = filesToLoad[index];
  109. filesToLoad[index] = "../../src/Shaders/" + filesToLoad[index] + ".fx";
  110. }
  111. }
  112. return filesToLoad;
  113. }
  114. /*
  115. * Shader Management.
  116. */
  117. function shadersName(filename) {
  118. return path.basename(filename)
  119. .replace(".fragment", "Pixel")
  120. .replace(".vertex", "Vertex")
  121. .replace(".fx", "Shader");
  122. }
  123. function includeShadersName(filename) {
  124. return path.basename(filename).replace(".fx", "");
  125. }
  126. /*
  127. * Main necessary files stream Management.
  128. */
  129. gulp.task("includeShaders", function (cb) {
  130. var filesToProcess = determineFilesToProcess("shaderIncludes");
  131. includeShadersStream = gulp.src(filesToProcess).
  132. pipe(expect.real({ errorOnFailure: true }, filesToProcess)).
  133. pipe(uncommentShader()).
  134. pipe(srcToVariable({
  135. variableName: "BABYLON.Effect.IncludesShadersStore", asMap: true, namingCallback: includeShadersName
  136. }));
  137. cb();
  138. });
  139. gulp.task("shaders", ["includeShaders"], function (cb) {
  140. var filesToProcess = determineFilesToProcess("shaders");
  141. shadersStream = gulp.src(filesToProcess).
  142. pipe(expect.real({ errorOnFailure: true }, filesToProcess)).
  143. pipe(uncommentShader()).
  144. pipe(srcToVariable({
  145. variableName: "BABYLON.Effect.ShadersStore", asMap: true, namingCallback: shadersName
  146. }));
  147. cb();
  148. });
  149. gulp.task("workers", function (cb) {
  150. workersStream = config.workers.map(function (workerDef) {
  151. return gulp.src(workerDef.files).
  152. pipe(expect.real({ errorOnFailure: true }, workerDef.files)).
  153. pipe(uglify()).
  154. pipe(srcToVariable({
  155. variableName: workerDef.variable
  156. }));
  157. });
  158. cb();
  159. });
  160. /**
  161. * Build tasks to concat minify uflify optimise the BJS js in different flavor (workers...).
  162. */
  163. gulp.task("buildWorker", ["workers", "shaders"], function () {
  164. var filesToProcess = determineFilesToProcess("files");
  165. return merge2(
  166. gulp.src(filesToProcess).
  167. pipe(expect.real({ errorOnFailure: true }, filesToProcess)),
  168. shadersStream,
  169. includeShadersStream,
  170. workersStream
  171. )
  172. .pipe(concat(config.build.minWorkerFilename))
  173. .pipe(cleants())
  174. .pipe(replace(extendsSearchRegex, ""))
  175. .pipe(replace(decorateSearchRegex, ""))
  176. .pipe(addModuleExports("BABYLON"))
  177. .pipe(uglify())
  178. .pipe(optimisejs())
  179. .pipe(gulp.dest(config.build.outputDirectory));
  180. });
  181. gulp.task("build", ["shaders"], function () {
  182. var filesToProcess = determineFilesToProcess("files");
  183. var directFilesToProcess = determineFilesToProcess("directFiles");
  184. return merge2(
  185. gulp.src(filesToProcess).
  186. pipe(expect.real({ errorOnFailure: true }, filesToProcess)),
  187. shadersStream,
  188. includeShadersStream,
  189. gulp.src(directFilesToProcess)
  190. )
  191. .pipe(concat(config.build.filename))
  192. .pipe(cleants())
  193. .pipe(replace(extendsSearchRegex, ""))
  194. .pipe(replace(decorateSearchRegex, ""))
  195. .pipe(addModuleExports("BABYLON"))
  196. .pipe(gulp.dest(config.build.outputDirectory))
  197. .pipe(rename(config.build.minFilename))
  198. .pipe(uglify())
  199. .pipe(optimisejs())
  200. .pipe(gulp.dest(config.build.outputDirectory));
  201. });
  202. /*
  203. * Compiles all typescript files and creating a js and a declaration file.
  204. */
  205. var alreadyCompiled = false;
  206. gulp.task("typescript-compile", function () {
  207. if (alreadyCompiled) {
  208. return;
  209. }
  210. alreadyCompiled = true;
  211. var tsResult = gulp.src(config.typescript)
  212. .pipe(sourcemaps.init())
  213. .pipe(tsProject());
  214. //If this gulp task is running on travis, file the build!
  215. if (process.env.TRAVIS) {
  216. var error = false;
  217. tsResult.on("error", function () {
  218. error = true;
  219. }).on("end", function () {
  220. if (error) {
  221. console.log("Typescript compile failed");
  222. process.exit(1);
  223. }
  224. });
  225. }
  226. return merge2([
  227. tsResult.dts
  228. .pipe(concat(config.build.declarationFilename))
  229. .pipe(addDtsExport("BABYLON", "babylonjs"))
  230. .pipe(gulp.dest(config.build.outputDirectory)),
  231. tsResult.js
  232. .pipe(sourcemaps.write("./",
  233. {
  234. includeContent: false,
  235. sourceRoot: (filePath) => {
  236. return "";
  237. }
  238. }))
  239. .pipe(gulp.dest(config.build.srcOutputDirectory))
  240. ])
  241. });
  242. /**
  243. * Helper methods to build external library (mat, post processes, ...).
  244. */
  245. var buildExternalLibraries = function (settings) {
  246. var tasks = settings.libraries.map(function (library) {
  247. return buildExternalLibrary(library, settings, false);
  248. });
  249. let mergedTasks = merge2(tasks);
  250. if (settings.build.buildAsModule) {
  251. mergedTasks.on("end", function () {
  252. //generate js file list
  253. let files = settings.libraries.filter(function (lib) {
  254. return !lib.doNotIncludeInBundle;
  255. }).map(function (lib) {
  256. return config.build.outputDirectory + settings.build.distOutputDirectory + lib.output;
  257. });
  258. var outputDirectory = config.build.outputDirectory + settings.build.distOutputDirectory;
  259. let srcTask = gulp.src(files)
  260. .pipe(concat(settings.build.outputFilename + ".js"))
  261. .pipe(replace(extendsSearchRegex, ""))
  262. .pipe(replace(decorateSearchRegex, ""))
  263. .pipe(replace(referenceSearchRegex, ""))
  264. .pipe(addModuleExports(settings.build.moduleDeclaration, true, settings.build.extendsRoot))
  265. .pipe(gulp.dest(outputDirectory))
  266. .pipe(cleants())
  267. .pipe(rename({ extname: ".min.js" }))
  268. .pipe(uglify())
  269. .pipe(optimisejs())
  270. .pipe(gulp.dest(outputDirectory));
  271. let dtsFiles = files.map(function (filename) {
  272. return filename.replace(".js", ".d.ts");
  273. });
  274. let dtsTask = gulp.src(dtsFiles)
  275. .pipe(concat(settings.build.outputFilename + ".module.d.ts"))
  276. .pipe(replace(referenceSearchRegex, ""))
  277. .pipe(addDtsExport(settings.build.moduleDeclaration, settings.build.moduleName, true, settings.build.extendsRoot))
  278. .pipe(gulp.dest(outputDirectory));
  279. return merge2([srcTask, dtsTask]);
  280. });
  281. }
  282. return mergedTasks;
  283. }
  284. var buildExternalLibrary = function (library, settings, watch) {
  285. var tsProcess = gulp.src(library.files, { base: settings.build.srcOutputDirectory })
  286. .pipe(sourcemaps.init())
  287. .pipe(typescript(externalTsConfig));
  288. var includeShader = gulp.src(library.shadersIncludeFiles || [], { base: settings.build.srcOutputDirectory })
  289. .pipe(uncommentShader())
  290. .pipe(appendSrcToVariable("BABYLON.Effect.IncludesShadersStore", includeShadersName, library.output + ".include.fx"))
  291. .pipe(gulp.dest(settings.build.srcOutputDirectory));
  292. var shader = gulp.src(library.shaderFiles || [], { base: settings.build.srcOutputDirectory })
  293. .pipe(uncommentShader())
  294. .pipe(appendSrcToVariable("BABYLON.Effect.ShadersStore", shadersName, library.output + ".fx"))
  295. .pipe(gulp.dest(settings.build.srcOutputDirectory));
  296. var dev = tsProcess.js
  297. .pipe(sourcemaps.write("./", {
  298. includeContent: false,
  299. sourceRoot: (filePath) => {
  300. return "";
  301. }
  302. })).pipe(gulp.dest(settings.build.srcOutputDirectory));
  303. var outputDirectory = config.build.outputDirectory + settings.build.distOutputDirectory;
  304. var css = gulp.src(library.sassFiles || [])
  305. .pipe(sass().on("error", sass.logError))
  306. .pipe(concat(library.output.replace(".js", ".css")))
  307. .pipe(gulp.dest(outputDirectory));
  308. if (watch) {
  309. return merge2([shader, includeShader, dev, css]);
  310. }
  311. else {
  312. /*if (library.bundle) {
  313. // Don't remove extends and decorate functions
  314. var code = merge2([tsProcess.js, shader, includeShader])
  315. .pipe(concat(library.output));
  316. if (library.buildAsModule) {
  317. code = code.pipe(addModuleExports(library.moduleDeclaration, true))
  318. }
  319. code.pipe(gulp.dest(outputDirectory))
  320. .pipe(cleants())
  321. .pipe(rename({ extname: ".min.js" }))
  322. .pipe(uglify())
  323. .pipe(optimisejs())
  324. .pipe(gulp.dest(outputDirectory));
  325. } else {*/
  326. var code = merge2([tsProcess.js, shader, includeShader])
  327. .pipe(concat(library.output))
  328. if (library.buildAsModule) {
  329. code = code.pipe(replace(extendsSearchRegex, ""))
  330. .pipe(replace(decorateSearchRegex, ""))
  331. .pipe(addModuleExports(library.moduleDeclaration, true, library.extendsRoot))
  332. }
  333. code = code.pipe(gulp.dest(outputDirectory))
  334. .pipe(cleants())
  335. .pipe(rename({ extname: ".min.js" }))
  336. .pipe(uglify())
  337. .pipe(optimisejs())
  338. .pipe(gulp.dest(outputDirectory));
  339. /*}*/
  340. var dts = tsProcess.dts
  341. .pipe(concat(library.output))
  342. .pipe(replace(referenceSearchRegex, ""))
  343. .pipe(rename({ extname: ".d.ts" }))
  344. .pipe(gulp.dest(outputDirectory));
  345. var waitAll;
  346. if (library.buildAsModule) {
  347. var dts2 = tsProcess.dts
  348. .pipe(concat(library.output))
  349. .pipe(replace(referenceSearchRegex, ""))
  350. .pipe(addDtsExport(library.moduleDeclaration, library.moduleName, true, library.extendsRoot))
  351. .pipe(rename({ extname: ".module.d.ts" }))
  352. .pipe(gulp.dest(outputDirectory));
  353. waitAll = merge2([dev, code, css, dts, dts2]);
  354. } else {
  355. waitAll = merge2([dev, code, css, dts]);
  356. }
  357. if (library.webpack) {
  358. return waitAll.on("end", function () {
  359. return webpack(require(library.webpack))
  360. .pipe(rename(library.output.replace(".js", library.noBundleInName ? '.js' : ".bundle.js")))
  361. .pipe(addModuleExports(library.moduleDeclaration, false, false, true))
  362. .pipe(uglify())
  363. .pipe(optimisejs())
  364. .pipe(gulp.dest(outputDirectory))
  365. });
  366. }
  367. else {
  368. return waitAll;
  369. }
  370. }
  371. }
  372. /**
  373. * The default task, concat and min the main BJS files.
  374. */
  375. gulp.task("default", function (cb) {
  376. runSequence("typescript-all", "intellisense", cb);
  377. });
  378. gulp.task("mainBuild", function (cb) {
  379. runSequence("buildWorker", "build", cb);
  380. });
  381. /**
  382. * Build the releasable files.
  383. */
  384. gulp.task("typescript", function (cb) {
  385. runSequence("typescript-compile", "mainBuild", cb);
  386. });
  387. /**
  388. * Dynamic module creation.
  389. */
  390. config.modules.map(function (module) {
  391. gulp.task(module, function () {
  392. return buildExternalLibraries(config[module]);
  393. });
  394. });
  395. gulp.task("typescript-libraries", config.modules, function () {
  396. });
  397. /**
  398. * Dynamic custom configurations.
  399. */
  400. config.buildConfigurations.distributed.map(function (customConfiguration) {
  401. gulp.task(customConfiguration, function (cb) {
  402. config.build.currentConfig = customConfiguration;
  403. config.build.outputDirectory = config.build.outputCustomConfigurationsDirectory + "/" + customConfiguration;
  404. runSequence("typescript-compile", "build", cb);
  405. });
  406. });
  407. gulp.task("typescript-customConfigurations", function (cb) {
  408. runSequence(config.buildConfigurations.distributed, cb);
  409. });
  410. /**
  411. * Custom build with full path file control; used by profile.html
  412. */
  413. gulp.task("build-custom", function (cb) {
  414. runSequence("typescript-compile", "build", cb);
  415. });
  416. /**
  417. * Do it all.
  418. */
  419. gulp.task("typescript-all", function (cb) {
  420. runSequence("typescript", "typescript-libraries", "typescript-customConfigurations", cb);
  421. });
  422. /**
  423. * Watch ts files and fire repective tasks.
  424. */
  425. gulp.task("watch", [], function () {
  426. var interval = 1000;
  427. var tasks = [gulp.watch(config.typescript, { interval: interval }, ["typescript-compile"])];
  428. config.modules.map(function (module) {
  429. config[module].libraries.map(function (library) {
  430. tasks.push(gulp.watch(library.files, { interval: interval }, function () {
  431. console.log(library.output);
  432. return buildExternalLibrary(library, config[module], true)
  433. .pipe(debug());
  434. }));
  435. tasks.push(gulp.watch(library.shaderFiles, { interval: interval }, function () {
  436. console.log(library.output);
  437. return buildExternalLibrary(library, config[module], true)
  438. .pipe(debug())
  439. }));
  440. tasks.push(gulp.watch(library.sassFiles, { interval: interval }, function () {
  441. console.log(library.output);
  442. return buildExternalLibrary(library, config[module], true)
  443. .pipe(debug())
  444. }));
  445. });
  446. });
  447. return tasks;
  448. });
  449. gulp.task("intellisense", function () {
  450. gulp.src(config.build.intellisenseSources)
  451. .pipe(concat(config.build.intellisenseFile))
  452. .pipe(replace(/^\s*_.*?$/gm, ""))
  453. .pipe(replace(/^\s*private .*?$/gm, ""))
  454. .pipe(replace(/^\s*public _.*?$/gm, ""))
  455. .pipe(replace(/^\s*protected .*?$/gm, ""))
  456. .pipe(replace(/^\s*public static _.*?$/gm, ""))
  457. .pipe(replace(/^\s*static _.*?$/gm, ""))
  458. .pipe(gulp.dest(config.build.playgroundDirectory));
  459. });
  460. /**
  461. * Embedded local dev env management.
  462. */
  463. gulp.task("deployLocalDev", function () {
  464. gulp.src("../../localDev/template/**.*")
  465. .pipe(gulp.dest("../../localDev/src/"));
  466. });
  467. /**
  468. * Embedded webserver for test convenience.
  469. */
  470. gulp.task("webserver", function () {
  471. var options = {
  472. port: 1338,
  473. livereload: false
  474. };
  475. if (commandLineOptions.public) {
  476. options.host = "0.0.0.0";
  477. }
  478. gulp.src("../../.").pipe(webserver(options));
  479. });
  480. /**
  481. * Combine Webserver and Watch as long as vscode does not handle multi tasks.
  482. */
  483. gulp.task("run", ["watch", "webserver"], function () {
  484. });
  485. gulp.task("clean-JS-MAP", function () {
  486. return del([
  487. "../../src/**/*.js.map", "../../src/**/*.js"
  488. ], { force: true });
  489. });