JsiiProject.Builder (io.github.cdklabs:projen 0.45.3 API)

java.lang.Object
- io.github.cdklabs.projen.cdk.JsiiProject.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<JsiiProject>

Enclosing class:: JsiiProject

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

(experimental) A fluent builder for JsiiProject.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`JsiiProject.Builder`	`allowLibraryDependencies(Boolean allowLibraryDependencies)` (experimental) Allow the project to include `peerDependencies` and `bundledDependencies`.
`JsiiProject.Builder`	`antitamper(Boolean antitamper)` (experimental) Checks that after build there are no modified files on git.
`JsiiProject.Builder`	`artifactsDirectory(String artifactsDirectory)` (experimental) A directory which will contain artifacts to be published to npm.
`JsiiProject.Builder`	`author(String author)` (experimental) The name of the library author.
`JsiiProject.Builder`	`authorAddress(String authorAddress)` (experimental) Email or URL of the library author.
`JsiiProject.Builder`	`authorEmail(String authorEmail)` (experimental) Author's e-mail.
`JsiiProject.Builder`	`authorName(String authorName)` (experimental) Author's name.
`JsiiProject.Builder`	`authorOrganization(Boolean authorOrganization)` (experimental) Author's Organization.
`JsiiProject.Builder`	`authorUrl(String authorUrl)` (experimental) Author's URL / Website.
`JsiiProject.Builder`	`autoApproveOptions(AutoApproveOptions autoApproveOptions)` (experimental) Enable and configure the 'auto approve' workflow.
`JsiiProject.Builder`	`autoApproveProjenUpgrades(Boolean autoApproveProjenUpgrades)` (experimental) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).
`JsiiProject.Builder`	`autoApproveUpgrades(Boolean autoApproveUpgrades)` (experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
`JsiiProject.Builder`	`autoDetectBin(Boolean autoDetectBin)` (experimental) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
`JsiiProject.Builder`	`autoMergeOptions(AutoMergeOptions autoMergeOptions)` (experimental) Configure options for automatic merging on GitHub.
`JsiiProject.Builder`	`bin(Map<String,String> bin)` (experimental) Binary programs vended with your module.
`JsiiProject`	`build()`
`JsiiProject.Builder`	`buildWorkflow(Boolean buildWorkflow)` (experimental) Define a GitHub workflow for building PRs.
`JsiiProject.Builder`	`bundledDeps(List<String> bundledDeps)` (experimental) List of dependencies to bundle into this module.
`JsiiProject.Builder`	`bundlerOptions(BundlerOptions bundlerOptions)` (experimental) Options for `Bundler`.
`JsiiProject.Builder`	`clobber(Boolean clobber)` (experimental) Add a `clobber` task which resets the repo to origin.
`JsiiProject.Builder`	`codeArtifactOptions(CodeArtifactOptions codeArtifactOptions)` (experimental) Options for publishing npm package to AWS CodeArtifact.
`JsiiProject.Builder`	`codeCov(Boolean codeCov)` (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos.
`JsiiProject.Builder`	`codeCovTokenSecret(String codeCovTokenSecret)` (experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
`JsiiProject.Builder`	`compat(Boolean compat)` (experimental) Automatically run API compatibility test against the latest version published to npm after compilation.
`JsiiProject.Builder`	`compatIgnore(String compatIgnore)` (experimental) Name of the ignore file for API compatibility tests.
`JsiiProject.Builder`	`copyrightOwner(String copyrightOwner)` (experimental) License copyright owner.
`JsiiProject.Builder`	`copyrightPeriod(String copyrightPeriod)` (experimental) The copyright years to put in the LICENSE file.
`static JsiiProject.Builder`	`create()`
`JsiiProject.Builder`	`defaultReleaseBranch(String defaultReleaseBranch)` (experimental) The name of the main release branch.
`JsiiProject.Builder`	`dependabot(Boolean dependabot)` (experimental) Use dependabot to handle dependency upgrades.
`JsiiProject.Builder`	`dependabotOptions(DependabotOptions dependabotOptions)` (experimental) Options for dependabot.
`JsiiProject.Builder`	`deps(List<String> deps)` (experimental) Runtime dependencies of this module.
`JsiiProject.Builder`	`depsUpgrade(Boolean depsUpgrade)` (experimental) Use github workflows to handle dependency upgrades.
`JsiiProject.Builder`	`depsUpgradeOptions(UpgradeDependenciesOptions depsUpgradeOptions)` (experimental) Options for depsUpgrade.
`JsiiProject.Builder`	`description(String description)` (experimental) The description is just a string that helps people understand the purpose of the package.
`JsiiProject.Builder`	`devContainer(Boolean devContainer)` (experimental) Add a VSCode development environment (used for GitHub Codespaces).
`JsiiProject.Builder`	`devDeps(List<String> devDeps)` (experimental) Build dependencies for this module.
`JsiiProject.Builder`	`disableTsconfig(Boolean disableTsconfig)` (experimental) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
`JsiiProject.Builder`	`docgen(Boolean docgen)` (experimental) Docgen by Typedoc.
`JsiiProject.Builder`	`docsDirectory(String docsDirectory)` (experimental) Docs directory.
`JsiiProject.Builder`	`dotnet(JsiiDotNetTarget dotnet)` Deprecated. use `publishToNuget`
`JsiiProject.Builder`	`entrypoint(String entrypoint)` (experimental) Module entrypoint (`main` in `package.json`).
`JsiiProject.Builder`	`entrypointTypes(String entrypointTypes)` (experimental) The .d.ts file that includes the type declarations for this module.
`JsiiProject.Builder`	`eslint(Boolean eslint)` (experimental) Setup eslint.
`JsiiProject.Builder`	`eslintOptions(EslintOptions eslintOptions)` (experimental) Eslint options.
`JsiiProject.Builder`	`excludeTypescript(List<String> excludeTypescript)` (experimental) Accepts a list of glob patterns.
`JsiiProject.Builder`	`github(Boolean github)` (experimental) Enable GitHub integration.
`JsiiProject.Builder`	`githubOptions(GitHubOptions githubOptions)` (experimental) Options for GitHub integration.
`JsiiProject.Builder`	`gitignore(List<String> gitignore)` (experimental) Additional entries to .gitignore.
`JsiiProject.Builder`	`gitpod(Boolean gitpod)` (experimental) Add a Gitpod development environment.
`JsiiProject.Builder`	`homepage(String homepage)` (experimental) Package's Homepage / Website.
`JsiiProject.Builder`	`jest(Boolean jest)` (experimental) Setup jest unit tests.
`JsiiProject.Builder`	`jestOptions(JestOptions jestOptions)` (experimental) Jest options.
`JsiiProject.Builder`	`jsiiReleaseVersion(String jsiiReleaseVersion)` (experimental) Version requirement of `jsii-release` which is used to publish modules to npm.
`JsiiProject.Builder`	`keywords(List<String> keywords)` (experimental) Keywords to include in `package.json`.
`JsiiProject.Builder`	`libdir(String libdir)` (experimental) Typescript artifacts output directory.
`JsiiProject.Builder`	`license(String license)` (experimental) License's SPDX identifier.
`JsiiProject.Builder`	`licensed(Boolean licensed)` (experimental) Indicates if a license should be added.
`JsiiProject.Builder`	`logging(LoggerOptions logging)` (experimental) Configure logging options such as verbosity.
`JsiiProject.Builder`	`majorVersion(Number majorVersion)` (experimental) Major version to release from the default branch.
`JsiiProject.Builder`	`maxNodeVersion(String maxNodeVersion)` (experimental) Minimum node.js version to require via `engines` (inclusive).
`JsiiProject.Builder`	`mergify(Boolean mergify)` Deprecated. use `githubOptions.mergify` instead
`JsiiProject.Builder`	`mergifyOptions(MergifyOptions mergifyOptions)` Deprecated. use `githubOptions.mergifyOptions` instead
`JsiiProject.Builder`	`minNodeVersion(String minNodeVersion)` (experimental) Minimum Node.js version to require via package.json `engines` (inclusive).
`JsiiProject.Builder`	`mutableBuild(Boolean mutableBuild)` (experimental) Automatically update files modified during builds to pull-request branches.
`JsiiProject.Builder`	`name(String name)` (experimental) This is the name of your project.
`JsiiProject.Builder`	`npmAccess(NpmAccess npmAccess)` (experimental) Access level of the npm package.
`JsiiProject.Builder`	`npmDistTag(String npmDistTag)` (experimental) The npmDistTag to use when publishing from the default branch.
`JsiiProject.Builder`	`npmignore(List<String> npmignore)` Deprecated. - use `project.addPackageIgnore`
`JsiiProject.Builder`	`npmignoreEnabled(Boolean npmignoreEnabled)` (experimental) Defines an .npmignore file.
`JsiiProject.Builder`	`npmRegistry(String npmRegistry)` Deprecated. use `npmRegistryUrl` instead
`JsiiProject.Builder`	`npmRegistryUrl(String npmRegistryUrl)` (experimental) The base URL of the npm package registry.
`JsiiProject.Builder`	`npmTokenSecret(String npmTokenSecret)` (experimental) GitHub secret which contains the NPM token to use when publishing packages.
`JsiiProject.Builder`	`outdir(String outdir)` (experimental) The root directory of the project.
`JsiiProject.Builder`	`packageManager(NodePackageManager packageManager)` (experimental) The Node Package Manager used to execute scripts.
`JsiiProject.Builder`	`packageName(String packageName)` (experimental) The "name" in package.json.
`JsiiProject.Builder`	`packageValue(Boolean packageValue)` (experimental) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`.
`JsiiProject.Builder`	`parent(Project parent)` (experimental) The parent project, if this project is part of a bigger project.
`JsiiProject.Builder`	`peerDependencyOptions(PeerDependencyOptions peerDependencyOptions)` (experimental) Options for `peerDeps`.
`JsiiProject.Builder`	`peerDeps(List<String> peerDeps)` (experimental) Peer dependencies for this module.
`JsiiProject.Builder`	`postBuildSteps(List<? extends JobStep> postBuildSteps)` (experimental) Steps to execute after build as part of the release workflow.
`JsiiProject.Builder`	`prerelease(String prerelease)` (experimental) Bump versions from the default branch as pre-releases (e.g.
`JsiiProject.Builder`	`projectType(ProjectType projectType)` Deprecated. no longer supported at the base project level
`JsiiProject.Builder`	`projenCommand(String projenCommand)` (experimental) The shell command to use in order to run the projen CLI.
`JsiiProject.Builder`	`projenDevDependency(Boolean projenDevDependency)` (experimental) Indicates of "projen" should be installed as a devDependency.
`JsiiProject.Builder`	`projenrcJs(Boolean projenrcJs)` (experimental) Generate (once) .projenrc.js (in JavaScript).
`JsiiProject.Builder`	`projenrcJson(Boolean projenrcJson)` (experimental) Generate (once) .projenrc.json (in JSON).
`JsiiProject.Builder`	`projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions)` (experimental) Options for .projenrc.json.
`JsiiProject.Builder`	`projenrcJsOptions(ProjenrcOptions projenrcJsOptions)` (experimental) Options for .projenrc.js.
`JsiiProject.Builder`	`projenrcTs(Boolean projenrcTs)` (experimental) Use TypeScript for your projenrc file (`.projenrc.ts`).
`JsiiProject.Builder`	`projenrcTsOptions(ProjenrcOptions projenrcTsOptions)` (experimental) Options for .projenrc.ts.
`JsiiProject.Builder`	`projenUpgradeAutoMerge(Boolean projenUpgradeAutoMerge)` Deprecated. use `autoApproveProjenUpgrades`.
`JsiiProject.Builder`	`projenUpgradeSchedule(List<String> projenUpgradeSchedule)` (experimental) Customize the projenUpgrade schedule in cron expression.
`JsiiProject.Builder`	`projenUpgradeSecret(String projenUpgradeSecret)` (experimental) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).
`JsiiProject.Builder`	`projenVersion(String projenVersion)` (experimental) Version of projen to install.
`JsiiProject.Builder`	`publishTasks(Boolean publishTasks)` (experimental) Define publishing tasks that can be executed manually as well as workflows.
`JsiiProject.Builder`	`publishToGo(JsiiGoTarget publishToGo)` (experimental) Publish Go bindings to a git repository.
`JsiiProject.Builder`	`publishToMaven(JsiiJavaTarget publishToMaven)` (experimental) Publish to maven.
`JsiiProject.Builder`	`publishToNuget(JsiiDotNetTarget publishToNuget)` (experimental) Publish to NuGet.
`JsiiProject.Builder`	`publishToPypi(JsiiPythonTarget publishToPypi)` (experimental) Publish to pypi.
`JsiiProject.Builder`	`pullRequestTemplate(Boolean pullRequestTemplate)` (experimental) Include a GitHub pull request template.
`JsiiProject.Builder`	`pullRequestTemplateContents(List<String> pullRequestTemplateContents)` (experimental) The contents of the pull request template.
`JsiiProject.Builder`	`python(JsiiPythonTarget python)` Deprecated. use `publishToPyPi`
`JsiiProject.Builder`	`readme(SampleReadmeProps readme)` (experimental) The README setup.
`JsiiProject.Builder`	`release(Boolean release)` (experimental) Add release management to this project.
`JsiiProject.Builder`	`releaseBranches(Map<String,? extends BranchOptions> releaseBranches)` (experimental) Defines additional release branches.
`JsiiProject.Builder`	`releaseEveryCommit(Boolean releaseEveryCommit)` Deprecated. Use `releaseTrigger: ReleaseTrigger.continuous()` instead
`JsiiProject.Builder`	`releaseFailureIssue(Boolean releaseFailureIssue)` (experimental) Create a github issue on every failed publishing task.
`JsiiProject.Builder`	`releaseFailureIssueLabel(String releaseFailureIssueLabel)` (experimental) The label to apply to issues indicating publish failures.
`JsiiProject.Builder`	`releaseSchedule(String releaseSchedule)` Deprecated. Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
`JsiiProject.Builder`	`releaseTagPrefix(String releaseTagPrefix)` (experimental) Automatically add the given prefix to release tags.
`JsiiProject.Builder`	`releaseToNpm(Boolean releaseToNpm)` (experimental) Automatically release to npm when new versions are introduced.
`JsiiProject.Builder`	`releaseTrigger(ReleaseTrigger releaseTrigger)` (experimental) The release trigger to use.
`JsiiProject.Builder`	`releaseWorkflow(Boolean releaseWorkflow)` Deprecated. see `release`.
`JsiiProject.Builder`	`releaseWorkflowName(String releaseWorkflowName)` (experimental) The name of the default release workflow.
`JsiiProject.Builder`	`releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps)` (experimental) A set of workflow steps to execute in order to setup the workflow container.
`JsiiProject.Builder`	`repository(String repository)` (experimental) The repository is the location where the actual code for your package lives.
`JsiiProject.Builder`	`repositoryDirectory(String repositoryDirectory)` (experimental) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
`JsiiProject.Builder`	`repositoryUrl(String repositoryUrl)` (experimental) Git repository URL.
`JsiiProject.Builder`	`rootdir(String rootdir)` Default: "."
`JsiiProject.Builder`	`sampleCode(Boolean sampleCode)` (experimental) Generate one-time sample in `src/` and `test/` if there are no files there.
`JsiiProject.Builder`	`scripts(Map<String,String> scripts)` (experimental) npm scripts to include.
`JsiiProject.Builder`	`srcdir(String srcdir)` (experimental) Typescript sources directory.
`JsiiProject.Builder`	`stability(String stability)` (experimental) Package's Stability.
`JsiiProject.Builder`	`stale(Boolean stale)` (experimental) Auto-close of stale issues and pull request.
`JsiiProject.Builder`	`staleOptions(StaleOptions staleOptions)` (experimental) Auto-close stale issues and pull requests.
`JsiiProject.Builder`	`testdir(String testdir)` (experimental) Jest tests directory.
`JsiiProject.Builder`	`tsconfig(TypescriptConfigOptions tsconfig)` (experimental) Custom TSConfig.
`JsiiProject.Builder`	`tsconfigDev(TypescriptConfigOptions tsconfigDev)` (experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).
`JsiiProject.Builder`	`tsconfigDevFile(String tsconfigDevFile)` (experimental) The name of the development tsconfig.json file.
`JsiiProject.Builder`	`typescriptVersion(String typescriptVersion)` (experimental) TypeScript version to use.
`JsiiProject.Builder`	`versionrcOptions(Map<String,? extends Object> versionrcOptions)` (experimental) Custom configuration used when creating changelog with standard-version package.
`JsiiProject.Builder`	`vscode(Boolean vscode)` (experimental) Enable VSCode integration.
`JsiiProject.Builder`	`workflowBootstrapSteps(List<? extends Object> workflowBootstrapSteps)` (experimental) Workflow steps to use in order to bootstrap this repo.
`JsiiProject.Builder`	`workflowContainerImage(String workflowContainerImage)` (experimental) Container image to use for GitHub workflows.
`JsiiProject.Builder`	`workflowGitIdentity(GitIdentity workflowGitIdentity)` (experimental) The git identity to use in workflows.
`JsiiProject.Builder`	`workflowNodeVersion(String workflowNodeVersion)` (experimental) The node version to use in GitHub workflows.
`JsiiProject.Builder`	`workflowRunsOn(List<String> workflowRunsOn)` (experimental) Github Runner selection labels.

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 JsiiProject.Builder create()
```
    Returns:
    
    a new instance of JsiiProject.Builder.
  - name
```
@Stability(value=Experimental)
public JsiiProject.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 JsiiProject.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 JsiiProject.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 JsiiProject.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 JsiiProject.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 JsiiProject.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 JsiiProject.Builder projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions)
```
    (experimental) Options for .projenrc.json.
    Default: - default options
    
    Parameters:
    
    projenrcJsonOptions - Options for .projenrc.json. This parameter is required.
    
    Returns:
    
    this
  - autoApproveOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder autoApproveOptions(AutoApproveOptions autoApproveOptions)
```
    (experimental) Enable and configure the 'auto approve' workflow.
    Default: - auto approve is disabled
    
    Parameters:
    
    autoApproveOptions - Enable and configure the 'auto approve' workflow. This parameter is required.
    
    Returns:
    
    this
  - autoMergeOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder autoMergeOptions(AutoMergeOptions autoMergeOptions)
```
    (experimental) Configure options for automatic merging on GitHub.
    Has no effect if github.mergify is set to false.
    Default: - see defaults in `AutoMergeOptions`
    
    Parameters:
    
    autoMergeOptions - Configure options for automatic merging on GitHub. This parameter is required.
    
    Returns:
    
    this
  - clobber
```
@Stability(value=Experimental)
public JsiiProject.Builder clobber(Boolean clobber)
```
    (experimental) Add a `clobber` task which resets the repo to origin.
    Default: true
    
    Parameters:
    
    clobber - Add a `clobber` task which resets the repo to origin. This parameter is required.
    
    Returns:
    
    this
  - devContainer
```
@Stability(value=Experimental)
public JsiiProject.Builder devContainer(Boolean devContainer)
```
    (experimental) Add a VSCode development environment (used for GitHub Codespaces).
    Default: false
    
    Parameters:
    
    devContainer - Add a VSCode development environment (used for GitHub Codespaces). This parameter is required.
    
    Returns:
    
    this
  - github
```
@Stability(value=Experimental)
public JsiiProject.Builder github(Boolean github)
```
    (experimental) Enable GitHub integration.
    Enabled by default for root projects. Disabled for non-root projects.
    Default: true
    
    Parameters:
    
    github - Enable GitHub integration. This parameter is required.
    
    Returns:
    
    this
  - githubOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder githubOptions(GitHubOptions githubOptions)
```
    (experimental) Options for GitHub integration.
    Default: - see GitHubOptions
    
    Parameters:
    
    githubOptions - Options for GitHub integration. This parameter is required.
    
    Returns:
    
    this
  - gitpod
```
@Stability(value=Experimental)
public JsiiProject.Builder gitpod(Boolean gitpod)
```
    (experimental) Add a Gitpod development environment.
    Default: false
    
    Parameters:
    
    gitpod - Add a Gitpod development environment. This parameter is required.
    
    Returns:
    
    this
  - mergify
```
@Stability(value=Deprecated)
 @Deprecated
public JsiiProject.Builder mergify(Boolean mergify)
```
    Deprecated. use `githubOptions.mergify` instead
    
    (deprecated) Whether mergify should be enabled on this repository or not.
    Default: true
    
    Parameters:
    
    mergify - Whether mergify should be enabled on this repository or not. This parameter is required.
    
    Returns:
    
    this
  - mergifyOptions
```
@Stability(value=Deprecated)
 @Deprecated
public JsiiProject.Builder mergifyOptions(MergifyOptions mergifyOptions)
```
    Deprecated. use `githubOptions.mergifyOptions` instead
    
    (deprecated) Options for mergify.
    Default: - default options
    
    Parameters:
    
    mergifyOptions - Options for mergify. This parameter is required.
    
    Returns:
    
    this
  - projectType
```
@Stability(value=Deprecated)
 @Deprecated
public JsiiProject.Builder projectType(ProjectType projectType)
```
    Deprecated. no longer supported at the base project level
    
    (deprecated) Which type of project this is (library/app).
    Default: ProjectType.UNKNOWN
    
    Parameters:
    
    projectType - Which type of project this is (library/app). This parameter is required.
    
    Returns:
    
    this
  - readme
```
@Stability(value=Experimental)
public JsiiProject.Builder readme(SampleReadmeProps readme)
```
    (experimental) The README setup.
    Default: - { filename: 'README.md', contents: '# replace this' }
    Example:
    // Example automatically generated from non-compiling source. May contain errors. "{ filename: 'readme.md', contents: '# title' }"
    Parameters:
    
    readme - The README setup. This parameter is required.
    
    Returns:
    
    this
  - stale
```
@Stability(value=Experimental)
public JsiiProject.Builder stale(Boolean stale)
```
    (experimental) Auto-close of stale issues and pull request.
    See staleOptions for options.
    Default: true
    
    Parameters:
    
    stale - Auto-close of stale issues and pull request. This parameter is required.
    
    Returns:
    
    this
  - staleOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder staleOptions(StaleOptions staleOptions)
```
    (experimental) Auto-close stale issues and pull requests.
    To disable set stale to false.
    Default: - see defaults in `StaleOptions`
    
    Parameters:
    
    staleOptions - Auto-close stale issues and pull requests. This parameter is required.
    
    Returns:
    
    this
  - vscode
```
@Stability(value=Experimental)
public JsiiProject.Builder vscode(Boolean vscode)
```
    (experimental) Enable VSCode integration.
    Enabled by default for root projects. Disabled for non-root projects.
    Default: true
    
    Parameters:
    
    vscode - Enable VSCode integration. This parameter is required.
    
    Returns:
    
    this
  - allowLibraryDependencies
```
@Stability(value=Experimental)
public JsiiProject.Builder allowLibraryDependencies(Boolean allowLibraryDependencies)
```
    (experimental) Allow the project to include `peerDependencies` and `bundledDependencies`.
    This is normally only allowed for libraries. For apps, there's no meaning for specifying these.
    Default: true
    
    Parameters:
    
    allowLibraryDependencies - Allow the project to include `peerDependencies` and `bundledDependencies`. This parameter is required.
    
    Returns:
    
    this
  - authorEmail
```
@Stability(value=Experimental)
public JsiiProject.Builder authorEmail(String authorEmail)
```
    (experimental) Author's e-mail.
    
    Parameters:
    
    authorEmail - Author's e-mail. This parameter is required.
    
    Returns:
    
    this
  - authorName
```
@Stability(value=Experimental)
public JsiiProject.Builder authorName(String authorName)
```
    (experimental) Author's name.
    
    Parameters:
    
    authorName - Author's name. This parameter is required.
    
    Returns:
    
    this
  - authorOrganization
```
@Stability(value=Experimental)
public JsiiProject.Builder authorOrganization(Boolean authorOrganization)
```
    (experimental) Author's Organization.
    
    Parameters:
    
    authorOrganization - Author's Organization. This parameter is required.
    
    Returns:
    
    this
  - authorUrl
```
@Stability(value=Experimental)
public JsiiProject.Builder authorUrl(String authorUrl)
```
    (experimental) Author's URL / Website.
    
    Parameters:
    
    authorUrl - Author's URL / Website. This parameter is required.
    
    Returns:
    
    this
  - autoDetectBin
```
@Stability(value=Experimental)
public JsiiProject.Builder autoDetectBin(Boolean autoDetectBin)
```
    (experimental) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
    Default: true
    
    Parameters:
    
    autoDetectBin - Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. This parameter is required.
    
    Returns:
    
    this
  - bin
```
@Stability(value=Experimental)
public JsiiProject.Builder bin(Map<String,String> bin)
```
    (experimental) Binary programs vended with your module.
    You can use this option to add/customize how binaries are represented in your package.json, but unless autoDetectBin is false, every executable file under bin will automatically be added to this section.
    
    Parameters:
    
    bin - Binary programs vended with your module. This parameter is required.
    
    Returns:
    
    this
  - bundledDeps
```
@Stability(value=Experimental)
public JsiiProject.Builder bundledDeps(List<String> bundledDeps)
```
    (experimental) List of dependencies to bundle into this module.
    These modules will be added both to the dependencies section and bundledDependencies section of your package.json.
    The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.
    
    Parameters:
    
    bundledDeps - List of dependencies to bundle into this module. This parameter is required.
    
    Returns:
    
    this
  - codeArtifactOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder codeArtifactOptions(CodeArtifactOptions codeArtifactOptions)
```
    (experimental) Options for publishing npm package to AWS CodeArtifact.
    Default: - undefined
    
    Parameters:
    
    codeArtifactOptions - Options for publishing npm package to AWS CodeArtifact. This parameter is required.
    
    Returns:
    
    this
  - deps
```
@Stability(value=Experimental)
public JsiiProject.Builder deps(List<String> deps)
```
    (experimental) Runtime dependencies of this module.
    The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.
    Default: []
    Example:
    // Example automatically generated from non-compiling source. May contain errors. [ 'express', 'lodash', 'foo@^2' ]
    Parameters:
    
    deps - Runtime dependencies of this module. This parameter is required.
    
    Returns:
    
    this
  - description
```
@Stability(value=Experimental)
public JsiiProject.Builder description(String description)
```
    (experimental) The description is just a string that helps people understand the purpose of the package.
    It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
    
    Parameters:
    
    description - The description is just a string that helps people understand the purpose of the package. This parameter is required.
    
    Returns:
    
    this
  - devDeps
```
@Stability(value=Experimental)
public JsiiProject.Builder devDeps(List<String> devDeps)
```
    (experimental) Build dependencies for this module.
    These dependencies will only be available in your build environment but will not be fetched when this module is consumed.
    The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.
    Default: []
    Example:
    // Example automatically generated from non-compiling source. May contain errors. [ 'typescript', '@types/express' ]
    Parameters:
    
    devDeps - Build dependencies for this module. This parameter is required.
    
    Returns:
    
    this
  - entrypoint
```
@Stability(value=Experimental)
public JsiiProject.Builder entrypoint(String entrypoint)
```
    (experimental) Module entrypoint (`main` in `package.json`).
    Set to an empty string to not include main in your package.json
    Default: "lib/index.js"
    
    Parameters:
    
    entrypoint - Module entrypoint (`main` in `package.json`). This parameter is required.
    
    Returns:
    
    this
  - homepage
```
@Stability(value=Experimental)
public JsiiProject.Builder homepage(String homepage)
```
    (experimental) Package's Homepage / Website.
    
    Parameters:
    
    homepage - Package's Homepage / Website. This parameter is required.
    
    Returns:
    
    this
  - keywords
```
@Stability(value=Experimental)
public JsiiProject.Builder keywords(List<String> keywords)
```
    (experimental) Keywords to include in `package.json`.
    
    Parameters:
    
    keywords - Keywords to include in `package.json`. This parameter is required.
    
    Returns:
    
    this
  - license
```
@Stability(value=Experimental)
public JsiiProject.Builder license(String license)
```
    (experimental) License's SPDX identifier.
    See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the licensed option if you want to no license to be specified.
    Default: "Apache-2.0"
    
    Parameters:
    
    license - License's SPDX identifier. This parameter is required.
    
    Returns:
    
    this
  - licensed
```
@Stability(value=Experimental)
public JsiiProject.Builder licensed(Boolean licensed)
```
    (experimental) Indicates if a license should be added.
    Default: true
    
    Parameters:
    
    licensed - Indicates if a license should be added. This parameter is required.
    
    Returns:
    
    this
  - maxNodeVersion
```
@Stability(value=Experimental)
public JsiiProject.Builder maxNodeVersion(String maxNodeVersion)
```
    (experimental) Minimum node.js version to require via `engines` (inclusive).
    Default: - no max
    
    Parameters:
    
    maxNodeVersion - Minimum node.js version to require via `engines` (inclusive). This parameter is required.
    
    Returns:
    
    this
  - minNodeVersion
```
@Stability(value=Experimental)
public JsiiProject.Builder minNodeVersion(String minNodeVersion)
```
    (experimental) Minimum Node.js version to require via package.json `engines` (inclusive).
    Default: - no "engines" specified
    
    Parameters:
    
    minNodeVersion - Minimum Node.js version to require via package.json `engines` (inclusive). This parameter is required.
    
    Returns:
    
    this
  - npmAccess
```
@Stability(value=Experimental)
public JsiiProject.Builder npmAccess(NpmAccess npmAccess)
```
    (experimental) Access level of the npm package.
    Default: - for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
    
    Parameters:
    
    npmAccess - Access level of the npm package. This parameter is required.
    
    Returns:
    
    this
  - npmRegistry
```
@Stability(value=Deprecated)
 @Deprecated
public JsiiProject.Builder npmRegistry(String npmRegistry)
```
    Deprecated. use `npmRegistryUrl` instead
    
    (deprecated) The host name of the npm registry to publish to.
    Cannot be set together with npmRegistryUrl.
    
    Parameters:
    
    npmRegistry - The host name of the npm registry to publish to. This parameter is required.
    
    Returns:
    
    this
  - npmRegistryUrl
```
@Stability(value=Experimental)
public JsiiProject.Builder npmRegistryUrl(String npmRegistryUrl)
```
    (experimental) The base URL of the npm package registry.
    Must be a URL (e.g. start with "https://" or "http://")
    Default: "https://registry.npmjs.org"
    
    Parameters:
    
    npmRegistryUrl - The base URL of the npm package registry. This parameter is required.
    
    Returns:
    
    this
  - npmTokenSecret
```
@Stability(value=Experimental)
public JsiiProject.Builder npmTokenSecret(String npmTokenSecret)
```
    (experimental) GitHub secret which contains the NPM token to use when publishing packages.
    Default: "NPM_TOKEN"
    
    Parameters:
    
    npmTokenSecret - GitHub secret which contains the NPM token to use when publishing packages. This parameter is required.
    
    Returns:
    
    this
  - packageManager
```
@Stability(value=Experimental)
public JsiiProject.Builder packageManager(NodePackageManager packageManager)
```
    (experimental) The Node Package Manager used to execute scripts.
    Default: NodePackageManager.YARN
    
    Parameters:
    
    packageManager - The Node Package Manager used to execute scripts. This parameter is required.
    
    Returns:
    
    this
  - packageName
```
@Stability(value=Experimental)
public JsiiProject.Builder packageName(String packageName)
```
    (experimental) The "name" in package.json.
    Default: - defaults to project name
    
    Parameters:
    
    packageName - The "name" in package.json. This parameter is required.
    
    Returns:
    
    this
  - peerDependencyOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder peerDependencyOptions(PeerDependencyOptions peerDependencyOptions)
```
    (experimental) Options for `peerDeps`.
    
    Parameters:
    
    peerDependencyOptions - Options for `peerDeps`. This parameter is required.
    
    Returns:
    
    this
  - peerDeps
```
@Stability(value=Experimental)
public JsiiProject.Builder peerDeps(List<String> peerDeps)
```
    (experimental) Peer dependencies for this module.
    Dependencies listed here are required to be installed (and satisfied) by the consumer of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the node_modules tree of your consumers.
    Note that prior to npm@7, peer dependencies are not automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers.
    Unless peerDependencyOptions.pinnedDevDependency is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required.
    Default: []
    
    Parameters:
    
    peerDeps - Peer dependencies for this module. This parameter is required.
    
    Returns:
    
    this
  - repository
```
@Stability(value=Experimental)
public JsiiProject.Builder repository(String repository)
```
    (experimental) The repository is the location where the actual code for your package lives.
    See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
    
    Parameters:
    
    repository - The repository is the location where the actual code for your package lives. This parameter is required.
    
    Returns:
    
    this
  - repositoryDirectory
```
@Stability(value=Experimental)
public JsiiProject.Builder repositoryDirectory(String repositoryDirectory)
```
    (experimental) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
    
    Parameters:
    
    repositoryDirectory - If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. This parameter is required.
    
    Returns:
    
    this
  - scripts
```
@Stability(value=Experimental)
public JsiiProject.Builder scripts(Map<String,String> scripts)
```
    (experimental) npm scripts to include.
    If a script has the same name as a standard script, the standard script will be overwritten.
    Default: {}
    
    Parameters:
    
    scripts - npm scripts to include. This parameter is required.
    
    Returns:
    
    this
  - stability
```
@Stability(value=Experimental)
public JsiiProject.Builder stability(String stability)
```
    (experimental) Package's Stability.
    
    Parameters:
    
    stability - Package's Stability. This parameter is required.
    
    Returns:
    
    this
  - antitamper
```
@Stability(value=Experimental)
public JsiiProject.Builder antitamper(Boolean antitamper)
```
    (experimental) Checks that after build there are no modified files on git.
    Default: true
    
    Parameters:
    
    antitamper - Checks that after build there are no modified files on git. This parameter is required.
    
    Returns:
    
    this
  - artifactsDirectory
```
@Stability(value=Experimental)
public JsiiProject.Builder artifactsDirectory(String artifactsDirectory)
```
    (experimental) A directory which will contain artifacts to be published to npm.
    Default: "dist"
    
    Parameters:
    
    artifactsDirectory - A directory which will contain artifacts to be published to npm. This parameter is required.
    
    Returns:
    
    this
  - jsiiReleaseVersion
```
@Stability(value=Experimental)
public JsiiProject.Builder jsiiReleaseVersion(String jsiiReleaseVersion)
```
    (experimental) Version requirement of `jsii-release` which is used to publish modules to npm.
    Default: "latest"
    
    Parameters:
    
    jsiiReleaseVersion - Version requirement of `jsii-release` which is used to publish modules to npm. This parameter is required.
    
    Returns:
    
    this
  - majorVersion
```
@Stability(value=Experimental)
public JsiiProject.Builder majorVersion(Number majorVersion)
```
    (experimental) Major version to release from the default branch.
    If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version.
    Default: - Major version is not enforced.
    
    Parameters:
    
    majorVersion - Major version to release from the default branch. This parameter is required.
    
    Returns:
    
    this
  - npmDistTag
```
@Stability(value=Experimental)
public JsiiProject.Builder npmDistTag(String npmDistTag)
```
    (experimental) The npmDistTag to use when publishing from the default branch.
    To set the npm dist-tag for release branches, set the npmDistTag property for each branch.
    Default: "latest"
    
    Parameters:
    
    npmDistTag - The npmDistTag to use when publishing from the default branch. This parameter is required.
    
    Returns:
    
    this
  - postBuildSteps
```
@Stability(value=Experimental)
public JsiiProject.Builder postBuildSteps(List<? extends JobStep> postBuildSteps)
```
    (experimental) Steps to execute after build as part of the release workflow.
    Default: []
    
    Parameters:
    
    postBuildSteps - Steps to execute after build as part of the release workflow. This parameter is required.
    
    Returns:
    
    this
  - prerelease
```
@Stability(value=Experimental)
public JsiiProject.Builder prerelease(String prerelease)
```
    (experimental) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
    Default: - normal semantic versions
    
    Parameters:
    
    prerelease - Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). This parameter is required.
    
    Returns:
    
    this
  - publishTasks
