create-moost 0.4.22 → 0.5.0

package/dist/index.cjs

@@ -51,8 +51,6 @@ async function getPrompts(inputs) {
         targetDir: inputs.name || '',
         projectName: inputs.name || '',
         packageName: inputs.name || '',
-        prettier: !!inputs.prettier,
-        eslint: !!inputs.eslint,
     };
     try {
         const results = await prompts([
@@ -101,25 +99,6 @@ async function getPrompts(inputs) {
                     { title: 'CLI Application', value: 'cli' },
                 ],
             },
-            {
-                name: 'bundler',
-                type: () => {
-                    if (inputs.esbuild && !inputs.rollup) {
-                        predefined.bundler = 'esbuild';
-                        return null;
-                    }
-                    if (!inputs.esbuild && inputs.rollup) {
-                        predefined.bundler = 'rollup';
-                        return null;
-                    }
-                    return 'select';
-                },
-                message: 'Bundler:',
-                choices: [
-                    { title: 'Rollup (recommended)', value: 'rollup' },
-                    { title: 'ESBuild', value: 'esbuild' },
-                ],
-            },
             {
                 name: 'packageName',
                 type: () => (isValidPackageName(predefined.targetDir) ? null : 'text'),
@@ -128,22 +107,17 @@ async function getPrompts(inputs) {
                 validate: (dir) => isValidPackageName(dir) || 'Invalid package.json name',
             },
             {
-                name: 'eslint',
-                type: () => (inputs.eslint ? null : 'toggle'),
-                message: 'Add ESLint for code quality?',
+                name: 'wf',
+                type: () => (inputs.wf ? null : 'toggle'),
+                message: 'Add Moost Workflows Example?',
                 initial: false,
                 active: 'Yes',
                 inactive: 'No',
             },
             {
-                name: 'prettier',
-                type: (prev, values) => {
-                    if (!values.eslint) {
-                        return null;
-                    }
-                    return 'toggle';
-                },
-                message: 'Add Prettier for code formatting?',
+                name: 'domelint',
+                type: () => (inputs.domelint ? null : 'toggle'),
+                message: 'Add do-me-lint (smart eslint installer)?',
                 initial: false,
                 active: 'Yes',
                 inactive: 'No',
@@ -191,7 +165,7 @@ function toValidPackageName(projectName) {
 
 const rw = new rewrite.ProstoRewrite({
     textPattern: [
-        '*.{js,jsx,ts,tsx,txt,json,yml,yaml,md,ini}',
+        '*.{js,jsx,ts,tsx,txt,json,jsonc,yml,yaml,md,ini,css,html}',
         'Dockerfile',
         '*config',
         '.gitignore',
@@ -214,19 +188,11 @@ async function scaffold(data) {
     }
     const templatePath = path.join(__dirname, '../templates', data.type);
     const commonPath = path.join(__dirname, '../templates/common');
+    const wfPath = path.join(__dirname, '../templates/wf');
     const context = { ...data, version };
     const excludeCommon = [];
-    if (!data.eslint) {
-        excludeCommon.push('.eslintrc.json');
-    }
-    if (!data.prettier) {
-        excludeCommon.push('.prettierignore', '.prettierrc');
-    }
-    if (data.bundler !== 'rollup') {
-        excludeCommon.push('rollup.config.js');
-    }
-    if (data.bundler !== 'esbuild') {
-        excludeCommon.push('build.js');
+    if (!data.domelint) {
+        excludeCommon.push('.domelintrc.yml');
     }
     await rw.rewriteDir({
         baseDir: templatePath,
@@ -236,7 +202,19 @@ async function scaffold(data) {
         baseDir: commonPath,
         output: projectDir,
         exclude: excludeCommon,
+        renameFile(filename) {
+            if (filename.endsWith('.jsonc')) {
+                return filename.replace(/c$/, '');
+            }
+            return filename;
+        },
     }, context);
+    if (data.wf) {
+        await rw.rewriteDir({
+            baseDir: wfPath,
+            output: projectDir,
+        }, context);
+    }
 }
 function emptyDirectorySync(directory) {
     if (fs.existsSync(directory)) {
@@ -264,13 +242,11 @@ let CliController = class CliController extends moost.Moost {
         eventCli$1.useAutoHelp() && process.exit(0);
         const prompts = await getPrompts({
             name,
-            eslint: !!eventCli$1.useCliOption('eslint'),
-            prettier: !!eventCli$1.useCliOption('prettier'),
             http: !!eventCli$1.useCliOption('http'),
             cli: !!eventCli$1.useCliOption('cli'),
+            wf: !!eventCli$1.useCliOption('wf'),
+            domelint: !!eventCli$1.useCliOption('domelint'),
             force: !!eventCli$1.useCliOption('force'),
-            esbuild: !!eventCli$1.useCliOption('esbuild'),
-            rollup: !!eventCli$1.useCliOption('rollup'),
         });
         console.log('\nScaffolding a new project...');
         await scaffold(prompts);
@@ -321,11 +297,13 @@ function run() {
         globalCliOptions: [
             { keys: ['http'], description: 'Use Moost HTTP', type: Boolean },
             { keys: ['cli'], description: 'Use Moost CLI', type: Boolean },
-            { keys: ['eslint'], description: 'Add ESLint', type: Boolean },
-            { keys: ['prettier'], description: 'Add Prettier', type: Boolean },
+            { keys: ['wf'], description: 'Add Workflow Adapter', type: Boolean },
+            {
+                keys: ['domelint'],
+                description: 'Add do-me-lint (smart eslint installer)',
+                type: Boolean,
+            },
             { keys: ['force'], description: 'Force Overwrite', type: Boolean },
-            { keys: ['esbuild'], description: 'Use esbuild for builds', type: Boolean },
-            { keys: ['rollup'], description: 'Use rollup for builds', type: Boolean },
         ],
     }));
     void app.init();

package/dist/index.mjs

@@ -49,8 +49,6 @@ async function getPrompts(inputs) {
         targetDir: inputs.name || '',
         projectName: inputs.name || '',
         packageName: inputs.name || '',
-        prettier: !!inputs.prettier,
-        eslint: !!inputs.eslint,
     };
     try {
         const results = await prompts([
@@ -99,25 +97,6 @@ async function getPrompts(inputs) {
                     { title: 'CLI Application', value: 'cli' },
                 ],
             },
-            {
-                name: 'bundler',
-                type: () => {
-                    if (inputs.esbuild && !inputs.rollup) {
-                        predefined.bundler = 'esbuild';
-                        return null;
-                    }
-                    if (!inputs.esbuild && inputs.rollup) {
-                        predefined.bundler = 'rollup';
-                        return null;
-                    }
-                    return 'select';
-                },
-                message: 'Bundler:',
-                choices: [
-                    { title: 'Rollup (recommended)', value: 'rollup' },
-                    { title: 'ESBuild', value: 'esbuild' },
-                ],
-            },
             {
                 name: 'packageName',
                 type: () => (isValidPackageName(predefined.targetDir) ? null : 'text'),
@@ -126,22 +105,17 @@ async function getPrompts(inputs) {
                 validate: (dir) => isValidPackageName(dir) || 'Invalid package.json name',
             },
             {
-                name: 'eslint',
-                type: () => (inputs.eslint ? null : 'toggle'),
-                message: 'Add ESLint for code quality?',
+                name: 'wf',
+                type: () => (inputs.wf ? null : 'toggle'),
+                message: 'Add Moost Workflows Example?',
                 initial: false,
                 active: 'Yes',
                 inactive: 'No',
             },
             {
-                name: 'prettier',
-                type: (prev, values) => {
-                    if (!values.eslint) {
-                        return null;
-                    }
-                    return 'toggle';
-                },
-                message: 'Add Prettier for code formatting?',
+                name: 'domelint',
+                type: () => (inputs.domelint ? null : 'toggle'),
+                message: 'Add do-me-lint (smart eslint installer)?',
                 initial: false,
                 active: 'Yes',
                 inactive: 'No',
@@ -189,7 +163,7 @@ function toValidPackageName(projectName) {
 
 const rw = new ProstoRewrite({
     textPattern: [
-        '*.{js,jsx,ts,tsx,txt,json,yml,yaml,md,ini}',
+        '*.{js,jsx,ts,tsx,txt,json,jsonc,yml,yaml,md,ini,css,html}',
         'Dockerfile',
         '*config',
         '.gitignore',
@@ -212,19 +186,11 @@ async function scaffold(data) {
     }
     const templatePath = join(__dirname, '../templates', data.type);
     const commonPath = join(__dirname, '../templates/common');
+    const wfPath = join(__dirname, '../templates/wf');
     const context = { ...data, version };
     const excludeCommon = [];
-    if (!data.eslint) {
-        excludeCommon.push('.eslintrc.json');
-    }
-    if (!data.prettier) {
-        excludeCommon.push('.prettierignore', '.prettierrc');
-    }
-    if (data.bundler !== 'rollup') {
-        excludeCommon.push('rollup.config.js');
-    }
-    if (data.bundler !== 'esbuild') {
-        excludeCommon.push('build.js');
+    if (!data.domelint) {
+        excludeCommon.push('.domelintrc.yml');
     }
     await rw.rewriteDir({
         baseDir: templatePath,
@@ -234,7 +200,19 @@ async function scaffold(data) {
         baseDir: commonPath,
         output: projectDir,
         exclude: excludeCommon,
+        renameFile(filename) {
+            if (filename.endsWith('.jsonc')) {
+                return filename.replace(/c$/, '');
+            }
+            return filename;
+        },
     }, context);
+    if (data.wf) {
+        await rw.rewriteDir({
+            baseDir: wfPath,
+            output: projectDir,
+        }, context);
+    }
 }
 function emptyDirectorySync(directory) {
     if (existsSync(directory)) {
@@ -262,13 +240,11 @@ let CliController = class CliController extends Moost {
         useAutoHelp() && process.exit(0);
         const prompts = await getPrompts({
             name,
-            eslint: !!useCliOption('eslint'),
-            prettier: !!useCliOption('prettier'),
             http: !!useCliOption('http'),
             cli: !!useCliOption('cli'),
+            wf: !!useCliOption('wf'),
+            domelint: !!useCliOption('domelint'),
             force: !!useCliOption('force'),
-            esbuild: !!useCliOption('esbuild'),
-            rollup: !!useCliOption('rollup'),
         });
         console.log('\nScaffolding a new project...');
         await scaffold(prompts);
@@ -319,11 +295,13 @@ function run() {
         globalCliOptions: [
             { keys: ['http'], description: 'Use Moost HTTP', type: Boolean },
             { keys: ['cli'], description: 'Use Moost CLI', type: Boolean },
-            { keys: ['eslint'], description: 'Add ESLint', type: Boolean },
-            { keys: ['prettier'], description: 'Add Prettier', type: Boolean },
+            { keys: ['wf'], description: 'Add Workflow Adapter', type: Boolean },
+            {
+                keys: ['domelint'],
+                description: 'Add do-me-lint (smart eslint installer)',
+                type: Boolean,
+            },
             { keys: ['force'], description: 'Force Overwrite', type: Boolean },
-            { keys: ['esbuild'], description: 'Use esbuild for builds', type: Boolean },
-            { keys: ['rollup'], description: 'Use rollup for builds', type: Boolean },
         ],
     }));
     void app.init();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-moost",
-  "version": "0.4.22",
+  "version": "0.5.0",
   "description": "create-moost",
   "main": "dist/index.cjs",
   "module": "dist/index.mjs",
@@ -42,10 +42,10 @@
   },
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/create-moost#readme",
   "dependencies": {
-    "@moostjs/event-cli": "0.4.22",
-    "@wooksjs/event-cli": "^0.5.16",
+    "@moostjs/event-cli": "0.5.0",
+    "@wooksjs/event-cli": "^0.5.18",
     "@prostojs/rewrite": "^0.1.1",
-    "moost": "0.4.22",
+    "moost": "0.5.0",
     "prompts": "^2.4.2"
   }
 }

package/templates/common/.domelintrc.yml

@@ -0,0 +1,14 @@
+ignoredRules:
+  # for Moost controllers: they don't typically use 'this'
+  - '@typescript-eslint/class-methods-use-this'
+
+  # For Moost decorators: it's common to pull url route params from the url
+  - max-params
+
+  # Too strict, hinders readability
+  - '@typescript-eslint/strict-boolean-expressions'
+
+  # Empty class is a valid use case for Moost's controller composition
+  - '@typescript-eslint/no-extraneous-class'
+
+  - '@typescript-eslint/consistent-type-imports'

package/templates/common/package.jsonc

@@ -0,0 +1,38 @@
+{
+  "name": "{{ packageName }}",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/main.js",
+  "type": "module",
+  "scripts": {
+//=IF (domelint)
+    "postinstall": "npx do-me-lint",
+//=END IF
+    "dev": "vite dev",
+    "build": "vite build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+//=IF (type === 'http')
+    "@moostjs/event-http": "^{{ version }}",
+//=END IF
+//=IF (wf)
+    "@moostjs/event-wf": "^{{ version }}",
+    "@wooksjs/http-static": "^0.5.18",
+//=END IF
+//=IF (type === 'cli')
+    "@moostjs/event-cli": "^{{ version }}",
+//=END IF
+    "moost": "^{{ version }}"
+  },
+  "devDependencies": {
+    "@moostjs/vite": "^{{ version }}",
+    "@types/node": "^22.10.2",
+    "typescript": "^5.7.2",
+    "unplugin-swc": "^1.5.1",
+    "vite": "^6.0.5"
+  }
+}

package/templates/common/tsconfig.json

@@ -1,15 +1,21 @@
 {
-    "compilerOptions": {
-        "outDir": "dist",
-        "emitDecoratorMetadata": true,
-        "experimentalDecorators": true,
-        "esModuleInterop": true,
-        "moduleResolution": "node",
-        "lib": ["esnext"],
-        "target": "ESNext",
-        "downlevelIteration": true,
-        "strict": true,
-        "skipLibCheck": true
-    },
-    "include": ["src"]
+  "compilerOptions": {
+    "outDir": "dist",
+
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "node",
+
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+
+    "isolatedModules": true,
+    "useDefineForClassFields": true
+  },
+  "exclude": ["node_modules", "dist"],
+  "include": ["src"]
 }

package/templates/common/vite.config.ts

@@ -0,0 +1,13 @@
+import { defineConfig, type Plugin } from "vite";
+import swc from 'unplugin-swc';
+import { moostViteDev } from "@moostjs/vite";
+
+export default defineConfig({
+  plugins: [
+    moostViteDev({
+      entry: "/src/main.ts",
+    }),
+    swc.vite(), 
+  ],
+});
+

package/templates/http/src/controllers/app.controller.ts

@@ -1,10 +1,103 @@
-import { Get } from '@moostjs/event-http'
-import { Controller, Param } from 'moost'
+/**
+ * @file Application Controller for Moost HTTP Template
+ *
+ * This file defines the `AppController` class, which handles HTTP routes within the
+ * Moost framework. The controller manages http endpoints.
+ *
+ * For more information on Moost HTTP, visit https://moost.org/webapp/
+ */
 
+import { Body, Get, Post, SetHeader } from "@moostjs/event-http";
+//=IF (wf)
+import { MoostWf } from "@moostjs/event-wf";
+import { serveFile } from "@wooksjs/http-static";
+//=END IF
+import { Controller, Param } from "moost";
+
+
+//=IF (wf)
+import type {
+  TWfExampleContext,
+  TWfExampleInput,
+  TWfExampleInputSchema,
+  TWfState,
+} from "../workflow/wf.types";
+import { Wf2HtmlPage } from "../workflow/wf2html.interceptor";
+//=END IF
+
+/**
+ * `AppController` manages the application's HTTP routes.
+ */
 @Controller()
 export class AppController {
-    @Get('hello/:name')
-    greet(@Param('name') name: string) {
-        return `Hello, ${name}!`
+//=IF (wf)
+  constructor(
+    private readonly wf: MoostWf<TWfExampleContext, TWfExampleInputSchema>
+  ) {}
+//=END IF
+
+  /**
+   * Handles GET requests to the `/hello/:name` endpoint.
+   *
+   * Responds with a personalized greeting message.
+   *
+   * **Example:**
+   * - Request: `GET /hello/John`
+   * - Response: `Hello John`
+   *
+   * @param {string} name - The name parameter extracted from the URL.
+   * @returns {string} A greeting message.
+   */
+  @Get("hello/:name")
+  hello(@Param("name") name: string): string {
+    return `Hello ${name}`;
+  }
+
+//=IF (wf)
+  /**
+   * Handles both GET and POST requests to the `/wf` endpoint.
+   *
+   * This endpoint is responsible for starting or resuming workflows based on the
+   * provided workflow state and user inputs. It utilizes the `Wf2HtmlPage` interceptor
+   * to convert workflow outputs into HTML pages with forms for user interaction.
+   *
+   * @param {TWfExampleInput | undefined} formInput - The input data from the request body.
+   * @returns {Promise<any>} The workflow's response, rendered as an HTML page.
+   */
+  @Get("wf")
+  @Post("wf")
+  @SetHeader("content-type", "text/html")
+  @Wf2HtmlPage()
+  async startWf(@Body() formInput?: TWfExampleInput) {
+    const { wfState, ...rest } = formInput || {};
+    const input = formInput ? rest : undefined;
+
+    if (typeof wfState === "object") {
+      // Resume an existing workflow with the provided state and input
+      return this.wf.resume<TWfExampleInput>(wfState as TWfState, input);
     }
+
+    // Start a new workflow with the provided input
+    return this.wf.start<TWfExampleInput>("wf-example", {}, input);
+  }
+
+  /**
+   * Serves static files from the `/static` directory.
+   *
+   * Handles GET requests to the `/static/*` endpoint by serving the requested file.
+   *
+   * **Example:**
+   * - Request: `GET /static/wf.css`
+   * - Response: Serves the `wf.css` file from the `./src/static/` directory.
+   *
+   * @param {string} filePath - The path to the static file requested.
+   * @returns {Promise<Buffer | string>} The contents of the requested static file.
+   */
+  @Get("static/*")
+  async serveStaticFile(@Param("*") filePath: string) {
+    return serveFile(`./src/static/${filePath}`, {
+      cacheControl: { maxAge: '1d' },
+    });
+  }
+//=END IF
 }

package/templates/http/src/main.ts

@@ -1,16 +1,49 @@
-import { MoostHttp } from '@moostjs/event-http'
-import { Moost } from 'moost'
-import { AppController } from './controllers/app.controller'
+/**
+ * @file Main Entry Point for Moost Application Template
+ *
+ * This file serves as the primary entry point for the Moost application.
+ *
+ * For more details on Moost Webapp and Moost Workflows, visit:
+ * - Moost Webapp: https://moost.org/webapp/
+ * - Moost Workflows: https://moost.org/wf/
+ */
 
-const app = new Moost()
+import { MoostHttp } from "@moostjs/event-http";
+//=IF (wf)
+import { MoostWf } from "@moostjs/event-wf";
+//=END IF
+import { Moost } from "moost";
 
-void app.adapter(new MoostHttp()).listen(3000, () => {
-    app.getLogger('{{ projectName }}').info('Up on port 3000')
-})
+import { AppController } from "./controllers/app.controller";
+//=IF (wf)
+import { WfController } from "./workflow/wf.controller";
+//=END IF
 
-void app
-    .registerControllers(
-        AppController
-        // Add more controllers here...
-    )
-    .init()
+/**
+ * Initializes and configures the Moost application.
+ *
+ * The application performs the following steps:
+ * 1. Creates a new instance of the Moost application.
+ * 2. Sets up the moost adapters.
+ * 3. Registers controllers.
+ * 4. Initializes the application to start handling incoming events.
+ */
+const app = new Moost();
+
+// Configure the HTTP adapter and start listening on port 3000
+app.adapter(new MoostHttp()).listen(3000, () => {
+  app.getLogger("[{{ projectName }}]").info("Server started on port 3000");
+});
+
+//=IF (wf)
+// Configure the Workflow adapter to handle workflow-related events
+app.adapter(new MoostWf());
+//=END IF
+
+// Register application controllers
+//=IF (wf)
+app.registerControllers(AppController, WfController).init();
+//=END IF
+//=IF (!wf)
+app.registerControllers(AppController).init();
+//=END IF