java.lang.Object
- software.amazon.jsii.JsiiObject
- - io.github.cdklabs.projen.cdk.JsiiProjectOptions.Jsii$Proxy

All Implemented Interfaces:

JsiiProjectOptions, GitHubProjectOptions, NodePackageOptions, NodeProjectOptions, ProjectOptions, ReleaseProjectOptions, TypeScriptProjectOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

JsiiProjectOptions
```
@Stability(Experimental)
@Internal
public static final class JsiiProjectOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements JsiiProjectOptions
```
An implementation for JsiiProjectOptions

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface io.github.cdklabs.projen.cdk.JsiiProjectOptions
  JsiiProjectOptions.Builder, JsiiProjectOptions.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`Jsii$Proxy(JsiiProjectOptions.Builder builder)`	Constructor that initializes the object based on literal property values passed by the `JsiiProjectOptions.Builder`.
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)`	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`Boolean`	`getAllowLibraryDependencies()`	(experimental) Allow the project to include `peerDependencies` and `bundledDependencies`.
`String`	`getArtifactsDirectory()`	(experimental) A directory which will contain build artifacts.
`String`	`getAuthor()`	(experimental) The name of the library author.
`String`	`getAuthorAddress()`	(experimental) Email or URL of the library author.
`String`	`getAuthorEmail()`	(experimental) Author's e-mail.
`String`	`getAuthorName()`	(experimental) Author's name.
`Boolean`	`getAuthorOrganization()`	(experimental) Is the author an organization.
`String`	`getAuthorUrl()`	(experimental) Author's URL / Website.
`AutoApproveOptions`	`getAutoApproveOptions()`	(experimental) Enable and configure the 'auto approve' workflow.
`Boolean`	`getAutoApproveUpgrades()`	(experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
`Boolean`	`getAutoDetectBin()`	(experimental) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
`Boolean`	`getAutoMerge()`	(experimental) Enable automatic merging on GitHub.
`AutoMergeOptions`	`getAutoMergeOptions()`	(experimental) Configure options for automatic merging on GitHub.
`Map<String,String>`	`getBin()`	(experimental) Binary programs vended with your module.
`String`	`getBugsEmail()`	(experimental) The email address to which issues should be reported.
`String`	`getBugsUrl()`	(experimental) The url to your project's issue tracker.
`Boolean`	`getBuildWorkflow()`	(experimental) Define a GitHub workflow for building PRs.
`Triggers`	`getBuildWorkflowTriggers()`	(experimental) Build workflow triggers.
`List<String>`	`getBundledDeps()`	(experimental) List of dependencies to bundle into this module.
`BundlerOptions`	`getBundlerOptions()`	(experimental) Options for `Bundler`.
`LicenseCheckerOptions`	`getCheckLicenses()`	(experimental) Configure which licenses should be deemed acceptable for use by dependencies.
`Boolean`	`getClobber()`	(experimental) Add a `clobber` task which resets the repo to origin.
`CodeArtifactOptions`	`getCodeArtifactOptions()`	(experimental) Options for npm packages using AWS CodeArtifact.
`Boolean`	`getCodeCov()`	(experimental) 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.
`String`	`getCodeCovTokenSecret()`	(experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
`Boolean`	`getCommitGenerated()`	(experimental) Whether to commit the managed files by default.
`Boolean`	`getCompat()`	(experimental) Automatically run API compatibility test against the latest version published to npm after compilation.
`String`	`getCompatIgnore()`	(experimental) Name of the ignore file for API compatibility tests.
`Boolean`	`getCompressAssembly()`	(experimental) Emit a compressed version of the assembly.
`String`	`getCopyrightOwner()`	(experimental) License copyright owner.
`String`	`getCopyrightPeriod()`	(experimental) The copyright years to put in the LICENSE file.
`String`	`getDefaultReleaseBranch()`	(experimental) The name of the main release branch.
`Boolean`	`getDependabot()`	(experimental) Use dependabot to handle dependency upgrades.
`DependabotOptions`	`getDependabotOptions()`	(experimental) Options for dependabot.
`List<String>`	`getDeps()`	(experimental) Runtime dependencies of this module.
`Boolean`	`getDepsUpgrade()`	(experimental) Use tasks and github workflows to handle dependency upgrades.
`UpgradeDependenciesOptions`	`getDepsUpgradeOptions()`	(experimental) Options for `UpgradeDependencies`.
`String`	`getDescription()`	(experimental) The description is just a string that helps people understand the purpose of the package.
`Boolean`	`getDevContainer()`	(experimental) Add a VSCode development environment (used for GitHub Codespaces).
`List<String>`	`getDevDeps()`	(experimental) Build dependencies for this module.
`Boolean`	`getDisableTsconfig()`	(experimental) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
`Boolean`	`getDisableTsconfigDev()`	(experimental) Do not generate a `tsconfig.dev.json` file.
`Boolean`	`getDocgen()`	(experimental) Docgen by Typedoc.
`String`	`getDocgenFilePath()`	(experimental) File path for generated docs.
`String`	`getDocsDirectory()`	(experimental) Docs directory.
`JsiiDotNetTarget`	`getDotnet()`
`String`	`getEntrypoint()`	(experimental) Module entrypoint (`main` in `package.json`).
`String`	`getEntrypointTypes()`	(experimental) The .d.ts file that includes the type declarations for this module.
`Boolean`	`getEslint()`	(experimental) Setup eslint.
`EslintOptions`	`getEslintOptions()`	(experimental) Eslint options.
`List<String>`	`getExcludeTypescript()`	(experimental) Accepts a list of glob patterns.
`Boolean`	`getGithub()`	(experimental) Enable GitHub integration.
`GitHubOptions`	`getGithubOptions()`	(experimental) Options for GitHub integration.
`List<String>`	`getGitignore()`	(experimental) Additional entries to .gitignore.
`IgnoreFileOptions`	`getGitIgnoreOptions()`	(experimental) Configuration options for .gitignore file.
`GitOptions`	`getGitOptions()`	(experimental) Configuration options for git.
`Boolean`	`getGitpod()`	(experimental) Add a Gitpod development environment.
`String`	`getHomepage()`	(experimental) Package's Homepage / Website.
`Boolean`	`getJest()`	(experimental) Setup jest unit tests.
`JestOptions`	`getJestOptions()`	(experimental) Jest options.
`String`	`getJsiiReleaseVersion()`	(experimental) Version requirement of `publib` which is used to publish modules to npm.
`String`	`getJsiiVersion()`	(experimental) Version of the jsii compiler to use.
`List<String>`	`getKeywords()`	(experimental) Keywords to include in `package.json`.
`String`	`getLibdir()`	(experimental) Typescript artifacts output directory.
`String`	`getLicense()`	(experimental) License's SPDX identifier.
`Boolean`	`getLicensed()`	(experimental) Indicates if a license should be added.
`LoggerOptions`	`getLogging()`	(experimental) Configure logging options such as verbosity.
`Number`	`getMajorVersion()`	(experimental) Major version to release from the default branch.
`String`	`getMaxNodeVersion()`	(experimental) Minimum node.js version to require via `engines` (inclusive).
`Boolean`	`getMergify()`	(deprecated) Whether mergify should be enabled on this repository or not.
`MergifyOptions`	`getMergifyOptions()`	(deprecated) Options for mergify.
`Number`	`getMinMajorVersion()`	(experimental) Minimal Major version to release.
`String`	`getMinNodeVersion()`	(experimental) Minimum Node.js version to require via package.json `engines` (inclusive).
`Boolean`	`getMutableBuild()`	(experimental) Automatically update files modified during builds to pull-request branches.
`String`	`getName()`	(experimental) This is the name of your project.
`NpmAccess`	`getNpmAccess()`	(experimental) Access level of the npm package.
`String`	`getNpmDistTag()`	(experimental) The npmDistTag to use when publishing from the default branch.
`List<String>`	`getNpmignore()`	(deprecated) Additional entries to .npmignore.
`Boolean`	`getNpmignoreEnabled()`	(experimental) Defines an .npmignore file.
`IgnoreFileOptions`	`getNpmIgnoreOptions()`	(experimental) Configuration options for .npmignore file.
`Boolean`	`getNpmProvenance()`	(experimental) Should provenance statements be generated when the package is published.
`String`	`getNpmRegistry()`	(deprecated) The host name of the npm registry to publish to.
`String`	`getNpmRegistryUrl()`	(experimental) The base URL of the npm package registry.
`String`	`getNpmTokenSecret()`	(experimental) GitHub secret which contains the NPM token to use when publishing packages.
`String`	`getOutdir()`	(experimental) The root directory of the project.
`NodePackageManager`	`getPackageManager()`	(experimental) The Node Package Manager used to execute scripts.
`String`	`getPackageName()`	(experimental) The "name" in package.json.
`Boolean`	`getPackageValue()`	(experimental) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g.
`Project`	`getParent()`	(experimental) The parent project, if this project is part of a bigger project.
`PeerDependencyOptions`	`getPeerDependencyOptions()`	(experimental) Options for `peerDeps`.
`List<String>`	`getPeerDeps()`	(experimental) Peer dependencies for this module.
`String`	`getPnpmVersion()`	(experimental) The version of PNPM to use if using PNPM as a package manager.
`List<JobStep>`	`getPostBuildSteps()`	(experimental) Steps to execute after build as part of the release workflow.
`String`	`getPrerelease()`	(experimental) Bump versions from the default branch as pre-releases (e.g.
`Boolean`	`getPrettier()`	(experimental) Setup prettier.
`PrettierOptions`	`getPrettierOptions()`	(experimental) Prettier options.
`ProjectType`	`getProjectType()`	(deprecated) Which type of project this is (library/app).
`String`	`getProjenCommand()`	(experimental) The shell command to use in order to run the projen CLI.
`GithubCredentials`	`getProjenCredentials()`	(experimental) Choose a method of providing GitHub API access for projen workflows.
`Boolean`	`getProjenDevDependency()`	(experimental) Indicates of "projen" should be installed as a devDependency.
`Boolean`	`getProjenrcJs()`	(experimental) Generate (once) .projenrc.js (in JavaScript).
`Boolean`	`getProjenrcJson()`	(experimental) Generate (once) .projenrc.json (in JSON).
`ProjenrcJsonOptions`	`getProjenrcJsonOptions()`	(experimental) Options for .projenrc.json.
`ProjenrcOptions`	`getProjenrcJsOptions()`	(experimental) Options for .projenrc.js.
`Boolean`	`getProjenrcTs()`	(experimental) Use TypeScript for your projenrc file (`.projenrc.ts`).
`ProjenrcOptions`	`getProjenrcTsOptions()`	(experimental) Options for .projenrc.ts.
`String`	`getProjenTokenSecret()`	(deprecated) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
`String`	`getProjenVersion()`	(experimental) Version of projen to install.
`Boolean`	`getPublishDryRun()`	(experimental) Instead of actually publishing to package managers, just print the publishing command.
`Boolean`	`getPublishTasks()`	(experimental) Define publishing tasks that can be executed manually as well as workflows.
`JsiiGoTarget`	`getPublishToGo()`	(experimental) Publish Go bindings to a git repository.
`JsiiJavaTarget`	`getPublishToMaven()`	(experimental) Publish to maven.
`JsiiDotNetTarget`	`getPublishToNuget()`	(experimental) Publish to NuGet.
`JsiiPythonTarget`	`getPublishToPypi()`	(experimental) Publish to pypi.
`Boolean`	`getPullRequestTemplate()`	(experimental) Include a GitHub pull request template.
`List<String>`	`getPullRequestTemplateContents()`	(experimental) The contents of the pull request template.
`JsiiPythonTarget`	`getPython()`
`SampleReadmeProps`	`getReadme()`	(experimental) The README setup.
`ReleasableCommits`	`getReleasableCommits()`	(experimental) Find commits that should be considered releasable Used to decide if a release is required.
`Boolean`	`getRelease()`	(experimental) Add release management to this project.
`Map<String,BranchOptions>`	`getReleaseBranches()`	(experimental) Defines additional release branches.
`Boolean`	`getReleaseEveryCommit()`	(deprecated) Automatically release new versions every commit to one of branches in `releaseBranches`.
`Boolean`	`getReleaseFailureIssue()`	(experimental) Create a github issue on every failed publishing task.
`String`	`getReleaseFailureIssueLabel()`	(experimental) The label to apply to issues indicating publish failures.
`String`	`getReleaseSchedule()`	(deprecated) CRON schedule to trigger new releases.
`String`	`getReleaseTagPrefix()`	(experimental) Automatically add the given prefix to release tags.
`Boolean`	`getReleaseToNpm()`	(experimental) Automatically release to npm when new versions are introduced.
`ReleaseTrigger`	`getReleaseTrigger()`	(experimental) The release trigger to use.
`Boolean`	`getReleaseWorkflow()`	(deprecated) DEPRECATED: renamed to `release`.
`String`	`getReleaseWorkflowName()`	(experimental) The name of the default release workflow.
`List<JobStep>`	`getReleaseWorkflowSetupSteps()`	(experimental) A set of workflow steps to execute in order to setup the workflow container.
`Boolean`	`getRenovatebot()`	(experimental) Use renovatebot to handle dependency upgrades.
`RenovatebotOptions`	`getRenovatebotOptions()`	(experimental) Options for renovatebot.
`String`	`getRepository()`	(experimental) The repository is the location where the actual code for your package lives.
`String`	`getRepositoryDirectory()`	(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.
`String`	`getRepositoryUrl()`	(experimental) Git repository URL.
`String`	`getRootdir()`	Default: "."
`Boolean`	`getSampleCode()`	(experimental) Generate one-time sample in `src/` and `test/` if there are no files there.
`List<ScopedPackagesOptions>`	`getScopedPackagesOptions()`	(experimental) Options for privately hosted scoped packages.
`Map<String,String>`	`getScripts()`	(deprecated) npm scripts to include.
`String`	`getSrcdir()`	(experimental) Typescript sources directory.
`String`	`getStability()`	(experimental) Package's Stability.
`Boolean`	`getStale()`	(experimental) Auto-close of stale issues and pull request.
`StaleOptions`	`getStaleOptions()`	(experimental) Auto-close stale issues and pull requests.
`String`	`getTestdir()`	(experimental) Jest tests directory.
`TypescriptConfigOptions`	`getTsconfig()`	(experimental) Custom TSConfig.
`TypescriptConfigOptions`	`getTsconfigDev()`	(experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).
`String`	`getTsconfigDevFile()`	(experimental) The name of the development tsconfig.json file.
`TsJestOptions`	`getTsJestOptions()`	(experimental) Options for ts-jest.
`String`	`getTypescriptVersion()`	(experimental) TypeScript version to use.
`Map<String,Object>`	`getVersionrcOptions()`	(experimental) Custom configuration used when creating changelog with standard-version package.
`Boolean`	`getVscode()`	(experimental) Enable VSCode integration.
`List<JobStep>`	`getWorkflowBootstrapSteps()`	(experimental) Workflow steps to use in order to bootstrap this repo.
`String`	`getWorkflowContainerImage()`	(experimental) Container image to use for GitHub workflows.
`GitIdentity`	`getWorkflowGitIdentity()`	(experimental) The git identity to use in workflows.
`String`	`getWorkflowNodeVersion()`	(experimental) The node version to use in GitHub workflows.
`Boolean`	`getWorkflowPackageCache()`	(experimental) Enable Node.js package cache in GitHub workflows.
`List<String>`	`getWorkflowRunsOn()`	(experimental) Github Runner selection labels.
`GroupRunnerOptions`	`getWorkflowRunsOnGroup()`	(experimental) Github Runner Group selection options.
`YarnBerryOptions`	`getYarnBerryOptions()`	(experimental) Options for Yarn Berry.
`int`	`hashCode()`

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
    Constructor that initializes the object based on values retrieved from the JsiiObject.
    
    Parameters:
    
    objRef - Reference to the JSII managed object.
  - Jsii$Proxy
```
protected Jsii$Proxy(JsiiProjectOptions.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the JsiiProjectOptions.Builder.
- Method Detail
  - getAuthor
```
public final String getAuthor()
```
    Description copied from interface: JsiiProjectOptions
    
    (experimental) The name of the library author.
    Default: $GIT_USER_NAME
    
    Specified by:
    
    getAuthor in interface JsiiProjectOptions
  - getAuthorAddress
```
public final String getAuthorAddress()
```
    Description copied from interface: JsiiProjectOptions
    
    (experimental) Email or URL of the library author.
    Default: $GIT_USER_EMAIL
    
    Specified by:
    
    getAuthorAddress in interface JsiiProjectOptions
  - getRepositoryUrl
```
public final String getRepositoryUrl()
```
    Description copied from interface: JsiiProjectOptions
    
    (experimental) Git repository URL.
    Default: $GIT_REMOTE
    
    Specified by:
    
    getRepositoryUrl in interface JsiiProjectOptions
  - getCompat
```
public final Boolean getCompat()
```
    Description copied from interface: JsiiProjectOptions
    (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
    Specified by:
    
    getCompat in interface JsiiProjectOptions
  - getCompatIgnore
```
public final String getCompatIgnore()
```
    Description copied from interface: JsiiProjectOptions
    
    (experimental) Name of the ignore file for API compatibility tests.
    Default: ".compatignore"
    
    Specified by:
    
    getCompatIgnore in interface JsiiProjectOptions
  - getCompressAssembly
```
public final Boolean getCompressAssembly()
```
    Description copied from interface: JsiiProjectOptions
    
    (experimental) Emit a compressed version of the assembly.
    Default: false
    
    Specified by:
    
    getCompressAssembly in interface JsiiProjectOptions
  - getDocgenFilePath
```
public final String getDocgenFilePath()
```
    Description copied from interface: JsiiProjectOptions
    
    (experimental) File path for generated docs.
    Default: "API.md"
    
    Specified by:
    
    getDocgenFilePath in interface JsiiProjectOptions
  - getDotnet
```
public final JsiiDotNetTarget getDotnet()
```
    Specified by:
    
    getDotnet in interface JsiiProjectOptions
  - getExcludeTypescript
```
public final List<String> getExcludeTypescript()
```
    Description copied from interface: JsiiProjectOptions
    
    (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.
    
    Specified by:
    
    getExcludeTypescript in interface JsiiProjectOptions
  - getJsiiVersion
```
public final String getJsiiVersion()
```
    Description copied from interface: JsiiProjectOptions
    
    (experimental) Version of the jsii compiler to use.
    Set to "*" if you want to manually manage the version of jsii in your project by managing updates to package.json on your own.
    NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~5.0.0).
    Default: "1.x"
    
    Specified by:
    
    getJsiiVersion in interface JsiiProjectOptions
  - getPublishToGo
```
public final JsiiGoTarget getPublishToGo()
```
    Description copied from interface: JsiiProjectOptions
    
    (experimental) Publish Go bindings to a git repository.
    Default: - no publishing
    
    Specified by:
    
    getPublishToGo in interface JsiiProjectOptions
  - getPublishToMaven
```
public final JsiiJavaTarget getPublishToMaven()
```
    Description copied from interface: JsiiProjectOptions
    
    (experimental) Publish to maven.
    Default: - no publishing
    
    Specified by:
    
    getPublishToMaven in interface JsiiProjectOptions
  - getPublishToNuget
```
public final JsiiDotNetTarget getPublishToNuget()
```
    Description copied from interface: JsiiProjectOptions
    
    (experimental) Publish to NuGet.
    Default: - no publishing
    
    Specified by:
    
    getPublishToNuget in interface JsiiProjectOptions
  - getPublishToPypi
```
public final JsiiPythonTarget getPublishToPypi()
```
    Description copied from interface: JsiiProjectOptions
    
    (experimental) Publish to pypi.
    Default: - no publishing
    
    Specified by:
    
    getPublishToPypi in interface JsiiProjectOptions
  - getPython
```
public final JsiiPythonTarget getPython()
```
    Specified by:
    
    getPython in interface JsiiProjectOptions
  - getRootdir
```
public final String getRootdir()
```
    Description copied from interface: JsiiProjectOptions
    
    Default: "."
    
    Specified by:
    
    getRootdir in interface JsiiProjectOptions
  - getDisableTsconfig
```
public final Boolean getDisableTsconfig()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
    Default: false
    
    Specified by:
    
    getDisableTsconfig in interface TypeScriptProjectOptions
  - getDisableTsconfigDev
```
public final Boolean getDisableTsconfigDev()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Do not generate a tsconfig.dev.json file.
    Default: false
    
    Specified by:
    
    getDisableTsconfigDev in interface TypeScriptProjectOptions
  - getDocgen
```
public final Boolean getDocgen()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Docgen by Typedoc.
    Default: false
    
    Specified by:
    
    getDocgen in interface TypeScriptProjectOptions
  - getDocsDirectory
```
public final String getDocsDirectory()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Docs directory.
    Default: "docs"
    
    Specified by:
    
    getDocsDirectory in interface TypeScriptProjectOptions
  - getEntrypointTypes
```
public final String getEntrypointTypes()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (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)
    
    Specified by:
    
    getEntrypointTypes in interface TypeScriptProjectOptions
  - getEslint
```
public final Boolean getEslint()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Setup eslint.
    Default: true
    
    Specified by:
    
    getEslint in interface TypeScriptProjectOptions
  - getEslintOptions
```
public final EslintOptions getEslintOptions()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Eslint options.
    Default: - opinionated default options
    
    Specified by:
    
    getEslintOptions in interface TypeScriptProjectOptions
  - getLibdir
```
public final String getLibdir()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Typescript artifacts output directory.
    Default: "lib"
    
    Specified by:
    
    getLibdir in interface TypeScriptProjectOptions
  - getProjenrcTs
```
public final Boolean getProjenrcTs()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Use TypeScript for your projenrc file (.projenrc.ts).
    Default: false
    
    Specified by:
    
    getProjenrcTs in interface TypeScriptProjectOptions
  - getProjenrcTsOptions
```
public final ProjenrcOptions getProjenrcTsOptions()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Options for .projenrc.ts.
    
    Specified by:
    
    getProjenrcTsOptions in interface TypeScriptProjectOptions
  - getSampleCode
```
public final Boolean getSampleCode()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Generate one-time sample in src/ and test/ if there are no files there.
    Default: true
    
    Specified by:
    
    getSampleCode in interface TypeScriptProjectOptions
  - getSrcdir
```
public final String getSrcdir()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Typescript sources directory.
    Default: "src"
    
    Specified by:
    
    getSrcdir in interface TypeScriptProjectOptions
  - getTestdir
```
public final String getTestdir()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (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"
    
    Specified by:
    
    getTestdir in interface TypeScriptProjectOptions
  - getTsconfig
```
public final TypescriptConfigOptions getTsconfig()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Custom TSConfig.
    Default: - default options
    
    Specified by:
    
    getTsconfig in interface TypeScriptProjectOptions
  - getTsconfigDev
```
public final TypescriptConfigOptions getTsconfigDev()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).
    Default: - use the production tsconfig options
    
    Specified by:
    
    getTsconfigDev in interface TypeScriptProjectOptions
  - getTsconfigDevFile
```
public final String getTsconfigDevFile()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) The name of the development tsconfig.json file.
    Default: "tsconfig.dev.json"
    
    Specified by:
    
    getTsconfigDevFile in interface TypeScriptProjectOptions
  - getTsJestOptions
```
public final TsJestOptions getTsJestOptions()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (experimental) Options for ts-jest.
    
    Specified by:
    
    getTsJestOptions in interface TypeScriptProjectOptions
  - getTypescriptVersion
```
public final String getTypescriptVersion()
```
    Description copied from interface: TypeScriptProjectOptions
    
    (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"
    
    Specified by:
    
    getTypescriptVersion in interface TypeScriptProjectOptions
  - getDefaultReleaseBranch
```
public final String getDefaultReleaseBranch()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) The name of the main release branch.
    Default: "main"
    
    Specified by:
    
    getDefaultReleaseBranch in interface NodeProjectOptions
  - getArtifactsDirectory
