chore(cli): show notifications for generate command

Author: jiashengguo

packages/cli/package.json

@@ -37,9 +37,9 @@
     },
     "dependencies": {
         "@zenstackhq/common-helpers": "workspace:*",
-        "@zenstackhq/schema": "workspace:*",
         "@zenstackhq/language": "workspace:*",
         "@zenstackhq/orm": "workspace:*",
+        "@zenstackhq/schema": "workspace:*",
         "@zenstackhq/sdk": "workspace:*",
         "@zenstackhq/server": "workspace:*",
         "chokidar": "^5.0.0",
@@ -56,6 +56,7 @@
         "package-manager-detector": "^1.3.0",
         "prisma": "catalog:",
         "semver": "^7.7.2",
+        "terminal-link": "^5.0.0",
         "ts-pattern": "catalog:"
     },
     "devDependencies": {
@@ -72,9 +73,10 @@
         "tmp": "catalog:"
     },
     "peerDependencies": {
-        "pg": "catalog:",
         "better-sqlite3": "catalog:",
-        "mysql2": "catalog:"
+        "mysql2": "catalog:",
+        "pg": "catalog:",
+        "zod": "catalog:"
     },
     "peerDependenciesMeta": {
         "pg": {

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

@@ -6,6 +6,8 @@ import fs from 'node:fs';
 import { createRequire } from 'node:module';
 import path from 'node:path';
 import { CliError } from '../cli-error';
+import terminalLink from 'terminal-link';
+import { z } from 'zod';
 
 export function getSchemaFile(file?: string) {
     if (file) {
@@ -216,3 +218,40 @@ export async function getZenStackPackages(
 
     return result.filter((p) => !!p);
 }
+
+const FETCH_CLI_CONFIG_TIMEOUT = 500;
+const CLI_CONFIG_ENDPOINT = 'https://zenstack.dev/config/cli.json';
+
+export async function showNotification() {
+    try {
+        const fetchResult = await fetch(CLI_CONFIG_ENDPOINT, {
+            headers: { accept: 'application/json' },
+            signal: AbortSignal.timeout(FETCH_CLI_CONFIG_TIMEOUT),
+        });
+
+        if (!fetchResult.ok) {
+            return;
+        }
+
+        const data = await fetchResult.json();
+        const schema = z.object({
+            notifications: z.array(z.object({ title: z.string(), url: z.url().optional(), active: z.boolean() })),
+        });
+        const parseResult = schema.safeParse(data);
+
+        if (parseResult.success) {
+            const activeItems = parseResult.data.notifications.filter((item) => item.active);
+            // return a random active item
+            if (activeItems.length > 0) {
+                const item = activeItems[Math.floor(Math.random() * activeItems.length)]!;
+                if (item.url) {
+                    console.log(terminalLink(item.title, item.url));
+                } else {
+                    console.log(item.title);
+                }
+            }
+        }
+    } catch {
+        // noop
+    }
+}

packages/cli/src/actions/generate.ts

@@ -14,6 +14,7 @@ import { CliError } from '../cli-error';
 import * as corePlugins from '../plugins';
 import { getOutputPath, getSchemaFile, getZenStackPackages, loadSchemaDocument } from './action-utils';
 import semver from 'semver';
+import { showNotification } from './action-utils';
 
 type Options = {
     schema?: string;
@@ -24,6 +25,7 @@ type Options = {
     liteOnly?: boolean;
     generateModels?: boolean;
     generateInput?: boolean;
+    offline?: boolean;
 };
 
 /**
@@ -37,6 +39,10 @@ export async function run(options: Options) {
     }
     const model = await pureGenerate(options, false);
 
+    if (!options.offline) {
+        await showNotification();
+    }
+
     if (options.watch) {
         const logsEnabled = !options.silent;
 

packages/cli/src/index.ts

@@ -74,12 +74,14 @@ function createProgram() {
     );
 
     const noVersionCheckOption = new Option('--no-version-check', 'do not check for new version');
+    const offlineOption = new Option('--offline', 'run in offline mode');
 
     program
         .command('generate')
         .description('Run code generation plugins')
         .addOption(schemaOption)
         .addOption(noVersionCheckOption)
+        .addOption(offlineOption)
         .addOption(new Option('-o, --output <path>', 'default output directory for code generation'))
         .addOption(new Option('-w, --watch', 'enable watch mode').default(false))
         .addOption(