java.lang.Object
- io.github.cdklabs.projen.javascript.NodeProjectOptions.Builder

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

Enclosing interface:: NodeProjectOptions

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

A builder for NodeProjectOptions

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`NodeProjectOptions.Builder`	`allowLibraryDependencies(Boolean allowLibraryDependencies)`	Sets the value of `NodePackageOptions.getAllowLibraryDependencies()`
`NodeProjectOptions.Builder`	`artifactsDirectory(String artifactsDirectory)`	Sets the value of `NodeProjectOptions.getArtifactsDirectory()`
`NodeProjectOptions.Builder`	`authorEmail(String authorEmail)`	Sets the value of `NodePackageOptions.getAuthorEmail()`
`NodeProjectOptions.Builder`	`authorName(String authorName)`	Sets the value of `NodePackageOptions.getAuthorName()`
`NodeProjectOptions.Builder`	`authorOrganization(Boolean authorOrganization)`	Sets the value of `NodePackageOptions.getAuthorOrganization()`
`NodeProjectOptions.Builder`	`authorUrl(String authorUrl)`	Sets the value of `NodePackageOptions.getAuthorUrl()`
`NodeProjectOptions.Builder`	`autoApproveOptions(AutoApproveOptions autoApproveOptions)`	Sets the value of `GitHubProjectOptions.getAutoApproveOptions()`
`NodeProjectOptions.Builder`	`autoApproveUpgrades(Boolean autoApproveUpgrades)`	Sets the value of `NodeProjectOptions.getAutoApproveUpgrades()`
`NodeProjectOptions.Builder`	`autoDetectBin(Boolean autoDetectBin)`	Sets the value of `NodePackageOptions.getAutoDetectBin()`
`NodeProjectOptions.Builder`	`autoMerge(Boolean autoMerge)`	Sets the value of `GitHubProjectOptions.getAutoMerge()`
`NodeProjectOptions.Builder`	`autoMergeOptions(AutoMergeOptions autoMergeOptions)`	Sets the value of `GitHubProjectOptions.getAutoMergeOptions()`
`NodeProjectOptions.Builder`	`bin(Map<String,String> bin)`	Sets the value of `NodePackageOptions.getBin()`
`NodeProjectOptions.Builder`	`bugsEmail(String bugsEmail)`	Sets the value of `NodePackageOptions.getBugsEmail()`
`NodeProjectOptions.Builder`	`bugsUrl(String bugsUrl)`	Sets the value of `NodePackageOptions.getBugsUrl()`
`NodeProjectOptions`	`build()`	Builds the configured instance.
`NodeProjectOptions.Builder`	`buildWorkflow(Boolean buildWorkflow)`	Sets the value of `NodeProjectOptions.getBuildWorkflow()`
`NodeProjectOptions.Builder`	`buildWorkflowTriggers(Triggers buildWorkflowTriggers)`	Sets the value of `NodeProjectOptions.getBuildWorkflowTriggers()`
`NodeProjectOptions.Builder`	`bundledDeps(List<String> bundledDeps)`	Sets the value of `NodePackageOptions.getBundledDeps()`
`NodeProjectOptions.Builder`	`bundlerOptions(BundlerOptions bundlerOptions)`	Sets the value of `NodeProjectOptions.getBundlerOptions()`
`NodeProjectOptions.Builder`	`checkLicenses(LicenseCheckerOptions checkLicenses)`	Sets the value of `NodeProjectOptions.getCheckLicenses()`
`NodeProjectOptions.Builder`	`clobber(Boolean clobber)`	Sets the value of `GitHubProjectOptions.getClobber()`
`NodeProjectOptions.Builder`	`codeArtifactOptions(CodeArtifactOptions codeArtifactOptions)`	Sets the value of `NodePackageOptions.getCodeArtifactOptions()`
`NodeProjectOptions.Builder`	`codeCov(Boolean codeCov)`	Sets the value of `NodeProjectOptions.getCodeCov()`
`NodeProjectOptions.Builder`	`codeCovTokenSecret(String codeCovTokenSecret)`	Sets the value of `NodeProjectOptions.getCodeCovTokenSecret()`
`NodeProjectOptions.Builder`	`commitGenerated(Boolean commitGenerated)`	Sets the value of `ProjectOptions.getCommitGenerated()`
`NodeProjectOptions.Builder`	`copyrightOwner(String copyrightOwner)`	Sets the value of `NodeProjectOptions.getCopyrightOwner()`
`NodeProjectOptions.Builder`	`copyrightPeriod(String copyrightPeriod)`	Sets the value of `NodeProjectOptions.getCopyrightPeriod()`
`NodeProjectOptions.Builder`	`defaultReleaseBranch(String defaultReleaseBranch)`	Sets the value of `NodeProjectOptions.getDefaultReleaseBranch()`
`NodeProjectOptions.Builder`	`dependabot(Boolean dependabot)`	Sets the value of `NodeProjectOptions.getDependabot()`
`NodeProjectOptions.Builder`	`dependabotOptions(DependabotOptions dependabotOptions)`	Sets the value of `NodeProjectOptions.getDependabotOptions()`
`NodeProjectOptions.Builder`	`deps(List<String> deps)`	Sets the value of `NodePackageOptions.getDeps()`
`NodeProjectOptions.Builder`	`depsUpgrade(Boolean depsUpgrade)`	Sets the value of `NodeProjectOptions.getDepsUpgrade()`
`NodeProjectOptions.Builder`	`depsUpgradeOptions(UpgradeDependenciesOptions depsUpgradeOptions)`	Sets the value of `NodeProjectOptions.getDepsUpgradeOptions()`
`NodeProjectOptions.Builder`	`description(String description)`	Sets the value of `NodePackageOptions.getDescription()`
`NodeProjectOptions.Builder`	`devContainer(Boolean devContainer)`	Sets the value of `GitHubProjectOptions.getDevContainer()`
`NodeProjectOptions.Builder`	`devDeps(List<String> devDeps)`	Sets the value of `NodePackageOptions.getDevDeps()`
`NodeProjectOptions.Builder`	`entrypoint(String entrypoint)`	Sets the value of `NodePackageOptions.getEntrypoint()`
`NodeProjectOptions.Builder`	`github(Boolean github)`	Sets the value of `GitHubProjectOptions.getGithub()`
`NodeProjectOptions.Builder`	`githubOptions(GitHubOptions githubOptions)`	Sets the value of `GitHubProjectOptions.getGithubOptions()`
`NodeProjectOptions.Builder`	`gitignore(List<String> gitignore)`	Sets the value of `NodeProjectOptions.getGitignore()`
`NodeProjectOptions.Builder`	`gitIgnoreOptions(IgnoreFileOptions gitIgnoreOptions)`	Sets the value of `ProjectOptions.getGitIgnoreOptions()`
`NodeProjectOptions.Builder`	`gitOptions(GitOptions gitOptions)`	Sets the value of `ProjectOptions.getGitOptions()`
`NodeProjectOptions.Builder`	`gitpod(Boolean gitpod)`	Sets the value of `GitHubProjectOptions.getGitpod()`
`NodeProjectOptions.Builder`	`homepage(String homepage)`	Sets the value of `NodePackageOptions.getHomepage()`
`NodeProjectOptions.Builder`	`jest(Boolean jest)`	Sets the value of `NodeProjectOptions.getJest()`
`NodeProjectOptions.Builder`	`jestOptions(JestOptions jestOptions)`	Sets the value of `NodeProjectOptions.getJestOptions()`
`NodeProjectOptions.Builder`	`jsiiReleaseVersion(String jsiiReleaseVersion)`	Sets the value of `ReleaseProjectOptions.getJsiiReleaseVersion()`
`NodeProjectOptions.Builder`	`keywords(List<String> keywords)`	Sets the value of `NodePackageOptions.getKeywords()`
`NodeProjectOptions.Builder`	`license(String license)`	Sets the value of `NodePackageOptions.getLicense()`
`NodeProjectOptions.Builder`	`licensed(Boolean licensed)`	Sets the value of `NodePackageOptions.getLicensed()`
`NodeProjectOptions.Builder`	`logging(LoggerOptions logging)`	Sets the value of `ProjectOptions.getLogging()`
`NodeProjectOptions.Builder`	`majorVersion(Number majorVersion)`	Sets the value of `ReleaseProjectOptions.getMajorVersion()`
`NodeProjectOptions.Builder`	`maxNodeVersion(String maxNodeVersion)`	Sets the value of `NodePackageOptions.getMaxNodeVersion()`
`NodeProjectOptions.Builder`	`mergify(Boolean mergify)`	Deprecated. use `githubOptions.mergify` instead
`NodeProjectOptions.Builder`	`mergifyOptions(MergifyOptions mergifyOptions)`	Deprecated. use `githubOptions.mergifyOptions` instead
`NodeProjectOptions.Builder`	`minMajorVersion(Number minMajorVersion)`	Sets the value of `ReleaseProjectOptions.getMinMajorVersion()`
`NodeProjectOptions.Builder`	`minNodeVersion(String minNodeVersion)`	Sets the value of `NodePackageOptions.getMinNodeVersion()`
`NodeProjectOptions.Builder`	`mutableBuild(Boolean mutableBuild)`	Sets the value of `NodeProjectOptions.getMutableBuild()`
`NodeProjectOptions.Builder`	`name(String name)`	Sets the value of `ProjectOptions.getName()`
`NodeProjectOptions.Builder`	`npmAccess(NpmAccess npmAccess)`	Sets the value of `NodePackageOptions.getNpmAccess()`
`NodeProjectOptions.Builder`	`npmDistTag(String npmDistTag)`	Sets the value of `ReleaseProjectOptions.getNpmDistTag()`
`NodeProjectOptions.Builder`	`npmignore(List<String> npmignore)`	Deprecated. - use `project.addPackageIgnore`
`NodeProjectOptions.Builder`	`npmignoreEnabled(Boolean npmignoreEnabled)`	Sets the value of `NodeProjectOptions.getNpmignoreEnabled()`
`NodeProjectOptions.Builder`	`npmIgnoreOptions(IgnoreFileOptions npmIgnoreOptions)`	Sets the value of `NodeProjectOptions.getNpmIgnoreOptions()`
`NodeProjectOptions.Builder`	`npmProvenance(Boolean npmProvenance)`	Sets the value of `NodePackageOptions.getNpmProvenance()`
`NodeProjectOptions.Builder`	`npmRegistry(String npmRegistry)`	Deprecated. use `npmRegistryUrl` instead
`NodeProjectOptions.Builder`	`npmRegistryUrl(String npmRegistryUrl)`	Sets the value of `NodePackageOptions.getNpmRegistryUrl()`
`NodeProjectOptions.Builder`	`npmTokenSecret(String npmTokenSecret)`	Sets the value of `NodePackageOptions.getNpmTokenSecret()`
`NodeProjectOptions.Builder`	`outdir(String outdir)`	Sets the value of `ProjectOptions.getOutdir()`
`NodeProjectOptions.Builder`	`packageManager(NodePackageManager packageManager)`	Sets the value of `NodePackageOptions.getPackageManager()`
`NodeProjectOptions.Builder`	`packageName(String packageName)`	Sets the value of `NodePackageOptions.getPackageName()`
`NodeProjectOptions.Builder`	`packageValue(Boolean packageValue)`	Sets the value of `NodeProjectOptions.getPackageValue()`
`NodeProjectOptions.Builder`	`parent(Project parent)`	Sets the value of `ProjectOptions.getParent()`
`NodeProjectOptions.Builder`	`peerDependencyOptions(PeerDependencyOptions peerDependencyOptions)`	Sets the value of `NodePackageOptions.getPeerDependencyOptions()`
`NodeProjectOptions.Builder`	`peerDeps(List<String> peerDeps)`	Sets the value of `NodePackageOptions.getPeerDeps()`
`NodeProjectOptions.Builder`	`pnpmVersion(String pnpmVersion)`	Sets the value of `NodePackageOptions.getPnpmVersion()`
`NodeProjectOptions.Builder`	`postBuildSteps(List<? extends JobStep> postBuildSteps)`	Sets the value of `ReleaseProjectOptions.getPostBuildSteps()`
`NodeProjectOptions.Builder`	`prerelease(String prerelease)`	Sets the value of `ReleaseProjectOptions.getPrerelease()`
`NodeProjectOptions.Builder`	`prettier(Boolean prettier)`	Sets the value of `NodeProjectOptions.getPrettier()`
`NodeProjectOptions.Builder`	`prettierOptions(PrettierOptions prettierOptions)`	Sets the value of `NodeProjectOptions.getPrettierOptions()`
`NodeProjectOptions.Builder`	`projectType(ProjectType projectType)`	Deprecated. no longer supported at the base project level
`NodeProjectOptions.Builder`	`projenCommand(String projenCommand)`	Sets the value of `ProjectOptions.getProjenCommand()`
`NodeProjectOptions.Builder`	`projenCredentials(GithubCredentials projenCredentials)`	Sets the value of `GitHubProjectOptions.getProjenCredentials()`
`NodeProjectOptions.Builder`	`projenDevDependency(Boolean projenDevDependency)`	Sets the value of `NodeProjectOptions.getProjenDevDependency()`
`NodeProjectOptions.Builder`	`projenrcJs(Boolean projenrcJs)`	Sets the value of `NodeProjectOptions.getProjenrcJs()`
`NodeProjectOptions.Builder`	`projenrcJson(Boolean projenrcJson)`	Sets the value of `ProjectOptions.getProjenrcJson()`
`NodeProjectOptions.Builder`	`projenrcJsonOptions(ProjenrcJsonOptions projenrcJsonOptions)`	Sets the value of `ProjectOptions.getProjenrcJsonOptions()`
`NodeProjectOptions.Builder`	`projenrcJsOptions(ProjenrcOptions projenrcJsOptions)`	Sets the value of `NodeProjectOptions.getProjenrcJsOptions()`
`NodeProjectOptions.Builder`	`projenTokenSecret(String projenTokenSecret)`	Deprecated. use `projenCredentials`
`NodeProjectOptions.Builder`	`projenVersion(String projenVersion)`	Sets the value of `NodeProjectOptions.getProjenVersion()`
`NodeProjectOptions.Builder`	`publishDryRun(Boolean publishDryRun)`	Sets the value of `ReleaseProjectOptions.getPublishDryRun()`
`NodeProjectOptions.Builder`	`publishTasks(Boolean publishTasks)`	Sets the value of `ReleaseProjectOptions.getPublishTasks()`
`NodeProjectOptions.Builder`	`pullRequestTemplate(Boolean pullRequestTemplate)`	Sets the value of `NodeProjectOptions.getPullRequestTemplate()`
`NodeProjectOptions.Builder`	`pullRequestTemplateContents(List<String> pullRequestTemplateContents)`	Sets the value of `NodeProjectOptions.getPullRequestTemplateContents()`
`NodeProjectOptions.Builder`	`readme(SampleReadmeProps readme)`	Sets the value of `GitHubProjectOptions.getReadme()`
`NodeProjectOptions.Builder`	`releasableCommits(ReleasableCommits releasableCommits)`	Sets the value of `ReleaseProjectOptions.getReleasableCommits()`
`NodeProjectOptions.Builder`	`release(Boolean release)`	Sets the value of `NodeProjectOptions.getRelease()`
`NodeProjectOptions.Builder`	`releaseBranches(Map<String,? extends BranchOptions> releaseBranches)`	Sets the value of `ReleaseProjectOptions.getReleaseBranches()`
`NodeProjectOptions.Builder`	`releaseEveryCommit(Boolean releaseEveryCommit)`	Deprecated. Use `releaseTrigger: ReleaseTrigger.continuous()` instead
`NodeProjectOptions.Builder`	`releaseFailureIssue(Boolean releaseFailureIssue)`	Sets the value of `ReleaseProjectOptions.getReleaseFailureIssue()`
`NodeProjectOptions.Builder`	`releaseFailureIssueLabel(String releaseFailureIssueLabel)`	Sets the value of `ReleaseProjectOptions.getReleaseFailureIssueLabel()`
`NodeProjectOptions.Builder`	`releaseSchedule(String releaseSchedule)`	Deprecated. Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
`NodeProjectOptions.Builder`	`releaseTagPrefix(String releaseTagPrefix)`	Sets the value of `ReleaseProjectOptions.getReleaseTagPrefix()`
`NodeProjectOptions.Builder`	`releaseToNpm(Boolean releaseToNpm)`	Sets the value of `NodeProjectOptions.getReleaseToNpm()`
`NodeProjectOptions.Builder`	`releaseTrigger(ReleaseTrigger releaseTrigger)`	Sets the value of `ReleaseProjectOptions.getReleaseTrigger()`
`NodeProjectOptions.Builder`	`releaseWorkflow(Boolean releaseWorkflow)`	Deprecated. see `release`.
`NodeProjectOptions.Builder`	`releaseWorkflowName(String releaseWorkflowName)`	Sets the value of `ReleaseProjectOptions.getReleaseWorkflowName()`
`NodeProjectOptions.Builder`	`releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps)`	Sets the value of `ReleaseProjectOptions.getReleaseWorkflowSetupSteps()`
`NodeProjectOptions.Builder`	`renovatebot(Boolean renovatebot)`	Sets the value of `ProjectOptions.getRenovatebot()`
`NodeProjectOptions.Builder`	`renovatebotOptions(RenovatebotOptions renovatebotOptions)`	Sets the value of `ProjectOptions.getRenovatebotOptions()`
`NodeProjectOptions.Builder`	`repository(String repository)`	Sets the value of `NodePackageOptions.getRepository()`
`NodeProjectOptions.Builder`	`repositoryDirectory(String repositoryDirectory)`	Sets the value of `NodePackageOptions.getRepositoryDirectory()`
`NodeProjectOptions.Builder`	`scopedPackagesOptions(List<? extends ScopedPackagesOptions> scopedPackagesOptions)`	Sets the value of `NodePackageOptions.getScopedPackagesOptions()`
`NodeProjectOptions.Builder`	`scripts(Map<String,String> scripts)`	Deprecated. use `project.addTask()` or `package.setScript()`
`NodeProjectOptions.Builder`	`stability(String stability)`	Sets the value of `NodePackageOptions.getStability()`
`NodeProjectOptions.Builder`	`stale(Boolean stale)`	Sets the value of `GitHubProjectOptions.getStale()`
`NodeProjectOptions.Builder`	`staleOptions(StaleOptions staleOptions)`	Sets the value of `GitHubProjectOptions.getStaleOptions()`
`NodeProjectOptions.Builder`	`versionrcOptions(Map<String,? extends Object> versionrcOptions)`	Sets the value of `ReleaseProjectOptions.getVersionrcOptions()`
`NodeProjectOptions.Builder`	`vscode(Boolean vscode)`	Sets the value of `GitHubProjectOptions.getVscode()`
`NodeProjectOptions.Builder`	`workflowBootstrapSteps(List<? extends JobStep> workflowBootstrapSteps)`	Sets the value of `NodeProjectOptions.getWorkflowBootstrapSteps()`
`NodeProjectOptions.Builder`	`workflowContainerImage(String workflowContainerImage)`	Sets the value of `ReleaseProjectOptions.getWorkflowContainerImage()`
`NodeProjectOptions.Builder`	`workflowGitIdentity(GitIdentity workflowGitIdentity)`	Sets the value of `NodeProjectOptions.getWorkflowGitIdentity()`
`NodeProjectOptions.Builder`	`workflowNodeVersion(String workflowNodeVersion)`	Sets the value of `NodeProjectOptions.getWorkflowNodeVersion()`
`NodeProjectOptions.Builder`	`workflowPackageCache(Boolean workflowPackageCache)`	Sets the value of `NodeProjectOptions.getWorkflowPackageCache()`
`NodeProjectOptions.Builder`	`workflowRunsOn(List<String> workflowRunsOn)`	Sets the value of `ReleaseProjectOptions.getWorkflowRunsOn()`
`NodeProjectOptions.Builder`	`workflowRunsOnGroup(GroupRunnerOptions workflowRunsOnGroup)`	Sets the value of `ReleaseProjectOptions.getWorkflowRunsOnGroup()`
`NodeProjectOptions.Builder`	`yarnBerryOptions(YarnBerryOptions yarnBerryOptions)`	Sets the value of `NodePackageOptions.getYarnBerryOptions()`

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
  - defaultReleaseBranch
