Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kanmu/eslint-config
ESLint configurations for Kanmu.
https://github.com/kanmu/eslint-config
frontend
Last synced: about 2 months ago
JSON representation
ESLint configurations for Kanmu.
- Host: GitHub
- URL: https://github.com/kanmu/eslint-config
- Owner: kanmu
- Created: 2015-08-17T04:03:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-09-07T23:53:27.000Z (over 1 year ago)
- Last Synced: 2024-10-13T17:09:51.475Z (2 months ago)
- Topics: frontend
- Language: JavaScript
- Homepage:
- Size: 126 KB
- Stars: 1
- Watchers: 27
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eslint-config-kanmu
[![NPM version][npm-image]][npm-url]
[![Build Status][github-actions-image]][github-actions-url]
[![License][license-image]][license-url]
ESLint configurations for Kanmu.
## Installation
```
npm install --save-dev eslint eslint-config-kanmu
```
## Usage
Add `.eslintrc` (YAML).
### Summary
- **Base**
- `kanmu`: ES2015
- `kanmu/es5`: ES5
- **Optional**
- `kanmu/browser`: Browser env
- `kanmu/flow`: for Flow
- `kanmu/flow-jsdoc`: for JSDoc and Flow
- `kanmu/node`: for Node.js env
- `kanmu/react`: for React
- `kanmu/react-native`: for React Native
- `kanmu/mocha`: for Testing mocha
### Examples
#### ES6 (Node.js)
```yaml
extends:
- kanmu
- kanmu/node
```
#### ES5 (Browser)
```yaml
extends:
- kanmu/es5
- kanmu/browser
```
#### React
```yaml
extends:
- kanmu
- kanmu/browser
- kanmu/react
```
##### Additional Requirements
```
npm install --save-dev eslint-plugin-react
```
#### React Native
```yaml
extends:
- kanmu
- kanmu/react-native
```
##### Additional Requirements
```
npm install --save-dev eslint-plugin-react eslint-plugin-react-native
```
#### React Native with Flow
```yaml
extends:
- kanmu
- kanmu/react-native
- kanmu/flow
- kanmu/flow-jsdoc
```
##### Additional Requirements
```
npm install --save-dev eslint-plugin-flowtype eslint-plugin-jsdoc eslint-plugin-react eslint-plugin-react-native eslint-plugin-import
```
[npm-url]: https://www.npmjs.com/package/eslint-config-kanmu
[npm-image]: https://img.shields.io/npm/v/eslint-config-kanmu.svg
[github-actions-url]: https://github.com/kanmu/eslint-config/actions/workflows/ci.yml
[github-actions-image]: https://github.com/kanmu/eslint-config/actions/workflows/ci.yml/badge.svg?branch=master
[license-url]: http://opensource.org/licenses/MIT
[license-image]: https://img.shields.io/npm/l/eslint-config-kanmu.svg