brick-engine-cli 1.0.1

package/.github/workflows/publish.yml

@@ -0,0 +1,75 @@
+name: Publish and Deploy
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # ensures history is available for tag and push
+          token: ${{ secrets.GITHUB_TOKEN }} # Needed to push back to the repository
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "22"
+          registry-url: "https://registry.npmjs.org/"
+
+      - name: Validate NPM Token
+        run: npm whoami
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Inject Secrets
+        run: |
+          sed -i "s|%%SUPABASE_URL%%|${{ secrets.SUPABASE_URL }}|g" src/config/constants.ts
+          sed -i "s|%%SUPABASE_ANON_KEY%%|${{ secrets.SUPABASE_ANON_KEY }}|g" src/config/constants.ts
+
+      - name: Build project
+        run: npm run build
+
+      - name: Configure Git
+        run: |
+          git config --global user.name 'LeonardoPinheiroLacerda'
+          git config --global user.email 'leon.lacerda2015@gmail.com'
+
+      - name: Bump Version
+        run: |
+          npm version patch --no-git-tag-version
+          VERSION=$(node -p "require('./package.json').version")
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+          git add package.json package-lock.json
+          git commit -m "chore: bump version to v${VERSION} [skip ci]"
+          git tag -a "v${VERSION}" -m "Version ${VERSION}"
+
+      - name: Push adjustments
+        run: |
+          git push origin HEAD:${{ github.ref }}
+          git push origin --tags
+
+      - name: Publish to NPM
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create "v${{ env.VERSION }}" \
+            --title "Release v${{ env.VERSION }}" \
+            --generate-notes

package/README.adoc

@@ -0,0 +1,98 @@
+= Brick Engine CLI
+:toc: left
+:sectnums:
+
+CLI to scaffold Brick Engine projects.
+
+== Introduction
+
+`brick-engine-cli` is a command-line tool designed to accelerate game development using the **Brick Engine**. It automates the creation of the project's initial structure, configures build tools and code quality settings, allowing you to start programming your game immediately.
+
+== Installation and Usage
+
+You can use this tool in two main ways:
+
+=== 1. Use Without Installation (Recommended)
+
+The fastest way to get started is using `npx`, which runs the latest version of the tool without requiring a global installation on your system:
+
+[source,bash]
+----
+npx brick-engine-cli init <project-name>
+----
+
+=== 2. Global Installation
+
+If you prefer to have the command permanently available in your terminal, you can install it globally via `npm`:
+
+[source,bash]
+----
+npm install -g brick-engine-cli
+----
+
+After installation, you can use the command directly:
+
+[source,bash]
+----
+brick-engine-cli init <project-name>
+----
+
+== Commands
+
+=== `init <name>`
+
+Initializes a new Brick Engine project in a directory with the provided name.
+
+During the process, you will be asked about:
+* Project description.
+* Whether you want to use **ESLint** to ensure code quality.
+* Whether you want to use **Prettier** for automatic formatting.
+
+=== `publish`
+
+Publishes your game to the Brick Engine platform.
+
+Before uploading, this command automatically builds the project to generate an optimized bundle. Once uploaded, the game enters a review process before becoming publicly available.
+
+During the execution, you will be prompted for:
+* **Developer email**: Used to send notifications regarding the game's review status (approval or rejection).
+
+Upon successful submission, the CLI outputs the Game ID, Version, Bundle URL, and the current status of the publication. The command also safely rejects duplicate publication attempts for the same version.
+
+== Template Scripts
+
+Generated projects come with the following scripts in `package.json`:
+
+=== Development and Build
+
+[cols="1,3"]
+|===
+| Command | Description
+
+| `npm start`
+| Starts the development server with hot reload and opens the browser in `standalone` mode.
+
+| `npm run build:standalone`
+| Generates the production version of the game in the `/dist` folder for independent web hosting.
+
+| `npm run build:bundle`
+| Generates an optimized bundle to be loaded at link:https://brickengine.com.br[brickengine.com.br], where you can play all previously published games directly in the browser.
+
+| `npm run serve`
+| Starts a local HTTP server to test the production version generated in `/dist`.
+|===
+
+=== Code Quality (Optional)
+
+If you selected these options during `init`:
+
+[cols="1,3"]
+|===
+| Command | Description
+
+| `npm run format`
+| Automatically formats the code using **Prettier**.
+
+| `npm run lint`
+| Runs **ESLint** to find issues in the code.
+|===

package/bin/brick-cli.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+
+// Try to load the compiled index.js
+let main;
+try {
+    main = require('../dist/index.js');
+} catch (e) {
+    console.error('Error: CLI not built. Please run "npm run build" in the CLI package.');
+    process.exit(1);
+}
+
+main.run();

package/dist/commands/init/index.d.ts

@@ -0,0 +1 @@
+export declare function initCommand(projectName: string): Promise<void>;

package/dist/commands/init/index.js