```
@Stability(Experimental)
public NodeProjectOptions.Builder defaultReleaseBranch(String defaultReleaseBranch)
```
    Sets the value of NodeProjectOptions.getDefaultReleaseBranch()
    
    Parameters:
    
    defaultReleaseBranch - The name of the main release branch. This parameter is required.
    
    Returns:
    
    this
  - artifactsDirectory
```
@Stability(Experimental)
public NodeProjectOptions.Builder artifactsDirectory(String artifactsDirectory)
```
    Sets the value of NodeProjectOptions.getArtifactsDirectory()
    
    Parameters:
    
    artifactsDirectory - A directory which will contain build artifacts.
    
    Returns:
    
    this
  - autoApproveUpgrades
```
@Stability(Experimental)
public NodeProjectOptions.Builder autoApproveUpgrades(Boolean autoApproveUpgrades)
```
    Sets the value of NodeProjectOptions.getAutoApproveUpgrades()
    
    Parameters:
    
    autoApproveUpgrades - Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Throw if set to true but autoApproveOptions are not defined.
    
    Returns:
    
    this
  - buildWorkflow
```
@Stability(Experimental)
public NodeProjectOptions.Builder buildWorkflow(Boolean buildWorkflow)
```
    Sets the value of NodeProjectOptions.getBuildWorkflow()
    
    Parameters:
    
    buildWorkflow - Define a GitHub workflow for building PRs.
    
    Returns:
    
    this
  - buildWorkflowTriggers
