https://github.com/chesleybrown/grunt-tabs4life

Grunt task for enforcing a very opinionated coding style.
https://github.com/chesleybrown/grunt-tabs4life

grunt-task

Last synced: 15 days ago
JSON representation

Grunt task for enforcing a very opinionated coding style.

• Host: GitHub
• URL: https://github.com/chesleybrown/grunt-tabs4life
• Owner: chesleybrown
• License: mit
• Created: 2015-03-13T03:55:23.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-02-17T14:26:18.000Z (over 8 years ago)
• Last Synced: 2024-10-03T07:36:37.328Z (about 2 months ago)
• Topics: grunt-task
• Language: JavaScript
• Size: 194 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![App Logo](https://raw.githubusercontent.com/chesleybrown/grunt-tabs4life/master/media/logo-small.png) grunt-tabs4life

=========================

[![Build Status](https://travis-ci.org/chesleybrown/grunt-tabs4life.svg?branch=master)](https://travis-ci.org/chesleybrown/grunt-tabs4life)

[![Dependency Status](https://david-dm.org/chesleybrown/grunt-tabs4life.svg)](https://david-dm.org/chesleybrown/grunt-tabs4life)

[![devDependency Status](https://david-dm.org/chesleybrown/grunt-tabs4life/dev-status.svg)](https://david-dm.org/chesleybrown/grunt-tabs4life#info=devDependencies)

[![NPM version](https://badge.fury.io/js/grunt-tabs4life.svg)](http://badge.fury.io/js/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](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell

npm install grunt-tabs4life --save-dev

```

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

```js

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](http://gruntjs.com/configuring-tasks) guide.

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

```js

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](https://github.com/jscs-dev/grunt-jscs).

#### jshint

Pass this whatever you would pass for options for [grunt-contrib-jshint](https://github.com/gruntjs/grunt-contrib-jshint).

#### lintspaces

Pass this whatever you would pass for options for [grunt-lintspaces](https://github.com/schorfES/grunt-lintspaces).

```js

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](https://twitter.com/Chesley)