sass:update-stylesheets

Full name:

nl.geodienstencentrum.maven:sass-maven-plugin:3.7.3-SNAPSHOT:update-stylesheets

Description:

Mojo that compiles Sass sources into CSS files using update_stylesheets.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: process-sources.

Optional Parameters

Name Type Since Description
<buildDirectory> File 2.0 Build directory for the plugin.
Default value is: ${project.build.directory}.
<destination> File 2.0 Where to put the compiled CSS files.
Default value is: ${project.build.directory}/${project.build.finalName}/css.
<excludes> String[] 2.0 Defines which of the included files in the source directories to exclude (none by default).
<failOnError> boolean 2.0 Fail the build if errors occur during compilation of sass/scss templates.
Default value is: true.
<gemPaths> String[] 2.0 Defines paths where jruby will look for gems. E.g. a maven build could download gems into ${project.build.directory}/rubygems and a gemPath pointed to this directory. Finally, individual gems can be loaded via the <gems> configuration.
Default value is: ${project.build.directory}/rubygems.
<gems> String[] 2.0 Defines gems to be loaded before Sass. This is useful to add gems with custom Sass functions or stylesheets. Gems that hook into Sass * are transparently added to Sass' load_path.
<includes> String[] 2.0 Defines files in the source directories to include. Defaults to: **&#x0002F;*.scss
<relativeOutputDirectory> String 2.0 Defines an additional path section when calculating the destination for the SCSS file. Allows, for example "/media/skins/universality/coal/scss/portal.scss" to end up at "/media/skins/universality/coal/portal.css" by specifying ".." NBThis location is relative to the source sassSourceDirectory
Default value is: ...
<resources> List 2.0 Sources for compilation with their destination directory containing Sass files. Allows for multiple resource sources and destinations. If specified it precludes the direct specification of sassSourceDirectory/relativeOutputDirectory/destination parameters. Example configuration: 
     <resources>
       <resource>
         <source>
             <directory>${basedir}/src/main/webapp</directory>
             <includes>
                 <include>**/*.scss</include>
             </includes>
         </source>
         <relativeOutputDirectory>..</relativeOutputDirectory>
         <destination>${project.build.directory}/${project.build.finalName}
             </destination>
       </resource>
     </resources>

<sassOptions> Map 2.0 Defines options for Sass::Plugin.options. See Sass options If the value is a string it must by quoted in the maven configuration: <cache_location>'/tmp/sass'</cache_location> If no options are set the default configuration set is used which is: 
<unix_newlines>true</unix_newlines>
<cache>true</cache>
<always_update>true</always_update>
<cache_location>${project.build.directory}/sass_cache</cache_location>
<style>:expanded</style>

<sassSourceDirectory> File 2.0 Directory containing Sass files, defaults to the Maven sources directory (${basedir}/src/main/sass).
Default value is: ${basedir}/src/main/sass.
User property is: sassSourceDirectory.
<skip> boolean 2.10 skip execution.
Default value is: false.
<useBourbon> boolean 2.11 Enable the use of Bourbon style library mixins.
Default value is: false.

Parameter Details

<buildDirectory>

Build directory for the plugin.
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • Default: ${project.build.directory}

<destination>

Where to put the compiled CSS files.
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}/css

<excludes>

Defines which of the included files in the source directories to exclude (none by default).
  • Type: java.lang.String[]
  • Since: 2.0
  • Required: No

<failOnError>

Fail the build if errors occur during compilation of sass/scss templates.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • Default: true

<gemPaths>

Defines paths where jruby will look for gems. E.g. a maven build could download gems into ${project.build.directory}/rubygems and a gemPath pointed to this directory. Finally, individual gems can be loaded via the <gems> configuration.
  • Type: java.lang.String[]
  • Since: 2.0
  • Required: No
  • Default: ${project.build.directory}/rubygems

<gems>

Defines gems to be loaded before Sass. This is useful to add gems with custom Sass functions or stylesheets. Gems that hook into Sass * are transparently added to Sass' load_path.
  • Type: java.lang.String[]
  • Since: 2.0
  • Required: No

<includes>

Defines files in the source directories to include. Defaults to: **&#x0002F;*.scss
  • Type: java.lang.String[]
  • Since: 2.0
  • Required: No

<relativeOutputDirectory>

Defines an additional path section when calculating the destination for the SCSS file. Allows, for example "/media/skins/universality/coal/scss/portal.scss" to end up at "/media/skins/universality/coal/portal.css" by specifying ".." NBThis location is relative to the source sassSourceDirectory
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Default: ..

<resources>

Sources for compilation with their destination directory containing Sass files. Allows for multiple resource sources and destinations. If specified it precludes the direct specification of sassSourceDirectory/relativeOutputDirectory/destination parameters. Example configuration: 
     <resources>
       <resource>
         <source>
             <directory>${basedir}/src/main/webapp</directory>
             <includes>
                 <include>**/*.scss</include>
             </includes>
         </source>
         <relativeOutputDirectory>..</relativeOutputDirectory>
         <destination>${project.build.directory}/${project.build.finalName}
             </destination>
       </resource>
     </resources>
  • Type: java.util.List
  • Since: 2.0
  • Required: No

<sassOptions>

Defines options for Sass::Plugin.options. See Sass options If the value is a string it must by quoted in the maven configuration: <cache_location>'/tmp/sass'</cache_location> If no options are set the default configuration set is used which is: 
<unix_newlines>true</unix_newlines>
<cache>true</cache>
<always_update>true</always_update>
<cache_location>${project.build.directory}/sass_cache</cache_location>
<style>:expanded</style>
  • Type: java.util.Map
  • Since: 2.0
  • Required: No

<sassSourceDirectory>

Directory containing Sass files, defaults to the Maven sources directory (${basedir}/src/main/sass).
  • Type: java.io.File
  • Since: 2.0
  • Required: No
  • User Property: sassSourceDirectory
  • Default: ${basedir}/src/main/sass

<skip>

skip execution.
  • Type: boolean
  • Since: 2.10
  • Required: No
  • Default: false

<useBourbon>

Enable the use of Bourbon style library mixins.
  • Type: boolean
  • Since: 2.11
  • Required: No
  • Default: false