Edit

DisableSyntax

This rule reports errors when a "disallowed" syntax is used. This is a syntactic rule, which means it does not require compilation to run unlike the Disable rule.

Example:

MyCode.scala:10: error: [DisableSyntax.throw] exceptions should be avoided,
                        consider encoding the error in the return type instead
  throw new IllegalArgumentException
  ^^^^^

Configuration

By default, this rule does not disable any particular syntax, every setting is opt-in.

Name	Type	Description
noVars	Boolean	Report error for usage of vars.
noThrows	Boolean	Report error for throwing exceptions.
noNulls	Boolean	Report error for usage of null.
noReturns	Boolean	Report error for usage of return.
noAsInstanceOf	Boolean	Report error for usage of asInstanceOf[T] casts.
noIsInstanceOf	Boolean	Report error for usage of isInstanceOf[T] checks.
noXml	Boolean	Report error on xml literals.
noDefaultArgs	Boolean	Report error on method parameters with default arguments.
noFinalVal	Boolean	Report error on `final` modifier for val definitions, see [motivation](https://github.com/sbt/zinc/issues/227)
noFinalize	Boolean	Reports error when finalize is overridden.
noValPatterns	Boolean	Report error when pattern matching in val assignment with non-tuple patterns.
noUniversalEquality	Boolean	Report error on `==` (universal equality)
noUniversalEqualityMessage	String	Reporter message for noUniversalEquality
regex	List[Regex]	Report error if the text contents of a source file matches a given regex.

Defaults

DisableSyntax.noVars = false
DisableSyntax.noThrows = false
DisableSyntax.noNulls = false
DisableSyntax.noReturns = false
DisableSyntax.noAsInstanceOf = false
DisableSyntax.noIsInstanceOf = false
DisableSyntax.noXml = false
DisableSyntax.noDefaultArgs = false
DisableSyntax.noFinalVal = false
DisableSyntax.noFinalize = false
DisableSyntax.noValPatterns = false
DisableSyntax.noUniversalEquality = false
DisableSyntax.noUniversalEqualityMessage = == is unsafe since it allows comparing two unrelated types
DisableSyntax.regex = []

Examples

DisableSyntax.noUniversalEquality = true
DisableSyntax.noUniversalEqualityMessage = "use === instead of =="
DisableSyntax.regex = [
  {
    id = "offensive"
    pattern = "[P|p]imp"
    message = "Please consider a less offensive word such as 'extension' or 'enrichment'"
  }
]