htmlhero / grunt-init-block

grunt-init-block

Generates css file structure according to classes used in HTML. Relies on BEM naming for classes.

Getting Started

This plugin requires Grunt ~0.4.1

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-init-block --save-dev

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

grunt.loadNpmTasks('grunt-init-block');

The "initBlock" task

Overview

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

grunt.initConfig({
	initBlock: {
		options: {
			// Task-specific options go here.
		},
		your_target: {
			// Target-specific file lists and/or options go here.
		}
	}
})

Options

options.attr

Type: String Default value: 'init-block'

Attribute that contains the name of the target file. Example: <div class="block" init-block="blocks.css"> If there is no filename, the text will be copied to the clipboard.

options.element

Type: String Default value: '__'

Element class name separator in your HTML. Example: <div class="block__element">

options.modifier

Type: String Default value: '_'

Modifier class name separator in your HTML. Example: <div class="block _modifier">

options.longModifier

Type: Boolean Default value: false

Use a long modifier. Example: <div class="block block_modifier">

options.preprocessor

Type: Boolean Default value: false

Use stylus style for output without braces.

options.indent

Type: String Default value: '\t'

Output line indent style. Use spaces or tabs.

Usage Example

Describe the task in your Gruntfile.js:

grunt.initConfig({
	initBlock: {
		options: {},
		all: {
			src: ['test/*.html'],
            dest: 'test/'
		}
	}
})

write html:

<div class="post _modifier" init-block="blocks.css">
	<h2 class="post__title"></h2>
	<div class="post__content"></div>
	<div class="post__comments"></div>
</div>

then run grunt initBlock and you will get in blocks.css:

.post {

}
	.post__title {

	}
	.post__content {

	}
	.post__comments {

	}
.post._modifier {

}

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.