# eslint-config-neono

> eslint-config-neono

Latest version **0.0.1** (published 2022-02-07) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2022-02-07 |
| First published | 2022-01-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 15 |
| Unpacked size | 229.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Donovan Benfouzari |
| Maintainers | d.benfouzari |
| Keywords | eslint, eslintconfig, config, neono, javascript, styleguide |

## Links

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

## Dependencies (15)

- [semver](https://npm.io/package/semver.md) ^7.3.5
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.16.7
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^7.0.1
- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ^25.3.4
- [@babel/preset-react](https://npm.io/package/@babel/preset-react.md) ^7.16.7
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.28.0
- [@babel/eslint-parser](https://npm.io/package/@babel/eslint-parser.md) ^7.16.5
- [@babel/eslint-plugin](https://npm.io/package/@babel/eslint-plugin.md) ^7.16.5
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.25.4
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^8.3.0
- [eslint-plugin-jest-dom](https://npm.io/package/eslint-plugin-jest-dom.md) ^4.0.1
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^5.9.0
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^4.3.0
- [eslint-plugin-testing-library](https://npm.io/package/eslint-plugin-testing-library.md) ^5.0.1
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^5.9.0

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2022-02-07
- 1.0.3 — 2022-01-05
- 1.0.2 — 2022-01-05
- 1.0.1 — 2022-01-05
- 1.0.0 — 2022-01-05

## README

<div align="center">
<h1>eslint-config-neono</h1>

<p>ESLint rules for all of my personal projects. Feel free to use these conventions :-)</p>
</div>

---

## Table of Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Installation](#installation)
- [Usage](#usage)
  - [Other configs](#other-configs)
  - [Things to know](#things-to-know)
    - [Example of highly customized config](#example-of-highly-customized-config)
- [LICENSE](#license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Installation

This module is distributed via [npm][npm] which is bundled with [node][node] and
should be installed as one of your project's `devDependencies`:

```
npm install --save-dev eslint-config-neono
yarn add -D eslint-config-neono
```

This library has a required `peerDependencies` listing for [`eslint`][eslint]

## Usage

Then add the extends to your `.eslintrc.js`:

```javascript
module.exports = {
  extends: "neono",
  rules: {
    // your overrides
  },
};
```

### Other configs

This config also exposes a few other configs that I use often and pull in as
needed.

You can use them standalone:

```javascript
module.exports = {
  extends: "neono/<config-name>",
};
```

Or in combination with the base config (recommended)

```javascript
module.exports = {
  extends: ["neono", "neono/<config-name>"],
};
```

Config list :

- neono
- neono/jest
- neono/react

**Note**: Due to [this bug](https://github.com/eslint/eslint/issues/3458) you
need to have the associated plugins installed to make things work. I recommend
adding them as dependencies to your project if you're going to use the config
for it.

- `jest`: [jest](http://facebook.github.io/jest/) testing framework
- `jsx-a11y`:
  [eslint-plugin-jsx-a11y](https://github.com/evcohen/eslint-plugin-jsx-a11y)
  for rules regarding accessibility with JSX (_eslint-plugin-jsx-a11y_)
- `react`: [React](https://www.npmjs.com/package/react) JS library
  (_eslint-plugin-react_)
- `@typescript-eslint`:
  [@typescript-eslint/parser](https://www.npmjs.com/package/@typescript-eslint/parser)
  and
  [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin).

### Things to know

- The default config uses `@babel/eslint-parser` to support stage features that
  ESLint doesn't support and it opts to use the `@babel/eslint-plugin` rules
  over the ESLint rules to support rules for these features as well.
- All plugins needed for rules used by these configs are dependencies of this
  module so you don't have to install anything on your own.
- The default config actually is composed of several configurations and you can
  use those individually. These are the configs it's using:
  `possible-errors.js`, `best-practices.js`, `stylistic.js`, `es6/index.js`, and
  `import/index.js`. You can use each of these configs yourself if you want to
  leave my own personal style out of it. Also, the `es6` and `import` configs
  each have a `possible-errors.js`, `best-practices.js`, and `stylistic.js`
  which they are composed of as well.

#### Example of highly customized config

```javascript
module.exports = {
  extends: [
    "neono/possible-errors",
    "neono/best-practices",
    "neono/es6/possible-errors",
    "neono/import",
    "neono/jest",
  ],
  rules: {
    /* custom rules */
  },
};
```

[//]: #
[//]: # "## Issues"
[//]: #
[//]: # "_Looking to contribute? Look for the [Good First Issue][good-first-issue]"
[//]: # "label._"
[//]: #
[//]: # "### 🐛 Bugs"
[//]: #
[//]: # "Please file an issue for bugs, missing documentation, or unexpected behavior."
[//]: #
[//]: # "[**See Bugs**][bugs]"
[//]: #
[//]: # "### 💡 Feature Requests"
[//]: #
[//]: # "Please file an issue to suggest new features. Vote on feature requests by adding"
[//]: # "a 👍. This helps maintainers prioritize what to work on."
[//]: #
[//]: # "[**See Feature Requests**][requests]"

## LICENSE

MIT

<!-- prettier-ignore-start -->
[npm]: https://www.npmjs.com
[node]: https://nodejs.org
[eslint]: https://github.com/eslint/eslint
<!-- prettier-ignore-end -->

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