DevoxxGenieIDEAPlugin 项目使用说明

DevoxxGenieIDEAPlugin 项目使用说明

DevoxxGenieIDEAPlugin DevoxxGenie is a plugin for IntelliJ IDEA that uses local LLM's (Ollama, LMStudio, GPT4All and Jan) and Cloud based LLMs to help review, test, explain your project code. 项目地址: https://gitcode.com/gh_mirrors/de/DevoxxGenieIDEAPlugin

1. 项目目录结构及介绍

DevoxxGenieIDEAPlugin 项目的目录结构如下：

.
├── .github/              # 存放 GitHub Actions 工作流配置文件
│   └── workflows/
├── gradle/               # Gradle 构建脚本和相关配置文件
│   ├── wrapper/
│   └── build.gradle.kts
├── src/                  # 源代码目录
│   └── main/
├── .gitignore            # Git 忽略文件列表
├── DEVOXXGENIE.md        # 项目描述文件
├── LICENSE               # 项目许可证文件
├── README.md             # 项目自述文件
├── build.gradle.kts      # Gradle 构建脚本
├── gradle.properties      # Gradle 属性配置文件
├── gradlew               # Gradle 命令行工具
├── gradlew.bat           # Gradle 命令行工具（Windows 版本）
└── settings.gradle.kts   # Gradle 设置文件

• .github/: 存放与 GitHub 相关的配置文件，例如 GitHub Actions 的工作流文件。
• gradle/: 包含 Gradle 构建脚本和相关配置文件。
• src/: 源代码目录，所有 Java 源代码都放置在此目录下。
• .gitignore: 指定 Git 忽略的文件和目录。
• DEVOXXGENIE.md: 包含项目详细信息，LLM 配置和项目特定的提示信息。
• LICENSE: 项目使用的许可证信息。
• README.md: 包含项目的基本信息和安装使用指南。
• build.gradle.kts: Kotlin 编写的 Gradle 构建脚本。
• gradle.properties: Gradle 属性配置文件，可以定义全局属性。
• gradlew: Gradle Wrapper 的命令行工具，用于执行构建任务。
• gradlew.bat: Gradle Wrapper 的命令行工具（Windows 版本）。
• settings.gradle.kts: Gradle 设置文件，用于配置项目结构。

2. 项目的启动文件介绍

项目的启动主要是通过 Gradle 来完成。在项目的根目录下，可以通过以下命令启动项目：

./gradlew bootRun

此命令会编译项目源码，并启动一个 IntelliJ IDEA 插件开发环境。build.gradle.kts 文件中的 bootRun 任务负责这一过程。

3. 项目的配置文件介绍

项目中主要的配置文件是 build.gradle.kts 和 gradle.properties。

• build.gradle.kts: 这是项目的构建脚本，使用 Kotlin 语言编写。它定义了项目的依赖、构建任务和插件。以下是构建脚本的一些关键部分：

plugins {
    // 应用 IntelliJ Platform 插件
    id("org.jetbrains.intellij") version "1.3.2"
    // 应用 Kotlin JVM 插件
    kotlin("jvm") version "1.7.22"
}

// 定义 IntelliJ 平台的版本和插件类型
intelliJ {
    version = "2023.1"
    type = "IU"
}

// 定义插件的 ID、名称和版本
group = "com.devoxx"
version = "0.7.0"
artifactId = "DevoxxGenie"

// 配置依赖项
repositories {
    mavenCentral()
}

dependencies {
    // 添加 Kotlin 标准库依赖
    implementation(kotlin("stdlib"))
    // 添加 IntelliJ API 依赖
    implementation("org.jetbrains.intellij.plugins:platform-ide:2023.1")
    // 其他依赖...
}

// 配置 Gradle 任务
tasks {
    // 配置编译任务...
}

• gradle.properties: 这是一个可选的配置文件，用于定义 Gradle 属性。这些属性可以在构建脚本中使用，通常用于定义全局变量，如 JVM 参数、项目路径等。例如：

# 定义 JVM 参数
org.gradle.jvmargs=-Xmx1024m

通过了解和配置这些文件，可以更好地管理和构建 DevoxxGenieIDEAPlugin 项目。

DevoxxGenieIDEAPlugin DevoxxGenie is a plugin for IntelliJ IDEA that uses local LLM's (Ollama, LMStudio, GPT4All and Jan) and Cloud based LLMs to help review, test, explain your project code. 项目地址: https://gitcode.com/gh_mirrors/de/DevoxxGenieIDEAPlugin