```
@Stability(value=Experimental)
public JsiiProject.Builder publishTasks(Boolean publishTasks)
```
    (experimental) Define publishing tasks that can be executed manually as well as workflows.
    Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.
    Default: false
    
    Parameters:
    
    publishTasks - Define publishing tasks that can be executed manually as well as workflows. This parameter is required.
    
    Returns:
    
    this
  - releaseBranches
```
@Stability(value=Experimental)
public JsiiProject.Builder releaseBranches(Map<String,? extends BranchOptions> releaseBranches)
```
    (experimental) Defines additional release branches.
    A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch must be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the majorVersion field must also be provided for the default branch.
    Default: - no additional branches are used for release. you can use `addBranch()` to add additional branches.
    
    Parameters:
    
    releaseBranches - Defines additional release branches. This parameter is required.
    
    Returns:
    
    this
  - releaseEveryCommit
```
@Stability(value=Deprecated)
 @Deprecated
public JsiiProject.Builder releaseEveryCommit(Boolean releaseEveryCommit)
```
    Deprecated. Use `releaseTrigger: ReleaseTrigger.continuous()` instead
    
    (deprecated) Automatically release new versions every commit to one of branches in `releaseBranches`.
    Default: true
    
    Parameters:
    
    releaseEveryCommit - Automatically release new versions every commit to one of branches in `releaseBranches`. This parameter is required.
    
    Returns:
    
    this
  - releaseFailureIssue
