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

jarvis/jarvis_code_agent/rule_share_manager.py

@@ -0,0 +1,158 @@
+"""规则分享管理模块"""
+
+import glob
+import os
+
+from jarvis.jarvis_utils.output import PrettyOutput
+
+# -*- coding: utf-8 -*-
+import shutil
+from typing import Any
+from typing import Dict
+from typing import List
+from typing import Set
+
+import typer
+
+from jarvis.jarvis_agent import user_confirm
+from jarvis.jarvis_agent.share_manager import ShareManager
+from jarvis.jarvis_utils.config import get_central_rules_repo
+from jarvis.jarvis_utils.config import get_data_dir
+
+
+class RuleShareManager(ShareManager):
+    """规则分享管理器"""
+
+    def __init__(self):
+        central_repo = get_central_rules_repo()
+        if not central_repo:
+            PrettyOutput.auto_print("❌ 错误：未配置中心规则仓库（central_rules_repo）")
+            PrettyOutput.auto_print("ℹ️ 请在配置文件中设置中心规则仓库的Git地址")
+            raise typer.Exit(code=1)
+
+        super().__init__(central_repo, "central_rules_repo")
+
+    def get_resource_type(self) -> str:
+        """获取资源类型名称"""
+        return "规则"
+
+    def format_resource_display(self, resource: Dict[str, Any]) -> str:
+        """格式化资源显示"""
+        return f"{resource['rule_name']} ({resource['filename']})"
+
+    def get_existing_resources(self) -> Set[str]:
+        """获取中心仓库中已有的规则文件名"""
+        existing_rules = set()
+        # 检查 rules 目录中的文件
+        rules_dir = os.path.join(self.repo_path, "rules")
+        if os.path.exists(rules_dir):
+            for filepath in glob.glob(os.path.join(rules_dir, "*")):
+                if os.path.isfile(filepath):
+                    existing_rules.add(os.path.basename(filepath))
+        # 检查根目录下的文件（作为规则文件）
+        for filepath in glob.glob(os.path.join(self.repo_path, "*")):
+            if os.path.isfile(filepath) and not filepath.endswith(".yaml"):
+                existing_rules.add(os.path.basename(filepath))
+        return existing_rules
+
+    def get_local_resources(self) -> List[Dict[str, Any]]:
+        """获取本地规则
+
+        注意：只能共享默认rules目录（get_data_dir()/rules）中的规则，
+        不能共享配置的rules目录和项目rules目录中的规则。
+        """
+        # 获取中心仓库中已有的规则文件名
+        existing_rules = self.get_existing_resources()
+
+        # 只从默认数据目录的 rules 目录获取规则（不能共享配置的目录和项目rules）
+        local_rules_dir = os.path.join(get_data_dir(), "rules")
+        if not os.path.exists(local_rules_dir):
+            PrettyOutput.auto_print(f"⚠️ 本地规则目录不存在: {local_rules_dir}")
+            return []
+
+        # 收集本地规则文件（排除已存在的）
+        rule_files = []
+        for filepath in glob.glob(os.path.join(local_rules_dir, "*")):
+            if not os.path.isfile(filepath):
+                continue
+            filename = os.path.basename(filepath)
+            # 跳过已存在的文件
+            if filename in existing_rules:
+                continue
+
+            # 规则名称就是文件名
+            rule_name = filename
+            rule_files.append(
+                {
+                    "path": filepath,
+                    "filename": filename,
+                    "rule_name": rule_name,
+                }
+            )
+
+        return rule_files
+
+    def share_resources(self, resources: List[Dict[str, Any]]) -> List[str]:
+        """分享规则到中心仓库"""
+        # 确认操作
+        share_list = ["\n将要分享以下规则到中心仓库（注意：文件将被移动而非复制）："]
+        for rule in resources:
+            share_list.append(f"- {rule['rule_name']} ({rule['filename']})")
+        joined_list = "\n".join(share_list)
+        PrettyOutput.auto_print(f"⚠️ {joined_list}")
+
+        if not user_confirm("确认移动这些规则到中心仓库吗？（原文件将被删除）"):
+            return []
+
+        # 确保中心仓库有 rules 目录
+        rules_dir = os.path.join(self.repo_path, "rules")
+        if not os.path.exists(rules_dir):
+            os.makedirs(rules_dir, exist_ok=True)
+
+        # 移动选中的规则到中心仓库
+        moved_list = []
+        for rule in resources:
+            src_file = rule["path"]
+            dst_file = os.path.join(rules_dir, rule["filename"])
+            shutil.move(src_file, dst_file)  # 使用move而不是copy
+            moved_list.append(f"已移动: {rule['rule_name']}")
+
+        return moved_list
+
+    def run(self) -> None:
+        """执行规则分享流程"""
+        try:
+            # 更新中心仓库
+            self.update_central_repo()
+
+            # 获取本地资源
+            local_resources = self.get_local_resources()
+            if not local_resources:
+                PrettyOutput.auto_print(
+                    "⚠️ 没有找到新的规则文件（所有规则可能已存在于中心仓库）"
+                )
+                return
+
+            # 选择要分享的资源
+            selected_resources = self.select_resources(local_resources)
+            if not selected_resources:
+                return
+
+            # 分享资源
+            moved_list = self.share_resources(selected_resources)
+            if moved_list:
+                # 一次性显示所有移动结果
+                joined_moved = "\n".join(moved_list)
+                PrettyOutput.auto_print(f"✅ {joined_moved}")
+
+                # 提交并推送
+                self.commit_and_push(len(selected_resources))
+
+                PrettyOutput.auto_print("✅ 规则已成功分享到中心仓库！")
+                PrettyOutput.auto_print(
+                    f"ℹ️ 原文件已从 {os.path.join(get_data_dir(), 'rules')} 移动到中心仓库"
+                )
+
+        except Exception as e:
+            PrettyOutput.auto_print(f"❌ 分享规则时出错: {str(e)}")
+            raise typer.Exit(code=1)

