# @alquipo/eslint-config

> ESLint configuration used by Alquipo projects.

Latest version **1.4.0** (published 2022-12-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @alquipo/eslint-config
pnpm add @alquipo/eslint-config
yarn add @alquipo/eslint-config
bun add @alquipo/eslint-config
```

## 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 | 1.4.0 |
| Published | 2022-12-14 |
| First published | 2022-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 16 |
| Unpacked size | 8.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Alquipo neto |
| Maintainers | alquipo |

## Links

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

## Dependencies (16)

- [eslint](https://npm.io/package/eslint.md) ^8.29.0
- [prettier](https://npm.io/package/prettier.md) ^2.8.1
- [eslint-plugin-n](https://npm.io/package/eslint-plugin-n.md) ^15.6.0
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.31.11
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.26.0
- [eslint-plugin-promise](https://npm.io/package/eslint-plugin-promise.md) ^6.1.1
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^8.5.0
- [eslint-config-standard](https://npm.io/package/eslint-config-standard.md) ^17.0.0
- [eslint-plugin-jsx-a11y](https://npm.io/package/eslint-plugin-jsx-a11y.md) ^6.6.1
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^4.2.1
- [eslint-plugin-storybook](https://npm.io/package/eslint-plugin-storybook.md) ^0.6.8
- [@next/eslint-plugin-next](https://npm.io/package/@next/eslint-plugin-next.md) ^13.0.6
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^5.46.1
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^4.6.0
- [eslint-plugin-import-helpers](https://npm.io/package/eslint-plugin-import-helpers.md) ^1.3.1
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^5.46.1

## Recent versions

- 1.4.0 (latest) — 2022-12-14
- 1.3.2 — 2022-11-14
- 1.3.1 — 2022-11-14
- 1.2.5 — 2022-10-13
- 1.2.4 — 2022-10-13
- 1.2.3 — 2022-10-13
- 1.0.1 — 2022-10-12

## README

<div align="center">
  <a href="https://eslint.org/">
    <img height="150" src="https://eslint.org/assets/images/logo/eslint-logo-color.svg">
  </a>

  <h1>@alquipo/eslint-config </h1>
</div>

<p align="center">

  <img alt="GitHub language count" src="https://img.shields.io/github/languages/count/Alquipo/eslint-config">

  <img alt="Repository size" src="https://img.shields.io/github/repo-size/Alquipo/eslint-config">

  <a href="https://www.linkedin.com/in/alquiponeto/">
      <img alt="Made by Alquipo" src="https://img.shields.io/badge/made%20by-AlquipoNeto-blue">
  </a>

  <a href="https://github.com/Alquipo/eslint-config/commits/master">
      <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/Alquipo/eslint-config?color=blue">
  </a>

  <img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen?color=blue">

  <img alt="CI Workflow" src="https://github.com/Alquipo/eslint-config/actions/workflows/release-package.yml/badge.svg">

</p>

## Whats included?

- Standard config base;
- React plugin;
- React Hooks plugin;
- JSX a11y plugin;
- Prettier;
- Import plugin
- Import Helpers plugin
- Storybook plugin
- Next plugin

### Install

First, install it:

```bash
$ npm install --save-dev eslint @alquipo/eslint-config 
```
or

```bash
$ yarn add -D eslint @alquipo/eslint-config 
```

### Usage

Add `@alquipo/eslint-config ` to the extends section of your `.eslintrc` or `package.json` file. 

##### React Project 

```json
{
  "extends": "@alquipo/eslint-config/react"
}
```

or

```json
{
   "scripts": {
      "lint": "eslint"
  },
  "devDependencies": {
    "eslint": "^8.25.0",
    "@alquipo/eslint-config": "^1.0.1"
  },
  "eslintConfig": {
    "extends": "@alquipo/eslint-config/react"
  },
}
```
##### Next Project 

```json
{
  "extends": "@alquipo/eslint-config/next"
}
```
or


```json
{
   "scripts": {
      "lint": "next lint"
  },
  "devDependencies": {
    "eslint": "^8.25.0",
    "@alquipo/eslint-config": "^1.0.1"
  },
  "eslintConfig": {
    "extends": "@alquipo/eslint-config/next"
  },
}
```

## 🤔 How to contribute to the project

- Make a **fork**;
- Create a new branch with your changes: `git checkout -b my-feature`
- Save the changes and create a commit message telling what you've done:`git commit -m "feature: My new feature"`
- Submit your changes: `git push origin my-feature`

> If you have any questions, check out this [guide on how to contribute on GitHub](https://github.com/firstcontributions/first-contributions)

## 📝 License

This project is MIT [Licensed](https://opensource.org/licenses/MIT).

Made with ❤️ by Alquipo Neto 👋🏽 [Contact!](https://www.linkedin.com/in/alquiponeto/)

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