gulpfile.js 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515
  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 webserver = require("gulp-webserver");
  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. console.log(outputDirectory);
  597. let buildEvent = wpBuild
  598. .pipe(gulp.dest(outputDirectory))
  599. //back-compat
  600. .pipe(through.obj(function(file, enc, cb) {
  601. // only js files
  602. const isjs = /\.js$/.test(file.path);
  603. if (isjs) this.push(file);
  604. cb();
  605. }))
  606. .pipe(rename(function(path) {
  607. console.log(path.basename);
  608. //path.extname === ".js"
  609. path.basename = path.basename.replace(".min", "")
  610. })).pipe(gulp.dest(outputDirectory));
  611. sequence.push(
  612. buildEvent
  613. );
  614. if (settings.build.dtsBundle || settings.build.processDeclaration) {
  615. buildEvent.on("end", function() {
  616. if (settings.build.dtsBundle) {
  617. dtsBundle.bundle(settings.build.dtsBundle);
  618. } if (settings.build.processDeclaration) {
  619. let fileLocation = path.join(outputDirectory, settings.build.processDeclaration.filename);
  620. fs.readFile(fileLocation, function(err, data) {
  621. if (err) throw err;
  622. // For Raanan,litera litteral import hack TO BETTER INTEGRATE
  623. data = data + "";
  624. data = data.replace('import "../sass/main.scss";', "");
  625. var newData = processDeclaration(data, settings.build.processDeclaration);
  626. fs.writeFileSync(fileLocation.replace('.module', ''), newData);
  627. //legacy module support
  628. fs.writeFileSync(fileLocation, data + "\n" + newData);
  629. });
  630. }
  631. });
  632. }
  633. /*if (settings.build.processDeclaration) {
  634. sequence.push(
  635. wpBuild
  636. .pipe(through.obj(function (file, enc, cb) {
  637. // only js files
  638. const isDts = /\.d.ts$/.test(file.path);
  639. file.contents = new Buffer(processDeclaration(file.contents, settings.build.processDeclaration));
  640. if (isDts) this.push(file);
  641. cb();
  642. }))
  643. .pipe(gulp.dest(outputDirectory))
  644. )
  645. }*/
  646. }
  647. return merge2(sequence);
  648. }
  649. else {
  650. return waitAll || Promise.resolve();
  651. }
  652. }
  653. }
  654. gulp.task("mainBuild", gulp.series("buildWorker", "build"));
  655. /**
  656. * Build the releasable files.
  657. */
  658. gulp.task("typescript", gulp.series("typescript-compile", "mainBuild"));
  659. /**
  660. * Dynamic module creation.
  661. */
  662. config.modules.map(function(module) {
  663. gulp.task(module, function() {
  664. return buildExternalLibraries(config[module]);
  665. });
  666. });
  667. gulp.task("typescript-libraries", gulp.series(config.modules));
  668. /**
  669. * Custom build with full path file control; used by profile.html
  670. */
  671. gulp.task("build-custom", gulp.series("typescript-compile", "build"));
  672. /**
  673. * Watch ts files from typescript .
  674. */
  675. gulp.task("srcTscWatch", function() {
  676. // Reuse The TSC CLI from gulp to enable -w.
  677. process.argv[2] = "-w";
  678. process.argv[3] = "-p";
  679. process.argv[4] = "../../src/tsconfig.json";
  680. require("./node_modules/typescript/lib/tsc.js");
  681. return Promise.resolve();
  682. });
  683. /**
  684. * Watch ts files and fire repective tasks.
  685. */
  686. gulp.task("watch", gulp.series("srcTscWatch", function startWatch() {
  687. var interval = 1000;
  688. var tasks = [];
  689. config.modules.map(function(module) {
  690. config[module].libraries.map(function(library) {
  691. if (library.webpack) {
  692. if (library.noWatch) return;
  693. var outputDirectory = config.build.tempDirectory + config[module].build.distOutputDirectory;
  694. let wpconfig = require(library.webpack);
  695. wpconfig.watch = true;
  696. // dev mode and absolute path sourcemaps for debugging
  697. wpconfig.mode = "development";
  698. wpconfig.output.devtoolModuleFilenameTemplate = "[absolute-resource-path]";
  699. //config.stats = "minimal";
  700. tasks.push(webpackStream(wpconfig, webpack).pipe(gulp.dest(outputDirectory)))
  701. } else {
  702. tasks.push(gulp.watch(library.files, { interval: interval }, function() {
  703. console.log(library.output);
  704. return buildExternalLibrary(library, config[module], true)
  705. .pipe(debug());
  706. }));
  707. tasks.push(gulp.watch(library.shaderFiles, { interval: interval }, function() {
  708. console.log(library.output);
  709. return buildExternalLibrary(library, config[module], true)
  710. .pipe(debug())
  711. }));
  712. tasks.push(gulp.watch(library.sassFiles, { interval: interval }, function() {
  713. console.log(library.output);
  714. return buildExternalLibrary(library, config[module], true)
  715. .pipe(debug())
  716. }));
  717. }
  718. });
  719. });
  720. console.log(tasks.length);
  721. return Promise.resolve();
  722. }));
  723. gulp.task("intellisense", function() {
  724. return gulp.src(config.build.intellisenseSources)
  725. .pipe(concat(config.build.intellisenseFile))
  726. .pipe(replace(/^\s+_.*?;/gm, ""))
  727. .pipe(replace(/^\s+_[\S\s]*?}/gm, ""))
  728. .pipe(replace(/^\s*readonly _/gm, "protected readonly _"))
  729. .pipe(replace(/^\s*static _/gm, "private static _"))
  730. .pipe(replace(/^\s*abstract _/gm, ""))
  731. .pipe(gulp.dest(config.build.playgroundDirectory));
  732. });
  733. /**
  734. * Embedded local dev env management.
  735. */
  736. gulp.task("deployLocalDev", function() {
  737. return gulp.src("../../localDev/template/**.*")
  738. .pipe(gulp.dest("../../localDev/src/"));
  739. });
  740. /**
  741. * Embedded webserver for test convenience.
  742. */
  743. gulp.task("webserver", function() {
  744. var options = {
  745. port: 1338,
  746. livereload: false,
  747. middleware: [cors()]
  748. };
  749. if (commandLineOptions.public) {
  750. options.host = "0.0.0.0";
  751. }
  752. return gulp.src("../../.").pipe(webserver(options));
  753. });
  754. /**
  755. * Combine Webserver and Watch as long as vscode does not handle multi tasks.
  756. */
  757. gulp.task("run", gulp.series("watch", "webserver"));
  758. /**
  759. * Cleans map and js files from the src folder.
  760. */
  761. gulp.task("clean-JS-MAP", function() {
  762. return del([
  763. "../../src/**/*.js.map", "../../src/**/*.js"
  764. ], { force: true });
  765. });
  766. gulp.task("netlify-cleanup", function() {
  767. //set by netlify
  768. if (process.env.REPOSITORY_URL) {
  769. return del([
  770. "../../inspector/node_modules/**/*", "../../gui/node_modules/**/*",
  771. "../../Viewer/node_modules/**/*"
  772. ], { force: true });
  773. }
  774. else {
  775. return Promise.resolve();
  776. }
  777. })
  778. // this is needed for the modules for the declaration files.
  779. gulp.task("modules-compile", function() {
  780. const dtsFilter = filter(['**', '!**/*.d.ts'], { restore: false });
  781. var tsResult = gulp.src(config.typescript)
  782. .pipe(dtsFilter)
  783. .pipe(sourcemaps.init())
  784. .pipe(tsProject());
  785. // If this gulp task is running on travis
  786. tsResult.once("error", function(err) {
  787. tsResult.once("finish", function() {
  788. console.log("Typescript compile failed");
  789. console.error(err);
  790. process.exit(1);
  791. });
  792. });
  793. return merge2([
  794. tsResult.dts
  795. .pipe(gulp.dest(config.build.srcOutputDirectory)),
  796. tsResult.js
  797. .pipe(sourcemaps.write("./",
  798. {
  799. includeContent: false,
  800. sourceRoot: (filePath) => {
  801. return "";
  802. }
  803. }))
  804. .pipe(gulp.dest(config.build.srcOutputDirectory))
  805. ]);
  806. });
  807. // this holds the declared objects in each module
  808. let declared = {}
  809. let perFile = {};
  810. let dependencyTree = {};
  811. gulp.task('prepare-for-modules', /*["modules-compile"],*/ function() {
  812. let tasks = [];
  813. Object.keys(config.workloads).forEach((moduleName) => {
  814. let dtsFiles = config.workloads[moduleName].files.map(f => f.replace(".js", ".d.ts"))
  815. let dtsTask = gulp.src(dtsFiles)
  816. .pipe(dtsModuleSupport(moduleName, false, declared, perFile));
  817. tasks.push(dtsTask);
  818. });
  819. // now calculate internal dependencies in the .ts files!
  820. /*Object.keys(config.workloads).forEach((moduleName) => {
  821. let tsFiles = config.workloads[moduleName].files.map(f => f.replace(".js", ".ts"))
  822. let depTask = gulp.src(tsFiles)
  823. .pipe(calculateDependencies(moduleName, perFile, dependencyTree));
  824. tasks.push(depTask);
  825. });*/
  826. return merge2(tasks);
  827. });
  828. gulp.task('prepare-dependency-tree', gulp.series("prepare-for-modules", function() {
  829. let tasks = [];
  830. // now calculate internal dependencies in the .ts files!
  831. Object.keys(config.workloads).forEach((moduleName) => {
  832. let tsFiles = config.workloads[moduleName].files.map(f => f.replace(".js", ".ts"))
  833. let depTask = gulp.src(tsFiles)
  834. .pipe(calculateDependencies(moduleName, perFile, declared, dependencyTree));
  835. tasks.push(depTask);
  836. });
  837. return merge2(tasks);
  838. }));
  839. // generate the modules directory, along with commonjs modules and es6 modules
  840. // Note - the generated modules are UNMINIFIED! The user will choose whether they want to minify or not.
  841. gulp.task("modules", gulp.series("prepare-dependency-tree", function() {
  842. let tasks = [];
  843. Object.keys(config.workloads)
  844. .forEach((moduleName) => {
  845. let shadersFiles = [];
  846. processDependency("shaders", config.workloads[moduleName], shadersFiles, true);
  847. for (var index = 0; index < shadersFiles.length; index++) {
  848. shadersFiles[index] = "../../src/Shaders/" + shadersFiles[index] + ".fx";
  849. }
  850. let shaderIncludeFiles = [];
  851. processDependency("shaderIncludes", config.workloads[moduleName], shaderIncludeFiles, true);
  852. for (var index = 0; index < shaderIncludeFiles.length; index++) {
  853. shaderIncludeFiles[index] = "../../src/Shaders/ShadersInclude/" + shaderIncludeFiles[index] + ".fx";
  854. }
  855. let commonJsTask = merge2([
  856. gulp.src(config.workloads[moduleName].files)
  857. .pipe(replace(extendsSearchRegex, ""))
  858. .pipe(replace(decorateSearchRegex, ""))
  859. .pipe(replace(referenceSearchRegex, ""))
  860. .pipe(replace(/var BABYLON;\n/g, ""))
  861. .pipe(babylonModuleExports(moduleName, dependencyTree, false, perFile, shadersFiles.length, shaderIncludeFiles.length))
  862. .pipe(rename(function(path) {
  863. path.basename = path.basename.split(".").pop()
  864. path.extname = ".js"
  865. })),
  866. gulp.src(shadersFiles)
  867. .pipe(expect.real({ errorOnFailure: true }, shadersFiles))
  868. .pipe(uncommentShader())
  869. .pipe(appendSrcToVariable("BABYLON.Effect.ShadersStore", shadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".fx", "commonjs"))
  870. .pipe(rename("shaders.js")),
  871. gulp.src(shaderIncludeFiles)
  872. .pipe(expect.real({ errorOnFailure: true }, shaderIncludeFiles))
  873. .pipe(uncommentShader())
  874. .pipe(appendSrcToVariable("BABYLON.Effect.IncludesShadersStore", includeShadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".include.fx", "commonjs"))
  875. .pipe(rename("shaderIncludes.js")),
  876. gulp.src(config.workloads[moduleName].files)
  877. .pipe(concat('index.js'))
  878. .pipe(babylonModuleExports(moduleName, dependencyTree, true, perFile))
  879. ]).pipe(gulp.dest(config.build.outputDirectory + '/modules/' + moduleName + '/'))
  880. let es6Tasks = merge2([
  881. gulp.src(config.workloads[moduleName].files)
  882. .pipe(replace(extendsSearchRegex, ""))
  883. .pipe(replace(decorateSearchRegex, ""))
  884. .pipe(replace(referenceSearchRegex, ""))
  885. .pipe(replace(/var BABYLON;\n/g, ""))
  886. .pipe(babylonES6ModuleExports(moduleName, dependencyTree, false, perFile, shadersFiles.length, shaderIncludeFiles.length))
  887. .pipe(rename(function(path) {
  888. path.basename = path.basename.split(".").pop()
  889. path.extname = ".js"
  890. })),
  891. gulp.src(shadersFiles)
  892. .pipe(expect.real({ errorOnFailure: true }, shadersFiles))
  893. .pipe(uncommentShader())
  894. .pipe(appendSrcToVariable("BABYLON.Effect.ShadersStore", shadersName, config.build.outputDirectory + '/es6/' + moduleName + ".fx", "es6"))
  895. .pipe(rename("shaders.js")),
  896. gulp.src(shaderIncludeFiles)
  897. .pipe(expect.real({ errorOnFailure: true }, shaderIncludeFiles))
  898. .pipe(uncommentShader())
  899. .pipe(appendSrcToVariable("BABYLON.Effect.IncludesShadersStore", includeShadersName, config.build.outputDirectory + '/es6/' + moduleName + ".include.fx", "es6"))
  900. .pipe(rename("shaderIncludes.js")),
  901. gulp.src(config.workloads[moduleName].files)
  902. .pipe(concat('index.js'))
  903. .pipe(babylonES6ModuleExports(moduleName, dependencyTree, true, perFile))
  904. ]).pipe(gulp.dest(config.build.outputDirectory + '/modules/' + moduleName + '/es6/'))
  905. //commonjs js generation task
  906. /*let jsTask = merge2([
  907. gulp.src(config.workloads[moduleName].files),
  908. gulp.src(shadersFiles).
  909. //pipe(expect.real({ errorOnFailure: true }, shadersFiles)).
  910. pipe(uncommentShader()).
  911. pipe(appendSrcToVariable("BABYLON.Effect.ShadersStore", shadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".fx", true)),
  912. gulp.src(shaderIncludeFiles).
  913. //pipe(expect.real({ errorOnFailure: true }, shaderIncludeFiles)).
  914. pipe(uncommentShader()).
  915. pipe(appendSrcToVariable("BABYLON.Effect.IncludesShadersStore", includeShadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".include.fx", true))
  916. ]).pipe(concat('index.js'))
  917. .pipe(replace(extendsSearchRegex, ""))
  918. .pipe(replace(decorateSearchRegex, ""))
  919. .pipe(replace(referenceSearchRegex, ""))
  920. .pipe(babylonModuleExports(moduleName, config.workloads[moduleName].dependUpon))
  921. .pipe(gulp.dest(config.build.outputDirectory + '/modules/' + moduleName + '/'));*/
  922. // es6 modules generation task
  923. /*let es6Task = merge2([
  924. gulp.src(config.workloads[moduleName].files),
  925. gulp.src(shadersFiles).
  926. //pipe(expect.real({ errorOnFailure: true }, shadersFiles)).
  927. pipe(uncommentShader()).
  928. pipe(appendSrcToVariable("BABYLON.Effect.ShadersStore", shadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".fx", true)),
  929. gulp.src(shaderIncludeFiles).
  930. //pipe(expect.real({ errorOnFailure: true }, shaderIncludeFiles)).
  931. pipe(uncommentShader()).
  932. pipe(appendSrcToVariable("BABYLON.Effect.IncludesShadersStore", includeShadersName, config.build.outputDirectory + '/commonjs/' + moduleName + ".include.fx", true))
  933. ]).pipe(concat('es6.js'))
  934. .pipe(replace(extendsSearchRegex, ""))
  935. .pipe(replace(decorateSearchRegex, ""))
  936. .pipe(replace(referenceSearchRegex, ""))
  937. .pipe(replace(/var BABYLON;/g, ""))
  938. .pipe(babylonES6ModuleExports(moduleName, config.workloads[moduleName].dependUpon))
  939. .pipe(gulp.dest(config.build.outputDirectory + '/modules/' + moduleName + '/'));
  940. // dts genration task
  941. let dtsFiles = config.workloads[moduleName].files.map(f => f.replace(".js", ".d.ts"))
  942. let dtsTask = gulp.src(dtsFiles)
  943. .pipe(concat("index.d.ts"))
  944. .pipe(replace(/declare module BABYLON {/g, `declare module 'babylonjs/${moduleName}' {`))
  945. .pipe(replace(/\ninterface /g, `\nexport interface `))
  946. .pipe(dtsModuleSupport(moduleName, true, declared, perFile, dependencyTree))
  947. .pipe(gulp.dest(config.build.outputDirectory + '/modules/' + moduleName + '/'));
  948. */
  949. tasks.push(commonJsTask, es6Tasks);
  950. });
  951. // run da tasks man!
  952. return merge2(tasks);
  953. }));
  954. /**
  955. * Generate the TypeDoc JSON output in order to create code metadata.
  956. */
  957. gulp.task("typedoc-generate", function() {
  958. return gulp
  959. .src([
  960. "../../dist/preview release/babylon.d.ts",
  961. "../../dist/preview release/gui/babylon.gui.d.ts",
  962. "../../dist/preview release/loaders/babylon.glTF2FileLoader.d.ts",
  963. "../../dist/preview release/serializers/babylon.glTF2Serializer.d.ts",
  964. "../../dist/preview release/glTF2Interface/babylon.glTF2Interface.d.ts"])
  965. .pipe(typedoc({
  966. // TypeScript options (see typescript docs)
  967. mode: "modules",
  968. module: "commonjs",
  969. target: "es5",
  970. includeDeclarations: true,
  971. // Output options (see typedoc docs)
  972. json: config.build.typedocJSON,
  973. // TypeDoc options (see typedoc docs)
  974. ignoreCompilerErrors: true,
  975. readme: "none",
  976. excludeExternals: true,
  977. excludePrivate: true,
  978. excludeProtected: true,
  979. entryPoint: ["\"babylon.d\"", "BABYLON"]
  980. }));
  981. });
  982. /**
  983. * Validate the TypeDoc JSON output against the current baselin to ensure our code is correctly documented.
  984. * (in the newly introduced areas)
  985. */
  986. gulp.task("typedoc-validate", function() {
  987. return gulp.src(config.build.typedocJSON)
  988. .pipe(validateTypedoc(config.build.typedocValidationBaseline, "BABYLON", true, false));
  989. });
  990. /**
  991. * Generate the validation reference to ensure our code is correctly documented.
  992. */
  993. gulp.task("typedoc-generateValidationBaseline", function() {
  994. return gulp.src(config.build.typedocJSON)
  995. .pipe(validateTypedoc(config.build.typedocValidationBaseline, "BABYLON", true, true));
  996. });
  997. /**
  998. * Validate the code comments and style case convention through typedoc and
  999. * generate the new baseline.
  1000. */
  1001. gulp.task("typedoc-all", gulp.series("typedoc-generate", "typedoc-validate", "typedoc-generateValidationBaseline"));
  1002. /**
  1003. * Validate compile the code and check the comments and style case convention through typedoc
  1004. */
  1005. gulp.task("typedoc-check", gulp.series("typescript-compile", "gui", "loaders", "serializers", "typedoc-generate", "typedoc-validate"));
  1006. /**
  1007. * Launches the KARMA validation tests in chrome in order to debug them.
  1008. * (Can only be launch locally.)
  1009. */
  1010. gulp.task("tests-validation-karma", function(done) {
  1011. var kamaServerOptions = {
  1012. configFile: __dirname + "/../../tests/validation/karma.conf.js",
  1013. singleRun: false
  1014. };
  1015. var server = new karmaServer(kamaServerOptions, done);
  1016. server.start();
  1017. });
  1018. /**
  1019. * Launches the KARMA validation tests in ff or virtual screen ff on travis for a quick analysis during the build.
  1020. * (Can only be launch on any branches.)
  1021. */
  1022. gulp.task("tests-validation-virtualscreen", function(done) {
  1023. var kamaServerOptions = {
  1024. configFile: __dirname + "/../../tests/validation/karma.conf.js",
  1025. singleRun: true,
  1026. browsers: ['Firefox']
  1027. };
  1028. var server = new karmaServer(kamaServerOptions, done);
  1029. server.start();
  1030. });
  1031. /**
  1032. * Launches the KARMA validation tests in browser stack for remote and cross devices validation tests.
  1033. * (Can only be launch from secure branches.)
  1034. */
  1035. gulp.task("tests-validation-browserstack", function(done) {
  1036. if (!process.env.BROWSER_STACK_USERNAME) {
  1037. done();
  1038. return;
  1039. }
  1040. var kamaServerOptions = {
  1041. configFile: __dirname + "/../../tests/validation/karma.conf.browserstack.js",
  1042. singleRun: true
  1043. };
  1044. var server = new karmaServer(kamaServerOptions, done);
  1045. server.start();
  1046. });
  1047. /**
  1048. * Transpiles typescript unit tests.
  1049. */
  1050. gulp.task("tests-unit-transpile", function(done) {
  1051. var tsProject = typescript.createProject('../../tests/unit/tsconfig.json');
  1052. var tsResult = gulp.src("../../tests/unit/**/*.ts", { base: "../../" })
  1053. .pipe(tsProject());
  1054. tsResult.once("error", function() {
  1055. tsResult.once("finish", function(err) {
  1056. console.log("Typescript compile failed");
  1057. console.error(err);
  1058. process.exit(1);
  1059. });
  1060. });
  1061. return tsResult.js.pipe(gulp.dest("../../"));
  1062. });
  1063. /**
  1064. * Launches the KARMA unit tests in phantomJS.
  1065. * (Can only be launch on any branches.)
  1066. */
  1067. gulp.task("tests-unit-debug", gulp.series("tests-unit-transpile", function(done) {
  1068. var kamaServerOptions = {
  1069. configFile: __dirname + "/../../tests/unit/karma.conf.js",
  1070. singleRun: false,
  1071. browsers: ['Chrome']
  1072. };
  1073. var server = new karmaServer(kamaServerOptions, done);
  1074. server.start();
  1075. }));
  1076. gulp.task("tests-babylon-unit", gulp.series("tests-unit-transpile", function(done) {
  1077. var kamaServerOptions = {
  1078. configFile: __dirname + "/../../tests/unit/karma.conf.js",
  1079. singleRun: true
  1080. };
  1081. var server = new karmaServer(kamaServerOptions, done);
  1082. server.start();
  1083. }));
  1084. var rmDir = function(dirPath) {
  1085. try { var files = fs.readdirSync(dirPath); }
  1086. catch (e) { return; }
  1087. if (files.length > 0)
  1088. for (var i = 0; i < files.length; i++) {
  1089. var filePath = dirPath + '/' + files[i];
  1090. if (fs.statSync(filePath).isFile())
  1091. fs.unlinkSync(filePath);
  1092. else
  1093. rmDir(filePath);
  1094. }
  1095. fs.rmdirSync(dirPath);
  1096. };
  1097. /**
  1098. * Transpiles viewer typescript unit tests.
  1099. */
  1100. gulp.task("tests-viewer-validation-transpile", function() {
  1101. let wpBuild = webpackStream(require('../../Viewer/webpack.gulp.config.js'), webpack);
  1102. // clean the built directory
  1103. rmDir("../../Viewer/tests/build/");
  1104. return wpBuild
  1105. .pipe(rename(function(path) {
  1106. if (path.extname === '.js') {
  1107. path.basename = "test";
  1108. }
  1109. }))
  1110. .pipe(gulp.dest("../../Viewer/tests/build/"));
  1111. });
  1112. /**
  1113. * Launches the viewer's KARMA validation tests in chrome in order to debug them.
  1114. * (Can only be launch locally.)
  1115. */
  1116. gulp.task("tests-viewer-validation-karma", gulp.series("tests-viewer-validation-transpile", function(done) {
  1117. var kamaServerOptions = {
  1118. configFile: __dirname + "/../../Viewer/tests/validation/karma.conf.js",
  1119. singleRun: false
  1120. };
  1121. var server = new karmaServer(kamaServerOptions, done);
  1122. server.start();
  1123. }));
  1124. /**
  1125. * Launches the KARMA validation tests in ff or virtual screen ff on travis for a quick analysis during the build.
  1126. * (Can only be launch on any branches.)
  1127. */
  1128. gulp.task("tests-viewer-validation-virtualscreen", gulp.series("tests-viewer-validation-transpile", function(done) {
  1129. var kamaServerOptions = {
  1130. configFile: __dirname + "/../../Viewer/tests/validation/karma.conf.js",
  1131. singleRun: true,
  1132. browsers: ['Firefox']
  1133. };
  1134. var server = new karmaServer(kamaServerOptions, done);
  1135. server.start();
  1136. }));
  1137. /**
  1138. * Launches the KARMA validation tests in browser stack for remote and cross devices validation tests.
  1139. * (Can only be launch from secure branches.)
  1140. */
  1141. gulp.task("tests-viewer-validation-browserstack", gulp.series("tests-viewer-validation-transpile", function(done) {
  1142. if (!process.env.BROWSER_STACK_USERNAME) {
  1143. done();
  1144. return;
  1145. }
  1146. var kamaServerOptions = {
  1147. configFile: __dirname + "/../../Viewer/tests/validation/karma.conf.browserstack.js",
  1148. singleRun: true
  1149. };
  1150. var server = new karmaServer(kamaServerOptions, done);
  1151. server.start();
  1152. }));
  1153. /**
  1154. * Transpiles viewer typescript unit tests.
  1155. */
  1156. gulp.task("tests-viewer-transpile", function() {
  1157. let wpBuild = webpackStream(require('../../Viewer/tests/unit/webpack.config.js'), webpack);
  1158. // clean the built directory
  1159. rmDir("../../Viewer/tests/build/");
  1160. return wpBuild
  1161. .pipe(rename(function(path) {
  1162. if (path.extname === '.js') {
  1163. path.basename = "test";
  1164. }
  1165. }))
  1166. .pipe(gulp.dest("../../Viewer/tests/build/"));
  1167. });
  1168. /**
  1169. * Launches the KARMA unit tests in chrome.
  1170. * (Can be launch on any branches.)
  1171. */
  1172. gulp.task("tests-viewer-unit-debug", gulp.series("tests-viewer-transpile", function(done) {
  1173. var kamaServerOptions = {
  1174. configFile: __dirname + "/../../Viewer/tests/karma.conf.js",
  1175. singleRun: false,
  1176. browsers: ['Chrome']
  1177. };
  1178. var server = new karmaServer(kamaServerOptions, done);
  1179. server.start();
  1180. }));
  1181. /**
  1182. * Launches the KARMA unit tests in phantomJS.
  1183. * (Can be launch on any branches.)
  1184. */
  1185. gulp.task("tests-viewer-unit", gulp.series("tests-viewer-transpile", function(done) {
  1186. var kamaServerOptions = {
  1187. configFile: __dirname + "/../../Viewer/tests/karma.conf.js",
  1188. singleRun: true
  1189. };
  1190. var server = new karmaServer(kamaServerOptions, done);
  1191. server.start();
  1192. }));
  1193. /**
  1194. * Launches the KARMA unit tests in phantomJS.
  1195. * (Can only be launch on any branches.)
  1196. */
  1197. gulp.task("tests-unit", gulp.series("tests-babylon-unit", "tests-viewer-unit"));
  1198. gulp.task("tests-modules", function() {
  1199. let testsToRun = require('../../tests/modules/tests.json');
  1200. let sequencePromise = Promise.resolve();
  1201. testsToRun.tests.forEach(test => {
  1202. sequencePromise = sequencePromise.then(() => {
  1203. console.log("Running " + test.name);
  1204. let basePath = '../../tests/modules/' + test.name + '/';
  1205. rmDir("../../tests/modules/build/");
  1206. let compilePromise = Promise.resolve();
  1207. if (test.dependencies) {
  1208. compilePromise = new Promise(function(resolve, reject) {
  1209. let counter = 0;
  1210. let copyTask = gulp.src(test.dependencies.map(dep => config.build.outputDirectory + '/' + dep)).pipe(rename(function(path) {
  1211. path.basename = (counter++) + '';
  1212. })).pipe(gulp.dest("../../tests/modules/build/dependencies/"))
  1213. copyTask.once("finish", resolve);
  1214. })
  1215. }
  1216. // any compilation needed?
  1217. if (test.typescript || test.bundler) {
  1218. //typescript only
  1219. if (test.typescript && !test.bundler) {
  1220. compilePromise = compilePromise.then(() => {
  1221. return new Promise(function(resolve, reject) {
  1222. var tsProject = typescript.createProject(basePath + (test.tsconfig || 'tsconfig.json'));
  1223. var tsResult = gulp.src(basePath + '/src/**/*.ts', { base: basePath })
  1224. .pipe(tsProject());
  1225. let error = false;
  1226. tsResult.once("error", function() {
  1227. error = true;
  1228. });
  1229. let jsPipe = tsResult.js.pipe(gulp.dest("../../tests/modules/"));
  1230. jsPipe.once("finish", function() {
  1231. if (error)
  1232. reject('error compiling test');
  1233. else
  1234. resolve();
  1235. });
  1236. });
  1237. });
  1238. } else {
  1239. if (test.bundler === 'webpack') {
  1240. console.log("webpack");
  1241. compilePromise = compilePromise.then(() => {
  1242. return new Promise(function(resolve, reject) {
  1243. let wpBuild = webpackStream(require(basePath + '/webpack.config.js'), webpack);
  1244. wpBuild = wpBuild
  1245. .pipe(rename(function(path) {
  1246. if (path.extname === '.js') {
  1247. path.basename = "tests-loader";
  1248. }
  1249. }))
  1250. .pipe(gulp.dest("../../tests/modules/build/"));
  1251. wpBuild.once("finish", resolve);
  1252. })
  1253. });
  1254. }
  1255. }
  1256. }
  1257. return compilePromise.then(() => {
  1258. return new Promise(function(resolve, reject) {
  1259. var kamaServerOptions = {
  1260. configFile: __dirname + "/../../tests/modules/karma.conf.js",
  1261. singleRun: true
  1262. };
  1263. var server = new karmaServer(kamaServerOptions, resolve);
  1264. server.start();
  1265. });
  1266. })
  1267. })
  1268. });
  1269. return sequencePromise;
  1270. });
  1271. gulp.task("tests-whatsnew", function(done) {
  1272. // Only checks on Travis
  1273. if (!process.env.TRAVIS) {
  1274. done();
  1275. return;
  1276. }
  1277. // Only checks on Pull Requests
  1278. if (process.env.TRAVIS_PULL_REQUEST == "false") {
  1279. done();
  1280. return;
  1281. }
  1282. // Do not check deploy
  1283. if (process.env.TRAVIS_BRANCH == "preview") {
  1284. done();
  1285. return;
  1286. }
  1287. // Compare what's new with the current one in the preview release folder.
  1288. const https = require("https");
  1289. const url = "https://rawgit.com/BabylonJS/Babylon.js/master/dist/preview%20release/what's%20new.md";
  1290. https.get(url, res => {
  1291. res.setEncoding("utf8");
  1292. let oldData = "";
  1293. res.on("data", data => {
  1294. oldData += data;
  1295. });
  1296. res.on("end", () => {
  1297. fs.readFile("../../dist/preview release/what's new.md", "utf-8", function(err, newData) {
  1298. if (err || oldData != newData) {
  1299. done();
  1300. return;
  1301. }
  1302. console.error("What's new file did not change.");
  1303. process.exit(1);
  1304. });
  1305. });
  1306. });
  1307. });
  1308. /**
  1309. * Do it all.
  1310. */
  1311. gulp.task("typescript-all", gulp.series("typescript", "typescript-libraries", "netlify-cleanup"));
  1312. /**
  1313. * The default task, concat and min the main BJS files.
  1314. */
  1315. gulp.task("default", gulp.series("tsLint", "typescript-all", "intellisense", "typedoc-all", "tests-unit", "tests-modules", "tests-validation-virtualscreen", "tests-validation-browserstack"));