Skip to content

Commit c9b408b

Browse files
committed
feat: bundle eslint to remove the need for a separate installation
1 parent 2a786f0 commit c9b408b

3 files changed

Lines changed: 23 additions & 73 deletions

File tree

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,25 @@ This includes the Eslint configuration used in atom-ide-community.
1010
npm install --save-dev eslint-config-atomic
1111
```
1212

13-
You should also install the peer dependencies:
13+
<details>
14+
<summary> You should have the peer dependencies. </summary>
15+
16+
If using `npm`, the bundled Eslint, TypeScript, Babel, etc is hoisted automatically.
17+
18+
If using `pnpm`, either add the following to your `.npmrc` to hoist the prettier bundled with the config
1419

1520
```
16-
npm install -save-dev "eslint"
21+
public-hoist-pattern[]=*
1722
```
1823

24+
Or install these yourself in your `devDependencies`.
25+
26+
```
27+
pnpm install -save-dev eslint typescript @babel/core
28+
```
29+
30+
</details>
31+
1932
## Usage
2033

2134
Create a `.eslintrc.json` file at the root of the project with the following content:

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
"bump": "ncu -u -x coffeescript"
3333
},
3434
"dependencies": {
35+
"eslint": "^7",
3536
"@babel/core": "^7",
3637
"@typescript-eslint/eslint-plugin": "^4.21.0",
3738
"@typescript-eslint/parser": "^4.21.0",

0 commit comments

Comments
 (0)