prisma-laravel-migrate 0.0.6 → 0.0.7

package/README.md

@@ -1,8 +1,8 @@
 # Prisma Laravel Migrate
 
-A generator toolkit that translates your **Prisma schema** into Laravel-compatible  
+A generator plugin that translates your **Prisma schema** into Laravel‑ready  
 **Database Migrations**, **Eloquent Models**, and **Enum classes**.  
-Everything is written in strict TypeScript and fully customizable through stubs, grouping, and marker-based injection.
+Built in strict TypeScript with fully‑customisable stubs, grouping, and marker‑based updates.
 
 ---
 
@@ -10,176 +10,167 @@ Everything is written in strict TypeScript and fully customizable through stubs,
 
 ```bash
 npm install prisma-laravel-migrate --save-dev
-
-(Requires prisma in the same project.)
-
+# requires the Prisma CLI in your project
+```
 
 ---
 
-🛠️ Prisma Generator Setup
+## 🛠️ Prisma Generator Setup
 
-Insert two generator blocks in schema.prisma:
+Add both generator blocks to **`schema.prisma`**:
 
+```prisma
 generator migrate {
   provider    = "prisma-laravel-migrate"
   stubDir     = "./prisma/stubs"
-  output      = "database/migrations"   // fallback
-  outputDir   = "database/migrations"   // takes precedence
+  output      = "database/migrations"     // fallback
+  outputDir   = "database/migrations"     // takes precedence
   startMarker = "// <prisma-laravel:start>"
   endMarker   = "// <prisma-laravel:end>"
-  noEmit      = false                   // set true to skip writing files
-  groups      = "./prisma/group-stubs.js" // optional group mapping
+  noEmit      = false
+  groups      = "./prisma/group-stubs.js"
 }
 
 generator modeler {
   provider      = "prisma-laravel-models"
   stubDir       = "./prisma/stubs"
   output        = "app/Models"
-  outputDir     = "app/Models"          // takes precedence
-  outputEnumDir = "app/Enums"           // enums folder (optional)
+  outputDir     = "app/Models"            // overrides output
+  outputEnumDir = "app/Enums"
   startMarker   = "// <prisma-laravel:start>"
   endMarker     = "// <prisma-laravel:end>"
   noEmit        = false
   groups        = "./prisma/group-stubs.js"
 }
+```
 
-Field Reference
-
-Key	Notes
-
-output / outputDir	Destination folder; outputDir overrides output.
-outputEnumDir	(modeler) folder for PHP enum classes.
-stubDir	Root stubs folder (migration/, model/, enum/).
-startMarker / endMarker	Region markers the generator will update.
-groups	Path to JS module exporting stub-group mappings.
-noEmit	If true, generator parses but writes no files.
-
+### Field Reference
 
+| Key | Notes |
+| --- | --- |
+| `outputDir / output` | Destination folder (`outputDir` takes precedence). |
+| `outputEnumDir` | (modeler) directory for PHP enum classes. |
+| `stubDir` | Root stubs folder (`migration/`, `model/`, `enum/`). |
+| `startMarker/endMarker` | Region markers the generator will update. |
+| `groups` | JS module exporting stub‑group mappings. |
+| `noEmit` | If `true`, generator parses but **writes no** files. |
 
 ---
 
-📁 Stub Folder Layout
-
-Running
-
-npx prisma-laravel-cli init --schema=prisma/schema.prisma
-
-creates:
+## 📁 Stub Folder Layout
 
+```
 prisma/stubs/
 ├── migration/index.stub
 ├── model/index.stub
 ├── model/simple-model.stub
 └── enum/index.stub
+```
 
-Copy log (example):
-
-➡️  Copied migration.stub → stubs/migration/index.stub
-➡️  Copied model.stub     → stubs/model/index.stub
-➡️  Copied enums.stub     → stubs/enum/index.stub
-➡️  Copied simple-model.stub → stubs/model/simple-model.stub
-
-Override a single table / enum by adding
-stubs/<type>/<name>.stub (e.g. stubs/model/users.stub).
-
+Create a table‑specific override with  
+`stubs/<type>/<table>.stub` (e.g. `stubs/model/users.stub`).
 
 ---
 
-🔧 CLI Commands
+## 🔧 CLI Commands
 
-Command	Purpose
+| Command | What it does |
+| --- | --- |
+| `init` | Inject generator blocks & scaffold stub folders |
+| `customize` | Create per‑table stub overrides |
+| `gen` | Run `prisma generate` then Laravel generators |
 
-init	Injects generator blocks & scaffold stub folders.
-customize	Create per-table stub overrides.
-gen	Run prisma generate and then Laravel generators.
-
-
-init
+### init
 
+```bash
 npx prisma-laravel-cli init --schema=prisma/schema.prisma
+```
 
-customize
+### customize
 
