⚡ Make a versions.js file that checks and returns used nw.js and pixi…

….js versions. versions.js should now be used as a source of truth about used nw.js and pixi versions.

Closes #305

.gitignore

@@ -85,6 +85,7 @@ app/export
 
 # editor-specific
 .vscode/settings.json
+.vscode/launch.json
 
 # docs
 docs/db.json

.vscode/launch.json → .vscode/launch-template.json

@@ -1,14 +1,11 @@
 {
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
         {
             "type": "nwjs",
             "request": "launch",
             "name": "Launch ct.js",
-            "nwjsVersion": "0.59.0",
+            "nwjsVersion": "(this should be filled by devSetup.gulpfile.js)",
             "runtimeArgs": [
                 "--nwapp=${workspaceFolder}/app"
             ],

app/package.json

@@ -73,8 +73,9 @@
     "monaco-themes": "^0.3.3",
     "nanoid": "^3.1.30",
     "opentype.js": "^1.3.3",
-    "pixi-particles": "^4.2.1",
+    "pixi-particles": "4.3.1",
     "pixi.js-legacy": "5.3.11",
+    "pixi.js": "5.3.11",
     "png2icons": "^2.0.1",
     "serve-handler": "^6.1.3",
     "terser": "^5.3.5",

devSetup.gulpfile.js

@@ -1,10 +1,14 @@
 'use strict';
 
+const versions = require('./versions');
+
 /* eslint no-console: 0 */
 const spawnise = require('./node_requires/spawnise'),
       gulp = require('gulp'),
       minimist = require('minimist');
 
+const fs = require('fs-extra');
+
 const argv = minimist(process.argv.slice(2));
 
 spawnise.logs = argv.logs || false; // gulp --logs
@@ -31,7 +35,6 @@ const npmInstall = path => done => {
 
 const bakeDocs = async () => {
     const npm = (/^win/).test(process.platform) ? 'npm.cmd' : 'npm';
-    const fs = require('fs-extra');
     await fs.remove('./app/data/docs/');
     await spawnise.spawn(npm, ['run', 'build'], {
         cwd: './docs'
@@ -42,6 +45,14 @@ const bakeDocs = async () => {
 const updateGitSubmodules = () =>
     spawnise.spawn('git', ['submodule', 'update', '--init', '--recursive']);
 
+const makeVSCodeLaunchJson = () => {
+    const template = require('./.vscode/launch-template.json');
+    template.configurations.find(c => c.type === 'nwjs').nwjsVersion = versions.nwjs;
+    return fs.outputJson('./.vscode/launch.json', template, {
+        spaces: 4
+    });
+};
+
 const defaultTask = gulp.series([
     updateGitSubmodules,
     gulp.parallel([
@@ -50,7 +61,10 @@ const defaultTask = gulp.series([
         npmInstall('./docs')
     ]),
     cleanup,
-    bakeDocs
+    gulp.parallel([
+        bakeDocs,
+        makeVSCodeLaunchJson
+    ])
 ]);
 
 gulp.task('default', defaultTask);

gulpfile.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const versions = require('./versions');
+
 /* eslint no-console: 0 */
 const path = require('path'),
       gulp = require('gulp'),
@@ -45,7 +47,7 @@ const path = require('path'),
  */
 const nwSource = void 0;
 const nwManifest = void 0;
-const nwVersion = '0.59.0',
+const nwVersion = versions.nwjs,
       platforms = ['osx64', 'win32', 'win64', 'linux32', 'linux64'],
       nwFiles = ['./app/**', '!./app/export/**', '!./app/projects/**', '!./app/exportDesktop/**', '!./app/cache/**', '!./app/.vscode/**', '!./app/JamGames/**'];
 

src/node_requires/exporter/index.js

@@ -190,14 +190,15 @@ const exportCtProject = async (project, projdir, production) => {
 
     /* Pixi.js */
     if (settings.rendering.usePixiLegacy) {
-        await fs.copyFile(basePath + 'ct.release/pixi-legacy.min.js', path.join(writeDir, '/pixi.min.js'));
-        await fs.copyFile(basePath + 'ct.release/pixi-legacy.min.js.map', path.join(writeDir, '/pixi-legacy.min.js.map'));
+        await fs.copyFile('./node_modules/pixi.js-legacy/dist/pixi-legacy.min.js', path.join(writeDir, '/pixi.min.js'));
+        await fs.copyFile('./node_modules/pixi.js-legacy/dist/pixi-legacy.min.js.map', path.join(writeDir, '/pixi-legacy.min.js.map'));
     } else {
-        await fs.copyFile(basePath + 'ct.release/pixi.min.js', path.join(writeDir, '/pixi.min.js'));
-        await fs.copyFile(basePath + 'ct.release/pixi.min.js.map', path.join(writeDir, '/pixi.min.js.map'));
+        await fs.copyFile('./node_modules/pixi.js/dist/pixi.min.js', path.join(writeDir, '/pixi.min.js'));
+        await fs.copyFile('./node_modules/pixi.js/dist/pixi.min.js.map', path.join(writeDir, '/pixi.min.js.map'));
     }
     if (project.emitterTandems && project.emitterTandems.length) {
-        await fs.copyFile(basePath + 'ct.release/pixi-particles.min.js', path.join(writeDir, '/pixi-particles.min.js'));
+        await fs.copyFile('./node_modules/pixi-particles/dist/pixi-particles.min.js', path.join(writeDir, '/pixi-particles.min.js'));
+        await fs.copyFile('./node_modules/pixi-particles/dist/pixi-particles.min.js.map', path.join(writeDir, '/pixi-particles.min.js.map'));
     }
 
     const startroom = getStartingRoom(project);

versions.js

@@ -0,0 +1,37 @@
+/*
+ * This file returns versions for nw.js and pixi.js, as well as checks
+ * that pixi.js versions used for game packaging are the same.
+ */
+
+const appManifest = require('./app/package.json');
+
+const unfixedRegex = /^[~^]|^[\d.]+-[\d.]+$/;
+
+const versionMessage = 'versions.js has found an error in ct.js configuration!';
+const makeTab = () => console.error(`╭─${'─'.repeat(versionMessage.length)}─╮
+│ ${versionMessage} │
+╰─${'─'.repeat(versionMessage.length)}─╯`);
+
+const packagesToCheck = {
+    pixi: 'pixi.js',
+    pixiLegacy: 'pixi.js-legacy',
+    pixiParticles: 'pixi-particles'
+};
+const packageVersions = {};
+for (const packageKey in packagesToCheck) {
+    packageVersions[packageKey] = appManifest.dependencies[packagesToCheck[packageKey]];
+    if (!packageVersions[packageKey] || unfixedRegex.test(packageVersions[packageKey])) {
+        makeTab();
+        throw new Error(`${packageKey} package used in the app folder is not set to a fixed version. This must be fixed. Current value is "${packageVersions[packageKey]}".`);
+    }
+}
+
+if (packageVersions.pixi !== packageVersions.pixiLegacy) {
+    makeTab();
+    throw new Error(`pixi.js-legacy and pixi.js packages in the app folder are not equal. This must be fixed. Current values are "${packageVersions.pixiLegacy}" for pixi.js-legacy and "${packageVersions.pixi}" for pixi.js.`);
+}
+
+module.exports = {
+    nwjs: '0.59.0',
+    ...packageVersions
+};