@famgia/omnify 1.0.70 → 1.0.71

package/ai-guides/config-guide.md

@@ -1,106 +1,176 @@
 # Omnify Configuration Guide
 
+## Quick Start
+
+```bash
+# Create new Laravel project (recommended)
+npx @famgia/omnify create-laravel-project my-app
+cd my-app
+
+# Or initialize in existing project
+npx @famgia/omnify init
+```
+
 ## Configuration File
 
 Create `omnify.config.ts` in project root:
 
 ```typescript
 import { defineConfig } from '@famgia/omnify';
+import laravel from '@famgia/omnify-laravel/plugin';
+import typescript from '@famgia/omnify-typescript/plugin';
 
 export default defineConfig({
   schemasDir: './schemas',
+  lockFilePath: './.omnify.lock',
 
   database: {
-    driver: 'mysql',  // 'mysql' | 'pgsql' | 'sqlite' | 'sqlsrv' | 'mariadb'
+    driver: 'mysql',
+    devUrl: 'mysql://root:password@localhost:3306/dev_db',
   },
 
-  output: {
-    laravel: {
-      migrationsPath: './database/migrations/omnify',
-      modelsPath: './app/Models',
-      enumsPath: './app/Enums',
-    },
-    typescript: {
-      path: './src/types/model',
-      singleFile: false,
-    },
-  },
+  plugins: [
+    laravel({
+      migrationsPath: 'database/migrations/omnify',
+      modelsPath: 'app/Models',
+      baseModelsPath: 'app/Models/OmnifyBase',
+      providersPath: 'app/Providers',
+      localesPath: 'app/Models/OmnifyBase/Locales',
+    }),
+    typescript({
+      path: './resources/ts/types/models',
+      generateRules: true,
+    }),
+  ],
 
-  // Multi-language support (optional)
   locale: {
-    locales: ['en', 'ja', 'vi'],
-    defaultLocale: 'en',
-    fallbackLocale: 'en',
+    locales: ['ja', 'en'],
+    defaultLocale: 'ja',
   },
 });
 ```
 
 ## Configuration Options
 
+### Root Options
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `schemasDir` | `string` | Yes | Directory containing schema files |
+| `lockFilePath` | `string` | Yes | Path to lock file for change tracking |
+| `database` | `object` | Yes | Database configuration |
+| `plugins` | `Plugin[]` | No | Array of generator plugins |
+| `locale` | `object` | No | Multi-language support configuration |
+
 ### database (required)
-| Option | Type | Description |
-|--------|------|-------------|
-| `driver` | string | Database driver: mysql, pgsql, sqlite, sqlsrv, mariadb |
-| `devUrl` | string | Development database URL for Atlas diff |
-| `enableFieldComments` | boolean | Enable field comments in migrations (MySQL) |
 
-### output.laravel
-| Option | Type | Description |
-|--------|------|-------------|
-| `migrationsPath` | string | Directory for generated migrations |
-| `modelsPath` | string | Directory for generated models |
-| `modelsNamespace` | string | PHP namespace for models |
-| `factoriesPath` | string | Directory for generated factories |
-| `enumsPath` | string | Directory for generated enums |
-| `enumsNamespace` | string | PHP namespace for enums |
-
-### output.typescript
 | Option | Type | Description |
 |--------|------|-------------|
-| `path` | string | Output directory for TypeScript types |
-| `singleFile` | boolean | Generate single file vs multiple files |
-| `generateEnums` | boolean | Generate enum types |
-| `generateRelationships` | boolean | Generate relationship types |
-| `generateRules` | boolean | Generate Ant Design validation rules (default: true) |
-| `validationTemplates` | object | Custom validation message templates |
+| `driver` | `string` | Database driver: `mysql`, `pgsql`, `sqlite`, `sqlsrv`, `mariadb` |
+| `devUrl` | `string` | Development database URL for Atlas diff (required for `generate`) |
+| `enableFieldComments` | `boolean` | Enable field comments in migrations (MySQL) |
 
-#### Validation Templates
+### Database URL Format
 
-Customize validation messages for your locales:
+```
+mysql://user:password@host:port/database
+postgres://user:password@host:port/database
+sqlite://path/to/file.db
+```
+
+## Plugin Configuration
+
+### Laravel Plugin
 
 ```typescript
-{
-  output: {
-    typescript: {
-      validationTemplates: {
-        required: {
-          ja: '${displayName}を入力してください',
-          en: '${displayName} is required',
-        },
-        maxLength: {
-          ja: '${displayName}は${max}文字以内です',
-          en: '${displayName} must be at most ${max} characters',
-        },
-        minLength: { /* ... */ },
-        min: { /* ... */ },
-        max: { /* ... */ },
-        email: { /* ... */ },
-        url: { /* ... */ },
-        pattern: { /* ... */ },
-      },
-    },
-  },
+import laravel from '@famgia/omnify-laravel/plugin';
+
+laravel({
+  migrationsPath: 'database/migrations/omnify',  // Migration files
+  modelsPath: 'app/Models',                       // Model classes
+  baseModelsPath: 'app/Models/OmnifyBase',        // Base model classes (auto-generated)
+  providersPath: 'app/Providers',                 // Service provider (OmnifyServiceProvider)
+  localesPath: 'app/Models/OmnifyBase/Locales',   // Locale files
+})
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `migrationsPath` | `string` | `database/migrations/omnify` | Laravel migrations output |
+| `modelsPath` | `string` | `app/Models` | Model classes output |
+| `baseModelsPath` | `string` | `app/Models/OmnifyBase` | Base model classes output |
+| `providersPath` | `string` | `app/Providers` | Service provider output |
+| `localesPath` | `string` | `app/Models/OmnifyBase/Locales` | Locale files output |
+
+### TypeScript Plugin
+
+```typescript
+import typescript from '@famgia/omnify-typescript/plugin';
+
+typescript({
+  path: './resources/ts/types/models',  // Output directory
+  generateRules: true,                   // Generate Ant Design validation rules
+})
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `path` | `string` | `./src/types/model` | Output directory for TypeScript types |
+| `generateRules` | `boolean` | `true` | Generate Ant Design validation rules |
+
+### Japan Plugin (Optional)
+
+```typescript
+import japan from '@famgia/omnify-japan/plugin';
+
+japan({
+  // Japan-specific types: JapaneseName, JapaneseAddress, etc.
+})
+```
+
+## Locale Configuration
+
+```typescript
+locale: {
+  locales: ['ja', 'en', 'vi'],    // Supported locale codes
+  defaultLocale: 'ja',            // Default locale for simple strings
+  fallbackLocale: 'en',           // Fallback when requested locale not found
 }
 ```
 
