db-model-router 1.0.2 → 1.0.4

package/docs/SKILL.md

@@ -1,15 +1,47 @@
+---
+name: db-model-router
+description: Database-agnostic REST API generator for Node.js/Express. Define model → get CRUD API + Express routes. 10 adapters, identical API. Works with express or ultimate-express.
+---
+
 # db-model-router — LLM Skill Reference
 
-Database-agnostic REST API generator for Node.js/Express. Define model → get CRUD API + Express routes. 9 adapters, identical API.
+Database-agnostic REST API generator for Node.js/Express. Define model → get CRUD API + Express routes. 10 adapters, identical API. Works with `express` or `ultimate-express`. Generated projects use ESM (`import`/`export`).
+
+## LLM Workflow (follow this order)
+
+1. **Scaffold**: `db-model-router init --framework express --database postgres --session redis --rateLimiting --helmet --logger --yes` (all flags → zero prompts)
+2. **Start infra**: `npm run docker:up` (starts DB + CloudBeaver + optional Loki/Grafana)
+3. **Migrations**: Write SQL/JS migration files into `migrations/`, then `npm run migrate`
+4. **Generate models**: `db-model-router generate --from dbmr.schema.json --models`
+5. **Generate routes + tests**: `db-model-router generate --from dbmr.schema.json --routes --tests`
+6. **Run**: `npm run dev`
+
+Step 1 creates the project with ESM, Docker, and all infrastructure. Step 2 starts containers. Steps 3-5 define schema and generate code. Step 6 starts the server.
 
 ## Install
 
 ```bash
-npm install db-model-router <driver>
+npm install db-model-router <framework> <driver>
 ```
 
+Frameworks: `express` or `ultimate-express` (auto-detected, prefers ultimate-express)
 Drivers: `mysql2`, `pg`, `better-sqlite3`, `mongodb`, `mssql`, `oracledb`, `ioredis`, `@aws-sdk/client-dynamodb @aws-sdk/lib-dynamodb`
 
+## Adapters
+
+| Module Key    | Driver                                           | Default Port |
+| ------------- | ------------------------------------------------ | ------------ |
+| `mysql`       | mysql2                                           | 3306         |
+| `mariadb`     | mysql2                                           | 3306         |
+| `postgres`    | pg                                               | 5432         |
+| `sqlite3`     | better-sqlite3                                   | —            |
+| `mongodb`     | mongodb                                          | 27017        |
+| `mssql`       | mssql                                            | 1433         |
+| `cockroachdb` | pg                                               | 26257        |
+| `oracle`      | oracledb                                         | 1521         |
+| `redis`       | ioredis                                          | 6379         |
+| `dynamodb`    | @aws-sdk/client-dynamodb + @aws-sdk/lib-dynamodb | —            |
+
 ## Init → Connect → Model → Route
 
 ```js
@@ -42,12 +74,12 @@ app.use("/users", route(users));
 
 ## model(db, table, structure, pk, unique, option)
 
-| Param     | Type            | Description                                                                                                           |
-| --------- | --------------- | --------------------------------------------------------------------------------------------------------------------- |
-| structure | `{col: "rule"}` | Types: `string\|integer\|numeric\|object`. Prefix `required\|` for NOT NULL. Exclude PK, timestamps, soft-delete cols |
-| pk        | string          | Primary key column. Default `"id"`                                                                                    |
-| unique    | string[]        | Columns for upsert conflict resolution                                                                                |
-| option    | object          | `{ safeDelete, created_at, modified_at }` — column names or null                                                      |
+| Param     | Type            | Description                                                                                                                                                                              |
+| --------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| structure | `{col: "rule"}` | Types: `string\|integer\|numeric\|boolean\|object\|datetime\|auto_increment`. Prefix `required\|` for NOT NULL. PK, timestamps, soft-delete cols are auto-excluded by the code generator |
+| pk        | string          | Primary key column. Convention: `<table>_id`                                                                                                                                             |
+| unique    | string[]        | Columns for upsert conflict resolution                                                                                                                                                   |
+| option    | object          | `{ safeDelete, created_at, modified_at }` — column names or null                                                                                                                         |
 
 ## Model Methods (all async)
 
@@ -83,14 +115,22 @@ Structure: `[OR_groups[AND_conditions[col, op, val]]]`
 Ops: `= != < > <= >= like not like in not in`
 
 ```js
