feat: added support for specifying native options (quarkusio#1494)

Added both `//NATIVE_OPTIONS` and `--native-option`.
Also enabled `//COMPILE_OPTIONS` for both Kotlin and Groovy sources.
Updated docs to prefer the newer tag and option names.

Fixes quarkusio#1493

Author: quintesse

docs/modules/ROOT/pages/index.adoc

@@ -61,7 +61,7 @@ toc::[]
 * Installation of scripts to user `PATH`
 * Include multiple files and sources
 * Dependency declarations using `//DEPS <gav>` for automatic dependency resolution
-* Control compile and runtime options with `//JAVAC_OPTIONS <flags>` and `//JAVA_OPTIONS <flags>`
+* Control compile and runtime options with `//COMPILE_OPTIONS <flags>`, `//NATIVE_OPTIONS <flags>` and `//RUNTIME_OPTIONS <flags>`
 * Compiled jar and Dependency resolution caching
 * native-image generation (`--native`)
 * Launch with debug enabled for instant debugging from your favorite IDE

docs/modules/ROOT/pages/running.adoc

@@ -26,7 +26,7 @@ to your script/class to see it.
 
 Flight recorder is a feature of the Java VM that lets you gather diagnostic and profiling data about your script.
 
-You can use `//JAVA_OPTIONS` to have full control over it; but for the easiest setup `jbang` lets you just run with `--jfr`, e.g.,
+You can use `//RUNTIME_OPTIONS` to have full control over it; but for the easiest setup `jbang` lets you just run with `--jfr`, e.g.,
 
   jbang --jfr myapp.java
 
@@ -37,18 +37,23 @@ Then you can use tools like `jvisualvm` or `jmc` to explore the data.
 If you want to tweak the configuration you can pass flight recorder options, like `jbang --jfr=filename=\{basename}.jfr,maxage=24h` where `\{basename}` will be replaced
 by the filename and then added `maxage=24h` to flight recording options.
 
-If you want further control use `//JAVAC_OPTIONS -XX:StartFlightRecording=<your options>` instead.
+If you want further control use `//COMPILE_OPTIONS -XX:StartFlightRecording=<your options>` instead.
 
-== `java` and `javac` Options
+== `java`, `javac` and `nativeimage` Options
 
-If you want to tweak memory settings or enable preview features you can setup the necessary options using
-`//JAVA_OPTIONS` and `//JAVAC_OPTIONS` as in the following example using Java 14 experimental `record` feature:
+You can pass options directly from JBang to the compiler and runtime tools that it uses to build and run your code.
+
+The following source tags are available for setting JVM (`java`) options, compiler options (`javac`, `kotlinc`, etc) and native image builders (`nativeimage`) respectively: `//RUNTIME_OPTIONS`, `//COMPILE_OPTIONS` and `//NATIVE_OPTIONS`.
+
+You can also set the same options from the command line using: `--runtime-option`, `--compile-option` and `--native-option`.
+
+As an example, if you want to enable preview features you can set up the necessary options as in the following example that uses Java 14 experimental `record` feature:
 
 [source, java]
 ----
 ///usr/bin/env jbang "$0" "$@" ; exit $?
-//JAVAC_OPTIONS --enable-preview -source 14 <.>
-//JAVA_OPTIONS --enable-preview // <.>
+//COMPILE_OPTIONS --enable-preview -source 14
+//RUNTIME_OPTIONS --enable-preview
 
 import static java.lang.System.*;
 

itests/gh_fetch_release_assets.java

@@ -1,6 +1,6 @@
 ///usr/bin/env jbang "$0" "$@" ; exit $?
-///JAVA_OPTIONS --add-opens java.base/java.net=ALL-UNNAMED
-///JAVA_OPTIONS --add-opens java.base/sun.net.www.protocol.https=ALL-UNNAMED
+///RUNTIME_OPTIONS --add-opens java.base/java.net=ALL-UNNAMED
+///RUNTIME_OPTIONS --add-opens java.base/sun.net.www.protocol.https=ALL-UNNAMED
 //DEPS info.picocli:picocli:4.6.3
 //DEPS org.kohsuke:github-api:1.116
 

itests/helloworld.java

@@ -1,6 +1,6 @@
 ///usr/bin/env jbang "$0" "$@" ; exit $?
 // //DEPS <dependency1> <dependency2>
-//JAVA_OPTIONS -Dfoo=bar "-Dbar=aap noot mies"
+//RUNTIME_OPTIONS -Dfoo=bar "-Dbar=aap noot mies"
 //MANIFEST foo bar=baz baz=${bazprop:nada}
 
 import static java.lang.System.*;

itests/with space/helloworld.java

@@ -1,6 +1,6 @@
 ///usr/bin/env jbang "$0" "$@" ; exit $?
 // //DEPS <dependency1> <dependency2>
-//JAVA_OPTIONS -Dfoo=bar "-Dbar=aap noot mies"
+//RUNTIME_OPTIONS -Dfoo=bar "-Dbar=aap noot mies"
 //MANIFEST foo bar=baz baz=${bazprop:nada}
 
 import static java.lang.System.*;

src/main/java/dev/jbang/catalog/Alias.java

@@ -33,9 +33,11 @@ public class Alias extends CatalogItem {
 	public final String mainClass;
 	@SerializedName(value = "compile-options")
 	public final List<String> compileOptions;
+	@SerializedName(value = "native-options")
+	public final List<String> nativeOptions;
 
 	private Alias() {
-		this(null, null, null, null, null, null, null, null, null, null, null, null, null, null);
+		this(null, null, null, null, null, null, null, null, null, null, null, null, null, null, null);
 	}
 
 	public Alias(String scriptRef,
@@ -51,6 +53,7 @@ public Alias(String scriptRef,
 			String javaVersion,
 			String mainClass,
 			List<String> compileOptions,
+			List<String> nativeOptions,
 			Catalog catalog) {
 		super(catalog);
 		this.scriptRef = scriptRef;
@@ -66,6 +69,7 @@ public Alias(String scriptRef,
 		this.javaVersion = javaVersion;
 		this.mainClass = mainClass;
 		this.compileOptions = compileOptions;
+		this.nativeOptions = nativeOptions;
 	}
 
 	/**
@@ -145,9 +149,11 @@ private static Alias merge(Alias a1, String name, Function<String, Alias> findUn
 			String mainClass = a1.mainClass != null ? a1.mainClass : a2.mainClass;
 			List<String> copts = a1.compileOptions != null && !a1.compileOptions.isEmpty() ? a1.compileOptions
 					: a2.compileOptions;
+			List<String> nopts = a1.nativeOptions != null && !a1.nativeOptions.isEmpty() ? a1.nativeOptions
+					: a2.nativeOptions;
 			Catalog catalog = a2.catalog != null ? a2.catalog : a1.catalog;
 			return new Alias(a2.scriptRef, desc, args, jopts, srcs, ress, deps, repos, cpaths, props, javaVersion,
-					mainClass, copts, catalog);
+					mainClass, copts, nopts, catalog);
 		} else {
 			return a1;
 		}

src/main/java/dev/jbang/catalog/Catalog.java

@@ -58,7 +58,7 @@ public Catalog(String baseRef, String description, ResourceRef catalogRef, Map<S
 		aliases.forEach((key, a) -> this.aliases.put(key,
 				new Alias(a.scriptRef, a.description, a.arguments, a.runtimeOptions, a.sources, a.resources,
 						a.dependencies, a.repositories, a.classpaths, a.properties, a.javaVersion, a.mainClass,
-						a.compileOptions, this)));
+						a.compileOptions, a.nativeOptions, this)));
 		templates.forEach((key, t) -> this.templates.put(key,
 				new Template(t.fileRefs, t.description, t.properties, this)));
 	}

src/main/java/dev/jbang/catalog/CatalogUtil.java

@@ -43,10 +43,12 @@ public static Path addNearestAlias(String name,
 			Map<String, String> properties,
 			String javaVersion,
 			String mainClass,
-			List<String> compileOptions) {
+			List<String> compileOptions,
+			List<String> nativeOptions) {
 		Path catalogFile = Catalog.getCatalogFile(null);
 		addAlias(catalogFile, name, scriptRef, description, arguments, javaRuntimeOptions, sources, resources,
-				dependencies, repositories, classPaths, properties, javaVersion, mainClass, compileOptions);
+				dependencies, repositories, classPaths, properties, javaVersion, mainClass, compileOptions,
+				nativeOptions);
 		return catalogFile;
 	}
 
@@ -70,13 +72,15 @@ public static Alias addAlias(Path catalogFile,
 			Map<String, String> properties,
 			String javaVersion,
 			String mainClass,
-			List<String> compileOptions) {
+			List<String> compileOptions,
+			List<String> nativeOptions) {
 		Path cwd = Util.getCwd();
 		catalogFile = cwd.resolve(catalogFile);
 		Catalog catalog = Catalog.get(catalogFile);
 		scriptRef = catalog.relativize(scriptRef);
 		Alias alias = new Alias(scriptRef, description, arguments, javaRuntimeOptions, sources, resources,
-				dependencies, repositories, classPaths, properties, javaVersion, mainClass, compileOptions, catalog);
+				dependencies, repositories, classPaths, properties, javaVersion, mainClass, compileOptions,
+				nativeOptions, catalog);
 		catalog.aliases.put(name, alias);
 		try {
 			catalog.write();

src/main/java/dev/jbang/cli/Alias.java

@@ -106,13 +106,13 @@ public Integer doCall() {
 					scriptMixin.sources, scriptMixin.resources, dependencyInfoMixin.getDependencies(),
 					dependencyInfoMixin.getRepositories(), dependencyInfoMixin.getClasspaths(),
 					dependencyInfoMixin.getProperties(), buildMixin.javaVersion, buildMixin.main,
-					buildMixin.compileOptions);
+					buildMixin.compileOptions, buildMixin.nativeOptions);
 		} else {
 			catFile = CatalogUtil.addNearestAlias(name, scriptMixin.scriptOrFile, desc, userParams, javaRuntimeOptions,
 					scriptMixin.sources, scriptMixin.resources, dependencyInfoMixin.getDependencies(),
 					dependencyInfoMixin.getRepositories(), dependencyInfoMixin.getClasspaths(),
 					dependencyInfoMixin.getProperties(), buildMixin.javaVersion, buildMixin.main,
-					buildMixin.compileOptions);
+					buildMixin.compileOptions, buildMixin.nativeOptions);
 		}
 		info(String.format("Alias '%s' added to '%s'", name, catFile));
 		return EXIT_OK;
@@ -131,7 +131,7 @@ ProjectBuilder createProjectBuilder() {
 											.javaVersion(buildMixin.javaVersion)
 											.mainClass(buildMixin.main)
 											.setArguments(userParams)
-											.javaOptions(javaRuntimeOptions);
+											.runtimeOptions(javaRuntimeOptions);
 		Path cat = getCatalog(false);
 		if (cat != null) {
 			pb.catalog(cat.toFile());

src/main/java/dev/jbang/cli/BuildMixin.java

@@ -23,4 +23,7 @@ void setJavaVersion(String javaVersion) {
 
 	@CommandLine.Option(names = { "-C", "--compile-option" }, description = "Options to pass to the compiler")
 	public List<String> compileOptions;
+
+	@CommandLine.Option(names = { "-N", "--native-option" }, description = "Options to pass to the native image tool")
+	public List<String> nativeOptions;
 }