-# create migration+model overrides for users & accounts
-npx prisma-laravel-cli customize -t migration,model -n users,accounts
+Generate override stubs.
 
-# create enum overrides
-npx prisma-laravel-cli customize -t enum -n UserStatus,RoleType
+```bash
+npx prisma-laravel-cli customize \
+  -t <types> \
+  -n <names> \
+  [--force] \
+  [--config <path>]
+```
+
+| Flag | Description |
+| --- | --- |
+| `-t, --type` | **Required.** Comma‑separated list of stub types.<br>Valid values: `migration`, `model`, `enum`. You may combine `migration,model`; `enum` must be used alone. |
+| `-n, --names` | **Required.** Comma‑separated table or enum names (e.g. `users,accounts`). |
+| `--force` | Overwrite existing stub files. |
+| `--config` | Path to an alternate CLI config file (custom stubDir/groups). |
+
+**Behaviour**
+
+1. Checks `<stubDir>/<type>/<name>.stub`.
+2. If missing, copies from `index.stub` → that path and logs:  
+  `➡️ Created stubs/<type>/<name>.stub from index.stub`
+3. If present and `--force` **not** set:  
+  `⏭️ Skipped existing stubs/<type>/<name>.stub`
+4. With `--force`, overwrites and logs creation.
+
+**Example**
 
-migration & model may be combined; enum must be separate.
+```bash
+# migration + model overrides for two tables
+npx prisma-laravel-cli customize -t migration,model -n users,accounts
+```
 
-gen
+### gen
 
-# run prisma generate then Laravel generation
+```bash
+# run prisma generate then Laravel generators
 npx prisma-laravel-cli gen --config=prisma/laravel.config.js
 
 # skip prisma generate step
 npx prisma-laravel-cli gen --config=prisma/laravel.config.js --skipGenerate
+```
 
-prisma/laravel.config.js example:
+`prisma/laravel.config.js` example:
 
+```js
 module.exports = {
   migrator: {
-    outputDir: 'database/migrations',
-    stubDir: 'prisma/stubs',
-    groups: './prisma/group-stubs.js',
+    outputDir: "database/migrations",
+    stubDir: "prisma/stubs",
+    groups: "./prisma/group-stubs.js",
   },
   modeler: {
-    outputDir: 'app/Models',
-    outputEnumDir: 'app/Enums',
-    stubDir: 'prisma/stubs',
-    groups: './prisma/group-stubs.js',
+    outputDir: "app/Models",
+    outputEnumDir: "app/Enums",
+    stubDir: "prisma/stubs",
+    groups: "./prisma/group-stubs.js",
   },
 };
-
+```
 
 ---
 
-🧩 Grouping Stubs
-
-prisma/group-stubs.js
-
-module.exports = [
-  { stubFile: 'auth.stub',    tables: ['users','accounts','password_resets'] },
-  { stubFile: 'billing.stub', tables: ['invoices','transactions'] },
-];
-
-Resolution order
-
-1. stubs/<type>/<table>.stub
-
-
-2. Matching group stub (stubFile)
-
-
-3. stubs/<type>/index.stub
-
+## ✨ Stub Customization Notes
 
+Stubs are **JS template literals**. Escape \\` and \\${ } if you want them literally.
 
+> **Full custom model stubs**  
+> If you plan to hand-craft **all** the internal sections yourself
+> (fillable, hidden, casts, etc.), remove the `${content}` placeholder
+> but **keep** the `// <prisma-laravel:start>` and
+> `// <prisma-laravel:end>` markers so the generator still knows where
+> to inject future updates.  
+> Remove the markers only if you never want the file touched again
 
 ---
 
-✨ Stub Customization Notes
-
-Stubs are JavaScript template literals. Escape \` and \${ } if you need them literally.
+## 📑 Default Stub Templates
 
-Keep the ${content} placeholder inside the marker block if you want the generator to keep injecting its dynamic chunk.
-
-> Full Custom Model Stubs
-If you plan to hand-craft a model stub completely—removing both the ${content} placeholder and the // <prisma-laravel:start> / // <prisma-laravel:end> markers—set
-noEmit = true for the modeler generator (or exclude that table via custom rules).
-Otherwise, the generator has nowhere to inject its code and will skip the file.
-Leaving the markers + ${content} lets you customise everything around the generated region while the tool continues to maintain fillable lists, casts, and relations automatically.
-
-
-
-
----
-
-📑 Default Stub Templates
-
-Enum
+<details>
+<summary>Enum <code>index.stub</code></summary>
 
+```php
 <?php
 
 namespace App\\Enums;
@@ -190,9 +181,14 @@ enum ${enumDef.name}: string
 ${enumDef.values.map(v => `    case ${v} = '${v}';`).join('\\n')}
     // <prisma-laravel:end>
 }
