Prettify Bruno Bru Files

A CLI tool to prettify and format Bruno .bru files.

Removes junk and makes code shorter and more transferable between systems. Imposes a standard format on all blocks of JSON and JavaScript code across multiple Bruno .bru files in your project.

body:json and body:graphql:vars blocks are formatted using jsonc-parser

script:pre-request, script:post-response and tests blocks are formatted using Prettier with Babel parser.

body:graphql blocks are formatted using Prettier with GraphQL parser.

Table of contents

• Why use this?
• Style choices
• Feedback
• Installation
• How to use prettify-bru
  • Basic report
  • Fixing the files
  • Limit to one directory
  • Limit to one file
  • Limit to only a subset of blocks
  • Complex example
• Config file
  • Agnostic File Paths
  • Shorten Getters
  • Prettier
• Automatically checking PRs

Why use this?

If your team uses Git (or similar) to track and share your Bruno collections, nobody wants to waste time discussing cosmetic formatting! Your energy is better spent thinking about the actual tests.

If one person happens to use 4-space indentation but another person uses 2, there is a chance that PRs descend into a tug of war over time; Each subsequent pull request undoing the previous persons indentation, leading to dozens of unnecessary cosmetic changes that distract the reviewer from focussing on the important changes that actually have a material impact on what is being tested.

Style choices

Bruno desktop app is somewhat opinionated about code style, the JSON body input has a "Prettify" button which reformats using 2-space indentation, so this project has followed its lead.

There is no adjacent option to reformat the Script or Tests tabs, so for JavaScript I've selected a default set of options which I think most closely align with a QAer's requirements... familiar and short.

For JavaScript I've gone with the same 2-space indentation as JSON, no semicolons at the end of lines for cleanliness and double-quotes for strings so you can copy and paste chunks between JavaScript and JSON without having to change all the quotes.

You can configure your project to override any of these options, see the Config file section below.

Feedback

I have developed this package in my free time to help all the QA people living through the industry transition from being manual testers to becoming Test Engineers. If you're suddenly sharing hundreds of Bruno files with teammates, you all need to learn good Git etiquette. Code formatters can remove a lot of the stress.

Please use this package on your team's repos and give me any ideas, feedback or bug reports via the "Issues" tab on the Git repo https://github.com/martinjoiner/prettify-bru

Thanks, Martin

Installation

Requires Node.js 20+

To install in your project, run:

npm i prettify-bru

Boom, now you should be ready to go!

How to use prettify-bru

Basic report

Get a non-destructive report of all files that could potentially be re-formatted by running:

npx prettify-bru

The above command will walk all subdirectories, finding .bru files and display a report. It will not modify the files.

Fixing the files

To actually modify the files, I recommend committing your changes before doing this, add the --write option to the command:

npx prettify-bru --write

⚠️ Including the --write option will modify the files in place, use with caution.

Limit to one directory

To limit the file search to a single subdirectory, provide the path as an argument. For example to search the folder named "speed-tests" do:

npx prettify-bru speed-tests

Limit to one file

Similar to above example, you can also provide a specific filename:

npx prettify-bru speed-tests/get-all.bru

Limit to only a subset of blocks

Use the --only option to operate on a specific block or subset of blocks. For example to only assess the body:json blocks in your files, specify the exact name of the block:

npx prettify-bru --only body:json

Some values target groups of blocks:

• "graphql" will operate on body:graphql and body:graphql:vars
• "script" will do both script:pre-request and script:post-response
• "body" will target all 3 body blocks body:json, body:graphql and body:graphql:vars

Complex example

Fix the formatting of just the body:json block in 1 specific file:

npm prettify-bru --write --only body:json speed-tests/get-all.bru

Config file

Create a .prettifybrurc file containing a JSON object with one or more of the following properties:

Agnostic File Paths

Property: agnosticFilePaths {boolean} (Default: true)

Replaces backslash folder separators in filenames with forward slashes so they work on Windows, Mac and Linux

file: @file(\Images\Memes\3-Spidermen.jpg) @contentType(image/jpeg)

will be changed to...

file: @file(/Images/Memes/3-Spidermen.jpg) @contentType(image/jpeg)

Shorten Getters

Property: shortenGetters {boolean} (Default: true)

Shorten code by replacing uses of getters with property references

expect(res.getStatus()).to.eql(200)
expect(res.getBody().name).to.eql("Dave")

The above will become...

expect(res.status).to.eql(200)
expect(res.body.name).to.eql("Dave")

Prettier

Property: prettier {Object} (Default: {})

The prettier property object can contain overrides for any of the Prettier options.

For example, to increase the line length limit from the default 80 up to 120 characters, your file would contain:

{
    "prettier": {
        "printWidth": 120
    }
}

Note: Config file is supported from version 1.6.0 and above.

Automatically checking PRs

You may want to configure Github workflows to run prettify-bru whenever a pull-request is raised. If the files are all formatted correctly the action will display in green, otherwise it will show as red to indicate the PR needs to be fixed.

This works because the prettify-bru command returns exit code 1 if it finds any files that contain an error or require reformatting. Otherwise it will return exit code 0.

Setup Github Workflows from the "Actions" tab of your repository.