Skip to content

futuretea/code-assistant

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Code Assistant for Claude Code

Claude Code 插件,用于代码质量管理。采用 Sub-Agent + Skill 架构,Skill 负责意图识别,Agent 负责干活,各自独立上下文、支持并行。

架构特点

┌─────────────────────────────────────────────────────────────┐
│  Skill Layer (触发器)                                         │
│  - 识别用户意图                                               │
│  - 决定调用哪个 Sub-Agent                                    │
│  - 汇总结果                                                   │
└─────────────────────────────────────────────────────────────┘
                            │
        ┌───────────────────┼───────────────────┐
        ▼                   ▼                   ▼
┌──────────────┐   ┌──────────────┐   ┌──────────────┐
│  Sub-Agent 1 │   │  Sub-Agent 2 │   │  Sub-Agent N │
│  (独立上下文) │   │  (独立上下文) │   │  (独立上下文) │
└──────────────┘   └──────────────┘   └──────────────┘

为什么这样设计?

  • 每个 Sub-Agent 有独立上下文,不会互相干扰
  • 多个 Agent 可以并行跑,比如同时审查多个包或多个文件
  • Skill 只管「什么时候触发」,Agent 只管「怎么干活」,各司其职

安装

1. 添加插件市场

/plugin marketplace add futuretea/code-assistant

2. 安装插件

/plugin install code-assistant@code-assistant

3. 验证安装

/plugin list

安装成功后,你应该能看到 code-assistant 在已安装插件列表中。

包含的技能

1. Rebase Analysis(Rebase 影响分析)

触发词: "analyze rebase", "rebase risk", "rebase impact", "conflict prediction", "分析 rebase", "rebase 风险", "冲突预测"

执行方式:

  • 简单操作(查看 ahead/behind)直接执行
  • 分叉分支分析委托给 code-rebase-analyzer
  • 多分支分析可并行处理

2. Code Simplification(代码简化)

触发词: "simplify code", "refactor", "clean up code", "optimize code", "简化代码", "重构", "代码优化"

执行方式:

  • 简单格式化直接执行
  • 系统化重构委托给 code-optimizer
  • 多目录优化可并行处理

3. PR Description(PR 描述生成)

触发词: "generate PR description", "write PR", "PR description", "生成 PR 描述", "写 PR"

执行方式:

  • 查看变更统计直接执行
  • 生成完整 PR 描述委托给 code-pr-writer
  • 遵循 Problem/Solution/Test Plan 格式

4. Text Humanization(文本人性化)

触发词: "humanize text", "remove AI writing", "make it sound natural", "消除 AI 痕迹", "让文字更自然", "去掉 AI 味"

执行方式:

  • 单个词汇替换直接执行
  • 整篇文档审查委托给 code-text-humanizer
  • 多文件处理可并行

5. Readability Improvement(代码可读性改进)

触发词: "improve readability", "reduce abstraction", "inline functions", "提高可读性", "减少抽象", "代码可读性"

执行方式:

  • 单个函数内联直接执行
  • 系统化可读性分析委托给 code-readability-improver
  • 全面审查可并行启动 readability-improver + go-style-reviewer

6. Go Style Review(Go 风格审查)

触发词: "review Go style", "Go code review", "Go best practices", "Go 风格审查", "Go 代码审查", "golangci-lint"

执行方式:

  • 运行 linter 直接执行
  • 系统化风格审查委托给 code-go-style-reviewer
  • 多包审查可并行处理

项目结构

