Common static analysis issues

Add to your build

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.staticanalysis.CommonStaticAnalysis")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-static-analysis:2.44.0")
}

./gradlew rewriteRun

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.staticanalysis.CommonStaticAnalysis

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-static-analysis:RELEASE

Definition

This recipe runs the following recipes in order.

• Constructors of an abstract class should not be declared publicorg.openrewrite.staticanalysis.AbstractClassPublicConstructor
• Atomic Boolean, Integer, and Long equality checks compare their valuesorg.openrewrite.staticanalysis.AtomicPrimitiveEqualsUsesGet
• new BigDecimal(double) should not be usedorg.openrewrite.staticanalysis.BigDecimalDoubleConstructorRecipe
• BigDecimal rounding constants to RoundingMode enumsorg.openrewrite.staticanalysis.BigDecimalRoundingConstantsToEnums
• Boolean checks should not be invertedorg.openrewrite.staticanalysis.BooleanChecksNotInverted
• CaseInsensitive comparisons do not alter caseorg.openrewrite.staticanalysis.CaseInsensitiveComparisonsDoNotChangeCase
• Catch clause should do more than just rethroworg.openrewrite.staticanalysis.CatchClauseOnlyRethrows
• Chain StringBuilder.append() callsorg.openrewrite.staticanalysis.ChainStringBuilderAppendCalls
• 'Collection.toArray()' should be passed an array of the proper typeorg.openrewrite.staticanalysis.CollectionToArrayShouldHaveProperType
• Covariant equalsorg.openrewrite.staticanalysis.CovariantEquals
• Default comes lastorg.openrewrite.staticanalysis.DefaultComesLast
• Remove empty blocksorg.openrewrite.staticanalysis.EmptyBlock
• Equals avoids nullorg.openrewrite.staticanalysis.EqualsAvoidsNull
• Explicit initializationorg.openrewrite.staticanalysis.ExplicitInitialization
• Externalizable classes have no-arguments constructororg.openrewrite.staticanalysis.ExternalizableHasNoArgsConstructor
• Finalize private fieldsorg.openrewrite.staticanalysis.FinalizePrivateFields
• Fall throughorg.openrewrite.staticanalysis.FallThrough
• Finalize classes with private constructorsorg.openrewrite.staticanalysis.FinalClass
• Fix String#format and String#formatted expressionsorg.openrewrite.staticanalysis.FixStringFormatExpressions
• for loop counters incremented in updateorg.openrewrite.staticanalysis.ForLoopIncrementInUpdate
• Use indexOf(String, int)org.openrewrite.staticanalysis.IndexOfChecksShouldUseAStartPosition
• indexOf() replaceable by contains()org.openrewrite.staticanalysis.IndexOfReplaceableByContains
• indexOf should not compare greater than zeroorg.openrewrite.staticanalysis.IndexOfShouldNotCompareGreaterThanZero
• Inline variableorg.openrewrite.staticanalysis.InlineVariable
• Use Collection#isEmpty() instead of comparing size()org.openrewrite.staticanalysis.IsEmptyCallOnCollections
• Simplify lambda blocks to expressionsorg.openrewrite.staticanalysis.LambdaBlockToExpression
• Standardize method name casingorg.openrewrite.staticanalysis.MethodNameCasing
• switch statements should have at least 3 case clausesorg.openrewrite.staticanalysis.MinimumSwitchCases
• Modifier orderorg.openrewrite.staticanalysis.ModifierOrder
• No multiple variable declarationsorg.openrewrite.staticanalysis.MultipleVariableDeclarations
• Fix missing bracesorg.openrewrite.staticanalysis.NeedBraces
• Nested enums are not staticorg.openrewrite.staticanalysis.NestedEnumsAreNotStatic
• Change StringBuilder and StringBuffer character constructor argument to Stringorg.openrewrite.staticanalysis.NewStringBuilderBufferWithCharArgument
• No double brace initializationorg.openrewrite.staticanalysis.NoDoubleBraceInitialization
• Use Collections#emptyList(), emptyMap(), and emptySet()org.openrewrite.staticanalysis.NoEmptyCollectionWithRawType
• Use comparison rather than equality checks in for conditionsorg.openrewrite.staticanalysis.NoEqualityInForCondition
• Remove finalize() methodorg.openrewrite.staticanalysis.NoFinalizer
• No primitive wrappers for #toString() or #compareTo(..)org.openrewrite.staticanalysis.NoPrimitiveWrappersForToStringOrCompareTo
• Jump statements should not be redundantorg.openrewrite.staticanalysis.NoRedundantJumpStatements
• Unnecessary String#toStringorg.openrewrite.staticanalysis.NoToStringOnStringType
• Unnecessary String#valueOf(..)org.openrewrite.staticanalysis.NoValueOfOnStringType
• finalize() calls superorg.openrewrite.staticanalysis.ObjectFinalizeCallsSuper
• Prefer System.getProperty("user.home") over System.getenv("HOME")org.openrewrite.staticanalysis.PreferSystemGetPropertyOverGetenv
• Use primitive wrapper valueOf methodorg.openrewrite.staticanalysis.PrimitiveWrapperClassConstructorToValueOf
• Redundant file creationorg.openrewrite.staticanalysis.RedundantFileCreation
• Remove extra semicolonsorg.openrewrite.staticanalysis.RemoveExtraSemicolons
• Remove no argument super() constructor callsorg.openrewrite.staticanalysis.RemoveNoArgumentSuperConstructorCall
• Remove redundant null checks before instanceoforg.openrewrite.staticanalysis.RemoveRedundantNullCheckBeforeInstanceof
• Remove redundant null checks before literal equalsorg.openrewrite.staticanalysis.RemoveRedundantNullCheckBeforeLiteralEquals
• Rename methods named hashcode, equal, or tostringorg.openrewrite.staticanalysis.RenameMethodsNamedHashcodeEqualOrToString
• Replace A.class.isInstance(a) with a instanceof Aorg.openrewrite.staticanalysis.ReplaceClassIsInstanceWithInstanceof
• Use method references in lambdaorg.openrewrite.staticanalysis.ReplaceLambdaWithMethodReference
• Replace StringBuilder#append with Stringorg.openrewrite.staticanalysis.ReplaceStringBuilderWithString
• Replace String concatenation with String.valueOf()org.openrewrite.staticanalysis.ReplaceStringConcatenationWithStringValueOf
• Simplify Arrays.asList(..) with varargsorg.openrewrite.staticanalysis.SimplifyArraysAsList
• Simplify boolean expressionorg.openrewrite.staticanalysis.SimplifyBooleanExpression
• Simplify boolean returnorg.openrewrite.staticanalysis.SimplifyBooleanReturn
• Static methods need not be finalorg.openrewrite.staticanalysis.StaticMethodNotFinal
• Use String.equals() on String literalsorg.openrewrite.staticanalysis.StringLiteralEquality
• Unnecessary close in try-with-resourcesorg.openrewrite.staticanalysis.UnnecessaryCloseInTryWithResources
• Unnecessary explicit type argumentsorg.openrewrite.staticanalysis.UnnecessaryExplicitTypeArguments
• Remove unnecessary parenthesesorg.openrewrite.staticanalysis.UnnecessaryParentheses
• Remove @Nullable and @CheckForNull annotations from primitivesorg.openrewrite.staticanalysis.UnnecessaryPrimitiveAnnotations
• Unnecessary return as last statement in void methodorg.openrewrite.staticanalysis.UnnecessaryReturnAsLastStatement
• Upper case literal suffixesorg.openrewrite.staticanalysis.UpperCaseLiteralSuffixes
• Use the diamond operatororg.openrewrite.staticanalysis.UseDiamondOperator
• No C-style array declarationsorg.openrewrite.staticanalysis.UseJavaStyleArrayDeclarations
• Use %n instead of \n in format stringsorg.openrewrite.staticanalysis.UsePortableNewlines
• Prefer while over for loopsorg.openrewrite.staticanalysis.WhileInsteadOfFor
• Write octal values as decimalorg.openrewrite.staticanalysis.WriteOctalValuesAsDecimal
• Structural equality tests should use == or !=org.openrewrite.kotlin.cleanup.EqualsMethodUsage
• it shouldn't be used as a lambda parameter nameorg.openrewrite.kotlin.cleanup.ImplicitParameterInLambda
• Replace Char#toInt() with Char#codeorg.openrewrite.kotlin.cleanup.ReplaceCharToIntWithCode
• Order importsorg.openrewrite.java.OrderImports

Data tables

Structured output this recipe can produce.

• Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
• Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
• Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
• Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats