# eslint-config-fishbrain-base

> ESLint config for Fishbrain TypeScript projects

Latest version **5.0.5** (published 2024-01-05) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install eslint-config-fishbrain-base
pnpm add eslint-config-fishbrain-base
yarn add eslint-config-fishbrain-base
bun add eslint-config-fishbrain-base
```

## 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 | 5.0.5 |
| Published | 2024-01-05 |
| First published | 2019-07-10 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 22.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Fishbrain |
| Maintainers | fishbrain-developers, dalen, alexceder, lukehansford, tetiana-fishbrain, klaseskilson |

## Links

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

## Dependencies (8)

- [eslint](https://npm.io/package/eslint.md) ^8.55.0
- [prettier](https://npm.io/package/prettier.md) ^3.1.0
- [eslint-plugin-fp](https://npm.io/package/eslint-plugin-fp.md) ^2.3.0
- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ^27.6.0
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.29.0
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^5.0.1
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^6.13.2
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^6.13.2

## Recent versions

- 5.0.5 (latest) — 2024-01-05
- 5.0.4 — 2023-12-05
- 5.0.3 — 2023-11-16
- 5.0.2 — 2023-09-26
- 5.0.1 — 2023-07-21
- 5.0.0 — 2023-07-21
- 4.0.0 — 2023-04-05
- 3.0.4 — 2022-01-25
- 2.1.1 — 2021-01-14
- 2.1.0 — 2020-07-31
- 2.0.0 — 2020-06-15
- 1.3.1 — 2020-01-07
- 1.3.0 — 2020-01-07
- 1.1.0 — 2019-07-19
- 1.0.7 — 2019-07-15
- … 7 more at https://npm.io/package/eslint-config-fishbrain-base/versions

## README

# ESLint config for Fishbrain TypeScript projects

[![npm version](https://badge.fury.io/js/eslint-config-fishbrai-base.svg)](https://badge.fury.io/js/eslint-config-fishbrain-base)
[![Build Status](https://travis-ci.com/fishbrain/eslint-config-fishbrain-base.svg?branch=master)](https://travis-ci.com/fishbrain/eslint-config-fishbrain-base)

Rule set based on [Airbnb JavaScript style guide](https://github.com/airbnb/javascript)
with some extra rules for Jest tests from [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest).

## Usage

```bash
npm install -D eslint-config-fishbrain-base
```

In `.eslintrc` (or whatver your ESLint config file is)

```json
{
  "extends": ["eslint-config-fishbrain-base"]
}
```

### Recommended tsconfig.json settings

In addition to setting target, module, moduleResolution etc,
these strictness settings are recommended.

```json
{
  "compilerOptions": {
    "strict": true,
    "noFallthroughCasesInSwitch": true,
    "noImplicitReturns": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true
  }
}
```

### Recommended Prettier settings

Add this to `package.json` to get correct config for [prettier](https://prettier.io/)

```json
  "prettier": {
    "singleQuote": true,
    "trailingComma": "all"
  }
```

### Editor settings

To enable ESLint in VS Code add the following to your `settings.json`:

```json
{
  "tslint.enable": false,
  "eslint.validate": [
    "javascript",
    "typescript",
  ]
}
```

### Web Projects

For ESLint rules for React based web projects, see: https://github.com/fishbrain/eslint-config-fishbrain

## Deploying

To trigger a release, merge changes into the `master` branch with an updated package version. This
will trigger a Github Actions workflow to deploy a release.

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