hekireki 0.2.1 → 0.2.2

package/README.md

@@ -7,6 +7,8 @@
 - 💎 Automatically generates [Zod](https://zod.dev/) schemas from your Prisma schema
 - 🤖 Automatically generates [Valibot](https://valibot.dev/) schemas from your Prisma schema
 - 📊 Creates [Mermaid](https://mermaid.js.org/) ER diagrams
+- 🧪 Generates [Ecto](https://hexdocs.pm/ecto/Ecto.Schema.html) schemas for Elixir projects
+  ⚠️ Foreign key constraints are **not** included — manage relationships in your application logic
 
 ## Installation
 
@@ -35,13 +37,19 @@ generator Hekireki-ER {
 generator Hekireki-Zod {
     provider = "hekireki-zod"
     type     = true
-    comment  = false
+    comment  = true
 }
 
 generator Hekireki-Valibot {
     provider = "hekireki-valibot"
     type     = true
-    comment  = false
+    comment  = true
+}
+
+generator Hekireki-Ecto {
+    provider = "hekireki-ecto"
+    output = "schema"
+    app = "DBSchema"
 }
 
 model User {
@@ -63,12 +71,10 @@ model Post {
     /// @z.uuid()
     /// @v.pipe(v.string(), v.uuid())
     id String @id @default(uuid())
-
     /// Article title
     /// @z.string().min(1).max(100)
     /// @v.pipe(v.string(), v.minLength(1), v.maxLength(100))
     title String
-
     /// Body content (no length limit)
     /// @z.string()
     /// @v.string()
@@ -180,6 +186,32 @@ erDiagram
     }
 ```
 
+## Ecto
+
+```elixir
+defmodule DBSchema.User do
+  use Ecto.Schema
+  @primary_key false
+  schema "user" do
+    field(:id, :binary_id, primary_key: true)
+    field(:name, :string)
+  end
+end
+```
+
+```elixir
+defmodule DBSchema.Post do
+  use Ecto.Schema
+  @primary_key false
+  schema "post" do
+    field(:id, :binary_id, primary_key: true)
+    field(:title, :string)
+    field(:content, :string)
+    field(:userId, :string)
+  end
+end
+```
+
 ## Configuration
 
 ### Zod Generator Options
@@ -208,6 +240,13 @@ erDiagram
 | `output`     | `string`  | `./mermaid-er`                      | Output directory                                 |
 | `file`       | `string`  | `ER.md`                             | File Name                                        |
 
+### Ecto Generator Options
+
+| Option       | Type      | Default                             | Description                                      |
+|--------------|-----------|-------------------------------------|--------------------------------------------------|
+| `output`     | `string`  | `./ecto`                            | Output directory                                 |
+| `app`        | `string`  | `MyApp`                             | App Name                                        |
+
 ⚠️ WARNING: Potential Breaking Changes Without Notice
 
 This project is in **early development** and being maintained by a developer with about 2 years of experience. While I'm doing my best to create a useful tool:

package/dist/generator/ecto/generator/ecto.d.ts

@@ -0,0 +1,3 @@
+import type { DMMF } from '@prisma/generator-helper';
+export declare function ectoSchemas(models: readonly DMMF.Model[], app: string | string[]): string;
+export declare function writeEctoSchemasToFiles(models: readonly DMMF.Model[], app: string | string[], outDir: string): Promise<void>;

package/dist/generator/ecto/generator/ecto.js

@@ -0,0 +1,61 @@
+import fsp from 'node:fs/promises';
+import { join } from 'node:path';
+import { snakeCase } from '../../../shared/utils/index.js';
+import { prismaTypeToEctoType } from '../utils/prisma-type-to-ecto-type.js';
+function getPrimaryKeyType(field) {
+    const def = field.default;
+    return def && typeof def === 'object' && 'name' in def && def.name === 'uuid' ? 'binary_id' : 'id';
+}
+function makeMutable(models) {
+    return models.map((m) => ({
+        ...m,
+        fields: m.fields?.map((f) => ({ ...f })) ?? [],
+    }));
+}
+export function ectoSchemas(models, app) {
+    const mutableModels = makeMutable(models);
+    return mutableModels
+        .map((model) => {
+        const idFields = model.fields.filter((f) => f.isId);
+        const isCompositePK = model.primaryKey && model.primaryKey.fields.length > 1;
+        if (!(idFields.length || isCompositePK)) {
+            return '';
+        }
+        const pkField = idFields[0];
+        const pkType = pkField ? getPrimaryKeyType(pkField) : ':id';
+        const excludedFieldNames = ['inserted_at', 'updated_at'];
+        const fields = model.fields.filter((f) => !(f.relationName || excludedFieldNames.includes(f.name)));
+        const hasInsertedAt = model.fields.some((f) => f.name === 'inserted_at');
+        const hasUpdatedAt = model.fields.some((f) => f.name === 'updated_at');
+        const lines = [
+            `defmodule ${app}.${model.name} do`,
+            '  use Ecto.Schema',
+            '  @primary_key false',
+            `  schema "${snakeCase(model.name)}" do`,
+            ...fields.map((f) => {
+                const type = f.isId ? pkType : prismaTypeToEctoType(f.type);
+                const primary = f.isId && !isCompositePK ? ', primary_key: true' : '';
+                return `    field(:${f.name}, :${type}${primary})`;
+            }),
+            ...(hasInsertedAt ? ['    field :inserted_at, :utc_datetime'] : []),
+            ...(hasUpdatedAt ? ['    field :updated_at, :utc_datetime'] : []),
+            '  end',
+            'end',
+        ];
+        return lines.join('\n');
+    })
+        .filter(Boolean)
+        .join('\n\n');
+}
+export async function writeEctoSchemasToFiles(models, app, outDir) {
+    const mutableModels = makeMutable(models);
+    await fsp.mkdir(outDir, { recursive: true });
+    for (const model of mutableModels) {
+        const code = ectoSchemas([model], app);
+        if (!code.trim())
+            continue;
+        const filePath = join(outDir, `${snakeCase(model.name)}.ex`);
+        await fsp.writeFile(filePath, code, 'utf8');
+        console.log(`✅ wrote ${filePath}`);
+    }
+}

package/dist/generator/ecto/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import type { GeneratorOptions } from '@prisma/generator-helper';
+export declare function main(options: GeneratorOptions): Promise<void>;

package/dist/generator/ecto/index.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+import pkg from '@prisma/generator-helper';
+import { writeEctoSchemasToFiles } from './generator/ecto.js';
+const { generatorHandler } = pkg;
+export async function main(options) {
+    const output = options.generator.output?.value ?? './ecto';
+    const app = options.generator.config?.app ?? 'MyApp';
+    await writeEctoSchemasToFiles(options.dmmf.datamodel.models, app, output);
+}
+generatorHandler({
+    onManifest() {
+        return {
+            defaultOutput: './ecto/',
+            prettyName: 'Hekireki-Ecto',
+        };
+    },
+    onGenerate: main,
+});

package/dist/generator/ecto/utils/index.d.ts

@@ -0,0 +1 @@
+export { prismaTypeToEctoType } from './prisma-type-to-ecto-type.js';

package/dist/generator/ecto/utils/index.js

@@ -0,0 +1 @@
+export { prismaTypeToEctoType } from './prisma-type-to-ecto-type.js';

package/dist/generator/ecto/utils/prisma-type-to-ecto-type.d.ts

@@ -0,0 +1 @@
+export declare function prismaTypeToEctoType(type: string): 'integer' | 'string' | 'boolean' | 'utc_datetime';

package/dist/generator/ecto/utils/prisma-type-to-ecto-type.js

@@ -0,0 +1,11 @@
+export function prismaTypeToEctoType(type) {
+    if (type === 'Int')
+        return 'integer';
+    if (type === 'String')
+        return 'string';
+    if (type === 'Boolean')
+        return 'boolean';
+    if (type === 'DateTime')
+        return 'utc_datetime';
+    return 'string';
+}

package/dist/shared/utils/decapitalize.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Decapitalize the first letter of a string
+ * @param { string } str - String to decapitalize
+ * @returns { string } String with the first letter in lowercase
+ *
+ * @example
+ * decapitalize('Posts')    // Returns: 'posts'
+ * decapitalize('User')     // Returns: 'user'
+ * decapitalize('Api')      // Returns: 'api'
+ *
+ * @remarks
+ * - Leaves the rest of the string unchanged
+ * - Returns an empty string if the input is empty
+ */
+export declare function decapitalize(str: string): string;

package/dist/shared/utils/decapitalize.js

@@ -0,0 +1,17 @@
+/**
+ * Decapitalize the first letter of a string
+ * @param { string } str - String to decapitalize
+ * @returns { string } String with the first letter in lowercase
+ *
+ * @example
+ * decapitalize('Posts')    // Returns: 'posts'
+ * decapitalize('User')     // Returns: 'user'
+ * decapitalize('Api')      // Returns: 'api'
+ *
+ * @remarks
+ * - Leaves the rest of the string unchanged
+ * - Returns an empty string if the input is empty
+ */
+export function decapitalize(str) {
+    return `${str.charAt(0).toLowerCase()}${str.slice(1)}`;
+}

package/dist/shared/utils/index.d.ts

@@ -1 +1,3 @@
 export { capitalize } from './capitalize.js';
+export { decapitalize } from './decapitalize.js';
+export { snakeCase } from './snake-case.js';

package/dist/shared/utils/index.js

@@ -1 +1,3 @@
 export { capitalize } from './capitalize.js';
+export { decapitalize } from './decapitalize.js';
+export { snakeCase } from './snake-case.js';

package/dist/shared/utils/snake-case.d.ts

@@ -0,0 +1 @@
+export declare function snakeCase(name: string): string;

package/dist/shared/utils/snake-case.js

@@ -0,0 +1,3 @@
+export function snakeCase(name) {
+    return `${name.replace(/([a-z0-9])([A-Z])/g, '$1_$2').toLowerCase()}`;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hekireki",
   "type": "module",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "license": "MIT",
   "description": "Hekireki is a tool that generates validation schemas for Zod and Valibot, as well as ER diagrams, from Prisma schemas annotated with comments.",
   "keywords": [
@@ -29,7 +29,8 @@
   "bin": {
     "hekireki-zod": "dist/generator/zod/index.js",
     "hekireki-valibot": "dist/generator/valibot/index.js",
-    "hekireki-mermaid-er": "dist/generator/mermaid-er/index.js"
+    "hekireki-mermaid-er": "dist/generator/mermaid-er/index.js",
+    "hekireki-ecto": "dist/generator/ecto/index.js"
   },
   "scripts": {
     "generate": "prisma generate",