kusotenpa / eslint-plugin-destructuring-newline

ESLint Plugin to enforce placing destructuring properties on separate lines.

eslint-plugin-destructuring-newline

Enforce placing destructuring properties on separate lines.

Installation

$ npm install --save-dev eslint eslint-plugin-destructuring-newline

Rules

🔧: Fixable

Rule	🔧
destructuring-newline/object-property-newline	🔧

Usage

In your .eslintrc

{
  "plugins": [
    "destructuring-newline"
  ],
  "rules": {
    "object-curly-newline": 2, // recommended
    "destructuring-newline/object-property-newline": 2
  }
}

Rule Details

// bad
const { a, b } = obj

// good
const { a } = obj
const {
    a,
    b,
} = obj

Option

maxProperties

Limit the number of properties per line.

// "destructuring-newline/object-property-newline": [2, { maxProperties: 3 }]

// bad
const {
  a,
  b,
  c,
  d,
} = obj

// good
const {
  a, b, c,
  d,
} = obj

const { a, b } = obj

eslint-plugin-destructuring-newline's Issues

Additional configuration: allow maiximum items, or check max-len?

Hi there!

Would it be possible to add an extra option to config, e.g. enforcing multiline if there are more than N items?
Or ideally check the max-len rule and enforce this one only if line exceeds max-len?

Thank you!

Nested destructuring not supported?

Thanks for making this plugin. It would be amazing if it supported nested destructuring. So

const a = { b: { c: 1 } };
const {
  // currently complains about this line v
  b: {
    c,
  },
} = a;
console.log(c);