feat: rename Console to Studio across the application and update related documentation

hotlong · hotlong · commit d9b08eb2ef4c · 2026-02-07T18:30:41.000+08:00
diff --git a/README.md b/README.md
@@ -148,7 +148,7 @@ os doctor            # Check environment health
 | Package | Description | Status |
 | :--- | :--- | :--- |
 | [`@objectstack/cli`](packages/cli) | CLI: init, dev, serve, studio, compile, validate, generate | 🟢 Active |
-| [`@objectstack/console`](apps/console) | Admin Console UI (Object Explorer, Schema Inspector) | 🟢 Active |
+| [`@objectstack/studio`](apps/studio) | Studio UI (Object Explorer, Schema Inspector) | 🟢 Active |
 | [`@objectstack/docs`](apps/docs) | Documentation site (Fumadocs + Next.js) | 🟢 Active |
 
 ### Examples
diff --git a/apps/studio/CHANGELOG.md b/apps/studio/CHANGELOG.md
@@ -1,4 +1,4 @@
-# @objectstack/console
+# @objectstack/studio
 
 ## 0.9.16
 
diff --git a/apps/studio/README.md b/apps/studio/README.md
@@ -1,10 +1,10 @@
-# ObjectStack Console
+# ObjectStack Studio
 
-The official **ObjectStack Platform Console** - a metadata-driven admin interface for managing data and configuration.
+The official **ObjectStack Studio** - a metadata-driven admin interface for managing data and configuration.
 
 ## 🎯 Overview
 
-ObjectStack Console provides a modern, responsive admin interface that:
+ObjectStack Studio provides a modern, responsive admin interface that:
 
 - **Auto-generates UI** from your metadata definitions
 - **CRUD Operations** with built-in validation
