@vc-shell/create-vc-app 1.2.4-beta.8 → 2.0.0-alpha.0

package/README.md

@@ -1,106 +1,76 @@
-# Creating your first application
+# create-vc-app
 
-Make sure you have executed `yarn` command and your current working directory is the one where you intend to create a project.
+Scaffolding tool for VC Shell applications and modules.
 
-## Interactive Mode (Default)
+## Create a New Project
 
-Run following command:
 ```bash
-$ npx create-vc-app
+npx create-vc-app [project-name]
 ```
 
-This command will execute application scaffolding tool. You will be presented with prompts:
+Interactive prompts guide you through project setup. Three project types are available:
 
-```text
-✔ Project name: … <your-app-name>
-✔ Package name: … <your-package-name>
-✔ Base path: … /apps/<your-app-name>/
-✔ Select module variant: › Classic view modules boilerplate
-✔ Module name: … <your-first-module-name>
-✔ Do you want to include additional module with sample data? … No / Yes
+| Type | Description |
+|------|-------------|
+| **Standalone App** | Full application with bundled modules |
+| **Dynamic Module** | Remote module loaded by host via Module Federation |
+| **Host App** | Shell that loads dynamic modules at runtime |
 
-Scaffolding app in ./<your-app-name>...
+### Non-Interactive Mode
 
-Done.
-```
+Pass flags to skip prompts:
 
-## Non-Interactive Mode
+```bash
+# Standalone app with dashboard and sample data
+npx create-vc-app my-app --type standalone --module-name "Products" --dashboard --mocks
 
-For automation, CI/CD, or when you want to skip prompts, you can use command line arguments:
+# Dynamic module
+npx create-vc-app my-module --type dynamic-module --module-name "Reviews"
 
-```bash
-$ npx create-vc-app my-app --variant classic --module-name "My Module" --mocks
+# Host app with tenant routing and AI agent
+npx create-vc-app my-shell --type host-app --dashboard --tenant-routes --ai-agent
 ```
 
-### Available Options
+### Options
 
 | Option | Description | Default |
 |--------|-------------|---------|
-| `--name`, `--app-name` | Name of the application | Directory name |
-| `--package-name` | Package name | App name (validated) |
-| `--variant` | Module variant (classic\|dynamic) | `classic` |
-| `--module-name` | Module name | App name in title case |
-| `--base-path` | Base path for the application | `/apps/<app-name>/` |
-| `--mocks` | Include additional module with sample data | `false` |
+| `--type <type>` | Project type: `standalone` \| `dynamic-module` \| `host-app` | _(prompted)_ |
+| `--name`, `--app-name` | Application name | Directory name |
+| `--package-name` | npm package name | App name (validated) |
+| `--module-name` | Initial module name | App name in title case |
+| `--base-path` | Base path for the application | `/apps/<name>/` |
+| `--tenant-routes` | Include tenant routing (`/:tenantId` prefix) | `false` |
+| `--ai-agent` | Include AI Agent configuration | `false` |
+| `--dashboard` | Include Dashboard with widgets | `false` |
+| `--mocks` | Include sample module with mock data | `false` |
 | `--overwrite` | Overwrite existing files without confirmation | `false` |
-| `--help`, `-h` | Show help message | - |
-| `--version`, `-v` | Show version | - |
+| `--help`, `-h` | Show help | — |
+| `--version`, `-v` | Show version | — |
 
-### Examples
+## Add a Module to Existing Project
 
-**Basic usage:**
-```bash
-npx create-vc-app my-app
-```
+From your project root:
 
-**With custom options:**
 ```bash
-npx create-vc-app my-app --variant classic --module-name "My Module" --mocks
+npx create-vc-app add-module <module-name>
 ```
 
-**With custom paths:**
-```bash
-npx create-vc-app my-app --base-path "/custom/path/" --package-name "@my-org/my-app"
-```
+This will:
+1. Create `src/modules/<module-name>/` with list + details pages
+2. Update `src/main.ts` — add import and `app.use()`
+3. Update `src/bootstrap.ts` — add menu item
 
-**Overwrite existing directory:**
-```bash
-npx create-vc-app existing-dir --overwrite
-```
-
-**Create in current directory:**
-```bash
-npx create-vc-app . --name my-existing-project --overwrite
-```
-
-**Full non-interactive example:**
-```bash
-npx create-vc-app my-ecommerce-app \
-  --variant classic \
-  --module-name "Product Catalog" \
-  --base-path "/apps/ecommerce/" \
-  --package-name "@mycompany/ecommerce-app" \
-  --mocks \
-  --overwrite
-```
+If `main.ts` or `bootstrap.ts` can't be parsed automatically, manual instructions are printed.
 
 ## After Creation
 
-Once app is created, follow the instructions to install dependencies and start dev server:
 ```bash
