grunt-wslint

grunt-mountebank

Linting for whitespace, to ensure consistency throughout the codebase and to make diffing easier.

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

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

grunt.loadNpmTasks('grunt-wslint');

Grunt Configuration

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

grunt.initConfig({
  wslint: {
    all: [
      '**/*',
      '!node_modules/**/*',
      '!.git/**/*',
      '!.DS_Store',
      '!*.iml'
    ],
    options: {
      noTrailingWhitespace: true,
      noTabs: true,
      trailingNewline: true,
      noMultipleTrailingNewlines: true
    }
  },
});

The files source represented in all use the standard Grunt globbing patterns. The example above shows including all files except the ones listed.

All options are represented in the example above. Leave an option off (or set it to false) to avoid executing that option. The options are as follows:

• noTrailingWhitespace - Disallow lines that end in whitespace
• noTabs - Disallow tabs
• trailingNewline - Require at least one trailing newline at the end of the file
• noMultipleTrailingNewlines - Disallow two or more trailing newlines at the end of the file