Skip to main content
Community Plugin
View plugin on GitHub
See starters using this

gatsby-plugin-prettier-build

prettify gatsby build output

npm version

Why?

wesbos-tweet

Install

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:

`gatsby-plugin-prettier-build`

Or to provide custom options:

{
  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.3

  • Add gatsby-plugin to package keywords #2 (thanks @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

Docs
Tutorials
Plugins
Blog
Showcase