https://github.com/pocket/eslint-config

ESLint Config used across Pocket
https://github.com/pocket/eslint-config

Last synced: about 1 month ago
JSON representation

ESLint Config used across Pocket

• Host: GitHub
• URL: https://github.com/pocket/eslint-config
• Owner: Pocket
• License: apache-2.0
• Created: 2022-03-07T22:32:51.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-18T01:56:27.000Z (over 1 year ago)
• Last Synced: 2024-10-29T05:07:37.828Z (2 months ago)
• Language: JavaScript
• Size: 374 KB
• Stars: 2
• Watchers: 13
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# ESLint (and Prettier) config

These are settings for ESLint and Prettier used by Pocket.

## What it does

This setup lints your Typescript code based on best practices. Check the [.eslintrc.js](https://github.com/Pocket/eslint-config/blob/main/.eslintrc.js) file to see what is included. Feel free to override the rules that make sense for you.

## Installing

1. In your project folder, run:

```

npm i -D @pocket-tools/eslint-config # or yarn install --dev @pocket-tools/eslint-config 

npx install-peerdeps --dev @pocket-tools/eslint-config

```

2. You will see several dependencies were installed. Now, create (or update) a `.eslintrc` file with the following content:

```js

{

  'extends': '@pocket-tools/eslint-config'

}

```

3. Copy the [.prettierrc](https://github.com/Pocket/eslint-config/blob/main/.prettierrc) file from this repository into your project folder

---

This repository is inspired by [eslint-config-wesbos](https://github.com/wesbos/eslint-config-wesbos).