https://github.com/sbt/sbt-concat

sbt-web plugin for concatenating web assets
https://github.com/sbt/sbt-concat

Last synced: 2 months ago
JSON representation

sbt-web plugin for concatenating web assets

• Host: GitHub
• URL: https://github.com/sbt/sbt-concat
• Owner: sbt
• License: mit
• Created: 2014-07-07T14:41:55.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2024-10-16T09:42:58.000Z (3 months ago)
• Last Synced: 2024-10-18T05:51:48.864Z (3 months ago)
• Language: Scala
• Size: 80.1 KB
• Stars: 8
• Watchers: 10
• Forks: 20
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-sbt-plugins - sbt-concat

README

        
sbt-concat

==========

[![Build Status](https://github.com/sbt/sbt-concat/actions/workflows/build-test.yml/badge.svg)](https://github.com/sbt/sbt-concat/actions/workflows/build-test.yml)

[sbt-web] plugin for concatenating files together, using the sbt-web asset pipeline.

Plugin

======

Add the plugin to your `project/plugins.sbt`:

```scala

addSbtPlugin("com.github.sbt" % "sbt-concat" % "1.0.0")

```

Enable the [sbt-web] plugin for your project:

```scala

lazy val root = (project in file(".")).enablePlugins(SbtWeb)

```

Add the `concat` task to your asset pipeline in your `build.sbt`:

```scala

pipelineStages := Seq(concat)

```

Configuration options

=====================

### Specifying concat groups

Below is an example of specifying concat groups within your `build.sbt` file. You can use `PathFinder` objects or a

`Seq[String]` to specify the files to concatenate together.

```scala

Concat.groups := Seq(

  "style-group.css" -> group(Seq("css/style1.css", "css/style2.css")),

  "script-group.js" -> group(Seq("js/script1.js", "js/script2.js")),

  "style-group2.css" -> group((sourceDirectory.value / "assets" / "style") * "*.css")

)

```

Note that with a `PathFinder`, you will need to take care to ensure that the files it selects will be concatenated in

the order that you desire.

To match entries in `Seq[String]` in group `PathMapping` is used. Only relative paths up to one level deep are guaranteed match.

This will produce three files with concatenated contents:

`style-group.css`

```css

/** css/style1.css **/

body { color: #000; }

/** css/style2.css **/

#main { background-color: #fff; }

```

`script-group.js`

```javascript

/** js/script1.js **/

function onDomReady(){ ... }

/** js/script2.js **/

$(onDomReady);

```

`style-group2.css`

```css

/** assets/style/main.css **/

body { font-weight: bold; }

/** assets/style/base.css **/

section { font-size: 15em; }

```

These will reside under the asset build directory in the base target directory by default. You can change the name

of this directory using the `Concat.parentDir` `SettingKey`.

License

=======

This code is licensed under the [MIT License].

[sbt-web]:https://github.com/sbt/sbt-web

[MIT License]:http://opensource.org/licenses/MIT