@xo-cash/eslint-config

This repository contains an ESLint configuration for TypeScript projects in the @xo-cash/* NPM package namespace. It is based on and extends a community maintained version of the official Airbnb ESLint configuration and its TypeScript equivalent.

Installation

Dependencies

Before you can use this you need to install the peer depenencies required by the configuration setup.

npm install --save-dev \
  eslint \
  typescript-eslint \
  @typescript-eslint/parser \
  @typescript-eslint/eslint-plugin \
  @stylistic/eslint-plugin \
  @chalp/eslint-airbnb

After installing the dependencies, you can install the module containing the configuration:

npm install --save-dev @xo-cash/eslint-config

Configuration

Place the following eslint.config.mjs in your project root directory:

export { default } from '@xo-cash/eslint-config';

Then add the following instruction to the scripts section of the package.json file:

"style": "eslint"