jarvis-ai-assistant 0.7.8__py3-none-any.whl → 1.0.2__py3-none-any.whl

jarvis/jarvis_code_agent/rules/performance.md

@@ -0,0 +1,158 @@
+# 性能优化规则
+
+## 你必须遵守的优化原则
+
+### 1. 先测量，后优化原则（必须遵守）
+
+**执行要求：**
+
+- **禁止**：在没有测量的情况下进行优化
+- **必须**：使用性能分析工具找出瓶颈
+- **必须**：基于实际数据决定优化方向
+- **禁止**：过早优化（在性能问题未确认前）
+
+**测量方法：**
+
+- 使用性能分析工具（如 profiler）
+- 测量关键路径的执行时间
+- 测量资源使用情况（CPU、内存、I/O）
+- 建立性能基准（benchmark）
+
+**优化流程：**
+
+1. 测量当前性能
+2. 识别性能瓶颈
+3. 优化瓶颈点
+4. 再次测量，确认优化效果
+5. 如果未达到目标，重复步骤 2-4
+
+### 2. 算法和数据结构选择原则（必须遵守）
+
+**执行要求：**
+
+- **必须**：选择合适的数据结构
+- **必须**：理解算法的时间复杂度
+- **必须**：考虑空间换时间的权衡
+- **必须**：根据数据规模选择算法
+
+**选择标准：**
+
+- 时间复杂度：O(1) > O(log n) > O(n) > O(n log n) > O(n²)
+- 空间复杂度：考虑内存限制
+- 数据特征：有序/无序、重复/唯一、大小等
+- 操作频率：读多写少 vs 写多读少
+
+### 3. 资源管理原则（必须遵守）
+
+**执行要求：**
+
+- **必须**：及时释放资源（文件、网络连接、数据库连接等）
+- **必须**：使用连接池管理资源
+- **必须**：避免内存泄漏
+- **禁止**：持有资源不释放
+
+**资源管理：**
+
+- 使用 try-finally 或 with 语句确保资源释放
+- 使用连接池复用连接
+- 及时关闭文件、网络连接
+- 清理不再使用的对象引用
+
+## 你必须掌握的优化技巧
+
+### 1. 缓存策略（必须考虑）
+
+**何时使用：**
+
+- 计算结果重复使用
+- 数据读取频繁但变化少
+- 网络请求结果可以缓存
+
+**实施要求：**
+
+- **必须**：使用适当的缓存策略（LRU、FIFO、TTL 等）
+- **必须**：注意缓存失效和更新
+- **必须**：考虑缓存大小限制
+- **禁止**：缓存敏感数据（除非加密）
+
+### 2. 批量处理（必须考虑）
+
+**何时使用：**
+
+- 数据库操作频繁
+- 网络请求可以合并
+- 循环中有重复计算
+
+**实施要求：**
+
+- **必须**：批量处理数据库操作（批量插入、更新）
+- **必须**：批量发送网络请求
+- **必须**：减少循环中的重复计算
+- **必须**：使用批量 API 而非循环调用
+
+### 3. 异步处理（必须考虑）
+
+**何时使用：**
+
+- I/O 操作（文件、网络、数据库）
+- 独立任务可以并行
+- 耗时任务不影响主流程
+
+**实施要求：**
+
+- **必须**：使用异步 I/O 处理阻塞操作
+- **必须**：并行处理独立任务
+- **必须**：使用消息队列处理耗时任务
+- **必须**：合理控制并发数量
+
+### 4. 数据库优化（必须考虑）
+
+**优化要求：**
+
+- **必须**：在查询字段上创建索引
+- **必须**：避免 N+1 查询问题
+- **必须**：使用分页而非加载全部数据
+- **必须**：优化查询语句（避免全表扫描）
+
+**查询优化：**
+
+- 使用索引加速查询
+- 使用 JOIN 而非多次查询
+- 使用 LIMIT 限制返回数量
+- 避免 SELECT *，只查询需要的字段
+
+## 性能优化检查清单
+
+在完成代码后，你必须确认：
+
+**性能测量：**
+
+- [ ] 已识别并优化了性能瓶颈
+- [ ] 使用性能分析工具验证了优化效果
+- [ ] 建立了性能基准并持续监控
+
+**算法和数据结构：**
+
+- [ ] 使用了合适的数据结构和算法
+- [ ] 理解了算法的时间复杂度
+- [ ] 考虑了空间换时间的权衡
+
+**资源管理：**
+
+- [ ] 资源被正确释放
+- [ ] 使用了连接池（如适用）
+- [ ] 没有内存泄漏
+
+**优化技巧应用：**
+
+- [ ] 避免了不必要的计算
+- [ ] 使用了适当的缓存策略
+- [ ] 实施了批量处理（如适用）
+- [ ] 使用了异步处理（如适用）
+
+**数据库优化：**
+
+- [ ] 数据库查询被优化
+- [ ] 使用了索引
+- [ ] 避免了 N+1 查询
+- [ ] 考虑了并发性能

