Skip to content

Commit 4f6ebfe

Browse files
committed
Add summaries and groups to gradle tasks
Fixes and closes apple#188 by adding task names and groups to major Pkl Gradle Plugin tasks Signed-off-by: Sam Gammon <[email protected]>
1 parent 277f1e0 commit 4f6ebfe

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

pkl-gradle/src/main/java/org/pkl/gradle/PklPlugin.java

+12-1
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,8 @@ private void configureJavaCodeGenTasks(NamedDomainObjectContainer<JavaCodeGenSpe
171171
createModulesTask(JavaCodeGenTask.class, spec)
172172
.configure(
173173
task -> {
174+
task.setDescription(TaskConstants.GENERATE_JAVA_DESCRIPTION);
175+
task.setGroup(TaskConstants.TASK_GROUP_CODEGEN);
174176
configureCodeGenTask(task, spec);
175177
task.getGenerateGetters().set(spec.getGenerateGetters());
176178
task.getGenerateJavadoc().set(spec.getGenerateJavadoc());
@@ -200,6 +202,8 @@ private void configureKotlinCodeGenTasks(NamedDomainObjectContainer<KotlinCodeGe
200202
createModulesTask(KotlinCodeGenTask.class, spec)
201203
.configure(
202204
task -> {
205+
task.setDescription(TaskConstants.GENERATE_KOTLIN_DESCRIPTION);
206+
task.setGroup(TaskConstants.TASK_GROUP_CODEGEN);
203207
configureCodeGenTask(task, spec);
204208
task.getGenerateKdoc().set(spec.getGenerateKdoc());
205209
});
@@ -228,7 +232,12 @@ private void configurePkldocTasks(NamedDomainObjectContainer<PkldocSpec> specs)
228232
.map(it -> it.dir("pkldoc").dir(spec.getName())));
229233

230234
createModulesTask(PkldocTask.class, spec)
231-
.configure(task -> task.getOutputDir().set(spec.getOutputDir()));
235+
.configure(
236+
task -> {
237+
task.setDescription(TaskConstants.GENERATE_PKLDOC_DESCRIPTION);
238+
task.setGroup(TaskConstants.TASK_GROUP_DOCS);
239+
task.getOutputDir().set(spec.getOutputDir());
240+
});
232241
});
233242
}
234243

@@ -242,6 +251,8 @@ private void configureTestTasks(NamedDomainObjectContainer<TestSpec> specs) {
242251
var testTask = createModulesTask(TestTask.class, spec);
243252
testTask.configure(
244253
task -> {
254+
task.setDescription(TaskConstants.GENERATE_PKLDOC_DESCRIPTION);
255+
task.setGroup(TaskConstants.TASK_GROUP_DOCS);
245256
task.getJunitReportsDir().set(spec.getJunitReportsDir());
246257
task.getOverwrite().set(spec.getOverwrite());
247258
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/**
2+
* Copyright © 2024 Apple Inc. and the Pkl project authors. All rights reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package org.pkl.gradle;
17+
18+
/** Constant values used by tasks */
19+
class TaskConstants {
20+
private TaskConstants() {
21+
/* no construction */
22+
}
23+
24+
/** Gradle task group declared for code-gen tasks. */
25+
static final String TASK_GROUP_CODEGEN = "Code generation";
26+
27+
/** Gradle task group declared for documentation tasks. */
28+
static final String TASK_GROUP_DOCS = "Documentation";
29+
30+
/** Gradle task description for generating Java code from Pkl modules. */
31+
static final String GENERATE_JAVA_DESCRIPTION = "Generate Java code from Pkl modules";
32+
33+
/** Gradle task description for generating Kotlin code from Pkl modules. */
34+
static final String GENERATE_KOTLIN_DESCRIPTION = "Generate Kotlin code from Pkl modules";
35+
36+
/** Gradle task description for generating Pkldoc from Pkl modules. */
37+
static final String GENERATE_PKLDOC_DESCRIPTION = "Generate Pkldoc from Pkl modules";
38+
}

0 commit comments

Comments
 (0)