-
Notifications
You must be signed in to change notification settings - Fork 419
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add the ability to pretty print DokkaConfiguration #2872
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| package org.jetbrains.dokka | ||
|
|
||
| import org.jetbrains.dokka.plugability.ConfigurableBlock | ||
| import org.jetbrains.dokka.utilities.parseJson | ||
| import org.jetbrains.dokka.utilities.serializeAsCompactJson | ||
| import org.jetbrains.dokka.utilities.serializeAsPrettyJson | ||
|
|
||
| fun DokkaConfigurationImpl(json: String): DokkaConfigurationImpl = parseJson(json) | ||
|
|
||
| fun GlobalDokkaConfiguration(json: String): GlobalDokkaConfiguration = parseJson(json) | ||
|
|
||
| @Deprecated("Renamed to better distinguish between compact/pretty prints", ReplaceWith("this.toCompactJsonString()")) | ||
| fun DokkaConfiguration.toJsonString(): String = this.toCompactJsonString() | ||
|
|
||
| @Deprecated("Renamed to better distinguish between compact/pretty prints", ReplaceWith("this.toCompactJsonString()")) | ||
| fun <T : ConfigurableBlock> T.toJsonString(): String = this.toCompactJsonString() | ||
|
|
||
| /** | ||
| * Serializes [DokkaConfiguration] as a machine-readable and compact JSON string. | ||
| * | ||
| * The returned string is not very human friendly as it will be difficult to parse by eyes due to it | ||
| * being compact and in one line. If you want to show the output to a human being, see [toPrettyJsonString]. | ||
| */ | ||
| fun DokkaConfiguration.toCompactJsonString(): String = serializeAsCompactJson(this) | ||
|
|
||
| /** | ||
| * Serializes [DokkaConfiguration] as a human-readable (pretty printed) JSON string. | ||
| * | ||
| * The returned string will have excessive line breaks and indents, which might not be | ||
| * desirable when passing this value between API consumers/producers. If you want | ||
| * a machine-readable and compact json string, see [toCompactJsonString]. | ||
| */ | ||
| fun DokkaConfiguration.toPrettyJsonString(): String = serializeAsPrettyJson(this) | ||
|
|
||
| /** | ||
| * Serializes a [ConfigurableBlock] as a machine-readable and compact JSON string. | ||
| * | ||
| * The returned string is not very human friendly as it will be difficult to parse by eyes due to it | ||
| * being compact and in one line. If you want to show the output to a human being, see [toPrettyJsonString]. | ||
| */ | ||
| fun <T : ConfigurableBlock> T.toCompactJsonString(): String = serializeAsCompactJson(this) | ||
IgnatBeresnev marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| /** | ||
| * Serializes a [ConfigurableBlock] as a human-readable (pretty printed) JSON string. | ||
| * | ||
| * The returned string will have excessive line breaks and indents, which might not be | ||
| * desirable when passing this value between API consumers/producers. If you want | ||
| * a machine-readable and compact json string, see [toCompactJsonString]. | ||
| */ | ||
| fun <T : ConfigurableBlock> T.toPrettyJsonString(): String = serializeAsCompactJson(this) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| package utilities | ||
|
|
||
| import org.jetbrains.dokka.utilities.serializeAsCompactJson | ||
| import org.jetbrains.dokka.utilities.serializeAsPrettyJson | ||
| import kotlin.test.assertEquals | ||
| import kotlin.test.Test | ||
|
|
||
| class JsonTest { | ||
|
|
||
| @Test | ||
| fun `should serialize an object as compact json`() { | ||
| val testObject = SimpleTestDataClass( | ||
| someString = "Foo", | ||
| someInt = 42, | ||
| someDouble = 42.0 | ||
| ) | ||
|
|
||
| val actual = serializeAsCompactJson(testObject) | ||
| val expected = "{\"someString\":\"Foo\",\"someInt\":42,\"someIntWithDefaultValue\":42,\"someDouble\":42.0}" | ||
|
|
||
| assertEquals(expected, actual) | ||
| } | ||
|
|
||
| @Test | ||
| fun `should serialize an object as pretty json`() { | ||
| val testObject = SimpleTestDataClass( | ||
| someString = "Foo", | ||
| someInt = 42, | ||
| someDouble = 42.0 | ||
| ) | ||
|
|
||
| val actual = serializeAsPrettyJson(testObject) | ||
|
|
||
| val expected = """ | ||
| { | ||
| "someString" : "Foo", | ||
| "someInt" : 42, | ||
| "someIntWithDefaultValue" : 42, | ||
| "someDouble" : 42.0 | ||
| }""".trimIndent().withSystemLineSeparator() | ||
|
|
||
| assertEquals(expected, actual) | ||
| } | ||
|
|
||
| /** | ||
| * If the expected output was generated on Linux, but the tests are run under Windows, | ||
| * the test might fail when comparing the strings due to different separators. | ||
| */ | ||
| private fun String.withSystemLineSeparator(): String = this.replace("\n", System.lineSeparator()) | ||
| } | ||
|
|
||
| data class SimpleTestDataClass( | ||
| val someString: String, | ||
| val someInt: Int, | ||
| val someIntWithDefaultValue: Int = 42, | ||
| val someDouble: Double | ||
| ) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The functions have been moved to another file, but within the same package, so source compatibility should be preserved