```
@Stability(Experimental)
public NodeProjectOptions.Builder buildWorkflowTriggers(Triggers buildWorkflowTriggers)
```
    Sets the value of NodeProjectOptions.getBuildWorkflowTriggers()
    
    Parameters:
    
    buildWorkflowTriggers - Build workflow triggers.
    
    Returns:
    
    this
  - bundlerOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder bundlerOptions(BundlerOptions bundlerOptions)
```
    Sets the value of NodeProjectOptions.getBundlerOptions()
    
    Parameters:
    
    bundlerOptions - Options for Bundler.
    
    Returns:
    
    this
  - checkLicenses
```
@Stability(Experimental)
public NodeProjectOptions.Builder checkLicenses(LicenseCheckerOptions checkLicenses)
```
    Sets the value of NodeProjectOptions.getCheckLicenses()
    
    Parameters:
    
    checkLicenses - Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.
    
    Returns:
    
    this
  - codeCov
```
@Stability(Experimental)
public NodeProjectOptions.Builder codeCov(Boolean codeCov)
```
    Sets the value of NodeProjectOptions.getCodeCov()
    
    Parameters:
    
    codeCov - Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with @codeCovTokenSecret.
    
    Returns:
    
    this
  - codeCovTokenSecret
```
@Stability(Experimental)
public NodeProjectOptions.Builder codeCovTokenSecret(String codeCovTokenSecret)
```
    Sets the value of NodeProjectOptions.getCodeCovTokenSecret()
    
    Parameters:
    
    codeCovTokenSecret - Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
    
    Returns:
    
    this
  - copyrightOwner
```
@Stability(Experimental)
public NodeProjectOptions.Builder copyrightOwner(String copyrightOwner)
```
    Sets the value of NodeProjectOptions.getCopyrightOwner()
    
    Parameters:
    
    copyrightOwner - License copyright owner.
    
    Returns:
    
    this
  - copyrightPeriod
```
@Stability(Experimental)
public NodeProjectOptions.Builder copyrightPeriod(String copyrightPeriod)
```
    Sets the value of NodeProjectOptions.getCopyrightPeriod()
    
    Parameters:
    
    copyrightPeriod - The copyright years to put in the LICENSE file.
    
    Returns:
    
    this
  - dependabot
```
@Stability(Experimental)
public NodeProjectOptions.Builder dependabot(Boolean dependabot)
```
    Sets the value of NodeProjectOptions.getDependabot()
    
    Parameters:
    
    dependabot - Use dependabot to handle dependency upgrades. Cannot be used in conjunction with depsUpgrade.
    
    Returns:
    
    this
  - dependabotOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder dependabotOptions(DependabotOptions dependabotOptions)
```
    Sets the value of NodeProjectOptions.getDependabotOptions()
    
    Parameters:
    
    dependabotOptions - Options for dependabot.
    
    Returns:
    
    this
  - depsUpgrade
