-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add documentation code generation (#553)
* feat: add documentation code generation * update generated-docs in example * apply formatting * lint
- Loading branch information
Cole Turner
authored
May 12, 2023
1 parent
51969ec
commit c153b6f
Showing
13 changed files
with
480 additions
and
5 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
99 changes: 99 additions & 0 deletions
99
...gen-core/src/main/kotlin/com/netflix/graphql/dgs/codegen/generators/shared/DocFileSpec.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,99 @@ | ||
| /* | ||
| * | ||
| * Copyright 2020 Netflix, Inc. | ||
| * | ||
| * 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. | ||
| * | ||
| */ | ||
|
|
||
| package com.netflix.graphql.dgs.codegen.generators.shared | ||
|
|
||
| import com.squareup.kotlinpoet.* | ||
| import java.io.File | ||
| import java.io.IOException | ||
| import java.io.OutputStreamWriter | ||
| import java.nio.charset.StandardCharsets | ||
| import java.nio.file.Files | ||
| import java.nio.file.Path | ||
| import javax.annotation.processing.Filer | ||
| import javax.tools.StandardLocation | ||
|
|
||
| class DocFileSpec private constructor( | ||
| builder: DocFileSpec.Builder | ||
| ) { | ||
| private val extension = "md" | ||
| private val packageName: String = builder.packageName | ||
| private val markdownText: String = builder.markdownText | ||
|
|
||
| @Throws(IOException::class) | ||
| public fun writeTo(out: Appendable) { | ||
| out.append(markdownText) | ||
| } | ||
|
|
||
| /** Writes this to `directory` as UTF-8 using the standard directory structure. */ | ||
| @Throws(IOException::class) | ||
| public fun writeTo(directory: Path) { | ||
| require(Files.notExists(directory) || Files.isDirectory(directory)) { | ||
| "path $directory exists but is not a directory." | ||
| } | ||
|
|
||
| Files.createDirectories(directory) | ||
|
|
||
| val outputPath = directory.resolve("$packageName.$extension") | ||
| OutputStreamWriter(Files.newOutputStream(outputPath), StandardCharsets.UTF_8).use { writer -> writeTo(writer) } | ||
| } | ||
|
|
||
| /** Writes this to `directory` as UTF-8 using the standard directory structure. */ | ||
| @Throws(IOException::class) | ||
| public fun writeTo(directory: File): Unit = writeTo(directory.toPath()) | ||
|
|
||
| /** Writes this to `filer`. */ | ||
| @Throws(IOException::class) | ||
| public fun writeTo(filer: Filer) { | ||
| val filerSourceFile = filer.createResource( | ||
| StandardLocation.SOURCE_OUTPUT, | ||
| packageName, | ||
| "$packageName.$extension" | ||
| ) | ||
| try { | ||
| filerSourceFile.openWriter().use { writer -> writeTo(writer) } | ||
| } catch (e: Exception) { | ||
| try { | ||
| filerSourceFile.delete() | ||
| } catch (ignored: Exception) { | ||
| } | ||
| throw e | ||
| } | ||
| } | ||
|
|
||
| public class Builder internal constructor( | ||
| public val packageName: String, | ||
| public var markdownText: String | ||
| ) { | ||
| public fun setMarkdownText(markdownText: String): DocFileSpec.Builder = apply { | ||
| this.markdownText = markdownText | ||
| } | ||
|
|
||
| public fun build(): DocFileSpec { | ||
| return DocFileSpec(this) | ||
| } | ||
| } | ||
| public companion object { | ||
| @JvmStatic public fun get(packageName: String, markdownText: String): DocFileSpec { | ||
| return builder(packageName, markdownText).build() | ||
| } | ||
|
|
||
| @JvmStatic public fun builder(packageName: String, markdownText: String): DocFileSpec.Builder = | ||
| DocFileSpec.Builder(packageName, markdownText) | ||
| } | ||
| } |
Oops, something went wrong.