From c9c86f4e70f10c90d05dfc2f8fdb9c84d55ab174 Mon Sep 17 00:00:00 2001 From: paul-dingemans Date: Wed, 12 Oct 2022 20:28:28 +0200 Subject: [PATCH] * Replace CLI options `--debug`, `--trace`, `--verbose` and `-v` are with `--log-level=` or the short version `-l=. (#1658) Closes #1652 Closes #1632 --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- CHANGELOG.md | 3 + docs/extensions/custom-rule-set.md | 2 +- docs/install/cli.md | 17 ++++-- .../ktlint/reporter/plain/PlainReporter.kt | 3 +- .../reporter/plain/PlainReporterProvider.kt | 1 - .../reporter/plain/PlainReporterTest.kt | 6 +- ktlint-ruleset-template/build.gradle.kts | 4 +- .../ktlint/internal/KtlintCommandLine.kt | 60 ++++++++++++++----- 9 files changed, 67 insertions(+), 31 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index cb03ec0a82..e0816565d0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -16,7 +16,7 @@ Please search in the [issues](https://github.com/pinterest/ktlint/issues) before ## Observed Behavior - + ## Steps to Reproduce diff --git a/CHANGELOG.md b/CHANGELOG.md index 1384a85958..f848c2c7c9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,6 +27,9 @@ Calling this API with a file path results in the `.editorconfig` files that will ### Changed * Update Kotlin development version to `1.7.20` and Kotlin version to `1.7.20`. +* CLI options `--debug`, `--trace`, `--verbose` and `-v` are replaced with `--log-level=` or the short version `-l=, see [CLI log-level](https://pinterest.github.io/ktlint/install/cli/#logging). ([#1632](https://github.com/pinterest/ktlint/issue/1632)) +* In CLI, disable logging entirely by setting `--log-level=none` or `-l=none` ([#1652](https://github.com/pinterest/ktlint/issue/1652)) + ## [0.47.1] - 2022-09-07 diff --git a/docs/extensions/custom-rule-set.md b/docs/extensions/custom-rule-set.md index 9c72b95df2..9eef0a7278 100644 --- a/docs/extensions/custom-rule-set.md +++ b/docs/extensions/custom-rule-set.md @@ -20,7 +20,7 @@ $ echo 'var v = 0' > test.kt ``` ```shell title="Running the ktlint-ruleset-template" hl_lines="1 40 43" -$ ktlint -R build/libs/ktlint-ruleset-template.jar --debug --relative test.kt +$ ktlint -R build/libs/ktlint-ruleset-template.jar --log-level=debug --relative test.kt 18:13:21.026 [main] DEBUG com.pinterest.ktlint.internal.RuleSetsLoader - JAR ruleset provided with path "/../ktlint/ktlint-ruleset-template/build/libs/ktlint-ruleset-template.jar" 18:13:21.241 [main] DEBUG com.pinterest.ktlint.Main - Discovered reporter with "baseline" id. diff --git a/docs/install/cli.md b/docs/install/cli.md index 59388b3447..bc3250e3fd 100644 --- a/docs/install/cli.md +++ b/docs/install/cli.md @@ -96,9 +96,9 @@ ktlint "src/**/*.kt" "!src/**/*Test.kt" ktlint "src/**/*.kt" "!src/**/generated/**" ``` -### Error reporting +### Violation reporting -`ktlint` supports different type of reporters. When not specified the `plain` reporter is used. Optionally the `plain` reporter can group the violations per file. +`ktlint` supports different type of reporters for lint violations. When not specified the `plain` reporter is used. Optionally the `plain` reporter can group the violations per file. ```shell title="Style violation grouped by file" $ ktlint --reporter=plain?group_by_file @@ -118,6 +118,12 @@ If resolving all existing errors in a project is unwanted, it is possible to cre ktlint --baseline=ktlint-baseline.xml # Baseline is created when not existing ``` +### Logging + +Logging information is written to `stdout`. The amount of logging can be influenced by setting the minimal log level using option `--log-level` or `-l` to one of values `trace`, `debug`, `info`, `warn`, `error`, or `none` to suppress all logging. + +By default, the `info` log level is used meaning that all log lines at level `info`, `warn` and `error` are shown while suppressing log lines at level `debug` or `trace`. + ### Rule configuration (`.editorconfig`) Some rules can be tweaked via the [`editorconfig file`](https://pinterest.github.io/ktlint/rules/configuration/). @@ -145,7 +151,7 @@ ktlint --editorconfig=/path/to/.editorconfig ### Stdin && stdout -With command below, the input is read from `stdin` and the violations are printed to `stderr`. +With command below, the input is read from `stdin` and the violations are printed to `stderr`. Logging is written to `stdout`. ```shell title="Lint from stdin" ktlint --stdin @@ -157,7 +163,8 @@ When combined with the `--format` option, the formatted code is written to `stdo ktlint --stdin -F ``` -!!! tip Suppress error output +!!! tip Suppress logging and error output + Logging output printed to `stdout` can be suppressed by setting `--log-level=none` (see [logging](#logging)). Output printed to `stderr` can be suppressed in different ways. To ignore all error output, add `2> /dev/null` to the end of the command line. Otherwise, specify a [reporter](#error-reporting) to write the error output to a file. @@ -192,8 +199,6 @@ ktlint installGitPrePushHook `--patterns-from-stdin[=]`: Reads additional patterns from `stdin`, where the patterns are separated by ``. If `=` is omitted, newline is used as fallback delimiter. If an empty string is given, the `NUL` byte is used as delimiter instead. Options `--stdin` and `--patterns-from-stdin` are mutually exclusive, only one of them can be given at a time. -`-v`, `--verbose` or `--debug`: Turn on debug output. Also option `--trace` is available, but this is meant for ktlint library developers. - `-V` or `--version`: Prints version information and exit. ### Microsoft Windows users diff --git a/ktlint-reporter-plain/src/main/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporter.kt b/ktlint-reporter-plain/src/main/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporter.kt index 4ef9b09d89..1ac62719c9 100644 --- a/ktlint-reporter-plain/src/main/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporter.kt +++ b/ktlint-reporter-plain/src/main/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporter.kt @@ -11,7 +11,6 @@ import java.util.concurrent.ConcurrentHashMap public class PlainReporter( private val out: PrintStream, - private val verbose: Boolean = false, private val groupByFile: Boolean = false, private val shouldColorOutput: Boolean = false, private val outputColor: Color = Color.DARK_GRAY, @@ -42,7 +41,7 @@ public class PlainReporter( out.println( " $line${ ":${if (pad) String.format("%-3s", col) else "$col"}".colored() - } $detail${if (verbose) " ($ruleId)".colored() else ""}", + } $detail ${"($ruleId)".colored()}", ) } } diff --git a/ktlint-reporter-plain/src/main/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterProvider.kt b/ktlint-reporter-plain/src/main/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterProvider.kt index 154a7fe7d5..eb97e25ad2 100644 --- a/ktlint-reporter-plain/src/main/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterProvider.kt +++ b/ktlint-reporter-plain/src/main/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterProvider.kt @@ -11,7 +11,6 @@ public class PlainReporterProvider : ReporterProvider { override fun get(out: PrintStream, opt: Map): PlainReporter = PlainReporter( out, - verbose = opt["verbose"]?.emptyOrTrue() ?: false, groupByFile = opt["group_by_file"]?.emptyOrTrue() ?: false, shouldColorOutput = opt["color"]?.emptyOrTrue() ?: false, outputColor = getColor(opt["color_name"]), diff --git a/ktlint-reporter-plain/src/test/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterTest.kt b/ktlint-reporter-plain/src/test/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterTest.kt index aa46f10c11..12adb04157 100644 --- a/ktlint-reporter-plain/src/test/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterTest.kt +++ b/ktlint-reporter-plain/src/test/kotlin/com/pinterest/ktlint/reporter/plain/PlainReporterTest.kt @@ -172,10 +172,10 @@ class PlainReporterTest { assertThat(String(out.toByteArray())).isEqualTo( """ /one-fixed-and-one-not.kt - 1:1 <"&'> + 1:1 <"&'> (rule-1) /two-not-fixed.kt - 1:10 I thought I would again - 2:20 A single thin straight line + 1:10 I thought I would again (rule-1) + 2:20 A single thin straight line (rule-2) """.trimIndent().replace("\n", System.lineSeparator()), ) diff --git a/ktlint-ruleset-template/build.gradle.kts b/ktlint-ruleset-template/build.gradle.kts index 732a31a71a..5237bb43f2 100644 --- a/ktlint-ruleset-template/build.gradle.kts +++ b/ktlint-ruleset-template/build.gradle.kts @@ -44,10 +44,10 @@ tasks.register("ktlint") { dependsOn(tasks.classes) group = LifecycleBasePlugin.VERIFICATION_GROUP mainClass.set("com.pinterest.ktlint.Main") - // adding compiled classes to the classpath so that ktlint would validate project"s sources + // adding compiled classes to the classpath so that ktlint would validate project's sources // using its own ruleset (in other words to dogfood) classpath(ktlint, sourceSets.main.map { it.output }) - args("--debug", "src/**/*.kt") + args("--log-level=debug", "src/**/*.kt") }.let { tasks.check.configure { dependsOn(it) diff --git a/ktlint/src/main/kotlin/com/pinterest/ktlint/internal/KtlintCommandLine.kt b/ktlint/src/main/kotlin/com/pinterest/ktlint/internal/KtlintCommandLine.kt index 05f11e296a..1bd9c7804f 100644 --- a/ktlint/src/main/kotlin/com/pinterest/ktlint/internal/KtlintCommandLine.kt +++ b/ktlint/src/main/kotlin/com/pinterest/ktlint/internal/KtlintCommandLine.kt @@ -116,15 +116,17 @@ internal class KtlintCommandLine { @Option( names = ["--debug"], - description = ["Turn on debug output"], + description = ["Turn on debug output. Deprecated, use '--log-level=debug' instead."], ) - var debug: Boolean = false + @Deprecated(message = "Replaced with minLogLevel") + var debugOld: Boolean? = null @Option( names = ["--trace"], - description = ["Turn on trace output"], + description = ["Turn on trace output. Deprecated, use '--log-level=trace' instead."], ) - var trace: Boolean = false + @Deprecated(message = "Replaced with minLogLevel") + var trace: Boolean? = null @Option( names = ["--disabled_rules"], @@ -194,9 +196,10 @@ internal class KtlintCommandLine { @Option( names = ["--verbose", "-v"], - description = ["Show error codes"], + description = ["Show error codes. Deprecated, use '--log-level=info' instead."], ) - private var verbose: Boolean = false + @Deprecated(message = "Replaced with minLogLevel") + private var verbose: Boolean? = null @Option( names = ["--editorconfig"], @@ -224,14 +227,32 @@ internal class KtlintCommandLine { @Parameters(hidden = true) private var patterns = ArrayList() + @Option( + names = ["--log-level", "-l"], + description = ["Defines the minimum log level (trace, debug, info, warn, error) or none to suppress all logging"], + converter = [LogLevelConverter::class], + ) + private var minLogLevel: Level = Level.INFO + private val tripped = AtomicBoolean() private val fileNumber = AtomicInteger() private val errorNumber = AtomicInteger() + internal var debug: Boolean = false + get() = Level.DEBUG.isGreaterOrEqual(minLogLevel) + private set + fun run() { - if (verbose) { - debug = true + if (debugOld != null || trace != null || verbose != null) { + if (minLogLevel == Level.OFF) { + minLogLevel = Level.ERROR + } + configureLogger().error { + "Options '--debug', '--trace', '--verbose' and '-v' are deprecated and replaced with option '--log-level=' or '-l='." + } + exitProcess(1) } + logger = configureLogger() assertStdinAndPatternsFromStdinOptionsMutuallyExclusive() @@ -311,11 +332,7 @@ internal class KtlintCommandLine { KotlinLogging .logger {} .setDefaultLoggerModifier { logger -> - (logger.underlyingLogger as Logger).level = when { - trace -> Level.TRACE - debug -> Level.DEBUG - else -> Level.INFO - } + (logger.underlyingLogger as Logger).level = minLogLevel } .initKtLintKLogger() @@ -471,7 +488,6 @@ internal class KtlintCommandLine { reporterId, split.lastOrNull { it.startsWith("artifact=") }?.let { it.split("=")[1] }, mapOf( - "verbose" to verbose.toString(), "color" to color.toString(), "color_name" to colorName, "format" to format.toString(), @@ -541,7 +557,7 @@ internal class KtlintCommandLine { "", "Internal Error (${e.ruleId}) in file '$filename' at position '${e.line}:${e.col}. " + "Please create a ticket at https://github.com/pinterest/ktlint/issues " + - "(if possible, please re-run with the --debug flag to get the stacktrace " + + "(if possible, please re-run with the --log-level=debug flag to get the stacktrace " + "and provide the source code that triggered an error)", ) } @@ -676,3 +692,17 @@ internal class KtlintCommandLine { val output: String?, ) } + +private class LogLevelConverter : CommandLine.ITypeConverter { + @Throws(Exception::class) + override fun convert(value: String?): Level = + when (value?.uppercase()) { + "TRACE" -> Level.TRACE + "DEBUG" -> Level.DEBUG + "INFO" -> Level.INFO + "WARN" -> Level.WARN + "ERROR" -> Level.ERROR + "NONE" -> Level.OFF + else -> Level.INFO + } +}