https://github.com/sholladay/eslint-config-tidy-react

ESLint shareable config for React with Tidy style
https://github.com/sholladay/eslint-config-tidy-react

bugs detect eslint eslint-config eslint-rules fix formatting lint mistakes react style

Last synced: 23 days ago
JSON representation

ESLint shareable config for React with Tidy style

• Host: GitHub
• URL: https://github.com/sholladay/eslint-config-tidy-react
• Owner: sholladay
• License: mpl-2.0
• Created: 2017-06-01T06:40:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-10-04T17:22:06.000Z (about 1 year ago)
• Last Synced: 2024-04-14T00:24:16.370Z (9 months ago)
• Topics: bugs, detect, eslint, eslint-config, eslint-rules, fix, formatting, lint, mistakes, react, style
• Language: JavaScript
• Homepage:
• Size: 74.2 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config-tidy-react [![Build status for ESLint Config Tidy React](https://travis-ci.com/sholladay/eslint-config-tidy-react.svg?branch=master "Build Status")](https://travis-ci.com/sholladay/eslint-config-tidy-react "Builds")

> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) for [React](https://facebook.github.io/react/) with Tidy style

Note that this only enables rules related to React. You probably want to compose this with other configs, such as [eslint-config-tidy](https://github.com/sholladay/eslint-config-tidy) (as shown below), to make your perfect setup.

## Why?

 - Consistency.

 - Clarity.

 - Simplicity.

## Install

```sh

npm install eslint-config-tidy eslint-config-tidy-react eslint-plugin-react --save-dev

```

## Usage

All you have to do is tell your linter to use this config.

### Use with [XO](https://github.com/sindresorhus/xo) (recommended)

Add some XO config to your package.json:

```json

{

    "name": "my-awesome-project",

    "xo": {

        "extend": ["tidy", "tidy-react"]

    }

}

```

### Alternatively, use with [ESLint](https://github.com/eslint/eslint)

Add some ESLint config to your package.json:

```json

{

    "name": "my-awesome-project",

    "eslintConfig": {

        "extends": ["tidy", "tidy-react"]

    }

}

```

## Related

- [eslint-config-tidy](https://github.com/sholladay/eslint-config-tidy) - ESLint shareable config for Tidy style

- [XO](https://github.com/sindresorhus/xo) - Linter based on ESLint

## Contributing

See our [contributing guidelines](https://github.com/sholladay/eslint-config-tidy-react/blob/master/CONTRIBUTING.md "Guidelines for participating in this project") for more details.

1. [Fork it](https://github.com/sholladay/eslint-config-tidy-react/fork).

2. Make a feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. [Submit a pull request](https://github.com/sholladay/eslint-config-tidy-react/compare "Submit code to this project for review").

## License

[MPL-2.0](https://github.com/sholladay/eslint-config-tidy-react/blob/master/LICENSE "License for eslint-config-tidy-react") © [Seth Holladay](https://seth-holladay.com "Author of eslint-config-tidy-react")

Go make something, dang it.