@famgia/omnify 1.0.15 → 1.0.19

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@famgia/omnify",
-  "version": "1.0.15",
+  "version": "1.0.19",
   "description": "Schema-driven database migration system with TypeScript types and Laravel migrations",
   "type": "module",
   "main": "./dist/index.js",
@@ -24,13 +24,13 @@
     "README.md"
   ],
   "dependencies": {
-    "@famgia/omnify-cli": "0.0.14",
-    "@famgia/omnify-core": "0.0.14",
-    "@famgia/omnify-types": "0.0.10",
-    "@famgia/omnify-laravel": "0.0.19",
-    "@famgia/omnify-typescript": "0.0.1",
-    "@famgia/omnify-atlas": "0.0.10",
-    "@famgia/omnify-mcp": "0.0.2"
+    "@famgia/omnify-cli": "0.0.18",
+    "@famgia/omnify-core": "0.0.18",
+    "@famgia/omnify-types": "0.0.14",
+    "@famgia/omnify-laravel": "0.0.24",
+    "@famgia/omnify-typescript": "0.0.6",
+    "@famgia/omnify-atlas": "0.0.14",
+    "@famgia/omnify-mcp": "0.0.6"
   },
   "keywords": [
     "omnify",

package/scripts/postinstall.js

@@ -4,63 +4,42 @@ import fs from 'fs';
 import path from 'path';
 import os from 'os';
 
-// Main CLAUDE.md content (used when creating new file)
-const CLAUDE_MD_CONTENT = `# Omnify Schema Rules
+// Content for CLAUDE.md
+const CLAUDE_MD_SECTION = `## Omnify
 
-This project uses **Omnify** for schema-driven code generation. When creating or modifying schemas, follow these rules.
+This project uses Omnify for schema-driven code generation.
 
-## Quick Reference
-
-For detailed documentation, see:
-- \`.claude/omnify/schema-guide.md\` - Complete schema format guide
-- \`.claude/omnify/examples.md\` - Example schemas
-
-## Schema Location
-
-Schemas are stored in \`schemas/\` directory with \`.yaml\` extension.
-
-## Basic Schema Format
-
-\`\`\`yaml
-# yaml-language-server: $schema=https://raw.githubusercontent.com/ecsol/omnify-ts/main/packages/types/schemas/omnify-schema.json
-name: ModelName
-displayName:
-  ja: 日本語名
-  en: English Name
-options:
-  softDelete: true
-  timestamps: true
-properties:
-  propertyName:
-    type: String
-    displayName:
-      ja: プロパティ名
-      en: Property Name
-\`\`\`
-
-## Commands
+**Documentation**: \`.claude/omnify/\`
+- \`schema-guide.md\` - Schema format and property types
+- \`config-guide.md\` - Configuration (omnify.config.ts)
+- \`laravel-guide.md\` - Laravel generator (if installed)
+- \`typescript-guide.md\` - TypeScript generator (if installed)
 
+**Commands**:
 - \`npx omnify generate\` - Generate code from schemas
-- \`npx omnify validate\` - Validate all schemas
+- \`npx omnify validate\` - Validate schemas
 `;
 
-// Content to append when CLAUDE.md already exists
-const CLAUDE_MD_APPEND = `
----
+// Cursor rules content
+const CURSORRULES_CONTENT = `# Omnify Schema Rules
 
-## Omnify Schema Integration
+This project uses Omnify for schema-driven code generation.
+Schemas are in \`schemas/\` directory with \`.yaml\` extension.
 
-This project uses **Omnify** for schema-driven code generation.
+For detailed documentation, read these files:
+- .claude/omnify/schema-guide.md - Base schema format
+- .claude/omnify/config-guide.md - Configuration (omnify.config.ts)
+- .claude/omnify/laravel-guide.md - Laravel generator (if exists)
+- .claude/omnify/typescript-guide.md - TypeScript generator (if exists)
 
-For detailed Omnify documentation, see:
-- \`.claude/omnify/schema-guide.md\` - Complete schema format guide
-- \`.claude/omnify/examples.md\` - Example schemas
-
-### Quick Commands
-- \`npx omnify generate\` - Generate code from schemas
-- \`npx omnify validate\` - Validate all schemas
+Commands:
+- npx omnify generate - Generate code from schemas
+- npx omnify validate - Validate all schemas
 `;
 
+// Marker to check if Omnify section exists
+const OMNIFY_MARKER = '.claude/omnify/';
+
 // Schema guide skill file
 const SCHEMA_GUIDE_CONTENT = `# Omnify Schema Format Guide
 
@@ -71,7 +50,7 @@ All schemas are stored in \`schemas/\` directory with \`.yaml\` extension.
 ## Object Schema Structure
 
 \`\`\`yaml
-# yaml-language-server: $schema=https://raw.githubusercontent.com/ecsol/omnify-ts/main/packages/types/schemas/omnify-schema.json
+# yaml-language-server: $schema=https://unpkg.com/@famgia/omnify-types/schemas/omnify-schema.json
 name: ModelName          # Required: PascalCase
 kind: object             # Optional: 'object' (default) or 'enum'
 displayName:             # Optional: i18n display name
@@ -208,242 +187,95 @@ If Omnify MCP is configured, these tools are available:
 - \`omnify_get_examples\` - Example schemas
 `;
 
-// Examples skill file
-const EXAMPLES_CONTENT = `# Omnify Schema Examples
+// Config guide skill file
+const CONFIG_GUIDE_CONTENT = `# Omnify Configuration Guide
 
-## User Schema
+## Configuration File
 
-\`\`\`yaml
-name: User
-displayName:
-  ja: ユーザー
-  en: User
-options:
-  softDelete: true
-  timestamps: true
-properties:
-  name:
-    type: String
-    displayName:
-      ja: 名前
-      en: Name
-    required: true
-    maxLength: 255
-  email:
-    type: String
-    displayName:
-      ja: メールアドレス
-      en: Email
-    required: true
-    unique: true
-  password:
-    type: String
-    displayName:
-      ja: パスワード
-      en: Password
-    required: true
-  role:
-    type: EnumRef
-    enum: UserRole
-    default: user
-  posts:
-    type: Association
-    relation: OneToMany
-    target: Post
-    mappedBy: author
-\`\`\`
-
-## Post Schema
-
-\`\`\`yaml
-name: Post
-displayName:
-  ja: 投稿
-  en: Post
-group: blog
-options:
-  softDelete: true
-  timestamps: true
-properties:
-  title:
-    type: String
-    displayName:
-      ja: タイトル
-      en: Title
-    required: true
-    maxLength: 255
-  content:
-    type: LongText
-    displayName:
-      ja: 内容
-      en: Content
-  status:
-    type: EnumRef
-    enum: PostStatus
-    default: draft
-  publishedAt:
-    type: DateTime
-    displayName:
-      ja: 公開日時
-      en: Published At
-  author:
-    type: Association
-    relation: ManyToOne
-    target: User
-    onDelete: CASCADE
-  category:
-    type: Association
-    relation: ManyToOne
-    target: Category
-    onDelete: SET_NULL
-  tags:
-    type: Association
-    relation: ManyToMany
-    target: Tag
-\`\`\`
+Create \`omnify.config.ts\` in project root:
 
-## Category Schema
+\`\`\`typescript
+import { defineConfig } from '@famgia/omnify';
 
-\`\`\`yaml
-name: Category
-displayName:
-  ja: カテゴリー
-  en: Category
-group: blog
-options:
-  timestamps: true
-properties:
-  name:
-    type: String
-    displayName:
-      ja: カテゴリー名
-      en: Category Name
-    required: true
-    maxLength: 100
-  slug:
-    type: String
-    displayName:
-      ja: スラッグ
-      en: Slug
-    required: true
-    unique: true
-  description:
-    type: LongText
-    displayName:
-      ja: 説明
-      en: Description
-  posts:
-    type: Association
-    relation: OneToMany
-    target: Post
-    mappedBy: category
-\`\`\`
+export default defineConfig({
+  schemasDir: './schemas',
 
-## Enum Examples
+  database: {
+    driver: 'mysql',  // 'mysql' | 'pgsql' | 'sqlite' | 'sqlsrv' | 'mariadb'
+  },
 
-### UserRole Enum
-\`\`\`yaml
-name: UserRole
-kind: enum
-displayName:
-  ja: ユーザーロール
-  en: User Role
-values:
-  admin: 管理者
-  editor: 編集者
-  user: 一般ユーザー
-\`\`\`
+  output: {
+    laravel: {
+      migrationsPath: './database/migrations/omnify',
+      modelsPath: './app/Models',
+      enumsPath: './app/Enums',
+    },
+    typescript: {
+      path: './src/types/model',
+      singleFile: false,
+    },
+  },
 
-### PostStatus Enum
-\`\`\`yaml
-name: PostStatus
-kind: enum
-displayName:
-  ja: 投稿ステータス
-  en: Post Status
-values:
-  draft: 下書き
-  review: レビュー中
-  published: 公開済み
-  archived: アーカイブ
+  // Multi-language support (optional)
+  locale: {
+    locales: ['en', 'ja', 'vi'],
+    defaultLocale: 'en',
+    fallbackLocale: 'en',
+  },
+});
 \`\`\`
 
-## E-commerce Example
-
-### Product Schema
-\`\`\`yaml
-name: Product
-displayName:
-  ja: 商品
-  en: Product
-group: shop
-options:
-  softDelete: true
-  timestamps: true
-properties:
-  name:
-    type: String
-    required: true
-    maxLength: 255
-  description:
-    type: LongText
-  price:
-    type: Float
-    precision: 10
-    scale: 2
-    required: true
-  stock:
-    type: Int
-    default: 0
-    unsigned: true
-  sku:
-    type: String
-    unique: true
-    maxLength: 50
-  isActive:
-    type: Boolean
-    default: true
-  category:
-    type: Association
-    relation: ManyToOne
-    target: ProductCategory
-    onDelete: SET_NULL
+## Configuration Options
+
+### 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 |
+
+### 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 |
+
+## Common Mistakes
+
+❌ **Wrong** - \`locales\` at root level:
+\`\`\`typescript
+{
+  locales: ['en', 'ja'],  // ERROR: locales not in OmnifyConfig
+}
 \`\`\`
 
-### Order Schema
-\`\`\`yaml
-name: Order
-displayName:
-  ja: 注文
-  en: Order
-group: shop
-options:
-  timestamps: true
-properties:
-  orderNumber:
-    type: String
-    required: true
-    unique: true
-  status:
-    type: EnumRef
-    enum: OrderStatus
-    default: pending
-  totalAmount:
-    type: Float
-    precision: 12
-    scale: 2
-  customer:
-    type: Association
-    relation: ManyToOne
-    target: User
-    onDelete: RESTRICT
-  items:
-    type: Association
-    relation: OneToMany
-    target: OrderItem
-    mappedBy: order
-  shippingAddress:
-    type: Json
+✅ **Correct** - \`locales\` inside \`locale\` object:
+\`\`\`typescript
+{
+  locale: {
+    locales: ['en', 'ja'],
+    defaultLocale: 'en',
+  },
+}
 \`\`\`
 `;
 
@@ -455,8 +287,9 @@ const MCP_CONFIG = {
 };
 
 function findProjectRoot() {
-  // Start from the current working directory or script location
-  let dir = process.cwd();
+  // npm/pnpm set INIT_CWD to the directory where the install was run
+  // This is more reliable than process.cwd() during postinstall
+  let dir = process.env.INIT_CWD || process.cwd();
 
   // If we're in node_modules, go up to find the actual project
   const nodeModulesIndex = dir.indexOf('node_modules');
@@ -482,15 +315,16 @@ function createOmnifySkillFiles(projectRoot) {
       fs.mkdirSync(omnifyDir, { recursive: true });
     }
 
-    // Write schema guide
+    // Write base schema guide (plugin-specific guides are created by each plugin)
     const schemaGuidePath = path.join(omnifyDir, 'schema-guide.md');
     fs.writeFileSync(schemaGuidePath, SCHEMA_GUIDE_CONTENT, 'utf-8');
 
-    // Write examples
-    const examplesPath = path.join(omnifyDir, 'examples.md');
-    fs.writeFileSync(examplesPath, EXAMPLES_CONTENT, 'utf-8');
+    // Write config guide
+    const configGuidePath = path.join(omnifyDir, 'config-guide.md');
+    fs.writeFileSync(configGuidePath, CONFIG_GUIDE_CONTENT, 'utf-8');
 
-    console.log('  Created .claude/omnify/ skill files');
+    console.log('  Created .claude/omnify/schema-guide.md');
+    console.log('  Created .claude/omnify/config-guide.md');
     return true;
   } catch (error) {
     console.log('  Note: Could not create .claude/omnify/ skill files');
@@ -500,33 +334,49 @@ function createOmnifySkillFiles(projectRoot) {
 
 function createClaudeMd(projectRoot) {
   const claudeMdPath = path.join(projectRoot, 'CLAUDE.md');
-  // Check for both variants of the Omnify marker
-  const omnifyMarkers = ['# Omnify Schema', '## Omnify Schema', 'omnify/schema-guide.md'];
 
   // Check if CLAUDE.md exists
   if (fs.existsSync(claudeMdPath)) {
-    // Read existing content
     const existingContent = fs.readFileSync(claudeMdPath, 'utf-8');
 
     // Check if Omnify section already exists
-    if (omnifyMarkers.some((marker) => existingContent.includes(marker))) {
+    if (existingContent.includes(OMNIFY_MARKER)) {
       console.log('  CLAUDE.md already has Omnify section, skipping...');
       return false;
     }
 
     // Append Omnify section to existing CLAUDE.md
-    const newContent = existingContent.trimEnd() + '\n' + CLAUDE_MD_APPEND;
+    const newContent = existingContent.trimEnd() + '\n\n' + CLAUDE_MD_SECTION;
     fs.writeFileSync(claudeMdPath, newContent, 'utf-8');
-    console.log('  Appended Omnify section to existing CLAUDE.md');
+    console.log('  Appended Omnify section to CLAUDE.md');
     return true;
   }
 
-  // Create new CLAUDE.md
-  fs.writeFileSync(claudeMdPath, CLAUDE_MD_CONTENT, 'utf-8');
-  console.log('  Created CLAUDE.md with Omnify schema rules');
+  // Create new CLAUDE.md with just the Omnify section
+  fs.writeFileSync(claudeMdPath, CLAUDE_MD_SECTION, 'utf-8');
+  console.log('  Created CLAUDE.md');
   return true;
 }
 
+function createCursorRules(projectRoot) {
+  const cursorDir = path.join(projectRoot, '.cursor', 'rules');
+  const cursorRulesPath = path.join(cursorDir, 'omnify.md');
+
+  try {
+    // Create .cursor/rules directory
+    if (!fs.existsSync(cursorDir)) {
+      fs.mkdirSync(cursorDir, { recursive: true });
+    }
+
+    // Always overwrite - this file is fully managed by Omnify
+    fs.writeFileSync(cursorRulesPath, CURSORRULES_CONTENT, 'utf-8');
+    console.log('  Updated .cursor/rules/omnify.md');
+    return true;
+  } catch {
+    return false;
+  }
+}
+
 function configureClaudeMcp() {
   const homeDir = os.homedir();
   const claudeDir = path.join(homeDir, '.claude');
@@ -580,9 +430,9 @@ function main() {
     return;
   }
 
-  // Skip if this is a dev install (in the omnify-ts monorepo itself)
-  const cwd = process.cwd();
-  if (cwd.includes('omnify-ts') && !cwd.includes('node_modules')) {
+  // 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;
   }
 
@@ -596,13 +446,15 @@ function main() {
 
     // Create or update CLAUDE.md in project root
     createClaudeMd(projectRoot);
+
+    // Create Cursor rules
+    createCursorRules(projectRoot);
   }
 
   // Configure MCP server in user's home directory
   configureClaudeMcp();
 
   console.log('\n✅ Omnify setup complete!\n');
-  console.log('   Restart Claude Code/Desktop to enable MCP tools.\n');
 }
 
 main();