@locker/eslint-plugin-locker

@locker/eslint-plugin-locker

Locker ESLint rules

Installation

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

Usage

Add @locker/eslint-plugin-locker to the plugins section of your configuration. Then configure the desired rules in the rules section.

Example of .eslintrc:

{
    "plugins": ["@locker/eslint-plugin-locker"],
    "rules": {
        "@locker/locker/blocked-element-properties": "error",
        "@locker/locker/no-document-domain-assignment": "error",
        "@locker/locker/null-window-top": "error"
    }
}

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

Configurations

To choose configuration settings, install the @locker/eslint-config-locker sharable configuration package.

Rules

Locker

Rule ID	Description	Fixable Using
@locker/locker/blocked-document-properties	disallow blocked Document properties
@locker/locker/blocked-element-properties	disallow blocked Element properties
@locker/locker/blocked-html-element-properties	disallow blocked HTMLElement properties
@locker/locker/blocked-html-iframe-element-properties	disallow blocked HTMLIframeElement properties
@locker/locker/empty-window-location	window.location is empty	@locker/rollup-plugin
@locker/locker/no-async-await	disallow async await syntax usage	@locker/rollup-plugin
@locker/locker/no-document-domain-assignment	disallow document.domain assignment
@locker/locker/no-dynamic-import	disallow dynamic import	@locker/rollup-plugin
@locker/locker/no-import-platform-resource-loader	disallow import or export from 'lightning/platformResourceLoader'
@locker/locker/null-document-location	document.location is 'null'	@locker/rollup-plugin
@locker/locker/null-shadow-root-host	shadowRoot.host is 'null'
@locker/locker/null-window-top	window.top is 'null'	--fix or @locker/rollup-plugin