:cd: Installation

npm install --save-dev eslint eslint-plugin-linestyle

Requirements

• ESLint v7.0.0 and above
• Node.js v12.22.x, v14.17.x, v16.x and above

:book: Usage

Add lineStyle to the plugins section of your .eslintrc configuration file (you can omit the eslint-plugin- prefix) and either use one of the two configurations available (recommended or all) or configure the rules you want:

// .eslintrc.js
module.exports = {
    "plugins": [
        "linestyle"
    ],
    "extends": [
         // add more generic rulesets here, such as:
         // 'eslint:recommended',
        "plugin:linestyle/recommended"
    ]
}

The standard configuration

The plugin:lineStyle/standard config enables a subset of the rules and superset of plugin:lineStyle/recommended config that apply a subjective style.

// .eslintrc.js
module.exports = {
    "plugins": [
        "linestyle"
    ],
    "extends": [
        "plugin:linestyle/no-line-style"
    ]
}

Advanced Configuration

Override/add specific rules configurations. See also: http://eslint.org/docs/user-guide/configuring.

// .eslintrc.js
module.exports = {
    "plugins": [
        "linestyle"
    ],
    "rules": {
        // Override/add rules settings here, such as:
        "linestyle/no-line-style": "error"
    }
}

:lock: License

See the LICENSE file for license rights and limitations (MIT).