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

Enable additional checkstyle checks #991

Closed
2 tasks done
algattik opened this issue Mar 29, 2022 · 2 comments
Closed
2 tasks done

Enable additional checkstyle checks #991

algattik opened this issue Mar 29, 2022 · 2 comments
Assignees
Labels
refactoring Cleaning up code and dependencies stale Open for x days with no activity

Comments

@algattik
Copy link
Contributor

algattik commented Mar 29, 2022

Feature Request

Which Areas Would Be Affected?

All

Why Is the Feature Desired?

Improve code consistency and reduce spurious PR diffs by enabling additional checkstyle checks as applicable.

Solution Proposal

  • Evaluate additional checks, e.g. from list below
  • Consider whether upgrading to checkstyle 10 brings benefits
  • Ensure any checks that generate many violations in existing codebase don't break the build initially, they can be tightened later

Examples of checks that could be added:

  • Header
  • NewlineAtEndOfFile
  • SuppressWarningsFilter (not a check, but allows disabling checks in specific files)
  • the following checks are used in Azure SDK but not currently enabled in EDC:
    • AvoidNestedBlocks
    • ConstantNameCheck
    • EmptyForIteratorPad
    • EmptyStatement
    • EqualsHashCode
    • FinalClass
    • IllegalImport
    • IllegalInstantiation
    • InnerAssignment
    • InterfaceIsType
    • LocalFinalVariableName
    • MagicNumber
    • MemberNameCheck
    • MethodNameCheck
    • MissingDeprecated
    • MissingJavadocPackage
    • NoWhitespaceAfter
    • RedundantImport
    • RedundantModifier
    • StaticVariableName
    • StaticVariableNameCheck
    • TypeNameCheck
    • TypecastParenPad
    • UnusedImports
    • VisibilityModifier
    • SuppressWarningsHolder

Type of Issue

code quality improvement

Checklist

  • assigned appropriate label?
  • Do NOT select a milestone or an assignee!
@github-actions
Copy link

github-actions bot commented Jun 7, 2022

This issue is stale because it has been open for 28 days with no activity.

@github-actions github-actions bot added the stale Open for x days with no activity label Jun 7, 2022
@github-actions
Copy link

This issue was closed because it has been inactive for 7 days since being marked as stale.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Cleaning up code and dependencies stale Open for x days with no activity
Projects
None yet
Development

No branches or pull requests

2 participants