Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 3.44 KB

README.md

File metadata and controls

85 lines (58 loc) · 3.44 KB

eslint-config-standard-react travis npm downloads javascript style guide

An ESLint Shareable Config for React/JSX support in JavaScript Standard Style

js-standard-style

Install

This module is for advanced users. You probably want to use standard instead :)

npm install eslint-config-standard-react

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.

This Shareable Config adds React and JSX to the baseline JavaScript Standard Style rules provided in eslint-config-standard.

Here's how to install everything you need:

npm install --save-dev @babel/core @babel/eslint-parser eslint-config-standard eslint-config-standard-jsx eslint-config-standard-react eslint-plugin-promise eslint-plugin-import eslint-plugin-node eslint-plugin-react

Then, add this to your .eslintrc file:

{
  "parser": "@babel/eslint-parser",
  "extends": ["standard", "standard-jsx", "standard-react"]
}

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

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

Looking for something easier than this?

The easiest way to use JavaScript Standard Style to check your code is to use the standard package. This comes with a global Node command line program (standard) that you can run or add to your npm test script to quickly check your style.

Badge

Use this in one of your projects? Include one of these badges in your readme to let people know that your code is using the standard style.

js-standard-style

[![js-standard-style](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)

js-standard-style

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/standard/standard)

Learn more

For the full listing of rules, editor plugins, FAQs, and more, visit the main JavaScript Standard Style repo.

License

MIT. Copyright (c) Feross Aboukhadijeh.