# gatsby-plugin-prettier-build

> prettify gatsby build output

Latest version **0.4.4** (published 2021-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install gatsby-plugin-prettier-build
pnpm add gatsby-plugin-prettier-build
yarn add gatsby-plugin-prettier-build
bun add gatsby-plugin-prettier-build
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.4 |
| Published | 2021-04-05 |
| First published | 2020-04-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 6.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 30 |
| Author | James Vickery |
| Maintainers | jmsv |
| Keywords | prettier, gatsby, gatsbyjs, plugin, gatsby-plugin |

## Links

- npm: https://www.npmjs.com/package/gatsby-plugin-prettier-build
- Repository: https://github.com/jmsv/gatsby-plugin-prettier-build
- Homepage: https://github.com/jmsv/gatsby-plugin-prettier-build#readme
- Issues: https://github.com/jmsv/gatsby-plugin-prettier-build/issues
- npm.io page: https://npm.io/package/gatsby-plugin-prettier-build

## Dependencies (3)

- [p-limit](https://npm.io/package/p-limit.md) ^2.3.0
- [prettier](https://npm.io/package/prettier.md) ^2.0.4
- [tiny-glob](https://npm.io/package/tiny-glob.md) ^0.2.6

## 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
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.4.4 (latest) — 2021-04-05
- 0.4.3 — 2020-04-14
- 0.4.2 — 2020-04-12
- 0.4.1 — 2020-04-10
- 0.4.0 — 2020-04-10
- 0.3.0 — 2020-04-09
- 0.2.0 — 2020-04-08
- 0.1.0 — 2020-04-08

## README

# gatsby-plugin-prettier-build

prettify gatsby build output

[![npm version](https://badge.fury.io/js/gatsby-plugin-prettier-build.svg)](https://badge.fury.io/js/gatsby-plugin-prettier-build)

## Why?

[![wesbos-tweet](https://user-images.githubusercontent.com/14852491/78827410-02ccdb00-79db-11ea-9369-74c0ada99cf4.png)](https://twitter.com/wesbos/status/1247903517051768839)

## Install

```bash
npm install --save gatsby-plugin-prettier-build
# or
yarn add gatsby-plugin-prettier-build
```

## Usage

In `gatsby-config.js` plugins array:

To stick to default options (see defaults below) add:

<!-- prettier-ignore -->
```js
`gatsby-plugin-prettier-build`
```

Or to provide custom options:

```js
{
  resolve: `gatsby-plugin-prettier-build`,
  options: {
    // default values
    types: ['html'],
    concurrency: 20,
    verbose: true
  }
}
```

### Options

#### `types`

> default: `['html']`

Array of filetypes to be prettified after build. Currently supports:

- `js`
- `html`
- `css`

For example, to prettify all supported types: `['html', 'js', 'css']`

#### `verbose`

> default: `true`

Whether or not to log progress to the console

#### `concurrency`

> default: `20`

How many files to prettify at once

You can remove the concurrency limit with `concurrency: Infinity` although this isn't recommended

## Changelog

#### `0.4.4`

- Stop plugin from breaking on prettier failure

#### `0.4.3`

- Add `gatsby-plugin` to package keywords [#2](https://github.com/jmsv/gatsby-plugin-prettier-build/pull/2) (thanks [@KyleAMathews](https://github.com/KyleAMathews))
- Minor docs fix

#### `0.4.2`

- Fix bug where undefined `types` option throws error on `onPreInit` options validation

#### `0.4.1`

- Docs fix

#### `0.4.0`

- Limit prettify concurrency with new `concurrency` option (defaults to `20`)
- Fix issue with counting number of prettified files

#### `0.3.0`

- Prettify files asynchronously with `Promise.all`

#### `0.2.0`

- Replace `glob` with `tiny-glob` (smaller and faster)
- Validate options on `onPreInit` to avoid hitting config problems post-build (saves time if there's a predictable problem)
- `fs.stat` filepaths to make sure they're files - avoids trying to read directories (`page-data` etc.) as files

#### `0.1.0`

Initial version

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