eslint-config-availity

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

Installation

Requires Node 20+ and ESLint 9+.

yarn add --dev eslint-config-availity

If you need TypeScript support, also include typescript as a devDependency.

Usage

This package exports ESLint flat configs. Create an eslint.config.js in your project root.

Workflow (for @availity/workflow projects)

import workflow from 'eslint-config-availity/workflow';

export default [
  ...workflow,
];

Browser (React + TypeScript)

import browser from 'eslint-config-availity/browser';

export default [
  ...browser,
];

Base (Node)

import base from 'eslint-config-availity';

export default [
  ...base,
];

Adding project-specific rules

import workflow from 'eslint-config-availity/workflow';

export default [
  ...workflow,
  {
    rules: {
      'no-console': 'warn',
    },
  },
  {
    ignores: ['**/static/*'],
  },
];

Migrating from .eslintrc

If upgrading from a previous version, see the @availity/workflow upgrade guide. The @availity/workflow-upgrade tool automates the migration from .eslintrc to eslint.config.js.

Included Configs and Plugins

Configs

• eslint-config-airbnb (via @eslint/compat)
• 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-eslint (v8)

Prettier

Recommended settings:

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

Contributing

• yarn
• Make necessary changes
• Update README.md and rules.test.js if necessary
• Commit using conventional commits
• Push and open a PR

License

MIT