@forgerock/eslint-config

ForgeRock ESLint Shareable Configuration

ForgeRock’s JavaScript Style Guide as a ESLint Shareable Configuration.

• Prerequisites
• Installation
  • via Yarn
  • via NPM
• Usage
  • Babel
  • Built-In
  • Filenames
  • JSX a11y
  • JSDoc
  • Promise
  • React
  • React Hooks
• Contributing

Prerequisites

ForgeRock ESLint Shareable Configuration requires ESLint 6.x.

Installation

via Yarn

yarn add @forgerock/eslint-config

via NPM

npm install @forgerock/eslint-config

Usage

Add one or more of the following rule sets to the extends section of your .eslintrc.js configuration.

Babel

extends: ["@forgerock/eslint-config/babel"]

Babel rules provided by eslint-plugin-babel.

Use these rules if you are using the babel-eslint parser.

Built-In

extends: ["@forgerock"]

Built-in rules provided by ESLint.

Filenames

extends: ["@forgerock/eslint-config/filenames"]

Filename rules provided by eslint-plugin-filenames.

JSX a11y

extends: ["@forgerock/eslint-config/jsx-a11y"]

JSX accessiblity rules provided by eslint-plugin-jsx-a11y.

JSDoc

extends: ["@forgerock/eslint-config/jsdoc"]

JSDoc rules provided by eslint-plugin-jsdoc.

Promise

extends: ["@forgerock/eslint-config/promise"]

Promise rules provided by eslint-plugin-promise.

React

extends: ["@forgerock/eslint-config/react"]

React and JSX rules provided by eslint-plugin-react.

React Hooks

extends: ["@forgerock/eslint-config/react-hooks"]

React Hook rules provided by eslint-plugin-react-hooks.

Contributing

Contribute to ForgeRock ESLint Shareable Configuration by opening a Pull Request.