```
@Stability(value=Experimental)
public JsiiProject.Builder releaseFailureIssue(Boolean releaseFailureIssue)
```
    (experimental) Create a github issue on every failed publishing task.
    Default: false
    
    Parameters:
    
    releaseFailureIssue - Create a github issue on every failed publishing task. This parameter is required.
    
    Returns:
    
    this
  - releaseFailureIssueLabel
```
@Stability(value=Experimental)
public JsiiProject.Builder releaseFailureIssueLabel(String releaseFailureIssueLabel)
```
    (experimental) The label to apply to issues indicating publish failures.
    Only applies if releaseFailureIssue is true.
    Default: "failed-release"
    
    Parameters:
    
    releaseFailureIssueLabel - The label to apply to issues indicating publish failures. This parameter is required.
    
    Returns:
    
    this
  - releaseSchedule
```
@Stability(value=Deprecated)
 @Deprecated
public JsiiProject.Builder releaseSchedule(String releaseSchedule)
```
    Deprecated. Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
    
    (deprecated) CRON schedule to trigger new releases.
    Default: - no scheduled releases
    
    Parameters:
    
    releaseSchedule - CRON schedule to trigger new releases. This parameter is required.
    
    Returns:
    
    this
  - releaseTagPrefix
```
@Stability(value=Experimental)
public JsiiProject.Builder releaseTagPrefix(String releaseTagPrefix)
```
    (experimental) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
    Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix.
    Default: - no prefix
    
    Parameters:
    
    releaseTagPrefix - Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. This parameter is required.
    
    Returns:
    
    this
  - releaseTrigger
