• Default: diktat-analysis.yml

• Required: no

You can override the name or the path of your YAML configuration file using the config input parameter, e. g.:

If you wish, you can report errors in a custom format.

• Default: sarif

• Required: no

• Possible values: any of the following.

  • sarif: report errors in the SARIF format. The output file will be named report.sarif and automatically uploaded to GitHub using the upload-sarif action. This will enable the check results to be shown as annotations in the pull request:

    

    as well as in the Code scanning alerts section of your repository:

    

  • checkstyle: this is the reporter of choice if you ever encounter issues with the sarif reporter. Errors are reported in the Checkstyle-XML format to the file named checkstyle-report.xml. The report is then consumed by the reviewdog tool and uploaded to GitHub, resulting in code annotations similar to those produced by the sarif reporter:

    

  • plain: report errors in the plain-text format, e. g.:

    C.kt:1:1: [MISSING_KDOC_TOP_LEVEL] all public and internal top-level classes and functions should have Kdoc: C (cannot be auto-corrected) (diktat-ruleset:kdoc-comments)
    C.kt:1:1: [FILE_NAME_INCORRECT] file name is incorrect - it should end with .kt extension and be in PascalCase: C.kt (diktat-ruleset:file-naming)
    C.kt:1:1: [PACKAGE_NAME_MISSING] no package name declared in a file: C.kt (diktat-ruleset:package-naming)
    C.kt:1:7: [CLASS_NAME_INCORRECT] class/enum/interface name should be in PascalCase and should contain only latin (ASCII) letters or numbers: C (diktat-ruleset:identifier-naming)
    C.kt:1:7: [IDENTIFIER_LENGTH] identifier's length is incorrect, it should be in range of [2, 64] symbols: C (cannot be auto-corrected) (diktat-ruleset:identifier-naming)

    The errors, if any, are printed on the standard output.

  • plain?group_by_file: same as above, but group errors by file, e. g.:

    C.kt
      1:1 [MISSING_KDOC_TOP_LEVEL] all public and internal top-level classes and functions should have Kdoc: C (cannot be auto-corrected)
      1:1 [FILE_NAME_INCORRECT] file name is incorrect - it should end with .kt extension and be in PascalCase: C.kt
      1:1 [PACKAGE_NAME_MISSING] no package name declared in a file: C.kt
      1:7 [CLASS_NAME_INCORRECT] class/enum/interface name should be in PascalCase and should contain only latin (ASCII) letters or numbers: C
      1:7 [IDENTIFIER_LENGTH] identifier's length is incorrect, it should be in range of [2, 64] symbols: C (cannot be auto-corrected)

  • json: report errors in the JSON format to the file named report.json.

  • html: report errors in the HTML format to the file named report.html.

• Default: none

• Required: no

One or more patterns which indicate the files or directories to check. Use a multiline string to specify multiple inputs.

• If an input is a path to a file, it is passed to diKTat as-is:

        - uses: saveourtool/benedikt@v1
          with:
            input-paths: |
              path/to/file.kt

• If an input is a path to a directory, the directory is recursively traversed, and all *.kt and *.kts files are passed to diKTat.

        - uses: saveourtool/benedikt@v1
          with:
            input-paths: |
              src/main/kotlin
              src/test/kotlin

• If an input is an Ant-style path pattern (such as **/*.kt), diKTat expands it into the list of files that match the path pattern. Path patterns may be negated, e. g.: !src/**/*Test.kt or !src/**/generated/**.

        - uses: saveourtool/benedikt@v1
          with:
            input-paths: |
              **/*.kt
              **/*.kts
              !**/generated/**

If this input parameter is not specified, this is equivalent to setting it to ., meaning diKTat will check all *.kt and *.kts files in the project directory unless configured otherwise.

It’s possible to run diKTat with a custom JVM using the actions/setup-java action. The following input parameters may be specified:

• java-distribution: the Java distribution, see the list of supported distributions.

  • Default: temurin

  • Required: no

• java-version: the Java version to set up. Takes a whole or semver Java version. See examples of supported syntax.

  • Default: none

  • Required: no

• Default: true

• Required: no

If false, the errors are still reported, but the step completes successfully. If true (the default), then lint errors reported by diKTat are considered fatal (i.e. the current step terminates with a failure):

• Default: true

• Required: no

If true, file paths get relativized with respect to the project directory. Otherwise, absolute file paths get reported. Example:

• Default: true

• Required: no

Setting this flag enables the console output to be colorized. This is only useful if the reporter is set to plain or plain?group_by_file:

• Default: false

• Required: no

Debug logging can be enabled by setting the debug input parameter to true:

• Written in UNIX Shell (~500 lines of code)

• BSD-compatible

• Also works in Windows (Git Bash, Cygwin, or MSys2)

• Automatically downloads ktlint and diktat far JARs

• Accepts all essential ktlint command-line arguments