jarvis/jarvis_code_agent/rules/refactoring.md

@@ -0,0 +1,139 @@
+# 重构规则
+
+## 你必须遵守的重构原则
+
+### 1. 小步快跑原则（必须遵守）
+
+**执行要求：**
+
+- **必须**：每次重构只做小的改动
+- **必须**：每次改动后立即运行测试
+- **必须**：确认测试通过后再进行下一步重构
+- **必须**：使用版本控制，每次小改动都提交，便于回滚
+
+**禁止行为：**
+
+- **禁止**：一次性进行大规模重构
+- **禁止**：在测试未通过的情况下继续重构
+
+### 2. 保持功能不变原则（必须遵守）
+
+**执行要求：**
+
+- **必须**：重构不应该改变代码的外部行为
+- **必须**：重构前后，所有测试必须都能通过
+- **必须**：如果有功能变更需求，必须单独提交，不要与重构混在一起
+
+**验证方法：**
+
+- 重构前运行所有测试，记录测试结果
+- 重构后运行所有测试，确保结果一致
+- 如果测试失败，立即回滚或修复
+
+### 3. 识别代码异味（必须识别并处理）
+
+**你必须识别并处理的代码异味：**
+
+- [ ] 重复代码（违反 DRY 原则）
+- [ ] 过长的方法或类（超过合理长度）
+- [ ] 过深的嵌套（超过 3-4 层）
+- [ ] 魔法数字和字符串（未命名的常量）
+- [ ] 过度的参数列表（超过 3-4 个参数）
+- [ ] 过长的方法链
+- [ ] 过大的类（职责过多）
+
+## 你必须掌握的重构技巧
+
+### 1. 提取方法（Extract Method）
+
+**何时使用：** 方法过长或包含重复逻辑
+**操作步骤：**
+
+1. 识别可以独立的方法块
+2. 创建新方法，移动代码
+3. 用方法调用替换原代码
+4. 运行测试确认
+
+### 2. 提取变量（Extract Variable）
+
+**何时使用：** 复杂表达式难以理解
+**操作步骤：**
+
+1. 识别复杂表达式
+2. 创建有意义的变量名
+3. 用变量替换表达式
+4. 运行测试确认
+
+### 3. 重命名（Rename）
+
+**何时使用：** 名称不清晰或误导
+**操作步骤：**
+
+1. 确定更清晰的名称
+2. 使用 IDE 的重构工具进行重命名
+3. 运行测试确认
+
+### 4. 消除重复（Remove Duplication）
+
+**何时使用：** 发现重复代码
+**操作步骤：**
+
+1. 识别重复模式
+2. 提取公共逻辑到函数或类
+3. 替换所有重复代码
+4. 运行测试确认
+
+### 5. 简化条件（Simplify Conditional）
+
+**何时使用：** 条件表达式复杂难懂
+**操作步骤：**
+
+1. 提取条件到有意义的变量
+2. 使用早期返回减少嵌套
+3. 使用更清晰的条件表达式
+4. 运行测试确认
+
+### 6. 移动代码（Move Code）
+
+**何时使用：** 代码位置不合适
+**操作步骤：**
+
+1. 确定代码应该存在的位置
+2. 移动代码到合适位置
+3. 更新引用
+4. 运行测试确认
+
+## 重构时机判断
+
+### 你必须进行重构的情况
+
+1. **添加新功能前**：
+   - 如果现有代码结构难以扩展
+   - **必须**：先重构现有代码，使其更容易扩展
+   - **然后**：再添加新功能
+
+2. **修复 Bug 时**：
+   - 如果发现代码结构有问题导致 Bug
+   - **必须**：先重构代码结构
+   - **然后**：再修复 Bug
+
+3. **代码审查时**：
+   - 如果发现可以改进的地方
+   - **必须**：建议重构
+   - **必须**：提供具体的重构建议
+
+4. **定期清理**：
+   - **必须**：定期进行技术债务清理
+   - **必须**：识别并重构代码异味
+
+## 重构执行检查清单
+
+在完成重构后，你必须确认：
+
+- [ ] 所有测试都能通过（重构前后测试结果一致）
+- [ ] 代码更清晰、更易读
+- [ ] 没有引入新的 bug
+- [ ] 性能没有明显下降（如有下降，必须说明原因）
+- [ ] 代码更易于扩展和维护
+- [ ] 代码异味已消除或减少
+- [ ] 重构已提交到版本控制

