From a8824800e7c5e8d86840b01e4fac77a0690eacda Mon Sep 17 00:00:00 2001 From: Henrique Almeida Date: Tue, 5 Dec 2023 09:09:13 +0100 Subject: [PATCH] Update README.md --- README.md | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index dc8c380..fe9cba9 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,15 @@ # eslint-config-gev -My curated ESLint configs for Javascript/Typescript. All my projects are using this. +My curated ESLint configs for Javascript/Typescript that I've been improving over the years. All of my projects use this. -~~Intended to work without Prettier, as ESLint can really manage the code looks by itself.~~ - -The above is no longer true in the current v3; I have opted to move to prettier for those reasons. Use my [prettier-config-gev](https://github.com/SrBrahma/prettier-config-gev) for formatting. You can still use this plugin with the all the great formatting by installing the major v2. +In the past, this package also took care of formatting the code, but ESLint proved to be slow when dealing with larger codebases, so I created this Prettier config that I use together with ESLint: [prettier-config-gev](https://github.com/SrBrahma/prettier-config-gev). You can also use my [**`gev`** npx package](https://github.com/srbrahma/gev) that will create a new project with everything properly and automatically configured. Works accordingly to https://eslint.org/docs/developer-guide/shareable-configs -If interested, take a look into the source files to see what will be used as plugins, extends and rules. +Take a look into the source files to see what will be used as plugins, extends, and rules. ## 💿 Install: @@ -29,11 +27,9 @@ yarn add -D eslint-config-gev pnpm i -D eslint-config-gev ``` -### CLI - -After installing, you can run `npx eslint-config-gev ` to quickly create a basic and functional `.eslintrc.js`, being flavor one of the following: `js, react-js, react-native-js, react-native-ts, react-ts, ts`. This list can be seen by running `npx eslint-config-gev -h`. +### CLI - Automated way -Else, continue reading! +After installing, run `npx eslint-config-gev ` to quickly create a basic and functional `.eslintrc.js`, being flavor one of the following: `js, react-js, react-native-js, react-native-ts, react-ts, ts`. This list can be seen by running `npx eslint-config-gev -h`. ### Manual