0.0.4 • Published 3 years ago

@outfit.io/eslint-config v0.0.4

Weekly downloads
-
License
UNLICENSED
Repository
github
Last release
3 years ago

Outfit.io ESLint config

Shareable ESLint config for Outfit.io JS projects.

Install

Run the following in your project directory:

npm install --save-dev @outfit.io/eslint-config

Usage

Step 1. Add ESLint rules for the language being used.

Javascript:

Add the following to your ESLint config file:

{
  "extends": ["eslint:recommended", "@outfit.io/eslint-config"]
}

TypeScript:

Install the TypeScript ESLint plugin and follow configuration instructions.

Add the following to your ESLint config file:

{
  "extends": ["plugin:@typescript-eslint/recommended", "@outfit.io/eslint-config", "@outfit.io/eslint-config/typescript"]
}

Step 2. Add ESLint rules for the frameworks/libraries being used.

React:

Install the React ESLint plugin and follow configuration instructions.

Add the following to your ESLint config file:

{
  "extends": ["plugin:react/recommended", "@outfit.io/eslint-config/react"]
}

Jest:

Install the Jest ESLint plugin and follow configuration instructions.

Add the following to your ESLint config file:

{
  "extends": ["plugin:jest/recommended", "@outfit.io/eslint-config/jest"]
}

Testing Library:

Install the Testing Library ESLint plugin and follow configuration instructions.

Add the following to your ESLint config file:

{
  "extends": ["plugin:testing-library/recommended", "@outfit.io/eslint-config/testing-library"]
}