it.nicolasfarabegoli.gradle.ConventionalCommits.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of conventional-commits Show documentation

Plugin to check if commits are 'Conventional Commits' compliant

There is a newer version: 3.1.3

package it.nicolasfarabegoli.gradle

import org.gradle.api.Plugin
import org.gradle.api.Project

/**
 * Plugin for checking if commits are _Conventional Commits_ compliant.
 * This plugin can be customized base on the need of the user.
 * See [ConventionalCommitsExtension] for alla available config.
 * For more info on _Conventional Commits_ see [link](https://www.conventionalcommits.org/en/v1.0.0/).
 */
class ConventionalCommits : Plugin {
    companion object {
        private inline fun  Project.createExtension(name: String, vararg args: Any?): T =
            project.extensions.create(name, T::class.java, *args)
    }

    override fun apply(project: Project) {
        val extension = project.createExtension("conventionalCommits", project)
        project.afterEvaluate {
            extension.setupScript()
        }
    }
}