```
public final String getArtifactsDirectory()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) A directory which will contain build artifacts.
    Default: "dist"
    
    Specified by:
    
    getArtifactsDirectory in interface NodeProjectOptions
  - getAutoApproveUpgrades
```
public final Boolean getAutoApproveUpgrades()
```
    Description copied from interface: NodeProjectOptions
    
    (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
    
    Specified by:
    
    getAutoApproveUpgrades in interface NodeProjectOptions
  - getBuildWorkflow
```
public final Boolean getBuildWorkflow()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Define a GitHub workflow for building PRs.
    Default: - true if not a subproject
    
    Specified by:
    
    getBuildWorkflow in interface NodeProjectOptions
  - getBuildWorkflowTriggers
```
public final Triggers getBuildWorkflowTriggers()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Build workflow triggers.
    Default: "{ pullRequest: {}, workflowDispatch: {} }"
    
    Specified by:
    
    getBuildWorkflowTriggers in interface NodeProjectOptions
  - getBundlerOptions
```
public final BundlerOptions getBundlerOptions()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Options for Bundler.
    
    Specified by:
    
    getBundlerOptions in interface NodeProjectOptions
  - getCheckLicenses
```
public final LicenseCheckerOptions getCheckLicenses()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) 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.
    Default: - no license checks are run during the build and all licenses will be accepted
    
    Specified by:
    
    getCheckLicenses in interface NodeProjectOptions
  - getCodeCov
```
public final Boolean getCodeCov()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) 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.
    Default: false
    
    Specified by:
    
    getCodeCov in interface NodeProjectOptions
  - getCodeCovTokenSecret