```
@Stability(value=Experimental)
public JsiiProject.Builder releaseTrigger(ReleaseTrigger releaseTrigger)
```
    (experimental) The release trigger to use.
    Default: - Continuous releases (`ReleaseTrigger.continuous()`)
    
    Parameters:
    
    releaseTrigger - The release trigger to use. This parameter is required.
    
    Returns:
    
    this
  - releaseWorkflowName
```
@Stability(value=Experimental)
public JsiiProject.Builder releaseWorkflowName(String releaseWorkflowName)
```
    (experimental) The name of the default release workflow.
    Default: "Release"
    
    Parameters:
    
    releaseWorkflowName - The name of the default release workflow. This parameter is required.
    
    Returns:
    
    this
  - releaseWorkflowSetupSteps
```
@Stability(value=Experimental)
public JsiiProject.Builder releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps)
```
    (experimental) A set of workflow steps to execute in order to setup the workflow container.
    
    Parameters:
    
    releaseWorkflowSetupSteps - A set of workflow steps to execute in order to setup the workflow container. This parameter is required.
    
    Returns:
    
    this
  - versionrcOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder versionrcOptions(Map<String,? extends Object> versionrcOptions)
```
    (experimental) Custom configuration used when creating changelog with standard-version package.
    Given values either append to default configuration or overwrite values in it.
    Default: - standard configuration applicable for GitHub repositories
    
    Parameters:
    
    versionrcOptions - Custom configuration used when creating changelog with standard-version package. This parameter is required.
    
    Returns:
    
    this
  - workflowContainerImage
```
@Stability(value=Experimental)
public JsiiProject.Builder workflowContainerImage(String workflowContainerImage)
```
    (experimental) Container image to use for GitHub workflows.
    Default: - default image
    
    Parameters:
    
    workflowContainerImage - Container image to use for GitHub workflows. This parameter is required.
    
    Returns:
    
    this
  - workflowRunsOn
```
@Stability(value=Experimental)
public JsiiProject.Builder workflowRunsOn(List<String> workflowRunsOn)
```
    (experimental) Github Runner selection labels.
    Default: ["ubuntu-latest"]
    
    Parameters:
    
    workflowRunsOn - Github Runner selection labels. This parameter is required.
    
    Returns:
    
    this
  - defaultReleaseBranch
```
@Stability(value=Experimental)
public JsiiProject.Builder defaultReleaseBranch(String defaultReleaseBranch)
```
    (experimental) The name of the main release branch.
    Default: "main"
    
    Parameters:
    
    defaultReleaseBranch - The name of the main release branch. This parameter is required.
    
    Returns:
    
    this
  - autoApproveProjenUpgrades
```
@Stability(value=Experimental)
public JsiiProject.Builder autoApproveProjenUpgrades(Boolean autoApproveProjenUpgrades)
```
    (experimental) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).
    Throw if set to true but autoApproveOptions are not defined.
    Default: false
    
    Parameters:
    
    autoApproveProjenUpgrades - Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). This parameter is required.
    
    Returns:
    
    this
  - autoApproveUpgrades
```
@Stability(value=Experimental)
public JsiiProject.Builder autoApproveUpgrades(Boolean autoApproveUpgrades)
```
    (experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
    Throw if set to true but autoApproveOptions are not defined.
    Default: - true
    
    Parameters:
    
    autoApproveUpgrades - Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). This parameter is required.
    
    Returns:
    
    this
  - buildWorkflow
```
@Stability(value=Experimental)
public JsiiProject.Builder buildWorkflow(Boolean buildWorkflow)
```
    (experimental) Define a GitHub workflow for building PRs.
    Default: - true if not a subproject
    
    Parameters:
    
    buildWorkflow - Define a GitHub workflow for building PRs. This parameter is required.
    
    Returns:
    
    this
  - bundlerOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder bundlerOptions(BundlerOptions bundlerOptions)
```
    (experimental) Options for `Bundler`.
    
    Parameters:
    
    bundlerOptions - Options for `Bundler`. This parameter is required.
    
    Returns:
    
    this
  - codeCov
