[![Build Status](https://dev.azure.com/morpork73/pitufo/_apis/build/status/ian-hamlin.pitufo?branchName=master)](https://dev.azure.com/morpork73/pitufo/_build/latest?definitionId=10&branchName=master)
![crates.io](https://img.shields.io/crates/v/pitufo.svg)

# pitufo

A small application that will walk the given path and replace the content of every json file found.  The file will either be prettified or minified.

## Latest Release

[Latest Release Page][latest-release]

## Downloads

* [x86_64-apple-darwin.zip][mac-release]
* [x86_64-pc-windows-msvc.zip][windows-release]
* [x86_64-unknown-linux-musl.zip][linux-release]

## Installation

pitufo can be installed via cargo.

```console
cargo install pitufo
```

## Usage

```console
Usage: pitufo [--follow] [--verbose] [--minify] [--bom] [-m <max-depth>] -p <path>

Options:
  --follow          follow symbolic links, the default is to not follow.
  --verbose         verbose mode, output the path of every file found, defaults
                    to silent
  --minify          minify the json, the default is to prettify.
  --bom             look for leading BOM in json files and remove if found, the
                    default is to take the file as-is.
  -m, --max-depth   set the maximum depth to recurse
  -p, --path        the path to search for json files.
  --help            display usage information
```

## Example

recursively walk the path and prettify or minify everything you can find

```console
  ./pitufo /GitHub/verb-data/json
```

```console
  ./pitufo /GitHub/verb-data/json --minify
```

prettify or minify everything you can find *directly* under the path

```console
  ./pitufo /GitHub/verb-data/json --max-depth 1
```

```console
  ./pitufo /GitHub/verb-data/json --minify  --max-depth 1
```

## Building

Install Rust as per the instructions here [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install)

```console
git clone https://github.com/ian-hamlin/pitufo.git
cd pitufo
cargo build --release
./target/release/pitufo path/to/json
```

## Notes

pitufo will:

* silently ignore any path that it can not access.
* report files it can not change to stderr.
* not provide any feedback on success or progress.

## License

Licensed under either of

* Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0))
* MIT license
   ([LICENSE-MIT](LICENSE-MIT) or [http://opensource.org/licenses/MIT](http://opensource.org/licenses/MIT))

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

[latest-release]: https://github.com/ian-hamlin/pitufo/releases/latest
[mac-release]: https://github.com/ian-hamlin/pitufo/releases/latest/download/x86_64-apple-darwin.zip
[windows-release]: https://github.com/ian-hamlin/pitufo/releases/latest/download/x86_64-pc-windows-msvc.zip
[linux-release]: https://github.com/ian-hamlin/pitufo/releases/latest/download/x86_64-unknown-linux-musl.zip