Skip to content

Commit b30c1e0

Browse files
greg-at-moderneTeamModerne
authored and
app
committed
Extract documentation examples from tests
Use this link to re-run the recipe: https://app.moderne.io/recipes/org.openrewrite.java.recipes.ExamplesExtractor?organizationId=QUxML09wZW4gU291cmNlL09wZW5SZXdyaXRl Co-authored-by: Moderne <team@moderne.io>
1 parent 25fcfd5 commit b30c1e0

4 files changed

Lines changed: 163 additions & 20 deletions

File tree

  • rewrite-gradle/src/main/resources/META-INF/rewrite
  • rewrite-maven/src/main/resources/META-INF/rewrite
  • rewrite-properties/src/main/resources/META-INF/rewrite
  • rewrite-scala/src/main/resources/META-INF/rewrite

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

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -754,6 +754,61 @@ examples:
754754
language: groovy
755755
---
756756
type: specs.openrewrite.org/v1beta/example
757+
recipeName: org.openrewrite.gradle.SortDependencies
758+
examples:
759+
- description: '`SortDependenciesTest#sortsByConfigurationThenGroupThenArtifact`'
760+
sources:
761+
- before: |
762+
plugins {
763+
id 'java-library'
764+
}
765+
766+
repositories {
767+
mavenCentral()
768+
}
769+
770+
dependencies {
771+
testImplementation "org.junit.jupiter:junit-jupiter-api:5.9.1"
772+
implementation "org.springframework:spring-web:5.3.23"
773+
api "com.google.guava:guava:31.1-jre"
774+
implementation "com.fasterxml.jackson.core:jackson-databind:2.13.4"
775+
}
776+
after: |
777+
plugins {
778+
id 'java-library'
779+
}
780+
781+
repositories {
782+
mavenCentral()
783+
}
784+
785+
dependencies {
786+
api "com.google.guava:guava:31.1-jre"
787+
implementation "com.fasterxml.jackson.core:jackson-databind:2.13.4"
788+
implementation "org.springframework:spring-web:5.3.23"
789+
testImplementation "org.junit.jupiter:junit-jupiter-api:5.9.1"
790+
}
791+
path: build.gradle
792+
language: groovy
793+
---
794+
type: specs.openrewrite.org/v1beta/example
795+
recipeName: org.openrewrite.gradle.SyncGradleExtPropertiesWithBom
796+
examples:
797+
- description: '`SyncGradleExtPropertiesWithBomTest#updatesExtSubscriptPropertyWhenBomVersionIsHigher`'
798+
parameters:
799+
- org.springframework.boot
800+
- spring-boot-dependencies
801+
- 3.4.0
802+
- 'false'
803+
sources:
804+
- before: |
805+
ext['jackson-bom.version'] = '2.14.0'
806+
after: |
807+
ext['jackson-bom.version'] = '2.18.1'
808+
path: build.gradle
809+
language: groovy
810+
---
811+
type: specs.openrewrite.org/v1beta/example
757812
recipeName: org.openrewrite.gradle.UpdateGradleWrapper
758813
examples:
759814
- description: Update existing Gradle wrapper
@@ -925,6 +980,28 @@ examples:
925980
language: groovy
926981
---
927982
type: specs.openrewrite.org/v1beta/example
983+
recipeName: org.openrewrite.gradle.UsePropertyAssignmentSyntax
984+
examples:
985+
- description: '`UsePropertyAssignmentSyntaxTest#spaceSyntaxConvertedToAssignment`'
986+
parameters:
987+
- description
988+
sources:
989+
- before: |
990+
tasks.register('runLogic', JavaExec) {
991+
description 'My precious logic'
992+
classpath sourceSets.main.runtimeClasspath
993+
mainClass = 'my.org.logic.Logic'
994+
}
995+
after: |
996+
tasks.register('runLogic', JavaExec) {
997+
description = 'My precious logic'
998+
classpath sourceSets.main.runtimeClasspath
999+
mainClass = 'my.org.logic.Logic'
1000+
}
1001+
path: build.gradle
1002+
language: groovy
1003+
---
1004+
type: specs.openrewrite.org/v1beta/example
9281005
recipeName: org.openrewrite.gradle.gradle8.JacocoReportDeprecations
9291006
examples:
9301007
- description: '`JacocoReportDeprecationsTest#deprecationsInNormalSyntax`'

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

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2462,6 +2462,62 @@ examples:
24622462
language: xml
24632463
---
24642464
type: specs.openrewrite.org/v1beta/example
2465+
recipeName: org.openrewrite.maven.SortDependencies
2466+
examples:
2467+
- description: '`SortDependenciesTest#sortsByGroupIdThenArtifactId`'
2468+
sources:
2469+
- before: |
2470+
<project>
2471+
<modelVersion>4.0.0</modelVersion>
2472+
<groupId>com.mycompany.app</groupId>
2473+
<artifactId>my-app</artifactId>
2474+
<version>1</version>
2475+
<dependencies>
2476+
<dependency>
2477+
<groupId>org.junit.jupiter</groupId>
2478+
<artifactId>junit-jupiter</artifactId>
2479+
<version>5.9.1</version>
2480+
</dependency>
2481+
<dependency>
2482+
<groupId>com.google.guava</groupId>
2483+
<artifactId>guava</artifactId>
2484+
<version>29.0-jre</version>
2485+
</dependency>
2486+
<dependency>
2487+
<groupId>com.fasterxml.jackson.core</groupId>
2488+
<artifactId>jackson-databind</artifactId>
2489+
<version>2.13.0</version>
2490+
</dependency>
2491+
</dependencies>
2492+
</project>
2493+
after: |
2494+
<project>
2495+
<modelVersion>4.0.0</modelVersion>
2496+
<groupId>com.mycompany.app</groupId>
2497+
<artifactId>my-app</artifactId>
2498+
<version>1</version>
2499+
<dependencies>
2500+
<dependency>
2501+
<groupId>com.fasterxml.jackson.core</groupId>
2502+
<artifactId>jackson-databind</artifactId>
2503+
<version>2.13.0</version>
2504+
</dependency>
2505+
<dependency>
2506+
<groupId>com.google.guava</groupId>
2507+
<artifactId>guava</artifactId>
2508+
<version>29.0-jre</version>
2509+
</dependency>
2510+
<dependency>
2511+
<groupId>org.junit.jupiter</groupId>
2512+
<artifactId>junit-jupiter</artifactId>
2513+
<version>5.9.1</version>
2514+
</dependency>
2515+
</dependencies>
2516+
</project>
2517+
path: pom.xml
2518+
language: xml
2519+
---
2520+
type: specs.openrewrite.org/v1beta/example
24652521
recipeName: org.openrewrite.maven.UpdateMavenProjectPropertyJavaVersion
24662522
examples:
24672523
- description: '`UpdateMavenProjectPropertyJavaVersionTest#basic`'

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

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,6 @@
1313
# limitations under the License.
1414
---
1515
type: specs.openrewrite.org/v1beta/example
16-
recipeName: org.openrewrite.properties.AddProperty
17-
examples:
18-
- description: '`AddPropertyTest#newProperty`'
19-
parameters:
20-
- management.metrics.enable.process.files
21-
- 'true'
22-
- 'null'
23-
- 'null'
24-
- 'null'
25-
- 'null'
26-
- 'null'
27-
sources:
28-
- before: |
29-
management=true
30-
after: |
31-
management=true
32-
management.metrics.enable.process.files=true
33-
language: properties
34-
---
35-
type: specs.openrewrite.org/v1beta/example
3616
recipeName: org.openrewrite.properties.AddPropertyComment
3717
examples:
3818
- description: '`AddPropertyCommentTest#shouldAddCommentToFirstProperty`'

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Copyright 2025 the original author or authors.
2+
# <p>
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
# <p>
7+
# https://www.apache.org/licenses/LICENSE-2.0
8+
# <p>
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
---
15+
type: specs.openrewrite.org/v1beta/example
16+
recipeName: org.openrewrite.scala.ScalaTemplateRecipeTest$ReplaceEqualsOne
17+
examples:
18+
- description: '`ScalaTemplateRecipeTest#replaceMatchedExpression`'
19+
sources:
20+
- before: |
21+
class Test {
22+
val b1 = 5 == 1
23+
val b2 = 5 == 2
24+
}
25+
after: |
26+
class Test {
27+
val b1 = true
28+
val b2 = 5 == 2
29+
}
30+
language: scala

0 commit comments

Comments
 (0)
⚡