https://github.com/willklein/eslint-plugin-whitespace

ESLint plugin for whitespace
https://github.com/willklein/eslint-plugin-whitespace

Last synced: about 1 year ago
JSON representation

ESLint plugin for whitespace

• Host: GitHub
• URL: https://github.com/willklein/eslint-plugin-whitespace
• Owner: willklein
• License: mit
• Created: 2015-06-12T03:17:22.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-07-18T05:57:45.000Z (almost 11 years ago)
• Last Synced: 2025-03-18T02:28:22.198Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 137 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# eslint-plugin-whitespace

> ESLint plugin for whitespace

## Usage

This plugin requires ESLint to also be installed. With both ESLint and this plugin installed, you will need to enable the plugin and configure its rules.

### Installation

Install ESLint if you have not already:

    npm install eslint

Install the plugin:

    npm install eslint-plugin-whitespace

### Configuration

Configure the plugin and its rules in your `.eslintrc` file or your shareable config.

Sample `.eslintrc`:

    {

      "plugins": [

        // other plugins would go here

    

        "whitespace"

      ],

    

      rules: {

        // other rules here

    

        // whitespace rules

        whitespace/no-tabs: 2

      }

    }

Configuring rules to `1` will set them to warn and configuring them to `2` will set them to error.

## List of supported rules

* no-tabs: Disallow tab characters

While there is currently only one rule, other whitespace rules are planned for enforcing additional whitespace conventions.

## Under Development

This plugin is under active development and its API may change at any time.

## License

[MIT](http://mit-license.org/) © [Will Klein](http://willkle.in)