jarvis/jarvis_code_agent/rules/security.md

@@ -0,0 +1,160 @@
+# 安全编码规则
+
+## 你必须遵守的核心安全原则
+
+### 1. 输入验证原则（必须严格执行）
+
+**执行要求：**
+
+- **必须**：永远不要信任用户输入
+- **必须**：验证所有输入数据的格式和范围
+- **必须**：使用白名单而非黑名单进行验证
+- **禁止**：直接使用未验证的用户输入
+
+**验证要求：**
+
+- 验证数据类型（字符串、数字、日期等）
+- 验证数据格式（邮箱、URL、电话号码等）
+- 验证数据范围（长度、数值范围等）
+- 验证数据内容（不允许特殊字符、SQL 注入字符等）
+
+### 2. 最小权限原则（必须遵守）
+
+**执行要求：**
+
+- **必须**：使用最小必要的权限
+- **必须**：避免使用管理员权限运行应用
+- **必须**：限制文件系统访问范围
+- **禁止**：使用过高的权限运行应用
+
+**权限管理：**
+
+- 文件系统：只授予必要的目录访问权限
+- 网络访问：只允许访问必要的服务
+- 数据库：使用最小权限的数据库用户
+- 系统资源：限制 CPU、内存等资源使用
+
+### 3. 敏感数据保护原则（必须遵守）
+
+**执行要求：**
+
+- **禁止**：在代码中硬编码密码、密钥、API Key
+- **必须**：使用环境变量或密钥管理服务存储敏感信息
+- **必须**：加密存储敏感数据
+- **必须**：使用 HTTPS 传输敏感数据
+
+**敏感数据处理：**
+
+- 密码：必须加密存储（使用哈希算法，如 bcrypt）
+- API 密钥：存储在环境变量或密钥管理服务中
+- 令牌：使用安全的令牌生成和验证机制
+- 个人信息：遵守数据保护法规（如 GDPR）
+
+## 你必须防范的常见安全问题
+
+### 1. SQL 注入（必须防范）
+
+**禁止行为：**
+
+- **禁止**：拼接 SQL 语句
+- **禁止**：直接将用户输入插入 SQL 语句
+
+**必须行为：**
+
+- **必须**：使用参数化查询
+- **必须**：使用 ORM 框架的查询方法
+- **必须**：验证和转义所有输入
+
+**示例：**
+
+```python
+# ❌ 错误：SQL 注入风险
+query = f"SELECT * FROM users WHERE id = {user_id}"
+
+# ✅ 正确：参数化查询
+query = "SELECT * FROM users WHERE id = ?"
+cursor.execute(query, (user_id,))
+```
+
+### 2. XSS (跨站脚本攻击)（必须防范）
+
+**必须行为：**
+
+- **必须**：对用户输入进行转义
+- **必须**：使用内容安全策略 (CSP)
+- **必须**：验证和清理 HTML 内容
+
+**防护措施：**
+
+- 输出转义：对所有输出到 HTML 的内容进行转义
+- CSP 头：设置内容安全策略，限制脚本执行
+- 输入验证：拒绝包含脚本标签的输入
+
+### 3. CSRF (跨站请求伪造)（必须防范）
+
+**必须行为：**
+
+- **必须**：使用 CSRF token
+- **必须**：验证请求来源
+- **必须**：对敏感操作使用 POST 请求
+
+**防护措施：**
+
+- 生成并验证 CSRF token
+- 检查 Referer 头
+- 使用 SameSite Cookie 属性
+
+### 4. 敏感信息泄露（必须防范）
+
+**禁止行为：**
+
+- **禁止**：在日志中记录敏感信息（密码、密钥、令牌）
+- **禁止**：在错误消息中暴露系统细节
+- **禁止**：在代码注释中留下敏感信息
+
+**必须行为：**
+
+- **必须**：在记录日志前过滤敏感信息
+- **必须**：使用通用的错误消息，不暴露内部细节
+- **必须**：定期检查代码和配置文件中的敏感信息
+
+## 安全编码检查清单
+
+在提交代码前，你必须确认：
+
+**输入验证：**
+
+- [ ] 所有用户输入都经过验证
+- [ ] 使用白名单而非黑名单
+- [ ] 验证了数据类型、格式和范围
+
+**敏感数据处理：**
+
+- [ ] 没有硬编码的密码或密钥
+- [ ] 敏感信息存储在环境变量或密钥管理服务中
+- [ ] 敏感数据被加密存储
+- [ ] 使用 HTTPS 传输敏感数据
+
+**数据库安全：**
+
+- [ ] 使用参数化查询（防止 SQL 注入）
+- [ ] 使用最小权限的数据库用户
+- [ ] 数据库连接使用加密
+
+**输出安全：**
+
+- [ ] 所有输出都经过转义（防止 XSS）
+- [ ] 错误消息不泄露系统信息
+- [ ] 日志中不包含敏感信息
+
+**访问控制：**
+
+- [ ] 实施了适当的访问控制
+- [ ] 使用 CSRF token 保护表单
+- [ ] 验证了用户权限
+
+**依赖安全：**
+
+- [ ] 定期更新依赖库
+- [ ] 检查依赖库的安全漏洞
+- [ ] 使用安全的随机数生成器

