Package io.github.cdklabs.projen.java

Interface ProjenrcOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ProjenrcOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.147Z")
@Stability(Experimental)
public interface ProjenrcOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for Projenrc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ProjenrcOptions.Builder	A builder for ProjenrcOptions
static class	ProjenrcOptions.Jsii$Proxy	An implementation for ProjenrcOptions

Method Summary

Modifier and Type	Method	Description
static ProjenrcOptions.Builder	builder()
default String	getClassName()	(experimental) The name of the Java class which contains the main() method for projen.
default String	getProjenVersion()	(experimental) The projen version to use.
default Boolean	getTestScope()	(experimental) Defines projenrc under the test scope instead of the main scope, which is reserved to the app.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClassName

@Stability(Experimental)
@Nullable
default String getClassName()

(experimental) The name of the Java class which contains the main() method for projen.

Default: "projenrc"

getProjenVersion

@Stability(Experimental)
@Nullable
default String getProjenVersion()

(experimental) The projen version to use.

Default: - current version

getTestScope

@Stability(Experimental)
@Nullable
default Boolean getTestScope()

(experimental) Defines projenrc under the test scope instead of the main scope, which is reserved to the app.

This means that projenrc will be under src/test/java/projenrc.java and projen will be defined as a test dependency. This enforces that application code does not take a dependency on projen code.

If this is disabled, projenrc should be under src/main/java/projenrc.java.

Default: true

builder

@Stability(Experimental)
static ProjenrcOptions.Builder builder()

Returns:

a ProjenrcOptions.Builder of ProjenrcOptions