From 743d2cde7f472826ab931dd2f5473ff82d0a6c60 Mon Sep 17 00:00:00 2001 From: William Cheng Date: Wed, 23 Nov 2022 20:31:13 +0800 Subject: [PATCH] Minor improvements to Gradle plugin (#14097) * minor improvements to gradle plugin, test * update gradle plugin doc * fix out --- modules/openapi-generator-gradle-plugin/README.adoc | 5 +++++ .../generator/gradle/plugin/tasks/GenerateTask.kt | 3 +++ .../src/test/kotlin/GenerateTaskDslTest.kt | 4 ++-- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/modules/openapi-generator-gradle-plugin/README.adoc b/modules/openapi-generator-gradle-plugin/README.adoc index f9cb667959c..3ffc65de9e9 100644 --- a/modules/openapi-generator-gradle-plugin/README.adoc +++ b/modules/openapi-generator-gradle-plugin/README.adoc @@ -378,6 +378,11 @@ apply plugin: 'org.openapi.generator' |String |mustache |Templating engine: "mustache" (default) or "handlebars" (beta) + +|cleanupOutput +|Boolean +|false +|Defines whether the output directory should be cleaned up before generating the output. |=== [NOTE] diff --git a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt index 9c0c721ee23..f3ef513a2f2 100644 --- a/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt +++ b/modules/openapi-generator-gradle-plugin/src/main/kotlin/org/openapitools/generator/gradle/plugin/tasks/GenerateTask.kt @@ -523,6 +523,9 @@ open class GenerateTask : DefaultTask() { cleanupOutput.ifNotEmpty { cleanup -> if (cleanup) { project.delete(outputDir) + val out = services.get(StyledTextOutputFactory::class.java).create("openapi") + out.withStyle(StyledTextOutput.Style.Success) + out.println("Cleaned up output directory ${outputDir.get()} before code generation (cleanupOutput set to true).") } } diff --git a/modules/openapi-generator-gradle-plugin/src/test/kotlin/GenerateTaskDslTest.kt b/modules/openapi-generator-gradle-plugin/src/test/kotlin/GenerateTaskDslTest.kt index e1c1e1f1989..d819025e2c3 100644 --- a/modules/openapi-generator-gradle-plugin/src/test/kotlin/GenerateTaskDslTest.kt +++ b/modules/openapi-generator-gradle-plugin/src/test/kotlin/GenerateTaskDslTest.kt @@ -136,7 +136,7 @@ class GenerateTaskDslTest : TestBase() { ) withProject(defaultBuildGradle, projectFiles) - val oldFile = File(temp, "build/kotlin/should-be-removed") + val oldFile = File(temp, "build/kotlin/should-not-be-removed") oldFile.mkdirs() oldFile.createNewFile() @@ -153,7 +153,7 @@ class GenerateTaskDslTest : TestBase() { "User friendly generate notice is missing." ) - assertTrue(oldFile.exists(), "Old files should have been removed") + assertTrue(oldFile.exists(), "Old files should NOT have been removed") assertEquals( TaskOutcome.SUCCESS, result.task(":openApiGenerate")?.outcome,