```
@Stability(value=Experimental)
public JsiiProject.Builder codeCov(Boolean codeCov)
```
    (experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret.
    Default: false
    
    Parameters:
    
    codeCov - Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. This parameter is required.
    
    Returns:
    
    this
  - codeCovTokenSecret
```
@Stability(value=Experimental)
public JsiiProject.Builder codeCovTokenSecret(String codeCovTokenSecret)
```
    (experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
    Default: - if this option is not specified, only public repositories are supported
    
    Parameters:
    
    codeCovTokenSecret - Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. This parameter is required.
    
    Returns:
    
    this
  - copyrightOwner
```
@Stability(value=Experimental)
public JsiiProject.Builder copyrightOwner(String copyrightOwner)
```
    (experimental) License copyright owner.
    Default: - defaults to the value of authorName or "" if `authorName` is undefined.
    
    Parameters:
    
    copyrightOwner - License copyright owner. This parameter is required.
    
    Returns:
    
    this
  - copyrightPeriod
```
@Stability(value=Experimental)
public JsiiProject.Builder copyrightPeriod(String copyrightPeriod)
```
    (experimental) The copyright years to put in the LICENSE file.
    Default: - current year
    
    Parameters:
    
    copyrightPeriod - The copyright years to put in the LICENSE file. This parameter is required.
    
    Returns:
    
    this
  - dependabot
```
@Stability(value=Experimental)
public JsiiProject.Builder dependabot(Boolean dependabot)
```
    (experimental) Use dependabot to handle dependency upgrades.
    Cannot be used in conjunction with depsUpgrade.
    Default: false
    
    Parameters:
    
    dependabot - Use dependabot to handle dependency upgrades. This parameter is required.
    
    Returns:
    
    this
  - dependabotOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder dependabotOptions(DependabotOptions dependabotOptions)
```
    (experimental) Options for dependabot.
    Default: - default options
    
    Parameters:
    
    dependabotOptions - Options for dependabot. This parameter is required.
    
    Returns:
    
    this
  - depsUpgrade
```
@Stability(value=Experimental)
public JsiiProject.Builder depsUpgrade(Boolean depsUpgrade)
```
    (experimental) Use github workflows to handle dependency upgrades.
    Cannot be used in conjunction with dependabot.
    Default: true
    
    Parameters:
    
    depsUpgrade - Use github workflows to handle dependency upgrades. This parameter is required.
    
    Returns:
    
    this
  - depsUpgradeOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder depsUpgradeOptions(UpgradeDependenciesOptions depsUpgradeOptions)
```
    (experimental) Options for depsUpgrade.
    Default: - default options
    
    Parameters:
    
    depsUpgradeOptions - Options for depsUpgrade. This parameter is required.
    
    Returns:
    
    this
  - gitignore
```
@Stability(value=Experimental)
public JsiiProject.Builder gitignore(List<String> gitignore)
```
    (experimental) Additional entries to .gitignore.
    
    Parameters:
    
    gitignore - Additional entries to .gitignore. This parameter is required.
    
    Returns:
    
    this
  - jest
```
@Stability(value=Experimental)
public JsiiProject.Builder jest(Boolean jest)
```
    (experimental) Setup jest unit tests.
    Default: true
    
    Parameters:
    
    jest - Setup jest unit tests. This parameter is required.
    
    Returns:
    
    this
  - jestOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder jestOptions(JestOptions jestOptions)
```
    (experimental) Jest options.
    Default: - default options
    
    Parameters:
    
    jestOptions - Jest options. This parameter is required.
    
    Returns:
    
    this
  - mutableBuild
```
@Stability(value=Experimental)
public JsiiProject.Builder mutableBuild(Boolean mutableBuild)
```
    (experimental) Automatically update files modified during builds to pull-request branches.
    This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged.
    Implies that PR builds do not have anti-tamper checks.
    Default: true
    
    Parameters:
    
    mutableBuild - Automatically update files modified during builds to pull-request branches. This parameter is required.
    
    Returns:
    
    this
  - npmignore
```
@Stability(value=Deprecated)
 @Deprecated
public JsiiProject.Builder npmignore(List<String> npmignore)
```
    Deprecated. - use `project.addPackageIgnore`
    
    (deprecated) Additional entries to .npmignore.
    
    Parameters:
    
    npmignore - Additional entries to .npmignore. This parameter is required.
    
    Returns:
    
    this
  - npmignoreEnabled
```
@Stability(value=Experimental)
public JsiiProject.Builder npmignoreEnabled(Boolean npmignoreEnabled)
```
    (experimental) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
    Default: true
    
    Parameters:
    
    npmignoreEnabled - Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. This parameter is required.
    
    Returns:
    
    this
  - projenDevDependency
```
@Stability(value=Experimental)
public JsiiProject.Builder projenDevDependency(Boolean projenDevDependency)
```
    (experimental) Indicates of "projen" should be installed as a devDependency.
    Default: true
    
    Parameters:
    
    projenDevDependency - Indicates of "projen" should be installed as a devDependency. This parameter is required.
    
    Returns:
    
    this
  - projenrcJs
```
@Stability(value=Experimental)
public JsiiProject.Builder projenrcJs(Boolean projenrcJs)
```
    (experimental) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
    Default: - true if projenrcJson is false
    
    Parameters:
    
    projenrcJs - Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. This parameter is required.
    
    Returns:
    
    this
  - projenrcJsOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder projenrcJsOptions(ProjenrcOptions projenrcJsOptions)
```
    (experimental) Options for .projenrc.js.
    Default: - default options
    
    Parameters:
    
    projenrcJsOptions - Options for .projenrc.js. This parameter is required.
    
    Returns:
    
    this
  - projenUpgradeAutoMerge
```
@Stability(value=Deprecated)
 @Deprecated
public JsiiProject.Builder projenUpgradeAutoMerge(Boolean projenUpgradeAutoMerge)
```
    Deprecated. use `autoApproveProjenUpgrades`.
    
    (deprecated) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).
    Throw if set to true but autoApproveOptions are not defined.
    Default: false
    
    Parameters:
    
    projenUpgradeAutoMerge - Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued). This parameter is required.
    
    Returns:
    
    this
  - projenUpgradeSchedule
