@youtyan/code-viewer 0.8.0 → 0.8.1

package/README.md

@@ -37,6 +37,8 @@ Requires Node.js 20 or newer when installed from npm. Development uses
   viewer.
   Local Supabase CLI (`supabase start`) Postgres projects are auto-discovered
   too, without needing a `docker-compose.yml`.
+  Table descriptions appear inside expanded table entries and in the Schema
+  tab header when the database provides them.
 - Read the built-in Help page for getting started, the `.code-viewer/`
   project files, AI annotations, datastores, the agent skill, and
   keybindings.

package/dist/code-viewer.js

@@ -10882,7 +10882,7 @@ function buildExecInvocation(config, sql) {
         "-t",
         "-A",
         "-F",
-        "\t",
+        PG_FIELD_SEPARATOR,
         "-R",
         PG_RECORD_SEPARATOR,
         "-v",
@@ -11226,14 +11226,14 @@ function decodeMysqlBatchField(value) {
   }
   return out;
 }
-function splitTsvLine(line, decodeFields) {
-  const fields = line.split("\t");
+function splitTsvLine(line, decodeFields, fieldSeparator = "\t") {
+  const fields = line.split(fieldSeparator);
   return decodeFields ? fields.map(decodeMysqlBatchField) : fields;
 }
 function stripFinalRecordSeparator(text, recordSeparator) {
   return text.endsWith(recordSeparator) ? text.slice(0, -recordSeparator.length) : text;
 }
-function parseTsvOutput(stdout, hasHeader, recordSeparator) {
+function parseTsvOutput(stdout, hasHeader, recordSeparator, fieldSeparator) {
   const text = recordSeparator ? stripFinalRecordSeparator(stripFinalLineBreak(stdout), recordSeparator) : stripFinalLineBreak(stdout);
   if (text.length === 0)
     return { columns: [], rows: [] };
@@ -11241,11 +11241,11 @@ function parseTsvOutput(stdout, hasHeader, recordSeparator) {
   if (lines.length === 0)
     return { columns: [], rows: [] };
   if (hasHeader) {
-    const columns = splitTsvLine(lines[0], true);
-    const rows2 = lines.slice(1).map((line) => splitTsvLine(line, true));
+    const columns = splitTsvLine(lines[0], true, fieldSeparator);
+    const rows2 = lines.slice(1).map((line) => splitTsvLine(line, true, fieldSeparator));
     return { columns, rows: rows2 };
   }
-  const rows = lines.map((line) => splitTsvLine(line, false));
+  const rows = lines.map((line) => splitTsvLine(line, false, fieldSeparator));
   return { columns: [], rows };
 }
 function isMysqlSpatialType(type) {
@@ -11315,7 +11315,7 @@ function createSqlCliAdapter(config) {
     if (result.code !== 0) {
       throw new Error(result.stderr.trim() || "query failed");
     }
-    return parseTsvOutput(result.stdout, config.kind === "mysql", config.kind === "postgresql" ? PG_RECORD_SEPARATOR : undefined);
+    return parseTsvOutput(result.stdout, config.kind === "mysql", config.kind === "postgresql" ? PG_RECORD_SEPARATOR : undefined, config.kind === "postgresql" ? PG_FIELD_SEPARATOR : undefined);
   }
   function toDbValue(val) {
     if (val === "NULL" || val === "\\N")
@@ -11392,15 +11392,16 @@ function createSqlCliAdapter(config) {
     async getTablesAsync(signal) {
       let sql;
       if (config.kind === "postgresql") {
-        sql = `SELECT table_name, table_type FROM information_schema.tables WHERE table_schema = ${postgresSchemaLiteral()} ORDER BY table_name`;
+        sql = `SELECT t.table_name, t.table_type, COALESCE(obj_description(cls.oid, 'pg_class'), '') FROM information_schema.tables t JOIN pg_namespace n ON n.nspname = t.table_schema JOIN pg_class cls ON cls.relnamespace = n.oid AND cls.relname = t.table_name WHERE t.table_schema = ${postgresSchemaLiteral()} ORDER BY t.table_name`;
       } else {
-        sql = `SELECT table_name, table_type FROM information_schema.tables WHERE table_schema = DATABASE() ORDER BY table_name`;
+        sql = `SELECT table_name, table_type, table_comment FROM information_schema.tables WHERE table_schema = DATABASE() ORDER BY table_name`;
       }
       const result = await execAsync(sql, signal);
       return result.rows.map((row) => ({
         name: row[0],
         type: row[1] === "VIEW" ? "view" : "table",
-        rowCount: null
+        rowCount: null,
+        comment: row[2] || null
       }));
     },
     async getColumnsAsync(table, signal) {
@@ -11413,11 +11414,11 @@ function createSqlCliAdapter(config) {
     },
     async getIndexesAsync(signal) {
       let sql;
-      const INDEX_COL_SEP = "\x1F";
+      const INDEX_COL_SEP = "\x1D";
       if (config.kind === "postgresql") {
-        sql = `SELECT i.relname, t.relname, CASE WHEN ix.indisunique THEN '1' ELSE '0' END, COALESCE(string_agg(a.attname, E'\\x1f' ORDER BY k.ord), '') FROM pg_index ix JOIN pg_class i ON i.oid = ix.indexrelid JOIN pg_class t ON t.oid = ix.indrelid JOIN pg_namespace n ON n.oid = t.relnamespace LEFT JOIN LATERAL unnest(ix.indkey) WITH ORDINALITY AS k(attnum, ord) ON true LEFT JOIN pg_attribute a ON a.attrelid = t.oid AND a.attnum = k.attnum WHERE n.nspname = ${postgresSchemaLiteral()} AND i.relname NOT LIKE 'pg_%' GROUP BY i.relname, t.relname, ix.indisunique ORDER BY t.relname, i.relname`;
+        sql = `SELECT i.relname, t.relname, CASE WHEN ix.indisunique THEN '1' ELSE '0' END, COALESCE(string_agg(a.attname, E'\\x1d' ORDER BY k.ord), '') FROM pg_index ix JOIN pg_class i ON i.oid = ix.indexrelid JOIN pg_class t ON t.oid = ix.indrelid JOIN pg_namespace n ON n.oid = t.relnamespace LEFT JOIN LATERAL unnest(ix.indkey) WITH ORDINALITY AS k(attnum, ord) ON true LEFT JOIN pg_attribute a ON a.attrelid = t.oid AND a.attnum = k.attnum WHERE n.nspname = ${postgresSchemaLiteral()} AND i.relname NOT LIKE 'pg_%' GROUP BY i.relname, t.relname, ix.indisunique ORDER BY t.relname, i.relname`;
       } else {
-        sql = `SELECT index_name, table_name, IF(MAX(non_unique) = 0, '1', '0'), GROUP_CONCAT(column_name ORDER BY seq_in_index SEPARATOR '\x1F') FROM information_schema.statistics WHERE table_schema = DATABASE() GROUP BY index_name, table_name ORDER BY table_name, index_name`;
+        sql = `SELECT index_name, table_name, IF(MAX(non_unique) = 0, '1', '0'), GROUP_CONCAT(column_name ORDER BY seq_in_index SEPARATOR '\x1D') FROM information_schema.statistics WHERE table_schema = DATABASE() GROUP BY index_name, table_name ORDER BY table_name, index_name`;
       }
       const result = await execAsync(sql, signal);
       return result.rows.map((row) => ({
@@ -11818,7 +11819,7 @@ async function listDockerDatabasesAsync(serviceName, kind, env, cwd, signal) {
         return fallback;
       return setDockerDatabasesCache(cacheKey, [], DOCKER_DATABASES_NEGATIVE_TTL_MS, now);
     }
-    const parsed = parseTsvOutput(result.stdout, kind === "mysql", kind === "postgresql" ? PG_RECORD_SEPARATOR : undefined);
+    const parsed = parseTsvOutput(result.stdout, kind === "mysql", kind === "postgresql" ? PG_RECORD_SEPARATOR : undefined, kind === "postgresql" ? PG_FIELD_SEPARATOR : undefined);
     const dbs = parsed.rows.map((r) => r[0]).filter(Boolean);
     const value = dbs.length > 0 ? dbs : fallbackDockerDatabases(defaultDb);
     return setDockerDatabasesCache(cacheKey, value, value.length > 0 ? DOCKER_DATABASES_POSITIVE_TTL_MS : DOCKER_DATABASES_NEGATIVE_TTL_MS, now);
@@ -11858,7 +11859,7 @@ async function fetchPostgresSchemasViaContainerAsync(config, cacheKey, now, sign
     if (result.code !== 0) {
       return setDockerSchemasCache(cacheKey, ["public"], DOCKER_DATABASES_NEGATIVE_TTL_MS, now);
     }
-    const parsed = parseTsvOutput(result.stdout, false, PG_RECORD_SEPARATOR);
+    const parsed = parseTsvOutput(result.stdout, false, PG_RECORD_SEPARATOR, PG_FIELD_SEPARATOR);
     const schemas = parsed.rows.map((r) => r[0]).filter(Boolean);
     const value = schemas.length > 0 ? schemas : ["public"];
     return setDockerSchemasCache(cacheKey, value, DOCKER_DATABASES_POSITIVE_TTL_MS, now);
@@ -11916,7 +11917,7 @@ async function openDockerAdapterAsync(serviceName, kind, env, cwd, overrideDatab
     ...kind === "postgresql" && schema ? { schema } : {}
   });
 }
-var createPgPoolImpl = (config) => new pg.Pool(config), createMysqlPoolImpl = (config) => mysql.createPool(config), COLUMNS_TTL_MS = 30000, ROWCOUNT_TTL_MS = 15000, DOCKER_DATABASES_POSITIVE_TTL_MS = 15000, DOCKER_DATABASES_NEGATIVE_TTL_MS = 3000, dockerDatabasesCache, dockerSchemasCache, spawnSyncImpl2, PG_RECORD_SEPARATOR = "\x1E", MYSQL_SPATIAL_TYPES, createDockerAdapter, SUPABASE_LOCAL_DB_USER = "postgres", SUPABASE_LOCAL_DB_PASSWORD = "postgres", SUPABASE_LOCAL_DB_NAME = "postgres";
+var createPgPoolImpl = (config) => new pg.Pool(config), createMysqlPoolImpl = (config) => mysql.createPool(config), COLUMNS_TTL_MS = 30000, ROWCOUNT_TTL_MS = 15000, DOCKER_DATABASES_POSITIVE_TTL_MS = 15000, DOCKER_DATABASES_NEGATIVE_TTL_MS = 3000, dockerDatabasesCache, dockerSchemasCache, spawnSyncImpl2, PG_RECORD_SEPARATOR = "\x1E", PG_FIELD_SEPARATOR = "\x1F", MYSQL_SPATIAL_TYPES, createDockerAdapter, SUPABASE_LOCAL_DB_USER = "postgres", SUPABASE_LOCAL_DB_PASSWORD = "postgres", SUPABASE_LOCAL_DB_NAME = "postgres";
 var init_docker = __esm(() => {
   init_mutate();
   init_sql_snapshot();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@youtyan/code-viewer",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Local browser-based code and git diff viewer",
   "type": "module",
   "bin": {

package/web/app.js

@@ -15998,7 +15998,8 @@ ${frontmatter.yaml}
       header.className = "db-schema-header";
       const headerTitle = document.createElement("span");
       headerTitle.className = "db-schema-header-title";
-      headerTitle.textContent = `Schema: ${table2}`;
+      const tableComment = extra?.tableComment?.trim();
+      headerTitle.textContent = tableComment ? `Schema: ${table2} — ${tableComment}` : `Schema: ${table2}`;
       header.appendChild(headerTitle);
       if (deps.onRefresh) {
         refreshBtn = document.createElement("button");
@@ -19716,7 +19717,7 @@ ${entry.message}` : entry.detail ?? entry.message ?? "";
         container.appendChild(colRow);
       }
     }
-    function toggleExpand(tableName, _node, arrow, children) {
+    function toggleExpand(tableName, _node, arrow, children, columnsHost) {
       const expanded = expandedTables.has(tableName);
       if (expanded) {
         expandedTables.delete(tableName);
@@ -19728,8 +19729,8 @@ ${entry.message}` : entry.detail ?? entry.message ?? "";
         children.hidden = false;
         arrow.classList.add("expanded");
         callbacks.onExpandedTableChange?.(tableName, true);
-        if (children.children.length === 0) {
-          renderColumns(children, tableName);
+        if (columnsHost.children.length === 0) {
+          renderColumns(columnsHost, tableName);
         }
       }
     }
@@ -19805,12 +19806,22 @@ ${entry.message}` : entry.detail ?? entry.message ?? "";
           const children = document.createElement("div");
           children.className = "db-table-children";
           children.hidden = !expandedTables.has(table2.name);
+          const comment2 = columnCommentText(table2.comment);
+          if (comment2) {
+            const tableComment = document.createElement("div");
+            tableComment.className = "db-table-col-comment";
+            tableComment.textContent = comment2;
+            tableComment.title = comment2;
+            children.appendChild(tableComment);
+          }
+          const columnsHost = document.createElement("div");
+          children.appendChild(columnsHost);
           if (expandedTables.has(table2.name)) {
-            renderColumns(children, table2.name);
+            renderColumns(columnsHost, table2.name);
           }
           arrow.addEventListener("click", (e2) => {
             e2.stopPropagation();
-            toggleExpand(table2.name, node, arrow, children);
+            toggleExpand(table2.name, node, arrow, children, columnsHost);
           });
           row.addEventListener("click", () => callbacks.onSelectTable(table2.name));
           row.addEventListener("contextmenu", (e2) => showContextMenu(e2, table2.name));
@@ -21116,7 +21127,9 @@ ${entry.message}` : entry.detail ?? entry.message ?? "";
         if (generation !== loadGeneration || currentDbInfo?.id !== requestDbId || currentTable !== table2) {
           return;
         }
-        schemaView.render(table2, columns, schemaCache?.indexes || []);
+        schemaView.render(table2, columns, schemaCache?.indexes || [], {
+          tableComment: schemaCache?.tables.find((entry) => entry.name === table2)?.comment
+        });
       }
     }
     async function selectTableSchemaOnly(table2, generation = loadGeneration) {
@@ -21132,7 +21145,9 @@ ${entry.message}` : entry.detail ?? entry.message ?? "";
       if (generation !== loadGeneration || currentDbInfo?.id !== requestDbId || currentTable !== table2) {
         return;
       }
-      schemaView.render(table2, columns, schemaCache?.indexes || []);
+      schemaView.render(table2, columns, schemaCache?.indexes || [], {
+        tableComment: schemaCache?.tables.find((entry) => entry.name === table2)?.comment
+      });
     }
     async function fetchColumns(table2) {
       if (schemaCache?.columnsMap?.[table2]) {
@@ -21158,7 +21173,9 @@ ${entry.message}` : entry.detail ?? entry.message ?? "";
       if (!currentDbInfo)
         return;
       const columns = await fetchColumns(table2);
-      schemaView.render(table2, columns, schemaCache?.indexes || []);
+      schemaView.render(table2, columns, schemaCache?.indexes || [], {
+        tableComment: schemaCache?.tables.find((entry) => entry.name === table2)?.comment
+      });
     }
     async function refreshCurrentSchemaView() {
       if (!currentDbInfo || !currentTable)
@@ -21190,7 +21207,9 @@ ${entry.message}` : entry.detail ?? entry.message ?? "";
         if (generation !== loadGeneration || currentDbInfo?.id !== dbId || currentTable !== nextTable) {
           return;
         }
-        schemaView.render(nextTable, columns, schema.indexes || []);
+        schemaView.render(nextTable, columns, schema.indexes || [], {
+          tableComment: schema.tables.find((entry) => entry.name === nextTable)?.comment
+        });
         cb.onStateChange();
       } catch (err) {
         if (generation !== loadGeneration || currentDbInfo?.id !== dbId || isAbortError2(err)) {
@@ -21217,7 +21236,8 @@ ${entry.message}` : entry.detail ?? entry.message ?? "";
         schemaView.render(table2, columns, schemaCache?.indexes || [], {
           foreignKeys: schemaCache?.foreignKeys,
           triggers: data.triggers,
-          ddl: data.sql
+          ddl: data.sql,
+          tableComment: schemaCache?.tables.find((entry) => entry.name === table2)?.comment
         });
       } catch {}
     }
@@ -26130,7 +26150,7 @@ code-viewer annotate add-db --db app.db --tab query \\
                     ],
                     [
                       "Sidebar",
-                      "DB selector, PostgreSQL schema selector, table tree (expand to see columns), filter, Rails FK inference toggle, and icon toolbar for Query / ER / Search / Snapshot tabs."
+                      "DB selector, PostgreSQL schema selector, table tree (expand to see columns and a table description when available), filter, Rails FK inference toggle, and icon toolbar for Query / ER / Search / Snapshot tabs."
                     ],
                     [
                       "Data tab",
@@ -26142,7 +26162,7 @@ code-viewer annotate add-db --db app.db --tab query \\
                     ],
                     [
                       "Schema tab",
-                      "Column definitions, indexes, foreign keys, triggers, and DDL, with an in-tab refresh action for reloading the current table structure."
+                      "Table description when available, column definitions, indexes, foreign keys, triggers, and DDL, with an in-tab refresh action for reloading the current table structure."
                     ],
                     [
                       "Query editor",
@@ -26797,7 +26817,7 @@ code-viewer annotate add-db --db app.db --tab query \\
                     ],
                     [
                       "サイドバー",
-                      "DB 選択、PostgreSQL スキーマセレクター、テーブルツリー（展開でカラム表示）、フィルター、Rails 命名規約による仮想 FK 推測トグル、Query / ER / Search / Snapshot アイコンツールバー。"
+                      "DB 選択、PostgreSQL スキーマセレクター、テーブルツリー（展開でカラムと、あればテーブルコメントを表示）、フィルター、Rails 命名規約による仮想 FK 推測トグル、Query / ER / Search / Snapshot アイコンツールバー。"
                     ],
                     [
                       "Data タブ",
@@ -26809,7 +26829,7 @@ code-viewer annotate add-db --db app.db --tab query \\
                     ],
                     [
                       "Schema タブ",
-                      "カラム定義、インデックス、外部キー、トリガー、DDL。現在の表構造だけを再読み込みするタブ内更新にも対応。"
+                      "テーブルコメント（あれば）、カラム定義、インデックス、外部キー、トリガー、DDL。現在の表構造だけを再読み込みするタブ内更新にも対応。"
                     ],
                     [
                       "クエリエディター",