-Built-in templates are available for: ja, en, vi, ko, zh
+## Commands
 
-### locale (optional)
-| Option | Type | Description |
-|--------|------|-------------|
-| `locales` | string[] | Supported locale codes: ['en', 'ja', 'vi'] |
-| `defaultLocale` | string | Default locale for simple strings |
-| `fallbackLocale` | string | Fallback when requested locale not found |
+```bash
+# Create new Laravel project
+npx @famgia/omnify create-laravel-project my-app
+
+# Initialize in existing project
+npx @famgia/omnify init
+
+# Validate all schemas
+npx @famgia/omnify validate
+
+# Show pending changes
+npx @famgia/omnify diff
+
+# Generate code
+npx @famgia/omnify generate
+
+# Generate with options
+npx @famgia/omnify generate --force           # Force regenerate
+npx @famgia/omnify generate --migrations-only  # Only migrations
+npx @famgia/omnify generate --types-only       # Only TypeScript
+
+# Reset all generated files
+npx @famgia/omnify reset
+```
+
+## Environment Variables
+
+| Variable | Description |
+|----------|-------------|
+| `OMNIFY_DEV_URL` | Override database.devUrl from config |
+| `DEBUG` | Set to `omnify:*` for debug output |
 
 ## Common Mistakes
 
@@ -120,3 +190,64 @@ Built-in templates are available for: ja, en, vi, ko, zh
   },
 }
 ```
+
+**Wrong** - Using old `output` format:
+```typescript
+{
+  output: {
+    laravel: { ... },      // ERROR: Use plugins instead
+    typescript: { ... },
+  },
+}
+```
+
+**Correct** - Using plugins:
+```typescript
+{
+  plugins: [
+    laravel({ ... }),
+    typescript({ ... }),
+  ],
+}
+```
+
+## Full Example
+
+```typescript
+import { defineConfig } from '@famgia/omnify';
+import laravel from '@famgia/omnify-laravel/plugin';
+import typescript from '@famgia/omnify-typescript/plugin';
+import japan from '@famgia/omnify-japan/plugin';
+
+export default defineConfig({
+  schemasDir: './schemas',
+  lockFilePath: './.omnify.lock',
+
+  database: {
+    driver: 'mysql',
+    devUrl: process.env.OMNIFY_DEV_URL || 'mysql://root:password@localhost:3306/dev_db',
+    enableFieldComments: true,
+  },
+
+  plugins: [
+    laravel({
+      migrationsPath: 'database/migrations/omnify',
+      modelsPath: 'app/Models',
+      baseModelsPath: 'app/Models/OmnifyBase',
+      providersPath: 'app/Providers',
+      localesPath: 'app/Models/OmnifyBase/Locales',
+    }),
+    typescript({
+      path: './resources/ts/types/models',
+      generateRules: true,
+    }),
+    japan(),  // Japan-specific types
+  ],
+
+  locale: {
+    locales: ['ja', 'en'],
+    defaultLocale: 'ja',
+    fallbackLocale: 'ja',
+  },
+});
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@famgia/omnify",
-  "version": "1.0.70",
+  "version": "1.0.71",
   "description": "Schema-driven database migration system with TypeScript types and Laravel migrations",
   "type": "module",
   "main": "./dist/index.js",
@@ -25,14 +25,14 @@
     "README.md"
   ],
   "dependencies": {
-    "@famgia/omnify-cli": "0.0.66",
-    "@famgia/omnify-core": "0.0.60",
-    "@famgia/omnify-types": "0.0.58",
-    "@famgia/omnify-laravel": "0.0.69",
-    "@famgia/omnify-typescript": "0.0.48",
-    "@famgia/omnify-atlas": "0.0.54",
-    "@famgia/omnify-mcp": "0.0.46",
-    "@famgia/omnify-japan": "0.0.53"
+    "@famgia/omnify-cli": "0.0.67",
+    "@famgia/omnify-core": "0.0.61",
+    "@famgia/omnify-types": "0.0.59",
+    "@famgia/omnify-laravel": "0.0.70",
+    "@famgia/omnify-typescript": "0.0.49",
+    "@famgia/omnify-atlas": "0.0.55",
+    "@famgia/omnify-mcp": "0.0.47",
+    "@famgia/omnify-japan": "0.0.54"
   },
   "keywords": [
     "omnify",