-
Notifications
You must be signed in to change notification settings - Fork 0
/
build.sbt
195 lines (184 loc) · 7.91 KB
/
build.sbt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
import sbt.project
lazy val prjName = "fluent-copy"
lazy val prjPackageName = prjName.replaceAll("[^\\p{Alpha}\\d]+", ".")
lazy val prjDescription = "A purely functional XML library"
lazy val prjOrg = "com.github.geirolz"
lazy val scala213 = "2.13.12"
lazy val scala33 = "3.3.4"
lazy val supportedScalaVersions = List(scala213, scala33)
//## global project to no publish ##
val copyReadMe = taskKey[Unit]("Copy generated README to main folder.")
lazy val root: Project = project
.in(file("."))
.settings(
inThisBuild(
List(
homepage := Some(url(s"https://github.com/geirolz/$prjName")),
licenses := List("Apache-2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0")),
developers := List(
Developer(
"DavidGeirola",
"David Geirola",
"david.geirola@gmail.com",
url("https://github.com/geirolz")
)
)
)
)
)
.settings(baseSettings)
.settings(noPublishSettings)
.settings(
crossScalaVersions := Nil
)
.settings(
copyReadMe := IO.copyFile(file("docs/compiled/README.md"), file("README.md"))
)
.aggregate(core, test, docs)
lazy val docs: Project =
project
.in(file("docs"))
.enablePlugins(MdocPlugin)
.dependsOn(core)
.settings(
baseSettings,
noPublishSettings,
libraryDependencies ++= Seq(
ProjectDependencies.Docs.dedicated
).flatten,
// config
scalacOptions --= Seq("-Werror", "-Xfatal-warnings"),
mdocIn := file("docs/source"),
mdocOut := file("docs/compiled"),
mdocVariables := Map(
"PRJ_NAME" -> prjName,
"VERSION" -> previousStableVersion.value.getOrElse("<version>"),
"DOC_OUT" -> mdocOut.value.getPath
)
)
lazy val core: Project =
module("core")(
folder = "./core",
publishAs = Some(prjName)
).settings(
libraryDependencies ++= ProjectDependencies.Core.dedicated
)
lazy val test: Project =
module("test")(
folder = "./test",
publishAs = None
).dependsOn(core)
//=============================== MODULES UTILS ===============================
def module(modName: String)(folder: String, publishAs: Option[String]): Project = {
val keys = modName.split("-")
val modDocName = keys.mkString(" ")
val publishSettings = publishAs match {
case Some(pubName) =>
Seq(
moduleName := pubName,
publish / skip := false
)
case None => noPublishSettings
}
Project(modName, file(folder))
.settings(
name := s"$prjName $modDocName",
publishSettings,
baseSettings
)
}
def subProjectName(modPublishName: String): String = s"$prjName-$modPublishName"
//=============================== SETTINGS ===============================
lazy val noPublishSettings: Seq[Def.Setting[_]] = Seq(
publish := {},
publishLocal := {},
publishArtifact := false,
publish / skip := true
)
lazy val baseSettings: Seq[Def.Setting[_]] = Seq(
// project
name := prjName,
description := prjDescription,
organization := prjOrg,
// scala
crossScalaVersions := supportedScalaVersions,
scalaVersion := supportedScalaVersions.head,
scalacOptions ++= scalacSettings(scalaVersion.value),
versionScheme := Some("early-semver"),
// dependencies
resolvers ++= ProjectResolvers.all,
libraryDependencies ++= ProjectDependencies.common ++ {
CrossVersion.partialVersion(scalaVersion.value) match {
case Some((2, 13)) => ProjectDependencies.Plugins.compilerPluginsFor2_13
case Some((3, _)) => ProjectDependencies.Plugins.compilerPluginsFor3
case _ => Nil
}
},
// fmt
scalafmtOnCompile := true
)
def scalacSettings(scalaVersion: String): Seq[String] =
Seq(
// "-Xlog-implicits",
"-deprecation", // Emit warning and location for usages of deprecated APIs.
"-encoding",
"utf-8", // Specify character encoding used by source files.
"-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
"-language:dynamics"
) ++ {
CrossVersion.partialVersion(scalaVersion) match {
case Some((3, _)) =>
Seq(
"-Ykind-projector",
"-explain-types", // Explain type errors in more detail.
"-Xfatal-warnings" // Fail the compilation if there are any warnings.
)
case Some((2, 13)) =>
Seq(
"-explaintypes", // Explain type errors in more detail.
"-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.
"-Xlint:adapted-args", // Warn if an argument list is modified to match the receiver.
"-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-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.
"-Ywarn-dead-code", // Warn when dead code is identified.
"-Ywarn-extra-implicit", // Warn when more than one implicit parameter section is defined.
"-Xlint:nullary-unit", // Warn when nullary methods return Unit.
"-Ywarn-numeric-widen", // Warn when numerics are widened.
"-Ywarn-value-discard", // Warn when non-Unit expression results are unused.
"-Xlint:inaccessible", // Warn about inaccessible types in method signatures.
"-Xlint:infer-any", // Warn when a type argument is inferred to be `Any`.
"-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:explicits", // Warn if a explicit 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-macros:after", // Tells the compiler to make the unused checks after macro expansion
"-Xsource:3",
"-P:kind-projector:underscore-placeholders",
"-Ymacro-annotations"
)
case _ => Nil
}
}
//=============================== ALIASES ===============================
addCommandAlias("check", "scalafmtAll;clean;coverage;test;coverageAggregate")
addCommandAlias("gen-doc", "mdoc;copyReadMe;")
addCommandAlias("coverage-test", "coverage;test;coverageReport")