express-prettier

1.0.3 • Public • Published

express-prettier

A simple and lightweight beautifier plugin for Express.

NPM

express-prettier has support of beautifying payloads via query parameter to make responses more readable for developers/humans. The plugin itself uses prettier under the hood and is capable of parsing/formatting anything that prettier can.

express-prettier registers itself as an express middleware to beautify the response payload before it gets sent.

Note: streams and buffers are excluded in beautification process.

Options

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
prettierOpts object { tabWidth: 2, parser: 'json-stringify' } Please take a look prettier official documentation for more information

Examples

// get required modules
const app = require('express')()
const expressPrettier = require('express-prettier')

// register express-prettier plugin
app.use(
  expressPrettier(
    { fallbackOnError: false }
  )
)

// test express server route
app.get('/', (req, res) => {
  // create an object
  const obj = {
    blackLivesMatter: true,
    favSinger: 'Ahmet Kaya'
  }

  // set return type
  res.setHeader('content-type', 'application/json')

  // return the object
  res.send(obj)
})

// initialize the express server
app.listen(3000, () => {
  console.log('Express 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 express-prettier plugin
app.use(
  expressPrettier(
    {
      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 express-prettier plugin
app.use(
  expressPrettier(
    { alwaysOn: true }
  )
)

// -------------------------------

// http://localhost:3000 -> will print out below result
/*
{
  "blackLivesMatter": true,
  "favSinger": "Ahmet Kaya"
}
*/

Installation

npm install express-prettier

Contribution

Contributions and pull requests are kindly welcomed!

License

This project is licensed under the terms of the MIT license.

Package Sidebar

Install

npm i express-prettier

Weekly Downloads

4

Version

1.0.3

License

MIT

Unpacked Size

25.2 kB

Total Files

8

Last publish

Collaborators

  • hsynlms