grunt-mt-style-guide

grunt-mt-style-guide

Medtelligent _static templating Grunt task

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-mt-style-guide --save

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

grunt.loadNpmTasks('grunt-mt-style-guide');

The "mt_style_guide" task

Overview

Scrapes comments from specified files, then stores said comments in a JSON file. Currently, that JSON file is stored, relative to the Gruntfile, at data/components.json.

Comments are scrapable from the following file types:

• .html
• .js
• .scss
• .less
• .hbs

Usage Examples

grunt.initConfig({
    mt_style_guide: {
        main: {
            files: [
                {
                    expand: true,
                    cwd: 'src/app/assets/scss',
                    src: [
                        '**/*.scss'
                    ]
                }
            ]
        }
    }
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)