Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yangbobo2021 committed Jul 19, 2024
1 parent 7c30ca2 commit 4a3b29c
Show file tree
Hide file tree
Showing 10 changed files with 103 additions and 12 deletions.
1 change: 1 addition & 0 deletions merico/aider/command.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ workflow_python:
version: 3.11.0
dependencies: requirements.txt
input: required
help: README.md
steps:
- run: $workflow_python $command_path/command.py "$input"
20 changes: 20 additions & 0 deletions merico/aider/files/add/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### aider.files.add

添加文件到aider处理列表中。

用法:
/aider.files.add <file_path>

参数:
- <file_path>: 要添加的文件路径(必需)

描述:
这个命令将指定的文件添加到aider的处理列表中。添加后,该文件将被包含在后续的aider操作中。

注意:
- 文件路径必须是有效的格式。
- 如果文件已经在列表中,它不会被重复添加。
- 添加成功后,会显示当前aider文件列表。

示例:
/aider.files.add src/main.py
1 change: 1 addition & 0 deletions merico/aider/files/add/command.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
description: "add files to aider"
input: required
help: README.md
steps:
- run: $devchat_python $command_path/command.py "$input"
16 changes: 16 additions & 0 deletions merico/aider/files/list/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
### aider.files.list

列出当前在aider处理列表中的所有文件。

用法:
/aider.files.list

描述:
这个命令会显示所有已添加到aider处理列表中的文件。它提供了一个当前aider正在处理的文件的概览。

注意:
- 如果没有文件被添加到aider,会显示相应的消息。
- 文件按字母顺序排序显示。

示例:
/aider.files.list
1 change: 1 addition & 0 deletions merico/aider/files/list/command.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
description: "list files in aider"
help: README.md
steps:
- run: $devchat_python $command_path/command.py
20 changes: 20 additions & 0 deletions merico/aider/files/remove/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### aider.files.remove

从aider处理列表中移除指定的文件。

用法:
/aider.files.remove <file_path>

参数:
- <file_path>: 要移除的文件路径(必需)

描述:
这个命令从aider的处理列表中移除指定的文件。移除后,该文件将不再被包含在后续的aider操作中。

注意:
- 文件路径必须是有效的格式。
- 如果指定的文件不在列表中,会显示相应的消息。
- 移除成功后,会显示更新后的aider文件列表。

示例:
/aider.files.remove src/main.py
1 change: 1 addition & 0 deletions merico/aider/files/remove/command.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
description: "remove files from aider"
input: required
help: README.md
steps:
- run: $devchat_python $command_path/command.py "$input"
25 changes: 20 additions & 5 deletions merico/ask_issue/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
### 操作指南
### ask_issue

ask_issue工作流命令使用步骤如下:
1. 选中Sonar或者Lint错误提示对应行。
2. 输入`/ask_issue`命令。
3. 开始生成问题描述解释以及对应的解决办法,等待生成结束。
自动修复代码中的lint错误。

用法:
/ask_issue

描述:
这个命令帮助开发者自动修复代码中的lint错误。它使用AI分析选中的代码行,识别lint问题,并提供修复建议。

步骤:
1. 在IDE中选择包含lint错误的代码行。
2. 运行 /ask_issue 命令。
3. 命令会自动获取选中的代码、相关的lint诊断信息,并调用AI生成修复方案。
4. AI会提供问题解释和修复后的代码片段。

注意事项:
- 确保在运行命令前已选择包含lint错误的代码行。
- 命令会优先处理SonarLint诊断的问题。
- AI生成的修复方案会包含问题解释和修改后的代码。
- 修改后的代码会以Markdown格式展示,包含足够的上下文信息。
28 changes: 22 additions & 6 deletions merico/fix_issue/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,23 @@
### 操作指南
### fix_issue

fix_issue工作流命令使用步骤如下:
1. 选中Sonar或者Lint错误提示对应行。
2. 输入`/fix_issue`命令。
3. 开始生成问题描述解释以及对应的解决办法,等待生成结束。
4. 自动弹出Diff View,选择是否接受修改。
自动修复代码中的lint错误。

用法:
/fix_issue

描述:
这个命令帮助开发者自动修复代码中的lint错误。它使用AI分析选中的代码行,识别lint问题,并提供修复建议。然后,它会自动应用这些修复建议,并在IDE中显示更改。

步骤:
1. 在IDE中选择包含lint错误的代码行。
2. 运行 /fix_issue 命令。
3. 命令会自动获取选中的代码、相关的lint诊断信息,并调用AI生成修复方案。
4. AI会提供问题解释和修复后的代码。
5. 命令会自动应用这些修复,并在IDE中显示更改。

注意事项:
- 确保在运行命令前已选择包含lint错误的代码行。
- 命令会优先处理SonarLint诊断的问题。
- 如果安装了aider Python,命令会使用aider来执行AI访问和应用更改。
- 如果没有安装aider Python,命令会使用默认实现来生成和应用修复。
- 所有的更改都会在IDE中以Diff View的形式展示,你可以在查看后决定是否接受这些更改。
2 changes: 1 addition & 1 deletion merico/fix_issue/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ def get_aider_python_path():
if os.path.exists(GLOBAL_CONFIG_PATH):
with open(GLOBAL_CONFIG_PATH, "r", encoding="utf-8") as f:
config = json.load(f)
return config.get("aider_python")
return config.get("aider_python2")
return None


Expand Down

0 comments on commit 4a3b29c

Please sign in to comment.