Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/myconsciousness/json-formatter
Lightweight, Extensible and Flexible formatter for JSON based on Java.
https://github.com/myconsciousness/json-formatter
bracket colon formatter formatting indents java json json-formatter json-strings
Last synced: 25 days ago
JSON representation
Lightweight, Extensible and Flexible formatter for JSON based on Java.
- Host: GitHub
- URL: https://github.com/myconsciousness/json-formatter
- Owner: myConsciousness
- License: apache-2.0
- Created: 2020-08-04T15:10:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-04T15:23:02.000Z (almost 4 years ago)
- Last Synced: 2024-10-02T07:21:10.891Z (about 1 month ago)
- Topics: bracket, colon, formatter, formatting, indents, java, json, json-formatter, json-strings
- Language: Java
- Homepage: https://myconsciousness.github.io/json-formatter/
- Size: 385 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# JSON Formatter
**Table of Contents**
- [What is it?](#what-is-it)
- [How To Use](#how-to-use)
- [1. Add the dependencies](#1-add-the-dependencies)
- [2. Add an import for **_JSON Fomratter_**](#2-add-an-import-for-_json-fomratter_)
- [3. Create a instance](#3-create-a-instance)
- [4. Format](#4-format)
- [Demonstrate I/O](#demonstrate-io)
- [License](#license)
- [More Information](#more-information)
## What is it?
**_This is a formatter for JSON strings._**
`JSON Formatter` is specialized in formatting JSON strings that do not use regular expressions and has no functions other than formatting. **_Therefore it is extremely lightweight besides can be expanded to meet user needs._**
## How To Use
### 1. Add the dependencies
> **_Note:_**
> Replace version you want to use. Check the latest [Packages](https://github.com/myConsciousness/json-formatter/packages).
> Please contact me for a token to download the package.
**_Maven_**
```xml
org.thinkit.formatter
json-formatter
v1.0.2
github
myConsciousness
xxxxxxxxxxxxxxxxxx
```
**_Gradle_**
```gradle
repositories {
maven {
name = "GitHubPackages"
url = uri("https://maven.pkg.github.com/myConsciousness/json-formatter")
credentials {
username = "myConsciousness"
password = "xxxxxxxxxxxxxxxxxx"
}
}
}
dependencies {
implementation 'org.thinkit.formatter:json-formatter:v1.0.2'
}
```
### 2. Add an import for [**_JSON Fomratter_**](https://github.com/myConsciousness/json-formatter/blob/master/src/main/java/org/thinkit/formatter/json/JsonFormatter.java)
```java
import org.thinkit.formatter.json.JsonFormatter;
```
### 3. Create a instance
```java
Formatter formatter = JsonFormatter.newInstance();
```
You can also create an instance with a specific number of indents as following.
> **_Note:_**
> If a negative indentation is passed at instantiation time, the initial value defined in the [content file](https://github.com/myConsciousness/json-formatter/blob/master/src/main/resources/content/org/thinkit/formatter/json/JsonDefaultIndent.json) takes precedence.
```java
Formatter formatter = JsonFormatter.from(indent);
```
### 4. Format
```java
Formatter formatter = JsonFormatter.from(indent);
String formattedJson = formatter.format(json);
```
## Demonstrate I/O
I have prepared the following unformatted json string for input/output reference. This is the json template for `content-framework`, but it's hard to see without any spaces or line breaks.
```txt
{"metadata":{"author":"Kato Shinya","since":"1.0","version":"1.0","creationDate":"2020/06/24","encoding":"UTF-8","description":"test"},"selectionNodes":[{"node":{"conditionId":"0","test1":"test","test2":"test"}},{"node":{"conditionId":"1","test1":"test","test2":"test"}},{"node":{"conditionId":"2","test1":"test","test2":"test"}}],"conditionNodes":[{"node":{"conditionId":"0","exclude":false,"conditions":[{"keyName":"test","operand":"=","value":"0"}]}},{"node":{"conditionId":"1","exclude":false,"conditions":[{"keyName":"test","operand":"=","value":"1"}]}},{"node":{"conditionId":"2","exclude":false,"conditions":[{"keyName":"test","operand":"=","value":"2"}]}}]}
```
Let's run `JSON Formatter` with the JSON string of above template as an argument.
```java
JsonFormatter.newInstance().format(json);
```
The output is as follows.
> **_Note:_**
> Whitespace in the JSON string before formatting is trimmed during the formatting process, so no pre-processing is required.
```json
{
"metadata": {
"author": "Kato Shinya",
"since": "1.0",
"version": "1.0",
"creationDate": "2020/06/24",
"encoding": "UTF-8",
"description": "test"
},
"selectionNodes": [
{
"node": {
"conditionId": "0",
"test1": "test",
"test2": "test"
}
},
{
"node": {
"conditionId": "1",
"test1": "test",
"test2": "test"
}
},
{
"node": {
"conditionId": "2",
"test1": "test",
"test2": "test"
}
}
],
"conditionNodes": [
{
"node": {
"conditionId": "0",
"exclude": false,
"conditions": [
{
"keyName": "test",
"operand": "=",
"value": "0"
}
]
}
},
{
"node": {
"conditionId": "1",
"exclude": false,
"conditions": [
{
"keyName": "test",
"operand": "=",
"value": "1"
}
]
}
},
{
"node": {
"conditionId": "2",
"exclude": false,
"conditions": [
{
"keyName": "test",
"operand": "=",
"value": "2"
}
]
}
}
]
}
```
## License
```license
Copyright 2020 Kato Shinya.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License
is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
or implied. See the License for the specific language governing permissions and limitations under
the License.
```
## More Information
`JSON Formatter` was designed and implemented by Kato Shinya, who works as a freelance developer.
Regardless of the means or content of communication, I would love to hear from you if you have any questions or concerns. I do not check my email box very often so a response may be delayed, anyway thank you for your interest!
- [Creator Profile](https://github.com/myConsciousness)
- [Creator Website](https://myconsciousness.github.io/)
- [License](https://github.com/myConsciousness/json-formatter/blob/master/LICENSE)
- [Release Note](https://github.com/myConsciousness/json-formatter/releases)
- [Package](https://github.com/myConsciousness/json-formatter/packages)
- [File a Bug](https://github.com/myConsciousness/json-formatter/issues)
- [Reference](https://myconsciousness.github.io/json-formatter/)