@@ -0,0 +1,67 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initCommand = initCommand;
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const chalk_1 = __importDefault(require("chalk"));
+const inquirer_1 = __importDefault(require("inquirer"));
+const template_1 = require("./template");
+const package_1 = __importDefault(require("./package/package"));
+async function initCommand(projectName) {
+    const targetDir = path_1.default.resolve(process.cwd(), projectName);
+    const templateDir = path_1.default.resolve(__dirname, "../../../templates");
+    // Check if directory already exists
+    if (fs_extra_1.default.existsSync(targetDir)) {
+        throw new Error(`Directory ${projectName} already exists.`);
+    }
+    console.log(chalk_1.default.bold.blue("\n🧱 Brick Engine CLI") +
+        chalk_1.default.gray(" - Scaffolding your next masterpiece\n"));
+    // Ask user if they want to use Prettier and ESLint
+    const answers = await inquirer_1.default.prompt([
+        {
+            type: "input",
+            name: "description",
+            message: "How would you describe your game?",
+            default: "A fantastic game built with Brick Engine",
+        },
+        {
+            type: "confirm",
+            name: "usePrettier",
+            message: "Would you like to use Prettier for code formatting?",
+            default: true,
+        },
+        {
+            type: "confirm",
+            name: "useESLint",
+            message: "Would you like to use ESLint for linting?",
+            default: true,
+        },
+    ]);
+    try {
+        console.log("");
+        // Create project directory
+        await fs_extra_1.default.ensureDir(targetDir);
+        console.log(`${chalk_1.default.green("✔")} Directory ${chalk_1.default.cyan(projectName)} created.`);
+        await (0, template_1.moveTemplate)(templateDir, targetDir, answers);
+        console.log(`${chalk_1.default.green("✔")} Template files copied.`);
+        const pkgJson = (0, package_1.default)(projectName, answers);
+        await fs_extra_1.default.writeFile(path_1.default.join(targetDir, "package.json"), JSON.stringify(pkgJson, null, 2));
+        console.log(`${chalk_1.default.green("✔")} package.json created.`);
+        console.log(`\n✨ ${chalk_1.default.bold.green("Success!")} Project ${chalk_1.default.cyan(projectName)} is ready.\n`);
+        console.log(chalk_1.default.bold("Next steps:"));
+        console.log(chalk_1.default.gray("───────────────────────────────────"));
+        console.log(`  1. ${chalk_1.default.cyan(`cd ${projectName}`)}`);
+        console.log(`  2. ${chalk_1.default.cyan("npm install")}`);
+        console.log(`  3. ${chalk_1.default.cyan("npm start")}`);
+        console.log(chalk_1.default.gray("───────────────────────────────────"));
+        console.log(`\n🌐 Local URL (after starting): ${chalk_1.default.underline.blue("http://localhost:8080")}`);
+        console.log(`📖 Documentation: ${chalk_1.default.underline.gray("https://github.com/LeonardoPinheiroLacerda/brick-engine")}\n`);
+    }
+    catch (error) {
+        console.error(chalk_1.default.red("\n✖ Initialization failed."));
+        throw error;
+    }
+}

package/dist/commands/init/package/dependencies.d.ts

@@ -0,0 +1,2 @@
+import { Answers, Dependency } from "../types";
+export default function devDependencies(answers: Answers): Dependency[];

package/dist/commands/init/package/dependencies.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = devDependencies;
+function devDependencies(answers) {
+    return [
+        {
+            name: "brick-engine-js",
+            version: "latest",
+            shouldInstall: true,
+        },
+    ];
+}

package/dist/commands/init/package/devDependencies.d.ts

@@ -0,0 +1,2 @@
+import { Answers, Dependency } from "../types";
+export default function devDependencies(answers: Answers): Dependency[];

package/dist/commands/init/package/devDependencies.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = devDependencies;
+function devDependencies(answers) {
+    return [
+        {
+            name: "prettier",
+            version: "^3.1.0",
+            shouldInstall: answers.usePrettier,
+        },
+        {
+            name: "eslint",
+            version: "^9.20.0",
+            shouldInstall: answers.useESLint,
+        },
+        {
+            name: "typescript-eslint",
+            version: "^8.24.0",
+            shouldInstall: answers.useESLint,
+        },
+        {
+            name: "@eslint/js",
+            version: "^9.20.0",
+            shouldInstall: answers.useESLint,
+        },
+        {
+            name: "globals",
+            version: "^15.15.0",
+            shouldInstall: answers.useESLint,
+        },
+        {
+            name: "copy-webpack-plugin",
+            version: "^13.0.1",
+            shouldInstall: true,
+        },
+        {
+            name: "css-loader",
+            version: "^7.1.4",
+            shouldInstall: true,
+        },
+        {
+            name: "html-webpack-plugin",
+            version: "^5.6.6",
+            shouldInstall: true,
+        },
+        {
+            name: "mini-css-extract-plugin",
+            version: "^2.10.0",
+            shouldInstall: true,
+        },
+        {
+            name: "ts-loader",
+            version: "^9.5.4",
+            shouldInstall: true,
+        },
+        {
+            name: "typescript",
+            version: "^5.9.3",
+            shouldInstall: true,
+        },
+        {
+            name: "webpack",
+            version: "^5.105.2",
+            shouldInstall: true,
+        },
+        {
+            name: "webpack-cli",
+            version: "^6.0.1",
+            shouldInstall: true,
+        },
+        {
+            name: "webpack-dev-server",
+            version: "^5.2.3",
+            shouldInstall: true,
+        },
+    ];
+}