@@ -67,7 +67,7 @@ Copy `.env.example` to `.env.local` to customize:
 ## 📁 Project Structure
 
 ```
-apps/console/
+apps/studio/
 ├── src/
 │   ├── App.tsx              # Main application component
 │   ├── main.tsx             # Entry point with MSW bootstrap
diff --git a/apps/studio/index.html b/apps/studio/index.html
@@ -7,7 +7,7 @@
     <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
     <link href="https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap" rel="stylesheet">
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>ObjectStack Console</title>
+    <title>ObjectStack Studio</title>
   </head>
   <body>
     <div id="root"></div>
diff --git a/apps/studio/package.json b/apps/studio/package.json
@@ -1,13 +1,13 @@
 {
-  "name": "@objectstack/console",
+  "name": "@objectstack/studio",
   "version": "1.1.0",
-  "description": "ObjectStack Platform Console - A metadata-driven admin interface for managing data and configuration",
+  "description": "ObjectStack Studio - A metadata-driven admin interface for managing data and configuration",
   "private": true,
   "type": "module",
   "scripts": {
     "msw:init": "msw init -y public",
     "dev": "pnpm msw:init && vite",
-    "build": "pnpm msw:init && tsc && vite build",
+    "build": "pnpm msw:init && vite build",
     "typecheck": "tsc --noEmit",
     "test": "vitest run",
     "test:bdd": "objectstack test",
diff --git a/apps/studio/vercel.json b/apps/studio/vercel.json
@@ -2,7 +2,7 @@
   "$schema": "https://openapi.vercel.sh/vercel.json",
   "framework": "vite",
   "installCommand": "cd ../.. && pnpm install",
-  "buildCommand": "cd ../.. && pnpm turbo run build --filter=@objectstack/console",
+  "buildCommand": "cd ../.. && pnpm turbo run build --filter=@objectstack/studio",
   "outputDirectory": "dist",
   "build": {
     "env": {
diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
   "scripts": {
     "build": "turbo run build --filter=!@objectstack/docs",
     "dev": "turbo run dev --filter=@example/app-host",
-    "dev:console": "pnpm --filter @objectstack/console dev",
+    "dev:studio": "pnpm --filter @objectstack/studio dev",
     "studio": "pnpm --filter @objectstack/cli build && node packages/cli/bin/objectstack.js studio",
     "test": "turbo run test --filter=@objectstack/spec",
     "clean": "turbo run clean && rm -rf dist",
diff --git a/packages/cli/src/bin.ts b/packages/cli/src/bin.ts
@@ -46,7 +46,7 @@ ${chalk.bold('Workflow:')}
   ${chalk.dim('$')} os generate object task       ${chalk.dim('# Add metadata')}
   ${chalk.dim('$')} os validate                   ${chalk.dim('# Check configuration')}
   ${chalk.dim('$')} os dev                        ${chalk.dim('# Start dev server')}
-  ${chalk.dim('$')} os studio                     ${chalk.dim('# Dev server + Console UI')}
+  ${chalk.dim('$')} os studio                     ${chalk.dim('# Dev server + Studio UI')}
   ${chalk.dim('$')} os compile                    ${chalk.dim('# Build for production')}
 
 ${chalk.dim('Aliases: objectstack | os')}
diff --git a/packages/cli/src/commands/dev.ts b/packages/cli/src/commands/dev.ts
@@ -9,7 +9,7 @@ export const devCommand = new Command('dev')
   .description('Start development mode with hot-reload')
   .argument('[package]', 'Package name or filter pattern', 'all')
   .option('-w, --watch', 'Enable watch mode (default)', true)
-  .option('--ui', 'Enable Console UI at /_studio/')
+  .option('--ui', 'Enable Studio UI at /_studio/')
   .option('-v, --verbose', 'Verbose output')
   .action(async (packageName, options) => {
     printHeader('Development Mode');
diff --git a/packages/cli/src/commands/serve.ts b/packages/cli/src/commands/serve.ts
@@ -16,12 +16,12 @@ import {
 } from '../utils/format.js';
 import {
   STUDIO_PATH,
-  resolveConsolePath,
-  hasConsoleDist,
+  resolveStudioPath,
+  hasStudioDist,
   spawnViteDevServer,
-  createConsoleProxyPlugin,
-  createConsoleStaticPlugin,
-} from '../utils/console.js';
+  createStudioProxyPlugin,
+  createStudioStaticPlugin,
+} from '../utils/studio.js';
 
 // Helper to find available port
 const getAvailablePort = async (startPort: number): Promise<number> => {
@@ -53,7 +53,7 @@ export const serveCommand = new Command('serve')
   .argument('[config]', 'Configuration file path', 'objectstack.config.ts')
   .option('-p, --port <port>', 'Server port', '3000')
   .option('--dev', 'Run in development mode (load devPlugins)')
-  .option('--ui', 'Enable Console UI at /_studio/')
+  .option('--ui', 'Enable Studio UI at /_studio/')
   .option('--no-server', 'Skip starting HTTP server plugin')
   .action(async (configPath, options) => {
     let port = parseInt(options.port);
@@ -228,31 +228,31 @@ export const serveCommand = new Command('serve')
         }
       }
 
-      // ── Console UI (--ui) ───────────────────────────────────────────
+      // ── Studio UI (--ui) ────────────────────────────────────────────
       let viteProcess: import('child_process').ChildProcess | null = null;
 
       if (options.ui) {
-        const consolePath = resolveConsolePath();
-        if (!consolePath) {
-          console.warn(chalk.yellow(`  ⚠ @objectstack/console not found — skipping UI`));
+        const studioPath = resolveStudioPath();
+        if (!studioPath) {
+          console.warn(chalk.yellow(`  ⚠ @objectstack/studio not found — skipping UI`));
         } else if (isDev) {
           // Dev mode → spawn Vite dev server & proxy through Hono
           try {
-            const result = await spawnViteDevServer(consolePath, { serverPort: port });
+            const result = await spawnViteDevServer(studioPath, { serverPort: port });
             viteProcess = result.process;
-            await kernel.use(createConsoleProxyPlugin(result.port));
-            trackPlugin('ConsoleUI');
+            await kernel.use(createStudioProxyPlugin(result.port));
+            trackPlugin('StudioUI');
           } catch (e: any) {
             console.warn(chalk.yellow(`  ⚠ Console UI failed to start: ${e.message}`));
           }
         } else {
           // Production mode → serve pre-built static files
-          const distPath = path.join(consolePath, 'dist');
-          if (hasConsoleDist(consolePath)) {
-            await kernel.use(createConsoleStaticPlugin(distPath));
-            trackPlugin('ConsoleUI');
+          const distPath = path.join(studioPath, 'dist');
+          if (hasStudioDist(studioPath)) {
+            await kernel.use(createStudioStaticPlugin(distPath));
+            trackPlugin('StudioUI');
           } else {
-            console.warn(chalk.yellow(`  ⚠ Console dist not found — run "pnpm --filter @objectstack/console build" first`));
+            console.warn(chalk.yellow(`  ⚠ Studio dist not found — run "pnpm --filter @objectstack/studio build" first`));
           }
         }
       }
diff --git a/packages/cli/src/commands/studio.ts b/packages/cli/src/commands/studio.ts
@@ -4,14 +4,14 @@ import { spawn } from 'child_process';
 import { printHeader, printKV, printStep } from '../utils/format.js';
 
 /**
- * `objectstack studio` — Launch the ObjectStack Console UI.
+ * `objectstack studio` — Launch the ObjectStack Studio UI.
  *
  * Alias for `objectstack serve --dev --ui`.
- * Starts the ObjectStack server in development mode with the Console
+ * Starts the ObjectStack server in development mode with the Studio
  * UI available at http://localhost:<port>/_studio/
  */
 export const studioCommand = new Command('studio')
-  .description('Launch Console UI with development server')
+  .description('Launch Studio UI with development server')
   .argument('[config]', 'Configuration file path', 'objectstack.config.ts')
   .option('-p, --port <port>', 'Server port', '3000')
   .action(async (configPath, options) => {
diff --git a/packages/cli/src/utils/format.ts b/packages/cli/src/utils/format.ts
@@ -188,7 +188,7 @@ export function printServerReady(opts: ServerReadyOptions) {
   console.log('');
   console.log(chalk.cyan('  ➜') + chalk.bold('  API:     ') + chalk.cyan(base + '/'));
   if (opts.uiEnabled && opts.studioPath) {
-    console.log(chalk.cyan('  ➜') + chalk.bold('  Console: ') + chalk.cyan(base + opts.studioPath + '/'));
+    console.log(chalk.cyan('  ➜') + chalk.bold('  Studio:  ') + chalk.cyan(base + opts.studioPath + '/'));
   }
   console.log('');
   console.log(chalk.dim(`  Config:  ${opts.configFile}`));
diff --git a/packages/cli/src/utils/studio.ts b/packages/cli/src/utils/studio.ts
@@ -1,7 +1,7 @@
 /**
- * Console UI Integration Utilities
+ * Studio UI Integration Utilities
  *
- * Handles resolving, spawning, and proxying the @objectstack/console
+ * Handles resolving, spawning, and proxying the @objectstack/studio
  * frontend when the CLI is started with --ui or via the `studio` command.
  */
 import path from 'path';
@@ -21,25 +21,25 @@ const VITE_PORT_START = 24678;
 // ─── Path Resolution ────────────────────────────────────────────────
 
 /**
- * Resolve the filesystem path to the @objectstack/console package.
+ * Resolve the filesystem path to the @objectstack/studio package.
  * Searches workspace locations first, then falls back to node_modules.
  */
-export function resolveConsolePath(): string | null {
+export function resolveStudioPath(): string | null {
   const cwd = process.cwd();
 
   // Workspace candidates (monorepo layouts)
   const candidates = [
-    path.resolve(cwd, 'apps/console'),
-    path.resolve(cwd, '../../apps/console'),
-    path.resolve(cwd, '../apps/console'),
+    path.resolve(cwd, 'apps/studio'),
+    path.resolve(cwd, '../../apps/studio'),
+    path.resolve(cwd, '../apps/studio'),
   ];
 
   for (const candidate of candidates) {
     const pkgPath = path.join(candidate, 'package.json');
     if (fs.existsSync(pkgPath)) {
       try {
         const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
-        if (pkg.name === '@objectstack/console') return candidate;
+        if (pkg.name === '@objectstack/studio') return candidate;
       } catch {
         // Skip invalid package.json
       }
@@ -50,18 +50,18 @@ export function resolveConsolePath(): string | null {
   try {
     const { createRequire } = require('module');
     const req = createRequire(import.meta.url);
-    const resolved = req.resolve('@objectstack/console/package.json');
+    const resolved = req.resolve('@objectstack/studio/package.json');
     return path.dirname(resolved);
   } catch {
     return null;
   }
 }
 
 /**
- * Check whether the Console has a pre-built `dist/` directory.
+ * Check whether the Studio has a pre-built `dist/` directory.
  */
-export function hasConsoleDist(consolePath: string): boolean {
-  return fs.existsSync(path.join(consolePath, 'dist', 'index.html'));
+export function hasStudioDist(studioPath: string): boolean {
+  return fs.existsSync(path.join(studioPath, 'dist', 'index.html'));
 }
 
 // ─── Port Utilities ─────────────────────────────────────────────────
@@ -98,19 +98,19 @@ export interface ViteDevResult {
  * Sets environment variables so the Console runs in server mode and
  * connects to the ObjectStack API on the same origin.
  *
- * @param consolePath - Absolute path to the @objectstack/console package
+ * @param studioPath - Absolute path to the @objectstack/studio package
  * @param options.serverPort - The main ObjectStack server port (for display only)
  */
 export async function spawnViteDevServer(
-  consolePath: string,
+  studioPath: string,
   options: { serverPort?: number } = {},
 ): Promise<ViteDevResult> {
   const vitePort = await findAvailablePort(VITE_PORT_START);
 
-  // Resolve the Vite binary from the Console's own dependencies
+  // Resolve the Vite binary from the Studio's own dependencies
   const viteBinCandidates = [
-    path.join(consolePath, 'node_modules', '.bin', 'vite'),
-    path.join(consolePath, '..', '..', 'node_modules', '.bin', 'vite'),
+    path.join(studioPath, 'node_modules', '.bin', 'vite'),
+    path.join(studioPath, '..', '..', 'node_modules', '.bin', 'vite'),
   ];
 
   let viteBin: string | null = null;
@@ -127,7 +127,7 @@ export async function spawnViteDevServer(
     : ['vite', '--port', String(vitePort), '--strictPort'];
 
   const child = spawn(command, args, {
-    cwd: consolePath,
+    cwd: studioPath,
     env: {
       ...process.env,
       VITE_BASE: `${STUDIO_PATH}/`,
@@ -184,16 +184,16 @@ export async function spawnViteDevServer(
  * Create a lightweight kernel plugin that proxies `/_studio/*` requests
  * to the Vite dev server. Used in development mode.
  */