```
public final String getCodeCovTokenSecret()
```
    Description copied from interface: NodeProjectOptions
    
    (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
    
    Specified by:
    
    getCodeCovTokenSecret in interface NodeProjectOptions
  - getCopyrightOwner
```
public final String getCopyrightOwner()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) License copyright owner.
    Default: - defaults to the value of authorName or "" if `authorName` is undefined.
    
    Specified by:
    
    getCopyrightOwner in interface NodeProjectOptions
  - getCopyrightPeriod
```
public final String getCopyrightPeriod()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) The copyright years to put in the LICENSE file.
    Default: - current year
    
    Specified by:
    
    getCopyrightPeriod in interface NodeProjectOptions
  - getDependabot
```
public final Boolean getDependabot()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Use dependabot to handle dependency upgrades.
    Cannot be used in conjunction with depsUpgrade.
    Default: false
    
    Specified by:
    
    getDependabot in interface NodeProjectOptions
  - getDependabotOptions
```
public final DependabotOptions getDependabotOptions()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Options for dependabot.
    Default: - default options
    
    Specified by:
    
    getDependabotOptions in interface NodeProjectOptions
  - getDepsUpgrade
```
public final Boolean getDepsUpgrade()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Use tasks and github workflows to handle dependency upgrades.
    Cannot be used in conjunction with dependabot.
    Default: true
    
    Specified by:
    
    getDepsUpgrade in interface NodeProjectOptions
  - getDepsUpgradeOptions
```
public final UpgradeDependenciesOptions getDepsUpgradeOptions()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Options for UpgradeDependencies.
    Default: - default options
    
    Specified by:
    
    getDepsUpgradeOptions in interface NodeProjectOptions
  - getGitignore
