create-moost 0.5.22 → 0.5.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-moost",
-  "version": "0.5.22",
+  "version": "0.5.24",
   "description": "create-moost",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -46,8 +46,8 @@
     "@prostojs/rewrite": "^0.1.1",
     "@wooksjs/event-cli": "^0.5.25",
     "prompts": "^2.4.2",
-    "@moostjs/event-cli": "^0.5.22",
-    "moost": "^0.5.22"
+    "@moostjs/event-cli": "^0.5.24",
+    "moost": "^0.5.24"
   },
   "devDependencies": {
     "@moostjs/vite": "^0.5.21",

package/templates/cli/README.md

@@ -0,0 +1,114 @@
+# Moost CLI Template
+
+This template provides a simple CLI application using Moost CLI. It demonstrates how to define commands with decorators, build the project with Rolldown, and run it in different environments.
+
+## Prerequisites
+
+- Node.js (v18 or later)
+- A package manager like [npm](https://www.npmjs.com/)
+
+## Installation
+
+This template is installed via:
+
+```bash
+npm create moost@latest -- --cli
+```
+
+After the setup, navigate into the project folder and install dependencies:
+
+```bash
+cd {{ packageName }}
+npm install
+```
+
+## Running Locally
+
+You can test the CLI in multiple ways:
+
+### 1. Using `npx` (Recommended for testing)
+
+```bash
+npm run build
+npx <project_name> <command> [options]
+```
+
+Example:
+
+```bash
+npx {{ packageName }} hello world
+```
+
+This method does not require global installation but runs slightly slower.
+
+### 2. Running in Development Mode
+
+```bash
+npm run dev <command> [options]
+```
+
+This command builds the project and runs it directly.
+
+### 3. Running a Built Version
+
+```bash
+npm run build
+node ./dist/main.js <command> [options]
+```
+
+This method is useful for testing the production build.
+
+## Building for Production
+
+To compile the CLI for production, run:
+
+```bash
+npm run build
+```
+
+This uses [Rolldown](https://github.com/rolldownjs/rolldown) with the SWC plugin to generate an optimized output in `dist/main.js`.  
+The **SWC plugin** is specifically included to support **decorators**, required for Moost.
+
+## CLI Usage
+
+Once built, you can use the CLI as follows:
+
+```bash
+node ./dist/main.js <command> [options]
+```
+
+Example:
+
+```bash
+node ./dist/main.js hello world
+```
+
+Output:
+
+```
+Hello, world!
+```
+
+To use uppercase:
+
+```bash
+node ./dist/main.js hello world -u
+```
+
+Output:
+
+```
+HELLO, WORLD!
+```
+
+## Files Overview
+
+- **`src/main.ts`** – Defines CLI commands using decorators.
+- **`bin.js`** – CLI entry point with a shebang for execution.
+- **`rolldown.config.ts`** – Build configuration (including SWC for decorators).
+- **`package.json`** – Contains scripts, dependencies, and CLI entry configuration.
+
+## Customization
+
+- **Add New Commands:** Edit `src/main.ts` and use `@Cli`, `@Param`, `@CliOption`, etc.
+- **Modify Help Options:** Adjust `.useHelp()` and `.useOptions()` in `main.ts`.

package/templates/cli/bin.js

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('./dist/main.cjs');
+import('./dist/main.js');

package/templates/cli/package.jsonc

@@ -2,12 +2,20 @@
   "name": "{{ packageName }}",
   "version": "1.0.0",
   "description": "",
-  "main": "dist/main.cjs",
+  "main": "dist/main.js",
+  "type": "module",
+  "bin": {
+    "{{ packageName }}": "./bin.js"
+  },
+  "files": [
+    "dist",
+    "bin.js"
+  ],
   "scripts": {
 //=IF (domelint)
     "postinstall": "npx do-me-lint",
 //=END IF
-    "dev": "pnpm build && node ./dist/main.cjs",
+    "dev": "pnpm build && node ./dist/main.js",
     "build": "rolldown build -c rolldown.config.ts",
     "test": "echo \"Error: no test specified\" && exit 1"
   },

package/templates/cli/rolldown.config.ts

@@ -4,8 +4,8 @@ import swc from 'unplugin-swc';
 export default defineConfig({
     input: 'src/main.ts',
     output: {
-        format: 'cjs',
-        file: 'dist/main.cjs',
+        format: 'esm',
+        file: 'dist/main.js',
     },
     external: ['@moostjs/event-cli', 'moost'],
     plugins: [

package/templates/cli/src/main.ts

@@ -1,18 +1,33 @@
-import { CliApp, Controller, Cli, Param } from '@moostjs/event-cli'
+import { CliApp, Controller, Cli, Param, CliExample, CliOption, Description } from '@moostjs/event-cli'
 
 @Controller()
 class Commands {
+    @CliExample('hello world', 'Prints "Hello, world!"')
+    @CliExample('hello world -u', 'Prints "HELLO, WORLD!"')
     @Cli('hello/:name')
-    greet(@Param('name') name: string) {
-        return `Hello, ${name}!`
+    greet(
+        @Description('A name to greet')
+        @Param('name')
+        name: string,
+
+        @Description('Whether to print the greeting in uppercase')
+        @CliOption('uppercase', 'u')
+        uppercase: boolean,
+    ) {
+        const output = `Hello, ${name}!`
+        return uppercase ? output.toUpperCase() : output
     }
 }
 
+/**
+ * npm run dev hello world
+ */
 function run() {
   new CliApp()
     .controllers(Commands)
-    .useHelp({ name: '{{ packageName }}'})
+    .useHelp({ name: 'cli-app', title: 'CLI APP'})
     .useOptions([{ keys: ['help'], description: 'Display instructions for the command.' }])
+    .start()
 }
 
 run()