+```
 
-Migration
+</details>
 
+<details>
+<summary>Migration <code>index.stub</code></summary>
+
+```php
 <?php
 
 use Illuminate\\Database\\Migrations\\Migration;
@@ -215,12 +211,18 @@ return new class extends Migration
         Schema::dropIfExists('${tableName}');
     }
 };
+```
 
+</details>
 
 ---
 
-🏗️ Complex Model Stub Example
+## 🏗️ Complex Model Stub Example
+
+<details>
+<summary>Expand stub</summary>
 
+```php
 <?php
 
 namespace App\\Models;
@@ -233,7 +235,7 @@ class ${model.className} extends Model
 {
     protected $table = '${model.tableName}';
 
-    /* ---------- Mass Assignment ---------- */
+    /* Mass Assignment */
     protected $fillable = [
 ${model.properties.filter(p => p.fillable).map(p => `        '${p.name}',`).join('\\n')}
     ];
@@ -241,7 +243,7 @@ ${model.properties.filter(p => p.fillable).map(p => `        '${p.name}',`).join
 ${(model.guarded ?? []).map(n => `        '${n}',`).join('\\n')}
     ];
 
-    /* ---------- Hidden / Casts ---------- */
+    /* Hidden & Casts */
     protected $hidden = [
 ${model.properties.filter(p => p.hidden).map(p => `        '${p.name}',`).join('\\n')}
     ];
@@ -250,80 +252,48 @@ ${model.properties.filter(p => p.cast).map(p => `        '${p.name}' => '${p.cas
 ${model.properties.filter(p => p.enumRef).map(p => `        '${p.name}' => ${p.enumRef}::class,`).join('\\n')}
     ];
 
-    /* ---------- Eager Loading ---------- */
-    protected $with = [
-${(model.with ?? []).map(r => `        '${r}',`).join('\\n')}
-    ];
-
-    /* ---------- Interfaces ---------- */
+    /* Interfaces metadata */
     public array $interfaces = [
-${Object.entries(model.interfaces).map(([k,i]) => `        '${k}' => {${i.import ? ` import: '${i.import}',` : ''} type: '${i.type}' },`).join('\\n')}
+${Object.entries(model.interfaces).map(([k,i]) =>
+`        '${k}' => {${i.import ? ` import: '${i.import}',` : ''} type: '${i.type}' },`).join('\\n')}
     ];
+    // This structure is useful for packages like fumeapp/modeltyper which
+    // read interface metadata to build TypeScript helpers.
 
-    /* ---------- Relationships ---------- */
+    /* Relationships */
 ${model.relations.map(r => {
   const args = [r.modelClass, r.foreignKey ? `'${r.foreignKey}'` : '', r.localKey ? `'${r.localKey}'` : ''].filter(Boolean).join(', ');
-  return `    public function ${r.name}(): ${r.type.charAt(0).toUpperCase() + r.type.slice(1)}\\n    {\\n        return $this->${r.type}(${args});\\n    }`;
+  return `    public function ${r.name}(): ${r.type.charAt(0).toUpperCase()+r.type.slice(1)}\\n    {\\n        return $this->${r.type}(${args});\\n    }`;
 }).join('\\n\\n')}
 
     // <prisma-laravel:start>
     ${content}
     // <prisma-laravel:end>
 }
+```
 
+</details>
 
 ---
 
-📚 Interfaces Metadata Example
-
-Useful for fumeapp/modeltyper integration:
-
-public array $interfaces = [
-    'props' => [
-        'import' => \"@typings/service-forms\",
-        'type'   => 'ServiceProps',
-    ],
-    'services' => [
-        'type' => 'Array<SMMService>',
-    ],
-];
-
-Type definition:
-Record<string, { import?: string; type: string }>.
-
-
----
-
-🚀 Enum Casting
-
-The generator automatically casts Prisma enums:
+## 🚀 Enum Casting
 
+```php
 protected $casts = [
     'status' => StatusEnum::class,
 ];
-
-Enums are saved to outputEnumDir if configured.
-
-
----
-
-💡 Tips
-
-Combine migration & model in the same customize command when table names align.
-
-Escape template characters in stub files.
-
-Use noEmit: true for dry-runs or CI validation.
-
-
+```
 
 ---
 
-📜 License
+## 💡 Tips
 
-MIT — Happy scaffolding! 🎉
+- Combine `migration` & `model` in one customize command when table names align.
+- Use `noEmit: true` for dry‑runs or CI validation.
+- Escape template chars in stub files.
 
 ---
 
-Copy that entire block into **README.md** and you’ll have the corrected, full documentation—including the note about fully custom model stubs.
+## 📜 License
 
+MIT — Happy scaffolding! 🎉

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prisma-laravel-migrate",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Generate laravel migrations and/or models using prisma files",
   "bin": {
     "prisma-laravel-migrations": "./dist/cli/index.js",