# juan-prettier-config

> Prettier configuration

Latest version **1.0.0** (published 2023-11-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install juan-prettier-config
pnpm add juan-prettier-config
yarn add juan-prettier-config
bun add juan-prettier-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.0.0 |
| Published | 2023-11-11 |
| First published | 2023-11-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Juan Guilherme |
| Maintainers | asjuanguilherme |
| Keywords | prettier, config, prettier-config, format |

## Links

- npm: https://www.npmjs.com/package/juan-prettier-config
- Repository: https://github.com/asjuanguilherme/prettier-config
- Homepage: https://github.com/asjuanguilherme/prettier-config#readme
- Issues: https://github.com/asjuanguilherme/prettier-config/issues
- npm.io page: https://npm.io/package/juan-prettier-config

## 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
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-11-11

## README

# Juan - Prettier Config

## 1. How to install

With npm:

```bash
npm install juan-prettier-config
```

Or with yarn:

```bash
yarn add juan-prettier-config
```

## 2. Create a Prettier configuration file

Create a file named `.prettierrc.js` or `.prettierrc` at the root of your project and import the configuration from `juan-prettier-config`:

```javascript
// .prettierrc.js or .prettierrc

module.exports = require("juan-prettier-config");
```

Or you can import the configuration file to your package.json file

```json
{
  "prettier": "juan-prettier-config"
}
```

## 3. Add a script to your `package.json` (optional)

Add a script to your `package.json` to make running Prettier easier:

```json
// package.json

{
  "scripts": {
    "format": "prettier --write ."
  }
}
```

Now, you can run `npm run format` or `yarn format` to format your code using the Prettier configuration.

## 4. Run Prettier

Now, you can run Prettier on your code using the following command:

With npm:

```bash
npx prettier --write .
```

Or with yarn:

```bash
yarn prettier --write .
```

This command formats all files in the current directory using the Prettier configuration specified in the `.prettierrc.js` or `.prettierrc` file.

That's essentially all you need to do to start using your `juan-prettier-config` library in your project. Ensure that the files you want to format are in the specified directory or adjust the Prettier command as needed to include the desired files.

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