https://github.com/lieutenantpeacock/lp-multisorter
Sorter for various file types. This is especially useful for comparing versions of generated files with differencing tools.
https://github.com/lieutenantpeacock/lp-multisorter
java json json-sorting openapi-json sort xml xmlsort
Last synced: 26 days ago
JSON representation
Sorter for various file types. This is especially useful for comparing versions of generated files with differencing tools.
- Host: GitHub
- URL: https://github.com/lieutenantpeacock/lp-multisorter
- Owner: LieutenantPeacock
- License: mit
- Created: 2021-08-04T20:40:23.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-13T03:57:36.000Z (over 3 years ago)
- Last Synced: 2024-12-31T04:43:39.533Z (over 1 year ago)
- Topics: java, json, json-sorting, openapi-json, sort, xml, xmlsort
- Language: Java
- Homepage:
- Size: 60.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Lt. Peacock's Multisorter
Do you need to compare the differences between versions of generated XML, JSON, etc (e.g. WSDL files from Spring WS, OpenAPI JSON files generated by springdoc-openapi)? The generally unpredictable order often hinders this endeavor, showing a plethora of changes in differencing tools when only a few values have actually changed. Fortunately, Lt. Peacock's Multisorter has you covered.
This library/tool provides the ability to sort various file types.
## Installation
JDK 8 is required at a minimum.
To build the project as a single executable JAR:
```
mvn clean package -Pcli
```
For those who do not want to build it manually, lp-multisorter-cli.jar can be downloaded from most of the [releases](https://github.com/LieutenantPeacock/lp-multisorter/releases) for direct use.
To see instructions on usage:
```
java -jar lp-multisorter.jar
```
This project is also available as a [Maven artifact](https://search.maven.org/artifact/com.lt-peacock/lp-multisorter/1.3.0/jar). Maven users can include the library with the following dependency in pom.xml:
```xml
com.lt-peacock
lp-multisorter
1.3.0
```
## XML
With this tool, you can sort both elements and their attributes by name to facilitate comparing with differencing tools.
### Command Line Usage
```
java -cp lp-multisorter.jar XMLSorter [inputFile] [outputFile]
```
The command above reads an XML file at the location specified by `inputFile` and outputs the sorted result to the location specified by `outputFile`. Elements are sorted lexicographically by node name and then by the `"name"` attribute, and their attributes are sorted lexicographically by name.
If `outputFile` is not specified, output goes to stdout; if `inputFile` is also not specified, input is taken from stdin.
Example:
```
java -cp lp-multisorter.jar XMLSorter file.xml file_sorted.xml
```
Example with a Unix pipeline:
```
cat file.xml | java -cp lp-multisorter.jar XMLSorter > file_sorted.xml
```
### Programmatic Usage
Construct a `SortXMLEngine`:
```java
SortXMLEngine engine = new SortXMLEngine();
```
By default, `ElementComparator` is used to order elements, which sorts lexicographically by node name and then by the `"name"` attribute, and `AttributeComparator` is used to order attributes, which sorts lexicographically by attribute name.
To specify a custom order, pass two more arguments to the constructor: a `Comparator` for `ElementVO` objects and a `Comparator` for `ElementAttribute` objects. Use `ElementComparator.MAINTAIN_ORDER` to keep the original order of elements in the file and `AttributeComparator.MAINTAIN_ORDER` to keep the original order of attributes on each element.
```java
SortXMLEngine engine = new SortXMLEngine(elementComparator, attributeComparator);
```
Then, call `sort` with an `InputStream` to read the file from and an `OutputStream` to write the sorted result to.
```java
engine.sort(new FileInputStream("file.xml"), new FileOutputStream("file_sorted.xml"));
```
## JSON
### Command Line Usage
```
java -cp lp-multisorter.jar JSONSorter [inputFile] [outputFile]
```
This reads a JSON file at the location specified by inputFile and writes the sorted result to the location specified by outputFile. The sorting is done by rearranging all the keys in each object in lexicographic order. Elements of arrays are not moved around.
If `outputFile` is not specified, output goes to stdout; if `inputFile` is also not specified, input is taken from stdin.
### Programmatic Usage
Construct a `SortJSONEngine`. An optional `Comparator` can be specified as the first argument to order the keys in each object. By default, the engine sorts keys in lexicographic order.
```java
SortJSONEngine engine = new SortJSONEngine();
```
Then, call `sort` with an `InputStream` and an `OutputStream`.
```java
engine.sort(new FileInputStream("file.json"), new FileOutputStream("file_sorted.json"));
```
`sort` may also be called with a `com.github.openjson.JSONObject` or `com.github.openjson.JSONArray` as the only argument, which will sort the keys of all objects in the structure in place.
```java
JSONObject obj = new JSONObject("{\"b\":1,\"a\":2}");
engine.sort(obj);
```
## OpenAPI JSON
Like with XML, Lt. Peacock's Multisorter can be used to sort OpenAPI JSON for easy comparison, especially for large files.
### Command Line Usage
```
java -cp lp-multisorter.jar OpenApiJSONSorter [inputFile] [outputFile]
```
The command above reads an OpenAPI JSON file at the location specified by `inputFile` and outputs the sorted result to the location specified by `outputFile`.
If `outputFile` is not specified, output goes to stdout; if `inputFile` is also not specified, input is taken from stdin.
### Programmatic Usage
Construct a `SortOpenApiJSONEngine`:
```java
SortOpenApiJSONEngine engine = new SortOpenApiJSONEngine();
```
Then, call `sort` with an `InputStream` to read the file from and an `OutputStream` to write the sorted result to.
```java
engine.sort(new FileInputStream("file.json"), new FileOutputStream("file_sorted.json"));
```