grunt-pattern-lab-json

create pattern lab atomic design json automatically

Getting Started

This plugin requires Grunt ~0.4.5

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-pattern-lab-json --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-pattern-lab-json');

The "pattern_lab_json" task

Overview

In your project's Gruntfile, add a section named pattern_lab_json to the data object passed into grunt.initConfig().

grunt.initConfig({
  pattern_lab_json: {
    default_options: {
      pattern_dirs: ['test/atoms','test/molecules','test/organisms','test/templates','test/pages'],
      "pattern_path": "test/"
    }
  },
});

Options

default_options.pattern_dirs

Type: Array

A list of patters directory to crate JSON.

default_options.pattern_path

Type: String

Path of patterns directory.

Usage Examples

Need to configure before run.

grunt.initConfig({
  pattern_lab_json: {
    default_options: {
      pattern_dirs: ['test/atoms','test/molecules','test/organisms','test/templates','test/pages'],
      "pattern_path": "test/"
    }
  },
});