mirror of
https://github.com/Palm1r/QodeAssist.git
synced 2026-02-24 07:53:01 -05:00
Compare commits
6 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| e836b86569 | |||
| 288fefebe5 | |||
| 528badbf1e | |||
| b789e42602 | |||
| 4bf955462f | |||
| 5b99e68e53 |
@ -55,6 +55,7 @@ add_qtc_plugin(QodeAssist
|
|||||||
templates/Llama2.hpp
|
templates/Llama2.hpp
|
||||||
templates/Claude.hpp
|
templates/Claude.hpp
|
||||||
templates/OpenAI.hpp
|
templates/OpenAI.hpp
|
||||||
|
templates/CodeLlamaQMLFim.hpp
|
||||||
providers/Providers.hpp
|
providers/Providers.hpp
|
||||||
providers/OllamaProvider.hpp providers/OllamaProvider.cpp
|
providers/OllamaProvider.hpp providers/OllamaProvider.cpp
|
||||||
providers/LMStudioProvider.hpp providers/LMStudioProvider.cpp
|
providers/LMStudioProvider.hpp providers/LMStudioProvider.cpp
|
||||||
|
|||||||
@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"Id" : "qodeassist",
|
"Id" : "qodeassist",
|
||||||
"Name" : "QodeAssist",
|
"Name" : "QodeAssist",
|
||||||
"Version" : "0.4.10",
|
"Version" : "0.4.12",
|
||||||
"Vendor" : "Petr Mironychev",
|
"Vendor" : "Petr Mironychev",
|
||||||
"VendorId" : "petrmironychev",
|
"VendorId" : "petrmironychev",
|
||||||
"Copyright" : "(C) ${IDE_COPYRIGHT_YEAR} Petr Mironychev, (C) ${IDE_COPYRIGHT_YEAR} The Qt Company Ltd",
|
"Copyright" : "(C) ${IDE_COPYRIGHT_YEAR} Petr Mironychev, (C) ${IDE_COPYRIGHT_YEAR} The Qt Company Ltd",
|
||||||
|
|||||||
68
README.md
68
README.md
@ -13,6 +13,15 @@
|
|||||||
> - The QodeAssist developer bears no responsibility for any charges incurred
|
> - The QodeAssist developer bears no responsibility for any charges incurred
|
||||||
> - Please carefully review the provider's pricing and your account settings before use
|
> - Please carefully review the provider's pricing and your account settings before use
|
||||||
|
|
||||||
|
⚠️ **Commercial Support and Custom Development**
|
||||||
|
> The QodeAssist developer offers commercial services for:
|
||||||
|
> - Adapting the plugin for specific Qt Creator versions
|
||||||
|
> - Custom development for particular operating systems
|
||||||
|
> - Integration with specific language models
|
||||||
|
> - Implementing custom features and modifications
|
||||||
|
>
|
||||||
|
> For commercial inquiries, please contact: qodeassist.dev@pm.me
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
1. [Overview](#overview)
|
1. [Overview](#overview)
|
||||||
2. [Install plugin to QtCreator](#install-plugin-to-qtcreator)
|
2. [Install plugin to QtCreator](#install-plugin-to-qtcreator)
|
||||||
@ -20,19 +29,25 @@
|
|||||||
4. [Configure for OpenAI](#configure-for-openai)
|
4. [Configure for OpenAI](#configure-for-openai)
|
||||||
5. [Configure for using Ollama](#configure-for-using-ollama)
|
5. [Configure for using Ollama](#configure-for-using-ollama)
|
||||||
6. [System Prompt Configuration](#system-prompt-configuration)
|
6. [System Prompt Configuration](#system-prompt-configuration)
|
||||||
7. [Template-Model Compatibility](#template-model-compatibility)
|
7. [File Context Features](#file-context-features)
|
||||||
8. [QtCreator Version Compatibility](#qtcreator-version-compatibility)
|
8. [Template-Model Compatibility](#template-model-compatibility)
|
||||||
9. [Development Progress](#development-progress)
|
9. [QtCreator Version Compatibility](#qtcreator-version-compatibility)
|
||||||
10. [Hotkeys](#hotkeys)
|
10. [Development Progress](#development-progress)
|
||||||
11. [Troubleshooting](#troubleshooting)
|
11. [Hotkeys](#hotkeys)
|
||||||
12. [Support the Development](#support-the-development-of-qodeassist)
|
12. [Troubleshooting](#troubleshooting)
|
||||||
13. [How to Build](#how-to-build)
|
13. [Support the Development](#support-the-development-of-qodeassist)
|
||||||
|
14. [How to Build](#how-to-build)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
- AI-powered code completion
|
- AI-powered code completion
|
||||||
- Chat functionality:
|
- Chat functionality:
|
||||||
- Side and Bottom panels
|
- Side and Bottom panels
|
||||||
|
- Chat history autosave and restore
|
||||||
|
- Token usage monitoring and management
|
||||||
|
- Attach files for one-time code analysis
|
||||||
|
- Link files for persistent context with auto update in conversations
|
||||||
|
- Automatic syncing with open editor files (optional)
|
||||||
- Support for multiple LLM providers:
|
- Support for multiple LLM providers:
|
||||||
- Ollama
|
- Ollama
|
||||||
- OpenAI
|
- OpenAI
|
||||||
@ -63,9 +78,15 @@
|
|||||||
<img width="326" alt="QodeAssistBottomPanel" src="https://github.com/user-attachments/assets/4cc64c23-a294-4df8-9153-39ad6fdab34b">
|
<img width="326" alt="QodeAssistBottomPanel" src="https://github.com/user-attachments/assets/4cc64c23-a294-4df8-9153-39ad6fdab34b">
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Automatic syncing with open editor files: (click to expand)</summary>
|
||||||
|
<img width="600" alt="OpenedDocumentsSync" src="https://github.com/user-attachments/assets/08efda2f-dc4d-44c3-927c-e6a975090d2f">
|
||||||
|
</details>
|
||||||
|
|
||||||
## Install plugin to QtCreator
|
## Install plugin to QtCreator
|
||||||
1. Install Latest Qt Creator
|
1. Install Latest Qt Creator
|
||||||
2. Download the QodeAssist plugin for your Qt Creator
|
2. Download the QodeAssist plugin for your Qt Creator
|
||||||
|
- Remove old version plugin if already was installed
|
||||||
3. Launch Qt Creator and install the plugin:
|
3. Launch Qt Creator and install the plugin:
|
||||||
- Go to:
|
- Go to:
|
||||||
- MacOS: Qt Creator -> About Plugins...
|
- MacOS: Qt Creator -> About Plugins...
|
||||||
@ -136,6 +157,39 @@ You're all set! QodeAssist is now ready to use in Qt Creator.
|
|||||||
|
|
||||||
The plugin comes with default system prompts optimized for chat and instruct models, as these currently provide better results for code assistance. If you prefer using FIM (Fill-in-Middle) models, you can easily customize the system prompt in the settings.
|
The plugin comes with default system prompts optimized for chat and instruct models, as these currently provide better results for code assistance. If you prefer using FIM (Fill-in-Middle) models, you can easily customize the system prompt in the settings.
|
||||||
|
|
||||||
|
## File Context Features
|
||||||
|
|
||||||
|
QodeAssist provides two powerful ways to include source code files in your chat conversations: Attachments and Linked Files. Each serves a distinct purpose and helps provide better context for the AI assistant.
|
||||||
|
|
||||||
|
### Attached Files
|
||||||
|
|
||||||
|
Attachments are designed for one-time code analysis and specific queries:
|
||||||
|
- Files are included only in the current message
|
||||||
|
- Content is discarded after the message is processed
|
||||||
|
- Ideal for:
|
||||||
|
- Getting specific feedback on code changes
|
||||||
|
- Code review requests
|
||||||
|
- Analyzing isolated code segments
|
||||||
|
- Quick implementation questions
|
||||||
|
- Files can be attached using the paperclip icon in the chat interface
|
||||||
|
- Multiple files can be attached to a single message
|
||||||
|
|
||||||
|
### Linked Files
|
||||||
|
|
||||||
|
Linked files provide persistent context throughout the conversation:
|
||||||
|
|
||||||
|
- Files remain accessible for the entire chat session
|
||||||
|
- Content is included in every message exchange
|
||||||
|
- Files are automatically refreshed - always using latest content from disk
|
||||||
|
- Perfect for:
|
||||||
|
- Long-term refactoring discussions
|
||||||
|
- Complex architectural changes
|
||||||
|
- Multi-file implementations
|
||||||
|
- Maintaining context across related questions
|
||||||
|
- Can be managed using the link icon in the chat interface
|
||||||
|
- Supports automatic syncing with open editor files (can be enabled in settings)
|
||||||
|
- Files can be added/removed at any time during the conversation
|
||||||
|
|
||||||
## Template-Model Compatibility
|
## Template-Model Compatibility
|
||||||
|
|
||||||
| Template | Compatible Models | Purpose |
|
| Template | Compatible Models | Purpose |
|
||||||
|
|||||||
@ -159,11 +159,19 @@ void PluginUpdater::handleDownloadFinished()
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
QString downloadPath = QStandardPaths::writableLocation(QStandardPaths::DownloadLocation);
|
QString downloadPath = QStandardPaths::writableLocation(QStandardPaths::DownloadLocation)
|
||||||
|
+ QDir::separator() + "QodeAssist_v" + m_lastUpdateInfo.version;
|
||||||
|
QDir().mkpath(downloadPath);
|
||||||
|
|
||||||
|
QString filePath = downloadPath + QDir::separator() + m_lastUpdateInfo.fileName;
|
||||||
|
|
||||||
|
if (QFile::exists(filePath)) {
|
||||||
|
emit downloadError(tr("Update file already exists: %1").arg(filePath));
|
||||||
|
reply->deleteLater();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
QString filePath = downloadPath + "/" + m_lastUpdateInfo.fileName;
|
|
||||||
QFile file(filePath);
|
QFile file(filePath);
|
||||||
|
|
||||||
if (!file.open(QIODevice::WriteOnly)) {
|
if (!file.open(QIODevice::WriteOnly)) {
|
||||||
emit downloadError(tr("Could not save the update file"));
|
emit downloadError(tr("Could not save the update file"));
|
||||||
reply->deleteLater();
|
reply->deleteLater();
|
||||||
@ -174,7 +182,6 @@ void PluginUpdater::handleDownloadFinished()
|
|||||||
file.close();
|
file.close();
|
||||||
|
|
||||||
emit downloadFinished(filePath);
|
emit downloadFinished(filePath);
|
||||||
|
|
||||||
reply->deleteLater();
|
reply->deleteLater();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@ -19,6 +19,11 @@
|
|||||||
|
|
||||||
#include "UpdateDialog.hpp"
|
#include "UpdateDialog.hpp"
|
||||||
|
|
||||||
|
#include <coreplugin/icore.h>
|
||||||
|
#include <extensionsystem/pluginmanager.h>
|
||||||
|
#include <extensionsystem/pluginspec.h>
|
||||||
|
#include <QDesktopServices>
|
||||||
|
|
||||||
namespace QodeAssist {
|
namespace QodeAssist {
|
||||||
|
|
||||||
UpdateDialog::UpdateDialog(QWidget *parent)
|
UpdateDialog::UpdateDialog(QWidget *parent)
|
||||||
@ -166,7 +171,32 @@ void UpdateDialog::updateProgress(qint64 received, qint64 total)
|
|||||||
void UpdateDialog::handleDownloadFinished(const QString &path)
|
void UpdateDialog::handleDownloadFinished(const QString &path)
|
||||||
{
|
{
|
||||||
m_progress->setVisible(false);
|
m_progress->setVisible(false);
|
||||||
QMessageBox::information(this, tr("Update Successful"), tr("Update has been downloaded."));
|
|
||||||
|
QMessageBox msgBox(this);
|
||||||
|
msgBox.setWindowTitle(tr("Update Downloaded"));
|
||||||
|
msgBox.setText(tr("The update has been downloaded successfully.\n"
|
||||||
|
"Would you like to close Qt Creator now and open the plugin folder?"));
|
||||||
|
msgBox.setInformativeText(tr("To complete the update:\n\n"
|
||||||
|
"1. Close Qt Creator completely\n"
|
||||||
|
"2. Navigate to the plugin folder\n"
|
||||||
|
"3. Remove the old version of QodeAssist plugin\n"
|
||||||
|
"4. Install plugin as usual via About plugin menu"));
|
||||||
|
msgBox.setStandardButtons(QMessageBox::Yes | QMessageBox::No);
|
||||||
|
msgBox.setDefaultButton(QMessageBox::Yes);
|
||||||
|
msgBox.setIcon(QMessageBox::Information);
|
||||||
|
|
||||||
|
if (msgBox.exec() == QMessageBox::Yes) {
|
||||||
|
const auto pluginSpecs = ExtensionSystem::PluginManager::plugins();
|
||||||
|
for (const ExtensionSystem::PluginSpec *spec : pluginSpecs) {
|
||||||
|
if (spec->name() == QLatin1String("QodeAssist")) {
|
||||||
|
const auto pluginPath = spec->filePath().path();
|
||||||
|
QFileInfo fileInfo(pluginPath);
|
||||||
|
QDesktopServices::openUrl(QUrl::fromLocalFile(fileInfo.absolutePath()));
|
||||||
|
Core::ICore::exit();
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
accept();
|
accept();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
48
templates/CodeLlamaQMLFim.hpp
Normal file
48
templates/CodeLlamaQMLFim.hpp
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (C) 2024 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/>.
|
||||||
|
*/
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#include "llmcore/PromptTemplate.hpp"
|
||||||
|
|
||||||
|
namespace QodeAssist::Templates {
|
||||||
|
|
||||||
|
class CodeLlamaQMLFim : public LLMCore::PromptTemplate
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
LLMCore::TemplateType type() const override { return LLMCore::TemplateType::Fim; }
|
||||||
|
QString name() const override { return "CodeLlama QML FIM"; }
|
||||||
|
QString promptTemplate() const override { return "<SUF>%1<PRE>%2<MID>"; }
|
||||||
|
QStringList stopWords() const override
|
||||||
|
{
|
||||||
|
return QStringList() << "<SUF>" << "<PRE>" << "</PRE>" << "</SUF>" << "< EOT >" << "\\end"
|
||||||
|
<< "<MID>" << "</MID>" << "##";
|
||||||
|
}
|
||||||
|
void prepareRequest(QJsonObject &request, const LLMCore::ContextData &context) const override
|
||||||
|
{
|
||||||
|
QString formattedPrompt = promptTemplate().arg(context.suffix, context.prefix);
|
||||||
|
request["prompt"] = formattedPrompt;
|
||||||
|
}
|
||||||
|
QString description() const override
|
||||||
|
{
|
||||||
|
return "The message will contain the following tokens: <SUF>%1<PRE>%2<MID>";
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
} // namespace QodeAssist::Templates
|
||||||
@ -25,6 +25,7 @@
|
|||||||
#include "templates/ChatML.hpp"
|
#include "templates/ChatML.hpp"
|
||||||
#include "templates/Claude.hpp"
|
#include "templates/Claude.hpp"
|
||||||
#include "templates/CodeLlamaFim.hpp"
|
#include "templates/CodeLlamaFim.hpp"
|
||||||
|
#include "templates/CodeLlamaQMLFim.hpp"
|
||||||
#include "templates/CustomFimTemplate.hpp"
|
#include "templates/CustomFimTemplate.hpp"
|
||||||
#include "templates/DeepSeekCoderFim.hpp"
|
#include "templates/DeepSeekCoderFim.hpp"
|
||||||
#include "templates/Llama2.hpp"
|
#include "templates/Llama2.hpp"
|
||||||
@ -53,6 +54,7 @@ inline void registerTemplates()
|
|||||||
templateManager.registerTemplate<Llama2>();
|
templateManager.registerTemplate<Llama2>();
|
||||||
templateManager.registerTemplate<Claude>();
|
templateManager.registerTemplate<Claude>();
|
||||||
templateManager.registerTemplate<OpenAI>();
|
templateManager.registerTemplate<OpenAI>();
|
||||||
|
templateManager.registerTemplate<CodeLlamaQMLFim>();
|
||||||
}
|
}
|
||||||
|
|
||||||
} // namespace QodeAssist::Templates
|
} // namespace QodeAssist::Templates
|
||||||
|
|||||||
Reference in New Issue
Block a user