+// AND: age > 25 AND type = 1
 [
   [
     ["age", ">", 25],
     ["type", "=", 1],
   ],
-][([["name", "=", "A"]], [["name", "=", "B"]])][[["type", "in", [1, 2, 3]]]][ // AND // OR // IN
+][
+  // OR: name = "A" OR name = "B"
+  ([["name", "=", "A"]], [["name", "=", "B"]])
+][
+  // IN
+  [["type", "in", [1, 2, 3]]]
+][
+  // LIKE (auto-wraps with %)
   [["name", "like", "Ali"]]
-]; // LIKE %Ali%
+];
 ```
 
 ## route(model, override?)
@@ -100,14 +140,14 @@ Generates Express Router with 9 endpoints:
 | Method | Path   | Action                           |
 | ------ | ------ | -------------------------------- |
 | GET    | `/:pk` | Get by PK                        |
-| POST   | `/:id` | Insert single                    |
-| PUT    | `/:id` | Update single (PK from URL)      |
-| PATCH  | `/:id` | Partial update                   |
-| DELETE | `/:id` | Delete single                    |
+| POST   | `/add` | Insert single                    |
+| PUT    | `/:pk` | Update single (PK from URL)      |
+| PATCH  | `/:pk` | Partial update (PK from URL)     |
+| DELETE | `/:pk` | Delete single                    |
 | GET    | `/`    | List (page, size, sort, filters) |
 | POST   | `/`    | Bulk insert `{data:[...]}`       |
 | PUT    | `/`    | Bulk update `{data:[...]}`       |
-| DELETE | `/`    | Bulk delete `{data:[...]}`       |
+| DELETE | `/`    | Bulk delete                      |
 
 **Payload override** (multi-tenancy): `route(m, { tenant_id: "user.tenant_id" })` — maps cols to `req` paths via lodash.get.
 
@@ -115,29 +155,128 @@ Generates Express Router with 9 endpoints:
 
 ## CLI Tools
 
-### generate-app (full scaffold)
+### Unified CLI: `db-model-router`
+
+```bash
+db-model-router <command> [options]
+db-model-router help <command>     # detailed help for any command
+```
+
+#### `init` — Project Scaffold
+
+Scaffolds a complete ESM-based Express REST API project with Docker support.
+
+```bash
+# Fully non-interactive (LLM-friendly — zero prompts)
+db-model-router init --framework express --database postgres --session redis \
+  --rateLimiting --helmet --logger --yes
+
+# With Loki logging + Grafana
+db-model-router init --database postgres --logger --loki --yes
+
+# With output directory
+db-model-router init --database mysql --output backend --yes
+
+# From schema file
+db-model-router init --from dbmr.schema.json --yes --no-install
+```
+
+| Flag                 | Description                                                                                                 | Default    |
+| -------------------- | ----------------------------------------------------------------------------------------------------------- | ---------- |
+| `--from <path>`      | Read config from schema file                                                                                |            |
+| `--framework <name>` | `express` or `ultimate-express`                                                                             | (prompted) |
+| `--database <name>`  | `mysql`, `mariadb`, `postgres`, `sqlite3`, `mongodb`, `mssql`, `cockroachdb`, `oracle`, `redis`, `dynamodb` | (prompted) |
+| `--db <name>`        | Alias for `--database`                                                                                      |            |
+| `--session <type>`   | `memory`, `redis`, `database`                                                                               | (prompted) |
+| `--output <dir>`     | Backend source directory (relative to cwd)                                                                  | (root)     |
+| `--rateLimiting`     | Enable rate limiting                                                                                        | yes        |
+| `--helmet`           | Enable Helmet security headers                                                                              | yes        |
+| `--logger`           | Enable Winston request logger                                                                               | yes        |
+| `--loki`             | Enable Loki transport + Loki/Grafana in docker-compose                                                      | no         |
+
+Generated files (ESM, `"type": "module"`):
+
+```
+app.js                          Express entry point
+.env / .env.example             Environment config (random passwords)
+Dockerfile                      node:alpine production image
+docker-compose.yml              DB + CloudBeaver + optional Loki/Grafana
+.cloudbeaver/data-sources.json  Auto-connects CloudBeaver to DB
+.grafana/datasources.yml        Auto-connects Grafana to Loki (when --loki)
+<output>/commons/db.js          Database init, connect, global.db
+<output>/commons/session.js     Session configuration
+<output>/commons/security.js    Helmet, rate limiting, custom headers
+<output>/commons/migrate.js     Migration runner (importable + standalone)
+<output>/commons/add_migration.js  Migration creator (importable + standalone)
+<output>/middleware/logger.js   Winston logger (+ Loki when LOKI_HOST is set)
+<output>/route/index.js         Central route mounting
+<output>/route/health.js        GET /health with DB connectivity check
+<output>/migrations/            Initial migration files
+```
+
+Docker services (auto-generated in docker-compose.yml):
+
+| Service     | When                        | Port   | Notes                                 |
+| ----------- | --------------------------- | ------ | ------------------------------------- |
+| Database    | Always (except sqlite3)     | Varies | Random password, bind mount `./data/` |
+| Redis       | `session=redis`, DB ≠ redis | 6379   | Session store                         |
+| CloudBeaver | SQL/MongoDB databases       | 8978   | Web DB admin, auto-connected          |
+| Loki        | `--loki`                    | 3100   | Log aggregation                       |
+| Grafana     | `--loki`                    | 3001   | Log visualization                     |
+
+Scripts: `start`, `dev`, `test`, `migrate`, `add_migration`, `docker:build`, `docker:up`, `docker:down`.
+
+**Critical**: `db-model-router` is CJS. Generated ESM code must use: `import dbModelRouter from "db-model-router"; const { init, db } = dbModelRouter;` — NOT named imports.
+
+#### `inspect` — DB Introspection
 
 ```bash
-db-model-router-generate-app --type mysql --env .env [--output ./dir] [--tables users,posts,posts.comments]
+db-model-router inspect --type postgres --env .env [--out schema.json] [--tables t1,t2]
 ```
 
-Creates: `app.js`, `models/`, `routes/`, `middleware/logger.js`, `.env.example`, `.gitignore`, `migrations/`, `sessions/`, `openapi.json`
+| Flag               | Description                             |
+| ------------------ | --------------------------------------- |
+| `--type <adapter>` | Database adapter (required)             |
+| `--env <path>`     | Path to .env file                       |
+| `--out <path>`     | Output file (default: dbmr.schema.json) |
+| `--tables <list>`  | Comma-separated table filter            |
 
-### generate-model (DB introspection → model files)
+#### `generate` — Code Generation
 
 ```bash
-db-model-router-generate-model --type <db> --env .env [--output ./models] [--tables t1,t2] [--schema public]
+db-model-router generate --from dbmr.schema.json [--models] [--routes] [--openapi] [--tests] [--llm-docs]
 ```
 
-Auto-detects: PK, unique indexes, DEFAULT→optional, timestamp cols, soft-delete cols.
+| Flag            | Description                             |
+| --------------- | --------------------------------------- |
+| `--from <path>` | Schema file (default: dbmr.schema.json) |
+| `--models`      | Generate only model files               |
+| `--routes`      | Generate only route files + index       |
+| `--openapi`     | Generate only OpenAPI spec              |
+| `--tests`       | Generate only test files                |
+| `--llm-docs`    | Generate only LLM docs                  |
+
+No flags = generate all. Generated routes/tests use ESM imports.
 
-### generate-route (model files → route files + OpenAPI)
+#### `doctor` — Validation
 
 ```bash
