@zenstackhq/cli 3.1.1 → 3.2.0

package/dist/index.js

@@ -12,7 +12,7 @@ var __export = (target, all) => {
 };
 
 // src/index.ts
-import { ZModelLanguageMetaData } from "@zenstackhq/language";
+import { ZModelLanguageMetaData as ZModelLanguageMetaData2 } from "@zenstackhq/language";
 import colors9 from "colors";
 import { Command, CommanderError, Option } from "commander";
 
@@ -271,7 +271,8 @@ async function run3(options) {
 __name(run3, "run");
 
 // src/actions/generate.ts
-import { invariant } from "@zenstackhq/common-helpers";
+import { invariant, singleDebounce } from "@zenstackhq/common-helpers";
+import { ZModelLanguageMetaData } from "@zenstackhq/language";
 import { isPlugin } from "@zenstackhq/language/ast";
 import { getLiteral, getLiteralArray } from "@zenstackhq/language/utils";
 import colors4 from "colors";
@@ -279,6 +280,7 @@ import { createJiti } from "jiti";
 import fs6 from "fs";
 import path4 from "path";
 import { pathToFileURL } from "url";
+import { watch } from "chokidar";
 import ora from "ora";
 
 // src/plugins/index.ts
@@ -346,6 +348,81 @@ var typescript_default = plugin2;
 
 // src/actions/generate.ts
 async function run4(options) {
+  const model = await pureGenerate(options, false);
+  if (options.watch) {
+    const logsEnabled = !options.silent;
+    if (logsEnabled) {
+      console.log(colors4.green(`
+Enabled watch mode!`));
+    }
+    const schemaExtensions = ZModelLanguageMetaData.fileExtensions;
+    const getRootModelWatchPaths = /* @__PURE__ */ __name((model2) => new Set(model2.declarations.filter((v) => v.$cstNode?.parent?.element.$type === "Model" && !!v.$cstNode.parent.element.$document?.uri?.fsPath).map((v) => v.$cstNode.parent.element.$document.uri.fsPath)), "getRootModelWatchPaths");
+    const watchedPaths = getRootModelWatchPaths(model);
+    if (logsEnabled) {
+      const logPaths = [
+        ...watchedPaths
+      ].map((at) => `- ${at}`).join("\n");
+      console.log(`Watched file paths:
+${logPaths}`);
+    }
+    const watcher = watch([
+      ...watchedPaths
+    ], {
+      alwaysStat: false,
+      ignoreInitial: true,
+      ignorePermissionErrors: true,
+      ignored: /* @__PURE__ */ __name((at) => !schemaExtensions.some((ext) => at.endsWith(ext)), "ignored")
+    });
+    const reGenerateSchema = singleDebounce(async () => {
+      if (logsEnabled) {
+        console.log("Got changes, run generation!");
+      }
+      try {
+        const newModel = await pureGenerate(options, true);
+        const allModelsPaths = getRootModelWatchPaths(newModel);
+        const newModelPaths = [
+          ...allModelsPaths
+        ].filter((at) => !watchedPaths.has(at));
+        const removeModelPaths = [
+          ...watchedPaths
+        ].filter((at) => !allModelsPaths.has(at));
+        if (newModelPaths.length) {
+          if (logsEnabled) {
+            const logPaths = newModelPaths.map((at) => `- ${at}`).join("\n");
+            console.log(`Added file(s) to watch:
+${logPaths}`);
+          }
+          newModelPaths.forEach((at) => watchedPaths.add(at));
+          watcher.add(newModelPaths);
+        }
+        if (removeModelPaths.length) {
+          if (logsEnabled) {
+            const logPaths = removeModelPaths.map((at) => `- ${at}`).join("\n");
+            console.log(`Removed file(s) from watch:
+${logPaths}`);
+          }
+          removeModelPaths.forEach((at) => watchedPaths.delete(at));
+          watcher.unwatch(removeModelPaths);
+        }
+      } catch (e) {
+        console.error(e);
+      }
+    }, 500, true);
+    watcher.on("unlink", (pathAt) => {
+      if (logsEnabled) {
+        console.log(`Removed file from watch: ${pathAt}`);
+      }
+      watchedPaths.delete(pathAt);
+      watcher.unwatch(pathAt);
+      reGenerateSchema();
+    });
+    watcher.on("change", () => {
+      reGenerateSchema();
+    });
+  }
+}
+__name(run4, "run");
+async function pureGenerate(options, fromWatch) {
   const start = Date.now();
   const schemaFile = getSchemaFile(options.schema);
   const model = await loadSchemaDocument(schemaFile);
@@ -354,7 +431,8 @@ async function run4(options) {
   if (!options.silent) {
     console.log(colors4.green(`Generation completed successfully in ${Date.now() - start}ms.
 `));
-    console.log(`You can now create a ZenStack client with it.
+    if (!fromWatch) {
+      console.log(`You can now create a ZenStack client with it.
 
 \`\`\`ts
 import { ZenStackClient } from '@zenstackhq/orm';
@@ -366,9 +444,11 @@ const client = new ZenStackClient(schema, {
 \`\`\`
 
 Check documentation: https://zenstack.dev/docs/`);
+    }
   }
+  return model;
 }
-__name(run4, "run");
+__name(pureGenerate, "pureGenerate");
 function getOutputPath(options, schemaFile) {
   if (options.output) {
     return options.output;
@@ -1146,13 +1226,13 @@ var seedAction = /* @__PURE__ */ __name(async (options, args) => {
 }, "seedAction");
 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(", ");
+  const schemaExtensions = ZModelLanguageMetaData2.fileExtensions.join(", ");
   program.description(`${colors9.bold.blue("\u03B6")} ZenStack is the modern data layer for TypeScript apps.
 
 Documentation: https://zenstack.dev/docs`).showHelpAfterError().showSuggestionAfterError();
   const schemaOption = new Option("--schema <file>", `schema file (with extension ${schemaExtensions}). Defaults to "zenstack/schema.zmodel" unless specified in package.json.`);
   const noVersionCheckOption = new Option("--no-version-check", "do not check for new version");
-  program.command("generate").description("Run code generation plugins").addOption(schemaOption).addOption(noVersionCheckOption).addOption(new Option("-o, --output <path>", "default output directory for code generation")).addOption(new Option("--lite", "also generate a lite version of schema without attributes").default(false)).addOption(new Option("--lite-only", "only generate lite version of schema without attributes").default(false)).addOption(new Option("--silent", "suppress all output except errors").default(false)).action(generateAction);
+  program.command("generate").description("Run code generation plugins").addOption(schemaOption).addOption(noVersionCheckOption).addOption(new Option("-o, --output <path>", "default output directory for code generation")).addOption(new Option("-w, --watch", "enable watch mode").default(false)).addOption(new Option("--lite", "also generate a lite version of schema without attributes").default(false)).addOption(new Option("--lite-only", "only generate lite version of schema without attributes").default(false)).addOption(new Option("--silent", "suppress all output except errors").default(false)).action(generateAction);
   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").addOption(schemaOption).addOption(noVersionCheckOption).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").action((options) => migrateAction("dev", options));
@@ -1204,6 +1284,9 @@ async function main() {
       exitCode = 1;
     }
   }
+  if (program.args.includes("generate") && (program.args.includes("-w") || program.args.includes("--watch"))) {
+    return;
+  }
   if (telemetry.isTracking) {
     setTimeout(() => {
       process.exit(exitCode);