Skip to content

sammysaglam/eslint-config-sammy

Repository files navigation

ESlint Config Sammy

GitHub license npm version PRs Welcome

Highly opinionated & React Typescript centric.

Features

  1. Lots of React goodness
  2. "Prettier" formatting (https://prettier.io/)

Installation

Step 1

yarn add eslint eslint-config-sammy --dev

Step 2

To the root of your project add the following two files:

.eslintrc

{
  "extends": "sammy"
}

.prettierrc.js

module.exports = {
  ...require("eslint-config-sammy/.prettierrc.recommended.js"),
};

Step 3

Add to your package.json "scripts" key (if doesn't exist, create):

"scripts": {
  "lint": "\"./node_modules/.bin/eslint\" . --ext js,ts,tsx"
}

Step 4

Add your ignore files: .prettierignore & .eslintignore

**/node_modules/**
**/build/**
**/coverage/**

Step 5

Run in your terminal

yarn lint
yarn lint --fix

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published