eslint-plugin-sayari

Custom rules built for Sayari Graph

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install @sayari/eslint-plugin:

$ npm install @sayari/eslint-plugin --save-dev

Usage

Option 1

Add the sayari plugin recommended config to the extends section of your .eslintrc configuration file.

{
  "extends": ["plugin:@sayari/recommended"]
}

Option 2

Add sayari to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["@sayari"]
}

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

{
  "rules": {
    "@sayari/rule-name": 2
  }
}

Supported Rules

strict-mui-imports:

• prevents styles imported from @material-ui to come from @material-ui/core/styles to help the import tranformer to minimize final bundle

no-unwrapped-jsx-text:

• requires that when JSX text shares a common parent with other elements, the text be wrapped in a <span> tag
• this prevents issues with this React bug when conflicted with things like google translate

polyfill-resize-observer:

• imorts the polyfill build from react-resize-detector to avoid browser compatability conflicts when accessing the ResizeObserver API