com.sksamuel.scapegoat.inspections.naming.MethodNames.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scalac-scapegoat-plugin_2.13.13 Show documentation

Scala compiler plugin for static code analysis

The newest version!

package com.sksamuel.scapegoat.inspections.naming

import scala.reflect.internal.Flags

import com.sksamuel.scapegoat.{Inspection, InspectionContext, Inspector, Levels}

/**
 * @author
 *   Stephen Samuel
 */
class MethodNames
    extends Inspection(
      text = "Method name not recommended",
      defaultLevel = Levels.Info,
      description = "Warns on method names that don't adhere to the Scala style guidelines.",
      explanation =
        "Methods should be in camelCase style with the first letter lower-case. See http://docs.scala-lang.org/style/naming-conventions.html#methods."
    ) {

  def inspector(ctx: InspectionContext): Inspector =
    new Inspector(ctx) {
      override def postTyperTraverser: context.Traverser =
        new context.Traverser {

          import context.global._

          private val regex = "^([a-z][A-Za-z0-9]*(_\\$eq)?)|(unary_\\$(minus|plus|bang|tilde))$"

          override def inspect(tree: Tree): Unit = {
            tree match {
              case dd: DefDef if dd.symbol != null && dd.symbol.isSynthetic                     =>
              case DefDef(mods, _, _, _, _, _) if mods.hasFlag(Flags.ACCESSOR)                  =>
              case DefDef(_, nme.CONSTRUCTOR, _, _, _, _)                                       =>
              case DefDef(_, _, _, _, _, _) if tree.symbol != null && tree.symbol.isConstructor =>
              case DefDef(_, name, _, _, _, _) if !name.decode.exists(_.isLetter)               =>
              case DefDef(_, name, _, _, _, _) if !name.toString.matches(regex) =>
                context.warn(tree.pos, self)
              case _ => continue(tree)
            }
          }
        }
    }
}