```
@Stability(Experimental)
public NodeProjectOptions.Builder depsUpgrade(Boolean depsUpgrade)
```
    Sets the value of NodeProjectOptions.getDepsUpgrade()
    
    Parameters:
    
    depsUpgrade - Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with dependabot.
    
    Returns:
    
    this
  - depsUpgradeOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder depsUpgradeOptions(UpgradeDependenciesOptions depsUpgradeOptions)
```
    Sets the value of NodeProjectOptions.getDepsUpgradeOptions()
    
    Parameters:
    
    depsUpgradeOptions - Options for UpgradeDependencies.
    
    Returns:
    
    this
  - gitignore
```
@Stability(Experimental)
public NodeProjectOptions.Builder gitignore(List<String> gitignore)
```
    Sets the value of NodeProjectOptions.getGitignore()
    
    Parameters:
    
    gitignore - Additional entries to .gitignore.
    
    Returns:
    
    this
  - jest
```
@Stability(Experimental)
public NodeProjectOptions.Builder jest(Boolean jest)
```
    Sets the value of NodeProjectOptions.getJest()
    
    Parameters:
    
    jest - Setup jest unit tests.
    
    Returns:
    
    this
  - jestOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder jestOptions(JestOptions jestOptions)
```
    Sets the value of NodeProjectOptions.getJestOptions()
    
    Parameters:
    
    jestOptions - Jest options.
    
    Returns:
    
    this
  - mutableBuild
```
@Stability(Experimental)
public NodeProjectOptions.Builder mutableBuild(Boolean mutableBuild)
```
    Sets the value of NodeProjectOptions.getMutableBuild()
    
    Parameters:
    
    mutableBuild - 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.
    
    Returns:
    
    this
  - npmignore
```
@Stability(Deprecated)
@Deprecated
public NodeProjectOptions.Builder npmignore(List<String> npmignore)
```
    Deprecated.
    - use `project.addPackageIgnore`
    
    Sets the value of NodeProjectOptions.getNpmignore()
    
    Parameters:
    
    npmignore - Additional entries to .npmignore.
    
    Returns:
    
    this
  - npmignoreEnabled
```
@Stability(Experimental)
public NodeProjectOptions.Builder npmignoreEnabled(Boolean npmignoreEnabled)
```
    Sets the value of NodeProjectOptions.getNpmignoreEnabled()
    
    Parameters:
    
    npmignoreEnabled - Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
    
    Returns:
    
    this
  - npmIgnoreOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder npmIgnoreOptions(IgnoreFileOptions npmIgnoreOptions)
```
    Sets the value of NodeProjectOptions.getNpmIgnoreOptions()
    
    Parameters:
    
    npmIgnoreOptions - Configuration options for .npmignore file.
    
    Returns:
    
    this
  - packageValue
```
@Stability(Experimental)
public NodeProjectOptions.Builder packageValue(Boolean packageValue)
```
    Sets the value of NodeProjectOptions.getPackageValue()
    
    Parameters:
    
    packageValue - Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
    
    Returns:
    
    this
  - prettier
```
@Stability(Experimental)
public NodeProjectOptions.Builder prettier(Boolean prettier)
```
    Sets the value of NodeProjectOptions.getPrettier()
    
    Parameters:
    
    prettier - Setup prettier.
    
    Returns:
    
    this
  - prettierOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder prettierOptions(PrettierOptions prettierOptions)
```
    Sets the value of NodeProjectOptions.getPrettierOptions()
    
    Parameters:
    
    prettierOptions - Prettier options.
    
    Returns:
    
    this
  - projenDevDependency
```
@Stability(Experimental)
public NodeProjectOptions.Builder projenDevDependency(Boolean projenDevDependency)
```
    Sets the value of NodeProjectOptions.getProjenDevDependency()
    
    Parameters:
    
    projenDevDependency - Indicates of "projen" should be installed as a devDependency.
    
    Returns:
    
    this
  - projenrcJs
```
@Stability(Experimental)
public NodeProjectOptions.Builder projenrcJs(Boolean projenrcJs)
```
    Sets the value of NodeProjectOptions.getProjenrcJs()
    
    Parameters:
    
    projenrcJs - Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
    
    Returns:
    
    this
  - projenrcJsOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder projenrcJsOptions(ProjenrcOptions projenrcJsOptions)
