Shared ESLint configuration (base)

ESLint is used for code linting.

The inheritance hierarchy looks like this:

eslint-config (base)
         ^
eslint-config-typescript
         ^
eslint-config-next

To use eslint-config-typescript or eslint-config-next, visit their respective documentation.

Add Dependencies

Install this package and peerDependencies of this package as devDependencies in the project, using install-peerdeps.

npx install-peerdeps --dev @mintlify/eslint-config

Alternatively, you can install this package as devDependency and install the peerDependencies separately.

# yarn
yarn add -D @mintlify/eslint-config

# npm
npm i -D @mintlify/eslint-config

# pnpm
pnpm add -D @mintlify/eslint-config

Add Configuration File

Create a .eslintrc.json file in the project root that extends this package.

{
    "extends": "@mintlify/eslint-config",
    ...
}