Using jq with clipboard for JSON formatting on macOS and Linux

Clipboard JSON Formatting with jq

The article details a method for formatting JSON data stored in the system clipboard using the command-line tool `jq`. This utility is commonly used for processing JSON data, and this specific application focuses on its pretty-printing capabilities.

Platform-Specific Implementations

For macOS users, the solution utilizes `pbpaste` to retrieve clipboard content and `pbcopy` to place the formatted output back into the clipboard. The initial alias provided is `jsontidy="pbpaste | jq '.' | pbcopy"`.

Linux users can adapt this functionality by substituting `xclip` for the macOS-specific commands. The equivalent command for Linux is `xclip -selection clipboard -o | jq '.' | xclip -selection clipboard`.

Robust Error Handling

A key improvement introduced is error handling. Without it, if the clipboard content is not valid JSON, `jq` would exit with an error, and the clipboard would be overwritten with an empty string. The enhanced alias addresses this by ensuring the original clipboard content is retained if `jq` fails to parse the input.

The refined alias for Linux, incorporating error handling, is `alias jsontidy="xclip -selection clipboard -o | (jq '.' || xclip -selection clipboard -o) | xclip -selection clipboard"`. This command attempts to format the JSON; if it fails, it passes the original clipboard content through, preventing data loss.

Impact for Developers

This technique provides developers with a convenient and efficient way to quickly format JSON data they encounter, such as API responses or configuration files, directly from their clipboard without needing to save it to a file or use a separate application. The error handling ensures that the process is non-destructive even when dealing with non-JSON text.