generator-sass-broccoli v4.0.1

SASS Broccoli Yeoman Generator

This Yeoman generator will create a simple Broccoli project that comes setup for web development with SASS. It also will install Yoga Sass, Font Awesome, and Normalize CSS.

Installing the Generator

npm install -g broccoli-cli yo generator-sass-broccoli

Creating Projects

To create a project with this generator run:

yo sass-broccoli

This will ask you for your project name, and a few details to get up and started.

Running the Development Server

Once the project has been created, move into the directory and then run:

npm start

The Brocfile.js injects live reload into HTML files in the public directory. This command is backed by broccoli-lr which will fire a reload whenever Broccoli rebuilds any trees.

Building the Project

To build the project into a final production build, run:

npm run build

This will build the project into a dist directory that can be uploaded to services such as Firebase, Surge, or AWS.

Lining SASS

This project comes with SASS Lint support.

To run SASS lint, run the command:

npm run lint

The rules installed beyond the SASS Lint defaults:

• Class Name Format: BEM
• No IDs
• No Important
• Hex Notation: Lowercase
• Indentation: 2 Spaces
• Property Sort Order: SMACSS
  • Box
  • Border
  • Background
  • Text
  • Other