Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
fastify-prettier
Advanced tools
A simple and lightweight beautifier plugin for Fastify.
fastify-prettier
has support of beautifying payloads via query parameter to make responses more readable for developers/humans. Decoratorprettier
can also be used anywhere in the fastify server as the content 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 in beautification process.
Note: fastify v3
compatibility shipped with v1.1.5
Name | Type | Default | Description |
---|---|---|---|
alwaysOn | boolean | false | To make all the payloads beautified in anyway |
fallbackOnError | boolean | true | If something bad happens, send the original payload. If its false , an error will be thrown |
overrideContentLength | boolean | true | Re-calculate content-length header for the beautified response |
query | object | { name: 'pretty', value: 'true' } | The query parameter that triggers the plugin to beautify the outgoing payload |
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' } | Please take a look prettier official documentation for more information |
Feel free to use prettier
decorator which beautifies the given content through the provided options whenever you need.
// 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' }
)
// 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 the query parameter option.
// 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 beautification for all outgoing payloads regardless the query parameter.
// register fastify-prettier plugin
fastify.register(
fastifyPrettier,
{
alwaysOn: true
}
)
// -------------------------------
// http://localhost:3000 -> will print out below result
/*
{
"blackLivesMatter": true,
"favSinger": "Ahmet Kaya"
}
*/
npm install fastify-prettier
Contributions and pull requests are kindly welcomed!
This project is licensed under the terms of the MIT license.
FAQs
a simple and lightweight beautifier plugin for Fastify.
We found that fastify-prettier demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.