eslint-config-dulcet-app v2.0.0
eslint-config-dulcet-app
This package includes the shareable ESLint configuration used by Create Dulcet App. Please refer to its documentation:
- Getting Started – How to create a new app.
- User Guide – How to develop apps bootstrapped with Create Dulcet App.
Usage in Create Dulcet App Projects
The easiest way to use this configuration is with Create Dulcet App, which includes it by default.
You don’t need to install it separately in Create Dulcet App projects.
Usage Outside of Create Dulcet App
If you want to use this ESLint configuration in a project not built with Create Dulcet App, you can install it with following steps.
First, install this package, ESLint and the necessary plugins.
npm install --save-dev eslint-config-dulcet-app babel-eslint@7.2.3 eslint@3.19.0 eslint-plugin-flowtype@2.33.0 eslint-plugin-import@2.2.0 eslint-plugin-jsx-a11y@5.0.1 eslint-plugin-dulcet@7.0.1
Then create a file named .eslintrc
with following contents in the root folder of your project:
{
"extends": "dulcet-app"
}
That's it! You can override the settings from eslint-config-dulcet-app
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": ["dulcet-app", "plugin:jsx-a11y/recommended"],
"plugins": ["jsx-a11y"]
}
However, if you are using Create Dulcet App and have not ejected, any additional rules will only be displayed in the IDE integrations, but not in the browser or the terminal.
2 years ago