# @gomarry/eslint-config-gomarry

> ESLint configuration of gomarry team including preset extending Airbnb, Flow, Prettier and Jest

Latest version **1.0.4** (published 2020-01-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @gomarry/eslint-config-gomarry
pnpm add @gomarry/eslint-config-gomarry
yarn add @gomarry/eslint-config-gomarry
bun add @gomarry/eslint-config-gomarry
```

## 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 | 1.0.4 |
| Published | 2020-01-27 |
| First published | 2020-01-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 12 |
| Unpacked size | 9.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Usamaliaquat123 |
| Maintainers | usamaliaquat |
| Keywords | node, npm, github, eslint, config, babel, flowtype, jest, prettier, react, react-native, react-hooks, promise |

## Links

- npm: https://www.npmjs.com/package/@gomarry/eslint-config-gomarry
- Repository: https://github.com/Gomarry/eslint-config-gomarry
- Homepage: https://github.com/Gomarry/eslint-config-gomarry#readme
- Issues: https://github.com/Gomarry/eslint-config-gomarry/issues
- npm.io page: https://npm.io/package/@gomarry/eslint-config-gomarry

## Dependencies (12)

- [prettier](https://npm.io/package/prettier.md) ^1.19.1
- [babel-eslint](https://npm.io/package/babel-eslint.md) ^10.0.3
- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ^23.6.0
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.18.0
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.20.0
- [eslint-plugin-promise](https://npm.io/package/eslint-plugin-promise.md) ^4.2.1
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^6.9.0
- [eslint-plugin-flowtype](https://npm.io/package/eslint-plugin-flowtype.md) ^4.6.0
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^3.1.2
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^2.3.0
- [eslint-restricted-globals](https://npm.io/package/eslint-restricted-globals.md) ^0.2.0
- [eslint-plugin-react-native](https://npm.io/package/eslint-plugin-react-native.md) ^3.8.1

## 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

- 1.0.4 (latest) — 2020-01-27
- 1.0.3 — 2020-01-27
- 1.0.2 — 2020-01-27
- 1.0.1 — 2020-01-27
- 1.0.0 — 2020-01-27

## README

# eslint-config-gomarry :trophy:

[![Travis](https://travis-ci.com/Gomarry/eslint-config-gomarry.svg)](https://travis-ci.com/)
[![version](https://img.shields.io/github/package-json/v/Gomarry/eslint-config-gomarry)](https://github.com/Gomarry/eslint-config-gomarry)
[![npm-version](https://img.shields.io/npm/v/@gomarry/eslint-config-gomarry)]()


Gomarry ESLint config utilizing Flow/TypeScript, Prettier, Jest, React and React Native.

Plugins and configs used:

 - Node config
  - [eslint-plugin-react](https://yarnpkg.com/en/package/eslint-plugin-react)
  - [eslint-plugin-react-native](https://yarnpkg.com/en/package/eslint-plugin-react-native)
  - [eslint-plugin-react-hooks](https://yarnpkg.com/en/package/eslint-plugin-react-hooks)
- Node config:
  - [eslint-config-prettier](https://yarnpkg.com/en/package/eslint-config-prettier)
  - [eslint-plugin-prettier](https://yarnpkg.com/en/package/eslint-plugin-prettier)
  - [eslint-plugin-jest](https://yarnpkg.com/en/package/eslint-plugin-jest) (applied for tests only, based on Jest's `testMatch` config)
  - [eslint-plugin-import](https://yarnpkg.com/en/package/eslint-plugin-import)
  - [eslint-plugin-promise](https://yarnpkg.com/en/package/eslint-plugin-promise)
  - [eslint-plugin-flowtype](https://yarnpkg.com/en/package/eslint-plugin-flowtype)
  - [@typescript-eslint/eslint-plugin](https://yarnpkg.com/en/package/@typescript-eslint/eslint-plugin)


  Additionally, it sets these environments:

Default config:

```json
{
  "env": {
    "es6": true,
    "node": true,
    "react-native/react-native": true
  }
}
```


Node config:

```json
{
  "env": {
    "es6": true,
    "node": true
  }
}
```


## Installation

```
yarn add --dev eslint @gomarry/eslint-config-gomarry
```

_Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like_



## Usage

Add to your ESLint config (`.eslintrc`, or `eslintConfig` field in `package.json`):

```json
{
  "extends": "@gomarry"
}
```

or for Node.js projects:

```json
{
  "extends": "@gomarry/eslint-config-gomarry/node"
}
```

### Example of extending the configuration

```json
{
  "extends": "@gomarry",
  "rules": {
    "global-require": 0,
    "prefer-destructuring": 0
  }
}
```

### TypeScript

In order to use this config in TypeScript project make sure you have installed following dependencies:

- [`@typescript-eslint/eslint-plugin`](https://yarnpkg.com/en/package/@typescript-eslint/eslint-plugin)
- [`@typescript-eslint/parser`](https://yarnpkg.com/en/package/@typescript-eslint/parser)
- [`typescript`](https://yarnpkg.com/en/package/typescript)

Then when running ESLint add `--ext '.js,.ts'` (you might need also `.jsx, .tsx`) option, for example:

```bash
yarn eslint --ext '.js,.ts' ./src
```

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