```
public final List<String> getGitignore()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Additional entries to .gitignore.
    
    Specified by:
    
    getGitignore in interface NodeProjectOptions
  - getJest
```
public final Boolean getJest()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Setup jest unit tests.
    Default: true
    
    Specified by:
    
    getJest in interface NodeProjectOptions
  - getJestOptions
```
public final JestOptions getJestOptions()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Jest options.
    Default: - default options
    
    Specified by:
    
    getJestOptions in interface NodeProjectOptions
  - getMutableBuild
```
public final Boolean getMutableBuild()
```
    Description copied from interface: NodeProjectOptions
    
    (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
    
    Specified by:
    
    getMutableBuild in interface NodeProjectOptions
  - getNpmignore
```
public final List<String> getNpmignore()
```
    Description copied from interface: NodeProjectOptions
    
    (deprecated) Additional entries to .npmignore.
    
    Specified by:
    
    getNpmignore in interface NodeProjectOptions
  - getNpmignoreEnabled
```
public final Boolean getNpmignoreEnabled()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
    Default: true
    
    Specified by:
    
    getNpmignoreEnabled in interface NodeProjectOptions
  - getNpmIgnoreOptions
```
public final IgnoreFileOptions getNpmIgnoreOptions()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Configuration options for .npmignore file.
    
    Specified by:
    
    getNpmIgnoreOptions in interface NodeProjectOptions
  - getPackageValue
```
public final Boolean getPackageValue()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
    Default: true
    
    Specified by:
    
    getPackageValue in interface NodeProjectOptions
  - getPrettier
