Gradle Plugin Concepts: Difference between revisions
Line 27: | Line 27: | ||
Plugins can be applied in two ways: | Plugins can be applied in two ways: | ||
==apply() method== | ==apply() method== | ||
<syntaxhighlight lang='groovy'> | |||
apply plugin: 'java' | |||
</syntaxhighlight> | |||
==plugins script block== | ==plugins script block== | ||
<syntaxhighlight lang='groovy'> | <syntaxhighlight lang='groovy'> |
Revision as of 05:04, 24 September 2020
External
- https://docs.gradle.org/current/userguide/plugins.html
- Gradle Plugin Portal https://plugins.gradle.org/
Internal
TODO
Overview
A Gradle plugin is packaged code that uses the Gradle API to provide additional functionality and extend Gradle core. A Gradle plugin applies some configuration to a target object, usually a Project. The plugin may introduce new tasks, new domain objects, conventions, project layouts and patterns for a specific problem domain. Plugins may even extend the core objects. Introducing their own conventions, plugins are "opinionated", encouraging the user to do things in a certain way. However, well written plugins must provide means to change the default conventions and make it work for non-standard projects.
Plugin API
Script Plugin
A script plugin is simply a file containing Gradle DSL code and possibly in-line Java and Groovy code. It can be thought as just another build script that can be imported into a build script.
apply from: 'example.gradle'
Conventionally, the file has the ".gradle" extension, but this is not mandatory. The file can be loaded from the local filesystem, or from a remote location. Filesystem location is relative to the project directory. Remote locations are specified with HTTP URLs.
Binary Plugin
A binary plugin is a class implementing org.gradle.api.Plugin and ancillary classes.
Using a Plugin
Plugins can be applied in two ways:
apply() method
apply plugin: 'java'
plugins script block
plugins {
}
Plugin Extension
A plugin is a typical use case for an extension.
Standard Plugins
A standard plugin ships with the Gradle runtime.