starred/pkl
1
0
Fork 0
mirror of https://github.com/apple/pkl.git synced 2026-04-25 09:48:41 +02:00
Code Issues 198 Packages Projects Releases 10 Wiki Activity

Allow command options to have nullable types and default values (#1444)

Browse Source
This commit is contained in:
Jen Basch
2026-02-26 08:34:46 -08:00
committed by GitHub
parent 3ef065b6b6
commit 4cf2a1b42c
4 changed files with 2 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/modules/release-notes/pages/0.31.adoc
View File

@@ -99,7 +99,7 @@ To learn more about this feature, consult https://github.com/apple/pkl-evolution
[[cli-framework]]
=== CLI Framework
Pkl 0.31 introduces a new framework for implementing CLI tools in Pkl (pr:https://github.com/apple/pkl/pull/1367[], pr:https://github.com/apple/pkl/pull/1431[], pr:https://github.com/apple/pkl/pull/1432[], pr:https://github.com/apple/pkl/pull/1436[], pr:https://github.com/apple/pkl/pull/1440[]).
Pkl 0.31 introduces a new framework for implementing CLI tools in Pkl (pr:https://github.com/apple/pkl/pull/1367[], pr:https://github.com/apple/pkl/pull/1431[], pr:https://github.com/apple/pkl/pull/1432[], pr:https://github.com/apple/pkl/pull/1436[], pr:https://github.com/apple/pkl/pull/1440[], pr:https://github.com/apple/pkl/pull/1444[]).
The framework provides a way to build command line tools with user experience idioms that will be immediately familiar to users.
CLI tools implemented in Pkl have largely the same capabilities as normal Pkl evaluation (i.e. writing to standard output and files), but this may be extended using xref:language-reference:index.adoc#external-readers[external readers].
@@ -339,6 +339,7 @@ The following bugs have been fixed.
* A possible race condition involving symlinks could bypass `--root-dir` during module and resource reading (pr:https://github.com/apple/pkl/pull/1426[]).
* `pkl format` produces internal stack traces when lexing fails (pr:https://github.com/apple/pkl/pull/1430[]).
* `super` access expressions are parsed incorrectly inside the spread operator (pr:https://github.com/apple/pkl/pull/1364[]).
* Modules and resources with `jar:file:` URIs were not properly sandboxed by `--root-dir` (pr:https://github.com/apple/pkl/pull/1442[]).
== Contributors [small]#🙏#

6
pkl-core/src/main/java/org/pkl/core/runtime/CommandSpecParser.java
View File

@@ -513,12 +513,6 @@ public final class CommandSpecParser {
var typeNode = resolved.getFirst();
isNullable = resolved.getSecond();
defaultValue = CommandSpecParser.this.getDefaultValue(prop, requireExplicitDefault);
if (isNullable && defaultValue != null) {
throw exceptionBuilder()
.evalError("commandOptionTypeNullableWithDefaultValue", prop.getName())
.withSourceSection(prop.getHeaderSection())
.build();
}
resolve(prop, typeNode);
return this;

5
pkl-core/src/main/resources/org/pkl/core/errorMessages.properties
View File

@@ -1098,11 +1098,6 @@ Found both `@Flag` and `@Argument` annotations for options property `{0}`.\n\
\n\
Only one option type may be specified.
commandOptionTypeNullableWithDefaultValue=\
Unexpected option property `{0}` with nullable type and default value.\n\
\n\
Options with default values must not be nullable.
commandOptionUnsupportedType=\
Command option property `{0}` has unsupported {1}type `{2}`.

20
pkl-core/src/test/kotlin/org/pkl/core/runtime/CommandSpecParserTest.kt
View File

@@ -292,26 +292,6 @@ class CommandSpecParserTest {
assertThat(exc.message).contains("No type annotation found for `foo` property.")
}
@Test
fun `nullable option with default not allowed`() {
val moduleUri =
writePklFile(
"cmd.pkl",
renderOptions +
"""
class Options {
foo: String? = "bar"
}
"""
.trimIndent(),
)
val exc = assertThrows<PklException> { parse(moduleUri) }
assertThat(exc.message).contains("foo: String? = \"bar\"")
assertThat(exc.message)
.contains("Unexpected option property `foo` with nullable type and default value")
}
@Test
fun `option with union type containing non-string-literals`() {
val moduleUri =