eslint-config-guestline

eslint-config-guestline

This package includes the shareable ESLint configuration used by Guestline Scripts.
Please refer to its documentation:

Usage with Guestline Scripts

The easiest way to use this configuration is with Guestline Scripts, which includes it by default.

You don’t need to install it separately.

Usage Outside of Guestline Scripts

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

First, install this package, ESLint and the necessary plugins.

npm install --save-dev eslint-config-guestline babel-eslint@^7.2.3 eslint@^4.1.1 eslint-plugin-flowtype@^2.34.1 eslint-plugin-import@^2.6.0 eslint-plugin-jsx-a11y@^5.1.1 eslint-plugin-react@^7.1.0

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

{
  "extends": "guestline"
}

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

Accessibility Checks

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

• accessible-emoji
• 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 file in the root of your project with this content:

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

However, if you are using Guestline Scripts, any additional rules will only be displayed in the IDE, but not in the browser or the terminal.