grunt-tabs4life

Grunt task for enforcing a very opinionated coding style.

Getting Started

This plugin requires Grunt ~0.4.2

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-tabs4life --save-dev

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

grunt.loadNpmTasks('grunt-tabs4life');

tabs4life task

Run this task with the grunt tabs4life command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Typically you'll just want to provide files in the standard Grunt way.

tabs4life: {
	src: 'path/to/files/*.js'
}

Options

This is basically just a wrapper around existing grunt tasks, but passes the opinionated options as their defaults. However you are free to override any of these defaults. One important note is that jscs and jshint will ONLY be used on .js files. lintspaces will be run against all files provided.

jscs

Pass this whatever you would pass for options for grunt-jscs.

jshint

Pass this whatever you would pass for options for grunt-contrib-jshint.

lintspaces

Pass this whatever you would pass for options for grunt-lintspaces.

tabs4life: {
	options: {
		jscs: {
			disallowTrailingWhitespace: true
		},
		jshint: {
			quotmark: 'double'
		},
		lintspaces: {
			trailingspaces: true
		}
	}
	src: 'path/to/files/*.js'
}

Running Tests

To execute all the tests, just run:

npm test

You can also just run the available grunt commands. The default being to check the code styling of the project itself.

grunt

Contact

You can follow me on twitter at @Chesley