```
    Sets the value of NodeProjectOptions.getProjenrcJsOptions()
    
    Parameters:
    
    projenrcJsOptions - Options for .projenrc.js.
    
    Returns:
    
    this
  - projenVersion
```
@Stability(Experimental)
public NodeProjectOptions.Builder projenVersion(String projenVersion)
```
    Sets the value of NodeProjectOptions.getProjenVersion()
    
    Parameters:
    
    projenVersion - Version of projen to install.
    
    Returns:
    
    this
  - pullRequestTemplate
```
@Stability(Experimental)
public NodeProjectOptions.Builder pullRequestTemplate(Boolean pullRequestTemplate)
```
    Sets the value of NodeProjectOptions.getPullRequestTemplate()
    
    Parameters:
    
    pullRequestTemplate - Include a GitHub pull request template.
    
    Returns:
    
    this
  - pullRequestTemplateContents
```
@Stability(Experimental)
public NodeProjectOptions.Builder pullRequestTemplateContents(List<String> pullRequestTemplateContents)
```
    Sets the value of NodeProjectOptions.getPullRequestTemplateContents()
    
    Parameters:
    
    pullRequestTemplateContents - The contents of the pull request template.
    
    Returns:
    
    this
  - release
```
@Stability(Experimental)
public NodeProjectOptions.Builder release(Boolean release)
```
    Sets the value of NodeProjectOptions.getRelease()
    
    Parameters:
    
    release - Add release management to this project.
    
    Returns:
    
    this
  - releaseToNpm
```
@Stability(Experimental)
public NodeProjectOptions.Builder releaseToNpm(Boolean releaseToNpm)
```
    Sets the value of NodeProjectOptions.getReleaseToNpm()
    
    Parameters:
    
    releaseToNpm - Automatically release to npm when new versions are introduced.
    
    Returns:
    
    this
  - releaseWorkflow
```
@Stability(Deprecated)
@Deprecated
public NodeProjectOptions.Builder releaseWorkflow(Boolean releaseWorkflow)
```
    Deprecated.
    see `release`.
    
    Sets the value of NodeProjectOptions.getReleaseWorkflow()
    
    Parameters:
    
    releaseWorkflow - DEPRECATED: renamed to release.
    
    Returns:
    
    this
  - workflowBootstrapSteps
```
@Stability(Experimental)
public NodeProjectOptions.Builder workflowBootstrapSteps(List<? extends JobStep> workflowBootstrapSteps)
```
    Sets the value of NodeProjectOptions.getWorkflowBootstrapSteps()
    
    Parameters:
    
    workflowBootstrapSteps - Workflow steps to use in order to bootstrap this repo.
    
    Returns:
    
    this
  - workflowGitIdentity
```
@Stability(Experimental)
public NodeProjectOptions.Builder workflowGitIdentity(GitIdentity workflowGitIdentity)
```
    Sets the value of NodeProjectOptions.getWorkflowGitIdentity()
    
    Parameters:
    
    workflowGitIdentity - The git identity to use in workflows.
    
    Returns:
    
    this
  - workflowNodeVersion
```
@Stability(Experimental)
public NodeProjectOptions.Builder workflowNodeVersion(String workflowNodeVersion)
```
    Sets the value of NodeProjectOptions.getWorkflowNodeVersion()
    
    Parameters:
    
    workflowNodeVersion - The node version to use in GitHub workflows.
    
    Returns:
    
    this
  - workflowPackageCache
```
@Stability(Experimental)
public NodeProjectOptions.Builder workflowPackageCache(Boolean workflowPackageCache)
```
    Sets the value of NodeProjectOptions.getWorkflowPackageCache()
    
    Parameters:
    
    workflowPackageCache - Enable Node.js package cache in GitHub workflows.
    
    Returns:
    
    this
  - autoApproveOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder autoApproveOptions(AutoApproveOptions autoApproveOptions)
```
    Sets the value of GitHubProjectOptions.getAutoApproveOptions()
    
    Parameters:
    
    autoApproveOptions - Enable and configure the 'auto approve' workflow.
    
    Returns:
    
    this
  - autoMerge
```
@Stability(Experimental)
public NodeProjectOptions.Builder autoMerge(Boolean autoMerge)
```
    Sets the value of GitHubProjectOptions.getAutoMerge()
    
    Parameters:
    
    autoMerge - Enable automatic merging on GitHub. Has no effect if github.mergify is set to false.
    
    Returns:
    
    this
  - autoMergeOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder autoMergeOptions(AutoMergeOptions autoMergeOptions)
```
    Sets the value of GitHubProjectOptions.getAutoMergeOptions()
    
    Parameters:
    
    autoMergeOptions - Configure options for automatic merging on GitHub. Has no effect if github.mergify or autoMerge is set to false.
    
    Returns:
    
    this
  - clobber
```
@Stability(Experimental)
public NodeProjectOptions.Builder clobber(Boolean clobber)
```
    Sets the value of GitHubProjectOptions.getClobber()
    
    Parameters:
    
    clobber - Add a clobber task which resets the repo to origin.
    
    Returns:
    
    this
  - devContainer
```
@Stability(Experimental)
public NodeProjectOptions.Builder devContainer(Boolean devContainer)
```
    Sets the value of GitHubProjectOptions.getDevContainer()
    
    Parameters:
    
    devContainer - Add a VSCode development environment (used for GitHub Codespaces).
    
    Returns:
    
    this
  - github
```
@Stability(Experimental)
public NodeProjectOptions.Builder github(Boolean github)
```
    Sets the value of GitHubProjectOptions.getGithub()
    
    Parameters:
    
    github - Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects.
    
    Returns:
    
    this
  - githubOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder githubOptions(GitHubOptions githubOptions)
```
    Sets the value of GitHubProjectOptions.getGithubOptions()
    
    Parameters:
    
    githubOptions - Options for GitHub integration.
    
    Returns:
    
    this
  - gitpod
```
@Stability(Experimental)
public NodeProjectOptions.Builder gitpod(Boolean gitpod)
```
    Sets the value of GitHubProjectOptions.getGitpod()
    
    Parameters:
    
    gitpod - Add a Gitpod development environment.
    
    Returns:
    
    this
  - mergify
```
@Stability(Deprecated)
@Deprecated
public NodeProjectOptions.Builder mergify(Boolean mergify)
```
    Deprecated.
    use `githubOptions.mergify` instead
    
    Sets the value of GitHubProjectOptions.getMergify()
    
    Parameters:
    
    mergify - Whether mergify should be enabled on this repository or not.
    
    Returns:
    
    this
  - mergifyOptions
```
@Stability(Deprecated)
@Deprecated
public NodeProjectOptions.Builder mergifyOptions(MergifyOptions mergifyOptions)
```
    Deprecated.
    use `githubOptions.mergifyOptions` instead
    
    Sets the value of GitHubProjectOptions.getMergifyOptions()
    
    Parameters:
    
    mergifyOptions - Options for mergify.
    
    Returns:
    
    this
  - projectType
```
@Stability(Deprecated)
@Deprecated
public NodeProjectOptions.Builder projectType(ProjectType projectType)
```
    Deprecated.
    no longer supported at the base project level
    
    Sets the value of GitHubProjectOptions.getProjectType()
    
    Parameters:
    
    projectType - Which type of project this is (library/app).
    
    Returns:
    
    this
  - projenCredentials
```
@Stability(Experimental)
public NodeProjectOptions.Builder projenCredentials(GithubCredentials projenCredentials)
```
    Sets the value of GitHubProjectOptions.getProjenCredentials()
    
    Parameters:
    
    projenCredentials - Choose a method of providing GitHub API access for projen workflows.
    
    Returns:
    
    this
  - projenTokenSecret
```
@Stability(Deprecated)
@Deprecated
public NodeProjectOptions.Builder projenTokenSecret(String projenTokenSecret)
```
    Deprecated.
    use `projenCredentials`
    
    Sets the value of GitHubProjectOptions.getProjenTokenSecret()
    
    Parameters:
    
    projenTokenSecret - The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. This token needs to have the repo, workflows and packages scope.
    
    Returns:
    
    this
  - readme
```
@Stability(Experimental)
public NodeProjectOptions.Builder readme(SampleReadmeProps readme)
```
    Sets the value of GitHubProjectOptions.getReadme()
    
    Parameters:
    
    readme - The README setup.
    
    Returns:
    
    this
  - stale
```
@Stability(Experimental)
public NodeProjectOptions.Builder stale(Boolean stale)
```
    Sets the value of GitHubProjectOptions.getStale()
    
    Parameters:
    
    stale - Auto-close of stale issues and pull request. See staleOptions for options.
    
    Returns:
    
    this
  - staleOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder staleOptions(StaleOptions staleOptions)
