[Gradle plugin] Unify resource directory, rename :generateImageVectors to :generateValkyrieImageVector, create basic README for plugin

Author: egorikftp

README.md

@@ -14,6 +14,8 @@
 [![CLI release][badge:cli-release]][url:gh-releases]
 [![Homebrew][badge:homebrew]][url:homebrew]
 
+<!-- [![Gradle Plugin Portal][badge:gradle-plugin]][url:gradle-plugin] -->
+
 [![Telegram][badge:telegram-invite]][url:telegram-invite]
 [![Slack][badge:slack-invite]][url:slack-invite]
 ![Test coverage][badge:coverage]
@@ -63,6 +65,9 @@ needs.
     - [`svgxml2imagevector` command](#svgxml2imagevector-command)
     - [`changelog` command](#changelog-command)
   - [Build](#build-cli)
+- 🐘 [Gradle plugin](#gradle-plugin)
+  - [Common scenarios](#common-scenarios)
+  - [Plugin configuration](#plugin-configuration)
 - [Other](#other)
   - [Export formats](#export-formats)
   - [Comparison with other solutions](#comparison-with-other-solutions)
@@ -86,12 +91,12 @@ needs.
 
 ### Available tools:
 
-- [IntelliJ IDEA / Android Studio plugin](#idea-plugin)
-- [CLI tool](#cli-tool)
-- Gradle plugin (🚧 waiting to publish 🚧)
+- 🔌 [IntelliJ IDEA / Android Studio plugin](#idea-plugin)
+- 🖥️ [CLI tool](#cli-tool)
+- 🐘 [Gradle plugin](#gradle-plugin) (🚧 waiting to publish 🚧)
 - Web app (🚧 under development 🚧)
 
-## IDEA Plugin
+## 🔌IDEA Plugin
 
 ### Plugin features
 
@@ -236,7 +241,7 @@ folder
 
 or run plugin in IDE using: `./gradlew runIde`
 
-## CLI tool
+## 🖥CLI tool
 
 CLI tools can be easily integrated into scripts and automated workflows, allowing you to convert icons from specific
 source with predefined settings.
@@ -297,7 +302,7 @@ A part of the CLI tool that allows you to create an icon pack with nested packs.
 
 Usage:
 
-```bash
+```text
 ./valkyrie iconpack [<options>]
 ```
 
@@ -315,7 +320,7 @@ A part of the CLI tool that allows you to convert SVG/XML files to ImageVector.
 
 Usage:
 
-```bash
+```text
 ./valkyrie svgxml2imagevector [<options>]
 ```
 
@@ -352,6 +357,100 @@ Output example:
 Run `./gradlew buildCLI` to build minified version of CLI tool. Artifact will be available in
 `tools/cli/build/distributions/valkyrie-cli-*.**.*-SNAPSHOT.zip`.
 
+## 🐘Gradle plugin
+
+The Gradle plugin automates the conversion of SVG/XML files to Compose ImageVector format during the build process. It's
+ideal for projects that need to version control icon sources and generate type-safe Kotlin code automatically.
+
+### Common scenarios
+
+- **Team collaboration**: Keep SVG/XML sources in version control and let the build system generate Kotlin code for
+  everyone
+- **CI/CD pipelines**: Ensure icons are always generated consistently across different environments
+- **Design system integration**: Automatically sync icon updates from design tools without manual conversion
+- **Large icon libraries**: Efficiently manage hundreds or thousands of icons with minimal manual intervention
+
+### Plugin configuration
+
+#### 1. Apply the plugin
+
+<!-- [![Gradle Plugin Portal][badge:gradle-plugin]][url:gradle-plugin] -->
+
+Define in your libs.versions.toml:
+
+```toml
+[plugins]
+valkyrie = "io.github.composegears.valkyrie:latest-version"
+```
+
+Add the plugin to your `build.gradle.kts`:
+
+```kotlin
+plugins {
+  alias(libs.plugins.valkyrie)
+}
+```
+
+#### 2. Configure the plugin
+
+```kotlin
+valkyrie {
+  // Required: Package name for generated code
+  // Defaults to Android 'namespace' if Android Gradle Plugin is applied
+  packageName = "com.example.app.icons"
+
+  // Optional: Icon pack configuration
+  iconPackName = "AppIcons" // Creates an icon pack object (unset by default)
+  nestedPackName = "Filled" // For nested packs like AppIcons.Filled (unset by default)
+
+  // Optional: Resource directory name containing icon files (default: "valkyrieResources")
+  // Icons will be discovered in src/{sourceSet}/{resourceDirectoryName}/
+  // Example: src/commonMain/valkyrieResources/, src/androidMain/valkyrieResources/
+  resourceDirectoryName = "valkyrieResources"
+
+  // Optional: Output format for generated ImageVectors (default: BackingProperty)
+  outputFormat = OutputFormat.BackingProperty // or OutputFormat.LazyProperty
+
+  // Optional: Code generation settings
+  useComposeColors = true // Use androidx.compose.ui.graphics.Color (default: true)
+  generatePreview = false // Generate @Preview composable functions (default: false)
+  previewAnnotationType = PreviewAnnotationType.AndroidX // AndroidX or Jetbrains (default: AndroidX)
+  useFlatPackage = false // Generate flat package structure without subfolders (default: false)
+  useExplicitMode = false // Add explicit visibility modifiers (default: false)
+  addTrailingComma = false // Add trailing commas in generated code (default: false)
+  indentSize = 4 // Number of spaces for indentation (default: 4)
+
+  // Optional: Custom output directory (default: build/generated/sources/valkyrie)
+  outputDirectory = layout.buildDirectory.dir("generated/valkyrie")
+
+  // Optional: Generate during IDE sync for better developer experience (default: false)
+  generateAtSync = false
+}
+```
+
+#### 3. Organize your icons
+
+Place your icon files in the resources directory:
+
+```text
+src/
+└── commonMain/
+    └── valkyrieResources/
+        ├── add.svg
+        ├── delete.svg
+        └── ic_home.xml
+```
+
+The plugin automatically discovers icons from `src/{sourceSet}/valkyrieResources/` in all source sets.
+
+#### 4. Run generation
+
+Run the Gradle task to generate ImageVector sources:
+
+```bash
+./gradlew generateValkyrieImageVector
+```
+
 ## Other
 
 ### Export formats
@@ -618,21 +717,21 @@ CLI options `--iconpack-name` and `--nested-packs` removed in favour of `--iconp
 
 Single pack
 
-```
+```text
 ❌ ./valkyrie --iconpack-name=ValkyrieIcons
 ```
 
-```
+```text
 ✅ ./valkyrie --iconpack=ValkyrieIcons
 ```
 
 Nested packs
 
-```
+```text
 ❌ ./valkyrie --iconpack-name=ValkyrieIcons --nested-packs=Colored,Filled
 ```
 
-```
+```text
 ✅ ./valkyrie --iconpack=ValkyrieIcons.Colored,ValkyrieIcons.Filled
 ```
 
@@ -652,7 +751,7 @@ Thank you for your contributions and support! ❤️
 
 ## License
 
-```
+```text
 Developed by ComposeGears 2024
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -676,6 +775,8 @@ limitations under the License.
 
 [badge:homebrew]: https://img.shields.io/badge/homebrew-tap-orange?style=for-the-badge&labelColor=black&color=white&logo=homebrew
 
+<!-- [badge:gradle-plugin]: https://img.shields.io/gradle-plugin-portal/v/io.github.composegears.valkyrie?style=for-the-badge&labelColor=black&color=white&label=Gradle%20Plugin -->
+
 [badge:marketplace-downloads]: https://img.shields.io/jetbrains/plugin/d/24786.svg?style=for-the-badge&labelColor=black&color=white
 
 [badge:marketplace-rating]: https://img.shields.io/jetbrains/plugin/r/rating/24786?style=for-the-badge&labelColor=black&color=white
@@ -694,6 +795,8 @@ limitations under the License.
 
 [url:homebrew]: https://github.com/ComposeGears/homebrew-repo
 
+<!-- [url:gradle-plugin]: https://plugins.gradle.org/plugin/io.github.composegears.valkyrie -->
+
 [url:telegram-invite]: https://t.me/composegears
 
 [url:slack-invite]: https://join.slack.com/t/composegears/shared_invite/zt-2noleve52-D~zrFPmC1cdhThsuQUW61A

tools/gradle-plugin/api/gradle-plugin.api

@@ -2,16 +2,15 @@ public abstract class io/github/composegears/valkyrie/gradle/GenerateImageVector
 	public fun <init> ()V
 	public final fun execute ()V
 	public abstract fun getAddTrailingComma ()Lorg/gradle/api/provider/Property;
-	public abstract fun getDrawableFiles ()Lorg/gradle/api/file/ConfigurableFileCollection;
 	public abstract fun getGeneratePreview ()Lorg/gradle/api/provider/Property;
+	public abstract fun getIconFiles ()Lorg/gradle/api/file/ConfigurableFileCollection;
 	public abstract fun getIconPackName ()Lorg/gradle/api/provider/Property;
 	public abstract fun getIndentSize ()Lorg/gradle/api/provider/Property;
 	public abstract fun getNestedPackName ()Lorg/gradle/api/provider/Property;
 	public abstract fun getOutputDirectory ()Lorg/gradle/api/file/DirectoryProperty;
 	public abstract fun getOutputFormat ()Lorg/gradle/api/provider/Property;
 	public abstract fun getPackageName ()Lorg/gradle/api/provider/Property;
 	public abstract fun getPreviewAnnotationType ()Lorg/gradle/api/provider/Property;
-	public abstract fun getSvgFiles ()Lorg/gradle/api/file/ConfigurableFileCollection;
 	public abstract fun getUseComposeColors ()Lorg/gradle/api/provider/Property;
 	public abstract fun getUseExplicitMode ()Lorg/gradle/api/provider/Property;
 	public abstract fun getUseFlatPackage ()Lorg/gradle/api/provider/Property;
@@ -28,6 +27,7 @@ public abstract interface class io/github/composegears/valkyrie/gradle/ValkyrieE
 	public abstract fun getOutputFormat ()Lorg/gradle/api/provider/Property;
 	public abstract fun getPackageName ()Lorg/gradle/api/provider/Property;
 	public abstract fun getPreviewAnnotationType ()Lorg/gradle/api/provider/Property;
+	public abstract fun getResourceDirectoryName ()Lorg/gradle/api/provider/Property;
 	public abstract fun getUseComposeColors ()Lorg/gradle/api/provider/Property;
 	public abstract fun getUseExplicitMode ()Lorg/gradle/api/provider/Property;
 	public abstract fun getUseFlatPackage ()Lorg/gradle/api/provider/Property;

tools/gradle-plugin/src/main/kotlin/io/github/composegears/valkyrie/gradle/GenerateImageVectorsTask.kt

@@ -26,9 +26,7 @@ import org.gradle.api.tasks.TaskAction
 
 @CacheableTask
 abstract class GenerateImageVectorsTask : DefaultTask() {
-    @get:[PathSensitive(RELATIVE) InputFiles] abstract val svgFiles: ConfigurableFileCollection
-
-    @get:[PathSensitive(RELATIVE) InputFiles] abstract val drawableFiles: ConfigurableFileCollection
+    @get:[PathSensitive(RELATIVE) InputFiles] abstract val iconFiles: ConfigurableFileCollection
 
     @get:Input abstract val packageName: Property<String>
 
@@ -92,7 +90,7 @@ abstract class GenerateImageVectorsTask : DefaultTask() {
             useFlatPackage = useFlatPackage,
         )
 
-        (svgFiles + drawableFiles).files.forEach { file ->
+        iconFiles.files.forEach { file ->
             val parseOutput = SvgXmlParser.toIrImageVector(ParserType.Jvm, Path(file.absolutePath))
             val vectorSpecOutput = ImageVectorGenerator.convert(
                 vector = parseOutput.irImageVector,
@@ -130,6 +128,7 @@ abstract class GenerateImageVectorsTask : DefaultTask() {
     }
 
     internal companion object {
-        internal const val TASK_NAME = "generateImageVectors"
+        internal const val TASK_NAME = "generateValkyrieImageVector"
+        internal const val DEFAULT_RESOURCE_DIRECTORY = "valkyrieResources"
     }
 }

tools/gradle-plugin/src/main/kotlin/io/github/composegears/valkyrie/gradle/Utils.kt

@@ -8,6 +8,7 @@ import org.gradle.api.Project
 import org.gradle.api.file.ConfigurableFileCollection
 import org.gradle.api.file.Directory
 import org.gradle.api.file.FileCollection
+import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
 import org.gradle.util.GradleVersion
 import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet
@@ -21,13 +22,10 @@ internal fun registerTask(
     target.tasks.register(taskName, GenerateImageVectorsTask::class.java) { task ->
         task.description = "Converts SVG & Drawable files into ImageVector Kotlin accessor properties"
 
-        val svgFiles = sourceSet.findSvgFiles()
-        val drawableFiles = sourceSet.findDrawableFiles()
-        task.svgFiles.conventionCompat(svgFiles)
-        task.drawableFiles.conventionCompat(drawableFiles)
-        task.onlyIf("Needs at least one input file") {
-            !svgFiles.isEmpty || !drawableFiles.isEmpty
-        }
+        val resourceDirName = extension.resourceDirectoryName
+        val iconFiles = sourceSet.findIconFiles(resourceDirName)
+        task.iconFiles.conventionCompat(iconFiles)
+        task.onlyIf("Needs at least one input file") { !iconFiles.isEmpty }
 
         task.packageName.convention(extension.packageName.orElse(target.packageNameOrThrow()))
 
@@ -96,12 +94,11 @@ private fun KotlinSourceSet.root(): Directory = with(project) {
     return layout.dir(src).get()
 }
 
-private fun KotlinSourceSet.findSvgFiles(): FileCollection = root()
-    .dir("svg")
-    .asFileTree
-    .filter { it.extension == "svg" }
-
-private fun KotlinSourceSet.findDrawableFiles(): FileCollection = root()
-    .dir("res")
-    .asFileTree
-    .filter { it.parentFile?.name.orEmpty().contains("drawable") && it.extension == "xml" }
+private fun KotlinSourceSet.findIconFiles(resourceDirectoryName: Property<String>): FileCollection {
+    return root()
+        .dir(resourceDirectoryName.get())
+        .asFileTree
+        .filter {
+            it.extension == "svg" || it.extension == "xml"
+        }
+}

tools/gradle-plugin/src/main/kotlin/io/github/composegears/valkyrie/gradle/ValkyrieExtension.kt

@@ -22,6 +22,12 @@ interface ValkyrieExtension {
      */
     val outputDirectory: DirectoryProperty
 
+    /**
+     * Name of the resource directory containing icon files. Defaults to `valkyrieResources`.
+     * The plugin will look for icons in `<sourceSet>/valkyrieResources` for all project types.
+     */
+    val resourceDirectoryName: Property<String>
+
     /**
      * Unset by default
      */

tools/gradle-plugin/src/main/kotlin/io/github/composegears/valkyrie/gradle/ValkyrieGradlePlugin.kt

@@ -2,6 +2,7 @@ package io.github.composegears.valkyrie.gradle
 
 import io.github.composegears.valkyrie.generator.jvm.imagevector.OutputFormat
 import io.github.composegears.valkyrie.generator.jvm.imagevector.PreviewAnnotationType
+import io.github.composegears.valkyrie.gradle.GenerateImageVectorsTask.Companion.DEFAULT_RESOURCE_DIRECTORY
 import io.github.composegears.valkyrie.gradle.GenerateImageVectorsTask.Companion.TASK_NAME
 import org.gradle.api.Plugin
 import org.gradle.api.Project
@@ -19,6 +20,7 @@ class ValkyrieGradlePlugin : Plugin<Project> {
             packageName.convention(packageNameOrThrow())
             generateAtSync.convention(false)
             outputDirectory.convention(layout.buildDirectory.dir("generated/sources/valkyrie"))
+            resourceDirectoryName.convention(DEFAULT_RESOURCE_DIRECTORY)
             outputFormat.convention(OutputFormat.BackingProperty)
             useComposeColors.convention(true)
             generatePreview.convention(false)

tools/gradle-plugin/src/test/kotlin/io/github/composegears/valkyrie/gradle/Utils.kt

@@ -6,6 +6,7 @@ import assertk.Assert
 import assertk.assertions.isEqualTo
 import assertk.assertions.isNotNull
 import assertk.fail
+import io.github.composegears.valkyrie.gradle.GenerateImageVectorsTask.Companion.DEFAULT_RESOURCE_DIRECTORY
 import java.nio.file.Files
 import java.nio.file.Path
 import java.nio.file.Paths
@@ -55,16 +56,22 @@ internal fun Path.writeSettingsFile() = resolve("settings.gradle.kts").writeText
     """.trimIndent(),
 )
 
-internal fun Path.writeTestSvgs(sourceSet: String) {
-    val destDir = resolve("src/$sourceSet/svg")
+internal fun Path.writeTestSvgs(
+    sourceSet: String,
+    resourceDirName: String = DEFAULT_RESOURCE_DIRECTORY,
+) {
+    val destDir = resolve("src/$sourceSet/$resourceDirName")
     destDir.createDirectories()
 
     val sourceDir = RESOURCES_DIR_SVG.toPath()
     sourceDir.copyToRecursively(destDir, followLinks = true)
 }
 
-internal fun Path.writeTestDrawables(sourceSet: String) {
-    val destDir = resolve("src/$sourceSet/res/drawable")
+internal fun Path.writeTestDrawables(
+    sourceSet: String,
+    resourceDirName: String = DEFAULT_RESOURCE_DIRECTORY,
+) {
+    val destDir = resolve("src/$sourceSet/$resourceDirName")
     destDir.createDirectories()
 
     val sourceDir = RESOURCES_DIR_XML.toPath()
@@ -73,7 +80,10 @@ internal fun Path.writeTestDrawables(sourceSet: String) {
 
 internal fun Assert<BuildResult>.taskWasSuccessful(name: String) = taskHadResult(name, SUCCESS)
 
-internal fun Assert<BuildResult>.taskHadResult(path: String, expected: TaskOutcome) = transform { it.task(path)?.outcome }
+internal fun Assert<BuildResult>.taskHadResult(
+    path: String,
+    expected: TaskOutcome,
+) = transform { it.task(path)?.outcome }
     .isNotNull()
     .isEqualTo(expected)