```
public final Boolean getPrettier()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Setup prettier.
    Default: false
    
    Specified by:
    
    getPrettier in interface NodeProjectOptions
  - getPrettierOptions
```
public final PrettierOptions getPrettierOptions()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Prettier options.
    Default: - default options
    
    Specified by:
    
    getPrettierOptions in interface NodeProjectOptions
  - getProjenDevDependency
```
public final Boolean getProjenDevDependency()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Indicates of "projen" should be installed as a devDependency.
    Default: true
    
    Specified by:
    
    getProjenDevDependency in interface NodeProjectOptions
  - getProjenrcJs
```
public final Boolean getProjenrcJs()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
    Default: - true if projenrcJson is false
    
    Specified by:
    
    getProjenrcJs in interface NodeProjectOptions
  - getProjenrcJsOptions
```
public final ProjenrcOptions getProjenrcJsOptions()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Options for .projenrc.js.
    Default: - default options
    
    Specified by:
    
    getProjenrcJsOptions in interface NodeProjectOptions
  - getProjenVersion
```
public final String getProjenVersion()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Version of projen to install.
    Default: - Defaults to the latest version.
    
    Specified by:
    
    getProjenVersion in interface NodeProjectOptions
  - getPullRequestTemplate
```
public final Boolean getPullRequestTemplate()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Include a GitHub pull request template.
    Default: true
    
    Specified by:
    
    getPullRequestTemplate in interface NodeProjectOptions
  - getPullRequestTemplateContents
```
public final List<String> getPullRequestTemplateContents()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) The contents of the pull request template.
    Default: - default content
    
    Specified by:
    
    getPullRequestTemplateContents in interface NodeProjectOptions
  - getRelease
```
public final Boolean getRelease()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Add release management to this project.
    Default: - true (false for subprojects)
    
    Specified by:
    
    getRelease in interface NodeProjectOptions
  - getReleaseToNpm
```
public final Boolean getReleaseToNpm()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Automatically release to npm when new versions are introduced.
    Default: false
    
    Specified by:
    
    getReleaseToNpm in interface NodeProjectOptions
  - getReleaseWorkflow
```
public final Boolean getReleaseWorkflow()
```
    Description copied from interface: NodeProjectOptions
    
    (deprecated) DEPRECATED: renamed to release.
    Default: - true if not a subproject
    
    Specified by:
    
    getReleaseWorkflow in interface NodeProjectOptions
  - getWorkflowBootstrapSteps
```
public final List<JobStep> getWorkflowBootstrapSteps()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Workflow steps to use in order to bootstrap this repo.
    Default: "yarn install --frozen-lockfile && yarn projen"
    
    Specified by:
    
    getWorkflowBootstrapSteps in interface NodeProjectOptions
  - getWorkflowGitIdentity
```
public final GitIdentity getWorkflowGitIdentity()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) The git identity to use in workflows.
    Default: - GitHub Actions
    
    Specified by:
    
    getWorkflowGitIdentity in interface NodeProjectOptions
  - getWorkflowNodeVersion
```
public final String getWorkflowNodeVersion()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) The node version to use in GitHub workflows.
    Default: - same as `minNodeVersion`
    
    Specified by:
    
    getWorkflowNodeVersion in interface NodeProjectOptions
  - getWorkflowPackageCache
```
public final Boolean getWorkflowPackageCache()
```
    Description copied from interface: NodeProjectOptions
    
    (experimental) Enable Node.js package cache in GitHub workflows.
    Default: false
    
    Specified by:
    
    getWorkflowPackageCache in interface NodeProjectOptions
  - getAutoApproveOptions
```
public final AutoApproveOptions getAutoApproveOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Enable and configure the 'auto approve' workflow.
    Default: - auto approve is disabled
    
    Specified by:
    
    getAutoApproveOptions in interface GitHubProjectOptions
  - getAutoMerge
```
public final Boolean getAutoMerge()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Enable automatic merging on GitHub.
    Has no effect if github.mergify is set to false.
    Default: true
    
    Specified by:
    
    getAutoMerge in interface GitHubProjectOptions
  - getAutoMergeOptions
```
public final AutoMergeOptions getAutoMergeOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Configure options for automatic merging on GitHub.
    Has no effect if github.mergify or autoMerge is set to false.
    Default: - see defaults in `AutoMergeOptions`
    
    Specified by:
    
    getAutoMergeOptions in interface GitHubProjectOptions
  - getClobber
```
public final Boolean getClobber()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Add a clobber task which resets the repo to origin.
    Default: - true, but false for subprojects
    
    Specified by:
    
    getClobber in interface GitHubProjectOptions
  - getDevContainer
```
public final Boolean getDevContainer()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Add a VSCode development environment (used for GitHub Codespaces).
    Default: false
    
    Specified by:
    
    getDevContainer in interface GitHubProjectOptions
  - getGithub
```
public final Boolean getGithub()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Enable GitHub integration.
    Enabled by default for root projects. Disabled for non-root projects.
    Default: true
    
    Specified by:
    
    getGithub in interface GitHubProjectOptions
  - getGithubOptions
```
public final GitHubOptions getGithubOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Options for GitHub integration.
    Default: - see GitHubOptions
    
    Specified by:
    
    getGithubOptions in interface GitHubProjectOptions
  - getGitpod
