mutano 3.2.0 → 3.3.0

package/README.md

@@ -180,6 +180,39 @@ export type UpdateableUser = Updateable<User>;
 | `camelCase` | Convert to camelCase |
 | `dryRun` | Return content without writing files |
 | `magicComments` | Enable @zod/@ts/@kysely comments (Obs.: no SQLite support) |
+| `inflection` | Transform model names: `'singular'`, `'plural'`, or `'none'` (default) |
+
+### Inflection
+
+Transform table/view names to singular or plural form in generated types:
+
+```typescript
+// Singular inflection - "users" table becomes "User" type
+await generate({
+  origin: { /* ... */ },
+  destinations: [{ type: 'zod' }],
+  inflection: 'singular'
+})
+
+// Plural inflection - "user" table becomes "Users" type
+await generate({
+  origin: { /* ... */ },
+  destinations: [{ type: 'ts' }],
+  inflection: 'plural'
+})
+```
+
+**Examples:**
+
+| Table Name | `inflection: 'singular'` | `inflection: 'plural'` | `inflection: 'none'` |
+|------------|-------------------------|----------------------|---------------------|
+| `users` | `UserType` | `UsersType` | `UsersType` |
+| `companies` | `CompanyType` | `CompaniesType` | `CompaniesType` |
+| `people` | `PersonType` | `PeopleType` | `PeopleType` |
+| `categories` | `CategoryType` | `CategoriesType` | `CategoriesType` |
+| `user_accounts` | `UserAccountType` | `UserAccountsType` | `UserAccountsType` |
+
+Works with all output types (Zod, TypeScript, Kysely) and combines with `camelCase` option.
 
 ## Magic Comments
 

package/dist/main.d.ts