-$ cd <your-app-name>
-$ yarn
-$ yarn serve
+cd <project-name>
+yarn install
+yarn serve
 ```
 
-## Available Variants
-
-- **classic** - Classic view modules boilerplate (default)
-- **dynamic** - Dynamic view modules boilerplate (coming soon)
-
-## Notes
+## Documentation
 
-- If you provide a project name as the first argument, it will be used as the app name
-- The `--variant` option is required for non-interactive mode
-- Use `--overwrite` to automatically overwrite existing files without confirmation
-- Package names are automatically validated and converted to valid npm package names
+https://docs.virtocommerce.org/platform/developer-guide/latest/custom-apps-development/vc-shell/vc-shell-overview/

package/dist/commands/add-module.d.ts

@@ -0,0 +1,2 @@
+export declare function addModuleCommand(args: Record<string, unknown>, templateRoot: string): Promise<void>;
+//# sourceMappingURL=add-module.d.ts.map

package/dist/commands/add-module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-module.d.ts","sourceRoot":"","sources":["../../src/commands/add-module.ts"],"names":[],"mappings":"AAQA,wBAAsB,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAgFzG"}

package/dist/commands/init.d.ts

@@ -0,0 +1,2 @@
+export declare function initCommand(args: Record<string, unknown>, templateRoot: string): Promise<void>;
+//# sourceMappingURL=init.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/commands/init.ts"],"names":[],"mappings":"AAsBA,wBAAsB,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA+LpG"}

package/dist/engine/codegen.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Add a module import and app.use() call to main.ts
+ */
+export declare function addModuleToMain(mainTsPath: string, moduleName: string): void;
+/**
+ * Add a menu item registration to bootstrap.ts
+ */
+export declare function addMenuItemToBootstrap(bootstrapPath: string, moduleName: string): void;
+//# sourceMappingURL=codegen.d.ts.map

package/dist/engine/codegen.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codegen.d.ts","sourceRoot":"","sources":["../../src/engine/codegen.ts"],"names":[],"mappings":"AAuBA;;GAEG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI,CAuB5E;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACpC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,GACjB,IAAI,CAsCN"}

package/dist/engine/helpers.d.ts

@@ -0,0 +1,19 @@
+export declare function toKebabCase(str: string): string;
+export declare function toPascalCase(str: string): string;
+export declare function toCamelCase(str: string): string;
+export declare function toScreamingSnakeCase(str: string): string;
+export declare function toSentenceCase(str: string): string;
+export declare function isValidPackageName(name: string): boolean;
+export declare function toValidPackageName(name: string): string;
+export declare function toValidBasePath(basePath: string): string;
+export declare function buildTemplateData(options: {
+    moduleName: string;
+    projectName?: string;
+    packageName?: string;
+    basePath?: string;
+    tenantRoutes?: boolean;
+    aiAgent?: boolean;
+    dashboard?: boolean;
+    mocks?: boolean;
+}): Record<string, string | boolean>;
+//# sourceMappingURL=helpers.d.ts.map

package/dist/engine/helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../src/engine/helpers.ts"],"names":[],"mappings":"AAAA,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO/C;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIhD;AAED,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAG/C;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAKxD;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAIlD;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAExD;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAOvD;AAED,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAOxD;AAED,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAC9K,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CA4BlC"}

package/dist/engine/template.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Render a single template file. Strips .ejs extension.
+ * Binary files are copied as-is. Text files are rendered through EJS.
+ */
+export declare function renderTemplate(templatePath: string, outputPath: string, data: Record<string, unknown>): void;
+/**
+ * Recursively render all files in a template directory to an output directory.
+ * Handles file renames (underscore → dot prefix) and EJS variable substitution
+ * in file/directory names.
+ */
+export declare function renderDir(templateDir: string, outputDir: string, data: Record<string, unknown>): void;
+/**
+ * Empty a directory (remove all contents but keep the dir itself).
+ * Preserves .git directory.
+ */
+export declare function emptyDir(dir: string): void;
+/**
+ * Check if a directory is empty (or only has .git)
+ */
+export declare function isDirEmpty(dirPath: string): boolean;
+//# sourceMappingURL=template.d.ts.map

package/dist/engine/template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../../src/engine/template.ts"],"names":[],"mappings":"AAwBA;;;GAGG;AACH,wBAAgB,cAAc,CAC5B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,IAAI,CAmBN;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CACvB,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,IAAI,CA6BN;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAY1C;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAInD"}