generator-mocha-broccoli v1.0.4

SASS Broccoli Mocha Generator

Note: this is the Mocha version of the original Qunit version. Not in NPM yet.

This Yeoman generator will create a simple Broccoli project that comes setup for web development with SASS, ES6 modules (using Babel transpiling) and Mocha. It also will install Yoga Sass, Font Awesome, and Normalize CSS. Just take a look at the src and tests directory.

Installing the Generator

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

Creating Projects

To create a project with this generator run:

yo qunit-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 run start

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

Running test

We use Mocha for running tests, just run them with this command:

npm run test

The command gets the tests from the tests directory and converts them into ES6 so mocha can use it.

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