NodeProjectOptions (io.github.cdklabs:projen 0.45.3 API)

All Superinterfaces:

GitHubProjectOptions, software.amazon.jsii.JsiiSerializable, NodePackageOptions, ProjectOptions, ReleaseProjectOptions

All Known Subinterfaces:

AwsCdkConstructLibraryOptions, AwsCdkTypeScriptAppOptions, Cdk8sTypeScriptAppOptions, ConstructLibraryAwsOptions, ConstructLibraryCdk8sOptions, ConstructLibraryCdktfOptions, ConstructLibraryOptions, JsiiProjectOptions, NextJsProjectOptions, NextJsTypeScriptProjectOptions, ReactProjectOptions, ReactTypeScriptProjectOptions, TypeScriptLibraryProjectOptions, TypeScriptProjectOptions

All Known Implementing Classes:

AwsCdkConstructLibraryOptions.Jsii$Proxy, AwsCdkTypeScriptAppOptions.Jsii$Proxy, Cdk8sTypeScriptAppOptions.Jsii$Proxy, ConstructLibraryAwsOptions.Jsii$Proxy, ConstructLibraryCdk8sOptions.Jsii$Proxy, ConstructLibraryCdktfOptions.Jsii$Proxy, ConstructLibraryOptions.Jsii$Proxy, JsiiProjectOptions.Jsii$Proxy, NextJsProjectOptions.Jsii$Proxy, NextJsTypeScriptProjectOptions.Jsii$Proxy, NodeProjectOptions.Jsii$Proxy, ReactProjectOptions.Jsii$Proxy, ReactTypeScriptProjectOptions.Jsii$Proxy, TypeScriptLibraryProjectOptions.Jsii$Proxy, TypeScriptProjectOptions.Jsii$Proxy
```
@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.862Z")
 @Stability(value=Experimental)
public interface NodeProjectOptions
extends software.amazon.jsii.JsiiSerializable, GitHubProjectOptions, NodePackageOptions, ReleaseProjectOptions
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`NodeProjectOptions.Builder` A builder for `NodeProjectOptions`
`static class`	`NodeProjectOptions.Jsii$Proxy` An implementation for `NodeProjectOptions`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`static NodeProjectOptions.Builder`	`builder()`
`default Boolean`	`getAutoApproveProjenUpgrades()` (experimental) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).
`default Boolean`	`getAutoApproveUpgrades()` (experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
`default Boolean`	`getBuildWorkflow()` (experimental) Define a GitHub workflow for building PRs.
`default BundlerOptions`	`getBundlerOptions()` (experimental) Options for `Bundler`.
`default Boolean`	`getCodeCov()` (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.
`default String`	`getCodeCovTokenSecret()` (experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
`default String`	`getCopyrightOwner()` (experimental) License copyright owner.
`default String`	`getCopyrightPeriod()` (experimental) The copyright years to put in the LICENSE file.
`String`	`getDefaultReleaseBranch()` (experimental) The name of the main release branch.
`default Boolean`	`getDependabot()` (experimental) Use dependabot to handle dependency upgrades.
`default DependabotOptions`	`getDependabotOptions()` (experimental) Options for dependabot.
`default Boolean`	`getDepsUpgrade()` (experimental) Use github workflows to handle dependency upgrades.
`default UpgradeDependenciesOptions`	`getDepsUpgradeOptions()` (experimental) Options for depsUpgrade.
`default List<String>`	`getGitignore()` (experimental) Additional entries to .gitignore.
`default Boolean`	`getJest()` (experimental) Setup jest unit tests.
`default JestOptions`	`getJestOptions()` (experimental) Jest options.
`default Boolean`	`getMutableBuild()` (experimental) Automatically update files modified during builds to pull-request branches.
`default List<String>`	`getNpmignore()` Deprecated. - use `project.addPackageIgnore`
`default Boolean`	`getNpmignoreEnabled()` (experimental) Defines an .npmignore file.
`default Boolean`	`getProjenDevDependency()` (experimental) Indicates of "projen" should be installed as a devDependency.
`default Boolean`	`getProjenrcJs()` (experimental) Generate (once) .projenrc.js (in JavaScript).
`default ProjenrcOptions`	`getProjenrcJsOptions()` (experimental) Options for .projenrc.js.
`default Boolean`	`getProjenUpgradeAutoMerge()` Deprecated. use `autoApproveProjenUpgrades`.
`default List<String>`	`getProjenUpgradeSchedule()` (experimental) Customize the projenUpgrade schedule in cron expression.
`default String`	`getProjenUpgradeSecret()` (experimental) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).
`default String`	`getProjenVersion()` (experimental) Version of projen to install.
`default Boolean`	`getPullRequestTemplate()` (experimental) Include a GitHub pull request template.
`default List<String>`	`getPullRequestTemplateContents()` (experimental) The contents of the pull request template.
`default Boolean`	`getRelease()` (experimental) Add release management to this project.
`default Boolean`	`getReleaseToNpm()` (experimental) Automatically release to npm when new versions are introduced.
`default Boolean`	`getReleaseWorkflow()` Deprecated. see `release`.
`default List<Object>`	`getWorkflowBootstrapSteps()` (experimental) Workflow steps to use in order to bootstrap this repo.
`default GitIdentity`	`getWorkflowGitIdentity()` (experimental) The git identity to use in workflows.
`default String`	`getWorkflowNodeVersion()` (experimental) The node version to use in GitHub workflows.

Methods inherited from interface io.github.cdklabs.projen.github.GitHubProjectOptions
getAutoApproveOptions, getAutoMergeOptions, getClobber, getDevContainer, getGithub, getGithubOptions, getGitpod, getMergify, getMergifyOptions, getProjectType, getReadme, getStale, getStaleOptions, getVscode

Methods inherited from interface io.github.cdklabs.projen.ProjectOptions
getLogging, getName, getOutdir, getParent, getProjenCommand, getProjenrcJson, getProjenrcJsonOptions

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Methods inherited from interface io.github.cdklabs.projen.javascript.NodePackageOptions
getAllowLibraryDependencies, getAuthorEmail, getAuthorName, getAuthorOrganization, getAuthorUrl, getAutoDetectBin, getBin, getBundledDeps, getCodeArtifactOptions, getDeps, getDescription, getDevDeps, getEntrypoint, getHomepage, getKeywords, getLicense, getLicensed, getMaxNodeVersion, getMinNodeVersion, getNpmAccess, getNpmRegistry, getNpmRegistryUrl, getNpmTokenSecret, getPackageManager, getPackageName, getPeerDependencyOptions, getPeerDeps, getRepository, getRepositoryDirectory, getScripts, getStability

Methods inherited from interface io.github.cdklabs.projen.release.ReleaseProjectOptions
getAntitamper, getArtifactsDirectory, getJsiiReleaseVersion, getMajorVersion, getNpmDistTag, getPostBuildSteps, getPrerelease, getPublishTasks, getReleaseBranches, getReleaseEveryCommit, getReleaseFailureIssue, getReleaseFailureIssueLabel, getReleaseSchedule, getReleaseTagPrefix, getReleaseTrigger, getReleaseWorkflowName, getReleaseWorkflowSetupSteps, getVersionrcOptions, getWorkflowContainerImage, getWorkflowRunsOn

- Method Detail
  - getDefaultReleaseBranch
```
@Stability(value=Experimental)
 @NotNull
