-
Notifications
You must be signed in to change notification settings - Fork 407
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add global settings to JSON dokka cli input (#2292)
* Add global settings to JSON dokka cli input * Apply requested changes * Move initialization of global arguments to extension function in core module
- Loading branch information
1 parent
b30db0a
commit 6b72925
Showing
12 changed files
with
309 additions
and
13 deletions.
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
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
52 changes: 52 additions & 0 deletions
52
integration-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/jsonBuilder.kt
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,52 @@ | ||
package org.jetbrains.dokka.it.cli | ||
|
||
fun jsonBuilder( | ||
outputPath: String, | ||
pluginsClasspath: String, | ||
projectPath: String, | ||
globalSourceLinks: String = "", | ||
globalExternalDocumentationLinks: String = "", | ||
globalPerPackageOptions: String = "", | ||
reportUndocumented: Boolean = false | ||
|
||
): String { | ||
return """{ | ||
"moduleName": "Dokka Example", | ||
"moduleVersion": null, | ||
"outputDir": "$outputPath", | ||
"pluginsClasspath": ["$pluginsClasspath"], | ||
"cacheRoot": null, | ||
"offlineMode": false, | ||
"sourceLinks": [$globalSourceLinks], | ||
"externalDocumentationLinks": [$globalExternalDocumentationLinks], | ||
"perPackageOptions": [$globalPerPackageOptions], | ||
"sourceSets": [ | ||
{ | ||
"displayName": "jvm", | ||
"sourceSetID": { | ||
"scopeId": ":dokkaHtml", | ||
"sourceSetName": "main" | ||
}, | ||
"sourceRoots": [ | ||
"$projectPath" | ||
], | ||
"dependentSourceSets": [], | ||
"samples": [], | ||
"includes": [], | ||
"includeNonPublic": false, | ||
"reportUndocumented": $reportUndocumented, | ||
"skipEmptyPackages": true, | ||
"skipDeprecated": false, | ||
"jdkVersion": 8, | ||
"sourceLinks": [], | ||
"perPackageOptions": [], | ||
"externalDocumentationLinks": [], | ||
"noStdlibLink": false, | ||
"noJdkLink": false, | ||
"suppressedFiles": [], | ||
"analysisPlatform": "jvm" | ||
} | ||
] | ||
} | ||
""" | ||
} |
Empty file.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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,30 @@ | ||
package org.jetbrains.dokka | ||
|
||
import junit.framework.Assert.assertTrue | ||
import org.junit.Test | ||
import java.lang.IllegalStateException | ||
import java.nio.file.Paths | ||
import kotlin.test.assertEquals | ||
|
||
class CliIntegrationTest { | ||
|
||
@Test | ||
fun `should apply global settings to all source sets`() { | ||
val jsonPath = Paths.get(javaClass.getResource("/my-file.json")?.toURI() ?: throw IllegalStateException("No JSON found!")).toFile().toString() | ||
val globalArguments = GlobalArguments(arrayOf(jsonPath)) | ||
|
||
val configuration = initializeConfiguration(globalArguments) | ||
|
||
configuration.sourceSets.forEach { | ||
assertTrue(it.perPackageOptions.isNotEmpty()) | ||
assertTrue(it.sourceLinks.isNotEmpty()) | ||
assertTrue(it.externalDocumentationLinks.isNotEmpty()) | ||
|
||
assertTrue(it.externalDocumentationLinks.any { it.url.toString() == "https://docs.oracle.com/javase/8/docs/api/" }) | ||
assertEquals(it.sourceLinks.single().localDirectory, "/home/Vadim.Mishenev/dokka/examples/cli/src/main/kotlin") | ||
assertEquals(it.perPackageOptions.single().matchingRegex, "my-custom-regex") | ||
} | ||
|
||
} | ||
|
||
} |
Oops, something went wrong.