@@ -84,6 +84,7 @@ interface Config {
     magicComments?: boolean;
     includeViews?: boolean;
     enumDeclarations?: Record<string, string[]>;
+    inflection?: 'singular' | 'plural' | 'none';
 }
 interface GenerateContentParams {
     table: string;
@@ -160,12 +161,8 @@ declare function getType(op: OperationType, desc: Desc, config: Config, destinat
 
 /**
  * Mutano - Database schema to TypeScript/Zod/Kysely converter
- * Refactored for better maintainability and modularity
  */
 
-/**
- * Main generate function - orchestrates the entire schema generation process
- */
 declare function generate(config: Config): Promise<Record<string, string>>;
 
 export { defaultKyselyHeader, defaultZodHeader, extractKyselyExpression, extractTSExpression, extractTypeExpression, extractZodExpression, generate, generateContent, generateViewContent, getType };

package/dist/main.js

@@ -2,6 +2,7 @@ import * as path from 'node:path';
 import camelCase from 'camelcase';
 import { writeFile } from 'node:fs/promises';
 import { ensureDir } from 'fs-extra/esm';
+import pluralize from 'pluralize';
 import knex from 'knex';
 import { readFileSync } from 'node:fs';
 import { createPrismaSchemaBuilder } from '@mrleebo/prisma-ast';
@@ -48,6 +49,16 @@ function createEntityList(tables, views) {
   return allEntities.sort((a, b) => a.name.localeCompare(b.name));
 }
 
+function applyInflection(name, inflection) {
+  if (inflection === "singular") {
+    return pluralize.singular(name);
+  }
+  if (inflection === "plural") {
+    return pluralize.plural(name);
+  }
+  return name;
+}
+
 const dateTypes = {
   mysql: ["date", "datetime", "timestamp"],
   postgres: [
@@ -472,8 +483,9 @@ function generateViewContent({
   defaultZodHeader
 }) {
   let content = "";
+  const inflectedView = applyInflection(view, config.inflection);
   if (destination.type === "kysely") {
-    const pascalView = camelCase(view, { pascalCase: true });
+    const pascalView = camelCase(inflectedView, { pascalCase: true });
     content += `// Kysely type definitions for ${view} (view)
 
 `;
@@ -493,7 +505,7 @@ function generateViewContent({
     content += `export type Selectable${pascalView}View = Selectable<${pascalView}View>;
 `;
   } else if (destination.type === "ts") {
-    const pascalView = camelCase(view, { pascalCase: true });
+    const pascalView = camelCase(inflectedView, { pascalCase: true });
     content += `// TypeScript interface for ${view} (view - read-only)
 `;
     content += `export interface ${pascalView}View {
@@ -523,7 +535,7 @@ function generateViewContent({
 `;
     }
     content += "})\n\n";
-    const pascalView = camelCase(view, { pascalCase: true });
+    const pascalView = camelCase(inflectedView, { pascalCase: true });
     content += `export type ${camelCase(`${pascalView}ViewType`, {
       pascalCase: true
     })} = z.infer<typeof ${snakeView}_view>
@@ -577,7 +589,8 @@ function generateTypeScriptContent({
   isCamelCase
 }) {
   let content = "";
-  const pascalTable = camelCase(table, { pascalCase: true });
+  const inflectedTable = applyInflection(table, config.inflection);
+  const pascalTable = camelCase(inflectedTable, { pascalCase: true });
   content += `// TypeScript interfaces for ${table}
 
 `;
@@ -627,7 +640,8 @@ function generateKyselyContent({
   isCamelCase
 }) {
   let content = "";
-  const pascalTable = camelCase(table, { pascalCase: true });
+  const inflectedTable = applyInflection(table, config.inflection);
+  const pascalTable = camelCase(inflectedTable, { pascalCase: true });
   content += `// Kysely type definitions for ${table}
 
 `;
@@ -676,6 +690,7 @@ function generateZodContent({
     content += header;
   }
   const snakeTable = toSnakeCase(table);
+  const inflectedTable = applyInflection(table, config.inflection);
   content += `export const ${snakeTable} = z.object({
 `;
   for (const desc of describes) {
@@ -720,13 +735,14 @@ function generateZodContent({
 `;
   }
   content += "})\n\n";
-  content += `export type ${camelCase(`${table}Type`, { pascalCase: true })} = z.infer<typeof ${snakeTable}>
+  const pascalInflectedTableType = camelCase(`${inflectedTable}Type`, { pascalCase: true });
+  content += `export type ${pascalInflectedTableType} = z.infer<typeof ${snakeTable}>
 `;
-  content += `export type Insertable${camelCase(`${table}Type`, { pascalCase: true })} = z.infer<typeof insertable_${snakeTable}>
+  content += `export type Insertable${pascalInflectedTableType} = z.infer<typeof insertable_${snakeTable}>
 `;
-  content += `export type Updateable${camelCase(`${table}Type`, { pascalCase: true })} = z.infer<typeof updateable_${snakeTable}>
+  content += `export type Updateable${pascalInflectedTableType} = z.infer<typeof updateable_${snakeTable}>
 `;
-  content += `export type Selectable${camelCase(`${table}Type`, { pascalCase: true })} = z.infer<typeof selectable_${snakeTable}>
+  content += `export type Selectable${pascalInflectedTableType} = z.infer<typeof selectable_${snakeTable}>
 `;
   return content;
 }
@@ -913,7 +929,24 @@ function extractPrismaEntities(config) {
     if (prismaEnum && "name" in prismaEnum && "enumerators" in prismaEnum) {
       const enumName = prismaEnum.name;
       const enumerators = prismaEnum.enumerators;
-      enumDeclarations[enumName] = enumerators.map((e) => {
+      const hasEnumIgnore = enumerators.some(
+        (item) => item.type === "attribute" && item.name === "ignore" && item.kind === "object"
+      );
+      if (hasEnumIgnore) {
+        continue;
+      }
+      const filteredEnumValues = enumerators.filter((e) => {
+        if (e.type === "attribute") {
+          return false;
+        }
+        if ("attributes" in e && e.attributes) {
+          const hasIgnore = e.attributes.some((attr) => attr.name === "ignore");
+          if (hasIgnore) {
+            return false;
+          }
+        }
+        return true;
+      }).map((e) => {
         if ("attributes" in e && e.attributes) {
           const mapAttr = e.attributes.find((attr) => attr.name === "map");
           if (mapAttr && mapAttr.args && mapAttr.args.length > 0) {
@@ -931,6 +964,7 @@ function extractPrismaEntities(config) {
         }
         return e.name;
       });
+      enumDeclarations[enumName] = filteredEnumValues;
     }
   }
   return { tables, views, enumDeclarations };
@@ -1138,8 +1172,9 @@ export interface ${schemaName} {
 `;
       const sortedTableEntries = tableContents.map(({ table, content }) => {
         const isView = content.includes("(view");
-        const pascalTable = camelCase(table, { pascalCase: true }) + (isView ? "View" : "");
-        const tableKey = isCamelCase ? camelCase(table) : table;
+        const inflectedTable = applyInflection(table, config.inflection);
+        const pascalTable = camelCase(inflectedTable, { pascalCase: true }) + (isView ? "View" : "");
+        const tableKey = isCamelCase ? camelCase(inflectedTable) : inflectedTable;
         return { tableKey, pascalTable, isView };
       }).sort((a, b) => a.tableKey.localeCompare(b.tableKey));
       for (const { tableKey, pascalTable } of sortedTableEntries) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "mutano",
   "type": "module",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Converts Prisma/MySQL/PostgreSQL/SQLite schemas to Zod/TS/Kysely interfaces",
   "author": "Alisson Cavalcante Agiani <thelinuxlich@gmail.com>",
   "license": "MIT",
@@ -19,11 +19,13 @@
     "@mrleebo/prisma-ast": "^0.13.0",
     "@types/fs-extra": "^11.0.4",
     "@types/pg": "^8.15.5",
+    "@types/pluralize": "^0.0.33",
     "camelcase": "^8.0.0",
     "fs-extra": "^11.3.2",
     "knex": "^3.1.0",
     "mysql2": "^3.14.4",
     "pg": "^8.16.3",
+    "pluralize": "^8.0.0",
     "sqlite3": "^5.1.7"
   },
   "devDependencies": {