eslint-config-uukit-app v0.0.2

eslint-config-uukit-app

This package includes the shareable ESLint configuration.

Usage

If you want to use this ESLint configuration in a project not built with uukit App, you can install it with the following steps.

First, install this package and ESLint.

npm install --save-dev eslint-config-uukit-app eslint@^8.0.0

Then create a file named .eslintrc.json with following contents in the root folder of your project:

{
  "extends": "uukit-app"
}

That's it! You can override the settings from eslint-config-uukit-app by editing the .eslintrc.json file. Learn more about configuring ESLint on the ESLint website.

Jest rules

This config also ships with optional Jest rules for ESLint (based on eslint-plugin-jest).

You can enable these rules by adding the Jest config to the extends array in your ESLint config.

{
  "extends": ["uukit-app", "uukit-app/jest"]
}

Accessibility Checks

The following rules from the eslint-plugin-jsx-a11y plugin are activated:

• alt-text
• anchor-has-content
• aria-activedescendant-has-tabindex
• aria-props
• aria-proptypes
• aria-role
• aria-unsupported-elements
• heading-has-content
• href-no-hash
• iframe-has-title
• img-redundant-alt
• no-access-key
• no-distracting-elements
• no-redundant-roles
• role-has-required-aria-props
• role-supports-aria-props
• scope

If you want to enable even more accessibility rules, you can create an .eslintrc.json file in the root of your project with this content:

{
  "extends": ["react-app", "plugin:jsx-a11y/recommended"],
  "plugins": ["jsx-a11y"]
}

However, if you are using Create React App and have not ejected, any additional rules will only be displayed in the IDE integrations, but not in the browser or the terminal.