# eslint-config-favoritemedium-typescript

> FavoriteMedium's ESLint config, following our styleguide

Latest version **2.10.0** (published 2020-09-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-config-favoritemedium-typescript
pnpm add eslint-config-favoritemedium-typescript
yarn add eslint-config-favoritemedium-typescript
bun add eslint-config-favoritemedium-typescript
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.10.0 |
| Published | 2020-09-29 |
| First published | 2020-01-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 102.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Muhammad Umair |
| Maintainers | favoritemedium |
| Keywords | es2015, es2016, es2017, es2018, es6, es7, eslint, favoritemedium, jsx, lint, react, style guide, ts, tsx, typescript |

## Links

- npm: https://www.npmjs.com/package/eslint-config-favoritemedium-typescript
- Repository: https://gitlab.com/favoritemedium-oss/eslint-config-favoritemedium-typescript
- Homepage: https://gitlab.com/favoritemedium-oss/eslint-config-favoritemedium-typescript#readme
- Issues: https://gitlab.com/favoritemedium-oss/eslint-config-favoritemedium-typescript/issues
- npm.io page: https://npm.io/package/eslint-config-favoritemedium-typescript

## Dependencies (4)

- [object.assign](https://npm.io/package/object.assign.md) ^4.1.0
- [object.entries](https://npm.io/package/object.entries.md) ^1.1.1
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^2.14.0
- [confusing-browser-globals](https://npm.io/package/confusing-browser-globals.md) ^1.0.9

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 2.10.0 (latest) — 2020-09-29
- 0.17.0 — 2020-03-16
- 0.16.0 — 2020-02-13
- 0.12.1 — 2020-01-10
- 0.12.0 — 2020-01-09

## README

# FavoriteMedium JavaScript/TypeScript Style Guide

_Super charged with `@typescript-eslint`_

There are two styles configurations:

- [Vanilla Js/Ts](#setup_vanilla_js_ts)
- [React (Jsx/Tsx)](#setup_react)

> _if you are using React configurations then there is no need to import base configurations._

## Installation & Usage Guide

Following procedures will guide you through setting up `eslint-config-favoritemedium-typescript` into your projects.

## 1. Vanilla Js/Ts setup

Assuming `eslint` and `typescript` are already installed as development dependencies.

```sh
npm i -D eslint-config-favoritemedium-typescript \
        eslint-plugin-import@^2.22.1 \
        @typescript-eslint/eslint-plugin@^4.3.0 \
        eslint \
        typescript
```

Within ESLint config file at project root add following configurations:

```javascript
module.exports = {
  extends: ['favoritemedium-typescript'],
};
```

in `package.json` file:

```javascript
{
  //...
  "scripts": {
    "lint": "eslint ./<source_directory>/**/*",
    "lint:fix": "eslint --fix ./<source_directory>/**/*"
  }
  //...
}
```

> \*Note: **lint:fix** is optional command; it will try to fix semicolons, spacing, quotes related formatting automatically.

## 2. React setup

There are two possible ways that `eslint-config-favoritemedium-typescript` plugin can added to project.

1. Adding to project created with `npx create-react-app <cool-app> --template typescript`
1. Manually configuring to existing project

### 2.1 Adding to new/existing project created with [create-react-app](https://create-react-app.dev/docs/getting-started/) v3.x and higher

Generate react application with following command mentioned [here](https://create-react-app.dev/docs/adding-typescript):

```
npx create-react-app my-app --template typescript
# or
yarn create react-app my-app --template typescript
```

install following dependency:

```bash
yarn add -D eslint-config-favoritemedium-typescript
# or
npm i -D eslint-config-favoritemedium-typescript
```

create `.eslintrc` file in project root directory

```javascript
// .eslintrc

module.exports = {
  extends: ['favoritemedium-typescript/config/react'],
};
```

create `.eslintignore` file in project root directory:

```javascript
// .eslintignore

node_modules
*.svg
*.css
*.scss
```

in `package.json` file add following script.

```javascript
{
  //...
  "scripts": {
    "lint": "eslint ./<source_directory>/**/*",
  }
  //...
}
```

### 2.2 Manual configurations

For setting up eslint for react project you need to install three additional dependencies to vanilla js/ts setup

```javascript
npm i -D eslint-config-favoritemedium-typescript \
        eslint-plugin-import@^2.22.1 \
        @typescript-eslint/eslint-plugin@^4.3.0 \
        eslint-plugin-jsx-a11y@^6.3.1 \
        eslint-plugin-react@^7.21.2 \
        eslint-plugin-react-hooks@^4.1.2 \
        eslint \
        typescript
```

create `.eslintrc` file in project root directory

```javascript
// .eslintrc

module.exports = {
  extends: ['favoritemedium-typescript/config/react'],
};
```

create `.eslintignore` file in project root directory:

```javascript
// .eslintignore

node_modules
*.svg
*.css
*.scss
```

in `package.json` file:

```javascript
{
  //...
  "scripts": {
    "lint": "eslint ./<source_directory>/**/*"
  }
  //...
}
```

After above setup completion you may add `npm run lint` command to your `pre-commit` setup like configured in `.huskyrc.js`

---
_Source: https://npm.io/package/eslint-config-favoritemedium-typescript · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._