Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmsv/gatsby-plugin-prettier-build
prettify gatsby build output
https://github.com/jmsv/gatsby-plugin-prettier-build
gatsby gatsby-plugin gatsbyjs hacktoberfest javascript prettier
Last synced: 3 months ago
JSON representation
prettify gatsby build output
- Host: GitHub
- URL: https://github.com/jmsv/gatsby-plugin-prettier-build
- Owner: jmsv
- License: mit
- Created: 2020-04-08T17:39:05.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-05T20:23:08.000Z (almost 4 years ago)
- Last Synced: 2024-10-13T18:06:56.355Z (3 months ago)
- Topics: gatsby, gatsby-plugin, gatsbyjs, hacktoberfest, javascript, prettier
- Language: JavaScript
- Homepage: https://npm.im/gatsby-plugin-prettier-build
- Size: 30.3 KB
- Stars: 30
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gatsby-plugin-prettier-build
prettify gatsby build output
[](https://badge.fury.io/js/gatsby-plugin-prettier-build)
## Why?
[](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:
```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