From dde383a2aa75f94c26d7949665b79cc95486a223 Mon Sep 17 00:00:00 2001
From: Piotr Jaszczyk <piotr.jaszczyk@nokia.com>
Date: Wed, 28 Nov 2018 15:46:50 +0100
Subject: Custom detekt rule for logger usage check
Check if logger invocations don't use unoptimal invocations, eg.
concatenation `debug("a=" + a)` instead of lambda use `debug {"a=" + a}`
Unfortunately to avoid defining dependencies in many places and having
circural dependencies it was necessarry to reorganize the maven module
structure. The goal was to have `sources` module with production code and
`build` module with build-time tooling (detekt rules among them).
Issue-ID: DCAEGEN2-1002
Change-Id: I36e677b98972aaae6905d722597cbce5e863d201
Signed-off-by: Piotr Jaszczyk <piotr.jaszczyk@nokia.com>
---
.../src/main/resources/onap-detekt-config.yml | 475 ---------------------
1 file changed, 475 deletions(-)
delete mode 100644 hv-collector-analysis/src/main/resources/onap-detekt-config.yml
(limited to 'hv-collector-analysis/src/main')
diff --git a/hv-collector-analysis/src/main/resources/onap-detekt-config.yml b/hv-collector-analysis/src/main/resources/onap-detekt-config.yml
deleted file mode 100644
index 99faaa79..00000000
--- a/hv-collector-analysis/src/main/resources/onap-detekt-config.yml
+++ /dev/null
@@ -1,475 +0,0 @@
-autoCorrect: true
-failFast: false
-
-test-pattern: # Configure exclusions for test sources
- active: true
- patterns: # Test file regexes
- - '.*/test/.*'
- - '.*Test.kt'
- - '.*Spec.kt'
- exclude-rule-sets:
- - 'comments'
- exclude-rules:
- - 'NamingRules'
- - 'WildcardImport'
- - 'MagicNumber'
- - 'MaxLineLength'
- - 'LateinitUsage'
- - 'StringLiteralDuplication'
- - 'SpreadOperator'
- - 'TooManyFunctions'
- - 'ForEachOnRange'
-
-build:
- maxIssues: 3
- weights:
- # complexity: 2
- # LongParameterList: 1
- # style: 1
- # comments: 1
-
-processors:
- active: true
- exclude:
- # - 'FunctionCountProcessor'
- # - 'PropertyCountProcessor'
- # - 'ClassCountProcessor'
- # - 'PackageCountProcessor'
- # - 'KtFileCountProcessor'
-
-console-reports:
- active: true
- exclude:
- # - 'ProjectStatisticsReport'
- # - 'ComplexityReport'
- # - 'NotificationReport'
- # - 'FindingsReport'
- # - 'BuildFailureReport'
-
-output-reports:
- active: true
- exclude:
- # - 'HtmlOutputReport'
- # - 'PlainOutputReport'
- # - 'XmlOutputReport'
-
-comments:
- active: true
- CommentOverPrivateFunction:
- active: false
- CommentOverPrivateProperty:
- active: false
- EndOfSentenceFormat:
- active: false
- endOfSentenceFormat: ([.?!][ \t\n\r\f<])|([.?!]$)
- UndocumentedPublicClass:
- active: false
- searchInNestedClass: true
- searchInInnerClass: true
- searchInInnerObject: true
- searchInInnerInterface: true
- UndocumentedPublicFunction:
- active: false
-
-complexity:
- active: true
- ComplexCondition:
- active: true
- threshold: 4
- ComplexInterface:
- active: false
- threshold: 10
- includeStaticDeclarations: false
- ComplexMethod:
- active: true
- threshold: 10
- ignoreSingleWhenExpression: false
- LabeledExpression:
- active: false
- LargeClass:
- active: true
- threshold: 150
- LongMethod:
- active: true
- threshold: 20
- LongParameterList:
- active: true
- threshold: 6
- ignoreDefaultParameters: false
- MethodOverloading:
- active: false
- threshold: 6
- NestedBlockDepth:
- active: true
- threshold: 4
- StringLiteralDuplication:
- active: false
- threshold: 3
- ignoreAnnotation: true
- excludeStringsWithLessThan5Characters: true
- ignoreStringsRegex: '$^'
- TooManyFunctions:
- active: true
- thresholdInFiles: 11
- thresholdInClasses: 11
- thresholdInInterfaces: 11
- thresholdInObjects: 11
- thresholdInEnums: 11
- ignoreDeprecated: false
-
-empty-blocks:
- active: true
- EmptyCatchBlock:
- active: true
- allowedExceptionNameRegex: "^(_|(ignore|expected).*)"
- EmptyClassBlock:
- active: true
- EmptyDefaultConstructor:
- active: true
- EmptyDoWhileBlock:
- active: true
- EmptyElseBlock:
- active: true
- EmptyFinallyBlock:
- active: true
- EmptyForBlock:
- active: true
- EmptyFunctionBlock:
- active: true
- ignoreOverriddenFunctions: false
- EmptyIfBlock:
- active: true
- EmptyInitBlock:
- active: true
- EmptyKtFile:
- active: true
- EmptySecondaryConstructor:
- active: true
- EmptyWhenBlock:
- active: true
- EmptyWhileBlock:
- active: true
-
-exceptions:
- active: true
- ExceptionRaisedInUnexpectedLocation:
- active: false
- methodNames: 'toString,hashCode,equals,finalize'
- InstanceOfCheckForException:
- active: false
- NotImplementedDeclaration:
- active: false
- PrintStackTrace:
- active: false
- RethrowCaughtException:
- active: false
- ReturnFromFinally:
- active: false
- SwallowedException:
- active: false
- ThrowingExceptionFromFinally:
- active: false
- ThrowingExceptionInMain:
- active: false
- ThrowingExceptionsWithoutMessageOrCause:
- active: false
- exceptions: 'IllegalArgumentException,IllegalStateException,IOException'
- ThrowingNewInstanceOfSameException:
- active: false
- TooGenericExceptionCaught:
- active: true
- exceptionNames:
- - ArrayIndexOutOfBoundsException
- - Error
- - Exception
- - IllegalMonitorStateException
- - NullPointerException
- - IndexOutOfBoundsException
- - RuntimeException
- - Throwable
- TooGenericExceptionThrown:
- active: true
- exceptionNames:
- - Error
- - Exception
- - Throwable
- - RuntimeException
-
-formatting:
- active: true
- android: false
- autoCorrect: true
- ChainWrapping:
- active: false
- autoCorrect: true
- CommentSpacing:
- active: true
- autoCorrect: true
- Filename:
- active: true
- FinalNewline:
- active: true
- autoCorrect: true
- ImportOrdering:
- active: true
- autoCorrect: true
- Indentation:
- active: true
- autoCorrect: true
- indentSize: 4
- continuationIndentSize: 4
- MaximumLineLength:
- active: true
- maxLineLength: 120
- ModifierOrdering:
- active: true
- autoCorrect: true
- NoBlankLineBeforeRbrace:
- active: true
- autoCorrect: true
- NoConsecutiveBlankLines:
- active: true
- autoCorrect: true
- NoEmptyClassBody:
- active: true
- autoCorrect: true
- NoItParamInMultilineLambda:
- active: true
- NoLineBreakAfterElse:
- active: true
- autoCorrect: true
- NoLineBreakBeforeAssignment:
- active: true
- autoCorrect: true
- NoMultipleSpaces:
- active: true
- autoCorrect: true
- NoSemicolons:
- active: true
- autoCorrect: true
- NoTrailingSpaces:
- active: true
- autoCorrect: true
- NoUnitReturn:
- active: true
- autoCorrect: true
- NoUnusedImports:
- active: true
- autoCorrect: true
- NoWildcardImports:
- active: true
- autoCorrect: true
- ParameterListWrapping:
- active: false
- autoCorrect: true
- indentSize: 4
- SpacingAroundColon:
- active: true
- autoCorrect: true
- SpacingAroundComma:
- active: true
- autoCorrect: true
- SpacingAroundCurly:
- active: true
- autoCorrect: true
- SpacingAroundKeyword:
- active: true
- autoCorrect: true
- SpacingAroundOperators:
- active: true
- autoCorrect: true
- SpacingAroundRangeOperator:
- active: true
- autoCorrect: true
- StringTemplate:
- active: true
- autoCorrect: true
-
-naming:
- active: true
- ClassNaming:
- active: true
- classPattern: '[A-Z$][a-zA-Z0-9$]*'
- EnumNaming:
- active: true
- enumEntryPattern: '^[A-Z][_a-zA-Z0-9]*'
- ForbiddenClassName:
- active: false
- forbiddenName: ''
- FunctionMaxLength:
- active: false
- maximumFunctionNameLength: 30
- FunctionMinLength:
- active: false
- minimumFunctionNameLength: 3
- FunctionNaming:
- active: true
- functionPattern: '^([a-z$][a-zA-Z$0-9]*)|(`.*`)$'
- excludeClassPattern: '$^'
- MatchingDeclarationName:
- active: false
- MemberNameEqualsClassName:
- active: false
- ignoreOverriddenFunction: true
- ObjectPropertyNaming:
- active: true
- propertyPattern: '[A-Za-z][_A-Za-z0-9]*'
- constantPattern: '[A-Za-z][_A-Za-z0-9]*'
- PackageNaming:
- active: true
- packagePattern: '^[a-z]+(\.[a-z][a-z0-9]*)*$'
- TopLevelPropertyNaming:
- active: true
- constantPattern: '[A-Z][_A-Z0-9]*'
- propertyPattern: '[A-Za-z][_A-Za-z0-9]*'
- privatePropertyPattern: '(_)?[A-Za-z][A-Za-z0-9]*'
- VariableMaxLength:
- active: false
- maximumVariableNameLength: 64
- VariableMinLength:
- active: false
- minimumVariableNameLength: 1
- VariableNaming:
- active: true
- variablePattern: '[a-z][A-Za-z0-9]*'
- privateVariablePattern: '(_)?[a-z][A-Za-z0-9]*'
- excludeClassPattern: '$^'
-
-performance:
- active: true
- ForEachOnRange:
- active: true
- SpreadOperator:
- active: true
- UnnecessaryTemporaryInstantiation:
- active: true
-
-potential-bugs:
- active: true
- DuplicateCaseInWhenExpression:
- active: true
- EqualsAlwaysReturnsTrueOrFalse:
- active: false
- EqualsWithHashCodeExist:
- active: true
- ExplicitGarbageCollectionCall:
- active: true
- InvalidRange:
- active: false
- IteratorHasNextCallsNextMethod:
- active: false
- IteratorNotThrowingNoSuchElementException:
- active: false
- LateinitUsage:
- active: false
- excludeAnnotatedProperties: ""
- ignoreOnClassesPattern: ""
- UnconditionalJumpStatementInLoop:
- active: false
- UnreachableCode:
- active: true
- UnsafeCallOnNullableType:
- active: false
- UnsafeCast:
- active: false
- UselessPostfixExpression:
- active: false
- WrongEqualsTypeParameter:
- active: false
-
-style:
- active: true
- CollapsibleIfStatements:
- active: false
- DataClassContainsFunctions:
- active: false
- conversionFunctionPrefix: 'to'
- EqualsNullCall:
- active: false
- ExpressionBodySyntax:
- active: false
- ForbiddenComment:
- active: true
- values: 'TODO:,FIXME:,STOPSHIP:'
- ForbiddenImport:
- active: false
- imports: ''
- FunctionOnlyReturningConstant:
- active: false
- ignoreOverridableFunction: true
- excludedFunctions: 'describeContents'
- LoopWithTooManyJumpStatements:
- active: false
- maxJumpCount: 1
- MagicNumber:
- active: true
- ignoreNumbers: '-1,0,1,2'
- ignoreHashCodeFunction: false
- ignorePropertyDeclaration: false
- ignoreConstantDeclaration: true
- ignoreCompanionObjectPropertyDeclaration: true
- ignoreAnnotation: false
- ignoreNamedArgument: true
- ignoreEnums: false
- MaxLineLength:
- active: true
- maxLineLength: 120
- excludePackageStatements: false
- excludeImportStatements: false
- excludeCommentStatements: false
- MayBeConst:
- active: false
- ModifierOrder:
- active: true
- NestedClassesVisibility:
- active: false
- NewLineAtEndOfFile:
- active: true
- NoTabs:
- active: false
- OptionalAbstractKeyword:
- active: true
- OptionalUnit:
- active: false
- OptionalWhenBraces:
- active: false
- ProtectedMemberInFinalClass:
- active: false
- RedundantVisibilityModifierRule:
- active: false
- ReturnCount:
- active: true
- max: 2
- excludedFunctions: "equals"
- SafeCast:
- active: true
- SerialVersionUIDInSerializableClass:
- active: false
- SpacingBetweenPackageAndImports:
- active: false
- ThrowsCount:
- active: true
- max: 2
- TrailingWhitespace:
- active: false
- UnnecessaryAbstractClass:
- active: false
- UnnecessaryInheritance:
- active: false
- UnnecessaryParentheses:
- active: false
- UntilInsteadOfRangeTo:
- active: false
- UnusedImports:
- active: false
- UnusedPrivateMember:
- active: true
- allowedNames: "(_.*|ignored|expected)"
- UseDataClass:
- active: false
- excludeAnnotatedClasses: ""
- UtilityClassWithPublicConstructor:
- active: false
- WildcardImport:
- active: true
- excludeImports: 'java.util.*,kotlinx.android.synthetic.*'
--
cgit