@prisma-next/cli 0.10.0-dev.22 → 0.10.0-dev.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prisma-next/cli",
-  "version": "0.10.0-dev.22",
+  "version": "0.10.0-dev.23",
   "license": "Apache-2.0",
   "type": "module",
   "sideEffects": false,
@@ -14,15 +14,15 @@
   "dependencies": {
     "@clack/prompts": "^1.3.0",
     "@dagrejs/dagre": "^3.0.0",
-    "@prisma-next/config": "0.10.0-dev.22",
-    "@prisma-next/contract": "0.10.0-dev.22",
-    "@prisma-next/emitter": "0.10.0-dev.22",
-    "@prisma-next/errors": "0.10.0-dev.22",
-    "@prisma-next/framework-components": "0.10.0-dev.22",
-    "@prisma-next/migration-tools": "0.10.0-dev.22",
-    "@prisma-next/psl-printer": "0.10.0-dev.22",
-    "@prisma-next/cli-telemetry": "0.10.0-dev.22",
-    "@prisma-next/utils": "0.10.0-dev.22",
+    "@prisma-next/config": "0.10.0-dev.23",
+    "@prisma-next/contract": "0.10.0-dev.23",
+    "@prisma-next/emitter": "0.10.0-dev.23",
+    "@prisma-next/errors": "0.10.0-dev.23",
+    "@prisma-next/framework-components": "0.10.0-dev.23",
+    "@prisma-next/migration-tools": "0.10.0-dev.23",
+    "@prisma-next/psl-printer": "0.10.0-dev.23",
+    "@prisma-next/cli-telemetry": "0.10.0-dev.23",
+    "@prisma-next/utils": "0.10.0-dev.23",
     "arktype": "^2.2.0",
     "c12": "^3.3.4",
     "ci-info": "^4.3.1",
@@ -39,14 +39,14 @@
     "wrap-ansi": "^10.0.0"
   },
   "devDependencies": {
-    "@prisma-next/sql-contract": "0.10.0-dev.22",
-    "@prisma-next/sql-contract-emitter": "0.10.0-dev.22",
-    "@prisma-next/sql-contract-ts": "0.10.0-dev.22",
-    "@prisma-next/sql-operations": "0.10.0-dev.22",
-    "@prisma-next/sql-runtime": "0.10.0-dev.22",
-    "@prisma-next/test-utils": "0.10.0-dev.22",
-    "@prisma-next/tsconfig": "0.10.0-dev.22",
-    "@prisma-next/tsdown": "0.10.0-dev.22",
+    "@prisma-next/sql-contract": "0.10.0-dev.23",
+    "@prisma-next/sql-contract-emitter": "0.10.0-dev.23",
+    "@prisma-next/sql-contract-ts": "0.10.0-dev.23",
+    "@prisma-next/sql-operations": "0.10.0-dev.23",
+    "@prisma-next/sql-runtime": "0.10.0-dev.23",
+    "@prisma-next/test-utils": "0.10.0-dev.23",
+    "@prisma-next/tsconfig": "0.10.0-dev.23",
+    "@prisma-next/tsdown": "0.10.0-dev.23",
     "@types/node": "24.10.4",
     "tsdown": "0.22.0",
     "typescript": "5.9.3",

package/src/commands/init/detect-package-manager.ts

@@ -56,6 +56,21 @@ export function formatRunCommand(pm: PackageManager, bin: string, args: string):
   return `${pm} ${bin} ${args}`;
 }
 
