Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wyze/eslint-plugin-wyze
My personal ESLint rules.
https://github.com/wyze/eslint-plugin-wyze
eslint eslint-plugin
Last synced: 4 days ago
JSON representation
My personal ESLint rules.
- Host: GitHub
- URL: https://github.com/wyze/eslint-plugin-wyze
- Owner: wyze
- License: mit
- Created: 2016-02-25T04:22:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-11T16:58:08.000Z (over 6 years ago)
- Last Synced: 2024-10-13T22:06:11.068Z (24 days ago)
- Topics: eslint, eslint-plugin
- Language: JavaScript
- Size: 278 KB
- Stars: 9
- Watchers: 4
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: license
Awesome Lists containing this project
README
# eslint-plugin-wyze
[![Build Status][travis-image]][travis-url]
[![npm][npm-image]][npm-url]
[![devDependencies][depsdev-image]][depsdev-url]
> My personal [ESLint](//github.com/eslint/eslint) rules.
## Installation
There is a `peerDependencies` on `eslint`.
```shell
$ npm i --save-dev eslint-plugin-wyze eslint
```
## Usage
### package.json
```js
{
// ...
"eslintConfig": {
"plugins": [
"wyze"
]
}
}
```
### .eslintrc
```js
{
"plugins": [
"wyze"
]
}
```
## Supported Rules
* [func-call-arg-spacing](docs/rules/func-call-arg-spacing.md): Enforces spacing inside function call arguments. _(fixable)_
* [func-params-spacing](docs/rules/func-params-spacing.md): Enforces spacing inside function parameters. _(fixable)_
* [max-file-length](docs/rules/max-file-length.md): Keep files to a maximum length.
* [newline-after-export](docs/newline-after-export.md): Ensures `export` statements are followed by a newline. _(fixable)_
* [sort-destructuring-keys](docs/rules/sort-destructuring-keys.md): Ensures keys are sorted for object destructuring.
* [sort-imports](docs/rules/sort-imports.md): Sorts imports by `named` and `default`. _(fixable)_
* [space-around-conditional](docs/rules/space-around-conditional.md): Always put spacing around your conditional expressions. _(fixable)_
## Recommended Config
We support a recommended config for the rules.
### Enable
```js
{
"extends": "plugin:wyze/recommended",
"plugins": [
"wyze"
]
}
```
### Rules
```js
{
"rules": {
"wyze/func-call-arg-spacing": "error",
"wyze/func-params-spacing": "error",
"wyze/max-file-length": "error",
"wyze/newline-after-export": "error",
"wyze/sort-destructuring-keys": "error",
"wyze/sort-imports": "error",
"wyze/space-around-conditional": "error"
}
}
```
## Change Log
> [Full Change Log](changelog.md)
### [v3.4.0](https://github.com/wyze/eslint-plugin-wyze/releases/tag/v3.4.0) (2018-07-11)
* [[`409135348d`](https://github.com/wyze/eslint-plugin-wyze/commit/409135348d)] - Fix `sort-imports` auto-fix with TypeScript parser (#24) (Justin Anastos)
* [[`ef1fb7b259`](https://github.com/wyze/eslint-plugin-wyze/commit/ef1fb7b259)] - Add support for default values (#21) (Jakub Rożek)
* [[`aea583cbd3`](https://github.com/wyze/eslint-plugin-wyze/commit/aea583cbd3)] - Update code to reflect new lint rules (Neil Kistner)
* [[`8281a343f7`](https://github.com/wyze/eslint-plugin-wyze/commit/8281a343f7)] - Upgrade dependencies and remove prelint command (Neil Kistner)
* [[`18ec073bf2`](https://github.com/wyze/eslint-plugin-wyze/commit/18ec073bf2)] - Drop support for Node 4 (Neil Kistner)
## License
MIT © [Neil Kistner](https://neilkistner.com)
[travis-image]: https://img.shields.io/travis/wyze/eslint-plugin-wyze.svg?style=flat-square
[travis-url]: https://travis-ci.org/wyze/eslint-plugin-wyze
[npm-image]: https://img.shields.io/npm/v/eslint-plugin-wyze.svg?style=flat-square
[npm-url]: https://npmjs.com/package/eslint-plugin-wyze
[depsdev-image]: https://img.shields.io/david/dev/wyze/eslint-plugin-wyze.svg?style=flat-square
[depsdev-url]: https://david-dm.org/wyze/eslint-plugin-wyze?type=dev