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

Improve description of AbsentOrWrongFileLicense rule #3109

Merged
merged 3 commits into from
Sep 27, 2020

Conversation

schalkms
Copy link
Member

The new description states how the rule checks Kotlin source files
against the given license header.
Closes #3100

The new description states how the rule checks Kotlin source files
against the given license header.
Closes #3100
@codecov
Copy link

codecov bot commented Sep 27, 2020

Codecov Report

Merging #3109 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #3109   +/-   ##
=========================================
  Coverage     79.44%   79.44%           
  Complexity     2596     2596           
=========================================
  Files           437      437           
  Lines          7818     7818           
  Branches       1484     1484           
=========================================
  Hits           6211     6211           
  Misses          819      819           
  Partials        788      788           
Impacted Files Coverage Δ Complexity Δ
...kt/rules/documentation/AbsentOrWrongFileLicense.kt 92.85% <ø> (ø) 8.00 <0.00> (ø)

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 c334513...0c3b0f4. Read the comment docs.

@@ -10,7 +10,9 @@ import io.gitlab.arturbosch.detekt.api.Severity
import org.jetbrains.kotlin.psi.KtFile

/**
* This rule will report every Kotlin source file which doesn't have required license header.
* This rule will report every Kotlin source file which doesn't have the required license header.
* Each Kotlin source file is checked, whether the header starts with the read text from the passed file in the
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
* Each Kotlin source file is checked, whether the header starts with the read text from the passed file in the
* Each Kotlin source file is checked whether the header starts with the read text from the passed file in the

Not sure if the comma is needs to be removed here.

@arturbosch arturbosch added this to the 1.14.1 milestone Sep 27, 2020
@schalkms schalkms merged commit e852dbc into master Sep 27, 2020
@schalkms schalkms deleted the description-AbsentOrWrongFileLicense branch September 27, 2020 14:26
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.

How to define the license header?
2 participants