Eslintrc-generator NPM

Project Demo Gif

💡 Features

Uses Airbnb Style Guide
Perfectly compatible with
- TypeScript
- JavaScript
- Prettier
- React
Ask questions and creates config based on your choice
You have complete control over the configuration
Checks for package.json file and npm init -y if not found
Installs all required packages as dev dependency as per the config
Uses your preferred package manager
Supports CLI arguments

⛏️ Built with

Inquirer
Listr
Execa
Yargs

💻 Command Line Arguments

-t, --moduleType: Module type you use js: JavaScript modules (Import/Export), req: CommonJS (require) { choices: "js", "req", "none" }
-c, --codeRun: Code will run on array { choices: "browser", "node" }
-r, --isReact: Using React in project boolean
-l, --language: Language you going to use { choices: "ts", "js" }
-p, --isPrettier: Using Prettier for formatting boolean
-m, --packageManager: Which package manager to use { choices: "yarn", "npm" }

🏁 Getting Started

Follow all these instructions and learn the best way to take benefits from this package.

📚 Prerequisite

Node
npm/yarn

🧰 Installation

Global installation (preferred way)
```
npm i eslintrc-generator -g
```
Note: Global installation is not possible with yarn v2 as far as I know, (please guide me if I am wrong). If you are using yarn v1 then use yarn global add eslintrc-generator. And I recommend using the global method

Per project installation

npm i eslintrc-generator

            or

yarn add eslintrc-generator

Command to generate RC file

npx eslintrc-generator

         or

generate-eslintrc

Generate via CLI arguments

npx eslintrc-generator -t js -c node -l ts -m yarn -rp

         or

generate-eslintrc -t js -c node -l ts -m yarn -rp

🎈 Usage

The sole motive of this package is to improve Developer Experience. The package is made to save time configuring Eslint and Prettier, with your project (if you have done this before you already know the pain). The tool will ask you certain questions, prepare a config and required packages list based on your answers, install all the packages and create the RC file perfectly compatible with your project as well as Prettier. You just need to focus on your awesome project.