@mahameru/cli 0.0.17 → 0.0.18

package/README.md

@@ -0,0 +1,115 @@
+# MahameruJS CLI Utility
+
+[![npm version](https://img.shields.io/npm/v/mahameru.svg)](https://www.npmjs.com/package/mahameru)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+`@mahameru/cli` is the command-line interface for running and building Mahameru-based applications. This package provides the core workflow for local development and project builds from the terminal.
+
+## Installation
+
+Install the CLI globally so the `mahameru` command is available directly from your terminal:
+
+```bash
+npm install -g @mahameru/cli
+```
+
+After that, you can run `mahameru` commands from any Mahameru project.
+
+If you don't have any MahameruJS projects, you can create one by running:
+
+```bash
+npm create mahameru
+```
+
+or
+
+```bash
+npx create-mahameru
+```
+
+and follow the prompts.
+
+## Project Requirements
+
+This CLI expects a `mahameru.config.ts` file in the project root. That file is loaded when running development mode.
+
+Some commands also rely on these project dependencies:
+
+- `tsx` to load the TypeScript config file for the `dev` command
+- `typescript` for the compile step in the `build` command
+- `tsc-alias` to rewrite path aliases after compilation
+
+For application source aliases, prefer `tsconfig.json` paths such as `@/*`. Do not rely on `package.json#imports` for `src/**` files that must run from `dist/` in production.
+
+## Usage
+
+### Development
+
+Run the Mahameru development server with Hot Reload:
+
+```bash
+mahameru dev
+```
+
+Available options:
+
+```bash
+mahameru dev --port 3000
+mahameru dev -p 3000
+mahameru dev --host localhost
+mahameru dev -h localhost
+```
+
+This command will:
+
+- load `mahameru.config.ts`
+- run TypeScript typechecking before each start or restart
+- apply default config values when they are not provided
+- run the Mahameru application from the current project
+- watch `src/**` and `mahameru.config.ts`, then hot reload the development server automatically when files change
+
+This Hot Reload flow refreshes the server during development when project files change. It does not provide browser HMR or module replacement inside the running app.
+If typechecking fails, the error is shown in the console and the dev server will wait until the next valid save before starting again.
+
+### Build
+
+Build the project with TypeScript:
+
+```bash
+mahameru build
+```
+
+This command will:
+
+- run `tsc --project tsconfig.json`
+- run `tsc-alias -p tsconfig.json`
+- fail if compiled `dist/**/*.js` files still contain unresolved `@/` or `#/` specifiers
+
+### Start
+
+Run the production server from the compiled `dist/` output:
+
+```bash
+mahameru start
+```
+
+This command will:
+
+- load `dist/mahameru.config.js`
+- run the Mahameru application using `dist/`, `dist/modules`, and `dist/routes`
+- expect all application path aliases to have been rewritten during `mahameru build`
+
+## Quick Workflow
+
+This CLI is focused on the basic development workflow:
+
+1. Use `mahameru dev` during local development and let Hot Reload refresh the server on file changes.
+2. Use `mahameru build` to produce the TypeScript build output.
+3. Use `@/*` path aliases in `tsconfig.json` when you want non-relative imports inside `src/`.
+4. Run `mahameru start` after a successful build to verify the production output.
+
+## Notes
+
+- If `mahameru.config.ts` is missing, the CLI will stop and show an error.
+- If `tsx`, `typescript`, or `tsc-alias` are not installed in the project, the related command will fail.
+- `mahameru dev` ignores changes inside `dist/` and `node_modules/`.

package/package.json

@@ -1,43 +1,60 @@
-{
-  "name": "@mahameru/cli",
-  "version": "0.0.17",
-  "description": "MahameruJS CLI Utility - The command-line interface for running and building Mahameru-based applications",
-  "bin": {
-    "mahameru": "./bin.js"
-  },
-  "scripts": {
-    "typecheck": "tsc --noEmit --project tsconfig.json",
-    "clean": "rimraf dist",
-    "build": "npm run clean && webpack"
-  },
-  "keywords": [
-    "mahameruJS",
-    "mahameru",
-    "cli",
-    "framework",
-    "nodejs",
-    "typescript",
-    "web-server",
-    "build-tool",
-    "developer-tools",
-    "process-manager"
-  ],
-  "author": "Bintan <hello@bintvn.co>",
-  "license": "ISC",
-  "files": [
-    "bin.js",
-    "mpm"
-  ],
-  "engines": {
-    "node": ">=20.6.0"
-  },
-  "dependencies": {
-    "commander": "^15.0.0",
-    "ora": "^9.4.1",
-    "picocolors": "^1.1.1",
-    "porterman": "^0.0.3",
-    "socket.io": "^4.8.3",
-    "tsc-alias": "^1.8.17",
-    "tsx": "^4.22.4"
-  }
-}
+{
+  "name": "@mahameru/cli",
+  "version": "0.0.18",
+  "description": "MahameruJS CLI Utility - The command-line interface for running and building Mahameru-based applications",
+  "bin": {
+    "mahameru": "./cli.js"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit --project tsconfig.json",
+    "clean": "rimraf dist",
+    "build": "npm run clean && webpack",
+    "build:install": "npm run clean && webpack && cd dist && npm i -g ."
+  },
+  "keywords": [
+    "mahameruJS",
+    "mahameru",
+    "cli",
+    "framework",
+    "nodejs",
+    "typescript",
+    "web-server",
+    "build-tool",
+    "developer-tools",
+    "process-manager"
+  ],
+  "author": "Bintan <hello@bintvn.co>",
+  "license": "ISC",
+  "files": [
+    "bin.js",
+    "mpm"
+  ],
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "dependencies": {
+    "commander": "^15.0.0",
+    "ora": "^9.4.1",
+    "picocolors": "^1.1.1",
+    "porterman": "^0.0.3",
+    "socket.io": "^4.8.3",
+    "tsc-alias": "^1.8.17",
+    "tsx": "^4.22.4"
+  },
+  "devDependencies": {
+    "@types/node": "^26.0.0",
+    "@types/socket.io": "^3.0.1",
+    "@types/webpack-node-externals": "^3.0.4",
+    "boxen": "^8.0.1",
+    "rimraf": "^6.1.3",
+    "strip-ansi": "^7.2.0",
+    "terser-webpack-plugin": "^5.6.1",
+    "ts-loader": "^9.6.1",
+    "ts-node": "^10.9.2",
+    "tsconfig-paths-webpack-plugin": "^4.2.0",
+    "typescript": "^6.0.3",
+    "webpack": "^5.107.2",
+    "webpack-cli": "^7.0.3",
+    "webpack-node-externals": "^3.0.0"
+  }
+}