```
public final Boolean getGitpod()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Add a Gitpod development environment.
    Default: false
    
    Specified by:
    
    getGitpod in interface GitHubProjectOptions
  - getMergify
```
public final Boolean getMergify()
```
    Description copied from interface: GitHubProjectOptions
    
    (deprecated) Whether mergify should be enabled on this repository or not.
    Default: true
    
    Specified by:
    
    getMergify in interface GitHubProjectOptions
  - getMergifyOptions
```
public final MergifyOptions getMergifyOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (deprecated) Options for mergify.
    Default: - default options
    
    Specified by:
    
    getMergifyOptions in interface GitHubProjectOptions
  - getProjectType
```
public final ProjectType getProjectType()
```
    Description copied from interface: GitHubProjectOptions
    
    (deprecated) Which type of project this is (library/app).
    Default: ProjectType.UNKNOWN
    
    Specified by:
    
    getProjectType in interface GitHubProjectOptions
  - getProjenCredentials
```
public final GithubCredentials getProjenCredentials()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Choose a method of providing GitHub API access for projen workflows.
    Default: - use a personal access token named PROJEN_GITHUB_TOKEN
    
    Specified by:
    
    getProjenCredentials in interface GitHubProjectOptions
  - getProjenTokenSecret
```
public final String getProjenTokenSecret()
```
    Description copied from interface: GitHubProjectOptions
    
    (deprecated) 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.
    Default: "PROJEN_GITHUB_TOKEN"
    
    Specified by:
    
    getProjenTokenSecret in interface GitHubProjectOptions
  - getReadme
```
public final SampleReadmeProps getReadme()
```
    Description copied from interface: GitHubProjectOptions
    (experimental) The README setup.
    Default: - { filename: 'README.md', contents: '# replace this' }
    Example:
    
    "{ filename: 'readme.md', contents: '# title' }"
    Specified by:
    
    getReadme in interface GitHubProjectOptions
  - getStale
```
public final Boolean getStale()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Auto-close of stale issues and pull request.
    See staleOptions for options.
    Default: false
    
    Specified by:
    
    getStale in interface GitHubProjectOptions
  - getStaleOptions
```
public final StaleOptions getStaleOptions()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Auto-close stale issues and pull requests.
    To disable set stale to false.
    Default: - see defaults in `StaleOptions`
    
    Specified by:
    
    getStaleOptions in interface GitHubProjectOptions
  - getVscode
```
public final Boolean getVscode()
```
    Description copied from interface: GitHubProjectOptions
    
    (experimental) Enable VSCode integration.
    Enabled by default for root projects. Disabled for non-root projects.
    Default: true
    
    Specified by:
    
    getVscode in interface GitHubProjectOptions
  - getName
```
public final String getName()
```
    Description copied from interface: ProjectOptions
    
    (experimental) This is the name of your project.
    Default: $BASEDIR
    
    Specified by:
    
    getName in interface ProjectOptions
  - getCommitGenerated
```
public final Boolean getCommitGenerated()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Whether to commit the managed files by default.
    Default: true
    
    Specified by:
    
    getCommitGenerated in interface ProjectOptions
  - getGitIgnoreOptions
```
public final IgnoreFileOptions getGitIgnoreOptions()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Configuration options for .gitignore file.
    
    Specified by:
    
    getGitIgnoreOptions in interface ProjectOptions
  - getGitOptions
```
public final GitOptions getGitOptions()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Configuration options for git.
    
    Specified by:
    
    getGitOptions in interface ProjectOptions
  - getLogging
```
public final LoggerOptions getLogging()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Configure logging options such as verbosity.
    Default: {}
    
    Specified by:
    
    getLogging in interface ProjectOptions
  - getOutdir
```
public final String getOutdir()
```
    Description copied from interface: ProjectOptions
    
    (experimental) The root directory of the project.
    Relative to this directory, all files are synthesized.
    If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other subprojects.
    Default: "."
    
    Specified by:
    
    getOutdir in interface ProjectOptions
  - getParent
```
public final Project getParent()
```
    Description copied from interface: ProjectOptions
    
    (experimental) The parent project, if this project is part of a bigger project.
    
    Specified by:
    
    getParent in interface ProjectOptions
  - getProjenCommand
```
public final String getProjenCommand()
```
    Description copied from interface: ProjectOptions
    
    (experimental) The shell command to use in order to run the projen CLI.
    Can be used to customize in special environments.
    Default: "npx projen"
    
    Specified by:
    
    getProjenCommand in interface ProjectOptions
  - getProjenrcJson
```
public final Boolean getProjenrcJson()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
    Default: false
    
    Specified by:
    
    getProjenrcJson in interface ProjectOptions
  - getProjenrcJsonOptions
```
public final ProjenrcJsonOptions getProjenrcJsonOptions()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Options for .projenrc.json.
    Default: - default options
    
    Specified by:
    
    getProjenrcJsonOptions in interface ProjectOptions
  - getRenovatebot
```
public final Boolean getRenovatebot()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Use renovatebot to handle dependency upgrades.
    Default: false
    
    Specified by:
    
    getRenovatebot in interface ProjectOptions
  - getRenovatebotOptions
```
public final RenovatebotOptions getRenovatebotOptions()
```
    Description copied from interface: ProjectOptions
    
    (experimental) Options for renovatebot.
    Default: - default options
    
    Specified by:
    
    getRenovatebotOptions in interface ProjectOptions
  - getAllowLibraryDependencies
```
public final Boolean getAllowLibraryDependencies()
```
    Description copied from interface: NodePackageOptions
    
    (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
    
    Specified by:
    
    getAllowLibraryDependencies in interface NodePackageOptions
  - getAuthorEmail
```
public final String getAuthorEmail()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Author's e-mail.
    
    Specified by:
    
    getAuthorEmail in interface NodePackageOptions
  - getAuthorName
```
public final String getAuthorName()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Author's name.
    
    Specified by:
    
    getAuthorName in interface NodePackageOptions
  - getAuthorOrganization
```
public final Boolean getAuthorOrganization()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Is the author an organization.
    
    Specified by:
    
    getAuthorOrganization in interface NodePackageOptions
  - getAuthorUrl
```
public final String getAuthorUrl()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Author's URL / Website.
    
    Specified by:
    
    getAuthorUrl in interface NodePackageOptions
  - getAutoDetectBin
```
public final Boolean getAutoDetectBin()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Automatically add all executables under the bin directory to your package.json file under the bin section.
    Default: true
    
    Specified by:
    
    getAutoDetectBin in interface NodePackageOptions
  - getBin
```
public final Map<String,String> getBin()
```
    Description copied from interface: NodePackageOptions
    
    (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.
    
    Specified by:
    
    getBin in interface NodePackageOptions
  - getBugsEmail
```
public final String getBugsEmail()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) The email address to which issues should be reported.
    
    Specified by:
    
    getBugsEmail in interface NodePackageOptions
  - getBugsUrl
