@famgia/omnify-laravel 0.0.44 → 0.0.46

package/ai-guides/laravel-guide.md

@@ -0,0 +1,222 @@
+# Omnify Laravel Generator Guide
+
+This guide covers Laravel-specific features and generated code patterns for Omnify.
+
+## Generated Files
+
+When you run `npx omnify generate`, the following Laravel files are generated:
+
+### Migrations
+- `database/migrations/omnify/*.php` - Laravel migrations for each schema
+
+### Models
+- `app/Models/OmnifyBase/{ModelName}BaseModel.php` - Generated base models (DO NOT EDIT)
+- `app/Models/{ModelName}.php` - Extendable model classes (safe to customize)
+
+### Traits
+- `app/Models/OmnifyBase/Traits/HasLocalizedDisplayName.php` - Localization trait
+
+### Locales
+- `app/Models/OmnifyBase/Locales/{ModelName}Locales.php` - i18n display names
+
+## Model Structure
+
+```php
+// app/Models/User.php (YOUR customizations go here)
+<?php
+namespace App\Models;
+
+use App\Models\OmnifyBase\UserBaseModel;
+
+class User extends UserBaseModel
+{
+    // Add your custom methods, scopes, accessors, etc.
+}
+```
+
+```php
+// app/Models/OmnifyBase/UserBaseModel.php (DO NOT EDIT - auto-generated)
+<?php
+namespace App\Models\OmnifyBase;
+
+use App\Models\OmnifyBase\Traits\HasLocalizedDisplayName;
+use App\Models\OmnifyBase\Locales\UserLocales;
+
+class UserBaseModel extends Model
+{
+    use HasLocalizedDisplayName;
+
+    protected static array $localizedDisplayNames = UserLocales::DISPLAY_NAMES;
+    protected static array $localizedPropertyDisplayNames = UserLocales::PROPERTY_DISPLAY_NAMES;
+
+    protected $fillable = ['name', 'email', 'password'];
+    protected $casts = [...];
+
+    // Relations defined here
+}
+```
+
+## Localization (i18n)
+
+### Display Names
+```php
+// Get localized model name
+User::getLocalizedDisplayName(); // Returns based on app()->getLocale()
+
+// Get localized property name
+User::getLocalizedPropertyDisplayName('email');
+```
+
+### Schema Definition
+```yaml
+# yaml-language-server: $schema=./node_modules/.omnify/combined-schema.json
+name: User
+displayName:
+  ja: ユーザー
+  en: User
+properties:
+  email:
+    type: String
+    displayName:
+      ja: メールアドレス
+      en: Email Address
+```
+
+## Relationships
+
+### ManyToOne
+```yaml
+# In Post schema
+author:
+  type: Association
+  relation: ManyToOne
+  target: User
+  onDelete: CASCADE
+```
+
+Generated:
+```php
+// PostBaseModel.php
+public function author(): BelongsTo
+{
+    return $this->belongsTo(User::class);
+}
+```
+
+### OneToMany
+```yaml
+# In User schema
+posts:
+  type: Association
+  relation: OneToMany
+  target: Post
+  mappedBy: author
+```
+
+Generated:
+```php
+// UserBaseModel.php
+public function posts(): HasMany
+{
+    return $this->hasMany(Post::class, 'author_id');
+}
+```
+
+### ManyToMany
+```yaml
+# In Post schema
+tags:
+  type: Association
+  relation: ManyToMany
+  target: Tag
+  pivotTable: post_tags
+  pivotFields:
+    - name: order
+      type: Int
+      default: 0
+```
+
+Generated:
+```php
+// PostBaseModel.php
+public function tags(): BelongsToMany
+{
+    return $this->belongsToMany(Tag::class, 'post_tags')
+        ->withPivot(['order']);
+}
+```
+
+## Migration Options
+
+### Soft Delete
+```yaml
+options:
+  softDelete: true  # Adds deleted_at column and SoftDeletes trait
+```
+
+### Timestamps
+```yaml
+options:
+  timestamps: true  # Adds created_at, updated_at columns
+```
+
+### Custom Table Name
+```yaml
+options:
+  table: custom_table_name
+```
+
+## Enum Support
+
+```yaml
+# schemas/PostStatus.yaml
+name: PostStatus
+kind: enum
+values:
+  draft: 下書き
+  published: 公開済み
+  archived: アーカイブ
+```
+
+Usage in schema:
+```yaml
+status:
+  type: EnumRef
+  enum: PostStatus
+  default: draft
+```
+
+Generated migration:
+```php
+$table->enum('status', ['draft', 'published', 'archived'])->default('draft');
+```
+
+## Commands
+
+```bash
+# Generate Laravel migrations and models
+npx omnify generate
+
+# Force regenerate all files
+npx omnify generate --force
+
+# Validate schemas
+npx omnify validate
+```
+
+## Configuration
+
+```typescript
+// omnify.config.ts
+import { defineConfig } from '@famgia/omnify';
+
+export default defineConfig({
+  schemasDir: './schemas',
+  output: {
+    laravel: {
+      migrationsPath: './database/migrations/omnify',
+      modelsPath: './app/Models',
+    },
+  },
+});
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@famgia/omnify-laravel",
-  "version": "0.0.44",
+  "version": "0.0.46",
   "description": "Laravel migration and TypeScript type generator for omnify-schema",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,12 +21,13 @@
   "files": [
     "dist",
     "scripts",
+    "ai-guides",
     "README.md"
   ],
   "dependencies": {
-    "@famgia/omnify-types": "0.0.35",
-    "@famgia/omnify-core": "0.0.38",
-    "@famgia/omnify-atlas": "0.0.34"
+    "@famgia/omnify-types": "0.0.37",
+    "@famgia/omnify-core": "0.0.40",
+    "@famgia/omnify-atlas": "0.0.36"
   },
   "scripts": {
     "build": "tsup",

package/scripts/postinstall.js

@@ -2,232 +2,12 @@
 
 import fs from 'fs';
 import path from 'path';
+import { fileURLToPath } from 'url';
 
-const LARAVEL_GUIDE_CONTENT = `# Omnify Laravel Generator Guide
-
-This guide covers Laravel-specific features and generated code patterns for Omnify.
-
-## Generated Files
-
-When you run \`npx omnify generate\`, the following Laravel files are generated:
-
-### Migrations
-- \`database/migrations/omnify/*.php\` - Laravel migrations for each schema
-
-### Models
-- \`app/Models/OmnifyBase/{ModelName}BaseModel.php\` - Generated base models (DO NOT EDIT)
-- \`app/Models/{ModelName}.php\` - Extendable model classes (safe to customize)
-
-### Traits
-- \`app/Models/OmnifyBase/Traits/HasLocalizedDisplayName.php\` - Localization trait
-
-### Locales
-- \`app/Models/OmnifyBase/Locales/{ModelName}Locales.php\` - i18n display names
-
-## Model Structure
-
-\`\`\`php
-// app/Models/User.php (YOUR customizations go here)
-<?php
-namespace App\\Models;
-
-use App\\Models\\OmnifyBase\\UserBaseModel;
-
-class User extends UserBaseModel
-{
-    // Add your custom methods, scopes, accessors, etc.
-}
-\`\`\`
-
-\`\`\`php
-// app/Models/OmnifyBase/UserBaseModel.php (DO NOT EDIT - auto-generated)
-<?php
-namespace App\\Models\\OmnifyBase;
-
-use App\\Models\\OmnifyBase\\Traits\\HasLocalizedDisplayName;
-use App\\Models\\OmnifyBase\\Locales\\UserLocales;
-
-class UserBaseModel extends Model
-{
-    use HasLocalizedDisplayName;
-
-    protected static array $localizedDisplayNames = UserLocales::DISPLAY_NAMES;
-    protected static array $localizedPropertyDisplayNames = UserLocales::PROPERTY_DISPLAY_NAMES;
-
-    protected $fillable = ['name', 'email', 'password'];
-    protected $casts = [...];
-
-    // Relations defined here
-}
-\`\`\`
-
-## Localization (i18n)
-
-### Display Names
-\`\`\`php
-// Get localized model name
-User::getLocalizedDisplayName(); // Returns based on app()->getLocale()
-
-// Get localized property name
-User::getLocalizedPropertyDisplayName('email');
-\`\`\`
-
-### Schema Definition
-\`\`\`yaml
-# yaml-language-server: $schema=./node_modules/.omnify/combined-schema.json
-name: User
-displayName:
-  ja: ユーザー
-  en: User
-properties:
-  email:
-    type: String
-    displayName:
-      ja: メールアドレス
-      en: Email Address
-\`\`\`
-
-## Relationships
-
-### ManyToOne
-\`\`\`yaml
-# In Post schema
-author:
-  type: Association
-  relation: ManyToOne
-  target: User
-  onDelete: CASCADE
-\`\`\`
-
-Generated:
-\`\`\`php
-// PostBaseModel.php
-public function author(): BelongsTo
-{
-    return $this->belongsTo(User::class);
-}
-\`\`\`
-
-### OneToMany
-\`\`\`yaml
-# In User schema
-posts:
-  type: Association
-  relation: OneToMany
-  target: Post
-  mappedBy: author
-\`\`\`
-
-Generated:
-\`\`\`php
-// UserBaseModel.php
-public function posts(): HasMany
-{
-    return $this->hasMany(Post::class, 'author_id');
-}
-\`\`\`
-
-### ManyToMany
-\`\`\`yaml
-# In Post schema
-tags:
-  type: Association
-  relation: ManyToMany
-  target: Tag
-  pivotTable: post_tags
-  pivotFields:
-    - name: order
-      type: Int
-      default: 0
-\`\`\`
-
-Generated:
-\`\`\`php
-// PostBaseModel.php
-public function tags(): BelongsToMany
-{
-    return $this->belongsToMany(Tag::class, 'post_tags')
-        ->withPivot(['order']);
-}
-\`\`\`
-
-## Migration Options
-
-### Soft Delete
-\`\`\`yaml
-options:
-  softDelete: true  # Adds deleted_at column and SoftDeletes trait
-\`\`\`
-
-### Timestamps
-\`\`\`yaml
-options:
-  timestamps: true  # Adds created_at, updated_at columns
-\`\`\`
-
-### Custom Table Name
-\`\`\`yaml
-options:
-  table: custom_table_name
-\`\`\`
-
-## Enum Support
-
-\`\`\`yaml
-# schemas/PostStatus.yaml
-name: PostStatus
-kind: enum
-values:
-  draft: 下書き
-  published: 公開済み
-  archived: アーカイブ
-\`\`\`
-
-Usage in schema:
-\`\`\`yaml
-status:
-  type: EnumRef
-  enum: PostStatus
-  default: draft
-\`\`\`
-
-Generated migration:
-\`\`\`php
-$table->enum('status', ['draft', 'published', 'archived'])->default('draft');
-\`\`\`
-
-## Commands
-
-\`\`\`bash
-# Generate Laravel migrations and models
-npx omnify generate --laravel
-
-# Validate schemas
-npx omnify validate
-
-# Watch for changes
-npx omnify watch --laravel
-\`\`\`
-
-## Configuration
-
-\`\`\`javascript
-// omnify.config.js
-export default {
-  schemasDir: './schemas',
-  outputDir: './',
-  laravel: {
-    migrationsDir: 'database/migrations/omnify',
-    modelsDir: 'app/Models',
-    baseModelsDir: 'app/Models/OmnifyBase',
-    namespace: 'App\\\\Models'
-  }
-};
-\`\`\`
-`;
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
 
 function findProjectRoot() {
-  // npm/pnpm set INIT_CWD to the directory where the install was run
   let dir = process.env.INIT_CWD || process.cwd();
   const nodeModulesIndex = dir.indexOf('node_modules');
   if (nodeModulesIndex !== -1) {
@@ -240,17 +20,28 @@ function findProjectRoot() {
   return null;
 }
 
-function createLaravelSkillFile(projectRoot) {
+function copyAiGuidesToProject(projectRoot) {
   const omnifyDir = path.join(projectRoot, '.claude', 'omnify');
+  const aiGuidesDir = path.join(__dirname, '..', 'ai-guides');
 
   try {
     if (!fs.existsSync(omnifyDir)) {
       fs.mkdirSync(omnifyDir, { recursive: true });
     }
 
-    const guidePath = path.join(omnifyDir, 'laravel-guide.md');
-    fs.writeFileSync(guidePath, LARAVEL_GUIDE_CONTENT, 'utf-8');
-    console.log('  Created .claude/omnify/laravel-guide.md');
+    if (fs.existsSync(aiGuidesDir)) {
+      const files = fs.readdirSync(aiGuidesDir);
+      for (const file of files) {
+        const srcPath = path.join(aiGuidesDir, file);
+        const destPath = path.join(omnifyDir, file);
+
+        if (fs.statSync(srcPath).isFile()) {
+          fs.copyFileSync(srcPath, destPath);
+          console.log(`  Created .claude/omnify/${file}`);
+        }
+      }
+    }
+
     return true;
   } catch {
     return false;
@@ -262,7 +53,6 @@ function main() {
     return;
   }
 
-  // Skip if in omnify-ts monorepo (source code), but allow examples/
   const projectDir = process.env.INIT_CWD || process.cwd();
   if (projectDir.includes('omnify-ts') && !projectDir.includes('omnify-ts/examples')) {
     return;
@@ -270,7 +60,7 @@ function main() {
 
   const projectRoot = findProjectRoot();
   if (projectRoot) {
-    createLaravelSkillFile(projectRoot);
+    copyAiGuidesToProject(projectRoot);
   }
 }