jarvis/jarvis_code_agent/rules/clean_code.md

@@ -0,0 +1,144 @@
+# 整洁代码规则
+
+## 你必须遵守的核心原则
+
+### 1. 可读性优先原则（最高优先级）
+
+**执行要求：**
+
+- **必须**：代码是写给人看的，机器只是顺便执行
+- **必须**：使用有意义的变量名和函数名
+- **必须**：代码应该自解释，减少不必要的注释
+- **禁止**：使用无意义的变量名（如 `a`, `b`, `x`, `temp`）
+
+**命名要求：**
+
+- 变量名必须清楚表达其用途
+- 函数名必须清楚表达其功能
+- 类名必须清楚表达其职责
+
+### 2. 单一职责原则（必须遵守）
+
+**函数要求：**
+
+- **必须**：每个函数只做一件事
+- **必须**：函数名必须准确描述函数的功能
+- **禁止**：一个函数做多件不相关的事
+
+**类要求：**
+
+- **必须**：每个类只有一个改变的理由
+- **必须**：类的职责必须清晰明确
+- **禁止**：创建职责混乱的"上帝类"
+
+**代码要求：**
+
+- **必须**：保持函数和类的简洁
+- **必须**：如果函数或类变得复杂，必须拆分
+
+### 3. DRY 原则（禁止重复）
+
+**执行要求：**
+
+- **禁止**：编写重复代码
+- **必须**：提取公共逻辑到函数或类中
+- **必须**：使用配置而非硬编码
+- **必须**：识别并消除重复模式
+
+## 命名规范（必须遵守）
+
+### 变量和函数命名
+
+- **必须**：使用描述性的名称，避免缩写
+- **必须**：函数名应该是动词或动词短语（如 `calculateTotal`, `getUserById`）
+- **必须**：类名应该是名词或名词短语（如 `UserService`, `OrderProcessor`）
+- **必须**：布尔变量应该使用 is/has/can 等前缀（如 `isValid`, `hasPermission`, `canEdit`）
+- **禁止**：使用单字母变量名（除非是循环计数器）
+- **禁止**：使用误导性的名称
+
+### 常量命名
+
+- **必须**：常量应该使用全大写，单词间用下划线分隔（如 `MAX_RETRY_COUNT`, `DEFAULT_TIMEOUT`）
+- **必须**：魔法数字和字符串必须定义为常量
+
+## 函数设计规范（必须遵守）
+
+### 函数长度
+
+- **必须**：函数应该短小，最好不超过 20 行
+- **必须**：如果函数超过 20 行，考虑拆分
+- **必须**：函数应该只做一件事，做好一件事
+
+### 函数参数
+
+- **必须**：函数参数应该尽可能少，最好不超过 3 个
+- **必须**：如果参数超过 3 个，考虑使用对象或配置类
+- **禁止**：使用布尔参数控制函数行为（使用策略模式或函数重载）
+
+### 函数行为
+
+- **必须**：避免副作用，函数应该可预测
+- **必须**：函数应该返回一致的结果类型
+- **禁止**：函数既修改状态又返回值（除非明确需要）
+
+## 代码组织规范（必须遵守）
+
+### 代码布局
+
+- **必须**：相关代码应该放在一起
+- **必须**：使用空行分隔逻辑块
+- **必须**：保持一致的代码风格
+- **必须**：遵循项目的代码格式化规范
+
+### 代码清理
+
+- **必须**：删除未使用的代码
+- **必须**：删除过时的注释
+- **必须**：删除调试代码（如 `console.log`, `print` 语句）
+- **禁止**：提交包含调试代码的代码
+
+## 代码示例
+
+### ❌ 不好的实践
+
+```python
+def calc(x, y, z):
+    return x * y + z * 2
+
+def process(data):
+    # 处理数据
+    result = []
+    for i in data:
+        if i > 0:
+            result.append(i * 2)
+    return result
+```
+
+### ✅ 好的实践
+
+```python
+TAX_MULTIPLIER = 2.0
+
+def calculate_total_price(quantity: int, unit_price: float, tax_rate: float) -> float:
+    subtotal = quantity * unit_price
+    tax = subtotal * tax_rate
+    return subtotal + tax
+
+def filter_and_double_positive_numbers(numbers: list[int]) -> list[int]:
+    """过滤正数并翻倍"""
+    return [number * 2 for number in numbers if number > 0]
+```
+
+## 代码质量检查清单
+
+在提交代码前，你必须确认：
+
+- [ ] 所有变量和函数都有有意义的名称
+- [ ] 函数长度不超过 20 行（或合理长度）
+- [ ] 函数参数不超过 3 个
+- [ ] 没有重复代码
+- [ ] 没有未使用的代码和注释
+- [ ] 代码格式符合项目规范
+- [ ] 代码自解释，不需要过多注释
+- [ ] 每个函数只做一件事
+- [ ] 每个类职责单一

