https://github.com/timakin/jf

Dead simple JSON Formatter
https://github.com/timakin/jf

Last synced: about 1 month ago
JSON representation

Dead simple JSON Formatter

• Host: GitHub
• URL: https://github.com/timakin/jf
• Owner: timakin
• License: mit
• Created: 2016-06-04T15:58:08.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-10-21T08:49:48.000Z (about 8 years ago)
• Last Synced: 2024-10-01T07:12:16.671Z (about 1 month ago)
• Language: Ruby
• Size: 29.3 KB
• Stars: 10
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
JF

=====

Dead simple JSON Formatter

## Example

```

$ jf raw.json [--gitdiff|--minify|-i] # Attach format to a json file.

$ jf .                                # Attach format to all of json files under the current directory.

$ cat raw.json | jf                   # Output pretty json for the received STDIN.

> (print pretty json)

# Merge options

$ jf origin.json --merge target.json                        # Push the object of inside of target.json back to the origin.json.

$ jf origin.json --merge target.json --key key1             # Push the object of inside of target.json to "key1" object of origin.json.

$ jf origin.json --merge target.json --key key1.innerkey1.0 # Push the object of inside of target.json to "origin[:key1][:innerkey1][:deep][0]".

```

## Options

- --git-diff

 - Run the command to only git-historically created|modified json file

- --minify

 - Compact multi lined json to one line

- -i {number}

 - Set the number of indents before the begining of each lines

- --merge {target.json} --key {keys}

 - Merge another json object to the specified json.

 - It supports deep inside object merge with '--key' option. You can set the option with dot-connected keys.

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/timakin/jf. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).