April 7, 2015
  • All
  • Ionic

Fixing a Broken SASS Build Stream

Mike Hartington

Director of Developer Relation...

Customizing your Ionic app with SASS can easily change its look and feel, but it can also create some problems. One particular problem can be syntax issues breaking your build stream. In this article, we’ll look at a quick and easy fix for this problem.

Let’s Break Things

First, let’s create a project with SASS already set up for us.

$ ionic start myApp --sass
$ cd myApp

From here, let’s up open up the project in our editor and then start our live reload server. With the server running, we can start to edit our ionic.app.scss file and make any changes we want, but for our example, we’re going to break things. We’ll copy the $stable variable and change its value.

To customize the look and feel of Ionic, you can override the variables
in Ionic's _variables.scss file.

For example, you might change some of the default colors:

$light:                           #fff !default;
$stable:                          #f8f8f8 !default;
$positive:                        #387ef5 !default;
$calm:                            #11c1f3 !default;
$balanced:                        #33cd5f !default;
$energized:                       #ffc900 !default;
$assertive:                       #ef473a !default;
$royal:                           #886aea !default;
$dark:                            #444 !default;

$stable:                          #34495e !default
// The path for our Ionicons font files, relative to the built CSS in www/css
$ionicons-font-path: "../lib/ionic/fonts" !default;

// Include all of Ionic
@import "www/lib/ionic/scss/ionic";

We’ve also forgotten to add a semicolon at the end of the variable, which will cause a syntax error and print out this error in our console.

ionic $ [16:57:36] Using gulpfile ~/myApp/gulpfile.js
[16:57:36] Starting 'sass'...
[16:57:36] Starting 'watch'...
[16:57:36] Finished 'watch' after 6.05 ms

      throw er; // Unhandled stream error in pipe.
Error: top-level variable binding must be terminated by ';'

So let’s go back and add that semicolon. Once we have, we can save the file and expect to compile the Sass, but in this case, it won’t compile. The syntax error will completely break the gulp build stream. This can be incredibly problematic and just plain annoying when developing your app. Thankfully, it’s easy to fix.

Can we fix it? Yes, we can!

To fix the problem, we can open up our gulpfile.js and pass in an option to our SASS task.

gulp.task('sass', function(done) {
    .pipe(sass({errLogToConsole: true}))
      keepSpecialComments: 0
    .pipe(rename({ extname: '.min.css' }))
    .on('end', done);

Adding {errLogToConsole: true} to the SASS method will allow us to log out any errors to our console and keep our build stream from breaking. Now, we can continue working with our SASS files, be notified of any syntax errors, and keep our live reload server from breaking.

Gulp-SASS Docs


Gulp Docs

Mike Hartington

Director of Developer Relation...