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
Copy file name to clipboardExpand all lines: README.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
</h1>
4
4
5
5
<palign="center">
6
-
A modern <ahref="https://eslint.org/">ESlint</a> configuration for <ahref="https://www.ecma-international.org/publications-and-standards/standards/ecma-262/">JavaScript</a>, <ahref="https://www.typescriptlang.org/">TypeScript</a> and <ahref="https://reactjs.org/">React</a> that includes the <ahref="https://github.com/airbnb/javascript">Airbnb</a> style guide, <ahref="https://github.com/jsx-eslint/eslint-plugin-jsx-a11y">jsx-a11y</a> to help with accessibility and <ahref="https://www.npmjs.com/package/eslint-plugin-prettier">Pettier</a> to do some code formatting.
6
+
A modern <ahref="https://eslint.org/">ESlint</a> configuration for <ahref="https://www.ecma-international.org/publications-and-standards/standards/ecma-262/">JavaScript</a>, <ahref="https://www.typescriptlang.org/">TypeScript</a> and <ahref="https://reactjs.org/">React</a> that includes the <ahref="https://github.com/airbnb/javascript">Airbnb</a> style guide, <ahref="https://github.com/jsx-eslint/eslint-plugin-jsx-a11y">jsx-a11y</a> to help with accessibility and <ahref="https://www.npmjs.com/package/eslint-plugin-prettier">Prettier</a> to do some code formatting.
7
7
</p>
8
8
9
9
<palign="center">
@@ -18,23 +18,23 @@
18
18
19
19
## A bit of context
20
20
21
-
It's always a bit time consuming to create or maintain different [ESlint](https://eslint.org/) configurations that works with different languages and libraries such as [TypeScript](https://www.typescriptlang.org/) and [React](https://reactjs.org/). The goal of this package is to have different configurations that just work out-of-the-box and that are constantly kept up-to-date.
21
+
It's always a bit time consuming to create or maintain different [ESlint](https://eslint.org/) configurations that work with different languages and libraries such as [TypeScript](https://www.typescriptlang.org/) and [React](https://reactjs.org/). The goal of this package is to have different configurations that just work out-of-the-box and are constantly kept up-to-date.
22
22
23
23
## Getting Started 🚀
24
24
25
-
Installing this packge is has as easy has any other packages. Simply use your favorite package manager. You'll need to install the required peer dependencies and than this packge.
25
+
Installing this package is as easy as any other packages. Simply use your favorite package manager. Keep in mind you'll need to install the required peer dependencies first.
26
26
27
27
### Install ESlint and Prettier peer dependencies
28
28
29
-
Install [ESlint](https://eslint.org/) and [Prettier](https://prettier.io/) either locally or globally. (Note that locally, per project, is strongly preferred)
29
+
Install [ESlint](https://eslint.org/) and [Prettier](https://prettier.io/) either locally or globally. Note that locally per project is strongly preferred.
30
30
31
31
32
32
```sh
33
33
npm install eslint@8 --save-dev
34
34
npm install prettier@2 --save-dev --save-exact
35
35
```
36
36
37
-
If you use [TypeScript](https://www.typescriptlang.org/) or [React](https://reactjs.org/) you'll also need to install them, but let's assume they're already installed. We'll only support most recent version. Have a look at the `peerDependencies` field in the package.jsonto know which one we support.
37
+
If you use [TypeScript](https://www.typescriptlang.org/) or [React](https://reactjs.org/) you'll also need to install them, but let's assume they're already installed. We'll only support most recent versions. Have a look at the `peerDependencies` field in the `package.json` file to know which versions are supported.
38
38
39
39
### Install easelint
40
40
@@ -44,7 +44,7 @@ npm install easelint --save-dev
44
44
45
45
### Setup the configuration file
46
46
47
-
Using any [file formats](https://eslint.org/docs/user-guide/configuring/configuration-files#configuration-file-formats) supported by [ESlint](https://eslint.org/), youll need to add `"100terres"` in the `"extends"` value of the configuration. Here's an example using a `.eslintrc.js` file.
47
+
Using any [file formats](https://eslint.org/docs/user-guide/configuring/configuration-files#configuration-file-formats) supported by [ESlint](https://eslint.org/), you'll need to add `"100terres"` in the `"extends"` value of the configuration. Here's an example using a `.eslintrc.js` file.
48
48
49
49
#### Using the full configuration with JavaScript, TypeScript and React
50
50
@@ -77,7 +77,7 @@ Voilà! Your project now uses a linter.
77
77
78
78
## How to Contribute 🤝
79
79
80
-
Pull requests are welcome. If you'd like to contribute to easelint, that's awesome. Simply open an issue explaining what we should change, improve or fix. If we decide that a change is required we can open a pull request and once everything looks good I'll approve and merge the PR.
80
+
Pull requests are welcomed. If you'd like to contribute to `easelint`, that's awesome. Simply open an issue explaining what should be changed, improved or fixed. If we decide that a change is required, we can open a pull request. Once everything looks good, I'll approve and merge the PR.
0 commit comments