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
|
# _sbt_ plugin for common _sbt_ settings [](https://travis-ci.com/drivergroup/sbt-settings)
Provides common sbt configuration for sbt itself, Scala compiler, testing, linting, formatting, release process, packaging, publication to Driver Scala projects. Allowing to use only necessary parts. Artifact organization is set to `xyz.driver`.
## TL;DR
### project/plugins.sbt
resolvers += "releases" at "https://drivergrp.jfrog.io/drivergrp/releases"
credentials += Credentials("Artifactory Realm", "drivergrp.jfrog.io", "sbt-publisher", "***REMOVED***")
addSbtPlugin("xyz.driver" % "sbt-settings" % "0.5.11")
### build.sbt
Do `sbt reload` after adding a plugin and configure a project:
lazy val root = (project in file("."))
.settings (name := "Name-Of-Your-Project")
.integrationTestingConfiguration // Enable integration tests
.buildInfoConfiguration // Build info accessible in app code
.gitPluginConfiguration // Git tag to application version number
.packagingConfiguration // To package to zip file as java server app
.settings(lintingSettings) // Scala code linting settings, includes `wartRemoverSettings` and `scalastyleSettings`
.settings(formatSettings) // Standard Scala code formatting
.settings(repositoriesSettings) // To use dependencies from Driver jar repository
.settings(publicationSettings) // Publishing to Driver jar repository
.settings(releaseSettings) // Release process configuration
.dockerConfiguration( // Docker containerization settings
imageName = "direct-api", // docker image name
repository = "{id}.dkr.ecr.{site}.amazonaws.com", // ec2 repo
exposedPorts = Seq(8080), // ports the docker container exposes
aggregateSubprojects = false
)
## Reference
Artifact organization is set to `xyz.driver`.
### Scala compiler settings
Scala version — 2.11.8, flags configured:
- Common settings: `-unchecked -feature -encoding utf8`,
- _Advanced Scala features_: `-language:higherKinds -language:implicitConversions -language:postfixOps`,
- _Compiler linting_: `-Xlint -deprecation -Ywarn-numeric-widen -Ywarn-dead-code -Ywarn-unused -Ywarn-unused-import`.
### Used sbt plugins
- [sbt-scalafmt](https://olafurpg.github.io/scalafmt/) - code formatter for Scala,
- [sbt-wartremover](https://github.com/puffnfresh/wartremover) - flexible Scala code linting tool,
- [scalastyle-sbt-plugin](https://github.com/scalastyle) - examines your Scala code and indicates potential problems with it,
- [sbt-revolver](https://github.com/spray/sbt-revolver) - for dangerously fast development turnaround in Scala,
- [sbt-buildinfo](https://github.com/sbt/sbt-buildinfo) - generates Scala source from your build definitions,
- [sbt-git](https://github.com/sbt/sbt-git) - to get access to git data (commit hash, branch) in sbt,
- [sbt-native-packager](https://github.com/sbt/sbt-native-packager) - build application packages in native formats,
- [sbt-assembly](https://github.com/sbt/sbt-assembly) - deploy fat JARs. Restart processes (sbt-native-packager is used instead,)
- [sbt-release](https://github.com/sbt/sbt-release) - customizable release process,
- [sbt-docker](https://github.com/marcuslonnberg/sbt-docker) - create Docker images directly from sbt.
## Examples
### Simple project configuration example
import sbt._
import Keys._
lazy val core = (project in file(".")).
settings(name := "Name-Of-Your-Project").
settings(
libraryDependencies ++= Seq(
"xyz.driver" %% "core" % "0.2.0",
"xyz.driver" %% "domain-model" % "0.1.0",
"com.typesafe.slick" %% "slick" % "3.1.1",
// ... etc
))
.gitPluginConfiguration
.settings (lintingSettings ++ formatSettings)
.settings(releaseSettings)
### Complex project configuration example
import sbt._
import sbt.Keys._
// we hide the existing definition for setReleaseVersion to replace it with our own
import sbtrelease.ReleaseStateTransformations.{setReleaseVersion => _}
// Sub-project specific dependencies
lazy val dependencies = Seq(
"xyz.driver" %% "core" % "0.2.0",
"xyz.driver" %% "domain-model" % "0.1.0",
"com.typesafe.slick" %% "slick" % "3.1.1",
"com.typesafe" % "config" % "1.2.1",
// ... etc
)
lazy val dependenciesSettings = Seq(
resolvers += "justwrote" at "http://repo.justwrote.it/releases/",
libraryDependencies ++= dependencies
)
lazy val testingDependencies = Seq(
libraryDependencies ++= Seq(
"com.typesafe.akka" %% "akka-testkit" % "2.4.8" % "test",
"org.scalatest" % "scalatest_2.11" % "2.2.1" % "test",
"org.mockito" % "mockito-core" % "1.9.5" % "test"
)
)
lazy val integrationTestingDependencies = Seq(
libraryDependencies ++= Seq(
"com.typesafe.akka" %% "akka-testkit" % akkaV % "test,it",
"org.scalatest" % "scalatest_2.11" % "2.2.1" % "test,it",
"org.mockito" % "mockito-core" % "1.9.5" % "test,it"
)
)
lazy val usersModule = (project in file("users"))
.settings (lintingSettings ++ formatSettings ++ repositoriesSettings)
.settings (dependenciesSettings ++ testingDependencies)
.settings (publishTo := Some(Resolver.defaultLocal))
lazy val assaysModule = (project in file("assays"))
.settings (lintingSettings ++ formatSettings ++ repositoriesSettings)
.settings (dependenciesSettings ++ testingDependencies)
.settings (publishTo := Some(Resolver.defaultLocal))
lazy val reportsModule = (project in file("reports"))
.settings (lintingSettings ++ formatSettings ++ repositoriesSettings)
.settings (dependenciesSettings ++ testingDependencies)
.settings (publishTo := Some(Resolver.defaultLocal))
lazy val root = (project in file("."))
.settings (name := "direct")
.integrationTestingConfiguration
.settings (lintingSettings ++ formatSettings ++ repositoriesSettings)
.settings (dependenciesSettings ++ integrationTestingDependencies)
.settings (publicationSettings ++ releaseSettings)
.buildInfoConfiguration
.gitPluginConfiguration
.packagingConfiguration
.dockerConfiguration
.dependsOn (usersModule, assaysModule, reportsModule)
.aggregate (usersModule, assaysModule, reportsModule)
For more examples please refer to [Driver Template](https://github.com/drivergroup/***REMOVED***), [Core library](https://github.com/drivergroup/***REMOVED***) or [***REMOVED***](https://github.com/drivergroup/***REMOVED***) projects.
|
