From fedf58f992dcf7e2bb7d9de10163070f1a4e5590 Mon Sep 17 00:00:00 2001 From: akuleshov7 Date: Sun, 31 Mar 2024 01:33:46 +0300 Subject: [PATCH 1/2] Adding diktat analyzer --- diktat-analysis.yml | 135 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100644 diktat-analysis.yml diff --git a/diktat-analysis.yml b/diktat-analysis.yml new file mode 100644 index 0000000..054af02 --- /dev/null +++ b/diktat-analysis.yml @@ -0,0 +1,135 @@ +# https://github.com/saveourtool/diktat +- name: DIKTAT_COMMON + enabled: true + configuration: + domainName: com.ptsecurity + kotlinVersion: 1.9 + srcDirectories: "main,commonMain,jvmMain" + testDirs: "test,jvmTest,commonTest" +- name: ENUM_VALUE + enabled: true + configuration: + enumStyle: SNAKE_CASE +- name: KDOC_CONTAINS_DATE_OR_AUTHOR + enabled: true + configuration: + versionRegex: \d+\.\d+\.\d+[-.\w\d]* +- name: HEADER_MISSING_OR_WRONG_COPYRIGHT + enabled: true + configuration: + isCopyrightMandatory: false + copyrightText: '' +- name: FILE_IS_TOO_LONG + enabled: true + configuration: + maxSize: 2000 + ignoreFolders: '' +- name: FILE_UNORDERED_IMPORTS + enabled: true + configuration: + useRecommendedImportsOrder: true +- name: FILE_WILDCARD_IMPORTS + enabled: false + configuration: + allowedWildcards: "kotlinx.serialization.*" +- name: BRACES_BLOCK_STRUCTURE_ERROR + enabled: true + configuration: + openBraceNewline: true + closeBraceNewline: true +- name: WRONG_INDENTATION + enabled: true + configuration: + # Is newline at the end of a file needed + newlineAtEnd: true + # If true: in parameter list when parameters are split by newline they are indented with two indentations instead of one + extendedIndentOfParameters: false + # If true: if first parameter in parameter list is on the same line as opening parenthesis, then other parameters can be aligned with it + alignedParameters: true + # If true: if expression is split by newline after operator like +/-/`*`, then the next line is indented with two indentations instead of one + extendedIndentAfterOperators: true + # If true: when dot qualified expression starts on a new line, this line will be indented with two indentations instead of one + extendedIndentBeforeDot: false + # The indentation size for each file + indentationSize: 4 + extendedIndentForExpressionBodies: true +- name: EMPTY_BLOCK_STRUCTURE_ERROR + enabled: true + configuration: + styleEmptyBlockWithNewline: true + allowEmptyBlocks: false +- name: LONG_LINE + enabled: true + configuration: + lineLength: 180 +- name: WRONG_NEWLINES + enabled: true + configuration: + maxParametersInOneLine: 3 +- name: TOO_MANY_CONSECUTIVE_SPACES + enabled: true + configuration: + maxSpaces: 1 + saveInitialFormattingForEnums: false +- name: LONG_NUMERICAL_VALUES_SEPARATED + enabled: true + configuration: + maxNumberLength: 5 + maxBlockLength: 3 +- name: WRONG_DECLARATIONS_ORDER + enabled: true + configuration: + sortEnum: true + sortProperty: true +- name: COMMENT_WHITE_SPACE + enabled: true + configuration: + maxSpacesBeforeComment: 2 + maxSpacesInComment: 1 +- name: TYPE_ALIAS + enabled: true + configuration: + typeReferenceLength: 25 +- name: TOO_LONG_FUNCTION + enabled: true + configuration: + maxFunctionLength: 55 # max length of function + isIncludeHeader: false # count function's header +- name: TOO_MANY_PARAMETERS + enabled: true + configuration: + maxParameterListSize: 5 +- name: NESTED_BLOCK + enabled: true + configuration: + maxNestedBlockQuantity: 4 +- name: TRAILING_COMMA + enabled: false + configuration: + valueArgument: true + valueParameter: true +- name: USE_DATA_CLASS + ignoreAnnotated: + - Entity +- name: MISSING_KDOC_CLASS_ELEMENTS + ignoreAnnotated: + - Operation + - Parameters + - Parameter + - JsName +- name: MISSING_KDOC_ON_FUNCTION + ignoreAnnotated: + - Operation + - Parameters + - Parameter +- name: WRONG_OVERLOADING_FUNCTION_ARGUMENTS + ignoreAnnotated: + - GetMapping + - PostMapping + - Repository +- name: KDOC_NO_CONSTRUCTOR_PROPERTY + enabled: true + configuration: + isParamTagsForParameters: false + isParamTagsForPrivateProperties: false + isParamTagsForGenericTypes: false From eb4487eaca85503d60b0a8fe4454683e3d425ce5 Mon Sep 17 00:00:00 2001 From: akuleshov7 Date: Sun, 31 Mar 2024 01:33:54 +0300 Subject: [PATCH 2/2] Adding diktat analyzer --- build.gradle.kts | 22 +++++++++++++++++++++- diktat-analysis.yml | 2 +- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/build.gradle.kts b/build.gradle.kts index 8f31e95..2864278 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,5 +1,25 @@ +import com.saveourtool.diktat.plugin.gradle.DiktatExtension +import com.saveourtool.diktat.plugin.gradle.DiktatGradlePlugin + plugins { id("com.saveourtool.template.build.kafka-local-run-configuration") + id("com.saveourtool.diktat") version "2.0.0" apply false } -group = "com.saveourtool.template" \ No newline at end of file +group = "com.saveourtool.template" + +allprojects { + repositories { + mavenLocal() + mavenCentral() + } + apply() + configure { + diktatConfigFile = rootProject.file("diktat-analysis.yml") + inputs { + include("src/**/*.kt") + exclude("src/") + } + debug = true + } +} \ No newline at end of file diff --git a/diktat-analysis.yml b/diktat-analysis.yml index 054af02..2b0890f 100644 --- a/diktat-analysis.yml +++ b/diktat-analysis.yml @@ -2,7 +2,7 @@ - name: DIKTAT_COMMON enabled: true configuration: - domainName: com.ptsecurity + domainName: com.saveourtool kotlinVersion: 1.9 srcDirectories: "main,commonMain,jvmMain" testDirs: "test,jvmTest,commonTest"