@git-ai/cli 1.0.0

package/src/actions/SelectModelAction.mjs

@@ -0,0 +1,161 @@
+import axios from "axios";
+import { promises as fs } from "fs";
+import { isAbsolute, resolve } from "path";
+import { chat } from "../utils/OpenAI.mjs";
+import { config } from "../utils/Storage.mjs";
+import inquirer from "inquirer";
+import { formatCompletions } from "../utils/MessageUtils.mjs";
+import { OPENAI_MODEL_LIST_URL } from "../const.mjs";
+import Logger from "../utils/Logger.mjs";
+import Spinner from "../utils/Spinner.mjs";
+import BaseAction from "./BaseAction.mjs";
+
+class SelectModelAction extends BaseAction {
+  async execute() {
+    await this.setModel();
+  }
+
+  async getModelList() {
+    if (!OPENAI_MODEL_LIST_URL) {
+      Logger.notice(`需要配置环境变量 \`OPENAI_MODEL_LIST_URL\` 。
+此变量指定 OpenAI 模型列表的来源，支持 HTTP(S) URL 或本地文件路径。
+
+** OPENAI_MODEL_LIST_URL 示例：**
+*   URL: \`https://raw.githubusercontent.com/xx025/carrot/main/model_list.json\`
+*   Linux/macOS 路径: \`/path/to/your/local/model_list.json\`
+*   Windows 路径: \`C:\\Path\\To\\Your\\Local\\model_list.json\`
+
+** JSON 配置示例：**
+模型id、baseURL、key 配置多个会随机取，必填(id、baseURL)、非必填(keys)
+\`\`\`json
+{
+  "data": [
+    {
+      "id": "modelId,modelId,modelId",
+      "baseURL": "baseURL,baseURL,baseURL",
+      "keys": "key,key,key"
+    }
+  ]
+}
+\`\`\`
+      `);
+      throw "未配置环境变量 `OPENAI_MODEL_LIST_URL`";
+    }
+    const source = OPENAI_MODEL_LIST_URL;
+    const isHttpSource = /^https?:\/\//i.test(source);
+    const spinner = new Spinner("正在加载模型列表...");
+    spinner.start();
+    try {
+      if (isHttpSource) {
+        const { data } = await axios.get(source);
+        spinner.stop();
+        return data;
+      }
+      const filePath = isAbsolute(source)
+        ? source
+        : resolve(process.cwd(), source);
+      const content = await fs.readFile(filePath, "utf8");
+      spinner.stop();
+      return JSON.parse(content);
+    } catch (error) {
+      spinner.stop();
+      throw error && error.message ? error.message : error;
+    }
+  }
+
+  async selectModels() {
+    const modelConfig = {
+      list: [],
+      origin: [],
+    };
+
+    try {
+      modelConfig.origin = (await this.getModelList()).data || [];
+      modelConfig.list = modelConfig.origin.map((item) => item.id);
+      if (!modelConfig.list.length) {
+        throw "未找到可用的模型";
+      }
+    } catch (error) {
+      throw error && error.message ? error.message : error;
+    }
+    try {
+      const answers = await inquirer.prompt([
+        {
+          type: "rawlist",
+          name: "model",
+          message: `请选择模型`,
+          choices: modelConfig.list,
+          default: "",
+          loop: false,
+        },
+      ]);
+      const item = modelConfig.origin.find((item) => item.id === answers.model);
+      if (!item.baseURL || !item.id) {
+        throw `模型信息不完整: 请检查 \`baseURL\` 和 \`id\``;
+      }
+      config.set("baseURL", item.baseURL);
+      config.set("model", item.id);
+      config.set("key", item.keys);
+      Logger.success(
+        `已设置模型: \n   - ${item.id.split(`,`).join("\n   - ")}`
+      );
+    } catch (error) {
+      throw `设置模型失败: ${error && error.message ? error.message : error}`;
+    }
+  }
+  // 验证模型是否可用
+  async validateModel() {
+    const spinner = new Spinner("正在验证模型是否可用...");
+    spinner.start();
+
+    const startTimestamp = Date.now();
+    const configModel = config.get("model")
+      ? config.get("model").split(",")
+      : [];
+    const total = configModel.length;
+    const errTotal = [];
+    while (configModel.length) {
+      const model = configModel.shift();
+      try {
+        const result = await chat({
+          model: model,
+          messages: [
+            {
+              role: "user",
+              content: "1+1=?",
+            },
+          ],
+        });
+        formatCompletions(result);
+      } catch {
+        errTotal.push(model);
+      }
+    }
+    spinner.stop();
+    if (total - errTotal.length > 0) {
+      Logger.success(`模型验证通过 ${total - errTotal.length} 个`);
+    }
+    if (errTotal.length) {
+      Logger.error(
+        `模型验证失败 ${errTotal.length} 个，分别是：\n${errTotal.join(
+          "\n   - "
+        )}`
+      );
+    }
+
+    const endTimestamp = Date.now();
+    const duration = endTimestamp - startTimestamp;
+
+    Logger.success(`本次检查模型用时: ${(duration / 1000).toFixed(3)} 秒`);
+  }
+
+  async setModel() {
+    await this.selectModels();
+    await this.validateModel();
+  }
+}
+
+export default async function () {
+  const action = new SelectModelAction();
+  await action.run();
+}