-db-model-router-generate-route --models ./models --output ./routes [--tables posts,posts.comments]
+db-model-router doctor [--from dbmr.schema.json] [--json]
 ```
 
-Dot notation `parent.child` creates nested routes: `parent/:parent_id/child` with FK scoping via `<parent_singular>_id`.
+Checks: schema validation, dependency check, file sync.
+
+#### `diff` — Preview Changes
+
+```bash
+db-model-router diff [--from dbmr.schema.json] [--json]
+```
+
+Shows added/modified/deleted files without writing.
+
+#### Universal Flags (all commands)
+
+`--yes`, `--json`, `--dry-run`, `--no-install`, `--help`
 
 ## Connection Configs
 
@@ -191,12 +330,90 @@ db.connect({ region, endpoint, accessKeyId, secretAccessKey });
 
 ## Rules
 
-1. `init()` before `db.connect()`. Don't destructure `db` before `init()`.
-2. `modelStructure` excludes: PK col, timestamp cols, soft-delete cols.
-3. `update()`/`patch()` require PK in payload. `upsert()` PK is optional.
-4. `findOne()` returns `false` on no match. `byId()` returns `null`.
-5. Bulk ops wrap in `{ data: [...] }`. Single ops use flat object.
-6. Timestamps auto-stripped from payloads. DB handles defaults/triggers.
-7. `safeDelete` makes `remove()` soft-delete; all reads auto-filter deleted rows.
-8. `list()` defaults: page=0, size=30. `sort` array: `["-col"]` for DESC.
-9. CommonJS only (`require`). Use dynamic `import()` for ESM.
+1. `init()` before `db.connect()`. Don't destructure `db` before `init()` — it's a getter.
+2. Generated projects are ESM (`"type": "module"`). The library itself is CJS. Use default import: `import dbModelRouter from "db-model-router"; const { init, db } = dbModelRouter;`
+3. `model structure` excludes: PK col, timestamp cols, soft-delete cols.
+4. `update()`/`patch()` require PK in payload. `upsert()` PK is optional.
+5. `findOne()` returns `false` on no match. `byId()` returns `null`.
+6. Bulk ops wrap in `{ data: [...] }`. Single ops use flat object.
+7. Timestamps auto-stripped from payloads. DB handles defaults/triggers.
+8. `safeDelete` makes `remove()` soft-delete; all reads auto-filter deleted rows.
+9. `list()` defaults: page=0, size=30. `sort` array: `["-col"]` for DESC.
+10. Use the unified `db-model-router` CLI with `dbmr.schema.json` for new projects.
+11. `generate` auto-generates test files alongside routes. Tests use `supertest`.
+12. `global.db` is set by `commons/db.js` — accessible anywhere without imports.
+13. Logger dynamically loads `winston-loki` only when `LOKI_HOST` env var is set.
+14. Docker passwords are randomly generated and shared between `.env` and `docker-compose.yml`.
+
+## Environment Variables by Database
+
+| Database    | Variables                                                              |
+| ----------- | ---------------------------------------------------------------------- |
+| mysql       | `PORT DB_HOST DB_PORT=3306 DB_NAME DB_USER DB_PASS`                    |
+| mariadb     | `PORT DB_HOST DB_PORT=3306 DB_NAME DB_USER DB_PASS`                    |
+| postgres    | `PORT DB_HOST DB_PORT=5432 DB_NAME DB_USER DB_PASS`                    |
+| cockroachdb | `PORT DB_HOST DB_PORT=26257 DB_NAME DB_USER DB_PASS`                   |
+| sqlite3     | `PORT DB_NAME=./data/data.db`                                          |
+| mongodb     | `PORT DB_HOST DB_PORT=27017 DB_NAME DB_USER DB_PASS`                   |
+| mssql       | `PORT DB_HOST DB_PORT=1433 DB_NAME DB_USER DB_PASS`                    |
+| oracle      | `PORT DB_HOST DB_PORT=1521 DB_NAME DB_USER DB_PASS`                    |
+| redis       | `PORT DB_HOST DB_PORT=6379 DB_PASS`                                    |
+| dynamodb    | `PORT AWS_REGION AWS_ENDPOINT AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY` |
+
+When `session=redis` and database ≠ redis: adds `REDIS_HOST REDIS_PORT REDIS_PASS`.
+When `logger=true`: adds `APP_NAME LOG_LEVEL LOKI_HOST` (LOKI_HOST empty unless `--loki`).
+
+## Schema-Driven Workflow
+
+The `db-model-router` command uses `dbmr.schema.json` as the source of truth.
+
+### LLM Workflow (schema-driven)
+
+1. **Inspect** (existing DB): `db-model-router inspect --type postgres --env .env` → writes `dbmr.schema.json`
+2. **Edit** `dbmr.schema.json` — add relationships, tweak columns, set options
+3. **Generate**: `db-model-router generate --from dbmr.schema.json` → models, routes, tests, OpenAPI
+4. **Doctor**: `db-model-router doctor --from dbmr.schema.json` → validate schema + check sync
+5. **Run**: `npm run dev`
+
+### dbmr.schema.json Format
+
+```json
+{
+  "adapter": "postgres",
+  "framework": "express",
+  "options": {
+    "session": "redis",
+    "rateLimiting": true,
+    "helmet": true,
+    "logger": true,
+    "loki": false
+  },
+  "tables": {
+    "users": {
+      "columns": {
+        "user_id": "auto_increment",
+        "name": "required|string",
+        "email": "required|string",
+        "age": "integer",
+        "is_deleted": "boolean",
+        "created_at": "datetime",
+        "updated_at": "datetime"
+      },
+      "pk": "user_id",
+      "unique": ["email"],
+      "softDelete": "is_deleted",
+      "timestamps": { "created_at": "created_at", "modified_at": "updated_at" }
+    }
+  },
+  "relationships": [
+    { "parent": "users", "child": "posts", "foreignKey": "user_id" }
+  ]
+}
+```
+
+Fields per table: `columns` (required, include ALL columns), `pk` (required, convention: `<table>_id`), `unique` (default `[pk]`), `softDelete`, `timestamps`.
+Column rules: `(required|)?(string|integer|numeric|boolean|object|datetime|auto_increment)`.
+
+- `auto_increment` — auto-incrementing PK (SERIAL in Postgres, AUTO_INCREMENT in MySQL/MariaDB)
+- `datetime` — date/time columns (TIMESTAMP, DATETIME, DATE)
+- `required|<type>` — NOT NULL constraint

package/docs/adapters/cockroachdb.md

@@ -46,4 +46,4 @@ CREATE TABLE users (
 );
 ```
 
