IHub Plugins Documentation

The ihub-meta plugin (ID: pub.ihub.plugin.ihub-meta) generates a project-meta.json file containing project structure metadata. This file is designed to be read by LLM/AI development tools to help them understand your project's architecture, dependencies, and source sets.

Generated Metadata Content:

• project: Name, group, version, description, and root directory.
• gradle: Gradle version and applied plugins.
• sourceSets: Source directory structure (main/test, supporting Java/Groovy/Kotlin/Resources).
• dependencies: Dependency information (e.g., implementation, testImplementation).
• modules: List of subprojects/modules.

# Run the task to generate metadata
./gradlew iHubMeta

The ihub-copyright plugin supports the following languages:

• Java
• Groovy
• Kotlin

Note: The plugin automatically excludes any code located in **/generated/** directories.

If no lombok.config file is present in your project, the plugin automatically generates one during the execution phase using the iHubLombokConfigTask. This task is compatible with the Gradle Configuration Cache and is a dependency for all AbstractCompile tasks.

The generated lombok.config contains:

config.stopBubbling = true
lombok.addLombokGeneratedAnnotation = true

The plugin resolves configuration properties using four distinct sources. When multiple sources define the same property, they are resolved according to the following priority (highest to lowest):

1. Sys (System Properties): Passed via command line using -D (e.g., -DiHub.property=value).
2. Env (Environment Variables): Defined in the OS environment. Use uppercase with underscores (e.g., PROPERTY_NAME=value).
3. Ext (Extension Properties): Custom plugin extensions configured in your build.gradle file.
4. Prj (Project Properties): Defined in gradle.properties using the format extension.propertyName (e.g., iHub.propertyName=value) or passed via command line using -P (e.g., -PiHub.propertyName=value).

The ihub plugin manages several repository types to ensure compatibility with different network environments (especially for users in China). The managed repositories include:

• ProjectDirs: Local project components located at {rootProject.projectDir}/libs.
• MavenLocal: The local Maven repository at {local}/.m2/repository.
• AliYunPublic: AliYun public aggregate repository (https://maven.aliyun.com/repository/public) which includes https://repo1.maven.org/maven2.
• ReleaseRepo: Private release repository.
• SnapshotRepo: Private snapshot repository.
• CustomizeRepo: Custom repository.
• MavenRepo: Maven Central repository.

Property Priority

When configuring IHub, properties are resolved in the following order (highest to lowest):

1. -DiHub.xxx=value (Command-line system properties)
2. IHUB_XXX=value (Environment variables)
3. gradle.properties file
4. @IHubProperty(defaultValue = ...) (Plugin default values)

Version Management

• Centralize Versions: All dependency versions should be managed in gradle/libs.versions.toml.
• Avoid Hardcoding: Do not hardcode version numbers in individual module build.gradle.kts files.

Gradle Best Practices for IHub

• ✅ Use tasks.register() instead of tasks.create().
• ✅ Use layout.buildDirectory instead of buildDir.
• ✅ Use ListProperty<T> instead of Property<List<T>>.
• ❌ Avoid afterEvaluate; use Provider.map() instead.

The ihub-version plugin integrates and enhances two third-party Gradle plugins to manage project versions:

1. io.freefair.git-version: Automatically configures project versions. ihub-version enhances this by supporting inferred version numbers based on Git tags.
2. com.github.ben-manes.versions: Used to check component versions. ihub-version enhances this by supporting automatic replacement of the latest versions.

Version Inference Details: Since version 1.9.5, version inference uses GitDescribeValueSource (via ProviderFactory.of(ValueSource) and ExecOperations) to call git describe --tags. This implementation is compatible with the Gradle Configuration Cache (CC).