opencode-glm-quota 1.2.0 → 1.3.0

package/README.md

@@ -21,10 +21,21 @@ OpenCode plugin to query Z.ai GLM Coding Plan usage statistics with real-time qu
 ### Option 1: npm (Recommended)
 
 ```bash
-npm install opencode-glm-quota
+# Install the plugin
+npm install @opencode-glm-quota/plugin
+
+# Run the installer to configure OpenCode
+npx @opencode-glm-quota/plugin install
+
+# Add to your OpenCode config (~/.config/opencode/opencode.json)
+echo '"@opencode-glm-quota/plugin"' >> ~/.config/opencode/opencode.json
 ```
 
-OpenCode automatically discovers and loads plugins from npm. No additional configuration required.
+**What the installer does:**
+- Copies `/glm_quota` command to `~/.config/opencode/command/glm_quota.md`
+- Copies skill documentation to `~/.config/opencode/skill/glm-quota-skill.md`
+- Merges agent configuration into `~/.config/opencode/opencode.json`
+- Supports `--force` flag to overwrite existing files
 
 ### Option 2: From GitHub
 
@@ -43,6 +54,9 @@ npm run build
 
 # Link for local testing
 npm link
+
+# Run the installer for local testing
+node bin/install.js
 ```
 
 ## Quick Start
@@ -222,9 +236,14 @@ src/
     date-formatter.ts   # Date/time formatting utilities
     progress-bar.ts     # ASCII progress bar rendering
     time-window.ts      # Rolling window calculation
+integration/
+  command/glm_quota.md          # /glm_quota slash command
+  skill/glm-quota-skill.md      # Skill documentation
+  opencode.jsonc                # Agent configuration (JSONC)
+bin/
+  install.js                     # Installation script
 dist/                   # Compiled JavaScript (generated)
 tests/                  # Test suite
-.opencode/              # OpenCode integration files
 package.json            # Dependencies and scripts
 tsconfig.json           # TypeScript configuration
 ```

package/bin/install.js

