SassyExport

SassyExport is a lightweight Compass extension that allows you to export an encoded Sass map into an external JSON file. Use it anyway you like.

Installation

gem install SassyExport
Add require "SassyExport" to your config.rb
Import into your stylesheet with @import "SassyExport";

Documentation

Setup

Our file structure,

root

Sass,

// ./sass/style.scss

@import "SassyExport";

$map: (
    hello: world,
);

// SassyExport : convert passed map to json and write to path/to/filename.json
// ----------------------------------------------------------------------------------------------------
// @param $path [string] : directory path and filename, valid extensions: [json | js]
// @param $map [map] : map to convert to json
// @param $pretty [bool] : pretty print json
// @param $debug [bool] : print debug string with path
// ----------------------------------------------------------------------------------------------------
// @return $string | write json to path

@include SassyExport("/json/hello.json", $map, true);

Result

New JSON file is created at ./json/hello.json. As you can see, $path is relative to where your config.rb is located. Simply calling @include SassyExport("/hello.json", $map) will write to your directory root.

{
    "hello": "world"
}

Breakdown

The SassyExport() mixin takes a <directory>/<filename>.<ext> $path and a Sass $map as arguments. You can export straight to a Javascript object by using the extension .js instead of .json. There are also optional arguments: $pretty which defaults to false, but will print pretty JSON (nicely indented) if set to true; and $debug which will print debug information if set to true.

It converts the $map into either a JSON map or Javascript object through Ruby, then creates a new directory/file (or updates an existing directory/file), and writes the contents of the JSON string to it. Contributions are welcome. If you believe that you could improve the small amount of code here, feel free to.

Enjoy.

Also Check Out

SassyJSON