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

idea: fourth part of idea violations #4723

Closed
Nimfadora opened this Issue Jul 15, 2017 · 3 comments

Comments

Projects
2 participants
@Nimfadora
Contributor

Nimfadora commented Jul 15, 2017

sub-task of #4681

full report is here

in scope of this issue we should fix:
Logging issues
Maven
Method metrics
Modularization issues
Naming conventions
Numeric issues
Packaging issues

Violations included:

ClassIndependentOfModule
ClassNamePrefixedWithPackageName
ClassOnlyUsedInOnePackage
ClassUnconnectedToPackage
ClassWithoutLogger
CyclomaticComplexity
DisjointPackage
ImplicitNumericConversion
LambdaParameterNamingConvention
MavenModelInspection
MethodWithMultipleLoops
ModuleWithTooManyClasses
NonCommentSourceStatements
OverloadedVarargsMethod
ParametersPerConstructor
PublicMethodWithoutLogging

will be addresses in separate issue:
MultipleReturnPointsPerMethod #3496

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Jul 15, 2017

Member

Violations included:

please activate that list of inspections and send PR(not for merge) to generate report on TC.

Member

romani commented Jul 15, 2017

Violations included:

please activate that list of inspections and send PR(not for merge) to generate report on TC.

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Jul 17, 2017

Member

'public' method without logging (Errors) (3823)
Class without logger (Errors) (559)

suppress: "we do not need logging by loggers in all places"

Maven Model Inspection

suppress: "behavior is different from local execution, no violations on local"

Constructor with too many parameters

update option to be "7" for max parameter count and violations that are left suppress by javadoc tag (they are in API class it is not that simple to fix)

Method with multiple loops

suppress: "nonsense in our context"

Method with multiple return points

need to be fixed, already existing issue that is assigned to you #3496

Overly complex method

suppress: "we use our own CyclomaticComplexityCheck and counts SWITCH in special way"

Overly long method

suppress: "we use MethodLengthCheck that supported by better suppression model"

Class independent of its module

only one violation suppress my javadoc tag. It is bug in inspection as it might consider only imports.

Module with too many classes

suppress: "we a single jar project by design , at least next near future"

Class name prefixed with package name

suppress: "names of Checks are public to users, we do care about clear name for user without information in what package it is placed. Check name is unique in whole in whole project"

Lambda parameter naming convention

make max length as 25 symbols, it should resolve all violations.

Overloaded varargs method

suppress: "design problem in inspection as it is not considering diff in argument types before varargs"

Implicit numeric conversion

activate options: "Ignore widening ..." and "... from constant and literals". Violations should disappear.

Class independent of its package

suppress: "we are library(interfaces are used outside of our code base) we can not follow this rule"

Class only used from one other package

please remove AbstractComplexityCheck, AbstractIllegalCheck, AbstractIllegalMethodCheck, AbstractNestedDepthCheck in scope of #4749

put javadoc suppression on JavadocParseTreeTest and CommentListener (#4750)

Package with disjoint dependency graph

suppress: "we against of over decomposition"

Member

romani commented Jul 17, 2017

'public' method without logging (Errors) (3823)
Class without logger (Errors) (559)

suppress: "we do not need logging by loggers in all places"

Maven Model Inspection

suppress: "behavior is different from local execution, no violations on local"

Constructor with too many parameters

update option to be "7" for max parameter count and violations that are left suppress by javadoc tag (they are in API class it is not that simple to fix)

Method with multiple loops

suppress: "nonsense in our context"

Method with multiple return points

need to be fixed, already existing issue that is assigned to you #3496

Overly complex method

suppress: "we use our own CyclomaticComplexityCheck and counts SWITCH in special way"

Overly long method

suppress: "we use MethodLengthCheck that supported by better suppression model"

Class independent of its module

only one violation suppress my javadoc tag. It is bug in inspection as it might consider only imports.

Module with too many classes

suppress: "we a single jar project by design , at least next near future"

Class name prefixed with package name

suppress: "names of Checks are public to users, we do care about clear name for user without information in what package it is placed. Check name is unique in whole in whole project"

Lambda parameter naming convention

make max length as 25 symbols, it should resolve all violations.

Overloaded varargs method

suppress: "design problem in inspection as it is not considering diff in argument types before varargs"

Implicit numeric conversion

activate options: "Ignore widening ..." and "... from constant and literals". Violations should disappear.

Class independent of its package

suppress: "we are library(interfaces are used outside of our code base) we can not follow this rule"

Class only used from one other package

please remove AbstractComplexityCheck, AbstractIllegalCheck, AbstractIllegalMethodCheck, AbstractNestedDepthCheck in scope of #4749

put javadoc suppression on JavadocParseTreeTest and CommentListener (#4750)

Package with disjoint dependency graph

suppress: "we against of over decomposition"

Nimfadora added a commit to Nimfadora/checkstyle that referenced this issue Jul 20, 2017

Nimfadora added a commit to Nimfadora/checkstyle that referenced this issue Jul 20, 2017

romani added a commit that referenced this issue Jul 20, 2017

@romani

This comment has been minimized.

Show comment
Hide comment
@romani

romani Jul 20, 2017

Member

fix is merged.

Member

romani commented Jul 20, 2017

fix is merged.

@romani romani closed this Jul 20, 2017

@romani romani added this to the 8.1 milestone Jul 20, 2017

@romani romani moved this from In Progress to Done in Practice What You Preach Jul 21, 2017

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