https://github.com/ches/scala-project.g8

Templates to generate Scala project skeletons with giter8
https://github.com/ches/scala-project.g8

g8 giter8 sbt scaffold scala

Last synced: about 6 hours ago
JSON representation

Templates to generate Scala project skeletons with giter8

• Host: GitHub
• URL: https://github.com/ches/scala-project.g8
• Owner: ches
• License: other
• Created: 2014-12-11T09:01:24.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2021-07-25T11:03:19.000Z (over 3 years ago)
• Last Synced: 2023-04-11T19:38:40.019Z (over 1 year ago)
• Topics: g8, giter8, sbt, scaffold, scala
• Language: Scala
• Size: 19.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
Scala Project Templates

-----------------------

Templates for generating project skeletons with `sbt new`, via [giter8]. There

are [many others to choose from][templates], I wanted something more minimal

than most of those as the default, with more specific or opinionated templates

available on branches.

For an open source project, I recommend having a look at

[joescii/scala-oss][oss] for extra features like publishing Scaladoc to GitHub

Pages, publishing artifacts for multiple Scala versions to Maven Central, etc.

### Usage ###

Since sbt 0.13.13, you can simply [use `sbt new`][sbt new]:

    $ sbt new ches/scala-project.g8

You will be prompted for parameters such as your project name.

If you prefer, you can use giter8 directly. With Homebrew on Mac OS X, it's

convenient to `brew install giter8`. Otherwise, see the [installation].

Then, simply invoke `g8` to generate a project:

    $ g8 ches/scala-project

### Available Templates ###

giter8 supports installing alternative templates from branches of a repository.

Templates available here are described below.

#### Default

    $ sbt new ches/scala-project.g8

The default is a minimal template for a basic single-module [sbt] project.

Features:

  - Minimal "bare" build configuration, the only declared dependency is

    ScalaTest. I'll accept a pull request for a specs2 branch if you insist :-)

  - Shallow sbt-style `src` layout, no deep package hierarchy directories.

  - Prompts for Scala version, defaulting to latest release.

  - `spec` [scaffold] to generate stub ScalaTest files. Enable the

    `sbt-giter8-scaffold` sbt plugin to use it with `g8Scaffold spec`.

    Edit defaults in `.g8/spec/default.properties` after the first use to spare

    yourself from entering project details like package name repetitively.

That's all so far :-)

### Contributing

This sort of thing is always tailored to personal tastes or organization

standards. If you mostly like the way I've done things but have a suggestion or

a tweak, feel free to send a pull request. If I don't like it, no hard feelings,

it's easy to maintain your own just the way you like.

See [Making your own templates].

### License

This software template is placed in the public domain according to Creative

Commons [CC0 1.0]. See `LICENSE.txt`.

[giter8]: https://github.com/foundweekends/giter8

[templates]: https://github.com/foundweekends/giter8/wiki/giter8-templates

[oss]: https://github.com/joescii/scala-oss.g8

[sbt new]: https://www.scala-sbt.org/1.x/docs/sbt-new-and-Templates.html

[installation]: http://www.foundweekends.org/giter8/setup.html

[sbt]: http://www.scala-sbt.org/

[scaffold]: http://www.foundweekends.org/giter8/scaffolding.html

[Making your own templates]: http://www.foundweekends.org/giter8/template.html

[CC0 1.0]: https://creativecommons.org/publicdomain/zero/1.0/