@zenstackhq/cli 3.0.0-beta.22 → 3.0.0-beta.24

package/src/actions/migrate.ts

@@ -1,7 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { CliError } from '../cli-error';
-import { execPackage } from '../utils/exec-utils';
+import { execPrisma } from '../utils/exec-utils';
 import { generateTempPrismaSchema, getSchemaFile } from './action-utils';
 
 type CommonOptions = {
@@ -64,69 +64,65 @@ export async function run(command: string, options: CommonOptions) {
     }
 }
 
-async function runDev(prismaSchemaFile: string, options: DevOptions) {
+function runDev(prismaSchemaFile: string, options: DevOptions) {
     try {
         const cmd = [
-            'prisma migrate dev',
+            'migrate dev',
             ` --schema "${prismaSchemaFile}"`,
             ' --skip-generate',
-            options.name ? ` --name ${options.name}` : '',
+            options.name ? ` --name "${options.name}"` : '',
             options.createOnly ? ' --create-only' : '',
         ].join('');
-
-        await execPackage(cmd);
+        execPrisma(cmd);
     } catch (err) {
         handleSubProcessError(err);
     }
 }
 
-async function runReset(prismaSchemaFile: string, options: ResetOptions) {
+function runReset(prismaSchemaFile: string, options: ResetOptions) {
     try {
         const cmd = [
-            'prisma migrate reset',
+            'migrate reset',
             ` --schema "${prismaSchemaFile}"`,
             ' --skip-generate',
             options.force ? ' --force' : '',
         ].join('');
-
-        await execPackage(cmd);
+        execPrisma(cmd);
     } catch (err) {
         handleSubProcessError(err);
     }
 }
 
-async function runDeploy(prismaSchemaFile: string, _options: DeployOptions) {
+function runDeploy(prismaSchemaFile: string, _options: DeployOptions) {
     try {
-        const cmd = ['prisma migrate deploy', ` --schema "${prismaSchemaFile}"`].join('');
-
-        await execPackage(cmd);
+        const cmd = ['migrate deploy', ` --schema "${prismaSchemaFile}"`].join('');
+        execPrisma(cmd);
     } catch (err) {
         handleSubProcessError(err);
     }
 }
 
-async function runStatus(prismaSchemaFile: string, _options: StatusOptions) {
+function runStatus(prismaSchemaFile: string, _options: StatusOptions) {
     try {
-        await execPackage(`prisma migrate status --schema "${prismaSchemaFile}"`);
+        execPrisma(`migrate status --schema "${prismaSchemaFile}"`);
     } catch (err) {
         handleSubProcessError(err);
     }
 }
 
-async function runResolve(prismaSchemaFile: string, options: ResolveOptions) {
+function runResolve(prismaSchemaFile: string, options: ResolveOptions) {
     if (!options.applied && !options.rolledBack) {
         throw new CliError('Either --applied or --rolled-back option must be provided');
     }
 
     try {
         const cmd = [
-            'prisma migrate resolve',
+            'migrate resolve',
             ` --schema "${prismaSchemaFile}"`,
-            options.applied ? ` --applied ${options.applied}` : '',
-            options.rolledBack ? ` --rolled-back ${options.rolledBack}` : '',
+            options.applied ? ` --applied "${options.applied}"` : '',
+            options.rolledBack ? ` --rolled-back "${options.rolledBack}"` : '',
         ].join('');
-
-        await execPackage(cmd);
+        execPrisma(cmd);
     } catch (err) {
         handleSubProcessError(err);
     }

package/src/index.ts

@@ -30,10 +30,15 @@ const checkAction = async (options: Parameters<typeof actions.check>[0]): Promis
     await telemetry.trackCommand('check', () => actions.check(options));
 };
 
-function createProgram() {
-    const program = new Command('zen');
+const formatAction = async (options: Parameters<typeof actions.format>[0]): Promise<void> => {
+    await telemetry.trackCommand('format', () => actions.format(options));
+};
 
-    program.version(getVersion()!, '-v --version', 'display CLI version');
+function createProgram() {
+    const program = new Command('zen')
+        .alias('zenstack')
+        .helpOption('-h, --help', 'Show this help message')
+        .version(getVersion()!, '-v --version', 'Show CLI version');
 
     const schemaExtensions = ZModelLanguageMetaData.fileExtensions.join(', ');
 
@@ -55,7 +60,7 @@ function createProgram() {
 
     program
         .command('generate')
-        .description('Run code generation plugins.')
+        .description('Run code generation plugins')
         .addOption(schemaOption)
         .addOption(noVersionCheckOption)
         .addOption(new Option('-o, --output <path>', 'default output directory for code generation'))
@@ -74,7 +79,7 @@ function createProgram() {
         .addOption(new Option('-n, --name <name>', 'migration name'))
         .addOption(new Option('--create-only', 'only create migration, do not apply'))
         .addOption(migrationsOption)
-        .description('Create a migration from changes in schema and apply it to the database.')
+        .description('Create a migration from changes in schema and apply it to the database')
         .action((options) => migrateAction('dev', options));
 
     migrateCommand
@@ -83,7 +88,7 @@ function createProgram() {
         .addOption(new Option('--force', 'skip the confirmation prompt'))
         .addOption(migrationsOption)
         .addOption(noVersionCheckOption)
-        .description('Reset your database and apply all migrations, all data will be lost.')
+        .description('Reset your database and apply all migrations, all data will be lost')
         .action((options) => migrateAction('reset', options));
 
     migrateCommand
@@ -91,7 +96,7 @@ function createProgram() {
         .addOption(schemaOption)
         .addOption(noVersionCheckOption)
         .addOption(migrationsOption)
-        .description('Deploy your pending migrations to your production/staging database.')
+        .description('Deploy your pending migrations to your production/staging database')
         .action((options) => migrateAction('deploy', options));
 
     migrateCommand
@@ -99,7 +104,7 @@ function createProgram() {
         .addOption(schemaOption)
         .addOption(noVersionCheckOption)
         .addOption(migrationsOption)
-        .description('Check the status of your database migrations.')
+        .description('Check the status of your database migrations')
         .action((options) => migrateAction('status', options));
 
     migrateCommand
@@ -109,14 +114,14 @@ function createProgram() {
         .addOption(migrationsOption)
         .addOption(new Option('--applied <migration>', 'record a specific migration as applied'))
         .addOption(new Option('--rolled-back <migration>', 'record a specific migration as rolled back'))
-        .description('Resolve issues with database migrations in deployment databases.')
+        .description('Resolve issues with database migrations in deployment databases')
         .action((options) => migrateAction('resolve', options));
 
-    const dbCommand = program.command('db').description('Manage your database schema during development.');
+    const dbCommand = program.command('db').description('Manage your database schema during development');
 
     dbCommand
         .command('push')
-        .description('Push the state from your schema to your database.')
+        .description('Push the state from your schema to your database')
         .addOption(schemaOption)
         .addOption(noVersionCheckOption)
         .addOption(new Option('--accept-data-loss', 'ignore data loss warnings'))
@@ -125,25 +130,34 @@ function createProgram() {
 
     program
         .command('info')
-        .description('Get information of installed ZenStack packages.')
+        .description('Get information of installed ZenStack packages')
         .argument('[path]', 'project path', '.')
         .addOption(noVersionCheckOption)
         .action(infoAction);
 
     program
         .command('init')
-        .description('Initialize an existing project for ZenStack.')
+        .description('Initialize an existing project for ZenStack')
         .argument('[path]', 'project path', '.')
         .addOption(noVersionCheckOption)
         .action(initAction);
 
     program
         .command('check')
-        .description('Check a ZModel schema for syntax or semantic errors.')
+        .description('Check a ZModel schema for syntax or semantic errors')
         .addOption(schemaOption)
         .addOption(noVersionCheckOption)
         .action(checkAction);
 
+    program
+        .command('format')
+        .description('Format a ZModel schema file')
+        .addOption(schemaOption)
+        .addOption(noVersionCheckOption)
+        .action(formatAction);
+
+    program.addHelpCommand('help [command]', 'Display help for a command');
+
     program.hook('preAction', async (_thisCommand, actionCommand) => {
         if (actionCommand.getOptionValue('versionCheck') !== false) {
             await checkNewVersion();

package/src/plugins/typescript.ts

@@ -22,7 +22,18 @@ const plugin: CliPlugin = {
         // liteOnly mode
         const liteOnly = pluginOptions['liteOnly'] === true;
 
-        await new TsSchemaGenerator().generate(model, { outDir, lite, liteOnly });
+        // add .js extension when importing
+        const importWithFileExtension = pluginOptions['importWithFileExtension'];
+        if (importWithFileExtension && typeof importWithFileExtension !== 'string') {
+            throw new Error('The "importWithFileExtension" option must be a string if specified.');
+        }
+
+        await new TsSchemaGenerator().generate(model, {
+            outDir,
+            lite,
+            liteOnly,
+            importWithFileExtension: importWithFileExtension as string | undefined,
+        });
     },
 };
 

package/src/utils/exec-utils.ts

@@ -1,4 +1,5 @@
 import { execSync as _exec, type ExecSyncOptions } from 'child_process';
+import { fileURLToPath } from 'url';
 
 /**
  * Utility for executing command synchronously and prints outputs on current console
@@ -24,3 +25,29 @@ export function execPackage(
     const packageManager = process?.versions?.['bun'] ? 'bunx' : 'npx';
     execSync(`${packageManager} ${cmd}`, options);
 }
+
+/**
+ * Utility for running prisma commands
+ */
+export function execPrisma(args: string, options?: Omit<ExecSyncOptions, 'env'> & { env?: Record<string, string> }) {
+    let prismaPath: string | undefined;
+    try {
+        if (typeof import.meta.resolve === 'function') {
+            // esm
+            prismaPath = fileURLToPath(import.meta.resolve('prisma/build/index.js'));
+        } else {
+            // cjs
+            prismaPath = require.resolve('prisma/build/index.js');
+        }
+    } catch {
+        // ignore and fallback
+    }
+
+    if (!prismaPath) {
+        // fallback to npx/bunx execute
+        execPackage(`prisma ${args}`, options);
+        return;
+    }
+
+    execSync(`node ${prismaPath} ${args}`, options);
+}

package/test/format.test.ts

@@ -0,0 +1,33 @@
+import { describe, expect, it } from 'vitest';
+import { createProject, runCli } from './utils';
+import fs from 'node:fs';
+
+const model = `
+model User {
+  id String @id @default(cuid())
+    email String @unique
+}
+`;
+
+describe('CLI format command test', () => {
+    it('should format a valid schema successfully', () => {
+        const workDir = createProject(model);
+        expect(() => runCli('format', workDir)).not.toThrow();
+        const updatedContent = fs.readFileSync(`${workDir}/zenstack/schema.zmodel`, 'utf-8');
+        expect(
+            updatedContent.includes(`model User {
+    id    String @id @default(cuid())
+    email String @unique
+}`),
+        ).toBeTruthy();
+    });
+
+    it('should silently ignore invalid schema', () => {
+        const invalidModel = `
+model User {
+  id String @id @default(cuid())
+`;
+        const workDir = createProject(invalidModel);
+        expect(() => runCli('format', workDir)).not.toThrow();
+    });
+});

package/test/generate.test.ts

@@ -45,6 +45,21 @@ describe('CLI generate command test', () => {
         expect(fs.existsSync(path.join(workDir, 'bar/schema.ts'))).toBe(true);
     });
 
+    it('should respect package.json schema dir config', () => {
+        const workDir = createProject(model);
+        fs.mkdirSync(path.join(workDir, 'foo'));
+        fs.renameSync(path.join(workDir, 'zenstack/schema.zmodel'), path.join(workDir, 'foo/schema.zmodel'));
+        fs.rmdirSync(path.join(workDir, 'zenstack'));
+        const pkgJson = JSON.parse(fs.readFileSync(path.join(workDir, 'package.json'), 'utf8'));
+        pkgJson.zenstack = {
+            schema: './foo',
+            output: './bar',
+        };
+        fs.writeFileSync(path.join(workDir, 'package.json'), JSON.stringify(pkgJson, null, 2));
+        runCli('generate', workDir);
+        expect(fs.existsSync(path.join(workDir, 'bar/schema.ts'))).toBe(true);
+    });
+
     it('should respect lite option', () => {
         const workDir = createProject(model);
         runCli('generate --lite', workDir);

package/test/migrate.test.ts

@@ -9,8 +9,7 @@ model User {
 }
 `;
 
-// skip due to timeout in CI
-describe.skip('CLI migrate commands test', () => {
+describe('CLI migrate commands test', () => {
     it('should generate a database with migrate dev', () => {
         const workDir = createProject(model);
         runCli('migrate dev --name init', workDir);