+export function formatRunScriptCommand(pm: PackageManager, scriptName: string): string {
+  switch (pm) {
+    case 'deno':
+      return `deno task ${scriptName}`;
+    case 'bun':
+      return `bun run ${scriptName}`;
+    case 'pnpm':
+      return `pnpm run ${scriptName}`;
+    case 'yarn':
+      return `yarn run ${scriptName}`;
+    default:
+      return `npm run ${scriptName}`;
+  }
+}
+
 export function formatAddArgs(pm: PackageManager, packages: string[]): string[] {
   if (pm === 'deno') {
     return ['add', ...packages.map((p) => `npm:${p}`)];

package/src/commands/init/init.ts

@@ -59,6 +59,7 @@ import {
 import { configFile, dbFile, starterSchema, targetPackageName } from './templates/code-templates';
 import { envExampleContent, envFileContent, MIN_SERVER_VERSION } from './templates/env';
 import { quickReferenceMd } from './templates/quick-reference';
+import { minimalProjectReadmeMd } from './templates/readme';
 import { defaultTsConfig, mergeTsConfig, TsConfigParseError } from './templates/tsconfig';
 
 interface FileEntry {
@@ -349,6 +350,26 @@ export async function runInit(
     }
   }
 
+  if (existsSync(join(baseDir, 'src/index.ts'))) {
+    if (!existsSync(join(baseDir, 'README.md'))) {
+      const rawName =
+        parsedPackageJson !== null && typeof parsedPackageJson['name'] === 'string'
+          ? parsedPackageJson['name']
+          : basename(baseDir);
+      filesToWrite.push({
+        path: 'README.md',
+        content: minimalProjectReadmeMd(
+          inputs.target,
+          inputs.schemaPath,
+          sanitisePackageName(rawName),
+          pm,
+        ),
+      });
+    } else {
+      warnings.push('README.md already exists; leaving it untouched.');
+    }
+  }
+
   // -----------------------------------------------------------------
   // Write phase — every input has been parsed and every merged file is
   // staged. From here on, failures are only possible at the

package/src/commands/init/templates/readme-mongo.md

@@ -0,0 +1,35 @@
+# {{projectName}}
+
+Generated by `prisma-next init` with the Minimal template.
+
+## First run
+
+1. `{{runDbUp}}` — start the local MongoDB replica set with `mongodb-memory-server`. Data persists in `.mongo-data/` across restarts.
+2. `{{runDev}}` — runs `src/index.ts`, which writes one row and reads it back.
+
+## Available scripts
+
+- `{{runDev}}` — run the Prisma Next sample script
+
+### Database and migrations
+
+- `{{runContractEmit}}` — emit contract artifacts after contract changes
+- `{{runDbUp}}` — start the local MongoDB replica set with `mongodb-memory-server`. Data persists in `.mongo-data/` across restarts.
+- `{{runDbDown}}` — stop the local MongoDB process (data preserved)
+- `{{runDbReset}}` — stop and wipe `.mongo-data/` for a clean slate
+- `{{runMigrationPlan}}` — create a MongoDB migration plan
+- `{{runMigrate}}` — apply the planned MongoDB migration
+- `{{runDbSeed}}` — insert sample users manually
+
+## Prisma Next
+
+Prisma Next setup is scaffolded in:
+
+- `{{contractPath}}`
+- `prisma-next.config.ts`
+- `prisma/db.ts`
+- `src/lib/prisma.ts`
+
+For provider-specific Prisma Next reference docs, see `prisma-next.md`. Prisma Next skills live in the upstream `skills/` directory: https://github.com/prisma/prisma-next/tree/main/skills.
+
+Node-based Prisma Next projects expect Node.js 24 LTS or newer.

package/src/commands/init/templates/readme-postgres.md

@@ -0,0 +1,34 @@
+# {{projectName}}
+
+Generated by `prisma-next init` with the Minimal template.
+
+## First run
+
+1. `{{runDbInit}}` — applies your contract to the database (creates tables, signs the marker).
+2. `{{runDev}}` — runs `src/index.ts`, which writes one row and reads it back.
+
+## Available scripts
+
+- `{{runDev}}` — run the Prisma Next sample script
+
+### Database and migrations
+
+- `{{runContractEmit}}` — emit contract artifacts after contract changes
+- `{{runDbInit}}` — initialize database state manually
+- `{{runDbUpdate}}` — update database state manually
+- `{{runMigrationPlan}}` — create a migration plan
+- `{{runMigrate}}` — apply a planned migration
+- `{{runDbSeed}}` — insert sample users manually (run after `db:init`)
+
+## Prisma Next
+
+Prisma Next setup is scaffolded in:
+
+- `{{contractPath}}`
+- `prisma-next.config.ts`
+- `prisma/db.ts`
+- `src/lib/prisma.ts`
+
+For provider-specific Prisma Next reference docs, see `prisma-next.md`. Prisma Next skills live in the upstream `skills/` directory: https://github.com/prisma/prisma-next/tree/main/skills.
+
+Node-based Prisma Next projects expect Node.js 24 LTS or newer.

package/src/commands/init/templates/readme.ts

@@ -0,0 +1,62 @@
+import { formatRunScriptCommand, type PackageManager } from '../detect-package-manager';
+import type { TargetId } from './code-templates';
+import { renderTemplate } from './render';
+
+const sharedVariables = ['projectName', 'contractPath', 'runDev', 'runContractEmit'] as const;
+
+export const postgresVariables = [
+  ...sharedVariables,
+  'runDbInit',
+  'runDbUpdate',
+  'runMigrationPlan',
+  'runMigrate',
+  'runDbSeed',
+] as const;
+
+export const mongoVariables = [
+  ...sharedVariables,
+  'runDbUp',
+  'runDbDown',
+  'runDbReset',
+  'runMigrationPlan',
+  'runMigrate',
+  'runDbSeed',
+] as const;
+
+type PostgresVars = Record<(typeof postgresVariables)[number], string>;
+type MongoVars = Record<(typeof mongoVariables)[number], string>;
+
+export function minimalProjectReadmeMd(
+  target: TargetId,
+  schemaPath: string,
+  projectName: string,
+  pm: PackageManager,
+): string {
+  const run = (script: string): string => formatRunScriptCommand(pm, script);
+  const shared = {
+    projectName,
+    contractPath: schemaPath,
+    runDev: run('dev'),
+    runContractEmit: run('contract:emit'),
+    runMigrationPlan: run('migration:plan'),
+    runMigrate: run('migrate'),
+    runDbSeed: run('db:seed'),
+  };
+
+  if (target === 'mongo') {
+    const vars: MongoVars = {
+      ...shared,
+      runDbUp: run('db:up'),
+      runDbDown: run('db:down'),
+      runDbReset: run('db:reset'),
+    };
+    return renderTemplate('readme-mongo.md', mongoVariables, vars);
+  }
+
+  const vars: PostgresVars = {
+    ...shared,
+    runDbInit: run('db:init'),
+    runDbUpdate: run('db:update'),
+  };
+  return renderTemplate('readme-postgres.md', postgresVariables, vars);
+}