jarvis/jarvis_code_agent/rules/tdd.md

@@ -0,0 +1,78 @@
+# 测试驱动开发 (TDD) 规则
+
+## 你必须遵循的工作流程
+
+### 红-绿-重构循环（严格执行）
+
+1. **🔴 红阶段（编写失败的测试）**：
+   - 在实现任何功能代码之前，必须先编写测试用例
+   - 测试必须描述期望的行为，而不是实现细节
+   - 运行测试，确认测试失败（红色）
+
+2. **🟢 绿阶段（让测试通过）**：
+   - 编写最简单的代码让测试通过
+   - 不要过度设计，只实现让测试通过的最小代码
+   - 运行测试，确认测试通过（绿色）
+
+3. **🔵 重构阶段（优化代码）**：
+   - 在测试通过的基础上，优化代码结构
+   - 重构后必须再次运行测试，确保所有测试仍然通过
+   - 如果重构导致测试失败，立即回滚或修复
+
+## 你必须遵守的原则
+
+### 测试优先原则
+
+- **禁止**：在编写测试之前实现功能代码
+- **必须**：为每个新功能编写测试用例
+- **必须**：测试应该清晰、可读、可维护
+- **必须**：使用描述性的测试名称，清楚表达测试意图
+
+### 测试覆盖要求
+
+- **必须**：为所有新功能编写对应的测试
+- **必须**：测试覆盖以下三种情况：
+  - 正常情况（happy path）
+  - 边界情况（edge cases）
+  - 异常情况（error cases）
+- **必须**：确保测试独立运行，不依赖其他测试
+- **必须**：确保测试可重复执行，结果一致
+
+## 实践指导
+
+### 编写测试时的思考方式
+
+- 问自己："这个功能应该做什么？"而不是"这个功能如何实现？"
+- 测试应该验证行为，而不是实现细节
+- 一个测试只验证一个行为或场景
+
+### 发现 Bug 时的处理流程
+
+1. 先编写测试用例重现该 Bug
+2. 运行测试，确认测试失败（重现问题）
+3. 修复代码
+4. 运行测试，确认测试通过（问题已解决）
+
+## 代码示例
+
+```python
+# ✅ 正确做法：先写测试
+def test_calculate_total():
+    assert calculate_total([1, 2, 3]) == 6
+    assert calculate_total([]) == 0
+    assert calculate_total([-1, 1]) == 0
+
+# 然后实现功能
+def calculate_total(numbers):
+    return sum(numbers)
+```
+
+## 执行检查清单
+
+在提交代码前，你必须确认：
+
+- [ ] 所有新功能都有对应的测试用例
+- [ ] 测试覆盖了正常、边界和异常情况
+- [ ] 所有测试都能独立运行
+- [ ] 所有测试都能通过
+- [ ] 测试名称清晰描述测试意图

