Remove --print-ast CLI flag as PsiViewer provides the same features (#…

…5418)
detekt · Oct 20, 2022 · 5c7f6ec · 5c7f6ec
1 parent 8d20a5a
commit 5c7f6ec
Show file tree

Hide file tree

Showing 7 changed files with 2 additions and 98 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -25,10 +25,8 @@ When implementing a new rule, do not forget to perform the following steps:
 - Run `./gradlew generateDocumentation` to add your rule and its config options to the `default-detekt-config.yml`.
 - Run `./gradlew build`. This will execute tests locally.
 
-The following remarks might help you during the implementation:
-- To print the AST of sources, you can pass the `--print-ast` flag to the CLI. This will print each
-  Kotlin files AST. This can be helpful when implementing and debugging rules.
-- To view the AST (PSI) of your source code, you can use the [PSI Viewer plugin](https://plugins.jetbrains.com/plugin/227-psiviewer) for IntelliJ.
+To view the AST (PSI) of your source code, you can use the [PSI Viewer plugin](https://plugins.jetbrains.com/plugin/227-psiviewer) for IntelliJ.
+This can be helpful when implementing and debugging rules.
 
 The general policy regarding contributed rules is as follows:
 - PRs will stay open for at least two days so that other users can give feedback.

diff --git a/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/CliArgs.kt b/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/CliArgs.kt
@@ -149,13 +149,6 @@ class CliArgs {
     )
     var runRule: String? = null
 
-    @Parameter(
-        names = ["--print-ast"],
-        description = "Prints the AST for given [input] file. Must be no directory.",
-        hidden = true
-    )
-    var printAst: Boolean = false
-
     /*
         The following @Parameters are used for type resolution. When additional parameters are required the
         names should mirror the names found in this file (e.g. "classpath", "language-version", "jvm-target"):

diff --git a/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/CliRunner.kt b/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/CliRunner.kt
@@ -5,7 +5,6 @@ import io.github.detekt.tooling.api.DetektCli
 import io.github.detekt.tooling.api.UnexpectedError
 import io.github.detekt.tooling.internal.DefaultAnalysisResult
 import io.github.detekt.tooling.internal.EmptyContainer
-import io.gitlab.arturbosch.detekt.cli.runners.AstPrinter
 import io.gitlab.arturbosch.detekt.cli.runners.ConfigExporter
 import io.gitlab.arturbosch.detekt.cli.runners.Runner
 import io.gitlab.arturbosch.detekt.cli.runners.VersionPrinter
@@ -21,7 +20,6 @@ class CliRunner : DetektCli {
         val specialRunner = when {
             arguments.showVersion -> VersionPrinter(outputChannel)
             arguments.generateConfig -> ConfigExporter(arguments, outputChannel)
-            arguments.printAst -> AstPrinter(arguments, outputChannel)
             else -> null
         }
 

diff --git a/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/Main.kt b/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/Main.kt
@@ -7,7 +7,6 @@ import io.github.detekt.tooling.api.MaxIssuesReached
 import io.github.detekt.tooling.api.UnexpectedError
 import io.github.detekt.tooling.api.exitCode
 import io.github.detekt.tooling.internal.NotApiButProbablyUsedByUsers
-import io.gitlab.arturbosch.detekt.cli.runners.AstPrinter
 import io.gitlab.arturbosch.detekt.cli.runners.ConfigExporter
 import io.gitlab.arturbosch.detekt.cli.runners.Executable
 import io.gitlab.arturbosch.detekt.cli.runners.Runner
@@ -55,7 +54,6 @@ fun buildRunner(
     return when {
         arguments.showVersion -> VersionPrinter(outputPrinter)
         arguments.generateConfig -> ConfigExporter(arguments, outputPrinter)
-        arguments.printAst -> AstPrinter(arguments, outputPrinter)
         else -> Runner(arguments, outputPrinter, errorPrinter)
     }
 }
diff --git a/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/runners/AstPrinter.kt b/detekt-cli/src/main/kotlin/io/gitlab/arturbosch/detekt/cli/runners/AstPrinter.kt
diff --git a/detekt-cli/src/test/kotlin/io/gitlab/arturbosch/detekt/cli/MainSpec.kt b/detekt-cli/src/test/kotlin/io/gitlab/arturbosch/detekt/cli/MainSpec.kt
@@ -5,7 +5,6 @@ package io.gitlab.arturbosch.detekt.cli
 import io.github.detekt.test.utils.NullPrintStream
 import io.github.detekt.test.utils.StringPrintStream
 import io.github.detekt.test.utils.resourceAsPath
-import io.gitlab.arturbosch.detekt.cli.runners.AstPrinter
 import io.gitlab.arturbosch.detekt.cli.runners.ConfigExporter
 import io.gitlab.arturbosch.detekt.cli.runners.Runner
 import io.gitlab.arturbosch.detekt.cli.runners.VersionPrinter
@@ -28,7 +27,6 @@ class MainSpec {
             return listOf(
                 arguments(arrayOf("--generate-config"), ConfigExporter::class),
                 arguments(arrayOf("--run-rule", "RuleSet:Rule"), Runner::class),
-                arguments(arrayOf("--print-ast"), AstPrinter::class),
                 arguments(arrayOf("--version"), VersionPrinter::class),
                 arguments(emptyArray<String>(), Runner::class),
             )

diff --git a/detekt-cli/src/test/kotlin/io/gitlab/arturbosch/detekt/cli/runners/AstPrinterSpec.kt b/detekt-cli/src/test/kotlin/io/gitlab/arturbosch/detekt/cli/runners/AstPrinterSpec.kt