```
    Sets the value of GitHubProjectOptions.getStaleOptions()
    
    Parameters:
    
    staleOptions - Auto-close stale issues and pull requests. To disable set stale to false.
    
    Returns:
    
    this
  - vscode
```
@Stability(Experimental)
public NodeProjectOptions.Builder vscode(Boolean vscode)
```
    Sets the value of GitHubProjectOptions.getVscode()
    
    Parameters:
    
    vscode - Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects.
    
    Returns:
    
    this
  - name
```
@Stability(Experimental)
public NodeProjectOptions.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 NodeProjectOptions.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 NodeProjectOptions.Builder gitIgnoreOptions(IgnoreFileOptions gitIgnoreOptions)
```
    Sets the value of ProjectOptions.getGitIgnoreOptions()
    
    Parameters:
    
    gitIgnoreOptions - Configuration options for .gitignore file.
    
    Returns:
    
    this
  - gitOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder gitOptions(GitOptions gitOptions)
```
    Sets the value of ProjectOptions.getGitOptions()
    
    Parameters:
    
    gitOptions - Configuration options for git.
    
    Returns:
    
    this
  - logging
```
@Stability(Experimental)
public NodeProjectOptions.Builder logging(LoggerOptions logging)
```
    Sets the value of ProjectOptions.getLogging()
    
    Parameters:
    
    logging - Configure logging options such as verbosity.
    
    Returns:
    
    this
  - outdir
```
@Stability(Experimental)
public NodeProjectOptions.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 NodeProjectOptions.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 NodeProjectOptions.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 NodeProjectOptions.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 NodeProjectOptions.Builder projenrcJsonOptions(ProjenrcJsonOptions projenrcJsonOptions)
```
    Sets the value of ProjectOptions.getProjenrcJsonOptions()
    
    Parameters:
    
    projenrcJsonOptions - Options for .projenrc.json.
    
    Returns:
    
    this
  - renovatebot
```
@Stability(Experimental)
public NodeProjectOptions.Builder renovatebot(Boolean renovatebot)
```
    Sets the value of ProjectOptions.getRenovatebot()
    
    Parameters:
    
    renovatebot - Use renovatebot to handle dependency upgrades.
    
    Returns:
    
    this
  - renovatebotOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder renovatebotOptions(RenovatebotOptions renovatebotOptions)
```
    Sets the value of ProjectOptions.getRenovatebotOptions()
    
    Parameters:
    
    renovatebotOptions - Options for renovatebot.
    
    Returns:
    
    this
  - allowLibraryDependencies
```
@Stability(Experimental)
public NodeProjectOptions.Builder allowLibraryDependencies(Boolean allowLibraryDependencies)
```
    Sets the value of NodePackageOptions.getAllowLibraryDependencies()
    
    Parameters:
    
    allowLibraryDependencies - Allow the project to include peerDependencies and bundledDependencies. This is normally only allowed for libraries. For apps, there's no meaning for specifying these.
    
    Returns:
    
    this
  - authorEmail
```
@Stability(Experimental)
public NodeProjectOptions.Builder authorEmail(String authorEmail)
```
    Sets the value of NodePackageOptions.getAuthorEmail()
    
    Parameters:
    
    authorEmail - Author's e-mail.
    
    Returns:
    
    this
  - authorName
```
@Stability(Experimental)
public NodeProjectOptions.Builder authorName(String authorName)
```
    Sets the value of NodePackageOptions.getAuthorName()
    
    Parameters:
    
    authorName - Author's name.
    
    Returns:
    
    this
  - authorOrganization
```
@Stability(Experimental)
public NodeProjectOptions.Builder authorOrganization(Boolean authorOrganization)
```
    Sets the value of NodePackageOptions.getAuthorOrganization()
    
    Parameters:
    
    authorOrganization - Is the author an organization.
    
    Returns:
    
    this
  - authorUrl
```
@Stability(Experimental)
public NodeProjectOptions.Builder authorUrl(String authorUrl)
```
    Sets the value of NodePackageOptions.getAuthorUrl()
    
    Parameters:
    
    authorUrl - Author's URL / Website.
    
    Returns:
    
    this
  - autoDetectBin
```
@Stability(Experimental)
public NodeProjectOptions.Builder autoDetectBin(Boolean autoDetectBin)
```
    Sets the value of NodePackageOptions.getAutoDetectBin()
    
    Parameters:
    
    autoDetectBin - Automatically add all executables under the bin directory to your package.json file under the bin section.
    
    Returns:
    
    this
  - bin
```
@Stability(Experimental)
public NodeProjectOptions.Builder bin(Map<String,String> bin)
```
    Sets the value of NodePackageOptions.getBin()
    
    Parameters:
    
    bin - 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.
    
    Returns:
    
    this
  - bugsEmail
```
@Stability(Experimental)
public NodeProjectOptions.Builder bugsEmail(String bugsEmail)
```
    Sets the value of NodePackageOptions.getBugsEmail()
    
    Parameters:
    
    bugsEmail - The email address to which issues should be reported.
    
    Returns:
    
    this
  - bugsUrl
```
@Stability(Experimental)
public NodeProjectOptions.Builder bugsUrl(String bugsUrl)
```
    Sets the value of NodePackageOptions.getBugsUrl()
    
    Parameters:
    
    bugsUrl - The url to your project's issue tracker.
    
    Returns:
    
    this
  - bundledDeps
```
@Stability(Experimental)
public NodeProjectOptions.Builder bundledDeps(List<String> bundledDeps)
```
    Sets the value of NodePackageOptions.getBundledDeps()
    
    Parameters:
    
    bundledDeps - 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.
    
    Returns:
    
    this
  - codeArtifactOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder codeArtifactOptions(CodeArtifactOptions codeArtifactOptions)
```
    Sets the value of NodePackageOptions.getCodeArtifactOptions()
    
    Parameters:
    
    codeArtifactOptions - Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
    
    Returns:
    
    this
  - deps
```
@Stability(Experimental)
public NodeProjectOptions.Builder deps(List<String> deps)
```
    Sets the value of NodePackageOptions.getDeps()
    
    Parameters:
    
    deps - 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.
    
    Returns:
    
    this
  - description
```
@Stability(Experimental)
public NodeProjectOptions.Builder description(String description)
```
    Sets the value of NodePackageOptions.getDescription()
    
    Parameters:
    
    description - 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
    
    Returns:
    
    this
  - devDeps
```
@Stability(Experimental)
public NodeProjectOptions.Builder devDeps(List<String> devDeps)
```
    Sets the value of NodePackageOptions.getDevDeps()
    
    Parameters:
    
    devDeps - 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.
    
    Returns:
    
    this
  - entrypoint
```
@Stability(Experimental)
public NodeProjectOptions.Builder entrypoint(String entrypoint)
```
    Sets the value of NodePackageOptions.getEntrypoint()
    
    Parameters:
    
    entrypoint - Module entrypoint (main in package.json). Set to an empty string to not include main in your package.json
    
    Returns:
    
    this
  - homepage
```
@Stability(Experimental)
public NodeProjectOptions.Builder homepage(String homepage)
```
    Sets the value of NodePackageOptions.getHomepage()
    
    Parameters:
    
    homepage - Package's Homepage / Website.
    
    Returns:
    
    this
  - keywords
```
@Stability(Experimental)
public NodeProjectOptions.Builder keywords(List<String> keywords)
```
    Sets the value of NodePackageOptions.getKeywords()
    
    Parameters:
    
    keywords - Keywords to include in package.json.
    
    Returns:
    
    this
  - license
```
@Stability(Experimental)
public NodeProjectOptions.Builder license(String license)
```
    Sets the value of NodePackageOptions.getLicense()
    
    Parameters:
    
    license - 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.
    
    Returns:
    
    this
  - licensed
