<!-- The FreeBSD Documentation License Copyright 2017-2019 Dominik Winter. All rights reserved. Redistribution and use in source (Markdown, Fossil wiki) and 'compiled' forms (HTML, PDF, PostScript, RTF and so forth) with or without modification, are permitted provided that the following conditions are met: Redistributions of source code (Markdown) must retain the above copyright notice, this list of conditions and the following disclaimer as the first lines of this file unmodified. Redistributions in compiled form (transformed to other DTDs, converted to PDF, PostScript, RTF and other formats) must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS DOCUMENTATION IS PROVIDED BY THE FREEBSD DOCUMENTATION PROJECT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FREEBSD DOCUMENTATION PROJECT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -->

Sass plugin for sbt

This sbt-web plugin provides a pure-Java compiler for Sass styles.

Installation

Add the plugin to project/plugins.sbt or project/sbt-puresass.sbt:

addSbtPlugin("com.chiselapp.twenstar" % "sbt-puresass" % "1.0.2")

It is cross-published for sbt versions 0.13.x and 1.2.x.

Where to place the Sass styles

The plugin expects the sbt-web file directory layout and looks for the Sass styles below the assets folder, e.g. in src/main/assets/stylesheets for production styles.

Enable the plugin

It is not necessary to explicitly enable the plugin. It is a source generator plugin and enables itself through sbt-web:

lazy val root = (project in file(".")).settings(
    // some settings ...
).enablePlugins(SbtWeb, /* further plugins */)

Detailed configuration

Please refer to the configuration guide.

Differences to other Sass plugins

There are two other published Sass plugins:

• sbt-sassify relies on libsass
• sbt-sass relies on the Sass gem and requires the user to install it manually

sbt-puresass plugin doesn't use a platform-specific binary (like sbt-sassify), nor requires an external program (like sbt-sass). It runs in pure Java.

Reporting issues

Please report issues using the Tickets menu point.

Development information

Please refer to the contributing guide.

License of the source code

Copyright © 2017–2019 Dominik Winter

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

License of the wiki pages

Copyright © 2017–2019 Dominik Winter

Licensed under The FreeBSD Documentation License.