gulpfile.js 54 KB

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