@locker/eslint-config-locker

@locker/eslint-config-locker

Locker ESLint configurations

Installation

$ yarn add --dev eslint @locker/eslint-config-locker

Usage

Add the appropriate configuration to the extends field in your configuration.

Example of .eslintrc:

{
    "extends": ["@locker/eslint-config-locker"]
}

For more details about configuration, please refer to the dedicated section in the ESLint documentation:
https://eslint.org/docs/user-guide/configuring#using-a-shareable-configuration-package

Configurations

This package exposes 3 configurations for Lightning Locker rules. Unless stated otherwise, each configuration assumes use of @locker/rollup-plugin in your build pipeline.

@locker/eslint-config-locker/base configuration

Goal: Detect foundational distortions of Lightning Locker.

@locker/eslint-config-locker/recommended configuration

Goal: Detect supplemental distortions of Lightning Locker.

@locker/eslint-config-locker/uncompiled configuration

Goal: Detect pitfalls of code NOT compiled with @locker/rollup-plugin.