# eslint-config-mysticatea

[![npm version](https://img.shields.io/npm/v/eslint-config-mysticatea.svg)](https://www.npmjs.com/package/eslint-config-mysticatea)
[![Downloads/month](https://img.shields.io/npm/dm/eslint-config-mysticatea.svg)](http://www.npmtrends.com/eslint-config-mysticatea)
[![Build Status](https://travis-ci.org/mysticatea/eslint-config.svg?branch=master)](https://travis-ci.org/mysticatea/eslint-config)
[![Dependency Status](https://david-dm.org/mysticatea/eslint-config.svg)](https://david-dm.org/mysticatea/eslint-config)

Shareable configurations of ESLint.

There is basic configuration at [base.js](./base.js).

## 💿 Installation

```
npm install --save-dev eslint eslint-config-mysticatea
```

### Requirements

- Node.js `^4.0.0`, `^6.0.0`, `^8.0.0`, or newer.
- ESLint `^4.14.0`, or newer.

## 📖 Usage

Write in your ESLint configurations: http://eslint.org/docs/user-guide/configuring#using-the-configuration-from-a-plugin

**First, please choose a base template.**

- `mysticatea` - A rule set for ECMAScript 2017.
- `mysticatea/es5` - A rule set for ECMAScript 5.

**Second, please choose a optional template and add it.**

- `mysticatea/browser` - An additional setting for browser environment.
- `mysticatea/mocha` - An additional setting for mocha environment.
- `mysticatea/modules` - An additional setting for ES Modules enviroment.
- `mysticatea/node` - An additional setting for Node.js environment.
- `mysticatea/vue` - An additional setting for Vue.js environment. This setting includes `mysticatea/browser` and `mysticatea/modules`.

Then, please write those into `extends` field.

### Examples

- Node.js with ES5

  ```json
  {
      "extends": ["mysticatea/es5", "mysticatea/node"]
  }
  ```

- Node.js with ES2015

  ```json
  {
      "extends": ["mysticatea", "mysticatea/node"]
  }
  ```

  In this case, `engines` field of `package.json` is needed to specify the version of Node.

- Node.js with ES2015 & Modules

  ```json
  {
      "extends": ["mysticatea", "mysticatea/modules", "mysticatea/node"]
  }
  ```

  In this case, `engines` field of `package.json` is needed to specify the version of Node.
  Or just turn `node/no-unsupported-features` off.

- Browser with ES2015

  ```json
  {
      "extends": ["mysticatea", "mysticatea/browser"]
  }
  ```

## 🚥 Semantic Versioning Policy

This package follows [Semantic Versioning 2.0.0](http://semver.org/)

- Patch release:
    - A new rule is disabled.
    - A rule's option is changed that results in ESLint reporting fewer errors.
    - Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone).
- Minor release:
    - A new preset is created.
    - An existing preset is deprecated.
- Major release:
    - An existing preset is removed.
    - A new rule is enabled.
    - A rule's option is changed that results in ESLint reporting more errors.
    - Required Node.js version is changed.
    - Required ESLint version is changed.

## 📰 Changelog

- [GitHub Releases](https://github.com/mysticatea/eslint-config/releases)

## 💎 Contributing

### Development Tools

- `npm test` runs tests.
- `npm run watch` runs tests when source code are changed.

There is a test script.

- Check lacking configurations of new rules.
- Check configurations of rules. (options are valid or not)
- Check configurations of deprecated rules. (should turn those off)
- Check configurations of removed rules. (should remove those)