Package Exports

theme-builder

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (theme-builder) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Theme builder

Build theme's variables form YAML to consumable format (like JS or SCSS)

Installing

npm install theme-builder

How to use

const themeBuilder = require('theme-builder');
const themeYaml = fs.readFileSync(pathToYamlFile);
const themeScss = themeBuilder(themeYaml, 'scss');

Current formats

js - just a plain javascript object
scss - SCSS variables

How it works (example)

You have index.yaml and you want to convert it to SCSS:

generic:
  color:
    accent: &accent '#1fcff6'
button:
  color:
    bg: *accent

So, you can call themeBuilder function like this:

const themeYaml = fs.readFileSync('index.yaml');
themeBuilder(themeYaml, 'scss', {prefix: 'ui'});

and as result you will get string with 2 variables:

$ui-generic-color-accent: #1fcff6;
$ui-button-color-bg: #1fcff6;

You can save the output to .scss file and use while writing your styles.

API (Types)

function themeBuilder(
  // Path to main theme YAML file
  themeYaml: string,

  // Output format
  format: string,

  // Optional config
  config?: Config
): any

type Config = {
  // Processors for additional formats
  processors?: {[name: string]: Processor},

  // Default theme YAML filepath, will be used as base to extend main YAML
  defaultThemeYaml?: string,

  // Output unit prefixes, eg. SCSS variables names prefixes
  prefix?: string,
}

type Processor = {
  compile(obj: object): any
}