jarvis/jarvis_code_agent/test_rules/cpp_test.md

@@ -0,0 +1,118 @@
+# C/C++ 测试规则
+
+## ⚠️ 你必须遵守的核心要求
+
+**编写完成务必执行测试，直到修复完成为止！**
+
+### 执行要求
+
+- **必须**：每次代码修改后，立即运行测试
+- **必须**：如果测试失败，修复代码直到所有测试通过
+- **禁止**：提交未通过测试的代码
+- **禁止**：在测试未通过的情况下继续开发
+
+### 工作流程
+
+1. 编写或修改代码
+2. **立即**运行测试
+3. 如果测试失败，修复代码
+4. 重复步骤 2-3，直到所有测试通过
+5. 确认所有测试通过后，才能提交代码
+
+## 你必须使用的测试框架
+
+### Google Test (gtest)（推荐使用）
+
+**安装方式：**
+
+- 使用包管理器安装（如 `apt-get install libgtest-dev`）
+- 或从源码编译安装
+
+**CMake 构建和运行：**
+
+```bash
+mkdir build && cd build
+cmake ..
+make
+./test_runner              # 运行所有测试
+./test_runner --gtest_filter=TestClass.* # 运行特定测试
+```
+
+**直接编译运行：**
+
+```bash
+g++ -std=c++17 test.cpp -lgtest -lgtest_main -pthread
+./a.out
+```
+
+### Catch2
+
+**安装方式：**
+
+- 下载单头文件版本
+- 或使用包管理器安装
+
+**编译运行：**
+
+```bash
+g++ -std=c++17 test.cpp -o test
+./test
+```
+
+## 你必须编写的测试示例
+
+### Google Test 测试格式
+
+```cpp
+// test/calculator_test.cpp
+#include <gtest/gtest.h>
+#include "../src/calculator.h"
+
+TEST(CalculatorTest, Add) {
+    Calculator calc;
+    EXPECT_EQ(5, calc.add(2, 3));
+}
+
+TEST(CalculatorTest, DivideByZero) {
+    Calculator calc;
+    EXPECT_THROW(calc.divide(10, 0), std::invalid_argument);
+}
+```
+
+### Catch2 测试格式
+
+```cpp
+// test/calculator_test.cpp
+#include <catch2/catch.hpp>
+#include "../src/calculator.h"
+
+TEST_CASE("Calculator add", "[calculator]") {
+    Calculator calc;
+    REQUIRE(calc.add(2, 3) == 5);
+}
+```
+
+## 断言宏使用规范
+
+### Google Test 断言
+
+- **必须**：使用 `EXPECT_*` 进行非致命断言（测试继续执行）
+- **必须**：使用 `ASSERT_*` 进行致命断言（测试立即终止）
+- **常用断言**：`EXPECT_EQ`, `ASSERT_EQ`, `EXPECT_THROW`, `ASSERT_THROW`
+
+### Catch2 断言
+
+- **必须**：使用 `REQUIRE` 进行致命断言
+- **必须**：使用 `CHECK` 进行非致命断言
+
+## 测试执行检查清单
+
+在提交代码前，你必须确认：
+
+- [ ] **编写完成后立即运行了测试**
+- [ ] **所有测试都通过了**
+- [ ] **如果测试失败，已修复代码直到通过**
+- [ ] 测试覆盖了正常情况
+- [ ] 测试覆盖了边界情况
+- [ ] 测试覆盖了异常情况
+- [ ] 使用了适当的断言宏（EXPECT_EQ, ASSERT_EQ 等）