kimu-cli 0.1.0 → 1.0.0

package/package.json

@@ -1,101 +1,101 @@
-{
-  "name": "kimu-cli",
-  "version": "0.1.0",
-  "description": "Official command-line interface for the KIMU framework ecosystem - Create, build, and manage KIMU applications",
-  "main": "dist/index.js",
-  "bin": {
-    "kimu": "./bin/kimu.js"
-  },
-  "scripts": {
-    "build": "tsc",
-    "dev": "tsc --watch",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "test:coverage": "jest --coverage",
-    "lint": "eslint src/**/*.ts",
-    "lint:fix": "eslint src/**/*.ts --fix",
-    "format": "prettier --write src/**/*.ts",
-    "link": "npm link",
-    "release": "npm run build && npm publish",
-    "prepare": "npm run build",
-    "package": "npm run build && npm pack",
-    "version": "npm run build",
-    "prepublishOnly": "npm run lint",
-    "preversion": "npm run lint",
-    "postversion": "git push && git push --tags"
-  },
-  "keywords": [
-    "kimu",
-    "cli",
-    "framework",
-    "web-components",
-    "typescript",
-    "developer-tools",
-    "scaffolding",
-    "generator",
-    "build-tool",
-    "kimu-framework"
-  ],
-  "author": {
-    "name": "Marco Di Pasquale",
-    "email": "info@unicoverso.com",
-    "url": "https://unicoverso.com"
-  },
-  "license": "MPL-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/UnicoVerso/kimu-cli.git"
-  },
-  "bugs": {
-    "url": "https://github.com/UnicoVerso/kimu-cli/issues"
-  },
-  "homepage": "https://github.com/UnicoVerso/kimu-cli#readme",
-  "engines": {
-    "node": ">=18.0.0",
-    "npm": ">=8.0.0"
-  },
-  "dependencies": {
-    "axios": "^1.6.2",
-    "chalk": "^5.3.0",
-    "commander": "^11.1.0",
-    "fs-extra": "^11.1.1",
-    "glob": "^10.3.10",
-    "inquirer": "^9.2.12",
-    "ora": "^7.0.1",
-    "semver": "^7.5.4",
-    "tar": "^6.2.0",
-    "validate-npm-package-name": "^5.0.0"
-  },
-  "devDependencies": {
-    "@types/fs-extra": "^11.0.4",
-    "@types/inquirer": "^9.0.7",
-    "@types/jest": "^29.5.8",
-    "@types/node": "^20.10.5",
-    "@types/semver": "^7.5.6",
-    "@types/tar": "^6.1.10",
-    "@types/validate-npm-package-name": "^4.0.2",
-    "@typescript-eslint/eslint-plugin": "^6.14.0",
-    "@typescript-eslint/parser": "^6.14.0",
-    "eslint": "^8.55.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-prettier": "^5.0.1",
-    "jest": "^29.7.0",
-    "prettier": "^3.1.1",
-    "ts-jest": "^29.1.1",
-    "typescript": "^5.3.3"
-  },
-  "files": [
-    "dist/**/*",
-    "bin/**/*",
-    "templates/**/*",
-    "README.md",
-    "LICENSE",
-    "CHANGELOG.md",
-    "docs/**/*"
-  ],
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org/"
-  },
-  "preferGlobal": true
-}
+{
+  "name": "kimu-cli",
+  "version": "1.0.0",
+  "description": "Official command-line interface for the KIMU framework ecosystem - Create, build, and manage KIMU applications with extensible template-based generators",
+  "main": "dist/index.js",
+  "bin": {
+    "kimu": "./bin/kimu.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "format": "prettier --write src/**/*.ts",
+    "link": "npm link",
+    "release": "npm run build && npm publish",
+    "prepare": "npm run build",
+    "package": "npm run build && npm pack",
+    "version": "npm run build",
+    "prepublishOnly": "npm run lint",
+    "preversion": "npm run lint",
+    "postversion": "git push && git push --tags"
+  },
+  "keywords": [
+    "kimu",
+    "cli",
+    "framework",
+    "web-components",
+    "typescript",
+    "developer-tools",
+    "scaffolding",
+    "generator",
+    "build-tool",
+    "kimu-framework"
+  ],
+  "author": {
+    "name": "Marco Di Pasquale",
+    "email": "info@unicoverso.com",
+    "url": "https://unicoverso.com"
+  },
+  "license": "MPL-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/UnicoVerso/kimu-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/UnicoVerso/kimu-cli/issues"
+  },
+  "homepage": "https://github.com/UnicoVerso/kimu-cli#readme",
+  "engines": {
+    "node": ">=18.0.0",
+    "npm": ">=8.0.0"
+  },
+  "dependencies": {
+    "axios": "^1.6.2",
+    "chalk": "^5.3.0",
+    "commander": "^11.1.0",
+    "fs-extra": "^11.1.1",
+    "glob": "^10.3.10",
+    "inquirer": "^9.2.12",
+    "ora": "^7.0.1",
+    "semver": "^7.5.4",
+    "tar": "^6.2.0",
+    "validate-npm-package-name": "^5.0.0"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/inquirer": "^9.0.7",
+    "@types/jest": "^29.5.8",
+    "@types/node": "^20.10.5",
+    "@types/semver": "^7.5.6",
+    "@types/tar": "^6.1.10",
+    "@types/validate-npm-package-name": "^4.0.2",
+    "@typescript-eslint/eslint-plugin": "^6.14.0",
+    "@typescript-eslint/parser": "^6.14.0",
+    "eslint": "^8.55.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.1.1",
+    "ts-jest": "^29.1.1",
+    "typescript": "^5.3.3"
+  },
+  "files": [
+    "dist/**/*",
+    "bin/**/*",
+    "templates/**/*",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md",
+    "docs/**/*"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "preferGlobal": true
+}

