Merge pull request #11 from regal/feat/5-ts-option

feat(bundle): Implement bundler.input.ts option

.vscode/settings.json

@@ -2,5 +2,8 @@
     "[typescript]": {
         "editor.formatOnSave": true,
     },
+    "[javascript]": {
+        "editor.formatOnSave": true,
+    },
     "tslint.autoFixOnSave": true
 }

jest.config.js

@@ -1,7 +1,6 @@
 module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  collectCoverageFrom: [
-    "src/**"
-  ]
-};
+    preset: "ts-jest",
+    testEnvironment: "node",
+    collectCoverageFrom: ["src/**"],
+    setupTestFrameworkScriptFile: "<rootDir>/test/jest-setup.js"
+};

src/bundle.ts

@@ -1,5 +1,5 @@
-import { GameMetadata } from "regal";
 import * as rollup from "rollup";
+import * as _commonjs from "rollup-plugin-commonjs";
 import * as insert from "rollup-plugin-insert";
 import * as _json from "rollup-plugin-json";
 import * as _resolve from "rollup-plugin-node-resolve";
@@ -13,32 +13,52 @@ import { BundlerOptions, RecursivePartial } from "./interfaces-public";
 const json = _json;
 const resolve = _resolve;
 const typescript = _typescript;
+const commonjs = _commonjs;
 
-export const bundleFooter = (md: GameMetadata) => `
+const esFooter = (metadata: string) => `
 import { Game } from "regal";
 /** Initialize game **/
-Game.init(${JSON.stringify(md, undefined, 2)});
+Game.init(${metadata});
 export { Game as default };
 `;
 
+const cjsFooter = (metadata: string) => `
+const Game = require("regal").Game;
+/** Initialize game **/
+Game.init(${metadata});
+module.exports = Game;
+`;
+
+export const bundleFooter = (config: LoadedConfiguration) => {
+    const footer = config.bundler.input.ts ? esFooter : cjsFooter;
+    return footer(JSON.stringify(config.game, undefined, 2));
+};
+
 export const bundleHeader = () => "/** BUNDLED GAME */";
 
 export const getPlugins = (config: LoadedConfiguration): rollup.Plugin[] => {
     const plugins: rollup.Plugin[] = [];
 
     plugins.push(
-        (typescript as any)({
-            tsconfigOverride: {
-                compilerOptions: { module: "es2015" }
-            }
+        insert.append(bundleFooter(config), {
+            include: config.bundler.input.file
         }),
         resolve(),
-        json({ exclude: "node_modules/**" }),
-        insert.append(bundleFooter(config.game), {
-            include: config.bundler.input.file
-        })
+        json({ exclude: "node_modules/**" })
     );
 
+    if (config.bundler.input.ts) {
+        plugins.unshift(
+            (typescript as any)({
+                tsconfigOverride: {
+                    compilerOptions: { module: "es2015" }
+                }
+            })
+        );
+    } else {
+        plugins.push(commonjs());
+    }
+
     if (config.bundler.output.minify) {
         plugins.push(terser({ output: { preamble: bundleHeader() } }));
     }

src/get-config.ts

@@ -38,13 +38,15 @@ export const loadUserConfig = async (
     const searchResult = await explorer.search(configLocation);
 
     if (searchResult === null) {
-        config = {
-            game: {}
-        };
+        config = {};
     } else {
         config = searchResult.config;
     }
 
+    if (config.game === undefined) {
+        config.game = {};
+    }
+
     const pkgPath = path.join(configLocation, "package.json");
     const pkg = await import(pkgPath);
 

test/cases/js-basic/js-basic.test.ts

@@ -0,0 +1,38 @@
+import { GameApi } from "regal";
+import { lines } from "../../test-utils";
+
+// @ts-ignore: import will be resolved
+import { bundle } from "../../../dist/regal-bundler.cjs.js";
+
+describe("Case: JS Basic", () => {
+    beforeAll(async () => {
+        await bundle({ configLocation: __dirname });
+    });
+
+    it("Creates a functional bundle without typescript", async () => {
+        // @ts-ignore: import will be resolved
+        const Game: GameApi = await import("./js-basic.regal.js");
+
+        let response = Game.postStartCommand();
+        expect(response.output.wasSuccessful).toBe(true);
+        expect(lines(response)).toEqual(["Game initialized to zero."]);
+
+        response = Game.postPlayerCommand(response.instance, "inc");
+        expect(response.output.wasSuccessful).toBe(true);
+        expect(lines(response)).toEqual([
+            "Game state incremented from 0 to 1."
+        ]);
+
+        for (let i = 0; i < 5; i++) {
+            response = Game.postPlayerCommand(response.instance, "dec");
+        }
+        expect(response.output.wasSuccessful).toBe(true);
+        expect(lines(response)).toEqual([
+            "Game state decremented from -3 to -4."
+        ]);
+
+        response = Game.postPlayerCommand(response.instance, "woof");
+        expect(response.output.wasSuccessful).toBe(true);
+        expect(lines(response)).toEqual(["Command not recognized: 'woof'."]);
+    });
+});

test/cases/js-basic/package.json

@@ -0,0 +1,14 @@
+{
+    "name": "js-basic",
+    "author": "author",
+    "regal": {
+        "bundler": {
+            "input": {
+                "ts": false
+            }
+        }
+    },
+    "dependencies": {
+        "regal": "^0.7.1"
+    }
+}

test/cases/js-basic/src/index.js

@@ -0,0 +1,29 @@
+const regal = require("regal");
+
+const init = regal.on("INIT", game => {
+    game.output.write("Game initialized to zero.");
+    game.state.num = 0;
+});
+
+const incr = regal.on("INCR", game =>
+    game.output.write(
+        `Game state incremented from ${game.state.num} to ${++game.state.num}.`
+    )
+);
+
+const decr = regal.on("DECR", game =>
+    game.output.write(
+        `Game state decremented from ${game.state.num} to ${--game.state.num}.`
+    )
+);
+
+regal.onStartCommand(init);
+regal.onPlayerCommand(cmd => game => {
+    if (cmd.startsWith("i")) {
+        return incr;
+    } else if (cmd.startsWith("d")) {
+        return decr;
+    }
+    game.output.write(`Command not recognized: '${cmd}'.`);
+    return regal.noop;
+});

test/jest-setup.js

@@ -0,0 +1 @@
+jest.setTimeout(10000);

test/unit/bundle.test.ts

@@ -93,5 +93,21 @@ describe("Bundle", () => {
             const plugins = getPlugins(config);
             expect(plugins.find(p => p.name === "terser")).toBeUndefined();
         });
+
+        it("Includes typescript plugin if input.ts is true", () => {
+            const config = sampleConfig();
+            config.bundler.input.ts = true;
+
+            const plugins = getPlugins(config);
+            expect(plugins.find(p => p.name === "rpt2")).not.toBeUndefined();
+        });
+
+        it("Does not include typescript plugin if input.ts is false", () => {
+            const config = sampleConfig();
+            config.bundler.input.ts = false;
+
+            const plugins = getPlugins(config);
+            expect(plugins.find(p => p.name === "rpt2")).toBeUndefined();
+        });
     });
 });