jarvis/jarvis_code_agent/rules/code_review.md

@@ -0,0 +1,115 @@
+# 代码审查规则
+
+## 你必须审查的方面
+
+### 1. 功能正确性（必须验证）
+
+**检查项：**
+
+- [ ] 代码是否实现了预期的功能？
+- [ ] 是否处理了所有边界情况？
+- [ ] 是否处理了所有异常情况？
+- [ ] 是否有潜在的安全漏洞？
+- [ ] 是否有明显的逻辑错误？
+
+**行动要求：**
+
+- 如果发现功能未实现或实现错误，必须指出并要求修复
+- 如果发现缺少边界或异常处理，必须要求补充
+- 如果发现安全漏洞，必须标记为阻塞性问题
+
+### 2. 代码质量（必须评估）
+
+**检查项：**
+
+- [ ] 代码是否清晰、易读？
+- [ ] 变量和函数命名是否准确、有意义？
+- [ ] 是否有重复代码需要重构？
+- [ ] 代码结构是否合理？
+
+**行动要求：**
+
+- 如果命名不清晰，必须建议更清晰的命名
+- 如果发现重复代码，必须建议提取公共逻辑
+- 如果代码结构混乱，必须建议重构
+
+### 3. 性能考虑（必须评估）
+
+**检查项：**
+
+- [ ] 是否存在明显的性能瓶颈？
+- [ ] 算法和数据结构选择是否合理？
+- [ ] 是否有不必要的计算或资源消耗？
+- [ ] 是否有内存泄漏风险？
+
+**行动要求：**
+
+- 如果发现性能问题，必须指出并提供优化建议
+- 如果算法选择不当，必须建议更合适的方案
+
+### 4. 可维护性（必须评估）
+
+**检查项：**
+
+- [ ] 代码结构是否合理？
+- [ ] 是否遵循项目的编码规范？
+- [ ] 是否有适当的注释和文档？
+- [ ] 代码是否易于理解和修改？
+
+**行动要求：**
+
+- 如果违反编码规范，必须要求修正
+- 如果缺少必要注释，必须要求补充
+- 如果代码难以理解，必须要求重构
+
+## 审查行为规范
+
+### 你必须遵守的原则
+
+- **必须**：保持建设性的反馈，关注代码而非个人
+- **必须**：提出具体、可操作的建议
+- **必须**：认可好的实践和设计
+- **必须**：及时响应审查请求
+- **禁止**：使用攻击性或贬低性的语言
+
+### 审查建议的格式
+
+- 明确指出问题所在（文件、行号、代码片段）
+- 说明问题的影响（为什么这是个问题）
+- 提供具体的修复建议（如何修复）
+- 如果是阻塞性问题，明确标记
+
+### 复杂变更的处理
+
+- 对于大型或复杂的变更，可以要求分阶段审查
+- 建议将复杂功能拆分为多个小的、可审查的提交
+
+## 审查检查清单
+
+在完成代码审查时，你必须确认：
+
+**功能层面：**
+
+- [ ] 代码实现了预期功能
+- [ ] 处理了边界和异常情况
+- [ ] 没有明显的 bug 或逻辑错误
+
+**质量层面：**
+
+- [ ] 代码符合项目的编码规范
+- [ ] 命名清晰、有意义
+- [ ] 没有重复代码
+- [ ] 代码结构合理
+
+**安全与性能：**
+
+- [ ] 没有安全漏洞
+- [ ] 性能可接受
+- [ ] 资源使用合理
+
+**可维护性：**
+
+- [ ] 有适当的错误处理
+- [ ] 有必要的测试覆盖
+- [ ] 代码注释清晰、准确
+- [ ] 代码易于理解和维护

