@famgia/omnify-laravel 0.0.19 → 0.0.20

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@famgia/omnify-laravel",
-  "version": "0.0.19",
+  "version": "0.0.20",
   "description": "Laravel migration and TypeScript type generator for omnify-schema",
   "type": "module",
   "main": "./dist/index.js",
@@ -20,10 +20,11 @@
   },
   "files": [
     "dist",
+    "scripts",
     "README.md"
   ],
   "dependencies": {
-    "@famgia/omnify-types": "0.0.9",
+    "@famgia/omnify-types": "0.0.10",
     "@famgia/omnify-core": "0.0.14",
     "@famgia/omnify-atlas": "0.0.10"
   },
@@ -33,6 +34,7 @@
     "test": "vitest run --passWithNoTests",
     "test:watch": "vitest",
     "lint": "eslint src",
-    "typecheck": "tsc --noEmit"
+    "typecheck": "tsc --noEmit",
+    "postinstall": "node scripts/postinstall.js"
   }
 }

package/scripts/postinstall.js

@@ -0,0 +1,276 @@
+#!/usr/bin/env node
+
+import fs from 'fs';
+import path from 'path';
+
+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
+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'
+  }
+};
+\`\`\`
+`;
+
+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) {
+    dir = dir.substring(0, nodeModulesIndex - 1);
+  }
+  const packageJsonPath = path.join(dir, 'package.json');
+  if (fs.existsSync(packageJsonPath)) {
+    return dir;
+  }
+  return null;
+}
+
+function createLaravelSkillFile(projectRoot) {
+  const omnifyDir = path.join(projectRoot, '.claude', 'omnify');
+
+  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');
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+function main() {
+  if (process.env.CI || process.env.CONTINUOUS_INTEGRATION) {
+    return;
+  }
+
+  // Skip if this is a dev install (in the omnify-ts monorepo packages, but allow examples)
+  const projectDir = process.env.INIT_CWD || process.cwd();
+  if (projectDir.includes('omnify-ts/packages')) {
+    return;
+  }
+
+  const projectRoot = findProjectRoot();
+  if (projectRoot) {
+    createLaravelSkillFile(projectRoot);
+  }
+}
+
+main();