eslint-plugin-magicdawn/README.md

eslint plugin for self use

# eslint-plugin-magicdawn

> eslint plugin for self use

[![Build Status](https://img.shields.io/travis/magicdawn/eslint-plugin-magicdawn.svg?style=flat-square)](https://travis-ci.org/magicdawn/eslint-plugin-magicdawn)
[![Coverage Status](https://img.shields.io/codecov/c/github/magicdawn/eslint-plugin-magicdawn.svg?style=flat-square)](https://codecov.io/gh/magicdawn/eslint-plugin-magicdawn)
[![npm version](https://img.shields.io/npm/v/eslint-plugin-magicdawn.svg?style=flat-square)](https://www.npmjs.com/package/eslint-plugin-magicdawn)
[![npm downloads](https://img.shields.io/npm/dm/eslint-plugin-magicdawn.svg?style=flat-square)](https://www.npmjs.com/package/eslint-plugin-magicdawn)
[![npm license](https://img.shields.io/npm/l/eslint-plugin-magicdawn.svg?style=flat-square)](http://magicdawn.mit-license.org)

## Install

```sh
$ npm i eslint-plugin-magicdawn --save-dev
```

## configs

### `plugin:magicdawn/base`

for node lib/app

```yml
extends:
  - plugin:magicdawn/base
```

### `plugin:magicdawn/vue`

for vue app

```yml
extends:
  - plugin:magicdawn/vue
```

## rules

| name               | desc                            | doc                                   |
| ------------------ | ------------------------------- | ------------------------------------- |
| `no-module-export` | no `module.export =` assignment | [doc](docs/rules/no-module-export.md) |

## Why

### 2017-03-19

I have a typo `module.export`, missing `'s'` that made me confused

## Changelog

[CHANGELOG.md](CHANGELOG.md)

## License

the MIT License http://magicdawn.mit-license.org