# eslint-config-flitz

> Shared ESLint configuration file for flitz.

Latest version **0.2.0** (published 2020-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install eslint-config-flitz
pnpm add eslint-config-flitz
yarn add eslint-config-flitz
bun add eslint-config-flitz
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2020-07-20 |
| First published | 2020-07-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 4.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Marcel Joachim Kloubert |
| Maintainers | mkloubert |
| Keywords | node, code, quality, eslint, typescript, shared, lint, linter, validate, strict, check, checker, verify, enforce, hint, javascript, ts, config, configuration, flitz, dev, development |

## Links

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

## Dependencies (8)

- [eslint](https://npm.io/package/eslint.md) ^6.8.0
- [eslint-plugin-jsdoc](https://npm.io/package/eslint-plugin-jsdoc.md) ^22.2.0
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.20.2
- [eslint-plugin-no-null](https://npm.io/package/eslint-plugin-no-null.md) ^1.0.2
- [eslint-plugin-unicorn](https://npm.io/package/eslint-plugin-unicorn.md) ^16.1.1
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^2.31.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^2.31.0
- [@typescript-eslint/eslint-plugin-tslint](https://npm.io/package/@typescript-eslint/eslint-plugin-tslint.md) ^2.31.0

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

- 0.2.0 (latest) — 2020-07-20
- 0.1.0 — 2020-07-19

## README

[![npm](https://img.shields.io/npm/v/eslint-config-flitz.svg)](https://www.npmjs.com/package/eslint-config-flitz)

# eslint-config-flitz

> Shared [ESLint config](http://eslint.org/docs/developer-guide/shareable-configs.html) for [flitz](https://github.com/flitz-js/flitz).

![meme](https://raw.githubusercontent.com/flitz-js/eslint-config/master/assets/meme.jpg)

## Install

Run

```bash
npm install --save-dev eslint eslint-config-flitz
```

from the folder, where your `package.json` is stored.

## Usage

### ESLint

Once the `eslint-config-flitz` package is installed, you can use it by specifying `flitz` in the [`extends`](http://eslint.org/docs/user-guide/configuring#extending-configuration-files) section of your [ESLint configuration](http://eslint.org/docs/user-guide/configuring).

Create a `.eslintrc.js` file in the root folder of your project and use the following skeleton:

```js
module.exports = {
  "extends": "flitz",
  "rules": {
    // Additional, per-project rules...
  }
}
```

As optional feature, you can add script entry, called `lint` e.g., to your `package.json`:

```json
{
  "scripts": {
    "lint": "eslint -c .eslintrc.js --ext .ts <mySrcFolder>"
  }
}
```

### Visual Studio Code

First install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) for [Visual Studio Code](https://code.visualstudio.com/) by [Dirk Baeumer](https://marketplace.visualstudio.com/publishers/dbaeumer).

Then setup your `settings.json` inside your `.vscode` subfolder by adding the following entries:

```json
{
  "editor.formatOnSave": true,
  "editor.tabSize": 2,
  "eslint.quiet": false,
  "eslint.enable": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}
```

To keep sure, to have the extension installed, create a `extensions.json` file inside the same folder, if needed, and add the following entry as recommendation:

```json
{
  "recommendations": [
    "dbaeumer.vscode-eslint"
  ]
}
```

## License

MIT © [Marcel Kloubert](https://github.com/mkloubert)

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