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

Add documentation page on type resolution #3225

Merged
merged 5 commits into from
Nov 21, 2020

Conversation

cortinico
Copy link
Member

I'm adding a page to explain in detail what is type resolution, how to enable it, how to write a custom rule that uses it and how to test it 👌

We had an empty page on the website for too long :) To start filling it.
This page is more like a draft. Happy to collect and integrated feedbacks.

Fixes #2259

@codecov
Copy link

codecov bot commented Nov 11, 2020

Codecov Report

Merging #3225 (f7d597a) into master (cd659ce) will decrease coverage by 0.04%.
The diff coverage is 77.63%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master    #3225      +/-   ##
============================================
- Coverage     80.10%   80.06%   -0.05%     
- Complexity     2647     2649       +2     
============================================
  Files           440      443       +3     
  Lines          8013     8072      +59     
  Branches       1529     1535       +6     
============================================
+ Hits           6419     6463      +44     
- Misses          775      789      +14     
- Partials        819      820       +1     
Impacted Files Coverage Δ Complexity Δ
...n/io/github/detekt/report/sarif/RuleDescriptors.kt 21.05% <21.05%> (ø) 0.00 <0.00> (?)
...rbosch/detekt/rules/style/EqualsOnSignatureLine.kt 77.77% <71.42%> (-11.12%) 6.00 <5.00> (+1.00) ⬇️
...n/kotlin/io/github/detekt/report/sarif/SarifDsl.kt 100.00% <100.00%> (ø) 0.00 <0.00> (?)
...io/github/detekt/report/sarif/SarifOutputReport.kt 100.00% <100.00%> (ø) 3.00 <3.00> (?)
...ab/arturbosch/detekt/rules/empty/EmptyWhenBlock.kt 66.66% <0.00%> (-8.34%) 1.00% <0.00%> (-1.00%)
...rturbosch/detekt/rules/bugs/UnnecessarySafeCall.kt 71.42% <0.00%> (-3.58%) 3.00% <0.00%> (-1.00%)
...ab/arturbosch/detekt/formatting/KtLintMultiRule.kt 92.15% <0.00%> (-0.16%) 6.00% <0.00%> (-2.00%)
... and 2 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 cd659ce...ed662f8. Read the comment docs.

Copy link
Member

@BraisGabin BraisGabin left a comment

Choose a reason for hiding this comment

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

Great addition!

docs/pages/gettingstarted/type-resolution.md Outdated Show resolved Hide resolved
Co-authored-by: Brais Gabín <braisgabin@gmail.com>
Copy link
Member

@schalkms schalkms left a comment

Choose a reason for hiding this comment

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

Sorry for the late review. I completely missed this PR.
Anyways, I really appreciate your work on this. This is great stuff. 👏
I have only some minor comments (typos, grammar).

docs/pages/gettingstarted/type-resolution.md Outdated Show resolved Hide resolved
docs/pages/gettingstarted/type-resolution.md Outdated Show resolved Hide resolved
docs/pages/gettingstarted/type-resolution.md Outdated Show resolved Hide resolved
docs/pages/gettingstarted/type-resolution.md Outdated Show resolved Hide resolved
docs/pages/gettingstarted/type-resolution.md Outdated Show resolved Hide resolved
docs/pages/gettingstarted/type-resolution.md Outdated Show resolved Hide resolved
docs/pages/gettingstarted/type-resolution.md Outdated Show resolved Hide resolved
docs/pages/gettingstarted/type-resolution.md Outdated Show resolved Hide resolved
docs/pages/gettingstarted/type-resolution.md Outdated Show resolved Hide resolved
docs/pages/gettingstarted/type-resolution.md Outdated Show resolved Hide resolved
cortinico and others added 3 commits November 18, 2020 21:04
Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>
Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>
@schalkms schalkms merged commit 462ad50 into detekt:master Nov 21, 2020
@arturbosch arturbosch added this to the 1.15.0 milestone Dec 14, 2020
arturbosch pushed a commit that referenced this pull request Dec 21, 2020
* Add documentation page on type resolution

Fixes #2259

* Update docs/pages/gettingstarted/type-resolution.md

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

* Apply suggestions from code review

Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>

* Add note on lintWithContext

Co-authored-by: Brais Gabín <braisgabin@gmail.com>
Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>
arturbosch pushed a commit that referenced this pull request Jan 16, 2021
* Add documentation page on type resolution

Fixes #2259

* Update docs/pages/gettingstarted/type-resolution.md

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

* Apply suggestions from code review

Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>

* Add note on lintWithContext

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

Successfully merging this pull request may close these issues.

Doc: type and symbol solving
4 participants