jarvis/jarvis_code_agent/rules/documentation.md

@@ -0,0 +1,165 @@
+# 文档编写规则
+
+## 你必须遵守的文档原则
+
+### 1. 清晰性原则（必须遵守）
+
+**文档要求：**
+
+- **必须**：文档应该清晰、准确
+- **必须**：使用简单的语言
+- **必须**：避免不必要的技术术语
+- **必须**：必要时提供术语解释
+
+**写作要求：**
+
+- 使用短句，避免长句
+- 使用主动语态
+- 使用具体的例子
+- 避免模糊的表达
+
+### 2. 完整性原则（必须遵守）
+
+**文档要求：**
+
+- **必须**：文档应该覆盖所有重要功能
+- **必须**：包含使用示例
+- **必须**：说明限制和注意事项
+- **必须**：说明前提条件和依赖
+
+**内容要求：**
+
+- 功能描述：说明功能做什么
+- 使用方法：说明如何使用
+- 参数说明：说明所有参数
+- 返回值说明：说明返回值
+- 异常说明：说明可能抛出的异常
+- 示例代码：提供可运行的示例
+
+### 3. 及时性原则（必须遵守）
+
+**维护要求：**
+
+- **必须**：代码变更时同步更新文档
+- **必须**：文档应该反映当前实现
+- **必须**：删除过时的文档
+- **禁止**：文档与代码不一致
+
+**更新时机：**
+
+- 添加新功能时，立即更新文档
+- 修改功能时，同步更新文档
+- 删除功能时，删除相关文档
+- 定期检查文档与代码的一致性
+
+## 你必须编写的文档类型
+
+### 1. 代码注释（必须编写）
+
+**注释要求：**
+
+- **必须**：解释"为什么"，而不是"做什么"
+- **必须**：复杂逻辑必须有注释
+- **必须**：公共 API 必须有文档字符串
+- **禁止**：注释重复代码内容
+
+**注释内容：**
+
+- 业务逻辑说明
+- 算法选择原因
+- 特殊处理的原因
+- 已知问题和限制
+
+**文档字符串格式：**
+
+```python
+def calculate_total(items: list[Item], discount: float = 0.0) -> float:
+    """计算商品总价
+    
+    参数:
+        items: 商品列表，不能为空
+        discount: 折扣率，范围 0.0-1.0，默认 0.0
+    
+    返回:
+        计算后的总价，已应用折扣
+    
+    异常:
+        ValueError: 当 items 为空或 discount 不在有效范围时抛出
+    
+    示例:
+        >>> items = [Item(price=10.0), Item(price=20.0)]
+        >>> calculate_total(items, discount=0.1)
+        27.0
+    """
+    pass
+```
+
+### 2. README 文档（必须编写）
+
+**README 要求：**
+
+- **必须**：项目概述和快速开始
+- **必须**：安装和配置说明
+- **必须**：使用示例
+- **必须**：常见问题解答（如适用）
+
+**README 结构：**
+
+- 项目简介
+- 功能特性
+- 安装步骤
+- 配置说明
+- 快速开始
+- 使用示例
+- API 文档链接
+- 贡献指南
+- 许可证信息
+
+### 3. API 文档（必须编写）
+
+**API 文档要求：**
+
+- **必须**：函数签名和参数说明
+- **必须**：返回值说明
+- **必须**：使用示例
+- **必须**：异常说明
+
+**文档内容：**
+
+- 函数/方法签名
+- 参数类型和说明
+- 返回值类型和说明
+- 可能抛出的异常
+- 使用示例
+- 相关 API 链接
+
+## 文档编写检查清单
+
+在完成代码后，你必须确认：
+
+**代码注释：**
+
+- [ ] 所有公共 API 都有文档字符串
+- [ ] 复杂逻辑有注释说明
+- [ ] 注释解释了"为什么"而非"做什么"
+- [ ] 没有过时的注释
+
+**README：**
+
+- [ ] README 包含快速开始指南
+- [ ] 有安装和配置说明
+- [ ] 有使用示例
+- [ ] 文档清晰、易读
+
+**API 文档：**
+
+- [ ] 所有公共 API 都有文档
+- [ ] 参数和返回值都有说明
+- [ ] 有使用示例
+- [ ] 说明了可能抛出的异常
+
+**文档维护：**
+
+- [ ] 文档与代码保持同步
+- [ ] 删除了过时的文档
+- [ ] 文档反映了当前实现

jarvis/jarvis_code_agent/rules/generate_rules.md

@@ -0,0 +1,52 @@
+**深度分析当前项目实际代码结构**，从项目真实实践中提炼**8个核心维度**，为该项目生成**AI IDE专用的代码开发指导规则**。
+
+这些规则将作为AI IDE的智能提示和代码生成准则，指导AI在代码开发过程中遵循该项目的实际最佳实践。
+
+**代码分析方法：**
+
+基于**代码即真理**原则，通过深度阅读项目实际代码来总结规则：
+
+1. **深度代码阅读**：逐行分析项目核心代码文件，识别真实的编码模式和技术实现
+2. **从代码中提取规律**：基于实际代码样例总结命名约定、架构模式、设计哲学
+3. **代码验证模式**：通过现有代码中的成功实践，提炼可复用的开发模式
+4. **拒绝需求假设**：所有规则必须来源于实际代码验证，禁止基于需求臆测
+5. **代码驱动规则**：每个指导原则都必须有对应的代码样例支撑
+6. **持续代码洞察**：随着对代码理解的深入，动态优化规则体系
+
+**AI代码生成直接相关的8个核心维度**（基于真实代码验证）：
+
+### 1. 编码规范
+定义代码风格、命名约定、格式化标准，确保生成的代码符合项目既有风格
+
+### 2. 工程结构规范  
+定义目录布局、模块组织、文件放置规则，确保代码结构符合项目架构
+
+### 3. 错误处理规范
+定义异常处理策略、错误返回格式、日志记录标准，确保代码健壮性
+
+### 4. 数据处理规范
+定义数据验证、清洗、转换和存储标准，确保业务逻辑正确性
+
+### 5. 接口设计规范
+定义API命名、参数规范、响应格式、类型注解，确保接口一致性
+
+### 6. 性能与资源规范
+定义性能指标、内存管理、算法选择标准，确保代码效率
+
+### 7. 依赖管理规范
+定义导入顺序、第三方库使用、版本控制标准，确保依赖清晰
+
+### 8. 类型注解规范
+定义类型提示、泛型使用、接口契约标准，确保代码可维护性
+
+输出格式：每个文件使用Markdown格式，包含**AI开发指令**和**代码生成准则**，用简洁的机器学习友好的方式描述核心原则，避免冗长的人类阅读文档
+
+生成原则：
+
+- **AI指令优先**：规则应格式化为AI可直接理解和执行的指令，而非人类阅读文档
+- **代码生成导向**：每个指导原则都必须能转化为具体的代码生成决策依据
+- **必须基于项目实际代码验证**：每个维度都必须通过实际项目代码分析，确认其与项目开发模式的真实关联性
+- **严禁虚构内容**：绝对禁止生成任何未经项目代码验证的虚构信息、假设或推测，所有规则必须基于真实存在的代码实践
+- **项目特定性**：禁止通用建议，所有规则必须反映该项目的独特开发智慧
+- **上下文感知**：规则应帮助AI理解何时何地应用特定模式，而非提供固定模板
+- **简洁机器友好**：用结构化、标签化的方式表达核心概念，便于AI快速解析和应用