io.github.cdklabs.projen

Class Project.Builder

java.lang.Object

io.github.cdklabs.projen.Project.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Project>

Enclosing class:

Project

@Stability(value=Experimental)
public static final class Project.Builder
extends Object
implements software.amazon.jsii.Builder<Project>

(experimental) A fluent builder for Project.

Method Summary

Modifier and Type	Method and Description
Project	build()
static Project.Builder	create()
Project.Builder	logging(LoggerOptions logging) (experimental) Configure logging options such as verbosity.
Project.Builder	name(String name) (experimental) This is the name of your project.
Project.Builder	outdir(String outdir) (experimental) The root directory of the project.
Project.Builder	parent(Project parent) (experimental) The parent project, if this project is part of a bigger project.
Project.Builder	projenCommand(String projenCommand) (experimental) The shell command to use in order to run the projen CLI.
Project.Builder	projenrcJson(Boolean projenrcJson) (experimental) Generate (once) .projenrc.json (in JSON).
Project.Builder	projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions) (experimental) Options for .projenrc.json.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static Project.Builder create()

Returns:

a new instance of Project.Builder.

name

@Stability(value=Experimental)
public Project.Builder name(String name)

(experimental) This is the name of your project.

Default: $BASEDIR

Parameters:

name - This is the name of your project. This parameter is required.

Returns:

this

logging

@Stability(value=Experimental)
public Project.Builder logging(LoggerOptions logging)

(experimental) Configure logging options such as verbosity.

Default: {}

Parameters:

logging - Configure logging options such as verbosity. This parameter is required.

Returns:

this

outdir

@Stability(value=Experimental)
public Project.Builder outdir(String outdir)

(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: "."

Parameters:

outdir - The root directory of the project. This parameter is required.

Returns:

this

parent

@Stability(value=Experimental)
public Project.Builder parent(Project parent)

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

Parameters:

parent - The parent project, if this project is part of a bigger project. This parameter is required.

Returns:

this

projenCommand

@Stability(value=Experimental)
public Project.Builder projenCommand(String projenCommand)

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

Can be used to customize in special environments.

Default: "npx projen"

Parameters:

projenCommand - The shell command to use in order to run the projen CLI. This parameter is required.

Returns:

this

projenrcJson

@Stability(value=Experimental)
public Project.Builder projenrcJson(Boolean projenrcJson)

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

Default: false

Parameters:

projenrcJson - Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. This parameter is required.

Returns:

this

projenrcJsonOptions

@Stability(value=Experimental)
public Project.Builder projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions)

(experimental) Options for .projenrc.json.

Default: - default options

Parameters:

projenrcJsonOptions - Options for .projenrc.json. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public Project build()

Specified by:

build in interface software.amazon.jsii.Builder<Project>