-export function createConsoleProxyPlugin(vitePort: number) {
+export function createStudioProxyPlugin(vitePort: number) {
   return {
-    name: 'com.objectstack.console-proxy',
+    name: 'com.objectstack.studio-proxy',
 
     init: async () => {},
 
     start: async (ctx: any) => {
       const httpServer = ctx.getService?.('http.server');
       if (!httpServer?.getRawApp) {
-        ctx.logger?.warn?.('Console proxy: http.server service not found — skipping');
+        ctx.logger?.warn?.('Studio proxy: http.server service not found — skipping');
         return;
       }
 
@@ -234,22 +234,22 @@ export function createConsoleProxyPlugin(vitePort: number) {
 }
 
 /**
- * Create a lightweight kernel plugin that serves the pre-built Console
+ * Create a lightweight kernel plugin that serves the pre-built Studio
  * static files at `/_studio/*`. Used in production mode.
  *
  * Uses Node.js built-in fs for static file serving to avoid external
  * bundling dependencies.
  */
-export function createConsoleStaticPlugin(distPath: string) {
+export function createStudioStaticPlugin(distPath: string) {
   return {
-    name: 'com.objectstack.console-static',
+    name: 'com.objectstack.studio-static',
 
     init: async () => {},
 
     start: async (ctx: any) => {
       const httpServer = ctx.getService?.('http.server');
       if (!httpServer?.getRawApp) {
-        ctx.logger?.warn?.('Console static: http.server service not found — skipping');
+        ctx.logger?.warn?.('Studio static: http.server service not found — skipping');
         return;
       }
 
@@ -258,7 +258,7 @@ export function createConsoleStaticPlugin(distPath: string) {
 
       const indexPath = path.join(absoluteDist, 'index.html');
       if (!fs.existsSync(indexPath)) {
-        ctx.logger?.warn?.(`Console static: dist not found at ${absoluteDist}`);
+        ctx.logger?.warn?.(`Studio static: dist not found at ${absoluteDist}`);
         return;
       }
 
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# @objectstack/console`
	`1`	`+# @objectstack/studio`
`2`	`2`
`3`	`3`	`## 0.9.16`
`4`	`4`