Flagi kompilatora Scalac

Nie bójmy się tego powiedzieć, Scala to nowy Perl. I tak jak w Perlu, w Scali obowiązuje zasada TIMTOWTDI (ang. There is more than one way to do it), czyli “Można to zrobić na różne sposoby”.

Jednak z biegiem czasu twórcy języka Scala uznali, że niektóre sposoby są lepsze od innych i powinna istnieć możliwość wyłączenia gorszych sposobów. Dodatkowo niektóre funkcjonalności języka są tak inne od tego co do tej pory widzieli programiści języków obiektowych, że nie powinny być domyślnie włączone. Oba te warunki, i pewnie jeszcze kilka innych, powodują, że Scalac, kompilator języka Scala, posiada flagi kompilacji. Dokładniej Scalac posiada ogromną ilość flag kompilacji.

Rekomendowana lista flag kompilatora

Na szczęście istnieją tacy ludzie jak tpolecat, który na swoim blogu zebrał listę rekomendowanych flag kompilatora Są to:

scalacOptions ++= Seq(
  "-deprecation",                      // Emit warning and location for usages of deprecated APIs.
  "-encoding", "utf-8",                // Specify character encoding used by source files.
  "-explaintypes",                     // Explain type errors in more detail.
  "-feature",                          // Emit warning and location for usages of features that should be imported explicitly.
  "-language:existentials",            // Existential types (besides wildcard types) can be written and inferred
  "-language:experimental.macros",     // Allow macro definition (besides implementation and application)
  "-language:higherKinds",             // Allow higher-kinded types
  "-language:implicitConversions",     // Allow definition of implicit functions called views
  "-unchecked",                        // Enable additional warnings where generated code depends on assumptions.
  "-Xcheckinit",                       // Wrap field accessors to throw an exception on uninitialized access.
  "-Xfatal-warnings",                  // Fail the compilation if there are any warnings.
  "-Xfuture",                          // Turn on future language features.
  "-Xlint:adapted-args",               // Warn if an argument list is modified to match the receiver.
  "-Xlint:by-name-right-associative",  // By-name parameter of right associative operator.
  "-Xlint:constant",                   // Evaluation of a constant arithmetic expression results in an error.
  "-Xlint:delayedinit-select",         // Selecting member of DelayedInit.
  "-Xlint:doc-detached",               // A Scaladoc comment appears to be detached from its element.
  "-Xlint:inaccessible",               // Warn about inaccessible types in method signatures.
  "-Xlint:infer-any",                  // Warn when a type argument is inferred to be `Any`.
  "-Xlint:missing-interpolator",       // A string literal appears to be missing an interpolator id.
  "-Xlint:nullary-override",           // Warn when non-nullary `def f()' overrides nullary `def f'.
  "-Xlint:nullary-unit",               // Warn when nullary methods return Unit.
  "-Xlint:option-implicit",            // Option.apply used implicit view.
  "-Xlint:package-object-classes",     // Class or object defined in package object.
  "-Xlint:poly-implicit-overload",     // Parameterized overloaded implicit methods are not visible as view bounds.
  "-Xlint:private-shadow",             // A private field (or class parameter) shadows a superclass field.
  "-Xlint:stars-align",                // Pattern sequence wildcard must align with sequence component.
  "-Xlint:type-parameter-shadow",      // A local type parameter shadows a type already in scope.
  "-Xlint:unsound-match",              // Pattern match may not be typesafe.
  "-Yno-adapted-args",                 // Do not adapt an argument list (either by inserting () or creating a tuple) to match the receiver.
  "-Ypartial-unification",             // Enable partial unification in type constructor inference
  "-Ywarn-dead-code",                  // Warn when dead code is identified.
  "-Ywarn-extra-implicit",             // Warn when more than one implicit parameter section is defined.
  "-Ywarn-inaccessible",               // Warn about inaccessible types in method signatures.
  "-Ywarn-infer-any",                  // Warn when a type argument is inferred to be `Any`.
  "-Ywarn-nullary-override",           // Warn when non-nullary `def f()' overrides nullary `def f'.
  "-Ywarn-nullary-unit",               // Warn when nullary methods return Unit.
  "-Ywarn-numeric-widen",              // Warn when numerics are widened.
  "-Ywarn-unused:implicits",           // Warn if an implicit parameter is unused.
  "-Ywarn-unused:imports",             // Warn if an import selector is not referenced.
  "-Ywarn-unused:locals",              // Warn if a local definition is unused.
  "-Ywarn-unused:params",              // Warn if a value parameter is unused.
  "-Ywarn-unused:patvars",             // Warn if a variable bound in a pattern is unused.
  "-Ywarn-unused:privates",            // Warn if a private member is unused.
  "-Ywarn-value-discard"               // Warn when non-Unit expression results are unused.
)