package/templates/generators/README.md

@@ -0,0 +1,76 @@
+# Generator Templates
+
+This folder contains template configurations for the `kimu new` command.
+
+## Structure
+
+Each generator type has its own folder:
+
+```
+generators/
+├── extension/          # Extension generator
+│   ├── config.json    # Generator configuration
+│   └── templates/     # Template files
+├── module/            # Module generator
+│   ├── config.json
+│   └── templates/
+└── ... (other types)
+```
+
+## Adding a New Generator
+
+1. Create a new folder with the generator name
+2. Add `config.json` with generator configuration
+3. Add template files in `templates/` subfolder
+4. Templates support placeholders like `{{name}}`, `{{className}}`, etc.
+
+## Configuration Schema
+
+```json
+{
+  "name": "extension",
+  "description": "Create a new UI extension",
+  "targetPath": "src/extensions/{{name}}",
+  "files": [
+    {
+      "name": "component.ts",
+      "template": "component.ts.template"
+    },
+    {
+      "name": "style.css",
+      "template": "style.css.template"
+    }
+  ],
+  "registration": {
+    "file": "extension-manifest.json",
+    "type": "array",
+    "entry": {
+      "tag": "{{kebabName}}",
+      "name": "{{titleName}}",
+      "version": "1.0.0"
+    }
+  },
+  "postCreate": [
+    "Edit {{targetPath}}/component.ts to add your logic",
+    "Load it with extensionManager.load('{{name}}')"
+  ]
+}
+```
+
+## Template Placeholders
+
+Available placeholders in templates and config:
+- `{{name}}` - Original name (e.g., "my-feature")
+- `{{className}}` - PascalCase class name (e.g., "MyFeature")
+- `{{kebabName}}` - kebab-case name (e.g., "my-feature")
+- `{{camelName}}` - camelCase name (e.g., "myFeature")
+- `{{titleName}}` - Title Case name (e.g., "My Feature")
+- `{{snakeName}}` - snake_case name (e.g., "my_feature")
+- `{{targetPath}}` - Computed target path
+
+## Notes
+
+- Template files use `.template` extension
+- Placeholders are replaced during generation
+- Registration can be disabled with `--no-register` flag
+- Custom paths can be specified with `--path` option

package/templates/generators/extension/config.json

