GrailsCliArtifactGradlePlugin (Grails 8.0.0-SNAPSHOT)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

org.grails.gradle.plugin.commands.GrailsCliArtifactGradlePlugin

All Implemented Interfaces and Traits:

Plugin<Project>
```
@groovy.transform.CompileStatic
abstract class GrailsCliArtifactGradlePlugin
extends java.lang.Object
implements Plugin<Project>
```
Configures a Grails plugin project to ship its CLI commands as a companion artifact under its own Maven coordinate (<artifactId>-cli), keeping command code and CLI-only dependencies off the runtime classpath of consuming applications. Applying the plugin:
- creates a cli source set (src/cli/groovy) exposed as a feature variant;
- adds org.apache.grails:grails-core-cli (the command contract) and the plugin's own runtime classes to the cli compile classpath, so commands compile with no additional configuration and are registered automatically in META-INF/grails-cli.factories;
- keeps the cli variants out of the plugin's default publication and exposes them through a dedicated cli software component;
- stamps the runtime jar with the Grails-Cli-Artifact manifest attribute, so the Grails Gradle plugin adds the companion to a consuming application's grailsCli configuration automatically;
- registers the companion publication with the Grails publish plugin (org.apache.grails.gradle.grails-publish) when it is applied.
Configure through the cliArtifact extension:
```
 cliArtifact {
     automaticModuleName = 'com.example.myplugin.cli'
 }
 
```
Since:
8.0

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`CLI_ARTIFACT_MANIFEST_ATTRIBUTE`	The runtime-jar manifest attribute advertising the companion cli coordinate
`static java.lang.String`	`CLI_COMPONENT_NAME`
`static java.lang.String`	`CLI_PUBLICATION_NAME`
`static java.lang.String`	`CLI_SOURCE_SET_NAME`

Constructor Summary

Constructors
Constructor and description
`GrailsCliArtifactGradlePlugin()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`void`	`apply(Project project)`
	`abstract SoftwareComponentFactory`	`getSoftwareComponentFactory()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Field Detail
  - public static final java.lang.String CLI_ARTIFACT_MANIFEST_ATTRIBUTE
    
    The runtime-jar manifest attribute advertising the companion cli coordinate
  - public static final java.lang.String CLI_COMPONENT_NAME
  - public static final java.lang.String CLI_PUBLICATION_NAME
  - public static final java.lang.String CLI_SOURCE_SET_NAME
- Constructor Detail
  - GrailsCliArtifactGradlePlugin()
- Method Detail
  - @java.lang.Override
    void apply(Project project)
  - @javax.inject.Inject
    abstract SoftwareComponentFactory getSoftwareComponentFactory()

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method