Lista jest długa i działa dla języka Scala w wersji 2.12. Jeśli używasz języka Scala w wersji wcześniejszej to część flag będziesz musiał wyłączyć. Dla wersji 2.11 jest to:

scalacOptions --= Seq(
  "-Xlint:constant",
  "-Ywarn-extra-implicit",
  "-Ywarn-unused:implicits",
  "-Ywarn-unused:imports",
  "-Ywarn-unused:locals",
  "-Ywarn-unused:params",
  "-Ywarn-unused:patvars",
  "-Ywarn-unused:privates",
)

.. i wtyczka do nich

Lista opcji jest długa i może zaciemniać plik build.sbt. Na szczęście DavidGregory084 stworzył wtyczkę sbt-tpolecat dodającą flagi kompilatora do projektu.

W pliku ` project/plugins.sbt` dodajemy:

addSbtPlugin("io.github.davidgregory084" % "sbt-tpolecat" % "0.1.4")

i wtyczka automatycznie ustawia odpowiednie flagi dla wersji 2.10/2.11/2.12/2.13

Portable Scala & Multi-project

Jeśli kompilujesz projekt w Scali na różne platformy (JVM/JS/Native) lub posiadasz multi-project, tak jak ja w projekcie resentiment, to musisz ręcznie dodać flagi dla kompilatora. Flagi generuje metoda scalacOptionsFor, która jako parametr pobiera wersję języka Scala. Flagi dodajemy do każdego projektu z osobna lub do wydzielonych ustawień jak w moim przypadku:

val SharedSettings = Seq(
  scalaVersion := "2.11.12",
  scalacOptions ++= scalacOptionsFor(scalaVersion.value),
  // ...
)

ScalaFix i modyfikacja domyślnych flag

Właśnie ustawiliśmy ponad 30 różnych flag, ale pewnie w niektórych wypadkach chciałbyś zmodyfikować tę listę. Np. żeby móc używać wtyczki ScalaFix.

