@next2d/builder 0.0.2 → 0.0.4

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Next2D
+Copyright (c) 2021 - 2023 Next2D
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -7,10 +7,10 @@ Multi-platform Builder
 [![license](https://img.shields.io/github/license/Next2D/builder)](https://github.com/Next2D/builder/blob/main/LICENSE)
 
 [日本語]\
-Next2D Frameworkのマルチプラットフォームビルダー、macOS、Windows、iOS、Android、Web（HTML）など、各種プラットフォームへの書き出しに対応
+Next2D Frameworkのマルチプラットフォームビルダー、Steam用のWindows、macOS、Linux、スマートフォン(iOS、Android)、Web（HTML）など、各種プラットフォームへの書き出しに対応
 
 [English]\
-Next2D Framework multi-platform builder, supports export to various platforms including macOS, Windows, iOS, Android, and Web (HTML)
+Multi-platform builder for Next2D Framework, export to various platforms including Windows, macOS, Linux, Smartphones (iOS, Android) and Web (HTML) for Steam
 
 ## Supported
 
@@ -28,10 +28,10 @@ Next2D Framework multi-platform builder, supports export to various platforms in
 npx @next2d/builder --platform web --env prd
 ```
 
-### debug example.
+### preview example.
 
 ```linux
-npx @next2d/builder --debug --platform web --env prd
+npx @next2d/builder --preview --platform web --env prd
 ```
 
 ## License

package/dist/index.d.ts

@@ -0,0 +1,120 @@
+#!/usr/bin/env node
+declare const cli: any;
+declare const pc: any;
+declare const fs: any;
+declare const cp: any;
+declare const vite: any;
+declare const electronBuilder: any;
+declare const recommendeVersion: number;
+declare const version: string;
+declare let platform: string;
+declare let environment: string;
+declare let hasHelp: boolean;
+declare let preview: boolean;
+/**
+ * @description ヘルプを出力して終了
+ *              Output help and exit
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+declare const echoHelp: () => void;
+/**
+ * @type {string}
+ * @private
+ */
+declare const platformDir: string;
+/**
+ * @type {object}
+ * @private
+ */
+declare let $configObject: any | null;
+/**
+ * @type {string}
+ * @private
+ */
+declare let $buildDir: string;
+/**
+ * @type {string}
+ * @private
+ */
+declare let $outDir: string;
+/**
+ * @return {Promise}
+ * @method
+ * @public
+ */
+declare const loadConfig: () => Promise<void>;
+/**
+ * @description Web用アプリの書き出し関数
+ *              Export function for web applications
+ *
+ * @return {Promise}
+ * @method
+ * @public
+ */
+declare const buildWeb: () => Promise<void>;
+/**
+ * @description Electronの書き出しに必要なconfigを生成
+ *              Generate config for Electron export
+ *
+ * @return {object}
+ * @method
+ * @public
+ */
+declare const generateElectronConfig: () => any;
+/**
+ * @description Electronで読み込むindex.htmlのファイルパスをセット
+ *              Set the file path of index.html to be loaded by Electron
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+declare const setElectronIndexPath: () => void;
+/**
+ * @description Electronで読み込むindex.htmlのファイルパスを初期化
+ *              Initialize the file path of index.html to be loaded by Electron
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+declare const unlinkElectronIndexPath: () => void;
+/**
+ * @description Windows用アプリの書き出し関数
+ *              Export function for Windows apps
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+declare const buildSteam: () => void;
+/**
+ * @description iOSのプロジェクトを生成
+ *              Generate iOS project
+ *
+ * @return {Promise<void>}
+ * @method
+ * @public
+ */
+declare const generateNativeProject: () => Promise<void>;
+/**
+ * @description iOS用アプリの書き出し関数
+ *              Export function for iOS apps
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+declare const runNative: () => void;
+/**
+ * @description ビルドの実行関数
+ *              Build Execution Functions
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+declare const build: () => void;

package/dist/index.js

@@ -0,0 +1,412 @@
+#!/usr/bin/env node
+"use strict";
+const cli = require("@capacitor/cli");
+const pc = require("picocolors");
+const fs = require("fs");
+const cp = require("child_process");
+const vite = require("vite");
+const electronBuilder = require("electron-builder");
+const recommendeVersion = 18;
+const version = process.versions.node;
+if (recommendeVersion > parseInt(version.split(".")[0])) {
+    pc.red(`You are running Node Version:${version}.
+View Generator requires Node ${recommendeVersion} or higher.
+Please update your version of Node.`);
+    process.exit(1);
+}
+let platform = "";
+let environment = "";
+let hasHelp = false;
+let preview = false;
+for (let idx = 0; idx < process.argv.length; ++idx) {
+    switch (process.argv[idx]) {
+        case "--preview":
+            preview = true;
+            break;
+        case "--help":
+        case "--h":
+            hasHelp = true;
+            break;
+        case "--platform":
+            platform = process.argv[++idx].toLowerCase();
+            break;
+        case "--env":
+            environment = process.argv[++idx];
+            break;
+        default:
+            break;
+    }
+    if (hasHelp) {
+        break;
+    }
+}
+if (!platform || !environment) {
+    hasHelp = true;
+}
+/**
+ * @description ヘルプを出力して終了
+ *              Output help and exit
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+const echoHelp = () => {
+    console.log();
+    console.log(pc.green("`--platform` can be specified for macOS, Windows, iOS, Android, and Web"));
+    console.log(pc.green("It is not case sensitive."));
+    console.log();
+    console.log("For build example:");
+    console.log("npx @next2d/builder --platform web --env prd");
+    console.log();
+    console.log("For preview example:");
+    console.log("npx @next2d/builder --preview --platform web --env prd");
+    console.log();
+    process.exit(1);
+};
+if (hasHelp) {
+    echoHelp();
+}
+/**
+ * @type {string}
+ * @private
+ */
+const platformDir = platform.indexOf(":") ? platform.split(":").join("/") : platform;
+/**
+ * @type {object}
+ * @private
+ */
+let $configObject = null;
+/**
+ * @type {string}
+ * @private
+ */
+let $buildDir = "";
+/**
+ * @type {string}
+ * @private
+ */
+let $outDir = "dist";
+// update env variables
+process.env.NEXT2D_EBUILD_ENVIRONMENT = environment;
+process.env.NEXT2D_TARGET_PLATFORM = platform;
+/**
+ * @return {Promise}
+ * @method
+ * @public
+ */
+const loadConfig = () => {
+    return new Promise(async (resolve) => {
+        const packageJson = JSON.parse(fs.readFileSync(`${process.cwd()}/package.json`, { "encoding": "utf8" }));
+        if (packageJson.type !== "module") {
+            packageJson.type = "module";
+            // overwride
+            fs.writeFileSync(`${process.cwd()}/package.json`, JSON.stringify(packageJson, null, 2));
+        }
+        const config = await vite.loadConfigFromFile({
+            "command": "build",
+            "mode": "build"
+        }, `${process.cwd()}/vite.config.ts`);
+        $configObject = config;
+        $outDir = $configObject.config?.build?.outDir || "dist";
+        $buildDir = `${process.cwd()}/${$outDir}/${platformDir}/${environment}`;
+        if (!fs.existsSync(`${$buildDir}`)) {
+            fs.mkdirSync(`${$buildDir}`, { "recursive": true });
+            console.log(pc.green(`create build dir: ${$buildDir}`));
+        }
+        resolve();
+    });
+};
+/**
+ * @description Web用アプリの書き出し関数
+ *              Export function for web applications
+ *
+ * @return {Promise}
+ * @method
+ * @public
+ */
+const buildWeb = () => {
+    return new Promise((resolve) => {
+        const command = `${process.cwd()}/node_modules/.bin/vite`;
+        const stream = cp.spawn(command, [
+            "--outDir",
+            $buildDir,
+            "build"
+        ]);
+        stream.stdout.on("data", (data) => {
+            console.log(data.toString());
+        });
+        stream.on("exit", () => {
+            console.log(pc.green("`HTML` and `JavaScript` files are written out."));
+            console.log();
+            resolve();
+        });
+    });
+};
+/**
+ * @description Electronの書き出しに必要なconfigを生成
+ *              Generate config for Electron export
+ *
+ * @return {object}
+ * @method
+ * @public
+ */
+const generateElectronConfig = () => {
+    let config = {};
+    const configPath = `${process.cwd()}/electron.build.json`;
+    if (!fs.existsSync(configPath)) {
+        console.error(pc.red("The file `electron.build.json` could not be found."));
+        process.exit(1);
+    }
+    config = Object.assign(config, JSON.parse(fs.readFileSync(configPath, { "encoding": "utf8" })));
+    if (!config.appId) {
+        console.log();
+        console.log(pc.red("`appId` is not set."));
+        console.log("Please set `appId` in `electron.build.json`.");
+        console.log();
+        process.exit(1);
+    }
+    switch (platform) {
+        case "windows":
+        case "steam:windows":
+            if (!("win" in config)) {
+                config.win = {
+                    "target": "portable"
+                };
+            }
+            if ("mac" in config) {
+                delete config.mac;
+            }
+            if ("linux" in config) {
+                delete config.linux;
+            }
+            break;
+        case "macos":
+        case "steam:macos":
+            if (!("mac" in config)) {
+                config.mac = {
+                    "target": "dmg"
+                };
+            }
+            if ("win" in config) {
+                delete config.win;
+            }
+            if ("linux" in config) {
+                delete config.linux;
+            }
+            break;
+        default:
+            break;
+    }
+    if (!("directories" in config)) {
+        config.directories = {
+            "output": "dist"
+        };
+    }
+    if (config.directories.output.slice(-1) !== "/") {
+        config.directories.output += "/";
+    }
+    config.directories.output += `${platformDir}/${environment}`;
+    return config;
+};
+/**
+ * @description Electronで読み込むindex.htmlのファイルパスをセット
+ *              Set the file path of index.html to be loaded by Electron
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+const setElectronIndexPath = () => {
+    const htmlFilePath = `${$buildDir}/index.html`;
+    fs.writeFileSync(`${process.cwd()}/electron.index.json`, JSON.stringify({
+        "path": htmlFilePath.replace(process.cwd(), ".").trim()
+    }, null, 2));
+};
+/**
+ * @description Electronで読み込むindex.htmlのファイルパスを初期化
+ *              Initialize the file path of index.html to be loaded by Electron
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+const unlinkElectronIndexPath = () => {
+    const jsonPath = `${process.cwd()}/electron.index.json`;
+    if (fs.existsSync(jsonPath)) {
+        fs.unlinkSync(jsonPath);
+    }
+};
+/**
+ * @description Windows用アプリの書き出し関数
+ *              Export function for Windows apps
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+const buildSteam = () => {
+    const packageJson = JSON.parse(fs.readFileSync(`${process.cwd()}/package.json`, { "encoding": "utf8" }));
+    // edit type
+    packageJson.type = "commonjs";
+    // overwride
+    fs.writeFileSync(`${process.cwd()}/package.json`, JSON.stringify(packageJson, null, 2));
+    // revert type
+    packageJson.type = "module";
+    /**
+     * Electronで読み込むindex.htmlのパスをセット
+     * Set the path to index.html to load in Electron
+     */
+    setElectronIndexPath();
+    if (preview) {
+        const stream = cp.spawn(`${process.cwd()}/node_modules/.bin/electron`, [
+            `${process.cwd()}/electron.js`
+        ]);
+        stream.on("exit", () => {
+            unlinkElectronIndexPath();
+            // reset
+            fs.writeFileSync(`${process.cwd()}/package.json`, JSON.stringify(packageJson, null, 2));
+        });
+        stream.on("disconnect", () => {
+            unlinkElectronIndexPath();
+            // reset
+            fs.writeFileSync(`${process.cwd()}/package.json`, JSON.stringify(packageJson, null, 2));
+        });
+    }
+    else {
+        /**
+         * Electronの書き出しに必要な設定を生成
+         * Generate settings necessary for exporting Electron
+         */
+        const config = generateElectronConfig();
+        console.log(pc.green("Start the `Electron` build process."));
+        const buildObject = {
+            "projectDir": process.cwd(),
+            "config": config
+        };
+        switch (platform) {
+            case "windows":
+            case "steam:windows":
+                buildObject.targets = electronBuilder.Platform.WINDOWS.createTarget();
+                break;
+            case "macos":
+            case "steam:macos":
+                buildObject.targets = electronBuilder.Platform.MAC.createTarget();
+                break;
+            case "linux":
+            case "steam:linux":
+                buildObject.targets = electronBuilder.Platform.LINUX.createTarget();
+                break;
+        }
+        electronBuilder
+            .build(buildObject)
+            .then(() => {
+            unlinkElectronIndexPath();
+            console.log(pc.green("Finished building `Electron`."));
+            // reset
+            fs.writeFileSync(`${process.cwd()}/package.json`, JSON.stringify(packageJson, null, 2));
+        });
+    }
+};
+/**
+ * @description iOSのプロジェクトを生成
+ *              Generate iOS project
+ *
+ * @return {Promise<void>}
+ * @method
+ * @public
+ */
+const generateNativeProject = () => {
+    if (fs.existsSync(`${process.cwd()}/${platform}`)) {
+        return Promise.resolve();
+    }
+    return new Promise((resolve) => {
+        const stream = cp.spawn("npx", ["cap", "add", platform]);
+        let errorCheck = false;
+        stream.stderr.on("data", (error) => {
+            errorCheck = true;
+            console.error(pc.red(error.toString()));
+        });
+        stream.stdout.on("data", (data) => {
+            console.log(data.toString());
+        });
+        stream.on("exit", () => {
+            if (errorCheck) {
+                process.exit(1);
+            }
+            console.log(pc.green(`Successfully generated ${platform} project.`));
+            console.log();
+            resolve();
+        });
+    });
+};
+/**
+ * @description iOS用アプリの書き出し関数
+ *              Export function for iOS apps
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+const runNative = () => {
+    generateNativeProject()
+        .then(() => {
+        /**
+         * Capacitorの書き出しに必要な設定を生成
+         * Generate settings necessary for exporting Capacitor
+         */
+        const config = JSON.parse(fs.readFileSync(`${process.cwd()}/capacitor.config.json`, { "encoding": "utf8" }));
+        config.webDir = `${$outDir}/${platformDir}/${environment}/`;
+        fs.writeFileSync(`${process.cwd()}/capacitor.config.json`, JSON.stringify(config, null, 2));
+        const nodePath = process.argv[0];
+        const filePath = process.argv[1];
+        process.argv = [nodePath, filePath, "run", platform];
+        // run simulator
+        cli.run();
+    });
+};
+/**
+ * @description ビルドの実行関数
+ *              Build Execution Functions
+ *
+ * @return {void}
+ * @method
+ * @public
+ */
+const build = () => {
+    switch (platform) {
+        case "windows":
+        case "macos":
+        case "linux":
+        case "steam:windows":
+        case "steam:macos":
+        case "steam:linux":
+            buildSteam();
+            break;
+        case "ios":
+            if (preview) {
+                runNative();
+            }
+            break;
+        case "android":
+            if (preview) {
+                runNative();
+            }
+            break;
+        case "web":
+            console.log(pc.green("build done."));
+            break;
+        default:
+            echoHelp();
+            break;
+    }
+};
+loadConfig()
+    .then(() => {
+    buildWeb()
+        .then(build)
+        .catch((error) => {
+        console.log(pc.red(error));
+        process.exit(1);
+    });
+});

package/package.json

@@ -1,39 +1,50 @@
 {
   "name": "@next2d/builder",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Multi-platform builder for Next2d Framework, supporting export to various platforms such as macOS, Windows, iOS, Android and Web(HTML)",
-  "author": "Toshiyuki Ienaga <ienaga@tvon.jp>",
+  "author": "Toshiyuki Ienaga <ienaga@next2d.app>",
   "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "homepage": "https://next2d.app",
   "bugs": "https://github.com/Next2D/view-generator/issues",
-  "main": "./index.js",
   "keywords": [
     "Next2D",
+    "JavaScript for Linux",
     "JavaScript for MacOS",
     "JavaScript for Windows",
     "JavaScript for iOS",
     "JavaScript for Android",
-    "Multi-platform"
+    "JavaScript for Steam",
+    "Multi-platform builder"
   ],
   "scripts": {
-    "lint": "eslint index.js"
+    "lint": "eslint src/index.ts",
+    "publish": "tsc"
   },
+  "files": [
+    "dist"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Next2D/builder.git"
   },
   "bin": {
-    "@next2d/builder": "index.js"
+    "@next2d/builder": "dist/index.js"
   },
   "dependencies": {
-    "@capacitor/cli": "^5.0.3",
-    "@next2d/env": "^1.0.1",
-    "@types/node": "^20.1.0",
-    "chalk": "4.1.0",
-    "electron": "^24.2.0",
-    "electron-builder": "^23.6.0"
+    "@capacitor/cli": "^5.5.1",
+    "@types/node": "^20.9.0",
+    "electron": "^27.0.4",
+    "electron-builder": "^24.6.4",
+    "picocolors": "^1.0.0",
+    "vite": "^4.5.0"
   },
   "devDependencies": {
-    "eslint": "^8.40.0"
+    "@typescript-eslint/eslint-plugin": "^6.10.0",
+    "@typescript-eslint/parser": "^6.10.0",
+    "eslint": "^8.53.0",
+    "typescript": "^5.2.2"
   }
 }

package/.eslintignore

@@ -1 +0,0 @@
-**/node_modules/*