# @flick-tech/eslint-config

> _shared ESLint configs used in Flick_

Latest version **1.1.16** (published 2021-09-16) · MIT license · 0 weekly downloads

## Install

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

## 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.1.16 |
| Published | 2021-09-16 |
| First published | 2020-11-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 23.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | andyasprou, hasparus |

## Links

- npm: https://www.npmjs.com/package/@flick-tech/eslint-config
- Repository: https://github.com/Flick-Tech/frontend
- Homepage: https://github.com/Flick-Tech/frontend#readme
- Issues: https://github.com/Flick-Tech/frontend/issues
- npm.io page: https://npm.io/package/@flick-tech/eslint-config

## Recent versions

- 1.1.16 (latest) — 2021-09-16
- 1.0.3 — 2021-04-30
- 1.0.2 — 2020-11-09
- 1.0.1 — 2020-11-09
- 1.0.0 — 2020-11-09

## README

# @flick-tech/eslint-config

_shared ESLint configs used in Flick_

## Motivation

Sharing one thoroughly documented ESLint config makes its maintenance easier and
predictable.

## Usage

### Installation

```
yarn add \
  "@typescript-eslint/eslint-plugin" \
  "@typescript-eslint/parser" \
  "eslint-plugin-cypress" \
  "eslint-plugin-import" \
  "eslint-plugin-jsx-a11y" \
  "eslint-plugin-react-hooks" \
  "eslint-plugin-react" \
  "eslint-plugin-simple-import-sort" \
  "eslint-plugin-sonarjs" \
```

### Rules requiring typechecking

Reference your tsconfig in `project` to enable rules which require typechecking

```json
{
  "root": true,
  "parserOptions": {
    "project": "./tsconfig.json"
  },
  "extends": ["@flick-tech"],
  "ignorePatterns": "./libs/tracking/src/lib/itly/*.ts"
}
```

## Releasing

There's no release needed for use in `frontend` repo. To use in other
repositories, run `yarn publish` in _libs/eslint-config_ directory.

## Development

- Mark changes from "default" rules present in common presets with `@changed`.
- Describe the background for a rule or its disabling with a comment marked with
  `@motivation`.
- Use rules that affect semantics — detect bugs and "no morning coffee"
  mistakes.
- Avoid obtrusive code style rules.

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