Skip to content

Commit

Permalink
show how to use auto plugins as source deps
Browse files Browse the repository at this point in the history
  • Loading branch information
tkroman committed Sep 2, 2017
0 parents commit dfe7554
Show file tree
Hide file tree
Showing 14 changed files with 110 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
target/
1 change: 1 addition & 0 deletions a/build.sbt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
scalaVersion := "2.12.3"
1 change: 1 addition & 0 deletions a/project/build.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sbt.version = 1.0.1
3 changes: 3 additions & 0 deletions a/project/plugins.sbt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
lazy val sp = ProjectRef(file("../../plugin"), "plugin")

dependsOn(sp)
Empty file added a/project/project/plugins.sbt
Empty file.
15 changes: 15 additions & 0 deletions a/src/main/scala/com/tkroman/example/sbtplugin/ErrA.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
package com.tkroman.example.sbtplugin

import com.github.ghik.silencer.silent

// fails to compile because no `rpintln` method,
// but doesn't fail due to "`xs` is unused",
// so both silencer & errors summary plugins + runtime lib dep
// are visible.
// Also, outputs in a nicer way thanks to errors summary
@silent
object ErrA {
def main(xs: Array[String]): Unit = {
rpintln(0)
}
}
1 change: 1 addition & 0 deletions b/build.sbt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
scalaVersion := "2.12.3"
1 change: 1 addition & 0 deletions b/project/build.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sbt.version = 1.0.1
3 changes: 3 additions & 0 deletions b/project/plugins.sbt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
lazy val sp = ProjectRef(file("../../plugin"), "plugin")

dependsOn(sp)
11 changes: 11 additions & 0 deletions b/src/main/scala/com/tkroman/example/sbtplugin/ErrB.scala
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package com.tkroman.example.sbtplugin


// fails to compile because no @silent annotation,
// but `xs` is unused, so both silencer & errors summary plugins
// are visible
object ErrB {
def main(xs: Array[String]): Unit = {
println(0)
}
}
6 changes: 6 additions & 0 deletions plugin/build.sbt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
scalaVersion := "2.12.3"

sbtPlugin := true

// adding this here instead of project/ because we want to provide this to users.
addSbtPlugin("org.duhemm" % "sbt-errors-summary" % "0.6.0")
1 change: 1 addition & 0 deletions plugin/project/build.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sbt.version = 1.0.1
Empty file added plugin/project/plugins.sbt
Empty file.
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
package com.tkroman.example.sbtplugin

import sbt._
import sbt.Keys._

object SettingsPlugin extends AutoPlugin {
override lazy val projectSettings = Seq(
libraryDependencies ++= Seq(
"com.github.ghik" %% "silencer-lib" % "0.5"
),

addCompilerPlugin("com.github.ghik" %% "silencer-plugin" % "0.5"),

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.
)
)

override def trigger: PluginTrigger = allRequirements

override def requires = sbt.errorssummary.Plugin
}

0 comments on commit dfe7554

Please sign in to comment.