Package io.github.cdklabs.projen

Interface ProjectOptions

    • Method Detail

      • getName

        @Stability(Experimental)
@NotNull
String getName()
        (experimental) This is the name of your project.

        Default: $BASEDIR

      • getCommitGenerated

        @Stability(Experimental)
@Nullable
default Boolean getCommitGenerated()
        (experimental) Whether to commit the managed files by default.

        Default: true

      • getGitIgnoreOptions

        @Stability(Experimental)
@Nullable
default IgnoreFileOptions getGitIgnoreOptions()
        (experimental) Configuration options for .gitignore file.

      • getGitOptions

        @Stability(Experimental)
@Nullable
default GitOptions getGitOptions()
        (experimental) Configuration options for git.

      • getLogging

        @Stability(Experimental)
@Nullable
default LoggerOptions getLogging()
        (experimental) Configure logging options such as verbosity.

        Default: {}

      • getOutdir

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

        Default: "."

      • getParent

        @Stability(Experimental)
@Nullable
default Project getParent()
        (experimental) The parent project, if this project is part of a bigger project.

      • getProjenCommand

        @Stability(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(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(Experimental)
@Nullable
default ProjenrcJsonOptions getProjenrcJsonOptions()
        (experimental) Options for .projenrc.json.

        Default: - default options

      • getRenovatebot

        @Stability(Experimental)
@Nullable
default Boolean getRenovatebot()
        (experimental) Use renovatebot to handle dependency upgrades.

        Default: false

      • getRenovatebotOptions

        @Stability(Experimental)
@Nullable
default RenovatebotOptions getRenovatebotOptions()
        (experimental) Options for renovatebot.

        Default: - default options