chore: change "--offline" option to "--no-tips"

Author: ymc9

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

@@ -222,17 +222,17 @@ export async function getZenStackPackages(
 const FETCH_CLI_MAX_TIME = 1000;
 const CLI_CONFIG_ENDPOINT = 'https://zenstack.dev/config/cli-v3.json';
 
-const notificationSchema = z.object({
+const usageTipsSchema = z.object({
     notifications: z.array(z.object({ title: z.string(), url: z.url().optional(), active: z.boolean() })),
 });
 
 /**
- * Starts the notification fetch in the background. Returns a callback that,
- * when invoked check if the fetch is complete. If not complete, it will wait until the max time is reached.
- * After that, if fetch is still not complete, just return.
+ * Starts the usage tips fetch in the background. Returns a callback that, when invoked check if the fetch
+ * is complete. If not complete, it will wait until the max time is reached. After that, if fetch is still
+ * not complete, just return.
  */
-export function startNotificationFetch() {
-    let fetchedData: z.infer<typeof notificationSchema> | undefined = undefined;
+export function startUsageTipsFetch() {
+    let fetchedData: z.infer<typeof usageTipsSchema> | undefined = undefined;
     let fetchComplete = false;
 
     const start = Date.now();
@@ -245,7 +245,7 @@ export function startNotificationFetch() {
         .then(async (res) => {
             if (!res.ok) return;
             const data = await res.json();
-            const parseResult = notificationSchema.safeParse(data);
+            const parseResult = usageTipsSchema.safeParse(data);
             if (parseResult.success) {
                 fetchedData = parseResult.data;
             }

packages/cli/src/actions/generate.ts

@@ -1,20 +1,25 @@
 import { invariant, singleDebounce } from '@zenstackhq/common-helpers';
 import { ZModelLanguageMetaData } from '@zenstackhq/language';
-import { type AbstractDeclaration, isPlugin, LiteralExpr, Plugin, type Model } from '@zenstackhq/language/ast';
+import { isPlugin, LiteralExpr, Plugin, type AbstractDeclaration, type Model } from '@zenstackhq/language/ast';
 import { getLiteral, getLiteralArray } from '@zenstackhq/language/utils';
 import { type CliPlugin } from '@zenstackhq/sdk';
+import { watch } from 'chokidar';
 import colors from 'colors';
 import { createJiti } from 'jiti';
 import fs from 'node:fs';
 import path from 'node:path';
 import { pathToFileURL } from 'node:url';
-import { watch } from 'chokidar';
 import ora, { type Ora } from 'ora';
+import semver from 'semver';
 import { CliError } from '../cli-error';
 import * as corePlugins from '../plugins';
-import { getOutputPath, getSchemaFile, getZenStackPackages, loadSchemaDocument } from './action-utils';
-import semver from 'semver';
-import { startNotificationFetch } from './action-utils';
+import {
+    getOutputPath,
+    getSchemaFile,
+    getZenStackPackages,
+    loadSchemaDocument,
+    startUsageTipsFetch,
+} from './action-utils';
 
 type Options = {
     schema?: string;
@@ -25,7 +30,7 @@ type Options = {
     liteOnly?: boolean;
     generateModels?: boolean;
     generateInput?: boolean;
-    offline?: boolean;
+    tips?: boolean;
 };
 
 /**
@@ -38,12 +43,11 @@ export async function run(options: Options) {
         console.warn(colors.yellow(`Failed to check for mismatched ZenStack packages: ${err}`));
     }
 
-    const maybeShowNotification =
-        !options.offline && !options.silent && !options.watch ? startNotificationFetch() : undefined;
+    const maybeShowUsageTips = options.tips && !options.silent && !options.watch ? startUsageTipsFetch() : undefined;
 
     const model = await pureGenerate(options, false);
 
-    await maybeShowNotification?.();
+    await maybeShowUsageTips?.();
 
     if (options.watch) {
         const logsEnabled = !options.silent;

packages/cli/src/index.ts

@@ -74,14 +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');
+    const noTipsOption = new Option('--no-tips', 'do not show usage tips');
 
     program
         .command('generate')
         .description('Run code generation plugins')
         .addOption(schemaOption)
         .addOption(noVersionCheckOption)
-        .addOption(offlineOption)
+        .addOption(noTipsOption)
         .addOption(new Option('-o, --output <path>', 'default output directory for code generation'))
         .addOption(new Option('-w, --watch', 'enable watch mode').default(false))
         .addOption(