# eslint-config-jsx

> ESLint shareable config for Suraj's JSX Codeguide

Latest version **2.0.2** (published 2021-03-16) · ISC license · 0 weekly downloads

## Install

```sh
npm install eslint-config-jsx
pnpm add eslint-config-jsx
yarn add eslint-config-jsx
bun add eslint-config-jsx
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2021-03-16 |
| First published | 2020-11-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 32.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Suraj Sharma |
| Maintainers | surajs02 |

## Links

- npm: https://www.npmjs.com/package/eslint-config-jsx
- Repository: https://github.com/surajs02/eslint-config-jsx
- Homepage: https://github.com/surajs02/eslint-config-jsx#readme
- Issues: https://github.com/surajs02/eslint-config-jsx/issues
- npm.io page: https://npm.io/package/eslint-config-jsx

## Dependencies (7)

- [eslint](https://npm.io/package/eslint.md) ^7.13.0
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.12.3
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.21.5
- [@babel/eslint-parser](https://npm.io/package/@babel/eslint-parser.md) ^7.12.1
- [@babel/eslint-plugin](https://npm.io/package/@babel/eslint-plugin.md) ^7.12.1
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^4.15.1
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^4.15.1

## Recent versions

- 2.0.2 (latest) — 2021-03-16
- 2.0.1 — 2021-03-16
- 2.0.0 — 2021-03-13
- 1.0.2 — 2020-11-14
- 1.0.1 — 2020-11-14
- 1.0.0 — 2020-11-14

## README

# eslint-config-jsx

ESLint shareable config based on [JSX Codeguide] where relevant eslint rules extend recommended eslint/react/typescript rules whilst enforcing the codeguide to improve code maintainability for JS/JSX & TS/TSX projects.

## Installation
Ensure eslint is installed before installing this package:
```bash
npm install -D eslint eslint-config-jsx
```

Peer dependency details (i.e., all must be public hence available to eslint):
- `eslint`: Base linting
- `@babel/core`: ES6+ linting
- `@babel/eslint-parser`: Base (non-experimental) JS linting
- `@babel/eslint-plugin`: Experimental ES6+ linting
- `eslint-plugin-react`: React linting
- `@typescript-eslint/parser`: Base TS linting
- `typescript-eslint/eslint-plugin`: TS linting

Install peer dependencies:
```bash
npx install-peerdeps --dev eslint-config-jsx
```

## Usage
Add this package's name to the `extends` section of your project's `.eslintrc.js` config file:

```js
modules.exports = {
  extends: ['eslint-config-jsx'],
  rules: {
    // Override JS rules, e.g.:
    // 'no-extra-semi': ['warn'],
  }
  overrides: [
    {
      files: ['**/*.ts', '**/*.tsx'],
      rules: {
        // Override TS rules, e.g.:
        // '@typescript-eslint/no-extra-semi': ['warn'],
      },
    },
  ],
};
```

## Contributing

Contributions should follow [JSX Codeguide] (styleguide changes can be requested via an issue at [JSX Codeguide]).

New plugins should be installed locally & moved to the `peerDependencies`.

[JSX Codeguide]: https://github.com/surajs02/jsx-codeguide

---
_Source: https://npm.io/package/eslint-config-jsx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._