Wtyczka ta wymaga dodania dwóch flag (-Ywarn-adapted-args, -Ywarn-unused") oraz usunięcia jednej (-Xfatal-warnings). Dla wygody, flagi przypisuję do zmiennych, a następnie dodaje do scalacOptions.

val ScalaFixScalacOptions = Seq(
  "-Ywarn-adapted-args", // for NoAutoTupling
  "-Ywarn-unused", // for RemoveUnused
)

val ScalaFixScalacOptionsOff = Seq(
  "-Xfatal-warnings",   // it should be disabled for scalafix
)

val SharedSettings = Seq(
  scalaVersion := "2.11.12",
  scalacOptions ++= scalacOptionsFor(scalaVersion.value),
  scalacOptions ++= ScalaFixScalacOptions,
  scalacOptions --= ScalaFixScalacOptionsOff,
  // ...
)

W identyczny sposób można włączać i wyłączać każdą inną flagę kompilatora Scalac.

Statyczna analiza kodu dla języka Scala w SBT - część 2.

Jest to kontynuacja posta Statyczna analiza kodu dla języka Scala w SBT - część 1.

Wtyczki nie modyfikujące kodu źródłowego.

Jest to o wiele większy zestaw wtyczek niż poprzednio.

Scalastyle - Scala style checker

Scalastyle

Dodajemy Scalastyle do pliku project/plugins.sbt:

addSbtPlugin("org.scalastyle" %% "scalastyle-sbt-plugin" % "1.0.0")

Generujemy domyślny plik konfiguracyjny scalastyle-config.xml zawierający reguły:

sbt scalastyleGenerateConfig

Wchodzimy do pliku scalastyle-config.xml i zmieniamy poziomy z warning na error.

Następnie wyłączamy sprawdzanie nagłówka:

 <check level="error" class="org.scalastyle.file.HeaderMatchesChecker" enabled="false"/>

A na końcu poprawiamy formatowanie dwuliniowej instrukcji if:

 <check level="error" class="org.scalastyle.scalariform.IfBraceChecker" enabled="true">
  <parameters>
   <parameter name="singleLineAllowed"><![CDATA[true]]></parameter>
   <parameter name="doubleLineAllowed"><![CDATA[true]]></parameter>
  </parameters>
 </check>

Teraz analizujemy kod i testy za pomocą polecenia:

sbt scalastyle test:scalastyle it:scalastyle

Pełna lista reguł jest dostępna pod linkiem rules-1.0.0.

Dla mnie najważniejszą funkcjonalnością jest liczenie złożoności cyklomatycznej:

 <check level="error" class="org.scalastyle.scalariform.CyclomaticComplexityChecker" enabled="true">
  <parameters>
   <parameter name="maximum"><![CDATA[2]]></parameter>
  </parameters>
 </check>

WartRemover: a flexible scala linter

WartRemover jest to wtyczka do usuwania brodawek z kodu. Przez brodawkę autor rozumie brzydkie rzeczy, które można napisać w języku Scala, bo składnia języka jest zbyt liberalna. Nazwa wtyczki jest trochę na wyrost, ponieważ w tej chwili WartRemover pozwala tylko odnaleźć brodawki, a usunąć musimy je sami.

Dodajemy wartremover do pliku project/plugins.sbt:

addSbtPlugin("org.wartremover" % "sbt-wartremover" % "2.3.7")

W pliku build.sbt włączamy wartremover:

wartremoverErrors ++= Warts.unsafe

Od teraz przy każdej kompilacji będą poszukiwane brodawki. Pełna lista brodawkek

Scapegoat - Scala compiler plugin for static code analysis

Scapegoat to linter dla języka Scala.

Dodajemy scapegoat do pliku project/plugins.sbt:

addSbtPlugin("com.sksamuel.scapegoat" %% "sbt-scapegoat" % "1.3.8")

Ustawiamy wersję scapegoat w build.sbt:

scapegoatVersion := "1.1.0"

Analizujemy kod za pomocą polecenia:

sbt scapegoat

Linter - Static Analysis Compiler Plugin for Scala

Linter to niestety nie rozwijany już linter.

Dodajemy Linter do pliku project/plugins.sbt:

addCompilerPlugin("org.psywerx.hairyfotr" %% "linter" % "0.1.17")

Linter uruchamia się automatycznie podczas kompilacji.

Scala clippy - Good advice for Scala compiler errors

Scala clippy to wtyczka dodająca porady jak poprawić błędy kompilacji.

Dodajemy clippy do pliku project/plugins.sbt:

addSbtPlugin("com.softwaremill.clippy" % "plugin-sbt" % "0.5.3")

sbt-cpd - Copy & Paste Detector plugin using PMD for sbt.

sbt-cpd to wtyczka do wykrywania duplikatów kodu za pomocą Copy/Paste Detector (CPD) z projektu PMD.

Dodajemy sbt-cpd do pliku project/plugins.sbt:

addSbtPlugin("com.github.sbt" % "sbt-cpd" % "2.0.0")

I analizujemy kod za pomocą polecenia:

sbt cpd

stats - An sbt plugin for source code statistics

sbt-stats to wtyczka licząca ilość plików, linii i znaków w projekcie.

Dodajemy stats do pliku project/plugins.sbt:

addSbtPlugin("com.orrsella" % "sbt-stats" % "1.0.7")

Analizujemy kod za pomocą polecenia:

sbt stats

Podsumowanie

Wszystkie wymienione wyżej wtyczki dodałem do projektu [resentiment](https://github.com/writeonly/resentiment.)

Moja komenda generowania raportów wygląda następująco:

sbt scalastyle test:scalastyle it:scalastyle && \
sbt scapegoat && \
sbt cpd && \
sbt stats

Niestety, ponieważ używam metody println w klasie Core, muszę obniżyć poziom raportowania błędów dla reguły org.scalastyle.file.RegexChecker w ScalaStyle z error na warning.

Follow