package scalariform
- Alphabetic
- Public
- All
Type Members
- abstract class AbstractClassChecker extends ScalariformChecker
- abstract class AbstractImportChecker extends ScalariformChecker
- abstract class AbstractMethodChecker extends ScalariformChecker
- abstract class AbstractSingleMethodChecker [T] extends ScalariformChecker
- abstract class AbstractTokenChecker extends ScalariformChecker
- class BlockImportChecker extends ScalariformChecker
- class ClassNamesChecker extends ScalariformChecker
- class ClassTypeParameterChecker extends AbstractClassChecker
- class CovariantEqualsChecker extends AbstractMethodChecker
- class CyclomaticComplexityChecker extends CombinedChecker
- class DeprecatedJavaChecker extends JavaAnnotationChecker
- class DisallowSpaceAfterTokenChecker extends SpaceAroundTokenChecker
- class DisallowSpaceBeforeTokenChecker extends SpaceAroundTokenChecker
- class EmptyClassChecker extends AbstractClassChecker
- class EmptyInterpolatedStringChecker extends ScalariformChecker
- class EnsureSingleSpaceAfterTokenChecker extends SpaceAroundTokenChecker
- class EnsureSingleSpaceBeforeTokenChecker extends SpaceAroundTokenChecker
- class EqualsHashCodeChecker extends AbstractMethodChecker
- class FieldNamesChecker extends ScalariformChecker
- class ForBraceChecker extends ScalariformChecker
- class IfBraceChecker extends CombinedChecker
- class IllegalImportsChecker extends AbstractImportChecker
- class ImportGroupingChecker extends ScalariformChecker
-
class
ImportOrderChecker
extends ScalariformChecker
Style checker that enforces import ordering.
Style checker that enforces import ordering. The following configuration parameters are available:
- groups: a comma-separated list of group names to consider.
- maxBlankLines: maximum number of blank lines to allow between groups. The default is "1". A value less than 1 disables the blank line limit.
- group.[groupName]: a regular expression that matches imports that should be in the given group.
- lexicographic: if true, imports are ordered lexicographically (classes, wildcards, then packages; case-sensitive ordering within); if false, apply the original case-insensitive ordering (with wildcards coming first, before classes).
For example, to check that "java" and "javax" imports are in a separate group at the top of the import list, you'd use this config:
<parameter name="groups">java,others</parameter> <parameter name="group.java">javax?\..+</parameter> <parameter name="group.other">.+</parameter>
Other non-configurable rules: - Within each group, import clauses are ordered alphabetically if 'lexicographic' is specified; else puts wildcards, then classes and packages, with case-insensitive sort. - In multi-import statements, entries are ordered alphabetically, with method / packages (assumed to be any string starting with a lower case letter) coming before classes.
Currently, this checker only looks at the top-level list of imports.
- abstract class JavaAnnotationChecker extends ScalariformChecker
- class LowercasePatternMatchChecker extends ScalariformChecker
- class MagicNumberChecker extends ScalariformChecker
- class MethodArgumentNamesChecker extends AbstractSingleMethodChecker[MethodArgumentNamesCheckerParameters]
- case class MethodArgumentNamesCheckerParameters (regexString: String, ignoreRegexString: String) extends Product with Serializable
- class MethodLengthChecker extends CombinedChecker
- class MethodNamesChecker extends AbstractSingleMethodChecker[MethodNamesCheckerParameters]
- case class MethodNamesCheckerParameters (regexString: String, ignoreRegexString: String, ignoreOverride: Boolean) extends Product with Serializable
- class MultipleStringLiteralsChecker extends ScalariformChecker
-
class
NamedArgumentChecker
extends ScalariformChecker
Checks method calls to ensure that passed literals are named.
- class NoCloneChecker extends AbstractMethodChecker
- class NoFinalizeChecker extends AbstractMethodChecker
- class NoWhitespaceAfterLeftBracketChecker extends ScalariformChecker
- class NoWhitespaceBeforeLeftBracketChecker extends ScalariformChecker
- class NoWhitespaceBeforeRightBracketChecker extends ScalariformChecker
- class NonASCIICharacterChecker extends ScalariformChecker
- class NotImplementedErrorUsage extends ScalariformChecker
- class NullChecker extends ScalariformChecker
- class NumberOfMethodsInTypeChecker extends AbstractMethodChecker
- class NumberOfTypesChecker extends ScalariformChecker
- class ObjectNamesChecker extends ScalariformChecker
- class OverrideJavaChecker extends JavaAnnotationChecker
- class PackageNamesChecker extends ScalariformChecker
- class PackageObjectNamesChecker extends ScalariformChecker
- class ParameterNumberChecker extends AbstractSingleMethodChecker[Int]
- class PatternMatchAlignChecker extends CombinedChecker
- class ProcedureDeclarationChecker extends AbstractSingleMethodChecker[Unit]
- class PublicMethodsHaveTypeChecker extends AbstractSingleMethodChecker[PublicMethodsHaveTypeParameters]
- case class PublicMethodsHaveTypeParameters (ignoreOverride: Boolean) extends Product with Serializable
- class RedundantIfChecker extends CombinedChecker
- class ReturnChecker extends AbstractTokenChecker
-
class
ScalaDocChecker
extends CombinedChecker
Checks that the ScalaDoc exists for all accessible members: - classes, traits, case classes and objects - methods - vals, vars and types
Checks that the ScalaDoc exists for all accessible members: - classes, traits, case classes and objects - methods - vals, vars and types
The ScalaDoc's structure must satisfy the parameter of the constructor in case of case classes and classes, or the parameter of the methods. The ScalaDoc must include the type parameters. Finally, the ScalaDoc must include return description for non-Unit returning methods.
- class SimplifyBooleanExpressionChecker extends ScalariformChecker
- class SpaceAfterCommentStartChecker extends ScalariformChecker
- trait SpaceAroundTokenChecker extends ScalariformChecker
- class SpacesAfterPlusChecker extends ScalariformChecker
- class SpacesBeforePlusChecker extends ScalariformChecker
- class StructuralTypeChecker extends ScalariformChecker
-
class
TodoCommentChecker
extends CombinedChecker
comment check for line comment style TODO or FIXME
- class TokenChecker extends AbstractTokenChecker
- class UnderscoreImportChecker extends AbstractImportChecker
- class UppercaseLChecker extends AbstractTokenChecker
- abstract class VarChecker extends ScalariformChecker
- class VarFieldChecker extends VarChecker
- class VarLocalChecker extends VarChecker
- class WhileChecker extends AbstractTokenChecker
- class XmlLiteralChecker extends ScalariformChecker
Value Members
-
object
ScalaDocChecker
Contains the ScalaDoc model with trivial parsers
- object VisitorHelper