eslint-config-availity

eslint-config-availity

Shareable ESLint config for Availity projects designed to be used with Prettier and Typescript

Installation

This package is compatible with v18 and v20 of Node.

NPM

npm install --save-dev eslint-config-availity

Yarn

yarn add --dev eslint-config-availity

If you need TypeScript support then you will also need to include typescript as a devDependency

Features

Configs

• eslint-config-airbnb
• eslint-config-airbnb-base
• eslint-config-prettier

Plugins

• eslint-plugin-import
• eslint-plugin-jest
• eslint-plugin-jsx-a11y
• eslint-plugin-promise
• eslint-plugin-react
• eslint-plugin-react-hooks
• eslint-plugin-unicorn

TypeScript

• @typescript-eslint/eslint-plugin
• @typescript-eslint/parser

Usage

Typescript is supported in both configurations

Node w/ optional Typescript

# .eslintrc.yaml
extends: availity

Browser (React) w/ Typescript

# .eslintrc.yaml
extends: availity/browser

Workflow

Allows root imports in @availity/workflow projects.

# .eslintrc.yaml
extends: availity/workflow

If you are using TypeScript then you can take advantage of root imports with your tsconfig.json

Prettier

Recommended settings

{
    "printWidth": 120,
    "singleQuote": true,
    "trailingComma": "es5"
}

Contributing

• yarn
• Make necessary changes
• Update README.md and rules.test.js if necessary
• Commit your changes using the conventional-commits format
• Push your changes and open a PR
• A new version will be deployed automatically through the CI process

Disclaimer

Open source software components distributed or made available in the Availity Materials are licensed to Company under the terms of the applicable open source license agreements, which may be found in text files included in the Availity Materials.

License

MIT