mirror/QodeAssist
1
0
Fork 0
mirror of https://github.com/Palm1r/QodeAssist.git synced 2025-11-13 05:22:49 -05:00
Code Issues Packages Projects Releases Wiki Activity

revert: Remove edit file tool (#245)

Browse Source
This commit is contained in:
Petr Mironychev
2025-10-28 16:39:49 +01:00
committed by GitHub
parent dfd9979450
commit d483ca372d
9 changed files with 2 additions and 1110 deletions
Download Patch File Download Diff File Expand all files Collapse all files

262
tools/EditFileTool.cpp
View File

@ -1,262 +0,0 @@
/*
* Copyright (C) 2025 Petr Mironychev
*
* This file is part of QodeAssist.
*
* QodeAssist is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* QodeAssist is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with QodeAssist. If not, see <https://www.gnu.org/licenses/>.
*/
#include "EditFileTool.hpp"
#include "ToolExceptions.hpp"
#include <context/ProjectUtils.hpp>
#include <coreplugin/documentmanager.h>
#include <logger/Logger.hpp>
#include <projectexplorer/project.h>
#include <projectexplorer/projectmanager.h>
#include <settings/GeneralSettings.hpp>
#include <QDateTime>
#include <QDir>
#include <QFile>
#include <QFileInfo>
#include <QJsonArray>
#include <QJsonDocument>
#include <QJsonObject>
#include <QRandomGenerator>
#include <QTextStream>
#include <QtConcurrent>
namespace QodeAssist::Tools {
EditFileTool::EditFileTool(QObject *parent)
: BaseTool(parent)
, m_ignoreManager(new Context::IgnoreManager(this))
{}
QString EditFileTool::name() const
{
return "edit_file";
}
QString EditFileTool::stringName() const
{
return {"Editing file"};
}
QString EditFileTool::description() const
{
return "Edit project files with two modes: REPLACE (find and replace text) or INSERT_AFTER "
"(insert after specific line). All text parameters must be complete lines with trailing "
"newlines (\\n auto-added if missing).\n"
"\n"
"REPLACE MODE:\n"
"- Finds search_text and replaces with new_text\n"
"- Context verification: line_before/line_after searched NEAR search_text (~500 chars), "
"not necessarily adjacent\n"
"- Both context lines: most precise matching\n"
"- One context line: directional search (before/after)\n"
"- No context: first occurrence\n"
"\n"
"INSERT_AFTER MODE:\n"
"- Inserts new_text RIGHT AFTER line_before\n"
"- Empty line_before: inserts at file start (useful for empty files)\n"
"- line_after: must IMMEDIATELY follow line_before for verification\n"
"- search_text is ignored\n"
"\n"
"BEST PRACTICES:\n"
"- Sequential additions: use INSERT_AFTER with previous addition as line_before\n"
"- Provide stable context lines that won't change\n"
"- Make atomic edits (one comprehensive change vs multiple small ones)";
}
QJsonObject EditFileTool::getDefinition(LLMCore::ToolSchemaFormat format) const
{
QJsonObject properties;
QJsonObject modeProperty;
modeProperty["type"] = "string";
modeProperty["enum"] = QJsonArray({"replace", "insert_after"});
modeProperty["description"] = "Edit mode: 'replace' (replace search_text with new_text), "
"'insert_after' (insert new_text after line_before)";
properties["mode"] = modeProperty;
QJsonObject filepathProperty;
filepathProperty["type"] = "string";
filepathProperty["description"] = "The absolute or relative file path to edit";
properties["filepath"] = filepathProperty;
QJsonObject newTextProperty;
newTextProperty["type"] = "string";
newTextProperty["description"] = "Complete line(s) to insert/replace/append. Trailing newline (\\n) auto-added if missing. "
"Example: 'int main(int argc, char *argv[]) {\\n' or 'void foo();\\nvoid bar();\\n'";
properties["new_text"] = newTextProperty;
QJsonObject searchTextProperty;
searchTextProperty["type"] = "string";
searchTextProperty["description"]
= "Complete line(s) to search for and replace. Trailing newline (\\n) auto-added if missing. "
"REQUIRED for 'replace' mode, IGNORED for other modes. "
"Example: 'int main() {\\n' or 'void foo();\\n'";
properties["search_text"] = searchTextProperty;
QJsonObject lineBeforeProperty;
lineBeforeProperty["type"] = "string";
lineBeforeProperty["description"] = "Complete line for context verification. Trailing newline (\\n) auto-added if missing. "
"Usage depends on mode:\n"
"- 'replace': OPTIONAL, searched BEFORE search_text (within ~500 chars, not necessarily adjacent)\n"
"- 'insert_after': OPTIONAL, new_text inserted RIGHT AFTER this line. "
"If empty, inserts at the beginning of the file (useful for empty files)\n"
"Example: 'class Movie {\\n' or '#include <iostream>\\n'";
properties["line_before"] = lineBeforeProperty;
QJsonObject lineAfterProperty;
lineAfterProperty["type"] = "string";
lineAfterProperty["description"] = "Complete line for context verification. Trailing newline (\\n) auto-added if missing. "
"Usage depends on mode:\n"
"- 'replace': OPTIONAL, searched AFTER search_text (within ~500 chars, not necessarily adjacent)\n"
"- 'insert_after': OPTIONAL, must IMMEDIATELY follow line_before for verification\n"
"Example: '}\\n' or 'public:\\n'";
properties["line_after"] = lineAfterProperty;
QJsonObject definition;
definition["type"] = "object";
definition["properties"] = properties;
QJsonArray required;
required.append("mode");
required.append("filepath");
required.append("new_text");
definition["required"] = required;
switch (format) {
case LLMCore::ToolSchemaFormat::OpenAI:
return customizeForOpenAI(definition);
case LLMCore::ToolSchemaFormat::Claude:
return customizeForClaude(definition);
case LLMCore::ToolSchemaFormat::Ollama:
return customizeForOllama(definition);
case LLMCore::ToolSchemaFormat::Google:
return customizeForGoogle(definition);
}
return definition;
}
LLMCore::ToolPermissions EditFileTool::requiredPermissions() const
{
return LLMCore::ToolPermissions(LLMCore::ToolPermission::FileSystemRead)
| LLMCore::ToolPermissions(LLMCore::ToolPermission::FileSystemWrite);
}
QFuture<QString> EditFileTool::executeAsync(const QJsonObject &input)
{
return QtConcurrent::run([this, input]() -> QString {
QString mode = input["mode"].toString();
if (mode.isEmpty()) {
throw ToolInvalidArgument("Error: mode parameter is required. Must be one of: 'replace', 'insert_after'");
}
if (mode != "replace" && mode != "insert_after") {
throw ToolInvalidArgument(QString("Error: invalid mode '%1'. Must be one of: 'replace', 'insert_after'").arg(mode));
}
QString inputFilepath = input["filepath"].toString();
if (inputFilepath.isEmpty()) {
throw ToolInvalidArgument("Error: filepath parameter is required");
}
QString newText = input["new_text"].toString();
if (newText.isEmpty()) {
throw ToolInvalidArgument("Error: new_text parameter is required");
}
QString searchText = input["search_text"].toString();
QString lineBefore = input["line_before"].toString();
QString lineAfter = input["line_after"].toString();
if (mode == "replace" && searchText.isEmpty()) {
throw ToolInvalidArgument("Error: search_text is required for 'replace' mode");
}
// Normalize text fields: ensure trailing newline if not empty
// This handles cases where LLM forgets to add \n
auto normalizeText = [](QString &text) {
if (!text.isEmpty() && !text.endsWith('\n')) {
LOG_MESSAGE(QString("EditFileTool: normalizing text, adding trailing newline (length: %1)").arg(text.length()));
text += '\n';
}
};
normalizeText(newText);
if (!searchText.isEmpty()) normalizeText(searchText);
if (!lineBefore.isEmpty()) normalizeText(lineBefore);
if (!lineAfter.isEmpty()) normalizeText(lineAfter);
QString filePath;
QFileInfo fileInfo(inputFilepath);
if (fileInfo.isAbsolute()) {
filePath = inputFilepath;
} else {
auto projects = ProjectExplorer::ProjectManager::projects();
if (!projects.isEmpty() && projects.first()) {
QString projectDir = projects.first()->projectDirectory().toUrlishString();
filePath = QDir(projectDir).absoluteFilePath(inputFilepath);
} else {
filePath = QFileInfo(inputFilepath).absoluteFilePath();
}
}
if (!QFileInfo::exists(filePath)) {
throw ToolRuntimeError(QString("Error: File '%1' does not exist").arg(filePath));
}
bool isInProject = Context::ProjectUtils::isFileInProject(filePath);
if (!isInProject) {
const auto &settings = Settings::generalSettings();
if (!settings.allowAccessOutsideProject()) {
throw ToolRuntimeError(
QString("Error: File '%1' is outside the project scope. "
"Enable 'Allow file access outside project' in settings to edit files outside project scope.")
.arg(filePath));
}
LOG_MESSAGE(QString("Editing file outside project scope: %1").arg(filePath));
}
auto project = isInProject ? ProjectExplorer::ProjectManager::projectForFile(
Utils::FilePath::fromString(filePath)) : nullptr;
if (project && m_ignoreManager->shouldIgnore(filePath, project)) {
throw ToolRuntimeError(
QString("Error: File '%1' is excluded by .qodeassistignore").arg(inputFilepath));
}
QJsonObject result;
result["type"] = "file_edit";
result["mode"] = mode;
result["filepath"] = filePath;
result["new_text"] = newText;
result["search_text"] = searchText;
result["line_before"] = lineBefore;
result["line_after"] = lineAfter;
QJsonDocument doc(result);
return QString("QODEASSIST_FILE_EDIT:%1")
.arg(QString::fromUtf8(doc.toJson(QJsonDocument::Compact)));
});
}
} // namespace QodeAssist::Tools