Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aleandros/tdiff
CLI tool for comparing tree like structures
https://github.com/aleandros/tdiff
cli crystal crystal-lang json yaml
Last synced: 3 months ago
JSON representation
CLI tool for comparing tree like structures
- Host: GitHub
- URL: https://github.com/aleandros/tdiff
- Owner: aleandros
- License: mit
- Created: 2020-04-29T17:06:15.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-06-02T21:59:16.000Z (over 4 years ago)
- Last Synced: 2024-11-02T13:33:58.575Z (3 months ago)
- Topics: cli, crystal, crystal-lang, json, yaml
- Language: Crystal
- Size: 60.5 KB
- Stars: 21
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tdiff
[](https://crystal-lang.org/)
[](https://github.com/aleandros/tdiff/actions?query=workflow%3ACI)
[](https://github.com/aleandros/tdiff/releases)
A tool for comparing Tree like files, specifically JSON and YAML
## Installation
Right now, simply go to the [releases page](https://github.com/aleandros/tdiff/releases) and download
the latest binary to your prefered directory in your path (like `/usr/local/bin`). This applies for both
windows and linux
### Using snap on Linux
If you have `snap` on your system, you can install it with
```shell
$ sudo snap install --beta tdiff # I hope to be able to consider it out of beta soon
```
### Using Homebrew for OSX
```shell
$ brew tap aleandros/tdiff
$ brew install tdiff
```
## Usage as a binary
Usage: `tdiff [OPTION]... [SOURCE] `
Identifies the differences between two tree-like file structures.
If `` is not present, input is assumed to come from STDIN.
At this moment, only JSON and YAML are supported.
An exit status of 1 indicates an error in the program.
An exit status of 127 indicates that there are differences between source
and target.
An exit status of 0 indicates no changes
Example output:
```shell
$ tdiff shard.yml shard.lock
- name: tdiff
* version: changed type from string to float
- authors: ["Edgar Cabrera "]
- targets: {"tdiff" => {"main" => "main.cr"}}
- crystal: 0.34.0
- license: MIT
- development_dependencies: {"ameba" => {"github" => "crystal-ameba/ameba", "version" => "~> 0.12.0"}}
+ shards: {"ameba" => {"github" => "crystal-ameba/ameba", "version" => "0.12.1"}}
```
## Usage as a shard
Add it to your application shards:
```yaml
dependencies:
tdiff:
github: aleandros/tdiff
```
It just requires a couple of IO objects, containing the YAML or JSON data,
and returns a list of `Tdiff:Core::Result` objects.
```crystal
require "tdiff"
comparator = Tdiff.compare(File.open('target_1.yml'), File.open('target_2.yml'))
comparator.compare
comparator.results.each do |result|
puts "#{result.path.join(".")}: #{result.difference.reason}"
end
```
If any of the inputs cannot be parsed, this method will raise a `Tdiff::Exception` error.
## Development
This is a pretty standard crystal project. So install crystal with your prefered method.
First install dependencies with `shards install`.
Remember to run:
* Tests with `crystal spec`
* Format with `crystal tool format`
* Ameba checks with `bin/ameba`
This will be checked by CI but still save yourself some time.
### Documentation
You can find the documentation [here](https://aleandros.github.io/tdiff/)
## TODO
- [x] Compare file to STDIN
- [x] Compare yamls
- [x] Compare json
- [x] Presentation layer
- [x] Add auto-publish via github actions and installation instructions
- [x] Add portable binaries for OSX (or homebrew package)
- [x] Publish as snap package
- [x] Add portable binary for Windows
- [x] Fix file permission testing in CI
- [x] Allow `Tdiff::Core` to be used as a library
- [ ] Support more array comparison algorithms
- [ ] Allow presentation-level customizations at runtime
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Edgar Cabrera](https://github.com/aleandros) - creator and maintainer