thatgfsj-code 0.2.1 → 0.2.2

package/docs/FAQ.md

@@ -1,11 +1,14 @@
 # 常见问题 FAQ
 
+> 贡献者请阅读 [`DEVELOPMENT.md`](../DEVELOPMENT.md)，版本变更见
+> [`CHANGELOG.md`](../CHANGELOG.md)。
+
 ## 目录
 
 1. [安装问题](#1-安装问题)
 2. [配置问题](#2-配置问题)
 3. [使用问题](#3-使用问题)
-4. [ Provider 问题](#4-provider-问题)
+4. [Provider 问题](#4-provider-问题)
 5. [其他问题](#5-其他问题)
 
 ---
@@ -32,9 +35,10 @@
 
 ### Q: 如何配置 API Key？
 
-**A**: 两种方式：
+**A**: 三种方式任选其一：
 1. 交互式配置（推荐）：运行 `gfcode init`
-2. 环境变量：设置对应的环境变量
+2. 环境变量：设置对应的环境变量（详见 [API_KEY_GUIDE.md](./API_KEY_GUIDE.md)）
+3. 手动编辑 `~/.thatgfsj/config.json`
 
 ### Q: 配置文件在哪里？
 
@@ -148,12 +152,30 @@ gfcode --version
 
 ### Q: 如何更新到最新版本？
 
+**A**:
 ```bash
+# 源码安装
 git pull
 npm install
 npm run build
+
+# 全局 npm 包
+npm install -g thatgfsj-code@latest
 ```
 
+### Q: 启动瞬间报 `ReferenceError: require is not defined`？
+
+**A**: 这是 0.2.1 之前的 bug，已经在 **0.2.2** 修复（用 `createRequire(import.meta.url)`）。
+如果你看到这个错，升级到最新版本即可：
+```bash
+npm install -g thatgfsj-code@latest
+```
+
+### Q: REPL 中 Ctrl+C 不能退出？
+
+**A**: 0.2.2 起，空输入连续按两次 Ctrl+C 即可退出。0.2.1 之前该路径只会打
+warning，不会退出；升级版本解决。
+
 ### Q: 遇到其他错误怎么办？
 
 **A**:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "thatgfsj-code",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Thatgfsj Code - Your AI Coding Assistant",
   "main": "dist/index.js",
   "type": "module",
@@ -12,16 +12,48 @@
     "build": "tsc",
     "start": "node dist/index.js",
     "dev": "tsc && node dist/index.js",
-    "link": "npm link"
+    "link": "npm link",
+    "test": "node --test tests/*.test.js",
+    "test:silent": "node --test --test-reporter=dot tests/*.test.js",
+    "prepublishOnly": "npm run test && npm run build"
   },
+  "files": [
+    "dist",
+    "README.md",
+    "DEVELOPMENT.md",
+    "CHANGELOG.md",
+    "LICENSE",
+    "docs",
+    "install.sh",
+    "install.ps1",
+    "install.bat"
+  ],
   "keywords": [
     "ai",
     "cli",
     "coding",
-    "assistant"
+    "assistant",
+    "anthropic",
+    "openai",
+    "siliconflow",
+    "minimax",
+    "kimi",
+    "deepseek",
+    "ollama"
   ],
   "author": "Thatgfsj",
   "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Thatgfsj/thatgfsj-code.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Thatgfsj/thatgfsj-code/issues"
+  },
+  "homepage": "https://github.com/Thatgfsj/thatgfsj-code#readme",
   "dependencies": {
     "chalk": "^5.3.0",
     "commander": "^11.1.0",

package/.patches/0001-fix-repl-replace-readline-with-inquirer-input-for-ke.patch

@@ -1,279 +0,0 @@
-From e51c23c167f946a6db211b0ea0a344502c6c7427 Mon Sep 17 00:00:00 2001
-From: Thatgfsj <thatgfsj@users.noreply.github.com>
-Date: Mon, 6 Jul 2026 02:33:34 +0800
-Subject: [PATCH 1/4] fix(repl): replace readline with @inquirer/input for
- keypad arrow key support
-
-Node readline.createInterface does not emit keypress events for the
-numeric keypad's arrow keys on Windows terminals, so users could not
-move the cursor with the arrows or edit within the input line.
-
-REPLInput now wraps @inquirer/input with prefill='editable', which uses
-raw mode and standard keypress events for both keypad and main-cluster
-arrow keys, plus Home/End/Ctrl+A/Ctrl+E for in-line editing.
----
- src/repl/input.ts | 209 +++++++++++++++++++++-------------------------
- 1 file changed, 94 insertions(+), 115 deletions(-)
-
-diff --git a/src/repl/input.ts b/src/repl/input.ts
-index a30a92a..9fac346 100644
---- a/src/repl/input.ts
-+++ b/src/repl/input.ts
-@@ -1,160 +1,139 @@
- /**
-  * REPL Input Handler
-- * Handles multiline input, history, and Ctrl+C
-+ *
-+ * 基于 @inquirer/input 实现，支持：
-+ *   - 方向键（含数字小键盘方向键）行内移动 / 跳转词首尾
-+ *   - Home / End / Backspace / Delete 行内编辑
-+ *   - Ctrl+A / Ctrl+E 跳到行首/行尾（emacs 风格）
-+ *   - Ctrl+C 中断当前输入（不清空整个会话），连续按两次空输入退出
-+ *   - 命令历史：本地维护 history 数组，通过 default 预填上一条
-+ *
-+ * 不再使用 Node 内置 readline 的 rl.question()——它在 Windows 终端下
-+ * 对小键盘方向键的 ANSI 转义序列不友好，会导致光标无法移动 (Bug #1)。
-  */
- 
--import readline from 'readline';
-+import input from '@inquirer/input';
- import chalk from 'chalk';
- 
-+const MAX_HISTORY = 200;
-+
-+export type PromptResult =
-+  | { kind: 'value'; value: string }       // 用户正常输入并提交（Enter）
-+  | { kind: 'cancelled' };                  // Ctrl+C 中断当前输入
-+
- export class REPLInput {
--  private rl: readline.Interface;
-   private history: string[] = [];
--  private historyIndex: number = -1;
--  private currentInput: string = '';
--  private multilineMode: boolean = false;
--  private multilineBuffer: string[] = [];
--
--  constructor() {
--    this.rl = readline.createInterface({
--      input: process.stdin,
--      output: process.stdout,
--      completer: this.completer.bind(this),
--      historySize: 100,
--      tabSize: 4
--    });
-+  private historyIndex: number = -1;        // -1 表示"未在历史中浏览"
-+  private currentDraft: string = '';        // 离开历史时保留用户原始草稿
-+  private defaultPrefix: string = chalk.green('\n> ');
-+  private consecutiveCancels: number = 0;   // 连续空输入 + Ctrl+C 计数,达到阈值退出
- 
--    // Handle Ctrl+C
--    this.rl.on('SIGINT', () => {
--      if (this.currentInput.length > 0 || this.multilineBuffer.length > 0) {
--        // Clear current input
--        this.currentInput = '';
--        this.multilineBuffer = [];
--        this.multilineMode = false;
--        process.stdout.write('\n');
--        this.rl.prompt();
--      } else {
--        // Exit REPL
--        process.stdout.write(chalk.gray('\n\n👋 Exiting...\n'));
--        process.exit(0);
-+  /**
-+   * Ask the user for input. Returns either a value or 'cancelled'.
-+   * Loop decides what to do with cancellation (usually: continue session,
-+   * unless user has cancelled an already-empty input twice in a row).
-+   */
-+  async prompt(prefix?: string, abortSignal?: AbortSignal): Promise<PromptResult> {
-+    const prefill = this.computePrefill();
-+    const previousDraft = prefill.kind === 'history' ? prefill.value : '';
-+
-+    // 用 abortSignal 绑到 inquirer:外面 Ctrl+C / 主进程事件可以取消
-+    const value = await input({
-+      message: prefix ?? this.defaultPrefix,
-+      prefill: 'editable',                  // 关键:启用方向键 + 行内编辑,包括小键盘
-+      default: previousDraft,               // 历史预填
-+      // Ctrl+C 由 @inquirer/input 抛出一个 symbol-like 错误,我们捕获为 cancelled
-+      validate: () => true,
-+    }, abortSignal ? { signal: abortSignal } : undefined).catch((err: any) => {
-+      // 区分真实错误与用户取消;inquirer 用 ExitPromptError (name: 'ExitPromptError')
-+      if (err && (err.name === 'ExitPromptError' || err.message?.includes('User force closed'))) {
-+        return null;
-       }
-+      throw err;
-     });
- 
--    // Track history navigation
--    this.rl.on('line', (line) => {
--      if (line.trim()) {
--        this.history.push(line);
--        if (this.history.length > 100) {
--          this.history.shift();
--        }
-+    if (value === null || value === undefined) {
-+      this.consecutiveCancels++;
-+      return { kind: 'cancelled' };
-+    }
-+
-+    const trimmed = value.trim();
-+    if (trimmed.length > 0) {
-+      // 避免把连续重复的内容都压入历史
-+      if (this.history[this.history.length - 1] !== trimmed) {
-+        this.history.push(trimmed);
-+        if (this.history.length > MAX_HISTORY) this.history.shift();
-       }
--      this.historyIndex = this.history.length;
--    });
--  }
-+    }
- 
--  /**
--   * Prompt for input
--   */
--  async prompt(prefix: string = chalk.green('\n> ')): Promise<string> {
--    return new Promise((resolve) => {
--      this.rl.question(prefix, (answer) => {
--        resolve(answer);
--      });
--    });
-+    this.consecutiveCancels = 0;
-+    return { kind: 'value', value: trimmed };
-   }
- 
-   /**
--   * Set prompt prefix
-+   * Should we ask the loop to exit? Two consecutive Ctrl+C on empty input => exit.
-    */
--  setPrompt(prefix: string): void {
--    this.rl.setPrompt(prefix);
-+  shouldExitOnCancel(): boolean {
-+    return this.consecutiveCancels >= 2;
-   }
- 
-   /**
--   * Close the interface
-+   * Reset consecutive-cancel counter when the loop has decided to keep running.
-    */
--  close(): void {
--    this.rl.close();
-+  resetCancelCounter(): void {
-+    this.consecutiveCancels = 0;
-   }
- 
-   /**
--   * Pause input
-+   * Decide what to prefill. Two modes:
-+   *   - 'history': when user is navigating up/down with arrows
-+   *   - 'draft':   when user has cleared the input — preserve their draft
-    */
--  pause(): void {
--    this.rl.pause();
-+  private computePrefill(): { kind: 'history' | 'draft' | 'none'; value: string } {
-+    if (this.historyIndex >= 0 && this.historyIndex < this.history.length) {
-+      return { kind: 'history', value: this.history[this.historyIndex] };
-+    }
-+    if (this.currentDraft) return { kind: 'draft', value: this.currentDraft };
-+    return { kind: 'none', value: '' };
-   }
- 
-   /**
--   * Resume input
-+   * Save the user's in-progress draft so ↑↓ preserves their unsent typing.
-    */
--  resume(): void {
--    this.rl.resume();
-+  saveDraft(text: string): void {
-+    this.currentDraft = text;
-   }
- 
-   /**
--   * Get previous command from history (for key handler)
-+   * Navigate up in history (called from a global key listener, if needed).
-    */
--  getPreviousHistory(): string | null {
--    if (this.history.length === 0) return null;
--    
--    if (this.historyIndex > 0) {
--      this.historyIndex--;
--    }
--    return this.history[this.historyIndex] || null;
-+  historyUp(): string {
-+    if (this.history.length === 0) return this.currentDraft;
-+    if (this.historyIndex < 0) this.historyIndex = this.history.length;
-+    if (this.historyIndex > 0) this.historyIndex--;
-+    return this.history[this.historyIndex] ?? '';
-   }
- 
-   /**
--   * Get next command from history (for key handler)
-+   * Navigate down in history.
-    */
--  getNextHistory(): string | null {
--    if (this.historyIndex < this.history.length - 1) {
--      this.historyIndex++;
--      return this.history[this.historyIndex];
-+  historyDown(): string {
-+    if (this.history.length === 0) return this.currentDraft;
-+    if (this.historyIndex >= this.history.length) return this.currentDraft;
-+    this.historyIndex++;
-+    if (this.historyIndex >= this.history.length) {
-+      this.historyIndex = this.history.length;
-+      return this.currentDraft;
-     }
--    this.historyIndex = this.history.length;
--    return '';
-+    return this.history[this.historyIndex] ?? '';
-   }
- 
--  /**
--   * Reset history navigation
--   */
--  resetHistoryNavigation(): void {
--    this.historyIndex = this.history.length;
-+  getHistory(): readonly string[] {
-+    return this.history;
-   }
- 
--  /**
--   * Simple completer for commands
--   */
--  private completer(line: string): [string[], string] {
--    const commands = [
--      'exit', 'quit', 'clear', 'context',
--      'help', 'tools', 'models', 'providers',
--      'history', 'git', 'file', 'shell'
--    ];
--    
--    const hits = commands.filter(c => c.startsWith(line.toLowerCase()));
--    return [hits.length ? hits : [], line];
--  }
--
--  /**
--   * Handle multiline input detection
--   */
--  isMultilineComplete(input: string): boolean {
--    // Check for explicit multiline trigger
--    if (input.endsWith('\\')) {
--      return false;
--    }
--    
--    // Check bracket balance
--    const openBrackets = (input.match(/\{/g) || []).length;
--    const closeBrackets = (input.match(/\}/g) || []).length;
--    const openParens = (input.match(/\(/g) || []).length;
--    const closeParens = (input.match(/\)/g) || []).length;
--    const openBrackets2 = (input.match(/\[/g) || []).length;
--    const closeBrackets2 = (input.match(/\]/g) || []).length;
--    
--    // Balanced if all counts match
--    return openBrackets === closeBrackets && 
--           openParens === closeParens && 
--           openBrackets2 === closeBrackets2;
-+  clearHistory(): void {
-+    this.history = [];
-+    this.historyIndex = -1;
-   }
- }
--- 
-2.45.2.windows.1
-