Home

Welcome to the Scalastyle wiki.

Note that in addition to the resources here on GitHub, the project has a Google group for discussion.

The following pages contain a list of proposed rules for Scalastyle. There is one page per category of rules. Each page contains a list of rules for that category.

The list of rules and indeed categories are completely inspired by and stolen from the excellent Checkstyle.

Please feel free to modify the text of these pages, in particular:

• adding new rules that you want
• refining the rules that are here with more concrete requirements

List of categories:

• Annotations
• Block Checks
• Class Design
• Coding
• Duplicate code
• Headers
• Imports
• Lazy-Val-Overriding
• Metrics
• Miscellaneous
• Modifiers
• Naming Conventions
• Null
• Package-Decl-Matching-FS
• Regexp
• Return
• Scaladoc Comments
• Size Violations (In progress, Nicolas)
• Types
• Uncapitalized-Identifier-Pattern-Matching
• Whitespace
• XML-literals

Developer documentation:

• Developer Guide