codenarc.ruleset

/*
 * CodeNarc RuleSet Configuration
 * =============================
 *
 * PRIORITY LEVELS (severity):
 *   1 = High (critical issues)
 *   2 = Medium (standard issues)
 *   3 = Low (minor/style issues)
 *
 * PRIORITY TO REPORT SEVERITY MAPPING:
 *   CodeNarc Priority 1 → critical
 *   CodeNarc Priority 2 → major
 *   CodeNarc Priority 3 → minor
 *   (Note: 'info' and 'blocker' severities are not used by CodeNarc rules)
 *
 * CONFIGURATION SYNTAX:
 *   RuleName                    // Use default settings
 *   RuleName { ... }            // Configure with properties
 *   RuleName(priority:1)        // Shorthand for priority only
 *   // RuleName                  // Commented out = disabled
 *
 * COMMON PROPERTIES:
 *   priority                    // 1, 2, or 3
 *   enabled                     // true/false (default: true)
 *   applyToFileNames            // Pattern for files to check (e.g., '*.groovy')
 *   doNotApplyToFileNames       // Pattern for files to exclude (e.g., '*Test.groovy')
 *   regex                       // For naming rules, validation pattern
 *
 * For full documentation: https://codenarc.org/
 */

ruleset {

    description '''
        Pricefx CodeNarc RuleSet - maintained by the Competency Leads team.
        Contains selected CodeNarc rules with custom configurations for Pricefx projects.
        '''

    // rulesets/basic.xml
    AssertWithinFinallyBlock
    // AssignmentInConditional
    BigDecimalInstantiation
    BitwiseOperatorInConditional
    BooleanGetBoolean
    BrokenNullCheck
    BrokenOddnessCheck
    // ClassForName
    ComparisonOfTwoConstants
    ComparisonWithSelf
    // ConstantAssertExpression
    ConstantIfExpression
    ConstantTernaryExpression
    DeadCode
    DoubleNegative
    DuplicateCaseStatement
    DuplicateMapKey
    DuplicateSetValue
    EmptyCatchBlock
    EmptyClass
    EmptyElseBlock
    EmptyFinallyBlock
    EmptyForStatement
    EmptyIfStatement
    // EmptyInstanceInitializer
    EmptyMethod
    // EmptyStaticInitializer
    EmptySwitchStatement
    EmptySynchronizedStatement
    EmptyTryBlock
    EmptyWhileStatement
    // EqualsAndHashCode
    // EqualsOverloaded
    // ExplicitGarbageCollection
    ForLoopShouldBeWhileLoop
    // HardCodedWindowsFileSeparator
    // HardCodedWindowsRootDirectory
    IntegerGetInteger
    MultipleUnaryOperators
    ParameterAssignmentInFilterClosure
    RandomDoubleCoercedToZero
    RemoveAllOnSelf
    ReturnFromFinallyBlock
    ThrowExceptionFromFinallyBlock

    // rulesets/braces.xml
    ElseBlockBraces
    ForStatementBraces
    IfStatementBraces
    WhileStatementBraces

    // rulesets/comments.xml
    // ClassJavadoc
    JavadocConsecutiveEmptyLines
    JavadocEmptyAuthorTag
    JavadocEmptyExceptionTag
    JavadocEmptyFirstLine
    JavadocEmptyLastLine
    JavadocEmptyParamTag
    JavadocEmptyReturnTag
    JavadocEmptySeeTag
    JavadocEmptySinceTag
    JavadocEmptyThrowsTag
    JavadocEmptyVersionTag
    JavadocMissingExceptionDescription
    JavadocMissingParamDescription
    JavadocMissingThrowsDescription

    // rulesets/concurrency.xml
    // BusyWait
    // DoubleCheckedLocking
    // InconsistentPropertyLocking
    // InconsistentPropertySynchronization
    NestedSynchronization
    // StaticCalendarField
    // StaticConnection
    // StaticDateFormatField
    // StaticMatcherField
    // StaticSimpleDateFormatField
    // SynchronizedMethod
    // SynchronizedOnBoxedPrimitive
    // SynchronizedOnGetClass
    // SynchronizedOnReentrantLock
    // SynchronizedOnString
    // SynchronizedOnThis
    // SynchronizedReadObjectMethod
    // SystemRunFinalizersOnExit
    // ThisReferenceEscapesConstructor
    // ThreadGroup
    // ThreadLocalNotStaticFinal
    // ThreadYield
    // UseOfNotifyMethod
    // VolatileArrayField
    // VolatileLongOrDoubleField
    // WaitOutsideOfWhileLoop

    // rulesets/convention.xml
    // CompileStatic
    ConfusingTernary
    CouldBeElvis
    CouldBeSwitchStatement
    // FieldTypeRequired // we can't use class fields - will cause some weird errors
    HashtableIsObsolete
    // IfStatementCouldBeTernary // See PFAUT-1244
    // ImplicitClosureParameter
    ImplicitReturnStatement
    InvertedCondition
    InvertedIfElse(priority:3)
    LongLiteralWithLowerCaseL
    MethodParameterTypeRequired
    MethodReturnTypeRequired {
        ignoreMethodNames = "* *" // Skip checking unit test method names. Most of test cases have spaces in names so it should be good enough.
    }
    // NoDef // On one hand side, it is useful, but on the other, we have a lot of defs where we can't use the PfX type or else tests will fail
    NoDouble
    NoFloat
    // NoJavaUtilDate // We can't use the suggested java.time.* package either way
    // NoTabCharacter
    ParameterReassignment
    // PublicMethodsBeforeNonPublicMethods
    // StaticFieldsBeforeInstanceFields
    // StaticMethodsBeforeInstanceMethods
    TernaryCouldBeElvis
    // TrailingComma
    // VariableTypeRequired // Same as NoDef
    // VectorIsObsolete

    // rulesets/design.xml
    // AbstractClassWithPublicConstructor
    // AbstractClassWithoutAbstractMethod
    // AssignmentToStaticFieldFromInstanceMethod
    // BooleanMethodReturnsNull   // violates: if (api.syntaxCheck) return; return true;
    // BuilderMethodWithSideEffects
    // CloneableWithoutClone
    // CloseWithoutCloseable
    // CompareToWithoutComparable
    // ConstantsOnlyInterface
    // EmptyMethodInAbstractClass
    // FinalClassWithProtectedMember
    // ImplementationAsType
    // Instanceof
    // LocaleSetDefault
    // NestedForLoop
    // OptionalCollectionReturnType
    // OptionalField
    // OptionalMethodParameter
    // PrivateFieldCouldBeFinal
    // PublicInstanceField
    ReturnsNullInsteadOfEmptyArray
    ReturnsNullInsteadOfEmptyCollection
    // SimpleDateFormatMissingLocale
    // StatelessSingleton
    // ToStringReturnsNull

    // rulesets/dry.xml
    // DuplicateListLiteral   // ["sku"] or customer business specific data
    // DuplicateMapLiteral    // violations in highcharts definitions; calculations of customer business specific data may violate this
    // DuplicateNumberLiteral // calculations of customer business specific data may violate this
    // DuplicateStringLiteral // working with constants in PFX is cumbersome

    // rulesets/enhanced.xml
    // CloneWithoutCloneable
    // JUnitAssertEqualsConstantActualValue
    // MissingOverrideAnnotation
    // UnsafeImplementationAsMap

    // rulesets/exceptions.xml
    CatchArrayIndexOutOfBoundsException
    CatchError
    // CatchException
    // CatchIllegalMonitorStateException
    CatchIndexOutOfBoundsException
    CatchNullPointerException
    CatchRuntimeException
    CatchThrowable
    // ConfusingClassNamedException
    // ExceptionExtendsError
    // ExceptionExtendsThrowable
    ExceptionNotThrown
    MissingNewInThrowStatement
    ReturnNullFromCatchBlock
    // SwallowThreadDeath
    // ThrowError // We can't have our own exception types, so we may need some generic types
    //ThrowException // See PFAUT-1244
    ThrowNullPointerException
    ThrowRuntimeException {
        doNotApplyToFileNames = '*Test.groovy'
    }
    ThrowThrowable

    // rulesets/formatting.xml
    // BlankLineBeforePackage
    BlockEndsWithBlankLine
    BlockStartsWithBlankLine(priority:3)
    BracesForClass
    BracesForForLoop
    BracesForIfElse
    BracesForMethod
    BracesForTryCatchFinally
    // ClassEndsWithBlankLine
    // ClassStartsWithBlankLine
    ClosureStatementOnOpeningLineOfMultipleLineClosure
    ConsecutiveBlankLines
    FileEndsWithoutNewline
    // Indentation
    // LineLength
    MissingBlankLineAfterImports
    MissingBlankLineAfterPackage
    MissingBlankLineBeforeAnnotatedField

    // SEE PFAUT-1244, DISABLED ALL SpaceAfter rules as IntelliJ can't autoformat them, so we can't enforce them
    // SpaceAfterCatch
    // SpaceAfterClosingBrace
    // SpaceAfterComma
    // SpaceAfterFor
    // SpaceAfterIf
    // SpaceAfterMethodCallName
    // SpaceAfterMethodDeclarationName
    // SpaceAfterNotOperator
    // SpaceAfterOpeningBrace
    // SpaceAfterSemicolon
    // SpaceAfterSwitch
    // SpaceAfterWhile

    SpaceAroundClosureArrow
    // SpaceAroundMapEntryColon // Conflicts with IntelliJ autoformatting of maps
    SpaceAroundOperator
    //SpaceBeforeClosingBrace
    SpaceBeforeOpeningBrace
    SpaceInsideParentheses
    TrailingWhitespace

    // rulesets/generic.xml
    // IllegalClassMember
    // IllegalClassReference
    // IllegalPackageReference
    //IllegalRegex {
    //    string = "api\\.input\\("
    //}
    //IllegalString {
    //    regex = "api\\.getElement\\("
    //}
    // IllegalSubclass
    // RequiredRegex
    // RequiredString
    // StatelessClass

    // rulesets/grails.xml
    // GrailsDomainGormMethods
    // GrailsDomainHasEquals
    // GrailsDomainHasToString
    // GrailsDomainReservedSqlKeywordName
    // GrailsDomainStringPropertyMaxSize
    // GrailsDomainWithServiceReference
    // GrailsDuplicateConstraint
    // GrailsDuplicateMapping
    // GrailsMassAssignment
    // GrailsPublicControllerMethod
    // GrailsServletContextReference
    // GrailsStatelessService

    // rulesets/groovyism.xml
    AssignCollectionSort
    AssignCollectionUnique
    //ClosureAsLastMethodParameter // See PFAUT-1244
    CollectAllIsDeprecated
    ConfusingMultipleReturns
    ExplicitArrayListInstantiation
    // ExplicitCallToAndMethod // It catches also Filter calls
    ExplicitCallToCompareToMethod
    ExplicitCallToDivMethod
    ExplicitCallToEqualsMethod // It catches also Filter calls -- really ???
    // ExplicitCallToGetAtMethod // We use a lot of it, because it is the safest for null-checking and works on both, lists and maps.
    ExplicitCallToLeftShiftMethod
    ExplicitCallToMinusMethod
    ExplicitCallToModMethod
    ExplicitCallToMultiplyMethod
    // ExplicitCallToOrMethod // It catches also Filter calls
    ExplicitCallToPlusMethod
    ExplicitCallToPowerMethod
    ExplicitCallToPutAtMethod
    ExplicitCallToRightShiftMethod
    ExplicitCallToXorMethod
    ExplicitHashMapInstantiation
    ExplicitHashSetInstantiation
    ExplicitLinkedHashMapInstantiation
    ExplicitLinkedListInstantiation
    ExplicitStackInstantiation
    ExplicitTreeSetInstantiation
    GStringAsMapKey
    GStringExpressionWithinString
    // GetterMethodCouldBeProperty // We don't use properties, so it returns weird results
    // GroovyLangImmutable
    UseCollectMany
    UseCollectNested

    // rulesets/imports.xml
    DuplicateImport
    // ImportFromSamePackage
    ImportFromSunPackages
    // MisorderedStaticImports // Conflicts with IntelliJ import formatting default settings
    NoWildcardImports
    UnnecessaryGroovyImport
    UnusedImport

    // rulesets/jdbc.xml
    // DirectConnectionManagement
    // JdbcConnectionReference
    // JdbcResultSetReference
    // JdbcStatementReference

    // rulesets/junit.xml
    ChainedTest
    // CoupledTestCase
    // We use Spock
    // JUnitAssertAlwaysFails
    // JUnitAssertAlwaysSucceeds
    // JUnitFailWithoutMessage
    // JUnitLostTest
    // JUnitPublicField
    // JUnitPublicNonTestMethod
    // JUnitPublicProperty
    // JUnitSetUpCallsSuper
    // JUnitStyleAssertions
    // JUnitTearDownCallsSuper
    // JUnitTestMethodWithoutAssert
    // JUnitUnnecessarySetUp
    // JUnitUnnecessaryTearDown
    // JUnitUnnecessaryThrowsException
    SpockIgnoreRestUsed
    // UnnecessaryFail
    // UseAssertEqualsInsteadOfAssertTrue
    // UseAssertFalseInsteadOfNegation
    // UseAssertNullInsteadOfAssertEquals
    // UseAssertSameInsteadOfAssertTrue
    // UseAssertTrueInsteadOfAssertEquals
    // UseAssertTrueInsteadOfNegation

    // rulesets/logging.xml
    // LoggerForDifferentClass
    // LoggerWithWrongModifiers
    // LoggingSwallowsStacktrace
    // MultipleLoggers
    PrintStackTrace
    Println
    SystemErrPrint
    // SystemOutPrint

    // rulesets/naming.xml
    // AbstractClassName
    // ClassName
    // ClassNameSameAsFilename
    // ClassNameSameAsSuperclass
    ConfusingMethodName
    // FactoryMethodName
//     FieldName {        // violates  def RoundingUtils = libs.SharedLib.RoundingUtils
//         regex = "([a-z_][a-zA-Z0-9]*)|([A-Z][A-Z0-9_]*)"
//     }
    // InterfaceName
    // InterfaceNameSameAsSuperInterface
    MethodName {
           regex = "[a-z_]\\w*"
           doNotApplyToFileNames = '*Test.groovy'
    }
    // ObjectOverrideMisspelledMethodName
    // PackageName
    // PackageNameMatchesFilePath
    ParameterName {
       regex = "[a-z_][a-zA-Z0-9]*"
    }
    // PropertyName
//     VariableName {
//         regex = "([a-z_][a-zA-Z0-9]*)|([A-Z][A-Z0-9_]*)"
//     }

    // rulesets/security.xml
    // Not sure we can do any of it
    // FileCreateTempFile
    // InsecureRandom
    // JavaIoPackageAccess
    // NonFinalPublicField
    // NonFinalSubclassOfSensitiveInterface
    // ObjectFinalize
    // PublicFinalizeMethod
    // SystemExit
    // UnsafeArrayDeclaration

    // rulesets/serialization.xml
    // EnumCustomSerializationIgnored
    // SerialPersistentFields
    // SerialVersionUID
    // SerializableClassMustDefineSerialVersionUID

    // rulesets/size.xml
//     MethodName {
//          doNotApplyToFileNames = '*Test.groovy'
//     }
    ClassSize
    // CrapMetric   // Requires the GMetrics jar and a Cobertura coverage file - we don't have coverage
    CyclomaticComplexity {   // Requires the GMetrics jar
      maxMethodComplexity = 50
    }
    MethodCount {
      maxMethods = 60 // See PFAUT-1244
    }
    MethodSize
    NestedBlockDepth
//     ParameterCount

    // rulesets/unnecessary.xml
    AddEmptyString
    ConsecutiveLiteralAppends
    ConsecutiveStringConcatenation
    UnnecessaryBigDecimalInstantiation
    UnnecessaryBigIntegerInstantiation
    UnnecessaryBooleanExpression {
        doNotApplyToFileNames = '*Test.groovy'
    }
    UnnecessaryBooleanInstantiation
    UnnecessaryCallForLastElement
    UnnecessaryCallToSubstring
    UnnecessaryCast
    UnnecessaryCatchBlock
    // UnnecessaryCollectCall
    UnnecessaryCollectionCall
    // UnnecessaryConstructor
    // UnnecessaryDefInFieldDeclaration
    // UnnecessaryDefInMethodDeclaration
    // UnnecessaryDefInVariableDeclaration
    UnnecessaryDotClass
    UnnecessaryDoubleInstantiation
    UnnecessaryElseStatement
    // UnnecessaryFinalOnPrivateMethod
    UnnecessaryFloatInstantiation
    // UnnecessaryGString // It may be too nitpicky. It doesn't make so much difference to differentiate String from GString usually
    // UnnecessaryGetter // Seems faulty. Will also catch keys in maps when values are closures
    UnnecessaryIfStatement
    UnnecessaryInstanceOfCheck
    UnnecessaryInstantiationToGetClass
    UnnecessaryIntegerInstantiation
    UnnecessaryLongInstantiation
    UnnecessaryModOne
    UnnecessaryNullCheck
    UnnecessaryNullCheckBeforeInstanceOf
    // UnnecessaryObjectReferences
    // UnnecessaryOverridingMethod
    UnnecessaryPackageReference
    UnnecessaryParenthesesForMethodCallWithClosure
    UnnecessaryPublicModifier
    // UnnecessaryReturnKeyword
    UnnecessarySafeNavigationOperator
    UnnecessarySelfAssignment
    UnnecessarySemicolon
    // UnnecessarySetter // Seems faulty. Will also catch keys in maps when values are closures
    UnnecessaryStringInstantiation
    UnnecessaryTernaryExpression(priority:3)
    UnnecessaryToString(priority:3)
    // UnnecessaryTransientModifier

    // rulesets/unused.xml
    UnusedArray
    UnusedMethodParameter
    UnusedObject
    UnusedPrivateField
    UnusedPrivateMethod
    UnusedPrivateMethodParameter
    UnusedVariable
}