String getDefaultReleaseBranch()
```
    (experimental) The name of the main release branch.
    Default: "main"
  - getAutoApproveProjenUpgrades
```
@Stability(value=Experimental)
 @Nullable
default Boolean getAutoApproveProjenUpgrades()
```
    (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
  - getAutoApproveUpgrades
```
@Stability(value=Experimental)
 @Nullable
default Boolean getAutoApproveUpgrades()
```
    (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
  - getBuildWorkflow
```
@Stability(value=Experimental)
 @Nullable
default Boolean getBuildWorkflow()
```
    (experimental) Define a GitHub workflow for building PRs.
    Default: - true if not a subproject
  - getBundlerOptions
```
@Stability(value=Experimental)
 @Nullable
default BundlerOptions getBundlerOptions()
```
    (experimental) Options for `Bundler`.
  - getCodeCov
```
@Stability(value=Experimental)
 @Nullable
default Boolean getCodeCov()
```
    (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
  - getCodeCovTokenSecret
```
@Stability(value=Experimental)
 @Nullable
default String getCodeCovTokenSecret()
```
    (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
  - getCopyrightOwner
```
@Stability(value=Experimental)
 @Nullable
default String getCopyrightOwner()
```
    (experimental) License copyright owner.
    Default: - defaults to the value of authorName or "" if `authorName` is undefined.
  - getCopyrightPeriod
```
@Stability(value=Experimental)
 @Nullable