@@ -0,0 +1,45 @@
+{
+  "name": "extension",
+  "description": "Create a new UI extension with component, styles, and template",
+  "targetPath": "src/extensions/{{name}}",
+  "files": [
+    {
+      "name": "component.ts",
+      "template": "component.ts.template",
+      "description": "Extension logic and lifecycle"
+    },
+    {
+      "name": "style.css",
+      "template": "style.css.template",
+      "description": "Component styles"
+    },
+    {
+      "name": "view.html",
+      "template": "view.html.template",
+      "description": "HTML template"
+    }
+  ],
+  "registration": {
+    "enabled": true,
+    "file": "extension-manifest.json",
+    "type": "array",
+    "entry": {
+      "tag": "{{kebabName}}",
+      "name": "{{titleName}}",
+      "version": "1.0.0",
+      "description": "Description for {{name}} extension",
+      "author": "Your Name",
+      "icon": "🎨",
+      "internal": false,
+      "path": "{{name}}",
+      "dependencies": []
+    }
+  },
+  "postCreate": [
+    "Edit {{targetPath}}/component.ts to add your logic",
+    "Style your component in {{targetPath}}/style.css",
+    "Update the template in {{targetPath}}/view.html",
+    "Extension registered in extension-manifest.json",
+    "Load it with extensionManager.load('{{name}}')"
+  ]
+}

package/templates/generators/extension/templates/component.ts.template

@@ -0,0 +1,66 @@
+import { KimuComponent } from '../../core/kimu-component';
+import { KimuComponentElement } from '../../core/kimu-component-element';
+
+@KimuComponent({
+  tag: '{{kebabName}}',
+  name: '{{titleName}}',
+  version: '1.0.0',
+  description: 'Description for {{name}} extension',
+  author: 'Your Name',
+  icon: '🎨',
+  internal: false,
+  path: '{{name}}',
+  dependencies: []
+})
+export class {{className}}Extension extends KimuComponentElement {
+  /**
+   * Initialize the extension
+   */
+  async onInit(): Promise<void> {
+    console.log('{{className}} extension initialized');
+  }
+
+  /**
+   * Get data for template binding
+   */
+  getData() {
+    return {
+      title: '{{titleName}}',
+      message: 'Welcome to {{name}} extension!'
+    };
+  }
+
+  /**
+   * Called after rendering
+   */
+  onRender(): void {
+    // Add event listeners or DOM manipulations here
+    this.setupEventListeners();
+  }
+
+  /**
+   * Setup event listeners
+   */
+  private setupEventListeners(): void {
+    // Example: Button click handler
+    const button = this.$('#actionButton');
+    if (button) {
+      button.addEventListener('click', () => this.handleAction());
+    }
+  }
+
+  /**
+   * Handle button action
+   */
+  private handleAction(): void {
+    console.log('Action triggered in {{name}}');
+    // Add your logic here
+  }
+
+  /**
+   * Cleanup when extension is destroyed
+   */
+  onDestroy(): void {
+    console.log('{{className}} extension destroyed');
+  }
+}

package/templates/generators/extension/templates/style.css.template

@@ -0,0 +1,40 @@
+/* Styles for {{name}} extension */
+
+.{{name}}-container {
+  padding: 20px;
+  margin: 20px;
+  border-radius: 8px;
+  background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
+  color: white;
+}
+
+.{{name}}-title {
+  font-size: 2em;
+  margin-bottom: 10px;
+  font-weight: bold;
+}
+
+.{{name}}-content {
+  font-size: 1.2em;
+  line-height: 1.6;
+}
+
+.{{name}}-button {
+  margin-top: 20px;
+  padding: 10px 20px;
+  background: white;
+  color: #667eea;
+  border: none;
+  border-radius: 5px;
+  cursor: pointer;
+  font-weight: bold;
+  transition: transform 0.2s;
+}
+
+.{{name}}-button:hover {
+  transform: scale(1.05);
+}
+
+.{{name}}-button:active {
+  transform: scale(0.95);
+}

package/templates/generators/extension/templates/view.html.template

@@ -0,0 +1,9 @@
+<div class="{{name}}-container">
+  <h1 class="{{name}}-title">${title}</h1>
+  <div class="{{name}}-content">
+    <p>${message}</p>
+  </div>
+  <button id="actionButton" class="{{name}}-button">
+    Click Me
+  </button>
+</div>

package/templates/generators/module/config.json

