Package com.arc_e_tect.gradle.shadow

Class ShadowApiDetectorPlugin

java.lang.Object

com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin

All Implemented Interfaces:

org.gradle.api.Plugin<org.gradle.api.Project>

public class ShadowApiDetectorPlugin
extends Object
implements org.gradle.api.Plugin<org.gradle.api.Project>

Gradle plugin that registers the detectShadowApis and updateShadowApiDetectorDSL tasks and wires the shadowApiDetector DSL extension into the project.

Usage

 plugins {
     id 'com.arc-e-tect.shadow-api-detector'
 }

 shadowApiDetector {
     rootDocument = file('src/main/resources/openapi/openapi.yaml')
 }
 

Defaults

• Controller directories: src/main/java
• OpenAPI description directory: the root document's own parent directory
• Fail on shadow APIs: false
• Report directory: build/reports/shadow-api-detector
• Report file name: shadow-apis.adoc
• Track contract history: false
• Contract history file: shadow-api-detector-contract-history.ndjson (project directory)
• Update contract history: same as track contract history

The task is not wired into check or build automatically - teams that generate their OpenAPI documentation from code would otherwise see every build fail on documentation that hasn't been regenerated yet. Opt in explicitly once the task is safe to run as part of your build:

 tasks.named('check') {
     dependsOn 'detectShadowApis'
 }
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TASK_NAME	Name of the Gradle task registered by this plugin.
static final String	UPDATE_DSL_TASK_NAME	Name of the DSL-updating task registered by this plugin.

Constructor Summary

Constructors

Constructor	Description
ShadowApiDetectorPlugin()	Creates a new plugin instance.

Method Summary

Modifier and Type	Method	Description
void	apply(org.gradle.api.Project project)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TASK_NAME

public static final String TASK_NAME

Name of the Gradle task registered by this plugin.

See Also:

• Constant Field Values

UPDATE_DSL_TASK_NAME

public static final String UPDATE_DSL_TASK_NAME

Name of the DSL-updating task registered by this plugin.

See Also:

• Constant Field Values

Constructor Details

ShadowApiDetectorPlugin

public ShadowApiDetectorPlugin()

Creates a new plugin instance. Instantiated by Gradle infrastructure.

Method Details

apply

public void apply(org.gradle.api.Project project)

Specified by:

apply in interface org.gradle.api.Plugin<org.gradle.api.Project>