https://github.com/fxwiegand/jpf

Pretty format all you json files at once in place with three characters
https://github.com/fxwiegand/jpf

format json pretty

Last synced: about 1 month ago
JSON representation

Pretty format all you json files at once in place with three characters

• Host: GitHub
• URL: https://github.com/fxwiegand/jpf
• Owner: fxwiegand
• License: mit
• Created: 2022-05-30T13:50:10.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-09-27T10:24:52.000Z (over 2 years ago)
• Last Synced: 2025-04-19T22:12:50.910Z (about 2 months ago)
• Topics: format, json, pretty
• Language: Python
• Homepage:
• Size: 15.6 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# jpf

[![Conda Recipe](https://img.shields.io/badge/recipe-jpf-green.svg)](https://anaconda.org/conda-forge/jpf)

[![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/jpf.svg)](https://anaconda.org/conda-forge/jpf)

[![Conda Version](https://img.shields.io/conda/vn/conda-forge/jpf.svg)](https://anaconda.org/conda-forge/jpf)

![License](https://img.shields.io/github/license/fxwiegand/jpf)

![PyPI](https://img.shields.io/pypi/v/jpf)

![PyPI - Downloads](https://img.shields.io/pypi/dm/jpf)

Pretty format all your json files at once in place with three characters

## Usage

```jpf```

Just typing in the three magic characters will pretty format all your `*.json` files in the current folder and all subfolders. Using the `--file` option specific files with other suffixes can be formatted as well. 

Since the command is recursive `jpf` should be used with caution.

## Options

`jpf` comes with some options to further customise the formatting of your files:

| argument      | short | default | function                                              |

|---------------|-------|---------|-------------------------------------------------------|

| `--help`      | `-h`  |         | show this help message and exit                       |

| `--indent`    | `-i`  | 4       | format files with that indent level                   |

| `--sort-keys` | `-s`  | False   | decide whether jpf should sort the keys               |

| `--file`      | `-f`  |         | format file under given path unaffected by its suffix |

## Installation

### pip

`jpf` is as very simple to install using pip:

```pip install jpf```

### conda

Alternatively `jpf` can be installed using conda:

```conda install -c conda-forge jpf```