package/src/actions/TokenAction.mjs

@@ -0,0 +1,25 @@
+import { config } from "../utils/Storage.mjs";
+import Logger from "../utils/Logger.mjs";
+import { formatToken } from "../utils/Utils.mjs";
+import BaseAction from "./BaseAction.mjs";
+
+class SetTokenAction extends BaseAction {
+  constructor(key) {
+    super(key);
+    this.key = key || "";
+  }
+
+  async execute() {
+    config.set("key", this.key);
+    if (this.key) {
+      Logger.success(`OpenAI Api Key 已设置: ${formatToken(this.key)}`);
+    } else {
+      Logger.warn(`OpenAI Api Key 已设置为空`);
+    }
+  }
+}
+
+export default async function (key) {
+  const action = new SetTokenAction(key);
+  await action.run();
+}

package/src/const.mjs

@@ -0,0 +1,41 @@
+import { resolve } from 'path';
+import { readFileSync } from 'fs';
+// 读取 package.json 文件
+const pkgPath = resolve(process.argv[1], '../../package.json');
+const pkg = JSON.parse(readFileSync(pkgPath, 'utf8'));
+export const BIN = Object.keys(pkg.bin)[0].split('-').join(' ')
+export const NAME = pkg.name
+export const DESCRIPTION = pkg.description
+export const VERSION = pkg.version
+export const AUTHOR = pkg.author
+export const LOWEST_NODE_VERSION = pkg.engines.node
+export const OPENAI_BASE_URL = "" //"https://api.siliconflow.cn/v1"
+export const OPENAI_API_KEYS_URL = "" //"https://cloud.siliconflow.cn/me/account/ak"
+export const OPENAI_MODELS_URL = "" //"https://cloud.siliconflow.cn/me/models"
+export const OPENAI_MODEL_DEFAULT = "" // "Qwen/Qwen2.5-Coder-7B-Instruct"
+export const OPENAI_TIMEOUT = 60 * 1000 * 3
+export const OPENAI_MAX_TOKEN_DEFAULT = 128000
+export const OPENAI_MODEL_LIST_URL = process.env.OPENAI_MODEL_LIST_URL
+export const OPENAI_FREE_BASE_URL = "https://open.bigmodel.cn/api/paas/v4"
+export const OPENAI_FREE_MODEL_ID = "glm-4-flash-250414,glm-4.5-flash"
+export const OPENAI_COMMIT_MESSAGE_TYPES = [
+    'feat',
+    'fix',
+    'docs',
+    'style',
+    'refactor',
+    'perf',
+    'test',
+    'build',
+    'ci',
+    'chore',
+    'revert',
+]
+export const asciiArt = `
+ ██████╗ ██╗████████╗     █████╗ ██╗
+██╔════╝ ██║╚══██╔══╝    ██╔══██╗██║
+██║  ███╗██║   ██║       ███████║██║
+██║   ██║██║   ██║       ██╔══██║██║
+╚██████╔╝██║   ██║       ██║  ██║██║
+ ╚═════╝ ╚═╝   ╚═╝       ╚═╝  ╚═╝╚═╝
+`

package/src/index.mjs

@@ -0,0 +1,69 @@
+import { Command } from 'commander';
+import CommitAction from './actions/CommitAction.mjs';
+import ModelAction from './actions/ModelAction.mjs';
+import TokenAction from './actions/TokenAction.mjs';
+import BaseUrlAction from './actions/BaseUrlAction.mjs';
+import MaxTokenAction from './actions/MaxTokenAction.mjs';
+import { exitProcess } from './utils/Utils.mjs';
+import SelectModelAction from './actions/SelectModelAction.mjs';
+import { BIN, VERSION, DESCRIPTION, NAME, OPENAI_MAX_TOKEN_DEFAULT, asciiArt } from './const.mjs';
+import Logger from './utils/Logger.mjs';
+import chalk from "chalk";
+
+let startTimestamp;
+function registerCommand() {
+    const program = new Command();
+    program
+        .name(BIN)
+        // .description(`${asciiArt}`)
+        // .description(`${asciiArt}\n${DESCRIPTION}`)
+        .version(VERSION)
+        .helpOption('-h', chalk.cyan(`显示帮助信息 （baseURL、model、token 分别支持多个，英文逗号隔开）`));
+    program
+        .command('set-baseURL [baseURL]')
+        .description(`设置 OpenAI compatible Base URL，请执行 ${chalk.cyan('`' + BIN + ' set-baseURL [baseURL]`')}\n如：https://api.siliconflow.cn/v1`)
+        .action(BaseUrlAction);
+    program
+        .command('set-key [key]')
+        .description(`设置 OpenAI compatible Api Key，请执行 ${chalk.cyan('`' + BIN + ' set-key [key]`')}`)
+        .action(TokenAction);
+    program
+        .command('set-model [model]')
+        .description(`设置您的模型，请执行 ${chalk.cyan('`' + BIN + ' set-model [model]`')}`)
+        .action(ModelAction);
+    program
+        .command('set-max-token <maxToken>')
+        .description(`设置您的最大 token 数，默认：${OPENAI_MAX_TOKEN_DEFAULT}(${Math.round(OPENAI_MAX_TOKEN_DEFAULT / 1000)}k)`)
+        .action(MaxTokenAction);
+    program
+        .command('select-model')
+        .description(`从模型列表选择，请执行 ${chalk.cyan('`' + BIN + ' select-model`')}`)
+        .action(SelectModelAction);
+    program
+        .option('-d, --dry-run', `等同于 ${chalk.cyan('`git commit --dry-run -m <message>`')}`)
+        .option('-e, --allow-empty', `等同于 ${chalk.cyan('`git commit --allow-empty -m <message>`')}`)
+        .option('-n, --no-verify', `等同于 ${chalk.cyan('`git commit --no-verify -m <message>`')}`)
+        .option('-s, --skip', `跳过 ${chalk.cyan('`git add`')} 命令, 只提交已暂存的更改，如：${chalk.cyan('`' + BIN + ' --skip\`')}`)
+        .description(`${DESCRIPTION}\n${asciiArt}\n使用 AI 自动生成提交信息并推送
+   → ${chalk.cyan('检查环境')} → ${chalk.cyan('检查目录')} → ${chalk.cyan('检查冲突')} → ${chalk.cyan('处理合并')}\n   → ${chalk.cyan('git add')} → ${chalk.cyan('获取diff')} → ${chalk.cyan('AI 生成 commit message')}\n   → ${chalk.cyan('git fetch')} → ${chalk.cyan('git merge')} → ${chalk.cyan('检查冲突')} → ${chalk.cyan('git push')}`)
+        .action(CommitAction);
+    program.parse();
+}
+async function prepare() {
+    // 第一步检查版本号
+    checkPkgVersion();
+}
+function checkPkgVersion() {
+    Logger.verbose(`${NAME}@${VERSION}`);
+}
+export default async function core() {
+    startTimestamp = Date.now()
+    try {
+        await prepare();
+        // 命令注册
+        registerCommand()
+    } catch (e) {
+        Logger.error(e.message);
+        exitProcess(1, startTimestamp);
+    }
+}

