eslint-plugin-object-pattern-newline

eslint-plugin-object-pattern-newline

ESLint plugin to enforce newlines in ES6 object pattern.

There is only one rule in this plugin which will report when there are more than 4 values in a line by default.

Installation

$ npm install eslint-plugin-object-pattern-newline --save-dev

Or

$ yarn add eslint-plugin-object-pattern-newline -D

Usage

Add object-newline to the plugins section of your .eslintrc configuration file.

{
    "plugins": [
        "object-newline"
    ]
}

Then add the rule in the rules section.

{
    "rules": {
        "object-newline/enforce": "error"
    }
}

Options

The first and most readable way is to use an object which allows you to specify any of the available options, leaving everything that's not specified as the default.

{
    "rules": {
        "max-len": ["error", 100],
        "object-newline/enforce": [
            "error",
            {
                "items": 2,
                "max-len": 100
            }
        ]
    }
}

items [number] (default: 4)

Specifies the maximum number of items before the plugin requires breaking items to multiple lines.

max-len [number] (default: Infinity)

Specifies the maximum length for source code lines in your project. This allows the plugin to prevent quick fixes that would cause your code to violate this limit from being applied. The rule will also automatically split lines for you should they exceed the limit.

Testing

Tests can be run via npm run test, make sure these pass after every change. Be sure to add tests for new features.