feat(cli): new "check" command for validating ZModel (#1652)

zenstackhq · Aug 21, 2024 · ca2a4f4 · ca2a4f4
1 parent b863060
commit ca2a4f4
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 2 deletions.
diff --git a/packages/schema/src/cli/actions/check.ts b/packages/schema/src/cli/actions/check.ts
@@ -0,0 +1,14 @@
+import { getDefaultSchemaLocation, loadDocument } from '../cli-util';
+
+type Options = {
+    schema: string;
+};
+
+/**
+ * CLI action for checking schema
+ */
+export async function check(_projectPath: string, options: Options) {
+    const schema = options.schema ?? getDefaultSchemaLocation();
+    await loadDocument(schema);
+    console.log('The schema is valid.');
+}
diff --git a/packages/schema/src/cli/actions/index.ts b/packages/schema/src/cli/actions/index.ts
@@ -1,5 +1,6 @@
+export * from './check';
+export * from './format';
 export * from './generate';
 export * from './info';
 export * from './init';
 export * from './repl';
-export * from './format';
diff --git a/packages/schema/src/cli/cli-util.ts b/packages/schema/src/cli/cli-util.ts
@@ -27,7 +27,7 @@ const CHECK_VERSION_TIMEOUT = 1000;
  * @param services Language services
  * @returns Parsed and validated AST
  */
-export async function loadDocument(fileName: string): Promise<Model> {
+export async function loadDocument(fileName: string, validateOnly = false): Promise<Model> {
     const services = createZModelServices(NodeFileSystem).ZModel;
     const extensions = services.LanguageMetaData.fileExtensions;
     if (!extensions.includes(path.extname(fileName))) {
@@ -93,6 +93,10 @@ export async function loadDocument(fileName: string): Promise<Model> {
 
     const model = document.parseResult.value as Model;
 
+    if (validateOnly) {
+        return model;
+    }
+
     // merge all declarations into the main document
     const imported = mergeImportsDeclarations(langiumDocuments, model);
 

diff --git a/packages/schema/src/cli/index.ts b/packages/schema/src/cli/index.ts
@@ -60,6 +60,16 @@ export const formatAction = async (options: Parameters<typeof actions.format>[1]
     );
 };
 
+export const checkAction = async (options: Parameters<typeof actions.check>[1]): Promise<void> => {
+    await telemetry.trackSpan(
+        'cli:command:start',
+        'cli:command:complete',
+        'cli:command:error',
+        { command: 'check' },
+        () => actions.check(process.cwd(), options)
+    );
+};
+
 export function createProgram() {
     const program = new Command('zenstack');
 
@@ -131,6 +141,12 @@ export function createProgram() {
         .option('--no-prisma-style', 'do not use prisma style')
         .action(formatAction);
 
+    program
+        .command('check')
+        .description('Check a ZenStack schema file for syntax or semantic errors.')
+        .addOption(schemaOption)
+        .action(checkAction);
+
     // make sure config is loaded before actions run
     program.hook('preAction', async (_, actionCommand) => {
         let configFile: string | undefined = actionCommand.opts().config;