Package io.github.cdklabs.projen

Class Project.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<Project>
    Enclosing class:
    Project
    @Stability(Experimental)
public static final class Project.Builder
extends Object
implements software.amazon.jsii.Builder<Project>
    (experimental) A fluent builder for Project.

    • Method Detail

      • name

        @Stability(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

      • commitGenerated

        @Stability(Experimental)
public Project.Builder commitGenerated​(Boolean commitGenerated)
        (experimental) Whether to commit the managed files by default.

        Default: true

        Parameters:
        commitGenerated - Whether to commit the managed files by default. This parameter is required.
        Returns:
        this

      • gitIgnoreOptions

        @Stability(Experimental)
public Project.Builder gitIgnoreOptions​(IgnoreFileOptions gitIgnoreOptions)
        (experimental) Configuration options for .gitignore file.

        Parameters:
        gitIgnoreOptions - Configuration options for .gitignore file. This parameter is required.
        Returns:
        this

      • gitOptions

        @Stability(Experimental)
public Project.Builder gitOptions​(GitOptions gitOptions)
        (experimental) Configuration options for git.

        Parameters:
        gitOptions - Configuration options for git. This parameter is required.
        Returns:
        this

      • logging

        @Stability(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(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 subprojects.

        Default: "."

        Parameters:
        outdir - The root directory of the project. This parameter is required.
        Returns:
        this

      • parent

        @Stability(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(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(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(Experimental)
public Project.Builder projenrcJsonOptions​(ProjenrcJsonOptions projenrcJsonOptions)
        (experimental) Options for .projenrc.json.

        Default: - default options

        Parameters:
        projenrcJsonOptions - Options for .projenrc.json. This parameter is required.
        Returns:
        this

      • renovatebot

        @Stability(Experimental)
public Project.Builder renovatebot​(Boolean renovatebot)
        (experimental) Use renovatebot to handle dependency upgrades.

        Default: false

        Parameters:
        renovatebot - Use renovatebot to handle dependency upgrades. This parameter is required.
        Returns:
        this

      • renovatebotOptions

        @Stability(Experimental)
public Project.Builder renovatebotOptions​(RenovatebotOptions renovatebotOptions)
        (experimental) Options for renovatebot.

        Default: - default options

        Parameters:
        renovatebotOptions - Options for renovatebot. This parameter is required.
        Returns:
        this

      • build

        @Stability(Experimental)
public Project build()
        Specified by:
        build in interface software.amazon.jsii.Builder<Project>
        Returns:
        a newly built instance of Project.