@mahameru/cli 0.0.14 → 0.0.16
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -7
- package/{dist/index.js → bin.js} +532 -372
- package/package.json +9 -5
package/README.md
CHANGED
|
@@ -7,13 +7,13 @@
|
|
|
7
7
|
|
|
8
8
|
## Installation
|
|
9
9
|
|
|
10
|
-
Install
|
|
10
|
+
Install the CLI globally so the `mahameru` command is available directly from your terminal:
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
npm install @mahameru/cli
|
|
13
|
+
npm install -g @mahameru/cli
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
After that, you can run `mahameru` commands from any Mahameru project.
|
|
17
17
|
|
|
18
18
|
If you don't have any MahameruJS projects, you can create one by running:
|
|
19
19
|
|
|
@@ -45,7 +45,7 @@ For application source aliases, prefer `tsconfig.json` paths such as `@/*`. Do n
|
|
|
45
45
|
|
|
46
46
|
### Development
|
|
47
47
|
|
|
48
|
-
Run the Mahameru development server:
|
|
48
|
+
Run the Mahameru development server with Hot Reload:
|
|
49
49
|
|
|
50
50
|
```bash
|
|
51
51
|
mahameru dev
|
|
@@ -63,11 +63,13 @@ mahameru dev -h localhost
|
|
|
63
63
|
This command will:
|
|
64
64
|
|
|
65
65
|
- load `mahameru.config.ts`
|
|
66
|
+
- run TypeScript typechecking before each start or restart
|
|
66
67
|
- apply default config values when they are not provided
|
|
67
68
|
- run the Mahameru application from the current project
|
|
68
|
-
- watch `src/**` and `mahameru.config.ts`, then
|
|
69
|
+
- watch `src/**` and `mahameru.config.ts`, then hot reload the development server automatically when files change
|
|
69
70
|
|
|
70
|
-
This
|
|
71
|
+
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.
|
|
72
|
+
If typechecking fails, the error is shown in the console and the dev server will wait until the next valid save before starting again.
|
|
71
73
|
|
|
72
74
|
### Build
|
|
73
75
|
|
|
@@ -101,7 +103,7 @@ This command will:
|
|
|
101
103
|
|
|
102
104
|
This CLI is focused on the basic development workflow:
|
|
103
105
|
|
|
104
|
-
1. Use `mahameru dev` during local development and let
|
|
106
|
+
1. Use `mahameru dev` during local development and let Hot Reload refresh the server on file changes.
|
|
105
107
|
2. Use `mahameru build` to produce the TypeScript build output.
|
|
106
108
|
3. Use `@/*` path aliases in `tsconfig.json` when you want non-relative imports inside `src/`.
|
|
107
109
|
4. Run `mahameru start` after a successful build to verify the production output.
|