# ai-naming-plugin

**Repository Path**: JasonLucas/ai-naming-plugin

## Basic Information

- **Project Name**: ai-naming-plugin
- **Description**: IDEA  ai-naming-plugin
- **Primary Language**: Kotlin
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-27
- **Last Updated**: 2026-02-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# AI Naming Assistant - IntelliJ IDEA 智能命名插件

## 📖 简介

AI Naming Assistant 是一款基于智谱AI GLM大模型的IntelliJ IDEA插件，帮助开发者进行专业的代码命名。只需输入中文描述，即可获得符合编程规范的英文命名建议。

## ✨ 功能特性

- **变量命名** - 使用camelCase驼峰命名法
- **常量命名** - 使用UPPER_SNAKE_CASE大写下划线命名法
- **方法命名** - 使用camelCase驼峰命名法，通常以动词开头
- **类命名** - 使用PascalCase帕斯卡命名法

每次请求返回4个不同风格的命名建议，方便开发者选择最适合的命名。

## 🎯 使用方法

1. **打开工具窗口**
   - 在IDEA右侧边栏找到 "AI Naming" 图标
   - 点击打开工具窗口

2. **选择命名类型**
   - 从下拉菜单选择：变量命名、常量命名、方法命名或类命名

3. **输入中文描述**
   - 在输入框中输入您想要命名的中文描述
   - 例如：用户年龄、获取订单列表、订单服务类

4. **获取命名建议**
   - 点击"✨ 获取命名建议"按钮
   - 或使用快捷键 `Ctrl+Enter`

5. **复制使用**
   - 点击建议右侧的"复制"按钮
   - 或直接点击整个建议卡片
   - 命名将自动复制到剪贴板

## ⚙️ 配置

### 获取智谱AI API Key

1. 访问 [智谱AI开放平台](https://bigmodel.cn/)
2. 注册/登录账号
3. 进入 [API Key管理](https://bigmodel.cn/usercenter/proj-mgmt/apikeys)
4. 创建并复制API Key

### 配置插件

1. 打开 IDEA → Settings → Tools → AI Naming Assistant
2. 输入您的API Key
3. 选择模型（推荐 `glm-4-flash` 免费）
4. 点击 Apply 保存设置

### 支持的模型

| 模型 | 说明 | 推荐 |
|------|------|------|
| glm-4-flash | 免费模型，速度快 | ⭐ 推荐 |
| glm-4 | 标准版 | - |
| glm-4-plus | 高级版，效果更好 | - |
| glm-4-air | 性价比版 | - |

## 📝 使用示例

| 输入描述 | 命名类型 | 建议示例 |
|---------|---------|---------|
| 用户年龄 | 变量命名 | userAge, ageOfUser, customerAge, personAge |
| 最大连接数 | 常量命名 | MAX_CONNECTIONS, MAX_CONNECTION_COUNT, CONNECTION_LIMIT |
| 获取订单列表 | 方法命名 | getOrderList, fetchOrders, retrieveOrderList, getOrders |
| 订单服务 | 类命名 | OrderService, OrderManager, OrderHandler, OrderProcessor |

## 🛠️ 技术架构

```
ai-naming-plugin/
├── build.gradle.kts          # Gradle构建配置
├── settings.gradle.kts       # Gradle设置
└── src/main/
    ├── kotlin/com/ai/naming/
    │   ├── AIService.kt              # AI服务，调用智谱AI API
    │   ├── NamingType.kt             # 命名类型枚举
    │   ├── NamingResult.kt           # 数据模型
    │   ├── NamingSettings.kt         # 设置存储
    │   ├── NamingConfigurable.kt     # 配置页面
    │   ├── NamingToolWindowContent.kt # 工具窗口UI
    │   └── NamingToolWindowFactory.kt # 工具窗口工厂
    └── resources/META-INF/
        └── plugin.xml                # 插件配置
```

## 📋 系统要求

- IntelliJ IDEA 2023.2+ (Build 232.* - 260.*)
- JDK 17+
- 网络连接（用于调用智谱AI API）

## 🔧 开发说明

### 环境准备

```bash
# 克隆项目
git clone <repository-url>
cd ai-naming-plugin

# 构建项目
./gradlew buildPlugin

# 生成的插件位于
# build/distributions/ai-naming-plugin-1.0.0.zip
```

### 项目依赖

- Kotlin 1.9.21
- IntelliJ Platform Plugin SDK
- OkHttp 4.12.0 (HTTP客户端)
- Gson 2.10.1 (JSON解析)

## 📄 许可证

Apache License 2.0

## 🤝 贡献

欢迎提交Issue和Pull Request！

## 📮 联系方式

如有问题或建议，请提交Gitee Issue。

---

**Powered by 智谱AI GLM**