code-assistant/
├── .claude/
│   └── settings.local.json              # 工具权限配置
├── .claude-plugin/
│   ├── marketplace.json                 # 插件市场元数据
│   └── plugin.json                      # 插件元数据
├── agents/                              # Sub-Agent 定义
│   ├── rebase-analyzer/AGENT.md         # Rebase 影响分析 Agent
│   ├── code-optimizer/AGENT.md          # 代码优化 Agent
│   ├── pr-writer/AGENT.md               # PR 描述生成 Agent
│   ├── text-humanizer/AGENT.md          # 文本人性化 Agent
│   ├── readability-improver/AGENT.md    # 代码可读性改进 Agent
│   └── go-style-reviewer/AGENT.md       # Go 风格审查 Agent
├── skills/                              # Skill 触发器
│   ├── rebase-analysis/SKILL.md
│   ├── code-simplification/SKILL.md
│   ├── pr-description/SKILL.md
│   ├── text-humanization/SKILL.md
│   ├── readability-improvement/SKILL.md
│   └── go-style-review/SKILL.md
├── .gitignore
├── CLAUDE.md
├── LICENSE
└── README.md

使用示例

Rebase 分析

# 查看分叉状态
"当前分支和 main 的分叉情况"

# 完整 rebase 分析
"分析 rebase 到 main 的风险"
→ 启动 code-rebase-analyzer
→ 分叉拓扑 + 冲突预测 + 影响评估
→ 生成风险报告和执行建议

# 多分支分析
"分析 feature-a 和 feature-b 的 rebase 风险"
→ 并行启动 2 个 code-rebase-analyzer
→ 对比风险等级

代码简化

# 格式化代码
"格式化这个文件"
→ 直接调用 goimports

# 重构文件
"简化 handler.go 的代码"
→ 启动 code-optimizer
→ 分析 + 优化 + 验证
→ 生成变更清单

# 多目录优化
"简化 pkg/handler 和 pkg/service"
→ 并行启动 2 个 code-optimizer
→ 汇总变更

PR 描述生成

# 生成 PR 描述
"为当前变更生成 PR 描述"
→ 启动 code-pr-writer
→ 分析 git diff
→ 生成 Problem/Solution/Test Plan 格式描述

代码审查

# Go 风格审查
"审查 pkg/mcp 的 Go 风格"
→ 启动 code-go-style-reviewer
→ 按规则逐项检查
→ 生成分类问题报告

# 全面审查
"全面审查 pkg/gateway 的代码质量"
→ 并行启动:
  Agent 1: code-go-style-reviewer(风格)
  Agent 2: code-readability-improver(可读性)
→ 合并报告

文本人性化

# 消除 AI 痕迹
"humanize README.md"
→ 启动 code-text-humanizer
→ 识别 AI 模式
→ 改写为自然表达

Sub-Agent 并行执行模式

多文件并行分析

User: "审查所有 handler 文件的 Go 风格"Parallel:
   Task({ agent: "code-go-style-reviewer", path: "handler_a.go" })
   Task({ agent: "code-go-style-reviewer", path: "handler_b.go" })
   Task({ agent: "code-go-style-reviewer", path: "handler_c.go" })
 汇总审查报告

全面代码质量审查

User: "全面审查代码质量"Parallel:
   Task({ agent: "code-go-style-reviewer", scope: "package" })
   Task({ agent: "code-readability-improver", scope: "module" })
 合并为统一报告

多目录并行重构

User: "简化 pkg/handler 和 pkg/service"Parallel:
   Task({ agent: "code-optimizer", path: "pkg/handler" })
   Task({ agent: "code-optimizer", path: "pkg/service" })
 汇总变更清单

开发

添加 Sub-Agent

  1. 创建 agents/<agent-name>/AGENT.md
  2. 定义 agent 名称、工具集、并行能力
  3. 说明输入输出格式
  4. 从 skill 中引用

添加 Skill

  1. 创建 skills/<skill-name>/SKILL.md
  2. 定义触发条件(description)
  3. 说明何时调用哪个 sub-agent
  4. 提供并行执行模式示例

添加新功能时,值得想一下:能不能跟多个文件并行跑?能不能复用已有 Agent?能不能减少重复操作?

Agent 文件格式

---
name: code-agent-name        # 统一 code- 前缀
description: When to use this agent
tools: ["Bash", "Read", ...]  # 需要的工具
parallel: true                # 是否支持并行
---

# Agent Title

## Responsibilities
What this agent does

## Input Format
Parameters it accepts

## Output Format
Structured response format

## Execution Strategy
How to parallelize operations

License

MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors