eslint-plugin-wyze's Introduction

eslint-plugin-wyze

My personal ESLint rules.

Installation

There is a peerDependencies on eslint.

$ npm i --save-dev eslint-plugin-wyze eslint

Usage

package.json

{
  // ...
  "eslintConfig": {
    "plugins": [
      "wyze"
    ]
  }
}

.eslintrc

{
  "plugins": [
    "wyze"
  ]
}

Supported Rules

func-call-arg-spacing: Enforces spacing inside function call arguments. (fixable)
func-params-spacing: Enforces spacing inside function parameters. (fixable)
max-file-length: Keep files to a maximum length.
newline-after-export: Ensures export statements are followed by a newline. (fixable)
sort-destructuring-keys: Ensures keys are sorted for object destructuring.
sort-imports: Sorts imports by named and default. (fixable)
space-around-conditional: Always put spacing around your conditional expressions. (fixable)

Recommended Config

We support a recommended config for the rules.

Enable

{
  "extends": "plugin:wyze/recommended",
  "plugins": [
    "wyze"
  ]
}

Rules

{
  "rules": {
    "wyze/func-call-arg-spacing": "error",
    "wyze/func-params-spacing": "error",
    "wyze/max-file-length": "error",
    "wyze/newline-after-export": "error",
    "wyze/sort-destructuring-keys": "error",
    "wyze/sort-imports": "error",
    "wyze/space-around-conditional": "error"
  }
}

Change Log

Full Change Log

v3.3.1 (2017-06-27)

[9f0504d104] - Upgrade dependencies (Neil Kistner)
[22bea1f744] - Ensure rest property is last in sort-destructuring-keys rule (Neil Kistner)
[3f04cd2c66] - Fix bug in sort-destructuring-keys when 10+ keys are used (Neil Kistner)