@@ -0,0 +1,35 @@
+{
+  "name": "module",
+  "description": "Create a new service module with module class and service",
+  "targetPath": "src/modules/{{name}}",
+  "files": [
+    {
+      "name": "module.ts",
+      "template": "module.ts.template",
+      "description": "Module class"
+    },
+    {
+      "name": "{{name}}-service.ts",
+      "template": "service.ts.template",
+      "description": "Service implementation"
+    },
+    {
+      "name": "README.md",
+      "template": "README.md.template",
+      "description": "Module documentation"
+    }
+  ],
+  "registration": {
+    "enabled": true,
+    "file": "kimu.config.json",
+    "type": "object",
+    "path": "modules.installed",
+    "entry": "{{name}}"
+  },
+  "postCreate": [
+    "Edit {{targetPath}}/module.ts to implement your module",
+    "Create services in {{targetPath}}/{{name}}-service.ts",
+    "Module registered in kimu.config.json",
+    "Load it with new {{className}}Module()"
+  ]
+}

package/templates/generators/module/templates/README.md.template

@@ -0,0 +1,62 @@
+# {{className}} Module
+
+## Overview
+This module provides {{name}} functionality to KIMU applications.
+
+## Installation
+This module has been created using `kimu new module {{name}}`.
+
+## Usage
+
+### Basic Usage
+```typescript
+import { KimuModuleManager } from '@kimu/core';
+import {{className}}Module from './modules/{{name}}/module';
+
+// Initialize module manager
+const moduleManager = KimuModuleManager.getInstance();
+
+// Load the module
+const {{camelName}}Module = new {{className}}Module();
+await moduleManager.loadModule({{camelName}}Module);
+
+// Get the service
+const {{camelName}}Service = moduleManager.getService('{{name}}');
+```
+
+### Advanced Usage
+```typescript
+// Use the service directly
+import { {{camelName}}Service } from './modules/{{name}}/{{name}}-service';
+
+// Call service methods
+{{camelName}}Service.exampleMethod();
+```
+
+## API Reference
+
+### {{className}}Module
+
+#### Methods
+- `getService()`: Returns the module service instance
+- `init()`: Initializes the module
+- `destroy()`: Cleanup when module is destroyed
+
+### {{className}}Service
+
+#### Methods
+- `getInstance()`: Get the singleton instance
+- `init()`: Initialize the service
+- `exampleMethod()`: Example method implementation
+
+## Configuration
+Add any configuration options for your module here.
+
+## Examples
+Add usage examples here.
+
+## Contributing
+Contributions are welcome! Please follow the KIMU contribution guidelines.
+
+## License
+This module follows the KIMU project license.

package/templates/generators/module/templates/module.ts.template

@@ -0,0 +1,36 @@
+import { KimuModule } from '../../core/kimu-module';
+import { {{camelName}}Service } from './{{name}}-service';
+
+/**
+ * {{className}} Module
+ * 
+ * This module provides {{name}} functionality to KIMU applications.
+ */
+export default class {{className}}Module extends KimuModule {
+  constructor(name = '{{name}}', version = '1.0.0', options?: any) {
+    super(name, version, options);
+  }
+
+  /**
+   * Get the module service instance
+   */
+  getService() {
+    return {{camelName}}Service;
+  }
+
+  /**
+   * Initialize the module
+   */
+  async init(): Promise<void> {
+    console.log('{{className}}Module initialized');
+    // Add initialization logic here
+  }
+
+  /**
+   * Cleanup when module is destroyed
+   */
+  destroy(): void {
+    console.log('{{className}}Module destroyed');
+    // Add cleanup logic here
+  }
+}

package/templates/generators/module/templates/service.ts.template

@@ -0,0 +1,41 @@
+/**
+ * {{className}} Service
+ * 
+ * This service provides {{name}} functionality to KIMU applications.
+ */
+export class {{className}}Service {
+  private static instance: {{className}}Service;
+
+  private constructor() {
+    // Private constructor for singleton pattern
+  }
+
+  /**
+   * Get the singleton instance
+   */
+  static getInstance(): {{className}}Service {
+    if (!{{className}}Service.instance) {
+      {{className}}Service.instance = new {{className}}Service();
+    }
+    return {{className}}Service.instance;
+  }
+
+  /**
+   * Initialize the service
+   */
+  async init(): Promise<void> {
+    console.log('{{className}}Service initialized');
+    // Add initialization logic here
+  }
+
+  /**
+   * Example method
+   */
+  public exampleMethod(): void {
+    console.log('{{className}}Service.exampleMethod called');
+    // Add your method implementation here
+  }
+}
+
+// Export singleton instance
+export const {{camelName}}Service = {{className}}Service.getInstance();