scala-bones
A yeoman generator for Scala projects.
About
scala-bones
is a yeoman-generator for Scala
-projects using sbt
. The generator creates a project that has
- a barebone for an
sbt
project, - a prototype
Main.scala
+TestSuite.scala
, - a unit-test suite using
scalatest
andscalactic
, - badges for the project status, build status using Travis CI and code coverage,
travis.yml
andcodecov.yml
files,java.version
andscalafmt/conf
files,- custom README.md, TODO.md and VERSIONS.md files,
- a GPL3 license.
The resulting folder-structure looks like this:
. |____.codecov.yml |____.gitignore |____.gitattributes |____.java.version |____.scalafmt.conf |____.travis.yml |____.yo-rc.json |____LICENSE |____README.md |____TODO.md |____VERSIONS.md |____build.sbt |____project | |____build.properties | |____plugins.sbt |____src | |____test | | |____scala | | | |____net | | | | |____groupID | | | | | |____tests | | | | | | |____emptyproject | | | | | | | |____Test.scala | |____main | | |____scala | | | |____net | | | | |____groupID | | | | | |____emptyproject
Installation
Yeoman comes with npm
, so install it first and then call:
npm install -g yo npm install -g generator-scala-bones
Once you have the package, you can create a scaffold using:
yo scala-bones
This builds the skeleton. Afterwards modify the sources and build the package with:
sbt compile sbt run
where ${artifactID}
will be the name of your package.
Author
Simon Dirmeier simon.dirmeier.de