Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve categorization & descriptions #7

Merged
merged 2 commits into from
Jul 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ public class CucumberAnnotationToSuite extends Recipe {

@Override
public String getDisplayName() {
return "Replace @Cucumber with @Suite";
return "Replace `@Cucumber` with `@Suite`";
}

@Override
public String getDescription() {
return "Replace @Cucumber with @Suite and @SelectClasspathResource(\"cucumber/annotated/class/package\").";
return "Replace `@Cucumber` with `@Suite` and `@SelectClasspathResource(\"cucumber/annotated/class/package\")`.";
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,12 +55,12 @@ public class CucumberJava8HookDefinitionToCucumberJava extends Recipe {

@Override
public String getDisplayName() {
return "Replace Cucumber-Java8 hook definition with Cucumber-Java";
return "Replace `cucumber-java8` hook definition with `cucumber-java`";
}

@Override
public String getDescription() {
return "Replace LambdaGlue hook definitions with new annotated methods with the same body.";
return "Replace `LambdaGlue` hook definitions with new annotated methods with the same body.";
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,12 @@ public class CucumberJava8StepDefinitionToCucumberJava extends Recipe {

@Override
public String getDisplayName() {
return "Replace Cucumber-Java8 step definitions with Cucumber-Java";
return "Replace `cucumber-java8` step definitions with `cucumber-java`";
}

@Override
public String getDescription() {
return "Replace StepDefinitionBody methods with StepDefinitionAnnotations on new methods with the same body.";
return "Replace `StepDefinitionBody` methods with `StepDefinitionAnnotations` on new methods with the same body.";
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ public class DropSummaryPrinter extends Recipe {

@Override
public String getDisplayName() {
return "Drop SummaryPrinter";
return "Drop `SummaryPrinter`";
}

@Override
public String getDescription() {
return "Replace SummaryPrinter with Plugin, if not already present.";
return "Replace `SummaryPrinter` with `Plugin`, if not already present.";
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public class RegexToCucumberExpression extends Recipe {

@Override
public String getDisplayName() {
return "Replace Cucumber-Java step definition regexes with Cucumber expressions";
return "Replace `cucumber-java` step definition regexes with Cucumber expressions";
}

@Override
Expand Down
5 changes: 5 additions & 0 deletions src/main/resources/META-INF/rewrite/category.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@
#
---
type: specs.openrewrite.org/v1beta/category
name: Cucumber
packageName: org.openrewrite.cucumber
description: Recipes for upgrading [Cucumber](https://cucumber.io/).
---
type: specs.openrewrite.org/v1beta/category
name: Cucumber-JVM
packageName: org.openrewrite.cucumber.jvm
description: Recipes for upgrading [Cucumber-JVM](https://github.com/cucumber/cucumber-jvm/).
8 changes: 4 additions & 4 deletions src/main/resources/META-INF/rewrite/cucumber.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ recipeList:
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.cucumber.jvm.CucumberJava8ToJava
displayName: Cucumber-Java8 migration to Cucumber-Java
description: Migrates Cucumber-Java8 step definitions and LambdaGlue hooks to Cucumber-Java annotated methods.
displayName: Migrate `cucumber-java8` to `cucumber-java`
description: Migrates `cucumber-java8` step definitions and `LambdaGlue` hooks to `cucumber-java` annotated methods.
tags:
- testing
- cucumber
Expand All @@ -86,8 +86,8 @@ recipeList:
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.cucumber.jvm.CucumberToJunitPlatformSuite
displayName: Cucumber to JUnit Test Suites
description: Migrates Cucumber tests to JUnit Test Suites.
displayName: Cucumber to JUnit test `@Suite`
description: Migrates Cucumber tests to JUnit test `@Suite`.
tags:
- testing
- cucumber
Expand Down