@@ -0,0 +1,229 @@
+#!/usr/bin/env node
+
+/**
+ * GLM Quota Plugin Installer
+ *
+ * This script installs the GLM Quota Plugin integration files into the user's
+ * OpenCode configuration directory (~/.config/opencode/).
+ *
+ * Usage:
+ *   node bin/install.js              # Interactive install (ask before overwriting)
+ *   node bin/install.js --force      # Force overwrite existing files
+ */
+
+import * as fs from 'fs'
+import * as path from 'path'
+import * as os from 'os'
+import { parse as parseJsonc } from 'jsonc-parser'
+
+// ==========================================
+// CONSTANTS
+// ==========================================
+
+const __filename = decodeURIComponent(new URL(import.meta.url).pathname)
+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, 'skill', 'glm-quota-skill.md')
+const AGENT_CONFIG = path.join(SOURCE_DIR, 'opencode.jsonc')
+
+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, 'skill', 'glm-quota-skill.md')
+
+// Check which config file exists (opencode.json or opencode.jsonc)
+const TARGET_CONFIG_JSON = path.join(CONFIG_DIR, 'opencode.json')
+const TARGET_CONFIG_JSONC = path.join(CONFIG_DIR, 'opencode.jsonc')
+let TARGET_CONFIG = null
+if (fileExists(TARGET_CONFIG_JSON)) {
+  TARGET_CONFIG = TARGET_CONFIG_JSON
+} else if (fileExists(TARGET_CONFIG_JSONC)) {
+  TARGET_CONFIG = TARGET_CONFIG_JSONC
+} else {
+  // Default to opencode.json if neither exists
+  TARGET_CONFIG = TARGET_CONFIG_JSON
+}
+
+// ==========================================
+// UTILITY FUNCTIONS
+// ==========================================
+
+/**
+ * Ensure directory exists, create if missing
+ */
+function ensureDirectory(dirPath) {
+  if (!fs.existsSync(dirPath)) {
+    fs.mkdirSync(dirPath, { recursive: true })
+  }
+}
+
+/**
+ * Check if file exists
+ */
+function fileExists(filePath) {
+  return fs.existsSync(filePath)
+}
+
+/**
+ * Copy file from source to destination
+ */
+function copyFile(source, destination) {
+  ensureDirectory(path.dirname(destination))
+  fs.copyFileSync(source, destination)
+}
+
+/**
+ * Parse JSON or JSONC file
+ */
+function parseConfig(filePath) {
+  try {
+    const content = fs.readFileSync(filePath, 'utf-8')
+    return parseJsonc(content)
+  } catch (error) {
+    throw new Error(`Failed to parse ${filePath}: ${error instanceof Error ? error.message : String(error)}`)
+  }
+}
+
+/**
+ * Write JSON file
+ */
+function writeConfig(filePath, data) {
+  ensureDirectory(path.dirname(filePath))
+  const json = JSON.stringify(data, null, 2) + '\n'
+  fs.writeFileSync(filePath, json)
+  console.log(`  ✓ Wrote ${filePath} (${json.length} bytes)`)
+}
+
+/**
+ * Deep merge objects
+ */
+function deepMerge(target, source) {
+  const result = { ...target }
+
+  for (const key of Object.keys(source)) {
+    if (source[key] instanceof Object && key in result && result[key] instanceof Object) {
+      result[key] = deepMerge(result[key], source[key])
+    } else {
+      result[key] = source[key]
+    }
+  }
+
+  return result
+}
+
+/**
+ * Prompt user for confirmation
+ */
+function promptConfirm(message) {
+  process.stdout.write(`${message} (y/N) `)
+  const response = process.stdin.read()
+  return response?.trim().toLowerCase() === 'y'
+}
+
+// ==========================================
+// INSTALLATION FUNCTIONS
+// ==========================================
+
+/**
+ * Install command file
+ */
+function installCommand(force) {
+  if (fileExists(TARGET_COMMAND) && !force) {
+    if (!promptConfirm(`Command file exists: ${TARGET_COMMAND}\nOverwrite?`)) {
+      console.log(`  ⊘ Skipped ${TARGET_COMMAND}`)
+      return
+    }
+  }
+
+  copyFile(COMMAND_FILE, TARGET_COMMAND)
+  console.log(`  ✓ Created ${TARGET_COMMAND}`)
+}
+
+/**
+ * Install skill file
+ */
+function installSkill(force) {
+  if (fileExists(TARGET_SKILL) && !force) {
+    if (!promptConfirm(`Skill file exists: ${TARGET_SKILL}\nOverwrite?`)) {
+      console.log(`  ⊘ Skipped ${TARGET_SKILL}`)
+      return
+    }
+  }
+
+  copyFile(SKILL_FILE, TARGET_SKILL)
+  console.log(`  ✓ Created ${TARGET_SKILL}`)
+}
+
+/**
+ * Merge agent configuration and add plugin to plugins array
+ */
+function mergeConfig() {
+  // Parse existing config if it exists (same file type will be written)
+  let existingConfig = {}
+  if (fileExists(TARGET_CONFIG)) {
+    existingConfig = parseConfig(TARGET_CONFIG)
+  }
+
+  // Parse new agent config from integration
+  const newConfig = parseConfig(AGENT_CONFIG)
+
+  // Merge agent definitions first
+  const mergedConfig = deepMerge(existingConfig, newConfig)
+
+  // Ensure plugins array exists and add our plugin
+  if (!mergedConfig.plugins) {
+    mergedConfig.plugins = []
+  }
+
+  const PLUGIN_NAME = '@opencode-glm-quota/plugin'
+  const plugins = Array.isArray(mergedConfig.plugins) ? mergedConfig.plugins : []
+
+  // Only add if not already present
+  if (!plugins.includes(PLUGIN_NAME)) {
+    plugins.push(PLUGIN_NAME)
+    mergedConfig.plugins = plugins
+    console.log(`  ✓ Added ${PLUGIN_NAME} to plugins array`)
+  } else {
+    console.log(`  ⊙ Plugin ${PLUGIN_NAME} already in plugins array`)
+  }
+
+  // Write merged config back to the same file (opencode.json or opencode.jsonc)
+  writeConfig(TARGET_CONFIG, mergedConfig)
+  console.log(`  ✓ Merged configuration into ${path.basename(TARGET_CONFIG)}`)
+}
+
+// ==========================================
+// MAIN INSTALLATION FUNCTION
+// ==========================================
+
+/**
+ * Main installer function
+ */
+function main() {
+  try {
+    // Parse command line arguments
+    const args = process.argv.slice(2)
+    const forceFlag = args.includes('--force')
+
+    console.log('✓ Installing GLM Quota Plugin...\n')
+
+    // Install integration files
+    installCommand(forceFlag)
+    installSkill(forceFlag)
+    mergeConfig()
+
+    console.log()
+    console.log('✓ Installation complete!')
+    console.log('✓ Restart OpenCode to use /glm_quota command')
+
+  } catch (error) {
+    console.error(`\n✗ Installation failed: ${error instanceof Error ? error.message : String(error)}`)
+    console.error('✗ Check file permissions and try again')
+    process.exit(1)
+  }
+}
+
+// Run installer
+if (import.meta.url === `file://${process.argv[1]}`) {
+  main()
+}

