generator-scala-bones

A yeoman-generator for Scala projects

Usage no npm install needed!

<script type="module">
  import generatorScalaBones from 'https://cdn.skypack.dev/generator-scala-bones';
</script>

README

scala-bones

Project Status travis appveyor codecov Codacy Badge npm version npm download

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 and scalactic,
  • badges for the project status, build status using Travis CI and code coverage,
  • travis.yml and codecov.yml files,
  • java.version and scalafmt/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
  (sbt package)

where ${artifactID} will be the name of your package.

Author

Simon Dirmeier simon.dirmeier.de