Syntax highlighting (via ANSI) for JSON output using Jackson
Simple utility for generating syntax-highlighted JSON text using the Jackson library. Inlines ANSI color-codes visible in ANSI-enabled consoles.
Features:
The library is primarily intended for adding coloring while doing minimal changes to existing applications. For example, coloring of status codes during unit testing.
The project is built with Maven and is available on the central Maven repository.
xml
<jackson-syntax-highlight.version>1.0.8</jackson-syntax-highlight.version>xml
<dependency>
<groupId>com.github.skjolber.jackson</groupId>
<artifactId>jackson-syntax-highlight</artifactId>
<version>${jackson-syntax-highlight.version}</version>
</dependency>or
groovy
ext {
jacksonSyntaxHighlightVersion = '1.0.8'
}groovy
api ("com.github.skjolber.jackson:jackson-syntax-highlight:${jacksonSyntaxHighlightVersion}")The highlighter wraps a normal JsonGenerator. Pretty-printing is enabled by default.
// construct output generatorJsonGenerator delegate = new JsonFactory().createGenerator(writer);// wrap with syntax highlighterJsonGenerator jsonGenerator = new SyntaxHighlightingJsonGenerator(delegate);// write JSON outputjsonGenerator.writeStartObject(); // start root objectjsonGenerator.writeFieldName("name");jsonGenerator.writeNumber(123);jsonGenerator.writeEndObject();// .. etc
Supply an instance of SyntaxHighlighter using the builder:
SyntaxHighlighter highlighter = DefaultSyntaxHighlighter.newBuilder().withNumber(AnsiSyntaxHighlight.BLUE).build();JsonGenerator jsonGenerator = new SyntaxHighlightingJsonGenerator(delegate, highlighter);
In addition, the JSON structure can be tracked via JsonStreamContextListener, for stateful coloring of subtrees.
Write a full object using writeObject, i.e.
JsonGenerator jsonGenerator = new SyntaxHighlightingJsonGenerator(delegate, highlighter, prettyprint);jsonGenerator.writeObject(obj);