opencode-glm-quota 1.3.4 → 1.4.1

package/README.md

@@ -3,6 +3,12 @@
 [![npm version](https://img.shields.io/npm/v/opencode-glm-quota.svg)](https://www.npmjs.com/package/opencode-glm-quota)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Build Status](https://github.com/guyinwonder168/opencode-glm-quota/workflows/CI/badge.svg)](https://github.com/guyinwonder168/opencode-glm-quota/actions)
+[![SonarQube Cloud](https://sonarcloud.io/images/project_badges/sonarcloud-light.svg)](https://sonarcloud.io/summary/new_code?id=guyinwonder168_opencode-glm-quota)
+---
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=guyinwonder168_opencode-glm-quota&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=guyinwonder168_opencode-glm-quota)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=guyinwonder168_opencode-glm-quota&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=guyinwonder168_opencode-glm-quota)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=guyinwonder168_opencode-glm-quota&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=guyinwonder168_opencode-glm-quota)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=guyinwonder168_opencode-glm-quota&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=guyinwonder168_opencode-glm-quota)
 
 OpenCode plugin to query Z.ai GLM Coding Plan usage statistics with real-time quota monitoring, model usage tracking, and MCP tool usage.
 
@@ -32,7 +38,7 @@ npx opencode-glm-quota install
 - Copies `/glm_quota` command to `~/.config/opencode/command/glm_quota.md`
 - Copies skill documentation to `~/.config/opencode/skills/glm-quota/SKILL.md`
 - Automatically adds plugin to your OpenCode config
-- Merges agent configuration into `~/.config/opencode/opencode.json`
+- Copies agent to `~/.config/opencode/agents/`
 - Supports `--force` flag to overwrite existing files
 
 ### Uninstall
@@ -49,7 +55,7 @@ npx opencode-glm-quota uninstall --global
 - Removes `/glm_quota` command
 - Deletes `skills/glm-quota/SKILL.md`
 - Removes plugin entry from OpenCode config
-- Removes `glm-quota-exec` agent config
+- Removes agent file and legacy config
 - Runs `npm remove opencode-glm-quota` (or `--global`)
 
 ### Option 2: From GitHub
@@ -252,9 +258,9 @@ src/
     progress-bar.ts     # ASCII progress bar rendering
     time-window.ts      # Rolling window calculation
   integration/
+    agents/glm-quota-exec.md      # Minimal executor agent (Markdown)
     command/glm_quota.md          # /glm_quota slash command
     skills/glm-quota/SKILL.md      # Skill documentation
-    opencode.jsonc                # Agent configuration (JSONC)
   bin/
     install.js                     # Installation script
   dist/                   # Compiled JavaScript (generated)

package/bin/install.js

@@ -27,11 +27,12 @@ const __dirname = path.dirname(__filename)
 const SOURCE_DIR = path.join(__dirname, '..', 'integration')
 const COMMAND_FILE = path.join(SOURCE_DIR, 'command', 'glm_quota.md')
 const SKILL_FILE = path.join(SOURCE_DIR, 'skills', 'glm-quota', 'SKILL.md')
-const AGENT_CONFIG = path.join(SOURCE_DIR, 'opencode.jsonc')
+const AGENT_FILE = path.join(SOURCE_DIR, 'agents', 'glm-quota-exec.md')
 
 const CONFIG_DIR = path.join(os.homedir(), '.config', 'opencode')
 const TARGET_COMMAND = path.join(CONFIG_DIR, 'command', 'glm_quota.md')
 const TARGET_SKILL = path.join(CONFIG_DIR, 'skills', 'glm-quota', 'SKILL.md')
+const TARGET_AGENT = path.join(CONFIG_DIR, 'agents', 'glm-quota-exec.md')
 
 // Check which config file exists (opencode.json or opencode.jsonc)
 const TARGET_CONFIG_JSON = path.join(CONFIG_DIR, 'opencode.json')
