feat: add "create-zenstack" and "init" command

package.json

@@ -1,6 +1,6 @@
 {
     "name": "zenstack-v3",
-    "version": "3.0.0-alpha.1",
+    "version": "3.0.0-alpha.0",
     "description": "ZenStack",
     "packageManager": "[email protected]",
     "scripts": {

packages/cli/package.json

@@ -1,9 +1,9 @@
 {
-    "name": "zenstack",
+    "name": "@zenstackhq/cli",
     "publisher": "zenstack",
-    "displayName": "ZenStack Language Tools",
+    "displayName": "ZenStack CLI",
     "description": "FullStack database toolkit with built-in access control and automatic API generation.",
-    "version": "3.0.0-alpha.1",
+    "version": "3.0.0-alpha.0",
     "type": "module",
     "author": {
         "name": "ZenStack Team"
@@ -28,7 +28,7 @@
         "pack": "pnpm pack"
     },
     "dependencies": {
-        "@types/node": "^18.0.0",
+        "@types/node": "^20.0.0",
         "@zenstackhq/language": "workspace:*",
         "@zenstackhq/runtime": "workspace:*",
         "@zenstackhq/sdk": "workspace:*",
@@ -37,6 +37,7 @@
         "commander": "^8.3.0",
         "langium": "~3.3.0",
         "ora": "^5.4.1",
+        "package-manager-detector": "^1.3.0",
         "tiny-invariant": "^1.3.3",
         "ts-pattern": "^4.3.0"
     },
@@ -45,11 +46,11 @@
         "typescript": "^5.0.0"
     },
     "devDependencies": {
-        "@zenstackhq/testtools": "workspace:*",
         "@types/async-exit-hook": "^2.0.0",
         "@types/better-sqlite3": "^7.6.13",
         "@types/semver": "^7.3.13",
         "@types/tmp": "^0.2.6",
+        "@zenstackhq/testtools": "workspace:*",
         "better-sqlite3": "^11.8.1",
         "tmp": "^0.2.3"
     }

packages/cli/src/actions/action-utils.ts

@@ -33,3 +33,15 @@ export async function loadSchemaDocument(schemaFile: string) {
     }
     return loadResult.model;
 }
+
+export function handleSubProcessError(err: unknown) {
+    if (
+        err instanceof Error &&
+        'status' in err &&
+        typeof err.status === 'number'
+    ) {
+        process.exit(err.status);
+    } else {
+        process.exit(1);
+    }
+}

packages/cli/src/actions/db.ts

@@ -1,8 +1,7 @@
 import path from 'node:path';
 import { execPackage } from '../utils/exec-utils';
-import { getSchemaFile } from './action-utils';
+import { getSchemaFile, handleSubProcessError } from './action-utils';
 import { run as runGenerate } from './generate';
-import { handleSubProcessError } from './common';
 
 type CommonOptions = {
     schema?: string;

packages/cli/src/actions/generate.ts

@@ -40,7 +40,7 @@ export async function run(options: Options) {
 import { ZenStackClient } from '@zenstackhq/runtime';
 import { schema } from '${outputPath}/schema';
 
-const db = new ZenStackClient(schema);
+const client = new ZenStackClient(schema);
 \`\`\`
 `);
     }

packages/cli/src/actions/index.ts

@@ -1,6 +1,7 @@
 import { run as db } from './db';
 import { run as generate } from './generate';
 import { run as info } from './info';
+import { run as init } from './init';
 import { run as migrate } from './migrate';
 
-export { db, generate, info, migrate };
+export { db, generate, info, init, migrate };

packages/cli/src/actions/info.ts

@@ -49,14 +49,14 @@ async function getZenStackPackages(
         return [];
     }
 
-    const packages = [
-        ...Object.keys(pkgJson.dependencies ?? {}).filter((p) =>
-            p.startsWith('@zenstackhq/')
-        ),
-        ...Object.keys(pkgJson.devDependencies ?? {}).filter((p) =>
-            p.startsWith('@zenstackhq/')
-        ),
-    ];
+    const packages = Array.from(
+        new Set(
+            [
+                ...Object.keys(pkgJson.dependencies ?? {}),
+                ...Object.keys(pkgJson.devDependencies ?? {}),
+            ].filter((p) => p.startsWith('@zenstackhq/') || p === 'zenstack')
+        )
+    ).sort();
 
     const result = await Promise.all(
         packages.map(async (pkg) => {

packages/cli/src/actions/init.ts

@@ -0,0 +1,82 @@
+import colors from 'colors';
+import fs from 'node:fs';
+import path from 'node:path';
+import ora from 'ora';
+import { detect, resolveCommand } from 'package-manager-detector';
+import { CliError } from '../cli-error';
+import { execSync } from '../utils/exec-utils';
+import { STARTER_ZMODEL } from './templates';
+
+/**
+ * CLI action for getting information about installed ZenStack packages
+ */
+export async function run(projectPath: string) {
+    const packages = [
+        { name: '@zenstackhq/cli', dev: true },
+        { name: '@zenstackhq/runtime', dev: false },
+    ];
+    let pm = await detect();
+    if (!pm) {
+        pm = { agent: 'npm', name: 'npm' };
+    }
+
+    console.log(colors.gray(`Using package manager: ${pm.agent}`));
+
+    for (const pkg of packages) {
+        const resolved = resolveCommand(pm.agent, 'install', [
+            pkg.name,
+            ...(pkg.dev ? [pm.agent === 'yarn' ? '--dev' : '--save-dev'] : []),
+        ]);
+        if (!resolved) {
+            throw new CliError(
+                `Unable to determine how to install package "${pkg.name}". Please install it manually.`
+            );
+        }
+
+        const spinner = ora(`Installing "${pkg.name}"`).start();
+        try {
+            execSync(`${resolved.command} ${resolved.args.join(' ')}`, {
+                cwd: projectPath,
+            });
+            spinner.succeed();
+        } catch (e) {
+            spinner.fail();
+            throw e;
+        }
+    }
+
+    const generationFolder = 'zenstack';
+
+    if (!fs.existsSync(path.join(projectPath, generationFolder))) {
+        fs.mkdirSync(path.join(projectPath, generationFolder));
+    }
+
+    if (
+        !fs.existsSync(
+            path.join(projectPath, generationFolder, 'schema.zmodel')
+        )
+    ) {
+        fs.writeFileSync(
+            path.join(projectPath, generationFolder, 'schema.zmodel'),
+            STARTER_ZMODEL
+        );
+    } else {
+        console.log(
+            colors.yellow(
+                'Schema file already exists. Skipping generation of sample.'
+            )
+        );
+    }
+
+    console.log(colors.green('ZenStack project initialized successfully!'));
+    console.log(
+        colors.gray(
+            `See "${generationFolder}/schema.zmodel" for your database schema.`
+        )
+    );
+    console.log(
+        colors.gray(
+            'Run `zenstack generate` to compile the the schema into a TypeScript file.'
+        )
+    );
+}

packages/cli/src/actions/templates.ts

@@ -0,0 +1,52 @@
+export const STARTER_ZMODEL = `// This is a sample model to get you started.
+
+/// A sample data source using local sqlite db.
+datasource db {
+    provider = 'sqlite'
+    url = 'file:./dev.db'
+}
+
+/// User model
+model User {
+    id       String @id @default(cuid())
+    email    String @unique @email @length(6, 32)
+    posts    Post[]
+}
+
+/// Post model
+model Post {
+    id        String   @id @default(cuid())
+    createdAt DateTime @default(now())
+    updatedAt DateTime @updatedAt
+    title     String   @length(1, 256)
+    content   String
+    published Boolean  @default(false)
+    author    User     @relation(fields: [authorId], references: [id])
+    authorId  String
+}
+`;
+
+export const STARTER_MAIN_TS = `import { ZenStackClient } from '@zenstackhq/runtime';
+import { schema } from './zenstack/schema';
+
+async function main() {
+    const client = new ZenStackClient(schema);
+    const user = await client.user.create({
+        data: {
+            email: '[email protected]',
+            posts: {
+                create: [
+                    {
+                        title: 'Hello World',
+                        content: 'This is a test post',
+                    },
+                ],
+            },
+        },
+        include: { posts: true }
+    });
+    console.log('User created:', user);
+}
+
+main();
+`;

packages/cli/src/index.ts

@@ -4,10 +4,6 @@ import { Command, Option } from 'commander';
 import * as actions from './actions';
 import { getVersion } from './utils/version-utils';
 
-const infoAction = async (projectPath: string): Promise<void> => {
-    await actions.info(projectPath);
-};
-
 const generateAction = async (
     options: Parameters<typeof actions.generate>[0]
 ): Promise<void> => {
@@ -22,6 +18,14 @@ const dbAction = async (command: string, options: any): Promise<void> => {
     await actions.db(command, options);
 };
 
+const infoAction = async (projectPath: string): Promise<void> => {
+    await actions.info(projectPath);
+};
+
+const initAction = async (projectPath: string): Promise<void> => {
+    await actions.init(projectPath);
+};
+
 export function createProgram() {
     const program = new Command('zenstack');
 
@@ -43,14 +47,6 @@ export function createProgram() {
         `schema file (with extension ${schemaExtensions}). Defaults to "schema.zmodel" unless specified in package.json.`
     );
 
-    program
-        .command('info')
-        .description(
-            'Get information of installed ZenStack and related packages.'
-        )
-        .argument('[path]', 'project path', '.')
-        .action(infoAction);
-
     program
         .command('generate')
         .description('Run code generation.')
@@ -121,6 +117,20 @@ export function createProgram() {
         )
         .action((options) => dbAction('push', options));
 
+    program
+        .command('info')
+        .description(
+            'Get information of installed ZenStack and related packages.'
+        )
+        .argument('[path]', 'project path', '.')
+        .action(infoAction);
+
+    program
+        .command('init')
+        .description('Initialize an existing project for ZenStack.')
+        .argument('[path]', 'project path', '.')
+        .action(initAction);
+
     return program;
 }
 

packages/create-zenstack/bin/cli

@@ -0,0 +1,3 @@
+#!/usr/bin/env node --no-warnings
+
+import '../dist/index.js';

packages/create-zenstack/package.json

@@ -0,0 +1,42 @@
+{
+    "name": "create-zenstack",
+    "version": "3.0.0-alpha.0",
+    "description": "Create a new ZenStack project",
+    "type": "module",
+    "scripts": {
+        "build": "tsup-node",
+        "watch": "tsup-node --watch",
+        "lint": "eslint src --ext ts",
+        "pack": "pnpm pack"
+    },
+    "keywords": [],
+    "author": "ZenStack Team",
+    "license": "MIT",
+    "files": [
+        "dist"
+    ],
+    "bin": {
+        "create-zenstack": "bin/cli"
+    },
+    "exports": {
+        ".": {
+            "import": {
+                "types": "./dist/index.d.ts",
+                "default": "./dist/index.js"
+            },
+            "require": {
+                "types": "./dist/index.d.cts",
+                "default": "./dist/index.cjs"
+            }
+        }
+    },
+    "dependencies": {
+        "colors": "1.4.0",
+        "commander": "^8.3.0",
+        "ora": "^5.4.1"
+    },
+    "devDependencies": {
+        "@types/colors": "^1.2.4",
+        "@types/node": "^20.0.0"
+    }
+}