Skip to content

3.1-plugins-setup.md

Latest commit

 

History

History
166 lines (132 loc) · 4.45 KB

3.1-plugins-setup.md

File metadata and controls

166 lines (132 loc) · 4.45 KB

3.1 插件配置指南

概述

CodeBuddy 支持多种插件扩展，本章介绍常用插件的配置方法。

插件类型

┌─────────────────────────────────────────────────────────────────────┐
│                    CodeBuddy 插件生态                                  │
├─────────────────────────────────────────────────────────────────────┤
│                                                                     │
│  ┌─────────────┐  ┌─────────────┐  ┌─────────────┐                │
│  │   内置插件   │  │   第三方插件 │  │   自定义插件 │                │
│  ├─────────────┤  ├─────────────┤  ├─────────────┤                │
│  │ 代码补全    │  │ 代码格式化   │  │ 企业内部工具 │                │
│  │ 语法检查    │  │ AI 对话     │  │ 私有服务    │                │
│  │ 版本控制    │  │ API 调试    │  │ 定制工作流  │                │
│  └─────────────┘  └─────────────┘  └─────────────┘                │
│                                                                     │
└─────────────────────────────────────────────────────────────────────┘

安装插件

方式一：IDE 内安装

1. 打开 CodeBuddy IDE
2. 进入 设置 → 插件市场
3. 搜索所需插件
4. 点击安装

方式二：命令行安装

# 安装官方插件
codebuddy plugin install @tencent/code-formatter

# 安装第三方插件
codebuddy plugin install @vendor/eslint-config

# 查看已安装插件
codebuddy plugin list

常用插件配置

1. ESLint 配置

# .codebuddy/plugins/eslint.yaml
plugin: eslint
enabled: true
config:
  extends:
    - eslint:recommended
    - plugin:react/recommended
    - plugin:@typescript-eslint/recommended
  rules:
    no-console: warn
    no-unused-vars: error
  settings:
    react:
      version: detect

2. Prettier 配置

# .codebuddy/plugins/prettier.yaml
plugin: prettier
enabled: true
config:
  semi: true
  singleQuote: true
  tabWidth: 2
  trailingComma: es5
  printWidth: 80

3. Git 插件

# .codebuddy/plugins/git.yaml
plugin: git
enabled: true
config:
  autoFetch: true
  autoPull: false
  branchProtection:
    - main
    - master
  commitHooks:
    - lint-staged
    - commit-msg

插件开发

创建自定义插件

# 初始化插件项目
codebuddy plugin init my-plugin

# 目录结构
my-plugin/
├── src/
│   └── index.ts      # 插件入口
├── package.json
└── codebuddy.config.js

插件模板

// src/index.ts
import { Plugin, PluginContext } from '@codebuddy/core';

export default class MyPlugin implements Plugin {
  name = 'my-plugin';
  version = '1.0.0';

  // 插件初始化
  async onInit(context: PluginContext) {
    console.log('插件初始化');
  }

  // 在代码补全时触发
  async onComplete(context: PluginContext) {
    // 自定义补全逻辑
    return [];
  }

  // 在保存文件时触发
  async onSave(context: PluginContext) {
    // 自定义保存逻辑
  }
}

插件市场推荐

插件名称 功能 安装命令
Code Formatter 代码格式化 install @tencent/code-formatter
API Tester API 调试 install @tencent/api-tester
DB Client 数据库客户端 install @tencent/db-client
Docker Helper Docker 辅助 install @tencent/docker-helper
CI/CD Monitor 流水线监控 install @tencent/cicd-monitor

本章小结

配置项 说明
安装方式 IDE 内 / 命令行
配置文件 .codebuddy/plugins/*.yaml
自定义开发 Plugin API
插件市场 官方 + 第三方

下一页：3.2 MCP 配置