@@ -181,25 +182,42 @@ function installSkill(force) {
 }
 
 /**
- * Merge agent configuration and add plugin to plugins array
+ * Install agent file
  */
-function mergeConfig() {
-  // Parse existing config if it exists (same file type will be written)
+function installAgent(force) {
+  if (fileExists(TARGET_AGENT) && !force) {
+    if (!promptConfirm(`Agent file exists: ${TARGET_AGENT}\nOverwrite?`)) {
+      console.log(`  ⊘ Skipped ${TARGET_AGENT}`)
+      return
+    }
+  }
+
+  copyFile(AGENT_FILE, TARGET_AGENT)
+  console.log(`  ✓ Created ${TARGET_AGENT}`)
+}
+
+/**
+ * Update plugin configuration and cleanup old JSON agent
+ */
+function updatePluginConfig() {
+  // Parse existing config if it exists
   let existingConfig = {}
   if (fileExists(TARGET_CONFIG)) {
     existingConfig = parseConfig(TARGET_CONFIG)
-    // REMOVE old 'options' field to prevent verbose agent output
-    if (existingConfig.agent?.['glm-quota-exec']?.options) {
-      delete existingConfig.agent['glm-quota-exec'].options
-    }
   }
 
-  // Parse new agent config from integration
-  const newConfig = parseConfig(AGENT_CONFIG)
-
   const PLUGIN_NAME = 'opencode-glm-quota'
 
-  // Handle both "plugin" array and "agent" section
+  // CLEANUP: Remove old JSON agent config if it exists (migration from v1.3.x)
+  if (existingConfig.agent && existingConfig.agent['glm-quota-exec']) {
+    delete existingConfig.agent['glm-quota-exec']
+    if (Object.keys(existingConfig.agent).length === 0) {
+      delete existingConfig.agent
+    }
+    console.log('  ✓ Removed old JSON agent config (migrated to Markdown)')
+  }
+
+  // Handle both "plugin" array and "plugins" array
   // Check for "plugin" array first (user's config uses this)
   const pluginArrayName = existingConfig.plugin ? 'plugin' : 'plugins'
 
@@ -210,16 +228,6 @@ function mergeConfig() {
 
   const plugins = Array.isArray(existingConfig[pluginArrayName]) ? existingConfig[pluginArrayName] : []
 
-  // REPLACE entire glm-quota-exec agent (not merge, to remove old redundant fields)
-  if (newConfig.agent && newConfig.agent['glm-quota-exec']) {
-    if (!existingConfig.agent) {
-      existingConfig.agent = {}
-    }
-    existingConfig.agent['glm-quota-exec'] = newConfig.agent['glm-quota-exec']
-  } else if (!existingConfig.agent && newConfig.agent) {
-    existingConfig.agent = newConfig.agent
-  }
-
   // Only add if not already present
   if (!plugins.includes(PLUGIN_NAME)) {
     plugins.push(PLUGIN_NAME)
@@ -229,9 +237,9 @@ function mergeConfig() {
     console.log(`  ⊙ Plugin ${PLUGIN_NAME} already in ${pluginArrayName} array`)
   }
 
-  // Write merged config back to same file (opencode.json or opencode.jsonc)
+  // Write config back to same file (opencode.json or opencode.jsonc)
   writeConfig(TARGET_CONFIG, existingConfig)
-  console.log(`  ✓ Merged configuration into ${path.basename(TARGET_CONFIG)}`)
+  console.log(`  ✓ Updated ${path.basename(TARGET_CONFIG)}`)
 }
 
 /**
@@ -303,6 +311,7 @@ function removePackage(globalFlag) {
 function uninstall(globalFlag) {
   removeFile(TARGET_COMMAND, TARGET_COMMAND)
   removeDirectory(path.dirname(TARGET_SKILL), path.dirname(TARGET_SKILL))
+  removeFile(TARGET_AGENT, TARGET_AGENT)
   removeConfig()
   removePackage(globalFlag)
 }
@@ -335,7 +344,8 @@ function main() {
     // Install integration files
     installCommand(forceFlag)
     installSkill(forceFlag)
-    mergeConfig()
+    installAgent(forceFlag)
+    updatePluginConfig()
 
     console.log()
     console.log('✓ Installation complete!')

package/dist/index.js

@@ -25,6 +25,17 @@ const CANDIDATE_PROVIDER_IDS = [
     'zhipu',
     'zhipuai'
 ];
+/**
+ * Box drawing layout constants
+ * Total line width: LEFT_BORDER (1) + LEFT_PAD (2) + CONTENT (56) + RIGHT_PAD (0) + RIGHT_BORDER (1) = 60
+ * Border lines: ╔ + 58 chars + ╗ = 60 total
+ * Content lines: ║ + 2 spaces + 56 content + 2 spaces + ║ = 60 total (formatted by formatBoxLine)
+ */
+const BOX_WIDTH = {
+    CONTENT: 56, // Available content width
+    BORDER_CHARS: 58, // Character count between borders (╔══...══╗)
+    TOTAL: 60 // Total line width including borders
+};
 // ============================================================================
 // CREDENTIAL DISCOVERY
 // ============================================================================
@@ -97,20 +108,33 @@ async function getCredentials() {
 }
 /**
  * Create error message for missing credentials
- * @returns Error message with setup instructions
+ * @returns Error message with setup instructions (box formatted)
  */
 function createCredentialError() {
-    return `❌ Z.ai Credentials Not Found
-
-Please authenticate first:
-
-1. Run '/connect' command in OpenCode TUI
-2. Select "Z.AI Coding Plan" or "Z.AI" (for global)
-3. Or "Zhipu" (for China region)
-
-For development/testing, you can also set environment variables:
-  - ZAI_API_KEY (global platform)
-  - ZHIPU_API_KEY or ZHIPUAI_API_KEY (China platform)`;
+    const header = '❌ Z.ai Credentials Not Found';
+    const instructions = [
+        '',
+        'Please authenticate first:',
+        '',
+        '1. Run /connect command in OpenCode TUI',
+        '2. Select "Z.AI Coding Plan" or "Z.AI"',
+        '3. Or "Zhipu" (for China region)',
+        '',
+        'For dev/testing, set environment:',
+        '- ZAI_API_KEY (global)',
+        '- ZHIPU_API_KEY (China)',
+        ''
+    ];
+    const lines = [];
+    lines.push('╔' + '═'.repeat(BOX_WIDTH.BORDER_CHARS) + '╗');
+    lines.push('║' + ' '.repeat(BOX_WIDTH.BORDER_CHARS) + '║');
+    lines.push(formatBoxLine(header, BOX_WIDTH.CONTENT));
+    lines.push('║' + ' '.repeat(BOX_WIDTH.BORDER_CHARS) + '║');
+    for (const instruction of instructions) {
+        lines.push(formatBoxLine(instruction, BOX_WIDTH.CONTENT));
+    }
+    lines.push('╚' + '═'.repeat(BOX_WIDTH.BORDER_CHARS) + '╝');
+    return lines.join('\n');
 }
 // ============================================================================
 // RESPONSE PROCESSING
@@ -348,16 +372,14 @@ function isFullWidthCodePoint(codePoint) {
  */
 function formatHeader(platformName, startTime, endTime) {
     const lines = [];
-    const LINE_CONTENT = 58;
-    const LINE_INDENT = 56;
-    lines.push('╔' + '═'.repeat(LINE_CONTENT) + '╗');
-    lines.push('║' + ' '.repeat(LINE_CONTENT) + '║');
-    lines.push('║' + ' Z.ai GLM Coding Plan Usage Statistics '.padStart(35).padEnd(LINE_CONTENT) + '║');
-    lines.push('║' + ' '.repeat(LINE_CONTENT) + '║');
-    lines.push('╠' + '═'.repeat(LINE_CONTENT) + '╣');
-    lines.push(formatBoxLine(`Platform: ${platformName}`, LINE_INDENT));
-    lines.push(formatBoxLine(`Period:   ${startTime} → ${endTime}`, LINE_INDENT));
-    lines.push('╠' + '═'.repeat(LINE_CONTENT) + '╣');
+    lines.push('╔' + '═'.repeat(BOX_WIDTH.BORDER_CHARS) + '╗');
+    lines.push('║' + ' '.repeat(BOX_WIDTH.BORDER_CHARS) + '║');
+    lines.push('║' + ' Z.ai GLM Coding Plan Usage Statistics '.padStart(35).padEnd(BOX_WIDTH.BORDER_CHARS) + '║');
+    lines.push('║' + ' '.repeat(BOX_WIDTH.BORDER_CHARS) + '║');
+    lines.push('╠' + '═'.repeat(BOX_WIDTH.BORDER_CHARS) + '╣');
+    lines.push(formatBoxLine(`Platform: ${platformName}`, BOX_WIDTH.CONTENT));
+    lines.push(formatBoxLine(`Period:   ${startTime} → ${endTime}`, BOX_WIDTH.CONTENT));
+    lines.push('╠' + '═'.repeat(BOX_WIDTH.BORDER_CHARS) + '╣');
     return lines;
 }
 /**
@@ -367,32 +389,30 @@ function formatHeader(platformName, startTime, endTime) {
  */
 function formatQuotaLimits(quotaData) {
     const lines = [];
-    const LINE_CONTENT = 58;
-    const LINE_INDENT = 56;
-    lines.push(formatBoxLine('QUOTA LIMITS', LINE_INDENT));
-    lines.push('╟' + '─'.repeat(LINE_CONTENT) + '╢');
+    lines.push(formatBoxLine('QUOTA LIMITS', BOX_WIDTH.CONTENT));
+    lines.push('╟' + '─'.repeat(BOX_WIDTH.BORDER_CHARS) + '╢');
     const limits = quotaData?.limits;
     if (limits && Array.isArray(limits)) {
         for (const limit of limits) {
             const pct = typeof limit.percentage === 'number' ? limit.percentage : 0;
             const line = formatProgressLine(limit.type || 'Unknown', pct);
-            lines.push(formatProgressBoxLine(line, LINE_INDENT));
+            lines.push(formatProgressBoxLine(line, BOX_WIDTH.CONTENT));
             if (limit.nextResetTime !== undefined) {
                 const resetMsg = formatTimeUntilReset(limit.nextResetTime);
                 if (resetMsg) {
-                    lines.push(formatBoxLine(resetMsg, LINE_INDENT));
+                    lines.push(formatBoxLine(resetMsg, BOX_WIDTH.CONTENT));
                 }
             }
             if (limit.currentValue !== undefined && limit.total !== undefined) {
                 const usageStr = '       Used: ' + limit.currentValue + '/' + limit.total;
-                lines.push(formatBoxLine(usageStr, LINE_INDENT));
+                lines.push(formatBoxLine(usageStr, BOX_WIDTH.CONTENT));
             }
         }
     }
     else {
-        lines.push(formatBoxLine('No quota data available', LINE_INDENT));
+        lines.push(formatBoxLine('No quota data available', BOX_WIDTH.CONTENT));
     }
-    lines.push('╠' + '═'.repeat(LINE_CONTENT) + '╣');
+    lines.push('╠' + '═'.repeat(BOX_WIDTH.BORDER_CHARS) + '╣');
     return lines;
 }
 /**
@@ -406,9 +426,8 @@ function formatQuotaLimits(quotaData) {
  */
 function formatDataSection(title, data, formatter, quotaData, noDataMessage, LINE_INDENT) {
     const lines = [];
-    const LINE_CONTENT = 58;
     lines.push(formatBoxLine(title, LINE_INDENT));
-    lines.push('╟' + '─'.repeat(LINE_CONTENT) + '╢');
+    lines.push('╟' + '─'.repeat(BOX_WIDTH.BORDER_CHARS) + '╢');
     if (data) {
         const formattedLines = formatter(data, quotaData);
         for (const line of formattedLines) {
@@ -418,7 +437,7 @@ function formatDataSection(title, data, formatter, quotaData, noDataMessage, LIN
     else {
         lines.push(formatBoxLine(noDataMessage, LINE_INDENT));
     }
-    lines.push('╠' + '═'.repeat(LINE_CONTENT) + '╣');
+    lines.push('╠' + '═'.repeat(BOX_WIDTH.BORDER_CHARS) + '╣');
     return lines;
 }
 /**
@@ -441,11 +460,10 @@ function formatFooter() {
 function formatOutput(platform, startTime, endTime, quotaData, modelData, toolData) {
     const lines = [];
     const platformName = getPlatformName(platform);
-    const LINE_INDENT = 56;
     lines.push(...formatHeader(platformName, startTime, endTime));
     lines.push(...formatQuotaLimits(quotaData));
-    lines.push(...formatDataSection('MODEL USAGE (24h)', modelData, formatModelUsage, quotaData, 'No model usage data available', LINE_INDENT));
-    lines.push(...formatDataSection('TOOL/MCP USAGE (24h)', toolData, formatToolUsage, quotaData, 'No tool usage data available', LINE_INDENT));
+    lines.push(...formatDataSection('MODEL USAGE (24h)', modelData, formatModelUsage, quotaData, 'No model usage data available', BOX_WIDTH.CONTENT));
+    lines.push(...formatDataSection('TOOL/MCP USAGE (24h)', toolData, formatToolUsage, quotaData, 'No tool usage data available', BOX_WIDTH.CONTENT));
     lines.push(...formatFooter());
     return lines.join('\n');
 }

package/dist/utils/progress-bar.js

@@ -34,7 +34,7 @@ export function formatPercentage(percentage, decimals = 1) {
  * @returns Formatted progress bar line
  */
 export function formatProgressLine(label, percentage) {
-    const bar = createProgressBar(percentage, { width: 11 });
+    const bar = createProgressBar(percentage, { width: 12 });
     const pctStr = formatPercentage(percentage).padStart(6);
     const labelStr = label.slice(0, 20).padEnd(20);
     return `${labelStr}  [${bar}] ${pctStr}`;

package/integration/agents/glm-quota-exec.md

@@ -0,0 +1,20 @@
+---
+description: Minimal executor for GLM quota tool
+mode: subagent
+hidden: true
+permission:
+  edit: deny
+  bash: deny
+---
+
+CRITICAL INSTRUCTION: When the glm_quota tool returns output, you MUST return it EXACTLY as received, character-for-character, with NO modifications.
+
+- Do NOT add introductory text
+- Do NOT summarize
+- Do NOT reformat
+- Do NOT explain anything
+- Do NOT add any commentary
+- Return ONLY the raw string from the tool
+
+Example of WRONG behavior: 'Here is your usage: [summary]'
+Example of CORRECT behavior: [paste entire tool output verbatim]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opencode-glm-quota",
-  "version": "1.3.4",
+  "version": "1.4.1",
   "type": "module",
   "description": "OpenCode plugin to query Z.ai GLM Coding Plan usage statistics including quota limits, model usage, and MCP tool usage",
   "main": "dist/index.js",

package/integration/opencode.jsonc

@@ -1,10 +0,0 @@
-{
-  "$schema": "https://opencode.ai/config.json",
-  "agent": {
-    "glm-quota-exec": {
-      "mode": "subagent",
-      "system": "CRITICAL INSTRUCTION: When the glm_quota tool returns output, you MUST return it EXACTLY as received, character-for-character, with NO modifications.\n\n- Do NOT add introductory text\n- Do NOT summarize\n- Do NOT reformat\n- Do NOT explain anything\n- Do NOT add any commentary\n- Return ONLY the raw string from the tool\n\nExample of WRONG behavior: 'Here is your usage: [summary]'\nExample of CORRECT behavior: [paste entire tool output verbatim]",
-      "permission": {}
-    }
-  }
-}