package/dist/commands/init/package/package.d.ts

@@ -0,0 +1,18 @@
+import { Answers } from "../types";
+export default function packageJson(name: string, answers: Answers): {
+    name: string;
+    description: string;
+    version: string;
+    type: string;
+    main: string;
+    keywords: never[];
+    author: string;
+    license: string;
+    scripts: Record<string, string>;
+    dependencies: Record<string, string>;
+    devDependencies: Record<string, string>;
+    overrides: {
+        ajv: string;
+        minimatch: string;
+    };
+};

package/dist/commands/init/package/package.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = packageJson;
+const dependencies_1 = __importDefault(require("./dependencies"));
+const devDependencies_1 = __importDefault(require("./devDependencies"));
+const scripts_1 = __importDefault(require("./scripts"));
+function packageJson(name, answers) {
+    return {
+        name,
+        description: answers.description,
+        version: "1.0.0",
+        type: "module",
+        main: "index.js",
+        keywords: [],
+        author: "",
+        license: "ISC",
+        scripts: (0, scripts_1.default)(answers).reduce((acc, s) => {
+            if (s.shouldInstall) {
+                acc[s.name] = s.command;
+            }
+            return acc;
+        }, {}),
+        dependencies: (0, dependencies_1.default)(answers).reduce((acc, d) => {
+            if (d.shouldInstall) {
+                acc[d.name] = d.version;
+            }
+            return acc;
+        }, {}),
+        devDependencies: (0, devDependencies_1.default)(answers).reduce((acc, d) => {
+            if (d.shouldInstall) {
+                acc[d.name] = d.version;
+            }
+            return acc;
+        }, {}),
+        overrides: {
+            ajv: "^8.18.0",
+            minimatch: "^10.2.1",
+        },
+    };
+}

package/dist/commands/init/package/scripts.d.ts

@@ -0,0 +1,2 @@
+import { Answers, Scripts } from "../types";
+export default function scripts(answers: Answers): Scripts[];

package/dist/commands/init/package/scripts.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = scripts;
+function scripts(answers) {
+    return [
+        {
+            name: "format",
+            command: 'prettier --write "src/**/*.ts"',
+            shouldInstall: answers.usePrettier,
+        },
+        {
+            name: "lint",
+            command: 'eslint "src/**/*.ts"',
+            shouldInstall: answers.useESLint,
+        },
+        {
+            name: "build:bundle",
+            command: "webpack --mode production --env bundle=bundle",
+            shouldInstall: true,
+        },
+        {
+            name: "build:standalone",
+            command: "webpack --mode production --env bundle=standalone",
+            shouldInstall: true,
+        },
+        {
+            name: "start",
+            command: "webpack serve --open --env bundle=standalone",
+            shouldInstall: true,
+        },
+        {
+            name: "serve",
+            command: "npx http-server ./dist --cors",
+            shouldInstall: true,
+        },
+    ];
+}

package/dist/commands/init/template.d.ts

@@ -0,0 +1,2 @@
+import { Answers } from "./types";
+export declare function moveTemplate(templateDir: string, targetDir: string, answers: Answers): Promise<void>;

package/dist/commands/init/template.js

@@ -0,0 +1,55 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.moveTemplate = moveTemplate;
+const fs = __importStar(require("fs-extra"));
+const path = __importStar(require("path"));
+async function moveTemplate(templateDir, targetDir, answers) {
+    const options = {
+        ".prettierrc": answers.usePrettier,
+        "eslint.config.mjs": answers.useESLint,
+    };
+    await fs.copy(templateDir, targetDir, {
+        filter: (src) => {
+            const basename = path.basename(src);
+            // If the file is specifically disabled in options, don't copy it
+            if (options[basename] === false) {
+                return false;
+            }
+            // Otherwise, return true (copy)
+            return true;
+        },
+    });
+}

package/dist/commands/init/types.d.ts

@@ -0,0 +1,15 @@
+export type Answers = {
+    description: string;
+    usePrettier: boolean;
+    useESLint: boolean;
+};
+export type Dependency = {
+    name: string;
+    version: string;
+    shouldInstall: boolean;
+};
+export type Scripts = {
+    name: string;
+    command: string;
+    shouldInstall: boolean;
+};

package/dist/commands/init/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/commands/publish/index.d.ts

@@ -0,0 +1,4 @@
+export declare function publishCommand(options: {
+    url?: string;
+    key?: string;
+}): Promise<void>;