fastify-prettier
A simple and lightweight beautifier plugin for Fastify.
fastify-prettier has support of beautifying responses via query parameter by default to make responses more readable for developers/humans. prettier decorator can also be used anywhere in the fastify server as beautifier. The plugin itself uses prettier under the hood and is capable of parsing/formatting anything that prettier can.
fastify-prettier uses onSend fastify hook to beautify the response/payload before it gets sent.
Note: streams and buffers are excluded for beautification by default.
Options
| Name | Type | Default | Description |
|---|---|---|---|
| alwaysOn | boolean | false | To make all responses beautified automatically in anyway |
| fallbackOnError | boolean | true | If something bad happens while beautifying, fallback/send previous response/payload. If its false, error will be thrown |
| overrideContentLength | boolean | true | Re-calculate content-length header for new beautified response/payload |
| query | object | { name: 'pretty', value: 'true' } |
Request query parameter that triggers the plugin for the beautified response. It works when alwaysOn is disabled |
| enableOnSendHook | boolean | true | Allow the plugin to get injected into fastify onSend hook to beautify outgoing responses. The prettier decorator can still be used even if that option is disabled |
| prettierOpts | object | { tabWidth: 2, parser: 'json-stringify' } |
Prettier plugin options. Please take a look prettier official documentation for more information |
Decorator
Feel free to use prettier decorator which beautifies the given content through given prettier options whenever you need in anywhere in the fastify server.
// example of using prettier decorator
const response = fastify.prettier(
// content type can be: boolean, number, object, array, string
content,
// prettier options (please see: prettierOpts)
{ parser: 'html', htmlWhitespaceSensitivity: 'ignore' }
)Examples
// get required modules
const fastify = require('fastify')()
const fastifyPrettier = require('fastify-prettier')
// register fastify-prettier plugin
fastify.register(
fastifyPrettier,
{
fallbackOnError: false
}
)
// test fastify server route
fastify.get('/', (req, reply) => {
// create an object
const obj = {
blackLivesMatter: true,
favSinger: 'Ahmet Kaya'
}
// set return type
reply.type('application/json')
// return the object
reply.send(obj)
})
// initialize the fastify server
fastify.listen(3000, () => {
console.log('Fastify server is running on port: 3000')
})
// -------------------------------
// http://localhost:3000 -> will print out below result
/*
{"blackLivesMatter":true,"favSinger":"Ahmet Kaya"}
*/
// http://localhost:3000?pretty=true -> will print out below result
/*
{
"blackLivesMatter": true,
"favSinger": "Ahmet Kaya"
}
*/You are allowed to change query parameter name and value as you desire.
// register fastify-prettier plugin
fastify.register(
fastifyPrettier,
{
query: {
name: 'beautify',
value: 'yes'
}
}
)
// -------------------------------
// http://localhost:3000 -> will print out below result
/*
{"blackLivesMatter":true,"favSinger":"Ahmet Kaya"}
*/
// http://localhost:3000?beautify=yes -> will print out below result
/*
{
"blackLivesMatter": true,
"favSinger": "Ahmet Kaya"
}
*/You can enable beautifier for all outgoing responses regardless query parameter when the plugin is registered in fastify.
// register fastify-prettier plugin
fastify.register(
fastifyPrettier,
{
alwaysOn: true
}
)
// -------------------------------
// http://localhost:3000 -> will print out below result
/*
{
"blackLivesMatter": true,
"favSinger": "Ahmet Kaya"
}
*/Installation
npm install fastify-prettier
Contribution
Contributions and pull requests are kindly welcomed!
License
This project is licensed under the terms of the MIT license.
