Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize docs for the configuration file #3337

Merged
merged 4 commits into from
Jan 7, 2021

Conversation

chao2zhang
Copy link
Member

Fun fact: Some of the new discussions like #3279 (comment) are already documented in the Path Filters / Excludes / Includes section.

@codecov
Copy link

codecov bot commented Dec 30, 2020

Codecov Report

Merging #3337 (a4c3af0) into master (ff655d2) will decrease coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master    #3337      +/-   ##
============================================
- Coverage     80.34%   80.27%   -0.08%     
+ Complexity     2724     2718       -6     
============================================
  Files           445      445              
  Lines          8177     8239      +62     
  Branches       1555     1563       +8     
============================================
+ Hits           6570     6614      +44     
- Misses          774      785      +11     
- Partials        833      840       +7     
Impacted Files Coverage Δ Complexity Δ
...enerator/printer/rulesetpage/RuleSetPagePrinter.kt 86.84% <ø> (-0.97%) 16.00 <0.00> (-2.00)
...ain/kotlin/io/gitlab/arturbosch/detekt/api/Rule.kt 82.60% <0.00%> (-17.40%) 16.00% <0.00%> (+1.00%) ⬇️
...in/kotlin/io/gitlab/arturbosch/detekt/api/Issue.kt 75.00% <0.00%> (-12.50%) 4.00% <0.00%> (-1.00%)
...io/github/detekt/report/sarif/SarifOutputReport.kt 90.62% <0.00%> (-9.38%) 4.00% <0.00%> (ø%)
...kotlin/io/gitlab/arturbosch/detekt/api/Findings.kt 62.50% <0.00%> (-8.93%) 0.00% <0.00%> (ø%)
...lin/io/github/detekt/report/xml/XmlOutputReport.kt 91.30% <0.00%> (-4.85%) 7.00% <0.00%> (-2.00%)
.../main/kotlin/io/github/detekt/parser/KtCompiler.kt 81.81% <0.00%> (-4.55%) 8.00% <0.00%> (+1.00%) ⬇️
...h/detekt/core/baseline/IndentingXMLStreamWriter.kt 58.82% <0.00%> (-1.56%) 14.00% <0.00%> (-1.00%)
...o/gitlab/arturbosch/detekt/internal/SharedTasks.kt 60.86% <0.00%> (-1.04%) 0.00% <0.00%> (ø%)
...otlin/io/gitlab/arturbosch/detekt/api/CodeSmell.kt 59.57% <0.00%> (-0.90%) 13.00% <0.00%> (+2.00%) ⬇️
... and 24 more

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 ff655d2...a4c3af0. Read the comment docs.

docs/pages/configurations.md Outdated Show resolved Hide resolved
docs/pages/configurations.md Outdated Show resolved Hide resolved
docs/pages/configurations.md Outdated Show resolved Hide resolved
chao2zhang and others added 2 commits December 31, 2020 06:49
Co-authored-by: Brais Gabín <braisgabin@gmail.com>
docs/pages/configurations.md Outdated Show resolved Hide resolved
docs/pages/configurations.md Outdated Show resolved Hide resolved
and rule authors the ability to write *library only* rules.
This is the replacement for the `test-pattern` feature.
## Build failure
_detekt_ supports the option to fail your build if a threshold of code smell issues is met.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
_detekt_ supports the option to fail your build if a threshold of code smell issues is met.
_Detekt_ supports the option to fail your build if a threshold of code smell issues is met.

Copy link
Member Author

Choose a reason for hiding this comment

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

We have a mix and match of Detekt and detekt across the documentation and README.md though, have we agreed upon preferring Detekt?

Copy link
Member

Choose a reason for hiding this comment

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

Not sure though. However, this is the beginning of a sentence. Hence, it starts with one capital letter.

@schalkms schalkms merged commit b2433c5 into detekt:master Jan 7, 2021
@chao2zhang chao2zhang deleted the configdoc branch January 7, 2021 14:04
arturbosch pushed a commit that referenced this pull request Jan 16, 2021
* Reorganize docs for the configuration file

* Update docs/pages/configurations.md

Co-authored-by: Brais Gabín <braisgabin@gmail.com>

* Correct misplaced statements

* Use better wording in doc

Co-authored-by: Brais Gabín <braisgabin@gmail.com>
Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>
@arturbosch arturbosch added this to the 1.16.0 milestone Jan 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants