@famgia/omnify-laravel 0.0.4 → 0.0.5

package/README.md

@@ -10,22 +10,80 @@ npm install @famgia/omnify-laravel
 
 ## Usage
 
+### Plugin Mode (Recommended)
+
+Use as a plugin in your `omnify.config.ts`:
+
+```typescript
+import { defineConfig } from '@famgia/omnify';
+import laravel from '@famgia/omnify-laravel/plugin';
+
+export default defineConfig({
+  schemasDir: './schemas',
+  database: {
+    driver: 'mysql',
+    devUrl: 'mysql://root@localhost:3306/dev',
+  },
+
+  plugins: [
+    laravel({
+      // Path for Laravel migration files (default: 'database/migrations')
+      migrationsPath: 'database/migrations',
+
+      // Path for TypeScript type files (default: 'types')
+      typesPath: 'resources/js/types',
+
+      // Generate all types in a single file (default: true)
+      singleFile: true,
+
+      // Database connection name for migrations (optional)
+      connection: 'mysql',
+
+      // Enable/disable generators (both default: true)
+      generateMigrations: true,
+      generateTypes: true,
+    }),
+  ],
+});
+```
+
+Then run:
+
+```bash
+npx omnify generate
+```
+
+### Plugin Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `migrationsPath` | `string` | `'database/migrations'` | Output path for Laravel migrations |
+| `typesPath` | `string` | `'types'` | Output path for TypeScript types |
+| `singleFile` | `boolean` | `true` | Generate all types in one file |
+| `connection` | `string` | `undefined` | Database connection name |
+| `generateMigrations` | `boolean` | `true` | Generate Laravel migrations |
+| `generateTypes` | `boolean` | `true` | Generate TypeScript types |
+
+### Direct API Usage
+
+For programmatic usage without the plugin system:
+
 ```typescript
 import {
-  generateMigration,
+  generateMigrations,
   generateTypeScript,
-  MigrationGenerator,
-  TypeScriptGenerator
 } from '@famgia/omnify-laravel';
 
-// Generate Laravel migration
-const migration = generateMigration(schema, {
-  tableName: 'users',
+// Generate Laravel migrations
+const migrations = generateMigrations(schemas, {
   timestamp: '2024_01_01_000000',
+  connection: 'mysql',
 });
 
-// Generate TypeScript interface
-const typescript = generateTypeScript(schemas);
+// Generate TypeScript interfaces
+const types = generateTypeScript(schemas, {
+  singleFile: true,
+});
 ```
 
 ## Features
@@ -36,6 +94,7 @@ const typescript = generateTypeScript(schemas);
 - Relationship handling (belongsTo, hasMany, etc.)
 - Index and constraint generation
 - Enum type support
+- Plugin system with DAG-based generator ordering
 
 ## Generated Output
 
@@ -76,11 +135,50 @@ export interface User {
 }
 ```
 
+## Creating Custom Plugins
+
+You can create your own generator plugins following this pattern:
+
+```typescript
+import type { OmnifyPlugin, GeneratorContext, GeneratorOutput } from '@famgia/omnify-types';
+
+export default function myPlugin(options?: MyOptions): OmnifyPlugin {
+  return {
+    name: 'my-plugin',
+    version: '1.0.0',
+
+    generators: [
+      {
+        name: 'my-generator',
+        description: 'Generate custom files',
+
+        // Optional: run after other generators
+        dependsOn: ['laravel-migrations'],
+
+        generate: async (ctx: GeneratorContext): Promise<GeneratorOutput[]> => {
+          // Access schemas via ctx.schemas
+          // Access previous generator outputs via ctx.previousOutputs
+
+          return [
+            {
+              path: 'output/file.ts',
+              content: '// Generated content',
+              type: 'other',
+            },
+          ];
+        },
+      },
+    ],
+  };
+}
+```
+
 ## Related Packages
 
 - [@famgia/omnify-core](https://www.npmjs.com/package/@famgia/omnify-core) - Core engine
 - [@famgia/omnify-cli](https://www.npmjs.com/package/@famgia/omnify-cli) - CLI tool
 - [@famgia/omnify-atlas](https://www.npmjs.com/package/@famgia/omnify-atlas) - Atlas adapter
+- [@famgia/omnify-types](https://www.npmjs.com/package/@famgia/omnify-types) - Type definitions
 
 ## License