You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<palign="center">Eslintrc-Generator is a simple but a timesaving commandline tool which will help you setup your eslint, project and code formatter with all the configuration you want. You just have to answer some really simple questions and this tool will do all the heavy lifting for you creating the file according to config and installing all the required packages</p>
44
+
<palign="center">Eslintrc-Generator is a simple but time-saving command-line tool that will help you setup your eslint, project, and code formatter with all the configuration you want. You just have to answer some really simple questions and this tool will do all the heavy lifting for you creating the file according to config and installing all the packages</p>
45
45
46
46
## 💡 Features
47
47
@@ -52,9 +52,9 @@
52
52
- Prettier
53
53
- React
54
54
1. Ask questions and creates config based on your choice
55
-
1. You have complete control on the configuration
55
+
1. You have complete control over the configuration
56
56
1. Checks for package.json file and `npm init -y` if not found
57
-
1. Installs all required packages as dev dependency according to config
57
+
1. Installs all required packages as dev dependency as per the config
58
58
1. Uses your preferred package manager
59
59
60
60
## ⛏️ Built with
@@ -69,6 +69,7 @@ Follow all these instructions and learn the best way to take benefits from this
69
69
70
70
### 📚 Prerequisite
71
71
72
+
- Node
72
73
- npm/yarn
73
74
74
75
### 🧰 Installation
@@ -79,6 +80,8 @@ Follow all these instructions and learn the best way to take benefits from this
79
80
npm i eslintrc-generator -g
80
81
```
81
82
83
+
> _**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`. But I recommend using the global method_
84
+
82
85
1. Per project installation
83
86
84
87
```bash
@@ -89,9 +92,7 @@ Follow all these instructions and learn the best way to take benefits from this
89
92
yarn add eslintrc-generator
90
93
```
91
94
92
-
> _**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`. But I recommend using the global method_
93
-
94
-
1. Command to generate rc file
95
+
1. Command to generate RC file
95
96
96
97
```bash
97
98
npx generate-eslintrc
@@ -103,7 +104,7 @@ Follow all these instructions and learn the best way to take benefits from this
103
104
104
105
## 🎈 Usage
105
106
106
-
The package is made to save time in configuring **Eslint**with your project and also with **Prettier**, _(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, install all the packages and create the RC file perfectly compatible with your project as well as Prettier for you as per the config. You just need to focus on your awesome project.
107
+
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.
107
108
108
109
## ✍️ Authors
109
110
@@ -113,7 +114,7 @@ The package is made to save time in configuring **Eslint** with your project and
113
114
114
115
**_"In real open source, you have the right to control your own destiny."_**_- Linus Torvalds_
115
116
116
-
Contributions are what make the opensource community an amazing place. Any contributions you make are **greatly appreciated**.
117
+
Contributions are what makes the open-source community an amazing place. Any contributions you make are **greatly appreciated**.
117
118
118
119
## 💳 License
119
120
@@ -136,6 +137,6 @@ Distributed under the MIT License. See [`LICENSE`](LICENCE) for more information
0 commit comments