```
@Stability(value=Experimental)
public JsiiProject.Builder projenUpgradeSchedule(List<String> projenUpgradeSchedule)
```
    (experimental) Customize the projenUpgrade schedule in cron expression.
    Default: [ "0 6 * * *" ]
    
    Parameters:
    
    projenUpgradeSchedule - Customize the projenUpgrade schedule in cron expression. This parameter is required.
    
    Returns:
    
    this
  - projenUpgradeSecret
```
@Stability(value=Experimental)
public JsiiProject.Builder projenUpgradeSecret(String projenUpgradeSecret)
```
    (experimental) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).
    This setting is a GitHub secret name which contains a GitHub Access Token with repo and workflow permissions.
    This token is used to submit the upgrade pull request, which will likely include workflow updates.
    To create a personal access token see https://github.com/settings/tokens
    Default: - no automatic projen upgrade pull requests
    
    Parameters:
    
    projenUpgradeSecret - Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`). This parameter is required.
    
    Returns:
    
    this
  - projenVersion
```
@Stability(value=Experimental)
public JsiiProject.Builder projenVersion(String projenVersion)
```
    (experimental) Version of projen to install.
    Default: - Defaults to the latest version.
    
    Parameters:
    
    projenVersion - Version of projen to install. This parameter is required.
    
    Returns:
    
    this
  - pullRequestTemplate
```
@Stability(value=Experimental)
public JsiiProject.Builder pullRequestTemplate(Boolean pullRequestTemplate)
```
    (experimental) Include a GitHub pull request template.
    Default: true
    
    Parameters:
    
    pullRequestTemplate - Include a GitHub pull request template. This parameter is required.
    
    Returns:
    
    this
  - pullRequestTemplateContents
```
@Stability(value=Experimental)
public JsiiProject.Builder pullRequestTemplateContents(List<String> pullRequestTemplateContents)
```
    (experimental) The contents of the pull request template.
    Default: - default content
    
    Parameters:
    
    pullRequestTemplateContents - The contents of the pull request template. This parameter is required.
    
    Returns:
    
    this
  - release
```
@Stability(value=Experimental)
public JsiiProject.Builder release(Boolean release)
```
    (experimental) Add release management to this project.
    Default: - true (false for subprojects)
    
    Parameters:
    
    release - Add release management to this project. This parameter is required.
    
    Returns:
    
    this
  - releaseToNpm
```
@Stability(value=Experimental)
public JsiiProject.Builder releaseToNpm(Boolean releaseToNpm)
```
    (experimental) Automatically release to npm when new versions are introduced.
    Default: false
    
    Parameters:
    
    releaseToNpm - Automatically release to npm when new versions are introduced. This parameter is required.
    
    Returns:
    
    this
  - releaseWorkflow
```
@Stability(value=Deprecated)
 @Deprecated
public JsiiProject.Builder releaseWorkflow(Boolean releaseWorkflow)
```
    Deprecated. see `release`.
    
    (deprecated) DEPRECATED: renamed to `release`.
    Default: - true if not a subproject
    
    Parameters:
    
    releaseWorkflow - DEPRECATED: renamed to `release`. This parameter is required.
    
    Returns:
    
    this
  - workflowBootstrapSteps
```
@Stability(value=Experimental)
public JsiiProject.Builder workflowBootstrapSteps(List<? extends Object> workflowBootstrapSteps)
```
    (experimental) Workflow steps to use in order to bootstrap this repo.
    Default: "yarn install --frozen-lockfile && yarn projen"
    
    Parameters:
    
    workflowBootstrapSteps - Workflow steps to use in order to bootstrap this repo. This parameter is required.
    
    Returns:
    
    this
  - workflowGitIdentity
```
@Stability(value=Experimental)
public JsiiProject.Builder workflowGitIdentity(GitIdentity workflowGitIdentity)
```
    (experimental) The git identity to use in workflows.
    Default: - GitHub Actions
    
    Parameters:
    
    workflowGitIdentity - The git identity to use in workflows. This parameter is required.
    
    Returns:
    
    this
  - workflowNodeVersion
```
@Stability(value=Experimental)
public JsiiProject.Builder workflowNodeVersion(String workflowNodeVersion)
```
    (experimental) The node version to use in GitHub workflows.
    Default: - same as `minNodeVersion`
    
    Parameters:
    
    workflowNodeVersion - The node version to use in GitHub workflows. This parameter is required.
    
    Returns:
    
    this
  - disableTsconfig
```
@Stability(value=Experimental)
public JsiiProject.Builder disableTsconfig(Boolean disableTsconfig)
```
    (experimental) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
    Default: false
    
    Parameters:
    
    disableTsconfig - Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). This parameter is required.
    
    Returns:
    
    this
  - docgen
```
@Stability(value=Experimental)
public JsiiProject.Builder docgen(Boolean docgen)
```
    (experimental) Docgen by Typedoc.
    Default: false
    
    Parameters:
    
    docgen - Docgen by Typedoc. This parameter is required.
    
    Returns:
    
    this
  - docsDirectory
```
@Stability(value=Experimental)
public JsiiProject.Builder docsDirectory(String docsDirectory)
```
    (experimental) Docs directory.
    Default: "docs"
    
    Parameters:
    
    docsDirectory - Docs directory. This parameter is required.
    
    Returns:
    
    this
  - entrypointTypes
```
@Stability(value=Experimental)
public JsiiProject.Builder entrypointTypes(String entrypointTypes)
```
    (experimental) The .d.ts file that includes the type declarations for this module.
    Default: - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
    
    Parameters:
    
    entrypointTypes - The .d.ts file that includes the type declarations for this module. This parameter is required.
    
    Returns:
    
    this
  - eslint
```
@Stability(value=Experimental)
public JsiiProject.Builder eslint(Boolean eslint)
```
    (experimental) Setup eslint.
    Default: true
    
    Parameters:
    
    eslint - Setup eslint. This parameter is required.
    
    Returns:
    
    this
  - eslintOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder eslintOptions(EslintOptions eslintOptions)
```
    (experimental) Eslint options.
    Default: - opinionated default options
    
    Parameters:
    
    eslintOptions - Eslint options. This parameter is required.
    
    Returns:
    
    this
  - libdir
```
@Stability(value=Experimental)
public JsiiProject.Builder libdir(String libdir)
```
    (experimental) Typescript artifacts output directory.
    Default: "lib"
    
    Parameters:
    
    libdir - Typescript artifacts output directory. This parameter is required.
    
    Returns:
    
    this
  - packageValue