```
@Stability(Experimental)
public NodeProjectOptions.Builder licensed(Boolean licensed)
```
    Sets the value of NodePackageOptions.getLicensed()
    
    Parameters:
    
    licensed - Indicates if a license should be added.
    
    Returns:
    
    this
  - maxNodeVersion
```
@Stability(Experimental)
public NodeProjectOptions.Builder maxNodeVersion(String maxNodeVersion)
```
    Sets the value of NodePackageOptions.getMaxNodeVersion()
    
    Parameters:
    
    maxNodeVersion - Minimum node.js version to require via engines (inclusive).
    
    Returns:
    
    this
  - minNodeVersion
```
@Stability(Experimental)
public NodeProjectOptions.Builder minNodeVersion(String minNodeVersion)
```
    Sets the value of NodePackageOptions.getMinNodeVersion()
    
    Parameters:
    
    minNodeVersion - Minimum Node.js version to require via package.json engines (inclusive).
    
    Returns:
    
    this
  - npmAccess
```
@Stability(Experimental)
public NodeProjectOptions.Builder npmAccess(NpmAccess npmAccess)
```
    Sets the value of NodePackageOptions.getNpmAccess()
    
    Parameters:
    
    npmAccess - Access level of the npm package.
    
    Returns:
    
    this
  - npmProvenance
```
@Stability(Experimental)
public NodeProjectOptions.Builder npmProvenance(Boolean npmProvenance)
```
    Sets the value of NodePackageOptions.getNpmProvenance()
    
    Parameters:
    
    npmProvenance - Should provenance statements be generated when the package is published. A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider.
    Note that the projen Release and Publisher components are using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.
    
    Returns:
    
    this
  - npmRegistry
```
@Stability(Deprecated)
@Deprecated
public NodeProjectOptions.Builder npmRegistry(String npmRegistry)
```
    Deprecated.
    use `npmRegistryUrl` instead
    
    Sets the value of NodePackageOptions.getNpmRegistry()
    
    Parameters:
    
    npmRegistry - The host name of the npm registry to publish to. Cannot be set together with npmRegistryUrl.
    
    Returns:
    
    this
  - npmRegistryUrl
```
@Stability(Experimental)
public NodeProjectOptions.Builder npmRegistryUrl(String npmRegistryUrl)
```
    Sets the value of NodePackageOptions.getNpmRegistryUrl()
    
    Parameters:
    
    npmRegistryUrl - The base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://")
    
    Returns:
    
    this
  - npmTokenSecret
```
@Stability(Experimental)
public NodeProjectOptions.Builder npmTokenSecret(String npmTokenSecret)
```
    Sets the value of NodePackageOptions.getNpmTokenSecret()
    
    Parameters:
    
    npmTokenSecret - GitHub secret which contains the NPM token to use when publishing packages.
    
    Returns:
    
    this
  - packageManager
```
@Stability(Experimental)
public NodeProjectOptions.Builder packageManager(NodePackageManager packageManager)
```
    Sets the value of NodePackageOptions.getPackageManager()
    
    Parameters:
    
    packageManager - The Node Package Manager used to execute scripts.
    
    Returns:
    
    this
  - packageName
```
@Stability(Experimental)
public NodeProjectOptions.Builder packageName(String packageName)
```
    Sets the value of NodePackageOptions.getPackageName()
    
    Parameters:
    
    packageName - The "name" in package.json.
    
    Returns:
    
    this
  - peerDependencyOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder peerDependencyOptions(PeerDependencyOptions peerDependencyOptions)
```
    Sets the value of NodePackageOptions.getPeerDependencyOptions()
    
    Parameters:
    
    peerDependencyOptions - Options for peerDeps.
    
    Returns:
    
    this
  - peerDeps
```
@Stability(Experimental)
public NodeProjectOptions.Builder peerDeps(List<String> peerDeps)
```
    Sets the value of NodePackageOptions.getPeerDeps()
    
    Parameters:
    
    peerDeps - 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.
    
    Returns:
    
    this
  - pnpmVersion
```
@Stability(Experimental)
public NodeProjectOptions.Builder pnpmVersion(String pnpmVersion)
```
    Sets the value of NodePackageOptions.getPnpmVersion()
    
    Parameters:
    
    pnpmVersion - The version of PNPM to use if using PNPM as a package manager.
    
    Returns:
    
    this
  - repository
```
@Stability(Experimental)
public NodeProjectOptions.Builder repository(String repository)
```
    Sets the value of NodePackageOptions.getRepository()
    
    Parameters:
    
    repository - The repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
    
    Returns:
    
    this
  - repositoryDirectory
```
@Stability(Experimental)
public NodeProjectOptions.Builder repositoryDirectory(String repositoryDirectory)
```
    Sets the value of NodePackageOptions.getRepositoryDirectory()
    
    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.
    
    Returns:
    
    this
  - scopedPackagesOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder scopedPackagesOptions(List<? extends ScopedPackagesOptions> scopedPackagesOptions)
```
    Sets the value of NodePackageOptions.getScopedPackagesOptions()
    
    Parameters:
    
    scopedPackagesOptions - Options for privately hosted scoped packages.
    
    Returns:
    
    this
  - scripts
```
@Stability(Deprecated)
@Deprecated
public NodeProjectOptions.Builder scripts(Map<String,String> scripts)
```
    Deprecated.
    use `project.addTask()` or `package.setScript()`
    
    Sets the value of NodePackageOptions.getScripts()
    
    Parameters:
    
    scripts - npm scripts to include. If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task.
    
    Returns:
    
    this
  - stability
```
@Stability(Experimental)
public NodeProjectOptions.Builder stability(String stability)
```
    Sets the value of NodePackageOptions.getStability()
    
    Parameters:
    
    stability - Package's Stability.
    
    Returns:
    
    this
  - yarnBerryOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder yarnBerryOptions(YarnBerryOptions yarnBerryOptions)
