Introducción

Público objetivo: Desarrollador principiante a intermedio con Gradle.

Empezar un nuevo proyecto de plugin Gradle puede parecer intimidante. Afortunadamente, Gradle proporciona un asistente interactivo potente, la tarea`init`, que genera una estructura de proyecto completa, limpia y lista para usar. Esta guía le mostrará cómo utilizar esta herramienta para crear una base de complemento sana, explicará su estructura y le mostrará cómo lanzar las primeras tareas de compilación.

Paso 1: Iniciar el asistente de proyecto

El comando`gradle init`es el punto de partida. Lanza un asistente de línea de comandos que le hace una serie de preguntas para configurar el proyecto.

Abre tu terminal en una carpeta vacía y ejecuta :

gradle init

El asistente le guiará. Aquí están las opciones a elegir para un plugin Gradle escrito en Kotlin:

  1. Seleccione el tipo de proyecto para generar:Elige`Gradle plugin`.

  2. Seleccione el lenguaje de implementación:Elige`Kotlin`.

  3. Seleccionar DSL de script de construcción:elijan`Kotlin`.

  4. Nombre del proyecto:Ingrese un nombre para su proyecto (ej:`site-baker`).

  5. ID del plugin:Asigna un identificador único a tu plugin (ejemplo:`com.cheroliv.site-baker`).

  6. Clase del complemento:Especifique el nombre de la clase de implementación (ej:`com.cheroliv.SiteBakerPlugin`).

Una vez finalizado, Gradle genera un árbol de archivos completo.

Diagrama del proceso de inicialización
@startuml
start
:Lanzar `gradle init`;
:Seleccionar el plugin Gradle;
:Elegir "Kotlin" (lenguaje);
:Seleccionar "Kotlin" (DSL);
:Ingresar nombre, ID y clase;
:Proyecto generado;
stop
@enduml

Paso 2: Comprender la estructura generada

El asistente crea una estructura de proyecto multi-módulos, separando el proyecto raíz del código fuente del plugin mismo.

.
├── gradle/
│   └── wrapper/
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── plugin/
│   ├── build.gradle.kts
│   └── src/
│       ├── main/
│       │   └── kotlin/
│       │       └── com/cheroliv/SiteBakerPlugin.kt
│       ├── test/
│       │   └── kotlin/
│       │       └── com/cheroliv/SiteBakerPluginTest.kt
│       └── functionalTest/
│           └── kotlin/
│               └── com/cheroliv/SiteBakerPluginFunctionalTest.kt
└── settings.gradle.kts

Archivos y carpetas clave

  • settings.gradle.kts: Este archivo en la raíz define los módulos incluidos en la compilación. Aquí, incluye el subproyecto`plugin`.

[source,kotlin] ---- rootProject.name = "site-baker include("plugin") </think>


  • plugin/build.gradle.kts: El corazón de la configuración de su plugin. Aplica el plugin`java-gradle-plugin`, declara las dependencias y configura los metadatos del plugin.

[source,kotlin] ---- complementos { java-gradle-plugin alias(libs.plugins.kotlin.jvm) }


Artículos relacionados