Skip to content

Commit b488e9c

Browse files
OpenRewrite recipe best practices
Co-authored-by: Moderne <team@moderne.io>
1 parent 83f089b commit b488e9c

2 files changed

Lines changed: 78 additions & 1 deletion

File tree

‎src/main/resources/META-INF/rewrite/examples.yml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,84 @@ examples:
115115
language: groovy
116116
---
117117
type: specs.openrewrite.org/v1beta/example
118+
recipeName: org.openrewrite.java.dependencies.ExcludeDependency
119+
examples:
120+
- description: Exclude a transitive Gradle dependency
121+
parameters: &id001
122+
- commons-logging
123+
- commons-logging
124+
- 'null'
125+
- 'null'
126+
sources:
127+
- before: |
128+
plugins {
129+
id 'java-library'
130+
}
131+
132+
repositories {
133+
mavenCentral()
134+
}
135+
136+
dependencies {
137+
implementation 'org.apache.httpcomponents:httpclient:4.5.13'
138+
}
139+
after: |
140+
plugins {
141+
id 'java-library'
142+
}
143+
144+
repositories {
145+
mavenCentral()
146+
}
147+
148+
dependencies {
149+
implementation('org.apache.httpcomponents:httpclient:4.5.13') {
150+
exclude group: 'commons-logging', module: 'commons-logging'
151+
}
152+
}
153+
path: build.gradle
154+
language: groovy
155+
- description: Exclude a transitive Maven dependency
156+
parameters: *id001
157+
sources:
158+
- before: |
159+
<project>
160+
<modelVersion>4.0.0</modelVersion>
161+
<groupId>com.example</groupId>
162+
<artifactId>demo</artifactId>
163+
<version>0.0.1-SNAPSHOT</version>
164+
<dependencies>
165+
<dependency>
166+
<groupId>org.apache.httpcomponents</groupId>
167+
<artifactId>httpclient</artifactId>
168+
<version>4.5.13</version>
169+
</dependency>
170+
</dependencies>
171+
</project>
172+
after: |
173+
<project>
174+
<modelVersion>4.0.0</modelVersion>
175+
<groupId>com.example</groupId>
176+
<artifactId>demo</artifactId>
177+
<version>0.0.1-SNAPSHOT</version>
178+
<dependencies>
179+
<dependency>
180+
<groupId>org.apache.httpcomponents</groupId>
181+
<artifactId>httpclient</artifactId>
182+
<version>4.5.13</version>
183+
<exclusions>
184+
<exclusion>
185+
<groupId>commons-logging</groupId>
186+
<artifactId>commons-logging</artifactId>
187+
</exclusion>
188+
</exclusions>
189+
</dependency>
190+
</dependencies>
191+
</project>
192+
path: pom.xml
193+
language: xml
194+
---
195+
type: specs.openrewrite.org/v1beta/example
118196
recipeName: org.openrewrite.java.dependencies.FindDependency
119197
examples:
120198
- description: '`FindDependencyTest#findMavenDependency`'

‎src/test/java/org/openrewrite/java/dependencies/ExcludeDependencyTest.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,6 @@ void gradleConfigurationFilter() {
149149
);
150150
}
151151

152-
@DocumentExample("Exclude a transitive Maven dependency")
153152
@Test
154153
void excludeMavenDependency() {
155154
rewriteRun(

0 commit comments

Comments
 (0)