https://github.com/echobind/eslint-plugin-echobind

Echobind's recommended eslint settings.
https://github.com/echobind/eslint-plugin-echobind

eslint eslint-config react react-native

Last synced: 3 months ago
JSON representation

Echobind's recommended eslint settings.

• Host: GitHub
• URL: https://github.com/echobind/eslint-plugin-echobind
• Owner: echobind
• Created: 2019-06-07T15:28:43.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-08T18:51:58.000Z (about 2 years ago)
• Last Synced: 2024-04-13T16:15:22.002Z (10 months ago)
• Topics: eslint, eslint-config, react, react-native
• Language: JavaScript
• Homepage:
• Size: 7.06 MB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Test](https://github.com/echobind/eslint-plugin-echobind/actions/workflows/test.yml/badge.svg)](https://github.com/echobind/eslint-plugin-echobind/actions/workflows/test.yml)

# eslint-plugin-echobind

Echobind's recommended eslint rules and configs

## Installation

You'll first need to install [ESLint](http://eslint.org):

```

$ yarn add eslint

```

Next, install `eslint-plugin-echobind`:

```

$ yarn add eslint-plugin-echobind

```

**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-echobind` globally.

## Usage

Eslint configs come bundled with this package. To use one, add it to the extends option in `.eslintrc.js`. For example, the following will use the React config:

```js

module.exports = {

  extends: ["plugin:echobind/react"],

};

```

If working on a Node project, use the node config:

```js

module.exports = {

  extends: ["plugin:echobind/node"],

};

```

## Provided Configs

This plugin provides the following configs:

- [React](./lib/configs/react.js): Use this for React projects with TypeScript

- [NodeJS](./lib/configs/node.js): Use this for Node projects with TypeScript

- [React Native](./lib/configs/react-native.js): Use this for React Native projects with TypeScript