gulpfile.js 54 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520
  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 addDecorateAndExtends = require("./gulp-decorateAndExtends");
  9. var addModuleExports = require("./gulp-addModuleExports");
  10. var addES6Exports = require("./gulp-addES6Exports");
  11. var babylonModuleExports = require("./gulp-babylonModule");
  12. var babylonES6ModuleExports = require("./gulp-es6ModuleExports");
  13. var dtsModuleSupport = require("./gulp-dtsModuleSupport");
  14. let calculateDependencies = require("./gulp-calculateDependencies");
  15. var merge2 = require("merge2");
  16. var concat = require("gulp-concat");
  17. var rename = require("gulp-rename");
  18. var cleants = require("gulp-clean-ts-extends");
  19. var replace = require("gulp-replace");
  20. var uncommentShader = require("./gulp-removeShaderComments");
  21. var expect = require("gulp-expect-file");
  22. var optimisejs = require("gulp-optimize-js");
  23. var connect = require("gulp-connect");
  24. var path = require("path");
  25. const webpack = require('webpack');
  26. var webpackStream = require("webpack-stream");
  27. var typedoc = require("gulp-typedoc");
  28. var validateTypedoc = require("./gulp-validateTypedoc");
  29. var fs = require("fs");
  30. var dtsBundle = require('dts-bundle');
  31. const through = require('through2');
  32. var karmaServer = require('karma').Server;
  33. var gulpTslint = require("gulp-tslint");
  34. var tslint = require("tslint");
  35. const filter = require('gulp-filter');
  36. var cors = require('cors');
  37. //viewer declaration
  38. var processDeclaration = require('./processViewerDeclaration');
  39. var config = require("./config.json");
  40. var del = require("del");
  41. var debug = require("gulp-debug");
  42. var includeShadersStream;
  43. var shadersStream;
  44. var workersStream;
  45. var extendsSearchRegex = /var\s__extends[\s\S]+?\}\)\(\);/g;
  46. var decorateSearchRegex = /var\s__decorate[\s\S]+?\};/g;
  47. var referenceSearchRegex = /\/\/\/ <reference.*/g;
  48. /**
  49. * TS configurations shared in the gulp file.
  50. */
  51. var tsConfig = {
  52. noResolve: true,
  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. strictFunctionTypes: true,
  64. types: [],
  65. lib: [
  66. "dom",
  67. "es2015.promise",
  68. "es5"
  69. ]
  70. };
  71. var tsProject = typescript.createProject(tsConfig);
  72. var externalTsConfig = {
  73. noResolve: false,
  74. target: "ES5",
  75. declarationFiles: true,
  76. typescript: require("typescript"),
  77. experimentalDecorators: true,
  78. isolatedModules: false,
  79. noImplicitAny: true,
  80. noImplicitReturns: true,
  81. noImplicitThis: true,
  82. noUnusedLocals: true,
  83. strictNullChecks: true,
  84. types: [],
  85. lib: [
  86. "dom",
  87. "es2015.promise",
  88. "es5"
  89. ]
  90. };
  91. var minimist = require("minimist");
  92. var commandLineOptions = minimist(process.argv.slice(2), {
  93. boolean: ["public", "tsLintFix"]
  94. });
  95. var tsLintFix = commandLineOptions.tsLintFix
  96. function processDependency(kind, dependency, filesToLoad, firstLevelOnly) {
  97. if (!firstLevelOnly && dependency.dependUpon) {
  98. for (var i = 0; i < dependency.dependUpon.length; i++) {
  99. var dependencyName = dependency.dependUpon[i];
  100. var parent = config.workloads[dependencyName];
  101. processDependency(kind, parent, filesToLoad);
  102. }
  103. }
  104. var content = dependency[kind];
  105. if (!content) {
  106. return;
  107. }
  108. for (var i = 0; i < content.length; i++) {
  109. var file = content[i];
  110. if (filesToLoad.indexOf(file) === -1) {
  111. filesToLoad.push(file);
  112. }
  113. }
  114. }
  115. function determineFilesToProcess(kind) {
  116. var currentConfig = config.build.currentConfig;
  117. var buildConfiguration = config.buildConfigurations[currentConfig];
  118. var filesToLoad = [];
  119. for (var index = 0; index < buildConfiguration.length; index++) {
  120. var dependencyName = buildConfiguration[index];
  121. var dependency = config.workloads[dependencyName];
  122. if (kind === "directFiles" && !dependency) {
  123. filesToLoad.push("../../dist/preview release/" + dependencyName);
  124. }
  125. else if (dependency) {
  126. processDependency(kind, dependency, filesToLoad);
  127. }
  128. }
  129. if (kind === "shaderIncludes") {
  130. for (var index = 0; index < filesToLoad.length; index++) {
  131. filesToLoad[index] = "../../src/Shaders/ShadersInclude/" + filesToLoad[index] + ".fx";
  132. }
  133. } else if (kind === "shaders") {
  134. for (var index = 0; index < filesToLoad.length; index++) {
  135. var name = filesToLoad[index];
  136. filesToLoad[index] = "../../src/Shaders/" + filesToLoad[index] + ".fx";
  137. }
  138. }
  139. return filesToLoad;
  140. }
  141. /*
  142. * Shader Management.
  143. */
  144. function shadersName(filename) {
  145. return path.basename(filename)
  146. .replace(".fragment", "Pixel")
  147. .replace(".vertex", "Vertex")
  148. .replace(".fx", "Shader");
  149. }
  150. function includeShadersName(filename) {
  151. return path.basename(filename).replace(".fx", "");
  152. }
  153. /*
  154. * Main necessary files stream Management.
  155. */
  156. gulp.task("includeShaders", function(cb) {
  157. var filesToProcess = determineFilesToProcess("shaderIncludes");
  158. includeShadersStream = gulp.src(filesToProcess).
  159. pipe(expect.real({ errorOnFailure: true }, filesToProcess)).
  160. pipe(uncommentShader()).
  161. pipe(srcToVariable({
  162. variableName: "BABYLON.Effect.IncludesShadersStore", asMap: true, namingCallback: includeShadersName
  163. }));
  164. cb();
  165. });
  166. gulp.task("shaders", gulp.series("includeShaders", function(cb) {
  167. var filesToProcess = determineFilesToProcess("shaders");
  168. shadersStream = gulp.src(filesToProcess).
  169. pipe(expect.real({ errorOnFailure: true }, filesToProcess)).
  170. pipe(uncommentShader()).
  171. pipe(srcToVariable({
  172. variableName: "BABYLON.Effect.ShadersStore", asMap: true, namingCallback: shadersName
  173. }));
  174. cb();
  175. }));
  176. gulp.task("workers", function(cb) {
  177. workersStream = config.workers.map(function(workerDef) {
  178. return gulp.src(workerDef.files).
  179. pipe(expect.real({ errorOnFailure: true }, workerDef.files)).
  180. pipe(uglify()).
  181. pipe(srcToVariable({
  182. variableName: workerDef.variable
  183. }));
  184. });
  185. cb();
  186. });
  187. /**
  188. * Build tasks to concat minify uflify optimise the BJS js in different flavor (workers...).
  189. */
  190. gulp.task("buildWorker", gulp.series(gulp.parallel("workers", "shaders"), function() {
  191. var filesToProcess = determineFilesToProcess("files");
  192. return merge2(
  193. gulp.src(filesToProcess).
  194. pipe(expect.real({ errorOnFailure: true }, filesToProcess)),
  195. shadersStream,
  196. includeShadersStream,
  197. workersStream
  198. )
  199. .pipe(concat(config.build.minWorkerFilename))
  200. .pipe(cleants())
  201. .pipe(replace(extendsSearchRegex, ""))
  202. .pipe(replace(decorateSearchRegex, ""))
  203. .pipe(addDecorateAndExtends())
  204. .pipe(addModuleExports("BABYLON", {
  205. dependencies: config.build.dependencies
  206. }))
  207. .pipe(uglify())
  208. .pipe(optimisejs())
  209. .pipe(gulp.dest(config.build.outputDirectory));
  210. }));
  211. gulp.task("build", gulp.series("shaders", function build() {
  212. var filesToProcess = determineFilesToProcess("files");
  213. var directFilesToProcess = determineFilesToProcess("directFiles");
  214. let mergedStreams = merge2(gulp.src(filesToProcess)
  215. .pipe(expect.real({ errorOnFailure: true }, filesToProcess)),
  216. shadersStream,
  217. includeShadersStream);
  218. if (directFilesToProcess.length) {
  219. mergedStreams.add(gulp.src(directFilesToProcess));
  220. }
  221. return merge2(
  222. mergedStreams
  223. .pipe(concat(config.build.noModuleFilename))
  224. .pipe(cleants())
  225. .pipe(replace(extendsSearchRegex, ""))
  226. .pipe(replace(decorateSearchRegex, ""))
  227. .pipe(addDecorateAndExtends())
  228. .pipe(gulp.dest(config.build.outputDirectory))
  229. .pipe(rename(config.build.filename))
  230. .pipe(addModuleExports("BABYLON", {
  231. dependencies: config.build.dependencies
  232. }))
  233. .pipe(gulp.dest(config.build.outputDirectory))
  234. .pipe(rename(config.build.minFilename))
  235. .pipe(uglify())
  236. .pipe(optimisejs())
  237. .pipe(gulp.dest(config.build.outputDirectory)),
  238. mergedStreams
  239. .pipe(concat("es6.js"))
  240. .pipe(cleants())
  241. .pipe(replace(extendsSearchRegex, ""))
  242. .pipe(replace(decorateSearchRegex, ""))
  243. .pipe(addES6Exports("BABYLON"))
  244. .pipe(gulp.dest(config.build.outputDirectory))
  245. );
  246. }));
  247. /*
  248. * TsLint all typescript files from the src directory.
  249. */
  250. gulp.task("typescript-tsLint", function() {
  251. const dtsFilter = filter(['**', '!**/*.d.ts'], { restore: false });
  252. return gulp.src(config.typescript)
  253. .pipe(dtsFilter)
  254. .pipe(gulpTslint({
  255. formatter: "stylish",
  256. configuration: "../../tslint.json",
  257. fix: tsLintFix
  258. }))
  259. .pipe(gulpTslint.report());
  260. });
  261. /*
  262. * TsLint all typescript files from the src directory.
  263. */
  264. var tsLintExternalLibrary = function(library, settings, watch) {
  265. if (library.files && library.files.length) {
  266. return gulp.src(library.files, { base: settings.build.srcOutputDirectory })
  267. .pipe(gulpTslint({
  268. formatter: "stylish",
  269. configuration: "../../tslint.json",
  270. fix: tsLintFix
  271. }))
  272. .pipe(gulpTslint.report());
  273. }
  274. else {
  275. return gulp.src((settings.build.srcDirectory || settings.build.srcOutputDirectory) + "/**/*.ts")
  276. .pipe(gulpTslint({
  277. formatter: "stylish",
  278. configuration: "../../tslint.json",
  279. fix: tsLintFix
  280. }))
  281. .pipe(gulpTslint.report());
  282. }
  283. }
  284. /**
  285. * Helper methods to tsLint external library (mat, post processes, ...).
  286. */
  287. var tsLintExternalLibraries = function(settings) {
  288. var tasks = settings.libraries.map(function(library) {
  289. return tsLintExternalLibrary(library, settings, false);
  290. });
  291. let mergedTasks = merge2(tasks);
  292. return mergedTasks;
  293. }
  294. /**
  295. * Dynamic module creation tsLint.
  296. */
  297. config.modules.map(function(module) {
  298. gulp.task(module + "-tsLint", function() {
  299. return tsLintExternalLibraries(config[module]);
  300. });
  301. });
  302. /**
  303. * Full Librairies tsLint.
  304. */
  305. gulp.task("typescript-libraries-tsLint",
  306. gulp.series(config.modules.map((module) => {
  307. return module + "-tsLint";
  308. })
  309. ));
  310. /**
  311. * Full TsLint.
  312. */
  313. gulp.task("tsLint", gulp.series("typescript-tsLint", "typescript-libraries-tsLint"));
  314. /*
  315. * Compiles all typescript files and creating a js and a declaration file.
  316. */
  317. gulp.task("typescript-compile", function() {
  318. const dtsFilter = filter(['**', '!**/*.d.ts'], { restore: false });
  319. var tsResult = gulp.src(config.typescript)
  320. .pipe(dtsFilter)
  321. .pipe(sourcemaps.init())
  322. .pipe(tsProject({
  323. summarizeFailureOutput: true
  324. }));
  325. tsResult.once("error", function(err) {
  326. tsResult.once("finish", function() {
  327. console.log("Typescript compile failed");
  328. console.error(err);
  329. process.exit(1);
  330. });
  331. });
  332. return merge2([
  333. tsResult.dts
  334. .pipe(concat(config.build.declarationFilename))
  335. .pipe(addDtsExport("BABYLON", "babylonjs"))
  336. .pipe(gulp.dest(config.build.outputDirectory)),
  337. tsResult.js
  338. .pipe(sourcemaps.write("./",
  339. {
  340. includeContent: false,
  341. sourceRoot: (filePath) => {
  342. return "";
  343. }
  344. }))
  345. .pipe(gulp.dest(config.build.srcOutputDirectory))
  346. ])
  347. });
  348. /**
  349. * Helper methods to build external library (mat, post processes, ...).
  350. */
  351. var buildExternalLibraries = function(settings) {
  352. var tasks = settings.libraries.map(function(library) {
  353. return buildExternalLibrary(library, settings, false);
  354. });
  355. let mergedTasks = merge2(tasks);
  356. if (settings.build.buildAsModule) {
  357. mergedTasks.on("end", function() {
  358. //generate js file list
  359. let files = settings.libraries.filter(function(lib) {
  360. return !lib.doNotIncludeInBundle;
  361. }).map(function(lib) {
  362. return config.build.outputDirectory + settings.build.distOutputDirectory + lib.output;
  363. });
  364. var outputDirectory = config.build.outputDirectory + settings.build.distOutputDirectory;
  365. let srcTask = gulp.src(files)
  366. .pipe(concat(settings.build.outputFilename + ".js"))
  367. .pipe(replace(extendsSearchRegex, ""))
  368. .pipe(replace(decorateSearchRegex, ""))
  369. .pipe(replace(referenceSearchRegex, ""))
  370. .pipe(addDecorateAndExtends())
  371. .pipe(addModuleExports(settings.build.moduleDeclaration, { subModule: true, extendsRoot: settings.build.extendsRoot }))
  372. .pipe(gulp.dest(outputDirectory))
  373. .pipe(cleants())
  374. .pipe(rename({ extname: ".min.js" }))
  375. .pipe(uglify())
  376. .pipe(optimisejs())
  377. .pipe(gulp.dest(outputDirectory));
  378. let dtsFiles = files.map(function(filename) {
  379. return filename.replace(".js", ".d.ts");
  380. });
  381. let dtsModuleTask = gulp.src(dtsFiles)
  382. .pipe(concat(settings.build.outputFilename + ".module.d.ts"))
  383. .pipe(replace(referenceSearchRegex, ""))
  384. .pipe(addDtsExport(settings.build.moduleDeclaration, settings.build.moduleName, true, settings.build.extendsRoot, settings.build.extraTypesDependencies))
  385. .pipe(gulp.dest(outputDirectory));
  386. let dtsTask = gulp.src(dtsFiles)
  387. .pipe(concat(settings.build.outputFilename + ".d.ts"))
  388. .pipe(replace(referenceSearchRegex, ""))
  389. .pipe(gulp.dest(outputDirectory));
  390. return merge2([srcTask, dtsTask, dtsModuleTask]);
  391. });
  392. }
  393. return mergedTasks;
  394. }
  395. var buildExternalLibrary = function(library, settings, watch) {
  396. var tsProcess;
  397. if (library.files && library.files.length) {
  398. tsProcess = gulp.src(library.files, { base: settings.build.srcOutputDirectory })
  399. .pipe(sourcemaps.init())
  400. .pipe(typescript(externalTsConfig));
  401. }
  402. let tasks = [];
  403. let shaderTask;
  404. let shadersIndlueTask;
  405. if (library.shadersIncludeFiles && library.shadersIncludeFiles.length) {
  406. shadersIndlueTask = gulp.src(library.shadersIncludeFiles, { base: settings.build.srcOutputDirectory })
  407. .pipe(uncommentShader())
  408. .pipe(appendSrcToVariable("BABYLON.Effect.IncludesShadersStore", includeShadersName, library.output + ".include.fx"))
  409. .pipe(gulp.dest(settings.build.srcOutputDirectory));
  410. tasks.push(shadersIndlueTask);
  411. }
  412. if (library.shaderFiles && library.shaderFiles.length) {
  413. shaderTask = gulp.src(library.shaderFiles, { base: settings.build.srcOutputDirectory })
  414. .pipe(uncommentShader())
  415. .pipe(appendSrcToVariable("BABYLON.Effect.ShadersStore", shadersName, library.output + ".fx"))
  416. .pipe(gulp.dest(settings.build.srcOutputDirectory));
  417. tasks.push(shaderTask);
  418. }
  419. var dev;
  420. if (tsProcess) {
  421. dev = tsProcess.js
  422. .pipe(sourcemaps.write("./", {
  423. includeContent: false,
  424. sourceRoot: (filePath) => {
  425. return "";
  426. }
  427. })).pipe(gulp.dest(settings.build.srcOutputDirectory));
  428. tasks.push(dev);
  429. }
  430. var outputDirectory = config.build.outputDirectory + settings.build.distOutputDirectory;
  431. /*let cssTask;
  432. if (library.sassFiles && library.sassFiles.length) {
  433. cssTask = gulp.src(library.sassFiles)
  434. .pipe(sass().on("error", sass.logError))
  435. .pipe(concat(library.output.replace(".js", ".css")))
  436. .pipe(gulp.dest(outputDirectory));
  437. tasks.push(cssTask);
  438. }*/
  439. if (watch) {
  440. return merge2(tasks);
  441. }
  442. else {
  443. /*if (library.bundle) {
  444. // Don't remove extends and decorate functions
  445. var code = merge2([tsProcess.js, shader, includeShader])
  446. .pipe(concat(library.output));
  447. if (library.buildAsModule) {
  448. code = code.pipe(addModuleExports(library.moduleDeclaration, true))
  449. }
  450. code.pipe(gulp.dest(outputDirectory))
  451. .pipe(cleants())
  452. .pipe(rename({ extname: ".min.js" }))
  453. .pipe(uglify())
  454. .pipe(optimisejs())
  455. .pipe(gulp.dest(outputDirectory));
  456. } else {*/
  457. let currentTasks = [];
  458. if (tsProcess) {
  459. currentTasks.push(tsProcess.js);
  460. }
  461. if (shaderTask) {
  462. currentTasks.push(shaderTask);
  463. }
  464. if (shadersIndlueTask) {
  465. currentTasks.push(shadersIndlueTask);
  466. }
  467. var code;
  468. if (currentTasks.length) {
  469. code = merge2(currentTasks)
  470. .pipe(concat(library.output));
  471. }
  472. if (library.buildAsModule && code) {
  473. code = code.pipe(replace(extendsSearchRegex, ""))
  474. .pipe(replace(decorateSearchRegex, ""))
  475. .pipe(addDecorateAndExtends())
  476. .pipe(addModuleExports(library.moduleDeclaration, { subModule: true, extendsRoot: library.extendsRoot }))
  477. }
  478. if (code) {
  479. code = code.pipe(gulp.dest(outputDirectory))
  480. .pipe(cleants())
  481. .pipe(rename({ extname: ".min.js" }))
  482. .pipe(uglify())
  483. .pipe(optimisejs())
  484. .pipe(gulp.dest(outputDirectory));
  485. /*}*/
  486. }
  487. var dts;
  488. if (tsProcess) {
  489. dts = tsProcess.dts
  490. .pipe(concat(library.output))
  491. .pipe(replace(referenceSearchRegex, ""))
  492. .pipe(rename({ extname: ".d.ts" }))
  493. .pipe(gulp.dest(outputDirectory));
  494. }
  495. var waitAll;
  496. let waitAllTasks = [];
  497. /*if (cssTask) {
  498. waitAllTasks.push(cssTask);
  499. }*/
  500. if (dev) {
  501. waitAllTasks.push(dev);
  502. }
  503. if (code) {
  504. waitAllTasks.push(code);
  505. }
  506. if (dts) {
  507. waitAllTasks.push(dts);
  508. }
  509. if (library.buildAsModule && tsProcess) {
  510. var dts2 = tsProcess.dts
  511. .pipe(concat(library.output))
  512. .pipe(replace(referenceSearchRegex, ""))
  513. .pipe(addDtsExport(library.moduleDeclaration, library.moduleName, true, library.extendsRoot, config.build.extraTypesDependencies))
  514. .pipe(rename({ extname: ".module.d.ts" }))
  515. .pipe(gulp.dest(outputDirectory));
  516. waitAllTasks.push(dts2);
  517. }
  518. if (waitAllTasks.length) {
  519. waitAll = merge2(waitAllTasks);
  520. }
  521. if (library.webpack) {
  522. let sequence = [];
  523. if (waitAll) {
  524. sequence.push(waitAll);
  525. }
  526. if (settings.build.outputs) {
  527. settings.build.outputs.forEach(out => {
  528. let wpConfig = require(library.webpack);
  529. if (!out.minified) {
  530. wpConfig.mode = "development";
  531. }
  532. let wpBuild = webpackStream(wpConfig, require("webpack"));
  533. //shoud dtsBundle create the declaration?
  534. if (settings.build.dtsBundle) {
  535. let event = wpBuild
  536. .pipe(through.obj(function(file, enc, cb) {
  537. // only declaration files
  538. const isdts = /\.d\.ts$/.test(file.path);
  539. if (isdts) this.push(file);
  540. cb();
  541. }))
  542. .pipe(gulp.dest(outputDirectory));
  543. // dts-bundle does NOT support (gulp) streams, so files have to be saved and reloaded,
  544. // until I fix it
  545. event.on("end", function() {
  546. // create the file
  547. dtsBundle.bundle(settings.build.dtsBundle);
  548. // prepend the needed reference
  549. let fileLocation = path.join(path.dirname(settings.build.dtsBundle.main), settings.build.dtsBundle.out);
  550. fs.readFile(fileLocation, function(err, data) {
  551. if (err) throw err;
  552. data = (settings.build.dtsBundle.prependText || "") + '\n' + data.toString();
  553. fs.writeFileSync(fileLocation, data);
  554. if (settings.build.processDeclaration) {
  555. var newData = processDeclaration(data, settings.build.processDeclaration);
  556. fs.writeFileSync(fileLocation.replace('.module', ''), newData);
  557. }
  558. });
  559. });
  560. }
  561. let build = wpBuild
  562. .pipe(through.obj(function(file, enc, cb) {
  563. // only pipe js files
  564. const isJs = /\.js$/.test(file.path);
  565. if (isJs) this.push(file);
  566. cb();
  567. }))
  568. .pipe(addModuleExports(library.moduleDeclaration, { subModule: false, extendsRoot: false, externalUsingBabylon: true, noBabylonInit: library.babylonIncluded }));
  569. function processDestination(dest) {
  570. var outputDirectory = config.build.outputDirectory + dest.outputDirectory;
  571. build = build
  572. .pipe(rename(dest.filename.replace(".js", library.noBundleInName ? '.js' : ".bundle.js")))
  573. .pipe(gulp.dest(outputDirectory));
  574. if (library.babylonIncluded && dest.addBabylonDeclaration) {
  575. // include the babylon declaration
  576. if (dest.addBabylonDeclaration === true) {
  577. dest.addBabylonDeclaration = [config.build.declarationFilename];
  578. }
  579. var decsToAdd = dest.addBabylonDeclaration.map(function(dec) {
  580. return config.build.outputDirectory + '/' + dec;
  581. });
  582. sequence.unshift(gulp.src(decsToAdd)
  583. .pipe(rename(function(path) {
  584. path.dirname = '';
  585. }))
  586. .pipe(gulp.dest(outputDirectory)))
  587. }
  588. }
  589. out.destinations.forEach(dest => {
  590. processDestination(dest);
  591. });
  592. sequence.push(build);
  593. });
  594. } else {
  595. let wpBuild = webpackStream(require(library.webpack), webpack);
  596. let buildEvent = wpBuild
  597. .pipe(gulp.dest(outputDirectory))
  598. //back-compat
  599. .pipe(through.obj(function(file, enc, cb) {
  600. // only js files
  601. const isjs = /\.js$/.test(file.path);
  602. if (isjs) this.push(file);
  603. cb();
  604. }))
  605. .pipe(rename(function(path) {
  606. //path.extname === ".js"
  607. path.basename = path.basename.replace(".min", "")
  608. })).pipe(gulp.dest(outputDirectory));
  609. sequence.push(
  610. buildEvent
  611. );
  612. if (settings.build.dtsBundle || settings.build.processDeclaration) {
  613. buildEvent.on("end", function() {
  614. if (settings.build.dtsBundle) {
  615. dtsBundle.bundle(settings.build.dtsBundle);
  616. } if (settings.build.processDeclaration) {
  617. let fileLocation = path.join(outputDirectory, settings.build.processDeclaration.filename);
  618. fs.readFile(fileLocation, function(err, data) {
  619. if (err) throw err;
  620. // For Raanan,litera litteral import hack TO BETTER INTEGRATE
  621. data = data + "";
  622. data = data.replace('import "../sass/main.scss";', "");
  623. var newData = processDeclaration(data, settings.build.processDeclaration);
  624. fs.writeFileSync(fileLocation.replace('.module', ''), newData);
  625. //legacy module support
  626. fs.writeFileSync(fileLocation, data + "\n" + newData);
  627. });
  628. }
  629. });
  630. }
  631. /*if (settings.build.processDeclaration) {
  632. sequence.push(
  633. wpBuild
  634. .pipe(through.obj(function (file, enc, cb) {
  635. // only js files
  636. const isDts = /\.d.ts$/.test(file.path);
  637. file.contents = new Buffer(processDeclaration(file.contents, settings.build.processDeclaration));
  638. if (isDts) this.push(file);
  639. cb();
  640. }))
  641. .pipe(gulp.dest(outputDirectory))
  642. )
  643. }*/
  644. }
  645. return merge2(sequence);
  646. }
  647. else {
  648. return waitAll || Promise.resolve();
  649. }
  650. }
  651. }
  652. gulp.task("mainBuild", gulp.series("buildWorker", "build"));
  653. /**
  654. * Build the releasable files.
  655. */
  656. gulp.task("typescript", gulp.series("typescript-compile", "mainBuild"));
  657. /**
  658. * Dynamic module creation.
  659. */
  660. config.modules.map(function(module) {
  661. gulp.task(module, function() {
  662. return buildExternalLibraries(config[module]);
  663. });
  664. });
  665. gulp.task("typescript-libraries", gulp.series(config.modules));
  666. /**
  667. * Custom build with full path file control; used by profile.html
  668. */
  669. gulp.task("build-custom", gulp.series("typescript-compile", "build"));
  670. /**
  671. * Watch ts files from typescript .
  672. */
  673. gulp.task("srcTscWatch", function() {
  674. // Reuse The TSC CLI from gulp to enable -w.
  675. process.argv[2] = "-w";
  676. process.argv[3] = "-p";
  677. process.argv[4] = "../../src/tsconfig.json";
  678. require("./node_modules/typescript/lib/tsc.js");
  679. return Promise.resolve();
  680. });
  681. /**
  682. * Watch ts files and fire repective tasks.
  683. */
  684. gulp.task("watch", gulp.series("srcTscWatch", function startWatch() {
  685. var interval = 1000;
  686. var tasks = [];
  687. config.modules.map(function(module) {
  688. config[module].libraries.map(function(library) {
  689. if (library.webpack) {
  690. if (library.noWatch) return;
  691. var outputDirectory = config.build.tempDirectory + config[module].build.distOutputDirectory;
  692. let wpconfig = require(library.webpack);
  693. wpconfig.watch = true;
  694. // dev mode and absolute path sourcemaps for debugging
  695. wpconfig.mode = "development";
  696. wpconfig.output.devtoolModuleFilenameTemplate = "[absolute-resource-path]";
  697. //config.stats = "minimal";
  698. tasks.push(webpackStream(wpconfig, webpack).pipe(gulp.dest(outputDirectory)))
  699. } else {
  700. if (library.files) {
  701. tasks.push(gulp.watch(library.files, { interval: interval }, function() {
  702. console.log(library.output);
  703. return buildExternalLibrary(library, config[module], true)
  704. .pipe(debug());
  705. }));
  706. }
  707. if (library.shaderFiles) {
  708. tasks.push(gulp.watch(library.shaderFiles, { interval: interval }, function() {
  709. console.log(library.output);
  710. return buildExternalLibrary(library, config[module], true)
  711. .pipe(debug())
  712. }));
  713. }
  714. if (library.sassFiles) {
  715. tasks.push(gulp.watch(library.sassFiles, { interval: interval }, function() {
  716. console.log(library.output);
  717. return buildExternalLibrary(library, config[module], true)
  718. .pipe(debug())
  719. }));
  720. }
  721. }
  722. });
  723. });
  724. console.log(tasks.length);
  725. return Promise.resolve();
  726. }));
  727. gulp.task("intellisense", function() {
  728. return gulp.src(config.build.intellisenseSources)
  729. .pipe(concat(config.build.intellisenseFile))
  730. .pipe(replace(/^\s+_.*?;/gm, ""))
  731. .pipe(replace(/^\s+_[\S\s]*?}/gm, ""))
  732. .pipe(replace(/^\s*readonly _/gm, "protected readonly _"))
  733. .pipe(replace(/^\s*static _/gm, "private static _"))
  734. .pipe(replace(/^\s*abstract _/gm, ""))
  735. .pipe(gulp.dest(config.build.playgroundDirectory));
  736. });
  737. /**
  738. * Embedded local dev env management.
  739. */
  740. gulp.task("deployLocalDev", function() {
  741. return gulp.src("../../localDev/template/**.*")
  742. .pipe(gulp.dest("../../localDev/src/"));
  743. });
  744. /**
  745. * Embedded webserver for test convenience.
  746. */
  747. gulp.task("webserver", function() {
  748. var options = {
  749. root: "../../.",
  750. port: 1338,
  751. livereload: false,
  752. middleware: function() {
  753. return [cors()];
  754. }
  755. };
  756. if (commandLineOptions.public) {
  757. options.host = "0.0.0.0";
  758. }
  759. connect.server(options);
  760. });
  761. /**
  762. * Combine Webserver and Watch as long as vscode does not handle multi tasks.
  763. */
  764. gulp.task("run", gulp.series("watch", "webserver"));
  765. /**
  766. * Cleans map and js files from the src folder.
  767. */
  768. gulp.task("clean-JS-MAP", function() {
  769. return del([
  770. "../../src/**/*.js.map", "../../src/**/*.js"
  771. ], { force: true });
  772. });
  773. gulp.task("netlify-cleanup", function() {
  774. //set by netlify
  775. if (process.env.REPOSITORY_URL) {
  776. return del([
  777. "../../inspector/node_modules/**/*", "../../gui/node_modules/**/*",
  778. "../../Viewer/node_modules/**/*"
  779. ], { force: true });
  780. }
  781. else {
  782. return Promise.resolve();
  783. }
  784. })
  785. // this is needed for the modules for the declaration files.
  786. gulp.task("modules-compile", function() {
  787. const dtsFilter = filter(['**', '!**/*.d.ts'], { restore: false });
  788. var tsResult = gulp.src(config.typescript)
  789. .pipe(dtsFilter)
  790. .pipe(sourcemaps.init())
  791. .pipe(tsProject());
  792. // If this gulp task is running on travis
  793. tsResult.once("error", function(err) {
  794. tsResult.once("finish", function() {
  795. console.log("Typescript compile failed");
  796. console.error(err);
  797. process.exit(1);
  798. });
  799. });
  800. return merge2([
  801. tsResult.dts
  802. .pipe(gulp.dest(config.build.srcOutputDirectory)),
  803. tsResult.js
  804. .pipe(sourcemaps.write("./",
  805. {
  806. includeContent: false,
  807. sourceRoot: (filePath) => {
  808. return "";
  809. }
  810. }))
  811. .pipe(gulp.dest(config.build.srcOutputDirectory))
  812. ]);
  813. });
  814. // this holds the declared objects in each module
  815. let declared = {}
  816. let perFile = {};
  817. let dependencyTree = {};
  818. gulp.task('prepare-for-modules', /*["modules-compile"],*/ function() {
  819. let tasks = [];
  820. Object.keys(config.workloads).forEach((moduleName) => {
  821. let dtsFiles = config.workloads[moduleName].files.map(f => f.replace(".js", ".d.ts"))
  822. let dtsTask = gulp.src(dtsFiles)
  823. .pipe(dtsModuleSupport(moduleName, false, declared, perFile));
  824. tasks.push(dtsTask);
  825. });
  826. // now calculate internal dependencies in the .ts files!
  827. /*Object.keys(config.workloads).forEach((moduleName) => {
  828. let tsFiles = config.workloads[moduleName].files.map(f => f.replace(".js", ".ts"))
  829. let depTask = gulp.src(tsFiles)
  830. .pipe(calculateDependencies(moduleName, perFile, dependencyTree));
  831. tasks.push(depTask);
  832. });*/
  833. return merge2(tasks);
  834. });
  835. gulp.task('prepare-dependency-tree', gulp.series("prepare-for-modules", function() {
  836. let tasks = [];
  837. // now calculate internal dependencies in the .ts files!
  838. Object.keys(config.workloads).forEach((moduleName) => {
  839. let tsFiles = config.workloads[moduleName].files.map(f => f.replace(".js", ".ts"))
  840. let depTask = gulp.src(tsFiles)
  841. .pipe(calculateDependencies(moduleName, perFile, declared, dependencyTree));
  842. tasks.push(depTask);
  843. });
  844. return merge2(tasks);
  845. }));
  846. // generate the modules directory, along with commonjs modules and es6 modules
  847. // Note - the generated modules are UNMINIFIED! The user will choose whether they want to minify or not.
  848. gulp.task("modules", gulp.series("prepare-dependency-tree", function() {
  849. let tasks = [];
  850. Object.keys(config.workloads)
  851. .forEach((moduleName) => {
  852. let shadersFiles = [];
  853. processDependency("shaders", config.workloads[moduleName], shadersFiles, true);
  854. for (var index = 0; index < shadersFiles.length; index++) {
  855. shadersFiles[index] = "../../src/Shaders/" + shadersFiles[index] + ".fx";
  856. }
  857. let shaderIncludeFiles = [];
  858. processDependency("shaderIncludes", config.workloads[moduleName], shaderIncludeFiles, true);
  859. for (var index = 0; index < shaderIncludeFiles.length; index++) {
  860. shaderIncludeFiles[index] = "../../src/Shaders/ShadersInclude/" + shaderIncludeFiles[index] + ".fx";
  861. }
  862. let commonJsTask = merge2([
  863. gulp.src(config.workloads[moduleName].files)
  864. .pipe(replace(extendsSearchRegex, ""))
  865. .pipe(replace(decorateSearchRegex, ""))
  866. .pipe(replace(referenceSearchRegex, ""))
  867. .pipe(replace(/var BABYLON;\n/g, ""))
  868. .pipe(babylonModuleExports(moduleName, dependencyTree, false, perFile, shadersFiles.length, shaderIncludeFiles.length))
  869. .pipe(rename(function(path) {
  870. path.basename = path.basename.split(".").pop()
  871. path.extname = ".js"
  872. })),
  873. gulp.src(shadersFiles)
  874. .pipe(expect.real({ errorOnFailure: true }, shadersFiles))
  875. .pipe(uncommentShader())
  876. .pipe(appendSrcToVariable("BABYLON.Effect.ShadersStore", shadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".fx", "commonjs"))
  877. .pipe(rename("shaders.js")),
  878. gulp.src(shaderIncludeFiles)
  879. .pipe(expect.real({ errorOnFailure: true }, shaderIncludeFiles))
  880. .pipe(uncommentShader())
  881. .pipe(appendSrcToVariable("BABYLON.Effect.IncludesShadersStore", includeShadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".include.fx", "commonjs"))
  882. .pipe(rename("shaderIncludes.js")),
  883. gulp.src(config.workloads[moduleName].files)
  884. .pipe(concat('index.js'))
  885. .pipe(babylonModuleExports(moduleName, dependencyTree, true, perFile))
  886. ]).pipe(gulp.dest(config.build.outputDirectory + '/modules/' + moduleName + '/'))
  887. let es6Tasks = merge2([
  888. gulp.src(config.workloads[moduleName].files)
  889. .pipe(replace(extendsSearchRegex, ""))
  890. .pipe(replace(decorateSearchRegex, ""))
  891. .pipe(replace(referenceSearchRegex, ""))
  892. .pipe(replace(/var BABYLON;\n/g, ""))
  893. .pipe(babylonES6ModuleExports(moduleName, dependencyTree, false, perFile, shadersFiles.length, shaderIncludeFiles.length))
  894. .pipe(rename(function(path) {
  895. path.basename = path.basename.split(".").pop()
  896. path.extname = ".js"
  897. })),
  898. gulp.src(shadersFiles)
  899. .pipe(expect.real({ errorOnFailure: true }, shadersFiles))
  900. .pipe(uncommentShader())
  901. .pipe(appendSrcToVariable("BABYLON.Effect.ShadersStore", shadersName, config.build.outputDirectory + '/es6/' + moduleName + ".fx", "es6"))
  902. .pipe(rename("shaders.js")),
  903. gulp.src(shaderIncludeFiles)
  904. .pipe(expect.real({ errorOnFailure: true }, shaderIncludeFiles))
  905. .pipe(uncommentShader())
  906. .pipe(appendSrcToVariable("BABYLON.Effect.IncludesShadersStore", includeShadersName, config.build.outputDirectory + '/es6/' + moduleName + ".include.fx", "es6"))
  907. .pipe(rename("shaderIncludes.js")),
  908. gulp.src(config.workloads[moduleName].files)
  909. .pipe(concat('index.js'))
  910. .pipe(babylonES6ModuleExports(moduleName, dependencyTree, true, perFile))
  911. ]).pipe(gulp.dest(config.build.outputDirectory + '/modules/' + moduleName + '/es6/'))
  912. //commonjs js generation task
  913. /*let jsTask = merge2([
  914. gulp.src(config.workloads[moduleName].files),
  915. gulp.src(shadersFiles).
  916. //pipe(expect.real({ errorOnFailure: true }, shadersFiles)).
  917. pipe(uncommentShader()).
  918. pipe(appendSrcToVariable("BABYLON.Effect.ShadersStore", shadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".fx", true)),
  919. gulp.src(shaderIncludeFiles).
  920. //pipe(expect.real({ errorOnFailure: true }, shaderIncludeFiles)).
  921. pipe(uncommentShader()).
  922. pipe(appendSrcToVariable("BABYLON.Effect.IncludesShadersStore", includeShadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".include.fx", true))
  923. ]).pipe(concat('index.js'))
  924. .pipe(replace(extendsSearchRegex, ""))
  925. .pipe(replace(decorateSearchRegex, ""))
  926. .pipe(replace(referenceSearchRegex, ""))
  927. .pipe(babylonModuleExports(moduleName, config.workloads[moduleName].dependUpon))
  928. .pipe(gulp.dest(config.build.outputDirectory + '/modules/' + moduleName + '/'));*/
  929. // es6 modules generation task
  930. /*let es6Task = merge2([
  931. gulp.src(config.workloads[moduleName].files),
  932. gulp.src(shadersFiles).
  933. //pipe(expect.real({ errorOnFailure: true }, shadersFiles)).
  934. pipe(uncommentShader()).
  935. pipe(appendSrcToVariable("BABYLON.Effect.ShadersStore", shadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".fx", true)),
  936. gulp.src(shaderIncludeFiles).
  937. //pipe(expect.real({ errorOnFailure: true }, shaderIncludeFiles)).
  938. pipe(uncommentShader()).
  939. pipe(appendSrcToVariable("BABYLON.Effect.IncludesShadersStore", includeShadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".include.fx", true))
  940. ]).pipe(concat('es6.js'))
  941. .pipe(replace(extendsSearchRegex, ""))
  942. .pipe(replace(decorateSearchRegex, ""))
  943. .pipe(replace(referenceSearchRegex, ""))
  944. .pipe(replace(/var BABYLON;/g, ""))
  945. .pipe(babylonES6ModuleExports(moduleName, config.workloads[moduleName].dependUpon))
  946. .pipe(gulp.dest(config.build.outputDirectory + '/modules/' + moduleName + '/'));
  947. // dts genration task
  948. let dtsFiles = config.workloads[moduleName].files.map(f => f.replace(".js", ".d.ts"))
  949. let dtsTask = gulp.src(dtsFiles)
  950. .pipe(concat("index.d.ts"))
  951. .pipe(replace(/declare module BABYLON {/g, `declare module 'babylonjs/${moduleName}' {`))
  952. .pipe(replace(/\ninterface /g, `\nexport interface `))
  953. .pipe(dtsModuleSupport(moduleName, true, declared, perFile, dependencyTree))
  954. .pipe(gulp.dest(config.build.outputDirectory + '/modules/' + moduleName + '/'));
  955. */
  956. tasks.push(commonJsTask, es6Tasks);
  957. });
  958. // run da tasks man!
  959. return merge2(tasks);
  960. }));
  961. /**
  962. * Generate the TypeDoc JSON output in order to create code metadata.
  963. */
  964. gulp.task("typedoc-generate", function() {
  965. return gulp
  966. .src([
  967. "../../dist/preview release/babylon.d.ts",
  968. "../../dist/preview release/gui/babylon.gui.d.ts",
  969. "../../dist/preview release/loaders/babylon.glTF2FileLoader.d.ts",
  970. "../../dist/preview release/serializers/babylon.glTF2Serializer.d.ts",
  971. "../../dist/preview release/glTF2Interface/babylon.glTF2Interface.d.ts"])
  972. .pipe(typedoc({
  973. // TypeScript options (see typescript docs)
  974. mode: "modules",
  975. module: "commonjs",
  976. target: "es5",
  977. includeDeclarations: true,
  978. // Output options (see typedoc docs)
  979. json: config.build.typedocJSON,
  980. // TypeDoc options (see typedoc docs)
  981. ignoreCompilerErrors: true,
  982. readme: "none",
  983. excludeExternals: true,
  984. excludePrivate: true,
  985. excludeProtected: true,
  986. entryPoint: ["\"babylon.d\"", "BABYLON"]
  987. }));
  988. });
  989. /**
  990. * Validate the TypeDoc JSON output against the current baselin to ensure our code is correctly documented.
  991. * (in the newly introduced areas)
  992. */
  993. gulp.task("typedoc-validate", function() {
  994. return gulp.src(config.build.typedocJSON)
  995. .pipe(validateTypedoc(config.build.typedocValidationBaseline, "BABYLON", true, false));
  996. });
  997. /**
  998. * Generate the validation reference to ensure our code is correctly documented.
  999. */
  1000. gulp.task("typedoc-generateValidationBaseline", function() {
  1001. return gulp.src(config.build.typedocJSON)
  1002. .pipe(validateTypedoc(config.build.typedocValidationBaseline, "BABYLON", true, true));
  1003. });
  1004. /**
  1005. * Validate the code comments and style case convention through typedoc and
  1006. * generate the new baseline.
  1007. */
  1008. gulp.task("typedoc-all", gulp.series("typedoc-generate", "typedoc-validate", "typedoc-generateValidationBaseline"));
  1009. /**
  1010. * Validate compile the code and check the comments and style case convention through typedoc
  1011. */
  1012. gulp.task("typedoc-check", gulp.series("typescript-compile", "gui", "loaders", "serializers", "typedoc-generate", "typedoc-validate"));
  1013. /**
  1014. * Launches the KARMA validation tests in chrome in order to debug them.
  1015. * (Can only be launch locally.)
  1016. */
  1017. gulp.task("tests-validation-karma", function(done) {
  1018. var kamaServerOptions = {
  1019. configFile: __dirname + "/../../tests/validation/karma.conf.js",
  1020. singleRun: false
  1021. };
  1022. var server = new karmaServer(kamaServerOptions, done);
  1023. server.start();
  1024. });
  1025. /**
  1026. * Launches the KARMA validation tests in ff or virtual screen ff on travis for a quick analysis during the build.
  1027. * (Can only be launch on any branches.)
  1028. */
  1029. gulp.task("tests-validation-virtualscreen", function(done) {
  1030. var kamaServerOptions = {
  1031. configFile: __dirname + "/../../tests/validation/karma.conf.js",
  1032. singleRun: true,
  1033. browsers: ['Firefox']
  1034. };
  1035. var server = new karmaServer(kamaServerOptions, done);
  1036. server.start();
  1037. });
  1038. /**
  1039. * Launches the KARMA validation tests in browser stack for remote and cross devices validation tests.
  1040. * (Can only be launch from secure branches.)
  1041. */
  1042. gulp.task("tests-validation-browserstack", function(done) {
  1043. if (!process.env.BROWSER_STACK_USERNAME) {
  1044. done();
  1045. return;
  1046. }
  1047. var kamaServerOptions = {
  1048. configFile: __dirname + "/../../tests/validation/karma.conf.browserstack.js",
  1049. singleRun: true
  1050. };
  1051. var server = new karmaServer(kamaServerOptions, done);
  1052. server.start();
  1053. });
  1054. /**
  1055. * Transpiles typescript unit tests.
  1056. */
  1057. gulp.task("tests-unit-transpile", function(done) {
  1058. var tsProject = typescript.createProject('../../tests/unit/tsconfig.json');
  1059. var tsResult = gulp.src("../../tests/unit/**/*.ts", { base: "../../" })
  1060. .pipe(tsProject());
  1061. tsResult.once("error", function() {
  1062. tsResult.once("finish", function(err) {
  1063. console.log("Typescript compile failed");
  1064. console.error(err);
  1065. process.exit(1);
  1066. });
  1067. });
  1068. return tsResult.js.pipe(gulp.dest("../../"));
  1069. });
  1070. /**
  1071. * Launches the KARMA unit tests in phantomJS.
  1072. * (Can only be launch on any branches.)
  1073. */
  1074. gulp.task("tests-unit-debug", gulp.series("tests-unit-transpile", function(done) {
  1075. var kamaServerOptions = {
  1076. configFile: __dirname + "/../../tests/unit/karma.conf.js",
  1077. singleRun: false,
  1078. browsers: ['Chrome']
  1079. };
  1080. var server = new karmaServer(kamaServerOptions, done);
  1081. server.start();
  1082. }));
  1083. gulp.task("tests-babylon-unit", gulp.series("tests-unit-transpile", function(done) {
  1084. var kamaServerOptions = {
  1085. configFile: __dirname + "/../../tests/unit/karma.conf.js",
  1086. singleRun: true
  1087. };
  1088. var server = new karmaServer(kamaServerOptions, done);
  1089. server.start();
  1090. }));
  1091. var rmDir = function(dirPath) {
  1092. try { var files = fs.readdirSync(dirPath); }
  1093. catch (e) { return; }
  1094. if (files.length > 0)
  1095. for (var i = 0; i < files.length; i++) {
  1096. var filePath = dirPath + '/' + files[i];
  1097. if (fs.statSync(filePath).isFile())
  1098. fs.unlinkSync(filePath);
  1099. else
  1100. rmDir(filePath);
  1101. }
  1102. fs.rmdirSync(dirPath);
  1103. };
  1104. /**
  1105. * Transpiles viewer typescript unit tests.
  1106. */
  1107. gulp.task("tests-viewer-validation-transpile", function() {
  1108. let wpBuild = webpackStream(require('../../Viewer/webpack.gulp.config.js'), webpack);
  1109. // clean the built directory
  1110. rmDir("../../Viewer/tests/build/");
  1111. return wpBuild
  1112. .pipe(rename(function(path) {
  1113. if (path.extname === '.js') {
  1114. path.basename = "test";
  1115. }
  1116. }))
  1117. .pipe(gulp.dest("../../Viewer/tests/build/"));
  1118. });
  1119. /**
  1120. * Launches the viewer's KARMA validation tests in chrome in order to debug them.
  1121. * (Can only be launch locally.)
  1122. */
  1123. gulp.task("tests-viewer-validation-karma", gulp.series("tests-viewer-validation-transpile", function(done) {
  1124. var kamaServerOptions = {
  1125. configFile: __dirname + "/../../Viewer/tests/validation/karma.conf.js",
  1126. singleRun: false
  1127. };
  1128. var server = new karmaServer(kamaServerOptions, done);
  1129. server.start();
  1130. }));
  1131. /**
  1132. * Launches the KARMA validation tests in ff or virtual screen ff on travis for a quick analysis during the build.
  1133. * (Can only be launch on any branches.)
  1134. */
  1135. gulp.task("tests-viewer-validation-virtualscreen", gulp.series("tests-viewer-validation-transpile", function(done) {
  1136. var kamaServerOptions = {
  1137. configFile: __dirname + "/../../Viewer/tests/validation/karma.conf.js",
  1138. singleRun: true,
  1139. browsers: ['Firefox']
  1140. };
  1141. var server = new karmaServer(kamaServerOptions, done);
  1142. server.start();
  1143. }));
  1144. /**
  1145. * Launches the KARMA validation tests in browser stack for remote and cross devices validation tests.
  1146. * (Can only be launch from secure branches.)
  1147. */
  1148. gulp.task("tests-viewer-validation-browserstack", gulp.series("tests-viewer-validation-transpile", function(done) {
  1149. if (!process.env.BROWSER_STACK_USERNAME) {
  1150. done();
  1151. return;
  1152. }
  1153. var kamaServerOptions = {
  1154. configFile: __dirname + "/../../Viewer/tests/validation/karma.conf.browserstack.js",
  1155. singleRun: true
  1156. };
  1157. var server = new karmaServer(kamaServerOptions, done);
  1158. server.start();
  1159. }));
  1160. /**
  1161. * Transpiles viewer typescript unit tests.
  1162. */
  1163. gulp.task("tests-viewer-transpile", function() {
  1164. let wpBuild = webpackStream(require('../../Viewer/tests/unit/webpack.config.js'), webpack);
  1165. // clean the built directory
  1166. rmDir("../../Viewer/tests/build/");
  1167. return wpBuild
  1168. .pipe(rename(function(path) {
  1169. if (path.extname === '.js') {
  1170. path.basename = "test";
  1171. }
  1172. }))
  1173. .pipe(gulp.dest("../../Viewer/tests/build/"));
  1174. });
  1175. /**
  1176. * Launches the KARMA unit tests in chrome.
  1177. * (Can be launch on any branches.)
  1178. */
  1179. gulp.task("tests-viewer-unit-debug", gulp.series("tests-viewer-transpile", function(done) {
  1180. var kamaServerOptions = {
  1181. configFile: __dirname + "/../../Viewer/tests/karma.conf.js",
  1182. singleRun: false,
  1183. browsers: ['Chrome']
  1184. };
  1185. var server = new karmaServer(kamaServerOptions, done);
  1186. server.start();
  1187. }));
  1188. /**
  1189. * Launches the KARMA unit tests in phantomJS.
  1190. * (Can be launch on any branches.)
  1191. */
  1192. gulp.task("tests-viewer-unit", gulp.series("tests-viewer-transpile", function(done) {
  1193. var kamaServerOptions = {
  1194. configFile: __dirname + "/../../Viewer/tests/karma.conf.js",
  1195. singleRun: true
  1196. };
  1197. var server = new karmaServer(kamaServerOptions, done);
  1198. server.start();
  1199. }));
  1200. /**
  1201. * Launches the KARMA unit tests in phantomJS.
  1202. * (Can only be launch on any branches.)
  1203. */
  1204. gulp.task("tests-unit", gulp.series("tests-babylon-unit", "tests-viewer-unit"));
  1205. gulp.task("tests-modules", function() {
  1206. let testsToRun = require('../../tests/modules/tests.json');
  1207. let sequencePromise = Promise.resolve();
  1208. testsToRun.tests.forEach(test => {
  1209. sequencePromise = sequencePromise.then(() => {
  1210. console.log("Running " + test.name);
  1211. let basePath = '../../tests/modules/' + test.name + '/';
  1212. rmDir("../../tests/modules/build/");
  1213. let compilePromise = Promise.resolve();
  1214. if (test.dependencies) {
  1215. compilePromise = new Promise(function(resolve, reject) {
  1216. let counter = 0;
  1217. let copyTask = gulp.src(test.dependencies.map(dep => config.build.outputDirectory + '/' + dep)).pipe(rename(function(path) {
  1218. path.basename = (counter++) + '';
  1219. })).pipe(gulp.dest("../../tests/modules/build/dependencies/"))
  1220. copyTask.once("finish", resolve);
  1221. })
  1222. }
  1223. // any compilation needed?
  1224. if (test.typescript || test.bundler) {
  1225. //typescript only
  1226. if (test.typescript && !test.bundler) {
  1227. compilePromise = compilePromise.then(() => {
  1228. return new Promise(function(resolve, reject) {
  1229. var tsProject = typescript.createProject(basePath + (test.tsconfig || 'tsconfig.json'));
  1230. var tsResult = gulp.src(basePath + '/src/**/*.ts', { base: basePath })
  1231. .pipe(tsProject());
  1232. let error = false;
  1233. tsResult.once("error", function() {
  1234. error = true;
  1235. });
  1236. let jsPipe = tsResult.js.pipe(gulp.dest("../../tests/modules/"));
  1237. jsPipe.once("finish", function() {
  1238. if (error)
  1239. reject('error compiling test');
  1240. else
  1241. resolve();
  1242. });
  1243. });
  1244. });
  1245. } else {
  1246. if (test.bundler === 'webpack') {
  1247. console.log("webpack");
  1248. compilePromise = compilePromise.then(() => {
  1249. return new Promise(function(resolve, reject) {
  1250. let wpBuild = webpackStream(require(basePath + '/webpack.config.js'), webpack);
  1251. wpBuild = wpBuild
  1252. .pipe(rename(function(path) {
  1253. if (path.extname === '.js') {
  1254. path.basename = "tests-loader";
  1255. }
  1256. }))
  1257. .pipe(gulp.dest("../../tests/modules/build/"));
  1258. wpBuild.once("finish", resolve);
  1259. })
  1260. });
  1261. }
  1262. }
  1263. }
  1264. return compilePromise.then(() => {
  1265. return new Promise(function(resolve, reject) {
  1266. var kamaServerOptions = {
  1267. configFile: __dirname + "/../../tests/modules/karma.conf.js",
  1268. singleRun: true
  1269. };
  1270. var server = new karmaServer(kamaServerOptions, resolve);
  1271. server.start();
  1272. });
  1273. })
  1274. })
  1275. });
  1276. return sequencePromise;
  1277. });
  1278. gulp.task("tests-whatsnew", function(done) {
  1279. // Only checks on Travis
  1280. if (!process.env.TRAVIS) {
  1281. done();
  1282. return;
  1283. }
  1284. // Only checks on Pull Requests
  1285. if (process.env.TRAVIS_PULL_REQUEST == "false") {
  1286. done();
  1287. return;
  1288. }
  1289. // Do not check deploy
  1290. if (process.env.TRAVIS_BRANCH == "preview") {
  1291. done();
  1292. return;
  1293. }
  1294. // Compare what's new with the current one in the preview release folder.
  1295. const https = require("https");
  1296. const url = "https://rawgit.com/BabylonJS/Babylon.js/master/dist/preview%20release/what's%20new.md";
  1297. https.get(url, res => {
  1298. res.setEncoding("utf8");
  1299. let oldData = "";
  1300. res.on("data", data => {
  1301. oldData += data;
  1302. });
  1303. res.on("end", () => {
  1304. fs.readFile("../../dist/preview release/what's new.md", "utf-8", function(err, newData) {
  1305. if (err || oldData != newData) {
  1306. done();
  1307. return;
  1308. }
  1309. console.error("What's new file did not change.");
  1310. process.exit(1);
  1311. });
  1312. });
  1313. });
  1314. });
  1315. /**
  1316. * Do it all.
  1317. */
  1318. gulp.task("typescript-all", gulp.series("typescript", "typescript-libraries", "netlify-cleanup"));
  1319. /**
  1320. * The default task, concat and min the main BJS files.
  1321. */
  1322. gulp.task("default", gulp.series("tsLint", "typescript-all", "intellisense", "typedoc-all", "tests-unit", "tests-modules", "tests-validation-virtualscreen", "tests-validation-browserstack"));