sbt-war

[![Build status](https://github.com/earldouglas/sbt-war/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/earldouglas/sbt-war/actions/workflows/test.yml)
[![Latest version](https://img.shields.io/github/v/tag/earldouglas/sbt-war)](https://github.com/earldouglas/sbt-war/tags)
[![Maven Central](https://img.shields.io/maven-central/v/com.earldouglas/sbt-war_2.12_1.0)](https://repo1.maven.org/maven2/com/earldouglas/sbt-war_2.12_1.0/)

# sbt-war

sbt-war is an [sbt](https://www.scala-sbt.org/) plugin for packaging and
running [WAR](https://en.wikipedia.org/wiki/WAR_(file_format)) files.

sbt-war is formerly known as xsbt-web-plugin, the last version of which
was [4.2.5](https://github.com/earldouglas/sbt-war/tree/4.2.5).  For
documentation and source code of prior versions, browse this repository
from the desired git tag.

## Requirements

* sbt 1.x and up
* Scala 2.12.x and up

## Getting help

* Submit a question, bug report, or feature request as a [new GitHub
  issue](https://github.com/earldouglas/sbt-war/issues/new)
* Look for *earldouglas* in the `#sbt` channel on the [Scala Discord
  server](https://discord.com/invite/scala)

## Project structure

A project that uses sbt-war looks something like this:

```
$ tree my-web-project/
my-web-project/
├── build.sbt
├── project
│   ├── build.properties
│   └── plugins.sbt
└── src
    ├── main
    │   ├── scala
    │   │   └── mypackage
    │   │       └── MyServlet.scala
    │   └── webapp
    │       ├── images
    │       │   └── logo.png
    │       ├── index.html
    │       └── styles
    │           └── style.css
    └── test
        └── scala
            ├── http.scala
            └── mypackage
                └── MyServletSuite.scala
```

A packaged WAR file looks something like this:

```
$ sbt "show package"
[info] /path/to/my-web-project/target/scala-3.1.0/my-web-project_3-0.1.0-SNAPSHOT.war

$ jar -tf target/scala-3.1.0/my-web-project_3-0.1.0-SNAPSHOT.war | LC_COLLATE=C sort
META-INF/MANIFEST.MF
WEB-INF/
WEB-INF/classes/
WEB-INF/classes/mypackage/
WEB-INF/classes/mypackage/Servlet.class
WEB-INF/classes/mypackage/Servlet.tasty
WEB-INF/lib/
WEB-INF/lib/scala-library-2.13.6.jar
WEB-INF/lib/scala3-library_3-3.1.0.jar
images/
images/logo.png
index.html
styles/
styles/style.css
```

Classes under *src/main/scala* are compiled and included in the WAR
file under *WEB-INF/classes*.

Dependencies are copied as JAR files into the *WEB-INF/lib/* directory.

Static assets (such as .html files, stylesheets, images, etc.) are
copied from *src/main/webapp* to to the root of the WAR file.

## Getting started from a template

```
$ sbt new https://gitlab.com/earldouglas/sbt-war.g8.git

name [My Web Project]: hello sbt-war

Template applied in ./hello-sbt-war

$ cd hello-sbt-war/
$ sbt
> warStart
```

```
$ curl localhost:8080/hello
<h1>Hello, world!</h1>
```

```
> warStop
```

## Getting started from scratch

Create a new empty project:

```
$ mkdir myproject
$ cd myproject
```

Set up