```
    Sets the value of NodePackageOptions.getYarnBerryOptions()
    
    Parameters:
    
    yarnBerryOptions - Options for Yarn Berry.
    
    Returns:
    
    this
  - jsiiReleaseVersion
```
@Stability(Experimental)
public NodeProjectOptions.Builder jsiiReleaseVersion(String jsiiReleaseVersion)
```
    Sets the value of ReleaseProjectOptions.getJsiiReleaseVersion()
    
    Parameters:
    
    jsiiReleaseVersion - Version requirement of publib which is used to publish modules to npm.
    
    Returns:
    
    this
  - majorVersion
```
@Stability(Experimental)
public NodeProjectOptions.Builder majorVersion(Number majorVersion)
```
    Sets the value of ReleaseProjectOptions.getMajorVersion()
    
    Parameters:
    
    majorVersion - 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.
    
    Returns:
    
    this
  - minMajorVersion
```
@Stability(Experimental)
public NodeProjectOptions.Builder minMajorVersion(Number minMajorVersion)
```
    Sets the value of ReleaseProjectOptions.getMinMajorVersion()
    
    Parameters:
    
    minMajorVersion - Minimal Major version to release. This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number.
    Can not be set together with majorVersion.
    
    Returns:
    
    this
  - npmDistTag
```
@Stability(Experimental)
public NodeProjectOptions.Builder npmDistTag(String npmDistTag)
```
    Sets the value of ReleaseProjectOptions.getNpmDistTag()
    
    Parameters:
    
    npmDistTag - 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.
    
    Returns:
    
    this
  - postBuildSteps
```
@Stability(Experimental)
public NodeProjectOptions.Builder postBuildSteps(List<? extends JobStep> postBuildSteps)
```
    Sets the value of ReleaseProjectOptions.getPostBuildSteps()
    
    Parameters:
    
    postBuildSteps - Steps to execute after build as part of the release workflow.
    
    Returns:
    
    this
  - prerelease
```
@Stability(Experimental)
public NodeProjectOptions.Builder prerelease(String prerelease)
```
    Sets the value of ReleaseProjectOptions.getPrerelease()
    
    Parameters:
    
    prerelease - Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
    
    Returns:
    
    this
  - publishDryRun
```
@Stability(Experimental)
public NodeProjectOptions.Builder publishDryRun(Boolean publishDryRun)
```
    Sets the value of ReleaseProjectOptions.getPublishDryRun()
    
    Parameters:
    
    publishDryRun - Instead of actually publishing to package managers, just print the publishing command.
    
    Returns:
    
    this
  - publishTasks
```
@Stability(Experimental)
public NodeProjectOptions.Builder publishTasks(Boolean publishTasks)
```
    Sets the value of ReleaseProjectOptions.getPublishTasks()
    
    Parameters:
    
    publishTasks - 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.
    
    Returns:
    
    this
  - releasableCommits
```
@Stability(Experimental)
public NodeProjectOptions.Builder releasableCommits(ReleasableCommits releasableCommits)
```
    Sets the value of ReleaseProjectOptions.getReleasableCommits()
    
    Parameters:
    
    releasableCommits - Find commits that should be considered releasable Used to decide if a release is required.
    
    Returns:
    
    this
  - releaseBranches
```
@Stability(Experimental)
public NodeProjectOptions.Builder releaseBranches(Map<String,? extends BranchOptions> releaseBranches)
```
    Sets the value of ReleaseProjectOptions.getReleaseBranches()
    
    Parameters:
    
    releaseBranches - 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.
    
    Returns:
    
    this
  - releaseEveryCommit
```
@Stability(Deprecated)
@Deprecated
public NodeProjectOptions.Builder releaseEveryCommit(Boolean releaseEveryCommit)
```
    Deprecated.
    Use `releaseTrigger: ReleaseTrigger.continuous()` instead
    
    Sets the value of ReleaseProjectOptions.getReleaseEveryCommit()
    
    Parameters:
    
    releaseEveryCommit - Automatically release new versions every commit to one of branches in releaseBranches.
    
    Returns:
    
    this
  - releaseFailureIssue
```
@Stability(Experimental)
public NodeProjectOptions.Builder releaseFailureIssue(Boolean releaseFailureIssue)
```
    Sets the value of ReleaseProjectOptions.getReleaseFailureIssue()
    
    Parameters:
    
    releaseFailureIssue - Create a github issue on every failed publishing task.
    
    Returns:
    
    this
  - releaseFailureIssueLabel
```
@Stability(Experimental)
public NodeProjectOptions.Builder releaseFailureIssueLabel(String releaseFailureIssueLabel)
```
    Sets the value of ReleaseProjectOptions.getReleaseFailureIssueLabel()
    
    Parameters:
    
    releaseFailureIssueLabel - The label to apply to issues indicating publish failures. Only applies if releaseFailureIssue is true.
    
    Returns:
    
    this
  - releaseSchedule
```
@Stability(Deprecated)
@Deprecated
public NodeProjectOptions.Builder releaseSchedule(String releaseSchedule)
```
    Deprecated.
    Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
    
    Sets the value of ReleaseProjectOptions.getReleaseSchedule()
    
    Parameters:
    
    releaseSchedule - CRON schedule to trigger new releases.
    
    Returns:
    
    this
  - releaseTagPrefix
```
@Stability(Experimental)
public NodeProjectOptions.Builder releaseTagPrefix(String releaseTagPrefix)
```
    Sets the value of ReleaseProjectOptions.getReleaseTagPrefix()
    
    Parameters:
    
    releaseTagPrefix - 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.
    
    Returns:
    
    this
  - releaseTrigger
```
@Stability(Experimental)
public NodeProjectOptions.Builder releaseTrigger(ReleaseTrigger releaseTrigger)
```
    Sets the value of ReleaseProjectOptions.getReleaseTrigger()
    
    Parameters:
    
    releaseTrigger - The release trigger to use.
    
    Returns:
    
    this
  - releaseWorkflowName
```
@Stability(Experimental)
public NodeProjectOptions.Builder releaseWorkflowName(String releaseWorkflowName)
```
    Sets the value of ReleaseProjectOptions.getReleaseWorkflowName()
    
    Parameters:
    
    releaseWorkflowName - The name of the default release workflow.
    
    Returns:
    
    this
  - releaseWorkflowSetupSteps
```
@Stability(Experimental)
public NodeProjectOptions.Builder releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps)
```
    Sets the value of ReleaseProjectOptions.getReleaseWorkflowSetupSteps()
    
    Parameters:
    
    releaseWorkflowSetupSteps - A set of workflow steps to execute in order to setup the workflow container.
    
    Returns:
    
    this
  - versionrcOptions
```
@Stability(Experimental)
public NodeProjectOptions.Builder versionrcOptions(Map<String,? extends Object> versionrcOptions)
```
    Sets the value of ReleaseProjectOptions.getVersionrcOptions()
    
    Parameters:
    
    versionrcOptions - Custom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it.
    
    Returns:
    
    this
  - workflowContainerImage
```
@Stability(Experimental)
public NodeProjectOptions.Builder workflowContainerImage(String workflowContainerImage)
```
    Sets the value of ReleaseProjectOptions.getWorkflowContainerImage()
    
    Parameters:
    
    workflowContainerImage - Container image to use for GitHub workflows.
    
    Returns:
    
    this
  - workflowRunsOn
```
@Stability(Experimental)
public NodeProjectOptions.Builder workflowRunsOn(List<String> workflowRunsOn)
```
    Sets the value of ReleaseProjectOptions.getWorkflowRunsOn()
    
    Parameters:
    
    workflowRunsOn - Github Runner selection labels.
    
    Returns:
    
    this
  - workflowRunsOnGroup
```
@Stability(Experimental)
public NodeProjectOptions.Builder workflowRunsOnGroup(GroupRunnerOptions workflowRunsOnGroup)
```
    Sets the value of ReleaseProjectOptions.getWorkflowRunsOnGroup()
    
    Parameters:
    
    workflowRunsOnGroup - Github Runner Group selection options.
    
    Returns:
    
    this
  - build
```
@Stability(Experimental)
public NodeProjectOptions build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<NodeProjectOptions>
    
    Returns:
    
    a new instance of NodeProjectOptions
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class NodeProjectOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

defaultReleaseBranch

artifactsDirectory

autoApproveUpgrades

buildWorkflow

buildWorkflowTriggers

bundlerOptions

checkLicenses

codeCov

codeCovTokenSecret

copyrightOwner

copyrightPeriod

dependabot

dependabotOptions

depsUpgrade

depsUpgradeOptions

gitignore

jest

jestOptions

mutableBuild

npmignore

npmignoreEnabled

npmIgnoreOptions

packageValue

prettier

prettierOptions

projenDevDependency

projenrcJs

projenrcJsOptions

projenVersion

pullRequestTemplate

pullRequestTemplateContents

release

releaseToNpm

releaseWorkflow

workflowBootstrapSteps

workflowGitIdentity

workflowNodeVersion

workflowPackageCache

autoApproveOptions

autoMerge

autoMergeOptions

clobber

devContainer

github

githubOptions

gitpod

mergify

mergifyOptions

projectType

projenCredentials

projenTokenSecret

readme

stale

staleOptions

vscode

name

commitGenerated

gitIgnoreOptions

gitOptions

logging

outdir

parent

projenCommand

projenrcJson

projenrcJsonOptions

renovatebot

renovatebotOptions

allowLibraryDependencies

authorEmail

authorName

authorOrganization

authorUrl

autoDetectBin