Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 3.05 KB

README.md

File metadata and controls

64 lines (45 loc) · 3.05 KB
Raw

Kotlin Utils

The Kotlin Utils provide certain meta-level functionality for this project, such as scripts to generate rule mappings for various third-party linters.

Generating rule mappings for external linters

Detekt

To re-generate detekt's rules.json:

  1. Update detektVersion property in settings.gradle.kts
  2. Run ./gradlew utils-kotlin:updateDetektRules from the project's root directory

ktlint

To re-generate ktlint's rules.json:

  1. Update ktlintVersion property in settings.gradle.kts
  2. Run ./gradlew utils-kotlin:updateKtlintRules from the project's root directory

Android Lint

To re-generate android lint's rules.json:

  1. Update android lint with command $ANDROID_SDK_HOME/tools/bin/sdkmanager --install "cmdline-tools;latest"
  2. Check Android Lint version with command $ANDROID_SDK_HOME/cmdline-tools/$version/bin/lint --version
  3. Export android lint help $ANDROID_SDK_HOME/cmdline-tools/$version/bin/lint --show > utils-kotlin/src/main/resources/android-lint-help.txt
  4. Run ./gradlew utils-kotlin:updateAndroidLintRules from the project's root directory

Note if you do not have the latest android sdk on your local machine, you can use the latest androidsdk/android-XX docker image from androidsdk, for example for androidsdk/android-31 the commands are:

# go to the project's root directory
cd sonar-kotlin
# enter into the docker container
docker run --rm -it -v "$PWD:/root/sonar-kotlin" androidsdk/android-31 /bin/bash
export JAVA_TOOL_OPTIONS="-Dfile.encoding=UTF8"
$ANDROID_HOME/cmdline-tools/latest/bin/lint --version
    lint: version 7.1.0
$ANDROID_SDK_HOME/cmdline-tools/latest/bin/lint --show > /root/sonar-kotlin/utils-kotlin/src/main/resources/android-lint-help.txt
# exit the docker container
exit
./gradlew utils-kotlin:updateAndroidLintRules

Printing ASTs to Dot

You can print the AST generated from a *.kt or *.kts file in TXT or DOT (Graphviz) format, either on stdout or to a file. To print the AST to stdout:

  1. Run ./gradlew utils-kotlin:printAst --args="<txt|dot> <path-to-input-kotlin-file>"

To print the AST into an output file, simply add the path of the output file as second command line argument:

  1. Run ./gradlew utils-kotlin:printAst --args="<txt|dot> <path-to-input-kotlin-file> <path-to-output-file>"

So for instance, if you want to visualize the AST for the file Example.kt do the following (you'll need to install graphviz for this):

./gradlew utils-kotlin:printAst --args="dot Example.kt /tmp/ast.dot"
dot -Tpng /tmp/ast.dot -o /tmp/ast.png

Now open the file /tmp/ast.png with an image viewer of your choice. See the documentation of the dot tool to find various alternative output formats.