# @frntnd/eslint

> A standard Eslint config to get started with

Latest version **1.0.1** (published 2022-05-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @frntnd/eslint
pnpm add @frntnd/eslint
yarn add @frntnd/eslint
bun add @frntnd/eslint
```

Provides the command `frntnd-eslint`.

## 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.0.1 |
| Published | 2022-05-21 |
| First published | 2022-04-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 16 |
| Unpacked size | 11.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Daphne Smit |
| Maintainers | daphnesmit |

## Links

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

## Dependencies (16)

- [eslint](https://npm.io/package/eslint.md) ^8.13.0
- [enquirer](https://npm.io/package/enquirer.md) ^2.3.6
- [commander](https://npm.io/package/commander.md) ^9.2.0
- [eslint-plugin-n](https://npm.io/package/eslint-plugin-n.md) ^14.0.0
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.29.4
- [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.0.0
- [eslint-config-standard](https://npm.io/package/eslint-config-standard.md) ^17.0.0-1
- [eslint-plugin-jsx-a11y](https://npm.io/package/eslint-plugin-jsx-a11y.md) ^6.5.1
- [eslint-plugin-standard](https://npm.io/package/eslint-plugin-standard.md) ^4.1.0
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^5.19.0
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^4.4.0
- [eslint-plugin-testing-library](https://npm.io/package/eslint-plugin-testing-library.md) ^5.3.1
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^5.19.0
- [eslint-plugin-simple-import-sort](https://npm.io/package/eslint-plugin-simple-import-sort.md) ^7.0.0
- [eslint-import-resolver-typescript](https://npm.io/package/eslint-import-resolver-typescript.md) ^2.7.1

## Recent versions

- 1.0.1 (latest) — 2022-05-21
- 1.0.0-develop.2 (develop) — 2022-04-15
- 1.0.0 — 2022-04-15

## README

# ESLint

## Extending ESLint
If you want to use this ESLint configuration in a React project, you can install it with the following steps.

Install the package and ESLint. Just copy this line and paste in your terminal:

```
npm i @frntnd/eslint eslint -D
```

or 

```
yarn add @frntnd/eslint eslint -D
```

Then create a file named .eslintrc.js with following contents in the root folder of your project:
```javascript
module.exports = {
  extends: ['./node_modules/@frntnd/eslint'], 
}
```

You can add linting scripts to your package.json scripts like this:

```json
"scripts": {
  "lint": "eslint src --ext .ts,.tsx,.js,.jsx",
  "lint-fix": "eslint --fix src --ext .ts,.tsx,.js,.jsx"
}
``` 

and then run:
```
npm run lint or npm run lint-fix
```
or
```
yarn lint or yarn lint-fix
```

## Ejecting from ESLint
You can add or overwrite the ESLint rules if you want to.
But if you totally wish to eject from `@frntnd/eslint` run `npx frntnd-eslint eject`

## Autoformatting on save in VSCode
To turn on autoformatting on save in VSCode follow the following guidelines:

- Download the [VSCode ESLint Plugin](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and following the instructions.

- Make sure to change your settings.json in VSCode and add the following lines in the json:

```json
"editor.codeActionsOnSave": {
  "source.fixAll.eslint": true
}
```

- Make sure Prettier is turned off and eslint is set as formatter!

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