[
https://issues.apache.org/jira/browse/SLING-10550?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Oliver Lietz updated SLING-10550:
---------------------------------
Description:
Changes to Checkstyle checks
# *Ignore LineLength check*
The very few long(er) lines are not an issue. Source is not edited anymore in
narrow terminal windows with 80 characters per line.
# *Ignore AnnotationOnSameLine check*
_Checks that annotations are located on the same line with their targets.
Verifying with this check is not good practice, but it is using by some style
guides._
# *Ignore AnnotationUseStyle check*
There are too many different Annotation types with different styles. No style
fits all.
# *Ignore HiddenField check*
Local variable or a parameter with same name as field in class is often used
when constructing the object in factory method or when keeping a local
reference is required.
# *Ignore AvoidStaticImport check*
Poor code readability is not given with modern IDEs.
# *Ignore CustomImportOrder check*
Using custom ImportOrder instead.
# *Adjust ImportControl check*
Allow all but {{sun}}.
# *Adjust ImportOrder check*
{{java}},{{javax}},{{javafx}},{{jakarta}},{{*}},_static_
# *Ignore TrailingComment check*
The very few trailing/endline comments are not an issue as they are not used
in way described in Steve McConnell's _Code Complete_.
# *Adjust RedundantModifier check*
Starting with Java 8 interfaces can have {{default}} and {{static}} methods.
{{public}} and {{abstract}} are therefore no longer redundant modifiers.
[https://docs.oracle.com/javase/tutorial/java/IandI/defaultmethods.html]
# *Adjust EmptyLineSeparator check*
An empty line before package declaration is not required (e.g. between license
header and package declaration).
# *Ignore JavadocVariable check*
Do not enforce Javadoc for members.
# *Ignore WriteTag check*
Do not check for Javadoc tags being present.
# *Adjust AbbreviationAsWordInName check*
Allow strict camel case only.
Implemented in
[{{de.bildschirmarbeiter/checkstyle/1}}|https://github.com/bildschirmarbeiter/checkstyle/tree/checkstyle-1]
and applied to [Commons
Crypto|https://github.com/apache/sling-org-apache-sling-commons-crypto].
was:
Changes to Checkstyle checks
# *Ignore LineLength check*
The very few long(er) lines are not an issue. Source is not edited anymore in
narrow terminal windows with 80 characters per line.
# *Ignore AnnotationOnSameLine check*
_Checks that annotations are located on the same line with their targets.
Verifying with this check is not good practice, but it is using by some style
guides._
# *Ignore AnnotationUseStyle check*
There are too many different Annotation types with different styles. No style
fits all.
# *Ignore HiddenField check*
Local variable or a parameter with same name as field in class is often used
when constructing the object in factory method or when keeping a local
reference is required.
# *Ignore AvoidStaticImport check*
Poor code readability is not given with modern IDEs.
# *Ignore CustomImportOrder check*
Using custom ImportOrder instead.
# *Adjust ImportControl check*
Allow all but {{sun}}.
# *Adjust ImportOrder check*
{{java}},{{javax}},{{javafx}},{{jakarta}},{{*}},_static_
# *Ignore TrailingComment check*
The very few trailing/endline comments are not an issue as they are not used
in way described in Steve McConnell's _Code Complete_.
# *Adjust RedundantModifier check*
Starting with Java 8 interfaces can have {{default}} and {{static}} methods.
{{public}} and {{abstract}} are therefore no longer redundant modifiers.
[https://docs.oracle.com/javase/tutorial/java/IandI/defaultmethods.html]
# *Adjust EmptyLineSeparator check*
An empty line before package declaration is not required (e.g. between license
header and package declaration).
# *Ignore JavadocVariable check*
Do not enforce Javadoc for members.
# *Ignore WriteTag check*
Do not check for Javadoc tags being present.
# *Adjust AbbreviationAsWordInName check*
Allow strict camel case only.
Implemented in
[{{de.bildschirmarbeiter/checkstyle/1}}|https://github.com/bildschirmarbeiter/checkstyle/tree/checkstyle-1].
> Compile a set of appropriate Checkstyle checks
> ----------------------------------------------
>
> Key: SLING-10550
> URL: https://issues.apache.org/jira/browse/SLING-10550
> Project: Sling
> Issue Type: Task
> Reporter: Oliver Lietz
> Assignee: Oliver Lietz
> Priority: Major
>
> Changes to Checkstyle checks
> # *Ignore LineLength check*
> The very few long(er) lines are not an issue. Source is not edited anymore
> in narrow terminal windows with 80 characters per line.
> # *Ignore AnnotationOnSameLine check*
> _Checks that annotations are located on the same line with their targets.
> Verifying with this check is not good practice, but it is using by some style
> guides._
> # *Ignore AnnotationUseStyle check*
> There are too many different Annotation types with different styles. No
> style fits all.
> # *Ignore HiddenField check*
> Local variable or a parameter with same name as field in class is often used
> when constructing the object in factory method or when keeping a local
> reference is required.
> # *Ignore AvoidStaticImport check*
> Poor code readability is not given with modern IDEs.
> # *Ignore CustomImportOrder check*
> Using custom ImportOrder instead.
> # *Adjust ImportControl check*
> Allow all but {{sun}}.
> # *Adjust ImportOrder check*
> {{java}},{{javax}},{{javafx}},{{jakarta}},{{*}},_static_
> # *Ignore TrailingComment check*
> The very few trailing/endline comments are not an issue as they are not used
> in way described in Steve McConnell's _Code Complete_.
> # *Adjust RedundantModifier check*
> Starting with Java 8 interfaces can have {{default}} and {{static}} methods.
> {{public}} and {{abstract}} are therefore no longer redundant modifiers.
> [https://docs.oracle.com/javase/tutorial/java/IandI/defaultmethods.html]
> # *Adjust EmptyLineSeparator check*
> An empty line before package declaration is not required (e.g. between
> license header and package declaration).
> # *Ignore JavadocVariable check*
> Do not enforce Javadoc for members.
> # *Ignore WriteTag check*
> Do not check for Javadoc tags being present.
> # *Adjust AbbreviationAsWordInName check*
> Allow strict camel case only.
> Implemented in
> [{{de.bildschirmarbeiter/checkstyle/1}}|https://github.com/bildschirmarbeiter/checkstyle/tree/checkstyle-1]
> and applied to [Commons
> Crypto|https://github.com/apache/sling-org-apache-sling-commons-crypto].
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
