ESLint Configuration
@availity/workflow projects use eslint-config-availity with ESLint's flat config format.
Setup
Install the config:
yarn add eslint-config-availity --dev
Create eslint.config.js at your project root:
import workflow from 'eslint-config-availity/workflow';
export default [
...workflow,
{
ignores: ['**/coverage/', '**/build/', '**/dist/'],
},
];
With TypeScript
If your project uses TypeScript, add the import resolver:
import workflow from 'eslint-config-availity/workflow';
export default [
...workflow,
{
settings: {
'import/resolver': {
typescript: {},
},
},
},
{
ignores: ['**/coverage/', '**/build/', '**/dist/'],
},
];
Running
av lint
Or directly:
npx eslint .
Migrating from .eslintrc
If you're upgrading from an older project using .eslintrc.yml or .eslintrc.json:
- Delete the old config file (
.eslintrc.yml,.eslintrc.json, or.eslintrc.js) - Create
eslint.config.jsas shown above - Remove any individual ESLint plugins from
devDependencies— they're bundled ineslint-config-availity:eslint-plugin-importeslint-plugin-jsx-a11yeslint-plugin-react@typescript-eslint/eslint-plugin@typescript-eslint/parser
The @availity/workflow-upgrade tool can automate this migration:
npx @availity/workflow-upgrade