eslint-config-bod

This package includes the shareable ESLint configuration used by Bod CLI, original forked from Create React App.

Please refer to its documentation:

• Getting Started: How to create a new app.
• User Guide: How to develop apps bootstrapped with Create React App.

Usage in Create React App Projects

The easiest way to use this configuration is with Create React App, which includes it by default.

You don’t need to install it separately in Create React App projects.

Usage Outside of Create React App

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

First, install this package and ESLint.

npm i -D eslint-config-bod

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

import eslintConfigBod from 'eslint-config-bod'

export default [...eslintConfigBod]

That's it! You can override the settings from eslint-config-bod by editing the eslint.config.js 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.

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

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.

Contact