Package io.github.cdklabs.projen

Class ProjectOptions.Builder

java.lang.Object

io.github.cdklabs.projen.ProjectOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ProjectOptions>

Enclosing interface:

ProjectOptions

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

A builder for ProjectOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ProjectOptions	build()	Builds the configured instance.
ProjectOptions.Builder	commitGenerated(Boolean commitGenerated)	Sets the value of ProjectOptions.getCommitGenerated()
ProjectOptions.Builder	gitIgnoreOptions(IgnoreFileOptions gitIgnoreOptions)	Sets the value of ProjectOptions.getGitIgnoreOptions()
ProjectOptions.Builder	gitOptions(GitOptions gitOptions)	Sets the value of ProjectOptions.getGitOptions()
ProjectOptions.Builder	logging(LoggerOptions logging)	Sets the value of ProjectOptions.getLogging()
ProjectOptions.Builder	name(String name)	Sets the value of ProjectOptions.getName()
ProjectOptions.Builder	outdir(String outdir)	Sets the value of ProjectOptions.getOutdir()
ProjectOptions.Builder	parent(Project parent)	Sets the value of ProjectOptions.getParent()
ProjectOptions.Builder	projenCommand(String projenCommand)	Sets the value of ProjectOptions.getProjenCommand()
ProjectOptions.Builder	projenrcJson(Boolean projenrcJson)	Sets the value of ProjectOptions.getProjenrcJson()
ProjectOptions.Builder	projenrcJsonOptions(ProjenrcJsonOptions projenrcJsonOptions)	Sets the value of ProjectOptions.getProjenrcJsonOptions()
ProjectOptions.Builder	renovatebot(Boolean renovatebot)	Sets the value of ProjectOptions.getRenovatebot()
ProjectOptions.Builder	renovatebotOptions(RenovatebotOptions renovatebotOptions)	Sets the value of ProjectOptions.getRenovatebotOptions()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

name

@Stability(Experimental)
public ProjectOptions.Builder name(String name)

Sets the value of ProjectOptions.getName()

Parameters:

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

Returns:

this

commitGenerated

@Stability(Experimental)
public ProjectOptions.Builder commitGenerated(Boolean commitGenerated)

Sets the value of ProjectOptions.getCommitGenerated()

Parameters:

commitGenerated - Whether to commit the managed files by default.

Returns:

this

gitIgnoreOptions

@Stability(Experimental)
public ProjectOptions.Builder gitIgnoreOptions(IgnoreFileOptions gitIgnoreOptions)

Sets the value of ProjectOptions.getGitIgnoreOptions()

Parameters:

gitIgnoreOptions - Configuration options for .gitignore file.

Returns:

this

gitOptions

@Stability(Experimental)
public ProjectOptions.Builder gitOptions(GitOptions gitOptions)

Sets the value of ProjectOptions.getGitOptions()

Parameters:

gitOptions - Configuration options for git.

Returns:

this

logging

@Stability(Experimental)
public ProjectOptions.Builder logging(LoggerOptions logging)

Sets the value of ProjectOptions.getLogging()

Parameters:

logging - Configure logging options such as verbosity.

Returns:

this

outdir

@Stability(Experimental)
public ProjectOptions.Builder outdir(String outdir)

Sets the value of ProjectOptions.getOutdir()

Parameters:

outdir - 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 subprojects.

Returns:

this

parent

@Stability(Experimental)
public ProjectOptions.Builder parent(Project parent)

Sets the value of ProjectOptions.getParent()

Parameters:

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

Returns:

this

projenCommand

@Stability(Experimental)
public ProjectOptions.Builder projenCommand(String projenCommand)

Sets the value of ProjectOptions.getProjenCommand()

Parameters:

projenCommand - The shell command to use in order to run the projen CLI. Can be used to customize in special environments.

Returns:

this

projenrcJson

@Stability(Experimental)
public ProjectOptions.Builder projenrcJson(Boolean projenrcJson)

Sets the value of ProjectOptions.getProjenrcJson()

Parameters:

projenrcJson - Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

Returns:

this

projenrcJsonOptions

@Stability(Experimental)
public ProjectOptions.Builder projenrcJsonOptions(ProjenrcJsonOptions projenrcJsonOptions)

Sets the value of ProjectOptions.getProjenrcJsonOptions()

Parameters:

projenrcJsonOptions - Options for .projenrc.json.

Returns:

this

renovatebot

@Stability(Experimental)
public ProjectOptions.Builder renovatebot(Boolean renovatebot)

Sets the value of ProjectOptions.getRenovatebot()

Parameters:

renovatebot - Use renovatebot to handle dependency upgrades.

Returns:

this

renovatebotOptions

@Stability(Experimental)
public ProjectOptions.Builder renovatebotOptions(RenovatebotOptions renovatebotOptions)

Sets the value of ProjectOptions.getRenovatebotOptions()

Parameters:

renovatebotOptions - Options for renovatebot.

Returns:

this

build

@Stability(Experimental)
public ProjectOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ProjectOptions

Throws:

NullPointerException - if any required attribute was not provided