rewrite.yml

#
# Copyright 2024 the original author or authors.
# <p>
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# <p>
# https://www.apache.org/licenses/LICENSE-2.0
# <p>
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
---
# Apply a subset of best practices to OpenRewrite recipes; typically run before committing changes.
# Any differences produced by this recipe will result in code suggestion comments on pull requests.
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.recipes.rewrite.OpenRewriteRecipeBestPracticesSubset
displayName: OpenRewrite best practices
description: Best practices for OpenRewrite recipe development.
preconditions:
  - org.openrewrite.FindSourceFiles:
      filePattern: "!(**/internal/grammar/*.*)"
recipeList:
  - org.openrewrite.recipes.JavaRecipeBestPracticesSubset
  - org.openrewrite.recipes.RecipeTestingBestPracticesSubset
  - org.openrewrite.recipes.RecipeNullabilityBestPracticesSubset
#  - org.openrewrite.java.recipes.ExamplesExtractor
#  - org.openrewrite.java.OrderImports
  - org.openrewrite.java.RemoveUnusedImports
  - org.openrewrite.java.SimplifySingleElementAnnotation
  - org.openrewrite.java.format.EmptyNewlineAtEndOfFile
  - org.openrewrite.java.format.RemoveTrailingWhitespace
  - org.openrewrite.staticanalysis.CompareEnumsWithEqualityOperator
  - org.openrewrite.staticanalysis.EqualsAvoidsNull
  - org.openrewrite.staticanalysis.InlineVariable
  - org.openrewrite.staticanalysis.LambdaBlockToExpression
  - org.openrewrite.staticanalysis.MissingOverrideAnnotation
  - org.openrewrite.staticanalysis.OperatorWrap:
      wrapOption: EOL
#  - org.openrewrite.staticanalysis.RemoveRedundantNullCheckBeforeInstanceof
#  - org.openrewrite.staticanalysis.RemoveUnusedLocalVariables
#  - org.openrewrite.staticanalysis.RemoveUnusedPrivateFields
#  - org.openrewrite.staticanalysis.RemoveUnusedPrivateMethods
#  - org.openrewrite.staticanalysis.UnwrapElseAfterReturn
  - org.openrewrite.staticanalysis.UseDiamondOperator
  - org.openrewrite.java.UseStaticImport:
      methodPattern: java.util.stream.Collectors *(..)
  - org.openrewrite.java.UseStaticImport:
      methodPattern: java.util.Collections *(..)
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.recipes.JavaRecipeBestPracticesSubset
displayName: Java Recipe best practices
description: Best practices for Java recipe development.
preconditions:
  - org.openrewrite.java.search.FindTypes:
      fullyQualifiedTypeName: org.openrewrite.Recipe
      checkAssignability: true
recipeList:
  - org.openrewrite.java.recipes.BlankLinesAroundFieldsWithAnnotations
  - org.openrewrite.java.recipes.CorrectlySpacedDescriptions
#  - org.openrewrite.java.recipes.ExecutionContextParameterName
  - org.openrewrite.java.recipes.IsLiteralNullRecipe
  - org.openrewrite.java.recipes.MissingOptionExample
  - org.openrewrite.java.recipes.NoMutableStaticFieldsInRecipes
  - org.openrewrite.java.recipes.RecipeEqualsAndHashCodeCallSuper
  - org.openrewrite.java.recipes.UseTreeRandomId
  - org.openrewrite.java.recipes.migrate.RemoveTraitsUsageRecipes
  - org.openrewrite.staticanalysis.NeedBraces
#  - org.openrewrite.staticanalysis.RemoveSystemOutPrintln
#  - org.openrewrite.java.RemoveAnnotation:
#      annotationPattern: '@org.openrewrite.NlsRewrite.DisplayName'
#  - org.openrewrite.java.RemoveAnnotation:
#      annotationPattern: '@org.openrewrite.NlsRewrite.Description'
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.recipes.RecipeTestingBestPracticesSubset
displayName: Recipe testing best practices
description: Best practices for testing recipes.
preconditions:
  - org.openrewrite.java.search.FindTypes:
      fullyQualifiedTypeName: org.openrewrite.test.RewriteTest
      checkAssignability: true
recipeList:
  - org.openrewrite.java.recipes.RewriteTestClassesShouldNotBePublic
#  - org.openrewrite.java.recipes.SelectRecipeExamples
  - org.openrewrite.java.recipes.SingleDocumentExample
  - org.openrewrite.java.recipes.ReorderTestMethods
  - org.openrewrite.java.recipes.ReplaceNullWithDoesNotExist
  - org.openrewrite.java.recipes.SourceSpecTextBlockNewLine
  - org.openrewrite.java.recipes.SourceSpecTextBlockIndentation
  - org.openrewrite.java.testing.cleanup.RemoveTestPrefix
  - org.openrewrite.java.testing.cleanup.TestsShouldNotBePublic
  - org.openrewrite.staticanalysis.NeedBraces
#  - org.openrewrite.staticanalysis.RemoveSystemOutPrintln
  - org.openrewrite.staticanalysis.ReorderAnnotations
  - org.openrewrite.java.UseStaticImport:
      methodPattern: 'org.openrewrite..Assertions *(..)'
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.recipes.RecipeNullabilityBestPracticesSubset
displayName: Recipe nullability best practices
description: Use OpenRewrite internal nullability annotations; drop JetBrains annotations; use `package-info.java` instead.
recipeList:
#  - org.openrewrite.java.jspecify.MigrateFromOpenRewriteAnnotations
  - org.openrewrite.java.RemoveAnnotation:
      annotationPattern: '@org.jetbrains.annotations.NotNull'
#  - org.openrewrite.java.RemoveAnnotation:
#      annotationPattern: '@javax.annotation.Nonnull'
  - org.openrewrite.java.RemoveAnnotation:
      annotationPattern: '@jakarta.annotation.Nonnull'
#  - org.openrewrite.java.jspecify.MigrateToJspecify
#  - org.openrewrite.staticanalysis.AnnotateNullableMethods
  - org.openrewrite.staticanalysis.NullableOnMethodReturnType