# @ikscodes/prettier-config

> An opinionated Prettier config.

Latest version **3.0.1** (published 2023-08-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install @ikscodes/prettier-config
pnpm add @ikscodes/prettier-config
yarn add @ikscodes/prettier-config
bun add @ikscodes/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 | 3.0.1 |
| Published | 2023-08-29 |
| First published | 2020-01-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ian K Smith |
| Maintainers | smithki |
| Keywords | prettier |

## Links

- npm: https://www.npmjs.com/package/@ikscodes/prettier-config
- Repository: https://github.com/smithki/prettier-config
- Homepage: https://github.com/smithki/prettier-config#readme
- Issues: https://github.com/smithki/prettier-config/issues
- npm.io page: https://npm.io/package/@ikscodes/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

- 3.0.1 (latest) — 2023-08-29
- 3.0.0 — 2023-08-29
- 2.2.0 — 2022-04-26
- 2.0.2 — 2021-12-29
- 2.0.1 — 2020-11-23
- 2.0.0 — 2020-06-23
- 1.0.0 — 2020-02-20
- 0.1.0 — 2020-01-20

## README

# 💅 prettier-config

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://github.com/prettier/prettier)

> An opinionated [Prettier config](https://prettier.io/).

## 🔗 Getting Started

### Install via NPM or Yarn:

Using `npm`:

```sh
npm install @ikscodes/prettier-config --save-dev
```

Using `yarn`:

```sh
yarn add -D @ikscodes/prettier-config
```

### Install required `peerDependencies`:


If using `npm@>7.x`, peer dependencies [will be installed automatically](https://github.blog/2021-02-02-npm-7-is-now-generally-available/), assuming no conflicts arise between peer dependency versions within your project.

If using **`npm@>5.x`**, use this shortcut (`yarn` will be automatically detected, if in use):

```sh
npx install-peerdeps --dev @ikscodes/prettier-config
```

Alternatively, Linux and macOS users can one of these commands:

```sh
# Using NPM:
(
  export PKG=@ikscodes/prettier-config;
  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)
```

```sh
# Using Yarn:
(
  export PKG=@ikscodes/prettier-config;
  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs yarn add -D "$PKG@latest"
)
```

## 🛠️ Usage

If you don't need additional settings or overrides, you can set the `prettier` key in `package.json`:

```javascript
{
  "prettier": "@ikscodes/prettier-config"
}
```

Or, if you need more flexibility, you can use `require` in `.prettierrc.js`:

```javascript
module.exports = {
  ...require('@ikscodes/prettier-config'),
  // ...Override settings ad hoc
}
```

## 🗜️ Versioning

```
+————— Major version is synchronized with Prettier's major version.
| +——— Minor version has BREAKING CHANGES or features.
| | +— Patch version has non-breaking changes.
| | |
x.x.x
```

It's recommended that you pin the version of `@ikscodes/prettier-config` with a [semver tilde (`~`)](https://devhints.io/semver) so as to avoid unintended breaking changes when updating your NPM depedencies.

## ⚖️ License

[MIT](./LICENSE)

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