Giter Club home page Giter Club logo

grunt-tabs4life's Introduction

App Logo grunt-tabs4life

Build Status Dependency Status devDependency Status NPM version

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

grunt-tabs4life's People

Contributors

chesleybrown avatar jurko-gospodnetic avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

grunt-tabs4life's Issues

Refactor bad coding style tests to test each separately

Currently all the bad coding style examples are squashed into a single test/files/bad/test_bad.js file and the test using it can not differentiate between specific parts of it being or not being considered invalid.

This should be refactored so each problematic coding style is tested separately.

upgrade dependency versions

Some dependency versions that could be upgraded:

  • lodash 3.8.0
  • grunt-jscs 1.8.0
  • grunt-lintspaces 0.6.2
  • grunt-contrib-jshint 0.11.2

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.