https://github.com/zhike-team/eslint-config-zhike-react

https://github.com/zhike-team/eslint-config-zhike-react

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/zhike-team/eslint-config-zhike-react
• Owner: zhike-team
• License: mit
• Created: 2019-01-11T11:17:31.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-24T07:04:45.000Z (about 6 years ago)
• Last Synced: 2025-01-12T06:04:25.794Z (15 days ago)
• Language: JavaScript
• Size: 9.77 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# eslint-config-zhike-react

## React eslint rules for zhike

![codestyle](https://img.shields.io/badge/codestyle-%40zhike%2Freact-green.svg)

![travis](https://travis-ci.org/zhike-team/eslint-config-zhike-react.svg?branch=master)

![npm](https://img.shields.io/npm/v/@zhike/eslint-config-react.svg)

![npm](https://img.shields.io/npm/v/@zhike/eslint-config-react/next.svg)

![npm](https://img.shields.io/npm/l/@zhike/eslint-config-react.svg)

![npm](https://img.shields.io/npm/dm/@zhike/eslint-config-react.svg)

[![GitHub forks](https://img.shields.io/github/forks/zhike-team/eslint-config-zhike-react.svg?style=social&label=Fork)](https://github.com/zhike-team/eslint-config-zhike-react/fork)

[![GitHub stars](https://img.shields.io/github/stars/zhike-team/eslint-config-zhike-react.svg?style=social&label=Star)](https://github.com/zhike-team/eslint-config-zhike-react)

### An ESLint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) for [Zhike Team](https://github.com/zhike-team) react projects

## Install

```bash

npm install --save-dev @zhike/eslint-config-react

```

or

```bash

yarn add -D @zhike/eslint-config-react

```

## Usage

Shareable configs are designed to work with the `extends` feature of `.eslintrc` files.

You can learn more about

[Shareable Configs](http://eslint.org/docs/developer-guide/shareable-configs) on the

official ESLint website.

To use the Zhike JavaScript Style shareable config, first run this:

```bash

npm install --save-dev @zhike/eslint-config-react\

  @zhike/eslint-config\

  eslint-config-standard\

  eslint-config-standard-react\

  eslint-plugin-standard\

  eslint-plugin-promise\

  eslint-plugin-import\

  eslint-plugin-react\

  eslint-plugin-node\

  eslint

```

Then, add this to your .eslintrc file:

```json

{

  "extends": "@zhike/eslint-config-react"

}

```

You can override settings from the shareable config by adding them directly into your

`.eslintrc` file.

## Badge

You can add a badge to your README.md file now.

With code:

```markdown

![codestyle](https://img.shields.io/badge/codestyle-%40zhike%2Freact-green.svg)

```

It looks like ![codestyle](https://img.shields.io/badge/codestyle-%40zhike%2Freact-green.svg)

## Contribute

[Contribute Guide](./CONTRIBUTING.md)

## License

MIT. Copyright (c) [Zhike](http://www.smartstudy.com).