Skip to content

Use multi line format for list options in config#3827

Merged
schalkms merged 4 commits into
detekt:mainfrom
marschwar:always-use-multi-line-lists
Jun 27, 2021
Merged

Use multi line format for list options in config#3827
schalkms merged 4 commits into
detekt:mainfrom
marschwar:always-use-multi-line-lists

Conversation

@marschwar

Copy link
Copy Markdown
Contributor

This closes #3671 and generates default list option in multi line format.

Comment thread detekt-core/src/main/resources/default-detekt-config.yml
@codecov

codecov Bot commented May 24, 2021

Copy link
Copy Markdown

Codecov Report

Merging #3827 (b760a08) into main (44c1ef0) will increase coverage by 0.00%.
The diff coverage is 90.90%.

❗ Current head b760a08 differs from pull request most recent head ae976a3. Consider uploading reports for the commit ae976a3 to get more accurate results
Impacted file tree graph

@@            Coverage Diff            @@
##               main    #3827   +/-   ##
=========================================
  Coverage     83.53%   83.54%           
- Complexity     3120     3125    +5     
=========================================
  Files           456      456           
  Lines          8996     9011   +15     
  Branches       1753     1757    +4     
=========================================
+ Hits           7515     7528   +13     
  Misses          565      565           
- Partials        916      918    +2     
Impacted Files Coverage Δ
.../io/gitlab/arturbosch/detekt/generator/out/Yaml.kt 70.27% <77.77%> (+1.30%) ⬆️
...bosch/detekt/generator/collection/Configuration.kt 100.00% <100.00%> (ø)
...ekt/generator/printer/rulesetpage/ConfigPrinter.kt 92.10% <100.00%> (-0.76%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 44c1ef0...ae976a3. Read the comment docs.

@cortinico cortinico added this to the 1.18.0 milestone May 24, 2021
@cortinico cortinico added the notable changes Marker for notable changes in the changelog label May 24, 2021
@marschwar marschwar force-pushed the always-use-multi-line-lists branch from 59f4202 to 158ad0f Compare May 25, 2021 13:04
@marschwar marschwar force-pushed the always-use-multi-line-lists branch from 86d694b to 27ea847 Compare June 6, 2021 10:30

@schalkms schalkms left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there anything else left to do besides handling the merge conflict?

Comment thread detekt-core/src/main/resources/default-detekt-config.yml Outdated
Comment thread detekt-core/src/main/resources/default-detekt-config.yml
Comment thread detekt-core/src/main/resources/default-detekt-config.yml
@marschwar marschwar force-pushed the always-use-multi-line-lists branch from c5b3e76 to 6f0d0c4 Compare June 26, 2021 17:35
@marschwar

Copy link
Copy Markdown
Contributor Author

Is there anything else left to do besides handling the merge conflict?

From my point of view this is ready. There may be objections to making such a change as part of a minor version though.

Configuration(
name = "rulesetconfig3",
description = "description rulesetconfig2",
defaultValue = "['first', 'se*cond']",

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not an issue, but just curious that if the asterisk is intended.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it is. The asterisk has a special meaning in yaml and the value has to be enclosed in parentheses.

@schalkms

Copy link
Copy Markdown
Member

There may be objections to making such a change as part of a minor version though.

The next version is v1.18 after v1.17.1. Hence I think it's okay.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

notable changes Marker for notable changes in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use dynamic list format for default-detekt-config.yml

5 participants