package/integration/command/glm_quota.md

@@ -0,0 +1,5 @@
+---
+description: Execute GLM quota check
+agent: glm-quota-exec
+---
+Execute glm_quota tool.

package/integration/opencode.jsonc

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://opencode.ai/config.json",
+  "agent": {
+    "glm-quota-exec": {
+      "mode": "subagent",
+      "system": "You are a minimal tool executor. Your only purpose is to execute the glm_quota tool when requested. Do not explain, reason, or add any commentary. Simply call the tool and return its output directly.",
+      "provider": "opencode",
+      "options": {
+        "system": "You are a minimal tool executor. Your only purpose is to execute the glm_quota tool when requested. Do not explain, reason, or add any commentary. Simply call the tool and return its output directly.",
+        "provider": "opencode"
+      },
+      "permission": {}
+    }
+  }
+  // Note: This agent definition is merged into user's existing OpenCode config
+  // by the installer script to avoid overwriting their custom configurations
+}

package/integration/skill/glm-quota-skill.md

@@ -0,0 +1,10 @@
+---
+name: glm-quota
+description: Query Z.ai GLM Coding Plan usage statistics including quota limits, model usage, and MCP tool usage
+parameters:
+  - name: detailed
+    type: boolean
+    optional: true
+    description: Show detailed usage breakdown
+---
+Query GLM quota usage including token limits and MCP tool usage.

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "opencode-glm-quota",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "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",
   "types": "dist/index.d.ts",
+  "bin": {
+    "opencode-glm-quota-install": "./bin/install.js"
+  },
   "files": [
     "dist",
+    "integration",
+    "bin",
     "README.md",
     "LICENSE"
   ],
@@ -14,6 +19,7 @@
     "build": "tsc",
     "clean": "rm -rf dist",
     "prepublishOnly": "npm run clean && npm run build",
+    "postinstall": "node bin/install.js",
     "test": "tsx --test $(find tests -name '*.test.ts' -type f)",
     "test:coverage": "c8 --reporter=lcov --reporter=text -- npm test",
     "lint": "eslint src/"
@@ -41,6 +47,9 @@
     "url": "https://github.com/guyinwonder168/opencode-glm-quota/issues"
   },
   "homepage": "https://github.com/guyinwonder168/opencode-glm-quota#readme",
+  "dependencies": {
+    "jsonc-parser": "^3.2.0"
+  },
   "peerDependencies": {
     "@opencode-ai/plugin": ">=0.1.0"
   },
@@ -48,7 +57,7 @@
     "access": "public"
   },
   "devDependencies": {
-    "@opencode-ai/plugin": "latest",
+    "@opencode-ai/plugin": "^1.1.30",
     "@types/node": "^20.0.0",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",