@lite-v3/eslint-plugin

eslint-plugin-loadable-component

ESLint rules for tokopedia web services.

Installation

You'll first need to install ESLint:

pnpm add eslint --save-dev

Next, install eslint-plugin-tokopedia-lite:

pnpm add eslint-plugin-tokopedia-lite --save-dev

Usage

Note: This plugin doesn't have "recommended" rule set at the moment. We are currently still considering of the right rules to be the recommended default set. Please make sure to enable rules based on your needs.

To get started, add tokopedia-lite to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["tokopedia-lite"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "tokopedia-lite/no-workspace-url-deps": "error",
    "tokopedia-lite/no-window-checking": "warn",
    "tokopedia-lite/no-var-expression-dynamic-import": "error"
  }
}

Rules

Name	Type	Docs
no-window-checking	Possible Error	Link
no-var-expression-dynamic-import	Possible Error	Link
no-invalid-loadable-specifier	Possible Error	Link
no-empty-leading-comment-dynamic-import	Best Practice	Link
jest-no-identical-title	Best Practice	TBD
jest-no-duplicate-hooks	Best Practice	Link
json-no-pluggables	Possible Error	Link
json-no-restricted-imports	Possible Error	Link
json-no-dependencies	Possible Error	Link
wpe-lite-theme/ban-hex-colors	Possible Error	Link

Disabling Rule

You can disable certain rule by using ESLint directive syntax (marked with #) to hint ESLint to disable in specific line or entire file. You can find a list of ESLint directives here.

# eslint-disable-next-line no-window-checking
if (window) {
    ...
}