Package io.github.cdklabs.projen

Interface InitProject

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

InitProject.Jsii$Proxy

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

(experimental) Information passed from projen new to the project object when the project is first created.

It is used to generate projenrc files in various languages.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static InitProject.Builder	builder()
Map<String,Object>	getArgs()	(experimental) Initial arguments passed to projen new.
InitProjectOptionHints	getComments()	(experimental) Include commented out options.
String	getFqn()	(experimental) The JSII FQN of the project type.
ProjectType	getType()	(experimental) Project metadata.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getArgs

@Stability(Experimental)
@NotNull
Map<String,Object> getArgs()

(experimental) Initial arguments passed to projen new.

getComments

@Stability(Experimental)
@NotNull
InitProjectOptionHints getComments()

(experimental) Include commented out options.

Does not apply to projenrc.json files.

Default: InitProjectOptionHints.FEATURED

getFqn

@Stability(Experimental)
@NotNull
String getFqn()

(experimental) The JSII FQN of the project type.

getType

@Stability(Experimental)
@NotNull
ProjectType getType()

(experimental) Project metadata.

builder

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

Returns:

a InitProject.Builder of InitProject