Merge pull request #188 from zenstackhq/dev

merge dev to main

Author: ymc9

package.json

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

packages/cli/package.json

@@ -3,7 +3,7 @@
     "publisher": "zenstack",
     "displayName": "ZenStack CLI",
     "description": "FullStack database toolkit with built-in access control and automatic API generation.",
-    "version": "3.0.0-alpha.27",
+    "version": "3.0.0-alpha.28",
     "type": "module",
     "author": {
         "name": "ZenStack Team"

packages/cli/src/actions/validate.ts renamed to packages/cli/src/actions/check.ts

@@ -6,7 +6,7 @@ type Options = {
 };
 
 /**
- * CLI action for validating schema without generation
+ * CLI action for checking a schema's validity.
  */
 export async function run(options: Options) {
     const schemaFile = getSchemaFile(options.schema);

packages/cli/src/actions/generate.ts

@@ -12,7 +12,6 @@ import { getPkgJsonConfig, getSchemaFile, loadSchemaDocument } from './action-ut
 type Options = {
     schema?: string;
     output?: string;
-    silent?: boolean;
 };
 
 /**
@@ -28,9 +27,8 @@ export async function run(options: Options) {
 
     await runPlugins(schemaFile, model, outputPath);
 
-    if (!options.silent) {
-        console.log(colors.green(`Generation completed successfully in ${Date.now() - start}ms.\n`));
-        console.log(`You can now create a ZenStack client with it.
+    console.log(colors.green(`Generation completed successfully in ${Date.now() - start}ms.\n`));
+    console.log(`You can now create a ZenStack client with it.
 
 \`\`\`ts
 import { ZenStackClient } from '@zenstackhq/runtime';
@@ -40,7 +38,6 @@ const client = new ZenStackClient(schema, {
     dialect: { ... }
 });
 \`\`\``);
-    }
 }
 
 function getOutputPath(options: Options, schemaFile: string) {

packages/cli/src/actions/index.ts

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

packages/cli/src/index.ts

@@ -25,8 +25,8 @@ const initAction = async (projectPath: string): Promise<void> => {
     await actions.init(projectPath);
 };
 
-const validateAction = async (options: Parameters<typeof actions.validate>[0]): Promise<void> => {
-    await actions.validate(options);
+const checkAction = async (options: Parameters<typeof actions.check>[0]): Promise<void> => {
+    await actions.check(options);
 };
 
 export function createProgram() {
@@ -40,26 +40,25 @@ export function createProgram() {
         .description(
             `${colors.bold.blue(
                 'ζ',
-            )} ZenStack is a database access toolkit for TypeScript apps.\n\nDocumentation: https://zenstack.dev.`,
+            )} ZenStack is the data layer for modern TypeScript apps.\n\nDocumentation: https://zenstack.dev.`,
         )
         .showHelpAfterError()
         .showSuggestionAfterError();
 
     const schemaOption = new Option(
         '--schema <file>',
-        `schema file (with extension ${schemaExtensions}). Defaults to "schema.zmodel" unless specified in package.json.`,
+        `schema file (with extension ${schemaExtensions}). Defaults to "zenstack/schema.zmodel" unless specified in package.json.`,
     );
 
     program
         .command('generate')
-        .description('Run code generation.')
+        .description('Run code generation plugins.')
         .addOption(schemaOption)
-        .addOption(new Option('--silent', 'do not print any output'))
-        .addOption(new Option('-o, --output <path>', 'default output directory for core plugins'))
+        .addOption(new Option('-o, --output <path>', 'default output directory for code generation'))
         .action(generateAction);
 
-    const migrateCommand = program.command('migrate').description('Update the database schema with migrations.');
-    const migrationsOption = new Option('--migrations <path>', 'path for migrations');
+    const migrateCommand = program.command('migrate').description('Run database schema migration related tasks.');
+    const migrationsOption = new Option('--migrations <path>', 'path that contains the "migrations" directory');
 
     migrateCommand
         .command('dev')
@@ -98,22 +97,22 @@ export 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.');
 
     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(new Option('--accept-data-loss', 'ignore data loss warnings'))
         .addOption(new Option('--force-reset', 'force a reset of the database before push'))
         .action((options) => dbAction('push', options));
 
     program
         .command('info')
-        .description('Get information of installed ZenStack and related packages.')
+        .description('Get information of installed ZenStack packages.')
         .argument('[path]', 'project path', '.')
         .action(infoAction);
 
@@ -123,7 +122,11 @@ export function createProgram() {
         .argument('[path]', 'project path', '.')
         .action(initAction);
 
-    program.command('validate').description('Validate a ZModel schema.').addOption(schemaOption).action(validateAction);
+    program
+        .command('check')
+        .description('Check a ZModel schema for syntax or semantic errors.')
+        .addOption(schemaOption)
+        .action(checkAction);
 
     return program;
 }

packages/cli/test/validate.test.ts renamed to packages/cli/test/check.test.ts

@@ -40,29 +40,29 @@ describe('CLI validate command test', () => {
         const workDir = createProject(validModel);
 
         // Should not throw an error
-        expect(() => runCli('validate', workDir)).not.toThrow();
+        expect(() => runCli('check', workDir)).not.toThrow();
     });
 
     it('should fail validation for invalid schema', () => {
         const workDir = createProject(invalidModel);
 
         // Should throw an error due to validation failure
-        expect(() => runCli('validate', workDir)).toThrow();
+        expect(() => runCli('check', workDir)).toThrow();
     });
 
     it('should respect custom schema location', () => {
         const workDir = createProject(validModel);
         fs.renameSync(path.join(workDir, 'zenstack/schema.zmodel'), path.join(workDir, 'zenstack/custom.zmodel'));
 
         // Should not throw an error when using custom schema path
-        expect(() => runCli('validate --schema ./zenstack/custom.zmodel', workDir)).not.toThrow();
+        expect(() => runCli('check --schema ./zenstack/custom.zmodel', workDir)).not.toThrow();
     });
 
     it('should fail when schema file does not exist', () => {
         const workDir = createProject(validModel);
 
         // Should throw an error when schema file doesn't exist
-        expect(() => runCli('validate --schema ./nonexistent.zmodel', workDir)).toThrow();
+        expect(() => runCli('check --schema ./nonexistent.zmodel', workDir)).toThrow();
     });
 
     it('should respect package.json config', () => {
@@ -78,7 +78,7 @@ describe('CLI validate command test', () => {
         fs.writeFileSync(path.join(workDir, 'package.json'), JSON.stringify(pkgJson, null, 2));
 
         // Should not throw an error when using package.json config
-        expect(() => runCli('validate', workDir)).not.toThrow();
+        expect(() => runCli('check', workDir)).not.toThrow();
     });
 
     it('should validate schema with syntax errors', () => {
@@ -96,6 +96,6 @@ model User {
         const workDir = createProject(modelWithSyntaxError, false);
 
         // Should throw an error due to syntax error
-        expect(() => runCli('validate', workDir)).toThrow();
+        expect(() => runCli('check', workDir)).toThrow();
     });
 });

packages/common-helpers/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/common-helpers",
-    "version": "3.0.0-alpha.27",
+    "version": "3.0.0-alpha.28",
     "description": "ZenStack Common Helpers",
     "type": "module",
     "scripts": {

packages/create-zenstack/package.json

@@ -1,6 +1,6 @@
 {
     "name": "create-zenstack",
-    "version": "3.0.0-alpha.27",
+    "version": "3.0.0-alpha.28",
     "description": "Create a new ZenStack project",
     "type": "module",
     "scripts": {

packages/dialects/sql.js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@zenstackhq/kysely-sql-js",
-    "version": "3.0.0-alpha.27",
+    "version": "3.0.0-alpha.28",
     "description": "Kysely dialect for sql.js",
     "type": "module",
     "scripts": {