Package io.github.cdklabs.projen

Interface CreateProjectOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CreateProjectOptions.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CreateProjectOptions.Builder	builder()
String	getDir()	(experimental) Directory that the project will be generated in.
default InitProjectOptionHints	getOptionHints()	(experimental) Should we render commented-out default options in the projenrc file?
default Boolean	getPost()	(experimental) Should we execute post synthesis hooks?
String	getProjectFqn()	(experimental) Fully-qualified name of the project type (usually formatted as projen.module.ProjectType).
Map<String,Object>	getProjectOptions()	(experimental) Project options.
default Boolean	getSynth()	(experimental) Should we call project.synth() or instantiate the project (could still have side-effects) and render the .projenrc file.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDir

@Stability(Experimental)
@NotNull
String getDir()

(experimental) Directory that the project will be generated in.

getProjectFqn

@Stability(Experimental)
@NotNull
String getProjectFqn()

(experimental) Fully-qualified name of the project type (usually formatted as projen.module.ProjectType).

Example:

 `projen.typescript.TypescriptProject`
 

getProjectOptions

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

(experimental) Project options.

Only JSON-like values can be passed in (strings, booleans, numbers, enums, arrays, and objects that are not derived from classes).

Consult the API reference of the project type you are generating for information about what fields and types are available.

getOptionHints

@Stability(Experimental)
@Nullable
default InitProjectOptionHints getOptionHints()

(experimental) Should we render commented-out default options in the projenrc file?

Does not apply to projenrc.json files.

Default: InitProjectOptionHints.FEATURED

getPost

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

(experimental) Should we execute post synthesis hooks?

(usually package manager install).

Default: true

getSynth

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

(experimental) Should we call project.synth() or instantiate the project (could still have side-effects) and render the .projenrc file.

Default: true

builder

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

Returns:

a CreateProjectOptions.Builder of CreateProjectOptions