@zhike/eslint-config

eslint-config-zhike

Eslint rules for zhike

An ESLint Shareable Config for Zhike Team

Install

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

or

yarn add -D @zhike/eslint-config

Usage

Shareable configs are designed to work with the extends feature of .eslintrc files. You can learn more about Shareable Configs on the official ESLint website.

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

npm install --save-dev @zhike/eslint-config\
  eslint-config-standard\
  eslint-plugin-standard\
  eslint-plugin-promise\
  eslint-plugin-import\
  eslint-plugin-node
  eslint

Then, add this to your .eslintrc file:

{
  "extends": "@zhike"
}

Note: We omitted the /eslint-config suffix since it is automatically assumed by ESLint.

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:

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

It looks like

Contribute

Contribute Guide

License

MIT. Copyright (c) Zhike.