eslint-config-flitz/README.md

Shared ESLint configuration file for flitz.

[![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)