-[← Back to main docs](../README.md)
+[← Back to main docs](../../README.md)

package/docs/adapters/dynamodb.md

@@ -50,4 +50,4 @@ aws dynamodb create-table \
   --endpoint-url http://localhost:8000
 ```
 
-[← Back to main docs](../README.md)
+[← Back to main docs](../../README.md)

package/docs/adapters/mongodb.md

@@ -53,4 +53,4 @@ const users = model(
 );
 ```
 
-[← Back to main docs](../README.md)
+[← Back to main docs](../../README.md)

package/docs/adapters/mssql.md

@@ -52,4 +52,4 @@ CREATE TABLE users (
 );
 ```
 
-[← Back to main docs](../README.md)
+[← Back to main docs](../../README.md)

package/docs/adapters/oracle.md

@@ -49,4 +49,4 @@ CREATE TABLE users (
 );
 ```
 
-[← Back to main docs](../README.md)
+[← Back to main docs](../../README.md)

package/docs/adapters/postgres.md

@@ -47,4 +47,4 @@ CREATE TABLE users (
 );
 ```
 
-[← Back to main docs](../README.md)
+[← Back to main docs](../../README.md)

package/docs/adapters/redis.md

@@ -50,4 +50,4 @@ const users = model(
 );
 ```
 
-[← Back to main docs](../README.md)
+[← Back to main docs](../../README.md)

package/docs/adapters/sqlite3.md