```
public final String getBugsUrl()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) The url to your project's issue tracker.
    
    Specified by:
    
    getBugsUrl in interface NodePackageOptions
  - getBundledDeps
```
public final List<String> getBundledDeps()
```
    Description copied from interface: NodePackageOptions
    
    (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.
    
    Specified by:
    
    getBundledDeps in interface NodePackageOptions
  - getCodeArtifactOptions
```
public final CodeArtifactOptions getCodeArtifactOptions()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Options for npm packages using AWS CodeArtifact.
    This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
    Default: - undefined
    
    Specified by:
    
    getCodeArtifactOptions in interface NodePackageOptions
  - getDeps
```
public final List<String> getDeps()
```
    Description copied from interface: NodePackageOptions
    (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:
    
    [ 'express', 'lodash', 'foo@^2' ]
    Specified by:
    
    getDeps in interface NodePackageOptions
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: NodePackageOptions
    
    (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
    
    Specified by:
    
    getDescription in interface NodePackageOptions
  - getDevDeps
```
public final List<String> getDevDeps()
```
    Description copied from interface: NodePackageOptions
    (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:
    
    [ 'typescript', '@types/express' ]
    Specified by:
    
    getDevDeps in interface NodePackageOptions
  - getEntrypoint
```
public final String getEntrypoint()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Module entrypoint (main in package.json).
    Set to an empty string to not include main in your package.json
    Default: "lib/index.js"
    
    Specified by:
    
    getEntrypoint in interface NodePackageOptions
  - getHomepage
```
public final String getHomepage()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Package's Homepage / Website.
    
    Specified by:
    
    getHomepage in interface NodePackageOptions
  - getKeywords
```
public final List<String> getKeywords()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Keywords to include in package.json.
    
    Specified by:
    
    getKeywords in interface NodePackageOptions
  - getLicense
```
public final String getLicense()
```
    Description copied from interface: NodePackageOptions
    
    (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"
    
    Specified by:
    
    getLicense in interface NodePackageOptions
  - getLicensed
```
public final Boolean getLicensed()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Indicates if a license should be added.
    Default: true
    
    Specified by:
    
    getLicensed in interface NodePackageOptions
  - getMaxNodeVersion
```
public final String getMaxNodeVersion()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Minimum node.js version to require via engines (inclusive).
    Default: - no max
    
    Specified by:
    
    getMaxNodeVersion in interface NodePackageOptions
  - getMinNodeVersion
```
public final String getMinNodeVersion()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Minimum Node.js version to require via package.json engines (inclusive).
    Default: - no "engines" specified
    
    Specified by:
    
    getMinNodeVersion in interface NodePackageOptions
  - getNpmAccess
```
public final NpmAccess getNpmAccess()
```
    Description copied from interface: NodePackageOptions
    
    (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`.
    
    Specified by:
    
    getNpmAccess in interface NodePackageOptions
  - getNpmProvenance
```
public final Boolean getNpmProvenance()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) 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.
    Default: - true for public packages, false otherwise
    
    Specified by:
    
    getNpmProvenance in interface NodePackageOptions
    
    See Also:
    
    https://docs.npmjs.com/generating-provenance-statements
  - getNpmRegistry
```
public final String getNpmRegistry()
```
    Description copied from interface: NodePackageOptions
    
    (deprecated) The host name of the npm registry to publish to.
    Cannot be set together with npmRegistryUrl.
    
    Specified by:
    
    getNpmRegistry in interface NodePackageOptions
  - getNpmRegistryUrl
```
public final String getNpmRegistryUrl()
```
    Description copied from interface: NodePackageOptions
    
    (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"
    
    Specified by:
    
    getNpmRegistryUrl in interface NodePackageOptions
  - getNpmTokenSecret
```
public final String getNpmTokenSecret()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) GitHub secret which contains the NPM token to use when publishing packages.
    Default: "NPM_TOKEN"
    
    Specified by:
    
    getNpmTokenSecret in interface NodePackageOptions
  - getPackageManager
```
public final NodePackageManager getPackageManager()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) The Node Package Manager used to execute scripts.
    Default: NodePackageManager.YARN_CLASSIC
    
    Specified by:
    
    getPackageManager in interface NodePackageOptions
  - getPackageName
```
public final String getPackageName()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) The "name" in package.json.
    Default: - defaults to project name
    
    Specified by:
    
    getPackageName in interface NodePackageOptions
  - getPeerDependencyOptions
```
public final PeerDependencyOptions getPeerDependencyOptions()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Options for peerDeps.
    
    Specified by:
    
    getPeerDependencyOptions in interface NodePackageOptions
  - getPeerDeps
```
public final List<String> getPeerDeps()
```
    Description copied from interface: NodePackageOptions
    
    (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: []
    
    Specified by:
    
    getPeerDeps in interface NodePackageOptions
  - getPnpmVersion
```
public final String getPnpmVersion()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) The version of PNPM to use if using PNPM as a package manager.
    Default: "7"
    
    Specified by:
    
    getPnpmVersion in interface NodePackageOptions
  - getRepository
```
public final String getRepository()
```
    Description copied from interface: NodePackageOptions
    
    (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
    
    Specified by:
    
    getRepository in interface NodePackageOptions
  - getRepositoryDirectory
```
public final String getRepositoryDirectory()
```
    Description copied from interface: NodePackageOptions
    
    (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.
    
    Specified by:
    
    getRepositoryDirectory in interface NodePackageOptions
  - getScopedPackagesOptions
```
public final List<ScopedPackagesOptions> getScopedPackagesOptions()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Options for privately hosted scoped packages.
    Default: - fetch all scoped packages from the public npm registry
    
    Specified by:
    
    getScopedPackagesOptions in interface NodePackageOptions
  - getScripts
```
public final Map<String,String> getScripts()
```
    Description copied from interface: NodePackageOptions
    
    (deprecated) 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.
    Default: {}
    
    Specified by:
    
    getScripts in interface NodePackageOptions
  - getStability
```
public final String getStability()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Package's Stability.
    
    Specified by:
    
    getStability in interface NodePackageOptions
  - getYarnBerryOptions
```
public final YarnBerryOptions getYarnBerryOptions()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Options for Yarn Berry.
    Default: - Yarn Berry v4 with all default options
    
    Specified by:
    
    getYarnBerryOptions in interface NodePackageOptions
  - getJsiiReleaseVersion
```
public final String getJsiiReleaseVersion()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) Version requirement of publib which is used to publish modules to npm.
    Default: "latest"
    
    Specified by:
    
    getJsiiReleaseVersion in interface ReleaseProjectOptions
  - getMajorVersion
```
public final Number getMajorVersion()
```
    Description copied from interface: ReleaseProjectOptions
    
    (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.
    
    Specified by:
    
    getMajorVersion in interface ReleaseProjectOptions
  - getMinMajorVersion
```
public final Number getMinMajorVersion()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) 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.
    Default: - No minimum version is being enforced
    
    Specified by:
    
    getMinMajorVersion in interface ReleaseProjectOptions
  - getNpmDistTag
```
public final String getNpmDistTag()
```
    Description copied from interface: ReleaseProjectOptions
    
    (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"
    
    Specified by:
    
    getNpmDistTag in interface ReleaseProjectOptions
  - getPostBuildSteps
```
public final List<JobStep> getPostBuildSteps()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) Steps to execute after build as part of the release workflow.
    Default: []
    
    Specified by:
    
    getPostBuildSteps in interface ReleaseProjectOptions
  - getPrerelease
```
public final String getPrerelease()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
    Default: - normal semantic versions
    
    Specified by:
    
    getPrerelease in interface ReleaseProjectOptions
  - getPublishDryRun
```
public final Boolean getPublishDryRun()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) Instead of actually publishing to package managers, just print the publishing command.
    Default: false
    
    Specified by:
    
    getPublishDryRun in interface ReleaseProjectOptions
  - getPublishTasks
```
public final Boolean getPublishTasks()
```
    Description copied from interface: ReleaseProjectOptions
    
    (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
    
    Specified by:
    
    getPublishTasks in interface ReleaseProjectOptions
  - getReleasableCommits
```
public final ReleasableCommits getReleasableCommits()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) Find commits that should be considered releasable Used to decide if a release is required.
    Default: ReleasableCommits.everyCommit()
    
    Specified by:
    
    getReleasableCommits in interface ReleaseProjectOptions
  - getReleaseBranches
```
public final Map<String,BranchOptions> getReleaseBranches()
```
    Description copied from interface: ReleaseProjectOptions
    
    (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.
    
    Specified by:
    
    getReleaseBranches in interface ReleaseProjectOptions
  - getReleaseEveryCommit
```
public final Boolean getReleaseEveryCommit()
```
    Description copied from interface: ReleaseProjectOptions
    
    (deprecated) Automatically release new versions every commit to one of branches in releaseBranches.
    Default: true
    
    Specified by:
    
    getReleaseEveryCommit in interface ReleaseProjectOptions
  - getReleaseFailureIssue
```
public final Boolean getReleaseFailureIssue()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) Create a github issue on every failed publishing task.
    Default: false
    
    Specified by:
    
    getReleaseFailureIssue in interface ReleaseProjectOptions
  - getReleaseFailureIssueLabel
```
public final String getReleaseFailureIssueLabel()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) The label to apply to issues indicating publish failures.
    Only applies if releaseFailureIssue is true.
    Default: "failed-release"
    
    Specified by:
    
    getReleaseFailureIssueLabel in interface ReleaseProjectOptions
  - getReleaseSchedule
```
public final String getReleaseSchedule()
```
    Description copied from interface: ReleaseProjectOptions
    
    (deprecated) CRON schedule to trigger new releases.
    Default: - no scheduled releases
    
    Specified by:
    
    getReleaseSchedule in interface ReleaseProjectOptions
  - getReleaseTagPrefix
```
public final String getReleaseTagPrefix()
```
    Description copied from interface: ReleaseProjectOptions
    
    (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: "v"
    
    Specified by:
    
    getReleaseTagPrefix in interface ReleaseProjectOptions
  - getReleaseTrigger
```
public final ReleaseTrigger getReleaseTrigger()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) The release trigger to use.
    Default: - Continuous releases (`ReleaseTrigger.continuous()`)
    
    Specified by:
    
    getReleaseTrigger in interface ReleaseProjectOptions
  - getReleaseWorkflowName
```
public final String getReleaseWorkflowName()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) The name of the default release workflow.
    Default: "release"
    
    Specified by:
    
    getReleaseWorkflowName in interface ReleaseProjectOptions
  - getReleaseWorkflowSetupSteps
```
public final List<JobStep> getReleaseWorkflowSetupSteps()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) A set of workflow steps to execute in order to setup the workflow container.
    
    Specified by:
    
    getReleaseWorkflowSetupSteps in interface ReleaseProjectOptions
  - getVersionrcOptions
```
public final Map<String,Object> getVersionrcOptions()
```
    Description copied from interface: ReleaseProjectOptions
    
    (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
    
    Specified by:
    
    getVersionrcOptions in interface ReleaseProjectOptions
  - getWorkflowContainerImage
```
public final String getWorkflowContainerImage()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) Container image to use for GitHub workflows.
    Default: - default image
    
    Specified by:
    
    getWorkflowContainerImage in interface ReleaseProjectOptions
  - getWorkflowRunsOn
```
public final List<String> getWorkflowRunsOn()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) Github Runner selection labels.
    Default: ["ubuntu-latest"]
    
    Specified by:
    
    getWorkflowRunsOn in interface ReleaseProjectOptions
  - getWorkflowRunsOnGroup
```
public final GroupRunnerOptions getWorkflowRunsOnGroup()
```
    Description copied from interface: ReleaseProjectOptions
    
    (experimental) Github Runner Group selection options.
    
    Specified by:
    
    getWorkflowRunsOnGroup in interface ReleaseProjectOptions
  - $jsii$toJson
```
@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
    Specified by:
    
    $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class JsiiProjectOptions.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.cdk.JsiiProjectOptions

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getAuthor

getAuthorAddress

getRepositoryUrl

getCompat

getCompatIgnore

getCompressAssembly

getDocgenFilePath

getDotnet

getExcludeTypescript

getJsiiVersion

getPublishToGo

getPublishToMaven

getPublishToNuget

getPublishToPypi

getPython

getRootdir

getDisableTsconfig

getDisableTsconfigDev

getDocgen

getDocsDirectory

getEntrypointTypes

getEslint

getEslintOptions

getLibdir

getProjenrcTs

getProjenrcTsOptions

getSampleCode

getSrcdir

getTestdir

getTsconfig

getTsconfigDev

getTsconfigDevFile

getTsJestOptions

getTypescriptVersion

getDefaultReleaseBranch

getArtifactsDirectory

getAutoApproveUpgrades

getBuildWorkflow

getBuildWorkflowTriggers

getBundlerOptions

getCheckLicenses

getCodeCov

getCodeCovTokenSecret

getCopyrightOwner

getCopyrightPeriod

getDependabot

getDependabotOptions

getDepsUpgrade

getDepsUpgradeOptions

getGitignore

getJest

getJestOptions

getMutableBuild

getNpmignore

getNpmignoreEnabled

getNpmIgnoreOptions

getPackageValue

getPrettier

getPrettierOptions

getProjenDevDependency

getProjenrcJs

getProjenrcJsOptions

getProjenVersion

getPullRequestTemplate

getPullRequestTemplateContents

getRelease

getReleaseToNpm

getReleaseWorkflow