default String getCopyrightPeriod()
```
    (experimental) The copyright years to put in the LICENSE file.
    Default: - current year
  - getDependabot
```
@Stability(value=Experimental)
 @Nullable
default Boolean getDependabot()
```
    (experimental) Use dependabot to handle dependency upgrades.
    Cannot be used in conjunction with depsUpgrade.
    Default: false
  - getDependabotOptions
```
@Stability(value=Experimental)
 @Nullable
default DependabotOptions getDependabotOptions()
```
    (experimental) Options for dependabot.
    Default: - default options
  - getDepsUpgrade
```
@Stability(value=Experimental)
 @Nullable
default Boolean getDepsUpgrade()
```
    (experimental) Use github workflows to handle dependency upgrades.
    Cannot be used in conjunction with dependabot.
    Default: true
  - getDepsUpgradeOptions
```
@Stability(value=Experimental)
 @Nullable
default UpgradeDependenciesOptions getDepsUpgradeOptions()
```
    (experimental) Options for depsUpgrade.
    Default: - default options
  - getGitignore
```
@Stability(value=Experimental)
 @Nullable
default List<String> getGitignore()
```
    (experimental) Additional entries to .gitignore.
  - getJest
```
@Stability(value=Experimental)
 @Nullable
default Boolean getJest()
```
    (experimental) Setup jest unit tests.
    Default: true
  - getJestOptions
```
@Stability(value=Experimental)
 @Nullable
default JestOptions getJestOptions()
```
    (experimental) Jest options.
    Default: - default options
  - getMutableBuild
```
@Stability(value=Experimental)
 @Nullable
default Boolean getMutableBuild()
```
    (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
  - getNpmignore
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default List<String> getNpmignore()
```
    Deprecated. - use `project.addPackageIgnore`
    
    (deprecated) Additional entries to .npmignore.
  - getNpmignoreEnabled
```
@Stability(value=Experimental)
 @Nullable
default Boolean getNpmignoreEnabled()
```
    (experimental) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
    Default: true
  - getProjenDevDependency
```
@Stability(value=Experimental)
 @Nullable
default Boolean getProjenDevDependency()
```
    (experimental) Indicates of "projen" should be installed as a devDependency.
    Default: true
  - getProjenrcJs
```
@Stability(value=Experimental)
 @Nullable
default Boolean getProjenrcJs()
```
    (experimental) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
    Default: - true if projenrcJson is false
  - getProjenrcJsOptions
```
@Stability(value=Experimental)
 @Nullable
default ProjenrcOptions getProjenrcJsOptions()
```
    (experimental) Options for .projenrc.js.
    Default: - default options
  - getProjenUpgradeAutoMerge
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Boolean getProjenUpgradeAutoMerge()
```
    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
  - getProjenUpgradeSchedule
```
@Stability(value=Experimental)
 @Nullable