@@ -40,4 +40,4 @@ CREATE TABLE users (
 );
 ```
 
-[← Back to main docs](../README.md)
+[← Back to main docs](../../README.md)

package/package.json

@@ -1,12 +1,10 @@
 {
   "name": "db-model-router",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "Generative API Creation using mysql2 and express libraries in node js",
   "main": "src/index.js",
   "bin": {
-    "db-model-router-generate-model": "src/cli/generate-model.js",
-    "db-model-router-generate-route": "src/cli/generate-route.js",
-    "db-model-router-generate-app": "src/cli/generate-app.js"
+    "db-model-router": "src/cli/main.js"
   },
   "scripts": {
     "dev": "nodemon src/serve.js",
@@ -21,7 +19,8 @@
     "test:cockroachdb": "dotenv -e env/.env.cockroachdb -- mocha test/adapters/cockroachdb.*.test.js --timeout 15000 --exit",
     "test:mssql": "dotenv -e env/.env.mssql -- mocha test/adapters/mssql.*.test.js --timeout 30000 --exit",
     "test:properties": "mocha test/properties/*.property.test.js --timeout 30000 --exit",
-    "test:all": "mocha test/adapters/*.test.js test/properties/*.property.test.js test/function.test.js --timeout 30000 --exit"
+    "test:all": "mocha test/adapters/*.test.js test/properties/*.property.test.js test/function.test.js --timeout 30000 --exit",
+    "clean:demo": "rm -rf demo/* demo/.*"
   },
   "repository": {
     "type": "git",
@@ -29,6 +28,13 @@
   },
   "keywords": [
     "mysql2",
+    "sqlite3",
+    "oracledb",
+    "postgres",
+    "pg",
+    "dynamodb",
+    "mongodb",
+    "mssql",
     "express",
     "ultimate-express",
     "generative",
@@ -43,6 +49,7 @@
   "homepage": "https://github.com/AvinashSKaranth/db-model-router#readme",
   "dependencies": {
     "dotenv": "^10.0.0",
+    "inquirer": "^8.2.6",
     "lodash": "^4.17.21",
     "node-input-validator": "^4.5.0"
   },
@@ -95,7 +102,6 @@
     }
   },
   "devDependencies": {
-    "better-sqlite3": "^12.9.0",
     "dotenv-cli": "^11.0.0",
     "express": "^4.21.0",
     "faker": "^5.5.3",

package/src/cli/commands/diff.js

@@ -0,0 +1,114 @@
+"use strict";
+
+const fs = require("fs");
+const path = require("path");
+const { parseSchema } = require("../../schema/schema-parser");
+const { SchemaValidationError } = require("../../schema/schema-validator");
+const { schemaToModelMeta } = require("../../schema/schema-to-meta");
+const { computeDiff } = require("../diff-engine");
+
+/**
+ * Diff command handler for the unified CLI.
+ *
+ * Compares the current generated files against what the schema would produce,
+ * reporting additions, modifications (with line diffs), and deletions.
+ * Does NOT modify any files on disk.
+ *
+ * Supported flags:
+ *   --from      Path to schema file (default: dbmr.schema.json)
+ *   --json      Output JSON result via ctx
+ *
+ * @param {object} args - Parsed key-value args
+ * @param {object} flags - Universal flags: { yes, json, dryRun, noInstall, help }
+ * @param {import('../flags').OutputContext} ctx - Output context
+ */
+async function diff(args, flags, ctx) {
+  const schemaFile = args.from || "dbmr.schema.json";
+  const schemaPath = path.resolve(schemaFile);
+  const baseDir = process.cwd();
+
+  // --- 1. Read and parse schema ---
+  if (!fs.existsSync(schemaPath)) {
+    const msg = `Schema file not found: ${schemaFile}`;
+    if (flags.json) {
+      ctx.result({ error: true, code: "SCHEMA_NOT_FOUND", message: msg });
+    } else {
+      ctx.log(`Error: ${msg}`);
+    }
+    process.exitCode = 1;
+    return;
+  }
+
+  let schema;
+  try {
+    const raw = fs.readFileSync(schemaPath, "utf8");
+    schema = parseSchema(raw);
+  } catch (err) {
+    const msg = `Schema parse error: ${err.message}`;
+    if (flags.json) {
+      ctx.result({
+        error: true,
+        code: "SCHEMA_VALIDATION",
+        message: msg,
+        errors: err.errors || [],
+      });
+    } else {
+      ctx.log(`Error: ${msg}`);
+    }
+    process.exitCode = 1;
+    return;
+  }
+
+  // --- 2. Compute diff ---
+  const meta = schemaToModelMeta(schema);
+  const relationships = schema.relationships || [];
+  const result = computeDiff(baseDir, meta, relationships);
+
+  // --- 3. Output results ---
+  if (flags.json) {
+    ctx.result({
+      added: result.added,
+      modified: result.modified,
+      deleted: result.deleted,
+    });
+  } else {
+    const total =
+      result.added.length + result.modified.length + result.deleted.length;
+
+    if (total === 0) {
+      ctx.log("All generated files are up to date.");
+      return;
+    }
+
+    if (result.added.length > 0) {
+      ctx.log("Added (new files to create):");
+      for (const f of result.added) {
+        ctx.log(`  + ${f}`);
+      }
+    }
+
+    if (result.modified.length > 0) {
+      ctx.log("Modified (files with changes):");
+      for (const m of result.modified) {
+        ctx.log(`  ~ ${m.file}`);
+        // Display line diffs indented
+        for (const line of m.diff.split("\n")) {
+          if (line) {
+            ctx.log(`    ${line}`);
+          }
+        }
+      }
+    }
+
+    if (result.deleted.length > 0) {
+      ctx.log("Deleted (extra files to remove):");
+      for (const f of result.deleted) {
+        ctx.log(`  - ${f}`);
+      }
+    }
+
+    ctx.log(`\n${total} file(s) differ.`);
+  }
+}
+
+module.exports = diff;