package/src/services/AIService.mjs

@@ -0,0 +1,113 @@
+import { chat, freeChat } from "../utils/OpenAI.mjs";
+import {
+  generateSystemMessage,
+  formatCompletions,
+} from "../utils/MessageUtils.mjs";
+import { config } from "../utils/Storage.mjs";
+import chalk from "chalk";
+/**
+ * AI 服务类
+ * 封装所有 AI 相关操作
+ */
+export class AIService {
+  constructor(userName) {
+    this.userName = userName;
+    this.usageMessage = "";
+  }
+  // 检查是否配置 baseUrl model
+  checkConfig() {
+    const baseURL = config.get("baseURL");
+    const key = config.get("key");
+    return baseURL && key;
+  }
+
+  /**
+   * 生成提交消息
+   */
+  async generateCommitMessage(diffString) {
+    const request = this.checkConfig() ? chat : freeChat;
+    const result = await request({
+      messages: [
+        {
+          role: "system",
+          content: generateSystemMessage(this.userName),
+        },
+        { role: "user", content: diffString },
+      ],
+    });
+    if (result.data && result.data.error && !result.data.choices) {
+      throw result.data.error;
+    }
+
+    if (result.data.usage) {
+      this.usageMessage = chalk.underline(
+        `本次模型消耗统计：总数 ${result.data.usage.total_tokens} tokens、输入 ${result.data.usage.prompt_tokens} tokens、输出 ${result.data.usage.completion_tokens} tokens`
+      );
+    }
+
+    return formatCompletions(result);
+  }
+
+  /**
+   * 让 AI 帮忙分析 git commit 失败原因
+   * @param {Object} payload
+   * @param {string} payload.errorMessage git commit 抛出的错误
+   * @param {string} payload.gitStatus 当前 git status 输出
+   * @param {string} payload.hookLogs 如果有 hook 输出，可传入
+   */
+  async analyzeCommitFailure({
+    errorMessage = "",
+    gitStatus = "",
+    hookLogs = "",
+  } = {}) {
+    this.usageMessage = "";
+    const request = this.checkConfig() ? chat : freeChat;
+    const contextParts = [];
+    if (errorMessage) {
+      contextParts.push(`Git 命令报错：\n${errorMessage}`);
+    }
+    if (gitStatus) {
+      contextParts.push(`git status 输出：\n${gitStatus}`);
+    }
+    if (hookLogs) {
+      contextParts.push(`Hook 输出：\n${hookLogs}`);
+    }
+    const userPrompt = contextParts.length
+      ? contextParts.join("\n\n")
+      : "未提供额外日志，只知道 git commit 失败。";
+
+    const result = await request({
+      messages: [
+        {
+          role: "system",
+          content:
+            "你是一个资深的 Git 专家，请分析用户提供的 git commit 失败日志，输出造成失败的最可能原因，并给出简洁的排查或修复步骤。请使用中文回答，结构可以是：原因 + 处理建议。",
+        },
+        {
+          role: "user",
+          content: userPrompt,
+        },
+      ],
+      temperature: 0.2,
+    });
+
+    if (result.data && result.data.usage) {
+      this.usageMessage = chalk.underline(
+        `本次模型消耗统计：总数 ${result.data.usage.total_tokens} tokens、输入 ${result.data.usage.prompt_tokens} tokens、输出 ${result.data.usage.completion_tokens} tokens`
+      );
+    }
+
+    if (result.data && result.data.error && !result.data.choices) {
+      throw result.data.error;
+    }
+
+    return formatCompletions(result);
+  }
+
+  /**
+   * 获取使用统计信息
+   */
+  getUsageMessage() {
+    return this.usageMessage;
+  }
+}