```
@Stability(value=Experimental)
public JsiiProject.Builder packageValue(Boolean packageValue)
```
    (experimental) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`.
    Default: true
    
    Parameters:
    
    packageValue - Defines a `yarn package` command that will produce a tarball and place it under `dist/js`. This parameter is required.
    
    Returns:
    
    this
  - projenrcTs
```
@Stability(value=Experimental)
public JsiiProject.Builder projenrcTs(Boolean projenrcTs)
```
    (experimental) Use TypeScript for your projenrc file (`.projenrc.ts`).
    Default: false
    
    Parameters:
    
    projenrcTs - Use TypeScript for your projenrc file (`.projenrc.ts`). This parameter is required.
    
    Returns:
    
    this
  - projenrcTsOptions
```
@Stability(value=Experimental)
public JsiiProject.Builder projenrcTsOptions(ProjenrcOptions projenrcTsOptions)
```
    (experimental) Options for .projenrc.ts.
    
    Parameters:
    
    projenrcTsOptions - Options for .projenrc.ts. This parameter is required.
    
    Returns:
    
    this
  - sampleCode
```
@Stability(value=Experimental)
public JsiiProject.Builder sampleCode(Boolean sampleCode)
```
    (experimental) Generate one-time sample in `src/` and `test/` if there are no files there.
    Default: true
    
    Parameters:
    
    sampleCode - Generate one-time sample in `src/` and `test/` if there are no files there. This parameter is required.
    
    Returns:
    
    this
  - srcdir
```
@Stability(value=Experimental)
public JsiiProject.Builder srcdir(String srcdir)
```
    (experimental) Typescript sources directory.
    Default: "src"
    
    Parameters:
    
    srcdir - Typescript sources directory. This parameter is required.
    
    Returns:
    
    this
  - testdir
```
@Stability(value=Experimental)
public JsiiProject.Builder testdir(String testdir)
```
    (experimental) Jest tests directory. Tests files should be named `xxx.test.ts`.
    If this directory is under srcdir (e.g. src/test, src/__tests__), then tests are going to be compiled into lib/ and executed as javascript. If the test directory is outside of src, then we configure jest to compile the code in-memory.
    Default: "test"
    
    Parameters:
    
    testdir - Jest tests directory. Tests files should be named `xxx.test.ts`. This parameter is required.
    
    Returns:
    
    this
  - tsconfig
```
@Stability(value=Experimental)
public JsiiProject.Builder tsconfig(TypescriptConfigOptions tsconfig)
```
    (experimental) Custom TSConfig.
    Default: - default options
    
    Parameters:
    
    tsconfig - Custom TSConfig. This parameter is required.
    
    Returns:
    
    this
  - tsconfigDev
```
@Stability(value=Experimental)
public JsiiProject.Builder tsconfigDev(TypescriptConfigOptions tsconfigDev)
```
    (experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).
    Default: - use the production tsconfig options
    
    Parameters:
    
    tsconfigDev - Custom tsconfig options for the development tsconfig.json file (used for testing). This parameter is required.
    
    Returns:
    
    this
  - tsconfigDevFile
```
@Stability(value=Experimental)
public JsiiProject.Builder tsconfigDevFile(String tsconfigDevFile)
```
    (experimental) The name of the development tsconfig.json file.
    Default: "tsconfig.dev.json"
    
    Parameters:
    
    tsconfigDevFile - The name of the development tsconfig.json file. This parameter is required.
    
    Returns:
    
    this
  - typescriptVersion
```
@Stability(value=Experimental)
public JsiiProject.Builder typescriptVersion(String typescriptVersion)
```
    (experimental) TypeScript version to use.
    NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~1.2.3).
    Default: "latest"
    
    Parameters:
    
    typescriptVersion - TypeScript version to use. This parameter is required.
    
    Returns:
    
    this
  - author
```
@Stability(value=Experimental)
public JsiiProject.Builder author(String author)
```
    (experimental) The name of the library author.
    Default: $GIT_USER_NAME
    
    Parameters:
    
    author - The name of the library author. This parameter is required.
    
    Returns:
    
    this
  - authorAddress
```
@Stability(value=Experimental)
public JsiiProject.Builder authorAddress(String authorAddress)
```
    (experimental) Email or URL of the library author.
    Default: $GIT_USER_EMAIL
    
    Parameters:
    
    authorAddress - Email or URL of the library author. This parameter is required.
    
    Returns:
    
    this
  - repositoryUrl
```
@Stability(value=Experimental)
public JsiiProject.Builder repositoryUrl(String repositoryUrl)
```
    (experimental) Git repository URL.
    Default: $GIT_REMOTE
    
    Parameters:
    
    repositoryUrl - Git repository URL. This parameter is required.
    
    Returns:
    
    this
  - compat
```
@Stability(value=Experimental)
public JsiiProject.Builder compat(Boolean compat)
```
    (experimental) Automatically run API compatibility test against the latest version published to npm after compilation.
    - You can manually run compatibility tests using yarn compat if this feature is disabled.
    - You can ignore compatibility failures by adding lines to a ".compatignore" file.
    Default: false
    Parameters:
    
    compat - Automatically run API compatibility test against the latest version published to npm after compilation. This parameter is required.
    
    Returns:
    
    this
  - compatIgnore
```
@Stability(value=Experimental)
public JsiiProject.Builder compatIgnore(String compatIgnore)
```
    (experimental) Name of the ignore file for API compatibility tests.
    Default: ".compatignore"
    
    Parameters:
    
    compatIgnore - Name of the ignore file for API compatibility tests. This parameter is required.
    
    Returns:
    
    this
  - dotnet
```
@Stability(value=Deprecated)
 @Deprecated
public JsiiProject.Builder dotnet(JsiiDotNetTarget dotnet)
```
    Deprecated. use `publishToNuget`
    
    Parameters:
    
    dotnet - This parameter is required.
    
    Returns:
    
    this
  - excludeTypescript
```
@Stability(value=Experimental)
public JsiiProject.Builder excludeTypescript(List<String> excludeTypescript)
```
    (experimental) Accepts a list of glob patterns.
    Files matching any of those patterns will be excluded from the TypeScript compiler input.
    By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input. This can be problematic for example when the package's build or test procedure generates .ts files that cannot be compiled with jsii's compiler settings.
    
    Parameters:
    
    excludeTypescript - Accepts a list of glob patterns. This parameter is required.
    
    Returns:
    
    this
  - publishToGo
```
@Stability(value=Experimental)
public JsiiProject.Builder publishToGo(JsiiGoTarget publishToGo)
```
    (experimental) Publish Go bindings to a git repository.
    Default: - no publishing
    
    Parameters:
    
    publishToGo - Publish Go bindings to a git repository. This parameter is required.
    
    Returns:
    
    this
  - publishToMaven
```
@Stability(value=Experimental)
public JsiiProject.Builder publishToMaven(JsiiJavaTarget publishToMaven)
```
    (experimental) Publish to maven.
    Default: - no publishing
    
    Parameters:
    
    publishToMaven - Publish to maven. This parameter is required.
    
    Returns:
    
    this
  - publishToNuget
```
@Stability(value=Experimental)
public JsiiProject.Builder publishToNuget(JsiiDotNetTarget publishToNuget)
```
    (experimental) Publish to NuGet.
    Default: - no publishing
    
    Parameters:
    
    publishToNuget - Publish to NuGet. This parameter is required.
    
    Returns:
    
    this
  - publishToPypi
```
@Stability(value=Experimental)
public JsiiProject.Builder publishToPypi(JsiiPythonTarget publishToPypi)
```
    (experimental) Publish to pypi.
    Default: - no publishing
    
    Parameters:
    
    publishToPypi - Publish to pypi. This parameter is required.
    
    Returns:
    
    this
  - python
```
@Stability(value=Deprecated)
 @Deprecated
public JsiiProject.Builder python(JsiiPythonTarget python)
```
    Deprecated. use `publishToPyPi`
    
    Parameters:
    
    python - This parameter is required.
    
    Returns:
    
    this
  - rootdir
```
@Stability(value=Experimental)
public JsiiProject.Builder rootdir(String rootdir)
```
    Default: "."
    
    Parameters:
    
    rootdir - This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Experimental)
public JsiiProject build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<JsiiProject>

Class JsiiProject.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

name

logging

outdir

parent

projenCommand

projenrcJson

projenrcJsonOptions

autoApproveOptions

autoMergeOptions

clobber

devContainer

github

githubOptions

gitpod

mergify

mergifyOptions

projectType

readme

stale

staleOptions

vscode

allowLibraryDependencies

authorEmail

authorName

authorOrganization

authorUrl

autoDetectBin

bin

bundledDeps

codeArtifactOptions

deps

description

devDeps

entrypoint

homepage

keywords

license

licensed

maxNodeVersion

minNodeVersion

npmAccess

npmRegistry

npmRegistryUrl

npmTokenSecret

packageManager

packageName

peerDependencyOptions

peerDeps

repository

repositoryDirectory

scripts

stability

antitamper

artifactsDirectory

jsiiReleaseVersion

majorVersion

npmDistTag

postBuildSteps

prerelease

publishTasks

releaseBranches

releaseEveryCommit

releaseFailureIssue

releaseFailureIssueLabel

releaseSchedule

releaseTagPrefix

releaseTrigger

releaseWorkflowName

releaseWorkflowSetupSteps

versionrcOptions

workflowContainerImage

workflowRunsOn

defaultReleaseBranch

autoApproveProjenUpgrades

autoApproveUpgrades