Cartridge Sass

If you are using this module on windows, it is recommend to use the cartridge-sass-legacy module instead to maximise comptability.

Sass expansion pack for Cartridge

To use this module, you will need cartridge-cli installed and have a cartridge project setup.

npm install cartridge-sass --save-dev

npm uninstall cartridge-sass --save-dev

This module adds the following to a project:

• Sass compilation using gulp-sass
• Source map generation using gulp-sourcemaps (local only)
• Sass import file creation using gulp-sass-generate-contents
• CSS manipulation using gulp-postcss
• Automatic CSS vender prefixes using autoprefixer
• Media query merging using css-mqpacker
• CSS minification using cssnano (prod only)
• Conversion of pixels to rems using postcss-pxtorem

Config

Once installed, the config file task.sass.js is created and stored in the _config directory in the root of your cartridge project.

Usage

The FrontEnd CSS guidelines are a good place to start when beginning your project

Development

Please follow the instructions within the base module development guide when working on this project.

Branches

New work should be commited to the develop branch and then merged in to master once complete. Documentation changes can be performed on the master branch.

Semantic Release

In addition to the base module guide, this project uses Semantic release to manage releases to NPM. When making changes and following the required commit message format releases are managed for you.

When the commit passes tests on Travis a new version will be published based on the content of the commits since the last release. For more information please see the Semantic release project on GitHub