# setup-eslint-prettier

> This will bootstrap the setup of ESlint, Prettier and Airbnb rules for ESlint

Latest version **2.1.2** (published 2023-07-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install setup-eslint-prettier
pnpm add setup-eslint-prettier
yarn add setup-eslint-prettier
bun add setup-eslint-prettier
```

Provides the command `setup-eslint-prettier`.

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.2 |
| Published | 2023-07-13 |
| First published | 2023-07-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Lucas Gomes |
| Maintainers | lucaas27 |

## Links

- npm: https://www.npmjs.com/package/setup-eslint-prettier
- npm.io page: https://npm.io/package/setup-eslint-prettier

## Dependencies (1)

- [inquirer](https://npm.io/package/inquirer.md) ^9.2.8

## Recent versions

- 2.1.2 (latest) — 2023-07-13
- 2.1.1 — 2023-07-13
- 2.1.0 — 2023-07-13
- 1.0.0 — 2023-07-13

## README

<!-- <div align="center" id="top">
  <img src="./.github/app.gif" alt="Setup Eslint Prettier" />

&#xa0;

</div> -->

<h1 align="center">Setup Eslint Prettier</h1>

<p align="center">
  <img alt="Github top language" src="https://img.shields.io/github/languages/top/Lucaas27/setup-eslint-prettier?color=56BEB8">

  <img alt="Github language count" src="https://img.shields.io/github/languages/count/Lucaas27/setup-eslint-prettier?color=56BEB8">

  <img alt="Repository size" src="https://img.shields.io/github/repo-size/Lucaas27/setup-eslint-prettier?color=56BEB8">

  <img alt="License" src="https://img.shields.io/github/license/Lucaas27/setup-eslint-prettier?color=56BEB8">

  <!-- <img alt="Github issues" src="https://img.shields.io/github/issues/Lucaas27/setup-eslint-prettier?color=56BEB8" /> -->

  <!-- <img alt="Github forks" src="https://img.shields.io/github/forks/Lucaas27/setup-eslint-prettier?color=56BEB8" /> -->

  <!-- <img alt="Github stars" src="https://img.shields.io/github/stars/Lucaas27/setup-eslint-prettier?color=56BEB8" /> -->
</p>

<!-- Status -->

<!-- <h4 align="center">
	🚧  Setup Eslint Prettier 🚀 Under construction...  🚧
</h4>

<hr> -->

<p align="center">
  <a href="#dart-about">About</a> &#xa0; | &#xa0; 
  <a href="#white_check_mark-requirements">Requirements</a> &#xa0; | &#xa0;
  <a href="#checkered_flag-starting">Starting</a> &#xa0; | &#xa0;
  <a href="#memo-license">License</a> &#xa0; | &#xa0;
  <a href="https://github.com/Lucaas27" target="_blank">Author</a>
</p>

<br>

## :dart: About

This npm package will bootstrap the set up of prettier and ESlint for a project.
It assumes your project is using ECMAScript modules.
It will also create .editorconfig and .prettierrc files with some rules. These rules can all be customised.

This is intended for my personal use but feel free to use it. It has some prettier and ESlint rules (airbnb) set up.
You can also choose between a React project of just Node.
The difference will be that the react option comes with an ESlint plugin for react.

## :white_check_mark: Requirements

Before starting :checkered_flag:, you need to have [Node](https://nodejs.org/en/) installed.

## :checkered_flag: Starting

You can run this package with npx - This will let you execute the package without the need to install it locally.
This is the preferred way to run it.

```bash

$ npx setup-eslint-prettier

```

Install the package locally

```bash
$ npm install -D setup-eslint-prettier

```

Both commands need to be run from the root directory of your node project.

## :memo: License

This project is under license from MIT. For more details, see the [LICENSE](LICENSE) file.

Made with :heart: by <a href="https://github.com/Lucaas27" target="_blank">Lucas Gomes</a>

&#xa0;

<a href="#top">Back to top</a>

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