Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.03 KB

README.md

File metadata and controls

59 lines (40 loc) · 2.03 KB

eslint-plugin-varspacing

Code Climate Issue Count Build status Build Status npm version

This plugin aims to implement a eslint rule like object-spacing, but for variables.

Installation

Install ESLint and this plugin globally:

npm install -g eslint eslint-plugin-varspacing

If you'd like to install ESLint locally, this plugin must be installed locally, too.

Configuration

This plugin must be added to the plugins section in the .eslintrc:

{
  "plugins": [
    "varspacing"
  ]
}

Use rules

This plugin contains one rule only, the var-spacing rule:

{
  "extends": "plugin:varspacing/recommended"
}

Available rules

Use with nix as package manager

It's possible to use this module with the nix package manager based on node2nix. A shell with a node instance and all loaded npm dependencies can be opened using the following command:

nix-shell -A shell

License

This module is published under MIT license. Please refer to the LICENSE file in the package root.