kalo-cli 0.2.27 → 0.3.0

package/README.md

@@ -1,68 +1,102 @@
-# Kalo - Générateur Django & Wagtail
+# Kalo CLI - Django/Wagtail Generator
 
-CLI pour générer du code structuré et uniforme pour Django et Wagtail.
+This is a command-line interface tool for generating Django and Wagtail components using Plop.js.
 
-## Prérequis
+## Features
 
-Ce projet est conçu pour fonctionner avec **Bun**. Vous devez avoir [Bun](https://bun.sh) installé sur votre machine.
+- Generate Django models, views, forms, APIs, and more
+- Generate Wagtail pages, snippets, blocks, and other components
+- Smart file appending to avoid duplicate classes
+- Configuration loading from `kalo.config.json`
+- Project root detection
+- Searchable prompts for selecting existing apps
 
-```bash
-# Installation de Bun (Mac, Linux, WSL)
-curl -fsSL https://bun.sh/install | bash
+## Utilities
 
-# Installation de Bun (Windows)
-powershell -c "irm bun.sh/install.ps1 | iex"
-```
+The project includes several utility modules:
 
-## Installation
+### Analysis Utilities (`src/utils/analysis.ts`)
+- Functions to analyze Python files and extract class definitions
+- Used to prevent duplicate class generation
 
-### Via Bun (Recommandé)
+### Code Manipulation Utilities (`src/utils/code-manipulation.ts`)
+- Functions to inject markers in code for AI-assisted generation
+- Apply generated code with imports, replacements, and code injection
 
-```bash
-bun add -d kalo-cli
-# ou globalement
-bun add -g kalo-cli
-```
+### Configuration Utilities (`src/utils/config.ts`)
+- Load configuration from `kalo.config.json` or `kalo.config.js`
+- Support for AI providers, temperature settings, and verbosity levels
 
+### File System Utilities (`src/utils/filesystem.ts`)
+- Find project root directory
+- Resolve application paths
+- Get list of existing Django applications
+- Get files and directories within an application
 
-## Utilisation
+### Naming Conventions (`src/utils/naming-conventions.ts`)
+- Validation functions for model names, app names, and page names
+- Field validation utilities
 
-### Si installé globalement
+### Plop Actions (`src/utils/plop-actions.ts`)
+- `createAppendActions`: Creates pairs of actions to ensure files exist and append content
+- Prevents duplicate class generation by checking existing classes
 
-```bash
-kalo
-```
+### Search Utilities (`src/utils/search.ts`)
+- Fuzzy searching for autocomplete prompts
+- Filter choices based on user input
 
-### Configuration
+### String Formatting (`src/utils/index.ts`)
+- Format strings to slugs, snake_case, or PascalCase
 
-Vous pouvez personnaliser le comportement de Kalo en créant un fichier `kalo.config.json` ou `kalo.config.js` à la racine de votre projet.
+## Usage
 
-Exemple `kalo.config.json` :
+```bash
+bun run plop # List all available generators
+bun run plop model # Generate a new Django model
+bun run plop view # Generate a new Django view
+bun run plop wagtail-page # Generate a new Wagtail page
+```
+
+## Generators
+
+The project includes generators for:
+
+- Django apps
+- Django models
+- Django views
+- Django forms
+- Django APIs
+- Django QuerySets
+- Wagtail pages
+- Wagtail snippets
+- Wagtail blocks
+- Wagtail streamfields
+- Wagtail forms
+- Wagtail tags
+- Wagtail groups
+- Wagtail hooks
+- Wagtail locales
+- Wagtail admin
+- Wagtail commands
+- Wagtail templates
+- Wagtail API v2
+
+## Configuration
+
+Create a `kalo.config.json` file in your project root:
 
 ```json
 {
-  "appDir": "apps",
-  "aiProvider": "Qwen",
-  "temperature": 0.5,
-  "verbosity": "standard"
+  "aiProvider": "openai",
+  "temperature": 0.7,
+  "verbosity": "standard",
+  "appDir": "src"
 }
 ```
 
-Options disponibles :
-- `appDir` : Le dossier où se trouvent vos applications Django (par défaut: `app`).
-- `aiProvider` : Le fournisseur d'IA par défaut (`Qwen`, `Ollama`, `Mistral`, `OpenAI`).
-- `temperature` : La créativité de l'IA (entre 0 et 1).
-- `verbosity` : Le niveau de détail des commentaires générés (`minimal`, `standard`, `verbose`).
-
-### Si installé dans un projet
-
-Utilisez `bun run` ou `bunx` :
-
-```bash
-bun run kalo
-# ou
-bunx kalo
-```
-
-Si vous utilisez `npx`, assurez-vous que l'environnement peut exécuter le script (nécessite un environnement compatible avec le shebang `#!/usr/bin/env bun`, généralement Mac/Linux/WSL). Sur Windows standard, préférez `bunx`.
+## Integration Notes
 
+- The `createAppendActions` utility is now used in ALL generators (model, view, api, form, queryset, wagtail-admin, wagtail-api-v2, wagtail-block, wagtail-command, wagtail-form, wagtail-hook, wagtail-page, wagtail-snippet, wagtail-streamfield, wagtail-tag, wagtail-template) to append to existing files instead of overwriting them
+- The `plopfile.ts` now loads configuration and sets up project root detection
+- Multiple generators now use searchable prompts for app selection (api, form, queryset, wagtail-admin, wagtail-api-v2, wagtail-block, wagtail-command, wagtail-form, wagtail-hook, wagtail-snippet, wagtail-streamfield, wagtail-tag, wagtail-template)
+- File system utilities are used throughout for path resolution and app detection

package/bin/kalo.ts

@@ -4,8 +4,9 @@ import fs from "node:fs";
 import minimist from "minimist";
 import { Plop, run } from "plop";
 import { fileURLToPath } from "node:url";
-import { loadConfig } from "../generators/utils/config";
-import { findProjectRoot } from "../generators/utils/filesystem";
+import { findProjectRoot } from "../src/utils/filesystem";
+import { loadConfig } from "../src/utils/config";
+
 
 const args = process.argv.slice(2);
 const argv = minimist(args);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kalo-cli",
-  "version": "0.2.27",
+  "version": "0.3.0",
   "description": "Générateur de code structuré et uniforme pour Django et Wagtail",
   "bin": {
     "kalo": "./bin/kalo.ts"
@@ -8,6 +8,7 @@
   "type": "module",
   "scripts": {
     "kalo": "bun bin/kalo.ts",
+    "dev": "plop --plopfile plopfile.ts",
     "doc": "serve dist/docs -p 3333",
     "doc:dev": "bun run --port 3333 docs-site/index.html",
     "build": "bun scripts/build-docs.ts"

package/plopfile.ts

@@ -1,26 +1,183 @@
 import { NodePlopAPI } from 'plop';
-import autocompletePrompt from 'inquirer-autocomplete-prompt';
-import registerGenerators from './generators/generator/main/index.ts';
-
-/**
- * Primary Plopfile entry point.
- * Registers all generators and helpers.
- *
- * @param {NodePlopAPI} plop - The Plop API instance.
- */
-export default function (plop: NodePlopAPI) {
-  // Register Prompts
-  plop.setPrompt('autocomplete', autocompletePrompt);
-
-  // Global Helpers
-    plop.setHelper('upperCase', (txt) => txt.toUpperCase());
-    plop.setHelper('snakeCase', (txt) => {
-        return txt && txt.match(/[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g)
-            ?.map(x => x.toLowerCase())
-            .join('_');
-    });
-
-  // --- Register Generators ---
-  // The 'main' generator module now handles registering 'main' and 'help' generators.
-  registerGenerators(plop);
-}
+import { findProjectRoot } from './src/utils/filesystem';
+import { loadConfig } from './src/utils/config';
+
+// Import all generators
+import appGenerator from './src/gen/app/index';
+import modelGenerator from './src/gen/model/index';
+import viewGenerator from './src/gen/view/index';
+import formGenerator from './src/gen/form/index';
+import apiGenerator from './src/gen/api/index';
+import querysetGenerator from './src/gen/queryset/index';
+import wagtailPageGenerator from './src/gen/wagtail-page/index';
+import wagtailSnippetGenerator from './src/gen/wagtail-snippet/index';
+import wagtailBlockGenerator from './src/gen/wagtail-block/index';
+import wagtailStreamfieldGenerator from './src/gen/wagtail-streamfield/index';
+import wagtailFormGenerator from './src/gen/wagtail-form/index';
+import wagtailTagGenerator from './src/gen/wagtail-tag/index';
+import wagtailGroupGenerator from './src/gen/wagtail-group/index';
+import wagtailHookGenerator from './src/gen/wagtail-hook/index';
+import wagtailLocaleGenerator from './src/gen/wagtail-locale/index';
+import wagtailAdminGenerator from './src/gen/wagtail-admin/index';
+import wagtailCommandGenerator from './src/gen/wagtail-command/index';
+import wagtailTemplateGenerator from './src/gen/wagtail-template/index';
+import wagtailApiV2Generator from './src/gen/wagtail-api-v2/index';
+
+export default async function (plop: NodePlopAPI) {
+	// Load configuration
+	const config = await loadConfig();
+
+	// Register custom helpers
+	plop.setHelper('toPascalCase', function(str: string) {
+		if (!str) return str;
+		return str.replace(/(\w)(\w*)/g, (g0, g1, g2) => g1.toUpperCase() + g2.toLowerCase()).replace(/\W/g, '');
+	});
+	// Snake case helper to enforce snake_case filenames
+	plop.setHelper('toSnakeCase', function(str: string) {
+		if (!str) return str;
+		return String(str)
+			.replace(/([a-z0-9])([A-Z])/g, '$1_$2')
+			.replace(/[\s\-]+/g, '_')
+			.toLowerCase();
+	});
+	// Title case for human-facing labels
+	plop.setHelper('titleCase', function(str: string) {
+		if (!str) return str;
+		return String(str)
+			.replace(/[_\-]+/g, ' ')
+			.replace(/\s+/g, ' ')
+			.trim()
+			.split(' ')
+			.map(w => w.charAt(0).toUpperCase() + w.slice(1).toLowerCase())
+			.join(' ');
+	});
+	// Map generic type to Django Model Field
+	plop.setHelper('djangoModelField', function(type: string) {
+		if (!type) return 'CharField';
+		const t = String(type).toLowerCase();
+		const map: Record<string, string> = {
+			char: 'CharField',
+			text: 'TextField',
+			integer: 'IntegerField',
+			small_integer: 'SmallIntegerField',
+			positive_integer: 'PositiveIntegerField',
+			float: 'FloatField',
+			decimal: 'DecimalField',
+			boolean: 'BooleanField',
+			date: 'DateField',
+			datetime: 'DateTimeField',
+			email: 'EmailField',
+			url: 'URLField',
+			file: 'FileField',
+			image: 'ImageField',
+			uuid: 'UUIDField',
+			json: 'JSONField',
+			ip_address: 'GenericIPAddressField',
+			foreign_key: 'ForeignKey',
+			many_to_many: 'ManyToManyField',
+			one_to_one: 'OneToOneField',
+		};
+		return map[t] || (type.endsWith('Field') ? type : 'CharField');
+	});
+	// Map generic type to Django Form Field
+	plop.setHelper('djangoFormField', function(type: string) {
+		if (!type) return 'CharField';
+		const t = String(type).toLowerCase();
+		const map: Record<string, string> = {
+			char: 'CharField',
+			text: 'CharField',
+			integer: 'IntegerField',
+			float: 'FloatField',
+			decimal: 'DecimalField',
+			boolean: 'BooleanField',
+			date: 'DateField',
+			datetime: 'DateTimeField',
+			email: 'EmailField',
+			url: 'URLField',
+			file: 'FileField',
+			image: 'ImageField',
+			uuid: 'UUIDField',
+			json: 'JSONField',
+		};
+		return map[t] || (type.endsWith('Field') ? type : 'CharField');
+	});
+
+	plop.setHelper('trim', (str) => {
+		return str ? String(str).trim() : '';
+	});
+
+	plop.setHelper('eq', (a, b) => {
+		return a == b;
+	});
+
+	plop.setHelper('split', (str, separator) => {
+		return str ? String(str).split(separator) : [];
+	});
+
+	plop.setHelper('replace', (str, find, replace) => {
+		return str ? String(str).split(find).join(replace) : '';
+	});
+
+	plop.setHelper('includes', (arr, value) => {
+		if (Array.isArray(arr)) return arr.includes(value);
+		if (typeof arr === 'string') return arr.includes(value);
+		return false;
+	});
+
+	// Set the project root as a global helper
+	plop.setHelper('projectRoot', function() {
+		return findProjectRoot();
+	});
+
+	// Set configuration as a global helper
+	plop.setHelper('getConfig', function(key: string) {
+		return config[key] || null;
+	});
+
+	// Register the autocomplete prompt
+	try {
+		const autoCompletePrompt = await import('inquirer-autocomplete-prompt');
+		plop.setPrompt('autocomplete', autoCompletePrompt.default);
+	} catch (error) {
+		console.warn('inquirer-autocomplete-prompt not found. Install it to enable autocomplete prompts.');
+	}
+
+	// Register all generators
+	appGenerator(plop);
+	modelGenerator(plop);
+	viewGenerator(plop);
+	formGenerator(plop);
+	apiGenerator(plop);
+	querysetGenerator(plop);
+	wagtailPageGenerator(plop);
+	wagtailSnippetGenerator(plop);
+	wagtailBlockGenerator(plop);
+	wagtailStreamfieldGenerator(plop);
+	wagtailFormGenerator(plop);
+	wagtailTagGenerator(plop);
+	wagtailGroupGenerator(plop);
+	wagtailHookGenerator(plop);
+	wagtailLocaleGenerator(plop);
+	wagtailAdminGenerator(plop);
+	wagtailCommandGenerator(plop);
+	wagtailTemplateGenerator(plop);
+	wagtailApiV2Generator(plop);
+
+	plop.setGenerator('component', {
+		description: 'Create a new component',
+		prompts: [
+			{
+				type: 'input',
+				name: 'name',
+				message: 'Component name:'
+			}
+		],
+		actions: [
+			{
+				type: 'add',
+				path: 'src/components/{{name}}.tsx',
+				template: 'export const {{name}} = () => <div>{{name}}</div>;'
+			}
+		]
+	});
+};