default List<String> getProjenUpgradeSchedule()
```
    (experimental) Customize the projenUpgrade schedule in cron expression.
    Default: [ "0 6 * * *" ]
  - getProjenUpgradeSecret
```
@Stability(value=Experimental)
 @Nullable
default String getProjenUpgradeSecret()
```
    (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
  - getProjenVersion
```
@Stability(value=Experimental)
 @Nullable
default String getProjenVersion()
```
    (experimental) Version of projen to install.
    Default: - Defaults to the latest version.
  - getPullRequestTemplate
```
@Stability(value=Experimental)
 @Nullable
default Boolean getPullRequestTemplate()
```
    (experimental) Include a GitHub pull request template.
    Default: true
  - getPullRequestTemplateContents
```
@Stability(value=Experimental)
 @Nullable
default List<String> getPullRequestTemplateContents()
```
    (experimental) The contents of the pull request template.
    Default: - default content
  - getRelease
```
@Stability(value=Experimental)
 @Nullable
default Boolean getRelease()
```
    (experimental) Add release management to this project.
    Default: - true (false for subprojects)
  - getReleaseToNpm
```
@Stability(value=Experimental)
 @Nullable
default Boolean getReleaseToNpm()
```
    (experimental) Automatically release to npm when new versions are introduced.
    Default: false
  - getReleaseWorkflow
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Boolean getReleaseWorkflow()
```
    Deprecated. see `release`.
    
    (deprecated) DEPRECATED: renamed to `release`.
    Default: - true if not a subproject
  - getWorkflowBootstrapSteps
```
@Stability(value=Experimental)
 @Nullable
default List<Object> getWorkflowBootstrapSteps()
```
    (experimental) Workflow steps to use in order to bootstrap this repo.
    Default: "yarn install --frozen-lockfile && yarn projen"
  - getWorkflowGitIdentity
```
@Stability(value=Experimental)
 @Nullable
default GitIdentity getWorkflowGitIdentity()
```
    (experimental) The git identity to use in workflows.
    Default: - GitHub Actions
  - getWorkflowNodeVersion
```
@Stability(value=Experimental)
 @Nullable
default String getWorkflowNodeVersion()
```
    (experimental) The node version to use in GitHub workflows.
    Default: - same as `minNodeVersion`
  - builder
```
@Stability(value=Experimental)
static NodeProjectOptions.Builder builder()
```
    Specified by:
    
    builder in interface GitHubProjectOptions
    
    Specified by:
    
    builder in interface NodePackageOptions
    
    Specified by:
    
    builder in interface ProjectOptions
    
    Specified by:
    
    builder in interface ReleaseProjectOptions
    
    Returns:
    
    a NodeProjectOptions.Builder of NodeProjectOptions

Interface NodeProjectOptions

Nested Class Summary

Method Summary

Methods inherited from interface io.github.cdklabs.projen.github.GitHubProjectOptions

Methods inherited from interface io.github.cdklabs.projen.ProjectOptions

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Methods inherited from interface io.github.cdklabs.projen.javascript.NodePackageOptions

Methods inherited from interface io.github.cdklabs.projen.release.ReleaseProjectOptions

Method Detail

getDefaultReleaseBranch

getAutoApproveProjenUpgrades

getAutoApproveUpgrades

getBuildWorkflow

getBundlerOptions

getCodeCov

getCodeCovTokenSecret

getCopyrightOwner

getCopyrightPeriod

getDependabot

getDependabotOptions

getDepsUpgrade

getDepsUpgradeOptions

getGitignore

getJest

getJestOptions

getMutableBuild

getNpmignore

getNpmignoreEnabled

getProjenDevDependency

getProjenrcJs

getProjenrcJsOptions

getProjenUpgradeAutoMerge

getProjenUpgradeSchedule

getProjenUpgradeSecret

getProjenVersion

getPullRequestTemplate

getPullRequestTemplateContents

getRelease

getReleaseToNpm

getReleaseWorkflow

getWorkflowBootstrapSteps

getWorkflowGitIdentity

getWorkflowNodeVersion

builder