io.github.cdklabs.projen

Interface ProjectOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AwsCdkConstructLibraryOptions, AwsCdkJavaAppOptions, AwsCdkTypeScriptAppOptions, Cdk8sTypeScriptAppOptions, ConstructLibraryAwsOptions, ConstructLibraryCdk8sOptions, ConstructLibraryCdktfOptions, ConstructLibraryOptions, GitHubProjectOptions, JavaProjectCommonOptions, JavaProjectOptions, JsiiProjectOptions, NextJsProjectOptions, NextJsTypeScriptProjectOptions, NodeProjectOptions, PythonProjectOptions, ReactProjectOptions, ReactTypeScriptProjectOptions, TypeScriptLibraryProjectOptions, TypeScriptProjectOptions

All Known Implementing Classes:

AwsCdkConstructLibraryOptions.Jsii$Proxy, AwsCdkJavaAppOptions.Jsii$Proxy, AwsCdkTypeScriptAppOptions.Jsii$Proxy, Cdk8sTypeScriptAppOptions.Jsii$Proxy, ConstructLibraryAwsOptions.Jsii$Proxy, ConstructLibraryCdk8sOptions.Jsii$Proxy, ConstructLibraryCdktfOptions.Jsii$Proxy, ConstructLibraryOptions.Jsii$Proxy, GitHubProjectOptions.Jsii$Proxy, JavaProjectCommonOptions.Jsii$Proxy, JavaProjectOptions.Jsii$Proxy, JsiiProjectOptions.Jsii$Proxy, NextJsProjectOptions.Jsii$Proxy, NextJsTypeScriptProjectOptions.Jsii$Proxy, NodeProjectOptions.Jsii$Proxy, ProjectOptions.Jsii$Proxy, PythonProjectOptions.Jsii$Proxy, ReactProjectOptions.Jsii$Proxy, ReactTypeScriptProjectOptions.Jsii$Proxy, TypeScriptLibraryProjectOptions.Jsii$Proxy, TypeScriptProjectOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.432Z")
 @Stability(value=Experimental)
public interface ProjectOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for `Project`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ProjectOptions.Builder	builder()
default LoggerOptions	getLogging() (experimental) Configure logging options such as verbosity.
String	getName() (experimental) This is the name of your project.
default String	getOutdir() (experimental) The root directory of the project.
default Project	getParent() (experimental) The parent project, if this project is part of a bigger project.
default String	getProjenCommand() (experimental) The shell command to use in order to run the projen CLI.
default Boolean	getProjenrcJson() (experimental) Generate (once) .projenrc.json (in JSON).
default ProjenrcOptions	getProjenrcJsonOptions() (experimental) Options for .projenrc.json.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Experimental)
 @NotNull
String getName()

(experimental) This is the name of your project.

Default: $BASEDIR

getLogging

@Stability(value=Experimental)
 @Nullable
default LoggerOptions getLogging()

(experimental) Configure logging options such as verbosity.

Default: {}

getOutdir

@Stability(value=Experimental)
 @Nullable
default String getOutdir()

(experimental) The root directory of the project.

Relative to this directory, all files are synthesized.

If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects.

Default: "."

getParent

@Stability(value=Experimental)
 @Nullable
default Project getParent()

(experimental) The parent project, if this project is part of a bigger project.

getProjenCommand

@Stability(value=Experimental)
 @Nullable
default String getProjenCommand()

(experimental) The shell command to use in order to run the projen CLI.

Can be used to customize in special environments.

Default: "npx projen"

getProjenrcJson

@Stability(value=Experimental)
 @Nullable
default Boolean getProjenrcJson()

(experimental) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.

Default: false

getProjenrcJsonOptions

@Stability(value=Experimental)
 @Nullable
default ProjenrcOptions getProjenrcJsonOptions()

(experimental) Options for .projenrc.json.

Default: - default options

builder

@Stability(value=Experimental)
static ProjectOptions.Builder builder()

Returns:

a ProjectOptions.Builder of ProjectOptions