Valkyrie 使用与配置指南

Valkyrie 使用与配置指南

Valkyrie SVG/XML to Compose ImageVector: IntelliJ IDEA / Android Studio plugin + build-in previewer without compilation, CLI tool 项目地址: https://gitcode.com/gh_mirrors/valky/Valkyrie

1. 项目的目录结构及介绍

Valkyrie 项目的目录结构如下：

Valkyrie/
├── .github/
├── .idea/
├── assets/
├── cli/
├── components/
├── gradle/
├── idea-plugin/
├── playground/
├── build.gradle.kts
├── gradle.properties
├── gradlew
├── gradlew.bat
├── renovate.json5
├── settings.gradle.kts
├── stability_config.conf
└── README.md

• .github/: 存放与 GitHub 有关的配置文件。
• .idea/: IntelliJ IDEA 的项目配置文件。
• assets/: 存放项目资源文件，如图标等。
• cli/: 命令行工具的源代码。
• components/: UI 组件的源代码。
• gradle/: Gradle 相关的配置和脚本文件。
• idea-plugin/: IntelliJ IDEA 插件的源代码。
• playground/: 项目的示例代码和测试文件。
• build.gradle.kts: Gradle 构建脚本。
• gradle.properties: Gradle 的属性配置文件。
• gradlew 和 gradlew.bat: Gradle 命令行工具的-wrapper 脚本。
• renovate.json5: Renovate 的配置文件，用于自动化依赖更新。
• settings.gradle.kts: Gradle 的设置文件。
• stability_config.conf: 稳定性配置文件。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

项目的启动主要通过 gradlew 或 gradlew.bat 文件来完成。这些是 Gradle 的-wrapper 脚本，允许用户在没有安装 Gradle 的情况下构建项目。

在终端或命令提示符中，进入项目根目录，运行以下命令来构建和运行项目：

./gradlew build

或者，如果你想运行特定的任务，比如构建 IntelliJ IDEA 插件，可以使用：

./gradlew :idea-plugin:buildPlugin

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件来进行：

• build.gradle.kts: 这是 Kotlin 编写的 Gradle 构建脚本，用于定义项目的构建逻辑。你可以在这里配置依赖项、构建任务和插件。
• gradle.properties: 此文件包含 Gradle 的全局属性设置。例如，可以在这里设置项目的版本号或 Gradle 插件的版本。
• settings.gradle.kts: 这是 Gradle 的设置文件，用于配置项目结构和插件的引入。

在 build.gradle.kts 文件中，你可以找到如下配置：

plugins {
    // 插件声明
}

repositories {
    // 仓库配置
}

dependencies {
    // 依赖配置
}

// 其他自定义的构建逻辑

确保根据项目的具体需求来调整这些配置文件。在修改配置后，可以通过运行 ./gradlew build 来检查配置是否正确应用。

Valkyrie SVG/XML to Compose ImageVector: IntelliJ IDEA / Android Studio plugin + build-in previewer without compilation, CLI tool 项目地址: https://gitcode.com/gh_mirrors/valky/Valkyrie