Class AwsCdkConstructLibraryOptions.Jsii$Proxy
- java.lang.Object
-
- software.amazon.jsii.JsiiObject
-
- io.github.cdklabs.projen.awscdk.AwsCdkConstructLibraryOptions.Jsii$Proxy
-
- All Implemented Interfaces:
AwsCdkConstructLibraryOptions,AwsCdkDepsCommonOptions,ConstructLibraryOptions,JsiiProjectOptions,GitHubProjectOptions,NodePackageOptions,NodeProjectOptions,ProjectOptions,ReleaseProjectOptions,TypeScriptProjectOptions,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- AwsCdkConstructLibraryOptions
@Stability(Experimental) @Internal public static final class AwsCdkConstructLibraryOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements AwsCdkConstructLibraryOptions
An implementation forAwsCdkConstructLibraryOptions
-
-
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.awscdk.AwsCdkConstructLibraryOptions
AwsCdkConstructLibraryOptions.Builder, AwsCdkConstructLibraryOptions.Jsii$Proxy
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedJsii$Proxy(AwsCdkConstructLibraryOptions.Builder builder)Constructor that initializes the object based on literal property values passed by theAwsCdkConstructLibraryOptions.Builder.protectedJsii$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()booleanequals(Object o)BooleangetAllowLibraryDependencies()(experimental) Allow the project to includepeerDependenciesandbundledDependencies.StringgetArtifactsDirectory()(experimental) A directory which will contain build artifacts.StringgetAuthor()(experimental) The name of the library author.StringgetAuthorAddress()(experimental) Email or URL of the library author.StringgetAuthorEmail()(experimental) Author's e-mail.StringgetAuthorName()(experimental) Author's name.BooleangetAuthorOrganization()(experimental) Is the author an organization.StringgetAuthorUrl()(experimental) Author's URL / Website.AutoApproveOptionsgetAutoApproveOptions()(experimental) Enable and configure the 'auto approve' workflow.BooleangetAutoApproveUpgrades()(experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).BooleangetAutoDetectBin()(experimental) Automatically add all executables under thebindirectory to yourpackage.jsonfile under thebinsection.BooleangetAutoMerge()(experimental) Enable automatic merging on GitHub.AutoMergeOptionsgetAutoMergeOptions()(experimental) Configure options for automatic merging on GitHub.Map<String,String>getBin()(experimental) Binary programs vended with your module.StringgetBugsEmail()(experimental) The email address to which issues should be reported.StringgetBugsUrl()(experimental) The url to your project's issue tracker.BooleangetBuildWorkflow()(experimental) Define a GitHub workflow for building PRs.TriggersgetBuildWorkflowTriggers()(experimental) Build workflow triggers.List<String>getBundledDeps()(experimental) List of dependencies to bundle into this module.BundlerOptionsgetBundlerOptions()(experimental) Options forBundler.CataloggetCatalog()(experimental) Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.BooleangetCdkAssert()(deprecated) Warning: NodeJS only.BooleangetCdkAssertions()(experimental) Install the assertions library?List<String>getCdkDependencies()(deprecated) Which AWS CDKv1 modules this project requires.BooleangetCdkDependenciesAsDeps()(deprecated) If this is enabled (default), all modules declared incdkDependencieswill be also added as normaldependencies(as well aspeerDependencies).List<String>getCdkTestDependencies()(deprecated) AWS CDK modules required for testing.StringgetCdkVersion()(experimental) Minimum version of the AWS CDK to depend on.BooleangetCdkVersionPinning()(experimental) Use pinned version instead of caret version for CDK.LicenseCheckerOptionsgetCheckLicenses()(experimental) Configure which licenses should be deemed acceptable for use by dependencies.BooleangetClobber()(experimental) Add aclobbertask which resets the repo to origin.CodeArtifactOptionsgetCodeArtifactOptions()(experimental) Options for npm packages using AWS CodeArtifact.BooleangetCodeCov()(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.StringgetCodeCovTokenSecret()(experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.BooleangetCommitGenerated()(experimental) Whether to commit the managed files by default.BooleangetCompat()(experimental) Automatically run API compatibility test against the latest version published to npm after compilation.StringgetCompatIgnore()(experimental) Name of the ignore file for API compatibility tests.BooleangetCompressAssembly()(experimental) Emit a compressed version of the assembly.StringgetConstructsVersion()(experimental) Minimum version of theconstructslibrary to depend on.StringgetCopyrightOwner()(experimental) License copyright owner.StringgetCopyrightPeriod()(experimental) The copyright years to put in the LICENSE file.StringgetDefaultReleaseBranch()(experimental) The name of the main release branch.BooleangetDependabot()(experimental) Use dependabot to handle dependency upgrades.DependabotOptionsgetDependabotOptions()(experimental) Options for dependabot.List<String>getDeps()(experimental) Runtime dependencies of this module.BooleangetDepsUpgrade()(experimental) Use tasks and github workflows to handle dependency upgrades.UpgradeDependenciesOptionsgetDepsUpgradeOptions()(experimental) Options forUpgradeDependencies.StringgetDescription()(experimental) The description is just a string that helps people understand the purpose of the package.BooleangetDevContainer()(experimental) Add a VSCode development environment (used for GitHub Codespaces).List<String>getDevDeps()(experimental) Build dependencies for this module.BooleangetDisableTsconfig()(experimental) Do not generate atsconfig.jsonfile (used by jsii projects since tsconfig.json is generated by the jsii compiler).BooleangetDisableTsconfigDev()(experimental) Do not generate atsconfig.dev.jsonfile.BooleangetDocgen()(experimental) Docgen by Typedoc.StringgetDocgenFilePath()(experimental) File path for generated docs.StringgetDocsDirectory()(experimental) Docs directory.JsiiDotNetTargetgetDotnet()BooleangetEdgeLambdaAutoDiscover()(experimental) Automatically adds ancloudfront.experimental.EdgeFunctionfor each.edge-lambda.tshandler in your source tree.StringgetEntrypoint()(experimental) Module entrypoint (maininpackage.json).StringgetEntrypointTypes()(experimental) The .d.ts file that includes the type declarations for this module.BooleangetEslint()(experimental) Setup eslint.EslintOptionsgetEslintOptions()(experimental) Eslint options.List<String>getExcludeTypescript()(experimental) Accepts a list of glob patterns.BooleangetExperimentalIntegRunner()(experimental) Enable experimental support for the AWS CDK integ-runner.BooleangetGithub()(experimental) Enable GitHub integration.GitHubOptionsgetGithubOptions()(experimental) Options for GitHub integration.List<String>getGitignore()(experimental) Additional entries to .gitignore.IgnoreFileOptionsgetGitIgnoreOptions()(experimental) Configuration options for .gitignore file.GitOptionsgetGitOptions()(experimental) Configuration options for git.BooleangetGitpod()(experimental) Add a Gitpod development environment.StringgetHomepage()(experimental) Package's Homepage / Website.BooleangetIntegrationTestAutoDiscover()(experimental) Automatically discovers and creates integration tests for each.integ.tsfile under your test directory.BooleangetJest()(experimental) Setup jest unit tests.JestOptionsgetJestOptions()(experimental) Jest options.StringgetJsiiReleaseVersion()(experimental) Version requirement ofpublibwhich is used to publish modules to npm.StringgetJsiiVersion()(experimental) Version of the jsii compiler to use.List<String>getKeywords()(experimental) Keywords to include inpackage.json.BooleangetLambdaAutoDiscover()(experimental) Automatically adds anaws_lambda.Functionfor each.lambda.tshandler in your source tree.BooleangetLambdaExtensionAutoDiscover()(experimental) Automatically adds anawscdk.LambdaExtensionfor each.lambda-extension.tsentrypoint in your source tree.LambdaFunctionCommonOptionsgetLambdaOptions()(experimental) Common options for all AWS Lambda functions.StringgetLibdir()(experimental) Typescript artifacts output directory.StringgetLicense()(experimental) License's SPDX identifier.BooleangetLicensed()(experimental) Indicates if a license should be added.LoggerOptionsgetLogging()(experimental) Configure logging options such as verbosity.NumbergetMajorVersion()(experimental) Major version to release from the default branch.StringgetMaxNodeVersion()(experimental) Minimum node.js version to require viaengines(inclusive).BooleangetMergify()(deprecated) Whether mergify should be enabled on this repository or not.MergifyOptionsgetMergifyOptions()(deprecated) Options for mergify.NumbergetMinMajorVersion()(experimental) Minimal Major version to release.StringgetMinNodeVersion()(experimental) Minimum Node.js version to require via package.jsonengines(inclusive).BooleangetMutableBuild()(experimental) Automatically update files modified during builds to pull-request branches.StringgetName()(experimental) This is the name of your project.NpmAccessgetNpmAccess()(experimental) Access level of the npm package.StringgetNpmDistTag()(experimental) The npmDistTag to use when publishing from the default branch.List<String>getNpmignore()(deprecated) Additional entries to .npmignore.BooleangetNpmignoreEnabled()(experimental) Defines an .npmignore file.IgnoreFileOptionsgetNpmIgnoreOptions()(experimental) Configuration options for .npmignore file.BooleangetNpmProvenance()(experimental) Should provenance statements be generated when the package is published.StringgetNpmRegistry()(deprecated) The host name of the npm registry to publish to.StringgetNpmRegistryUrl()(experimental) The base URL of the npm package registry.StringgetNpmTokenSecret()(experimental) GitHub secret which contains the NPM token to use when publishing packages.StringgetOutdir()(experimental) The root directory of the project.NodePackageManagergetPackageManager()(experimental) The Node Package Manager used to execute scripts.StringgetPackageName()(experimental) The "name" in package.json.BooleangetPackageValue()(experimental) Defines apackagetask that will produce an npm tarball under the artifacts directory (e.g.ProjectgetParent()(experimental) The parent project, if this project is part of a bigger project.PeerDependencyOptionsgetPeerDependencyOptions()(experimental) Options forpeerDeps.List<String>getPeerDeps()(experimental) Peer dependencies for this module.StringgetPnpmVersion()(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.StringgetPrerelease()(experimental) Bump versions from the default branch as pre-releases (e.g.BooleangetPrettier()(experimental) Setup prettier.PrettierOptionsgetPrettierOptions()(experimental) Prettier options.ProjectTypegetProjectType()(deprecated) Which type of project this is (library/app).StringgetProjenCommand()(experimental) The shell command to use in order to run the projen CLI.GithubCredentialsgetProjenCredentials()(experimental) Choose a method of providing GitHub API access for projen workflows.BooleangetProjenDevDependency()(experimental) Indicates of "projen" should be installed as a devDependency.BooleangetProjenrcJs()(experimental) Generate (once) .projenrc.js (in JavaScript).BooleangetProjenrcJson()(experimental) Generate (once) .projenrc.json (in JSON).ProjenrcJsonOptionsgetProjenrcJsonOptions()(experimental) Options for .projenrc.json.ProjenrcOptionsgetProjenrcJsOptions()(experimental) Options for .projenrc.js.BooleangetProjenrcTs()(experimental) Use TypeScript for your projenrc file (.projenrc.ts).ProjenrcOptionsgetProjenrcTsOptions()(experimental) Options for .projenrc.ts.StringgetProjenTokenSecret()(deprecated) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.StringgetProjenVersion()(experimental) Version of projen to install.BooleangetPublishDryRun()(experimental) Instead of actually publishing to package managers, just print the publishing command.BooleangetPublishTasks()(experimental) Define publishing tasks that can be executed manually as well as workflows.JsiiGoTargetgetPublishToGo()(experimental) Publish Go bindings to a git repository.JsiiJavaTargetgetPublishToMaven()(experimental) Publish to maven.JsiiDotNetTargetgetPublishToNuget()(experimental) Publish to NuGet.JsiiPythonTargetgetPublishToPypi()(experimental) Publish to pypi.BooleangetPullRequestTemplate()(experimental) Include a GitHub pull request template.List<String>getPullRequestTemplateContents()(experimental) The contents of the pull request template.JsiiPythonTargetgetPython()SampleReadmePropsgetReadme()(experimental) The README setup.ReleasableCommitsgetReleasableCommits()(experimental) Find commits that should be considered releasable Used to decide if a release is required.BooleangetRelease()(experimental) Add release management to this project.Map<String,BranchOptions>getReleaseBranches()(experimental) Defines additional release branches.BooleangetReleaseEveryCommit()(deprecated) Automatically release new versions every commit to one of branches inreleaseBranches.BooleangetReleaseFailureIssue()(experimental) Create a github issue on every failed publishing task.StringgetReleaseFailureIssueLabel()(experimental) The label to apply to issues indicating publish failures.StringgetReleaseSchedule()(deprecated) CRON schedule to trigger new releases.StringgetReleaseTagPrefix()(experimental) Automatically add the given prefix to release tags.BooleangetReleaseToNpm()(experimental) Automatically release to npm when new versions are introduced.ReleaseTriggergetReleaseTrigger()(experimental) The release trigger to use.BooleangetReleaseWorkflow()(deprecated) DEPRECATED: renamed torelease.StringgetReleaseWorkflowName()(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.BooleangetRenovatebot()(experimental) Use renovatebot to handle dependency upgrades.RenovatebotOptionsgetRenovatebotOptions()(experimental) Options for renovatebot.StringgetRepository()(experimental) The repository is the location where the actual code for your package lives.StringgetRepositoryDirectory()(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.StringgetRepositoryUrl()(experimental) Git repository URL.StringgetRootdir()Default: "."BooleangetSampleCode()(experimental) Generate one-time sample insrc/andtest/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.StringgetSrcdir()(experimental) Typescript sources directory.StringgetStability()(experimental) Package's Stability.BooleangetStale()(experimental) Auto-close of stale issues and pull request.StaleOptionsgetStaleOptions()(experimental) Auto-close stale issues and pull requests.StringgetTestdir()(experimental) Jest tests directory.TypescriptConfigOptionsgetTsconfig()(experimental) Custom TSConfig.TypescriptConfigOptionsgetTsconfigDev()(experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).StringgetTsconfigDevFile()(experimental) The name of the development tsconfig.json file.TsJestOptionsgetTsJestOptions()(experimental) Options for ts-jest.StringgetTypescriptVersion()(experimental) TypeScript version to use.Map<String,Object>getVersionrcOptions()(experimental) Custom configuration used when creating changelog with standard-version package.BooleangetVscode()(experimental) Enable VSCode integration.List<JobStep>getWorkflowBootstrapSteps()(experimental) Workflow steps to use in order to bootstrap this repo.StringgetWorkflowContainerImage()(experimental) Container image to use for GitHub workflows.GitIdentitygetWorkflowGitIdentity()(experimental) The git identity to use in workflows.StringgetWorkflowNodeVersion()(experimental) The node version to use in GitHub workflows.BooleangetWorkflowPackageCache()(experimental) Enable Node.js package cache in GitHub workflows.List<String>getWorkflowRunsOn()(experimental) Github Runner selection labels.GroupRunnerOptionsgetWorkflowRunsOnGroup()(experimental) Github Runner Group selection options.YarnBerryOptionsgetYarnBerryOptions()(experimental) Options for Yarn Berry.inthashCode()
-
-
-
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(AwsCdkConstructLibraryOptions.Builder builder)
Constructor that initializes the object based on literal property values passed by theAwsCdkConstructLibraryOptions.Builder.
-
-
Method Detail
-
getEdgeLambdaAutoDiscover
public final Boolean getEdgeLambdaAutoDiscover()
Description copied from interface:AwsCdkConstructLibraryOptions(experimental) Automatically adds ancloudfront.experimental.EdgeFunctionfor each.edge-lambda.tshandler in your source tree. If this is disabled, you can manually add anawscdk.AutoDiscovercomponent to your project.Default: true
- Specified by:
getEdgeLambdaAutoDiscoverin interfaceAwsCdkConstructLibraryOptions
-
getExperimentalIntegRunner
public final Boolean getExperimentalIntegRunner()
Description copied from interface:AwsCdkConstructLibraryOptions(experimental) Enable experimental support for the AWS CDK integ-runner.Default: false
- Specified by:
getExperimentalIntegRunnerin interfaceAwsCdkConstructLibraryOptions
-
getIntegrationTestAutoDiscover
public final Boolean getIntegrationTestAutoDiscover()
Description copied from interface:AwsCdkConstructLibraryOptions(experimental) Automatically discovers and creates integration tests for each.integ.tsfile under your test directory.Default: true
- Specified by:
getIntegrationTestAutoDiscoverin interfaceAwsCdkConstructLibraryOptions
-
getLambdaAutoDiscover
public final Boolean getLambdaAutoDiscover()
Description copied from interface:AwsCdkConstructLibraryOptions(experimental) Automatically adds anaws_lambda.Functionfor each.lambda.tshandler in your source tree. If this is disabled, you either need to explicitly callaws_lambda.Function.autoDiscover()or define anew aws_lambda.Function()for each handler.Default: true
- Specified by:
getLambdaAutoDiscoverin interfaceAwsCdkConstructLibraryOptions
-
getLambdaExtensionAutoDiscover
public final Boolean getLambdaExtensionAutoDiscover()
Description copied from interface:AwsCdkConstructLibraryOptions(experimental) Automatically adds anawscdk.LambdaExtensionfor each.lambda-extension.tsentrypoint in your source tree. If this is disabled, you can manually add anawscdk.AutoDiscovercomponent to your project.Default: true
- Specified by:
getLambdaExtensionAutoDiscoverin interfaceAwsCdkConstructLibraryOptions
-
getLambdaOptions
public final LambdaFunctionCommonOptions getLambdaOptions()
Description copied from interface:AwsCdkConstructLibraryOptions(experimental) Common options for all AWS Lambda functions.Default: - default options
- Specified by:
getLambdaOptionsin interfaceAwsCdkConstructLibraryOptions
-
getCatalog
public final Catalog getCatalog()
Description copied from interface:ConstructLibraryOptions(experimental) Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION
The catalog will also post a tweet to https://twitter.com/awscdkio with the package name, description and the above link. You can disable these tweets through
{ announce: false }.You can also add a Twitter handle through
{ twitter: 'xx' }which will be mentioned in the tweet.Default: - new version will be announced
- Specified by:
getCatalogin interfaceConstructLibraryOptions- See Also:
- https://github.com/construct-catalog/catalog
-
getAuthor
public final String getAuthor()
Description copied from interface:JsiiProjectOptions(experimental) The name of the library author.Default: $GIT_USER_NAME
- Specified by:
getAuthorin interfaceJsiiProjectOptions
-
getAuthorAddress
public final String getAuthorAddress()
Description copied from interface:JsiiProjectOptions(experimental) Email or URL of the library author.Default: $GIT_USER_EMAIL
- Specified by:
getAuthorAddressin interfaceJsiiProjectOptions
-
getRepositoryUrl
public final String getRepositoryUrl()
Description copied from interface:JsiiProjectOptions(experimental) Git repository URL.Default: $GIT_REMOTE
- Specified by:
getRepositoryUrlin interfaceJsiiProjectOptions
-
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 compatif this feature is disabled. - You can ignore compatibility failures by adding lines to a ".compatignore" file.
Default: false
- Specified by:
getCompatin interfaceJsiiProjectOptions
- You can manually run compatibility tests using
-
getCompatIgnore
public final String getCompatIgnore()
Description copied from interface:JsiiProjectOptions(experimental) Name of the ignore file for API compatibility tests.Default: ".compatignore"
- Specified by:
getCompatIgnorein interfaceJsiiProjectOptions
-
getCompressAssembly
public final Boolean getCompressAssembly()
Description copied from interface:JsiiProjectOptions(experimental) Emit a compressed version of the assembly.Default: false
- Specified by:
getCompressAssemblyin interfaceJsiiProjectOptions
-
getDocgenFilePath
public final String getDocgenFilePath()
Description copied from interface:JsiiProjectOptions(experimental) File path for generated docs.Default: "API.md"
- Specified by:
getDocgenFilePathin interfaceJsiiProjectOptions
-
getDotnet
public final JsiiDotNetTarget getDotnet()
- Specified by:
getDotnetin interfaceJsiiProjectOptions
-
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:
getExcludeTypescriptin interfaceJsiiProjectOptions
-
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.jsonon 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:
getJsiiVersionin interfaceJsiiProjectOptions
-
getPublishToGo
public final JsiiGoTarget getPublishToGo()
Description copied from interface:JsiiProjectOptions(experimental) Publish Go bindings to a git repository.Default: - no publishing
- Specified by:
getPublishToGoin interfaceJsiiProjectOptions
-
getPublishToMaven
public final JsiiJavaTarget getPublishToMaven()
Description copied from interface:JsiiProjectOptions(experimental) Publish to maven.Default: - no publishing
- Specified by:
getPublishToMavenin interfaceJsiiProjectOptions
-
getPublishToNuget
public final JsiiDotNetTarget getPublishToNuget()
Description copied from interface:JsiiProjectOptions(experimental) Publish to NuGet.Default: - no publishing
- Specified by:
getPublishToNugetin interfaceJsiiProjectOptions
-
getPublishToPypi
public final JsiiPythonTarget getPublishToPypi()
Description copied from interface:JsiiProjectOptions(experimental) Publish to pypi.Default: - no publishing
- Specified by:
getPublishToPypiin interfaceJsiiProjectOptions
-
getPython
public final JsiiPythonTarget getPython()
- Specified by:
getPythonin interfaceJsiiProjectOptions
-
getRootdir
public final String getRootdir()
Description copied from interface:JsiiProjectOptionsDefault: "."- Specified by:
getRootdirin interfaceJsiiProjectOptions
-
getDisableTsconfig
public final Boolean getDisableTsconfig()
Description copied from interface:TypeScriptProjectOptions(experimental) Do not generate atsconfig.jsonfile (used by jsii projects since tsconfig.json is generated by the jsii compiler).Default: false
- Specified by:
getDisableTsconfigin interfaceTypeScriptProjectOptions
-
getDisableTsconfigDev
public final Boolean getDisableTsconfigDev()
Description copied from interface:TypeScriptProjectOptions(experimental) Do not generate atsconfig.dev.jsonfile.Default: false
- Specified by:
getDisableTsconfigDevin interfaceTypeScriptProjectOptions
-
getDocgen
public final Boolean getDocgen()
Description copied from interface:TypeScriptProjectOptions(experimental) Docgen by Typedoc.Default: false
- Specified by:
getDocgenin interfaceTypeScriptProjectOptions
-
getDocsDirectory
public final String getDocsDirectory()
Description copied from interface:TypeScriptProjectOptions(experimental) Docs directory.Default: "docs"
- Specified by:
getDocsDirectoryin interfaceTypeScriptProjectOptions
-
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:
getEntrypointTypesin interfaceTypeScriptProjectOptions
-
getEslint
public final Boolean getEslint()
Description copied from interface:TypeScriptProjectOptions(experimental) Setup eslint.Default: true
- Specified by:
getEslintin interfaceTypeScriptProjectOptions
-
getEslintOptions
public final EslintOptions getEslintOptions()
Description copied from interface:TypeScriptProjectOptions(experimental) Eslint options.Default: - opinionated default options
- Specified by:
getEslintOptionsin interfaceTypeScriptProjectOptions
-
getLibdir
public final String getLibdir()
Description copied from interface:TypeScriptProjectOptions(experimental) Typescript artifacts output directory.Default: "lib"
- Specified by:
getLibdirin interfaceTypeScriptProjectOptions
-
getProjenrcTs
public final Boolean getProjenrcTs()
Description copied from interface:TypeScriptProjectOptions(experimental) Use TypeScript for your projenrc file (.projenrc.ts).Default: false
- Specified by:
getProjenrcTsin interfaceTypeScriptProjectOptions
-
getProjenrcTsOptions
public final ProjenrcOptions getProjenrcTsOptions()
Description copied from interface:TypeScriptProjectOptions(experimental) Options for .projenrc.ts.- Specified by:
getProjenrcTsOptionsin interfaceTypeScriptProjectOptions
-
getSampleCode
public final Boolean getSampleCode()
Description copied from interface:TypeScriptProjectOptions(experimental) Generate one-time sample insrc/andtest/if there are no files there.Default: true
- Specified by:
getSampleCodein interfaceTypeScriptProjectOptions
-
getSrcdir
public final String getSrcdir()
Description copied from interface:TypeScriptProjectOptions(experimental) Typescript sources directory.Default: "src"
- Specified by:
getSrcdirin interfaceTypeScriptProjectOptions
-
getTestdir
public final String getTestdir()
Description copied from interface:TypeScriptProjectOptions(experimental) Jest tests directory. Tests files should be namedxxx.test.ts.If this directory is under
srcdir(e.g.src/test,src/__tests__), then tests are going to be compiled intolib/and executed as javascript. If the test directory is outside ofsrc, then we configure jest to compile the code in-memory.Default: "test"
- Specified by:
getTestdirin interfaceTypeScriptProjectOptions
-
getTsconfig
public final TypescriptConfigOptions getTsconfig()
Description copied from interface:TypeScriptProjectOptions(experimental) Custom TSConfig.Default: - default options
- Specified by:
getTsconfigin interfaceTypeScriptProjectOptions
-
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:
getTsconfigDevin interfaceTypeScriptProjectOptions
-
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:
getTsconfigDevFilein interfaceTypeScriptProjectOptions
-
getTsJestOptions
public final TsJestOptions getTsJestOptions()
Description copied from interface:TypeScriptProjectOptions(experimental) Options for ts-jest.- Specified by:
getTsJestOptionsin interfaceTypeScriptProjectOptions
-
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:
getTypescriptVersionin interfaceTypeScriptProjectOptions
-
getDefaultReleaseBranch
public final String getDefaultReleaseBranch()
Description copied from interface:NodeProjectOptions(experimental) The name of the main release branch.Default: "main"
- Specified by:
getDefaultReleaseBranchin interfaceNodeProjectOptions
-
getArtifactsDirectory
public final String getArtifactsDirectory()
Description copied from interface:NodeProjectOptions(experimental) A directory which will contain build artifacts.Default: "dist"
- Specified by:
getArtifactsDirectoryin interfaceNodeProjectOptions
-
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
autoApproveOptionsare not defined.Default: - true
- Specified by:
getAutoApproveUpgradesin interfaceNodeProjectOptions
-
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:
getBuildWorkflowin interfaceNodeProjectOptions
-
getBuildWorkflowTriggers
public final Triggers getBuildWorkflowTriggers()
Description copied from interface:NodeProjectOptions(experimental) Build workflow triggers.Default: "{ pullRequest: {}, workflowDispatch: {} }"
- Specified by:
getBuildWorkflowTriggersin interfaceNodeProjectOptions
-
getBundlerOptions
public final BundlerOptions getBundlerOptions()
Description copied from interface:NodeProjectOptions(experimental) Options forBundler.- Specified by:
getBundlerOptionsin interfaceNodeProjectOptions
-
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:
getCheckLicensesin interfaceNodeProjectOptions
-
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:
getCodeCovin interfaceNodeProjectOptions
-
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:
getCodeCovTokenSecretin interfaceNodeProjectOptions
-
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:
getCopyrightOwnerin interfaceNodeProjectOptions
-
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:
getCopyrightPeriodin interfaceNodeProjectOptions
-
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:
getDependabotin interfaceNodeProjectOptions
-
getDependabotOptions
public final DependabotOptions getDependabotOptions()
Description copied from interface:NodeProjectOptions(experimental) Options for dependabot.Default: - default options
- Specified by:
getDependabotOptionsin interfaceNodeProjectOptions
-
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:
getDepsUpgradein interfaceNodeProjectOptions
-
getDepsUpgradeOptions
public final UpgradeDependenciesOptions getDepsUpgradeOptions()
Description copied from interface:NodeProjectOptions(experimental) Options forUpgradeDependencies.Default: - default options
- Specified by:
getDepsUpgradeOptionsin interfaceNodeProjectOptions
-
getGitignore
public final List<String> getGitignore()
Description copied from interface:NodeProjectOptions(experimental) Additional entries to .gitignore.- Specified by:
getGitignorein interfaceNodeProjectOptions
-
getJest
public final Boolean getJest()
Description copied from interface:NodeProjectOptions(experimental) Setup jest unit tests.Default: true
- Specified by:
getJestin interfaceNodeProjectOptions
-
getJestOptions
public final JestOptions getJestOptions()
Description copied from interface:NodeProjectOptions(experimental) Jest options.Default: - default options
- Specified by:
getJestOptionsin interfaceNodeProjectOptions
-
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:
getMutableBuildin interfaceNodeProjectOptions
-
getNpmignore
public final List<String> getNpmignore()
Description copied from interface:NodeProjectOptions(deprecated) Additional entries to .npmignore.- Specified by:
getNpmignorein interfaceNodeProjectOptions
-
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:
getNpmignoreEnabledin interfaceNodeProjectOptions
-
getNpmIgnoreOptions
public final IgnoreFileOptions getNpmIgnoreOptions()
Description copied from interface:NodeProjectOptions(experimental) Configuration options for .npmignore file.- Specified by:
getNpmIgnoreOptionsin interfaceNodeProjectOptions
-
getPackageValue
public final Boolean getPackageValue()
Description copied from interface:NodeProjectOptions(experimental) Defines apackagetask that will produce an npm tarball under the artifacts directory (e.g.dist).Default: true
- Specified by:
getPackageValuein interfaceNodeProjectOptions
-
getPrettier
public final Boolean getPrettier()
Description copied from interface:NodeProjectOptions(experimental) Setup prettier.Default: false
- Specified by:
getPrettierin interfaceNodeProjectOptions
-
getPrettierOptions
public final PrettierOptions getPrettierOptions()
Description copied from interface:NodeProjectOptions(experimental) Prettier options.Default: - default options
- Specified by:
getPrettierOptionsin interfaceNodeProjectOptions
-
getProjenDevDependency
public final Boolean getProjenDevDependency()
Description copied from interface:NodeProjectOptions(experimental) Indicates of "projen" should be installed as a devDependency.Default: true
- Specified by:
getProjenDevDependencyin interfaceNodeProjectOptions
-
getProjenrcJs
public final Boolean getProjenrcJs()
Description copied from interface:NodeProjectOptions(experimental) Generate (once) .projenrc.js (in JavaScript). Set tofalsein order to disable .projenrc.js generation.Default: - true if projenrcJson is false
- Specified by:
getProjenrcJsin interfaceNodeProjectOptions
-
getProjenrcJsOptions
public final ProjenrcOptions getProjenrcJsOptions()
Description copied from interface:NodeProjectOptions(experimental) Options for .projenrc.js.Default: - default options
- Specified by:
getProjenrcJsOptionsin interfaceNodeProjectOptions
-
getProjenVersion
public final String getProjenVersion()
Description copied from interface:NodeProjectOptions(experimental) Version of projen to install.Default: - Defaults to the latest version.
- Specified by:
getProjenVersionin interfaceNodeProjectOptions
-
getPullRequestTemplate
public final Boolean getPullRequestTemplate()
Description copied from interface:NodeProjectOptions(experimental) Include a GitHub pull request template.Default: true
- Specified by:
getPullRequestTemplatein interfaceNodeProjectOptions
-
getPullRequestTemplateContents
public final List<String> getPullRequestTemplateContents()
Description copied from interface:NodeProjectOptions(experimental) The contents of the pull request template.Default: - default content
- Specified by:
getPullRequestTemplateContentsin interfaceNodeProjectOptions
-
getRelease
public final Boolean getRelease()
Description copied from interface:NodeProjectOptions(experimental) Add release management to this project.Default: - true (false for subprojects)
- Specified by:
getReleasein interfaceNodeProjectOptions
-
getReleaseToNpm
public final Boolean getReleaseToNpm()
Description copied from interface:NodeProjectOptions(experimental) Automatically release to npm when new versions are introduced.Default: false
- Specified by:
getReleaseToNpmin interfaceNodeProjectOptions
-
getReleaseWorkflow
public final Boolean getReleaseWorkflow()
Description copied from interface:NodeProjectOptions(deprecated) DEPRECATED: renamed torelease.Default: - true if not a subproject
- Specified by:
getReleaseWorkflowin interfaceNodeProjectOptions
-
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:
getWorkflowBootstrapStepsin interfaceNodeProjectOptions
-
getWorkflowGitIdentity
public final GitIdentity getWorkflowGitIdentity()
Description copied from interface:NodeProjectOptions(experimental) The git identity to use in workflows.Default: - GitHub Actions
- Specified by:
getWorkflowGitIdentityin interfaceNodeProjectOptions
-
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:
getWorkflowNodeVersionin interfaceNodeProjectOptions
-
getWorkflowPackageCache
public final Boolean getWorkflowPackageCache()
Description copied from interface:NodeProjectOptions(experimental) Enable Node.js package cache in GitHub workflows.Default: false
- Specified by:
getWorkflowPackageCachein interfaceNodeProjectOptions
-
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:
getAutoApproveOptionsin interfaceGitHubProjectOptions
-
getAutoMerge
public final Boolean getAutoMerge()
Description copied from interface:GitHubProjectOptions(experimental) Enable automatic merging on GitHub.Has no effect if
github.mergifyis set to false.Default: true
- Specified by:
getAutoMergein interfaceGitHubProjectOptions
-
getAutoMergeOptions
public final AutoMergeOptions getAutoMergeOptions()
Description copied from interface:GitHubProjectOptions(experimental) Configure options for automatic merging on GitHub.Has no effect if
github.mergifyorautoMergeis set to false.Default: - see defaults in `AutoMergeOptions`
- Specified by:
getAutoMergeOptionsin interfaceGitHubProjectOptions
-
getClobber
public final Boolean getClobber()
Description copied from interface:GitHubProjectOptions(experimental) Add aclobbertask which resets the repo to origin.Default: - true, but false for subprojects
- Specified by:
getClobberin interfaceGitHubProjectOptions
-
getDevContainer
public final Boolean getDevContainer()
Description copied from interface:GitHubProjectOptions(experimental) Add a VSCode development environment (used for GitHub Codespaces).Default: false
- Specified by:
getDevContainerin interfaceGitHubProjectOptions
-
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:
getGithubin interfaceGitHubProjectOptions
-
getGithubOptions
public final GitHubOptions getGithubOptions()
Description copied from interface:GitHubProjectOptions(experimental) Options for GitHub integration.Default: - see GitHubOptions
- Specified by:
getGithubOptionsin interfaceGitHubProjectOptions
-
getGitpod
public final Boolean getGitpod()
Description copied from interface:GitHubProjectOptions(experimental) Add a Gitpod development environment.Default: false
- Specified by:
getGitpodin interfaceGitHubProjectOptions
-
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:
getMergifyin interfaceGitHubProjectOptions
-
getMergifyOptions
public final MergifyOptions getMergifyOptions()
Description copied from interface:GitHubProjectOptions(deprecated) Options for mergify.Default: - default options
- Specified by:
getMergifyOptionsin interfaceGitHubProjectOptions
-
getProjectType
public final ProjectType getProjectType()
Description copied from interface:GitHubProjectOptions(deprecated) Which type of project this is (library/app).Default: ProjectType.UNKNOWN
- Specified by:
getProjectTypein interfaceGitHubProjectOptions
-
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:
getProjenCredentialsin interfaceGitHubProjectOptions
-
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,workflowsandpackagesscope.Default: "PROJEN_GITHUB_TOKEN"
- Specified by:
getProjenTokenSecretin interfaceGitHubProjectOptions
-
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:
getReadmein interfaceGitHubProjectOptions
-
getStale
public final Boolean getStale()
Description copied from interface:GitHubProjectOptions(experimental) Auto-close of stale issues and pull request.See
staleOptionsfor options.Default: false
- Specified by:
getStalein interfaceGitHubProjectOptions
-
getStaleOptions
public final StaleOptions getStaleOptions()
Description copied from interface:GitHubProjectOptions(experimental) Auto-close stale issues and pull requests.To disable set
staletofalse.Default: - see defaults in `StaleOptions`
- Specified by:
getStaleOptionsin interfaceGitHubProjectOptions
-
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:
getVscodein interfaceGitHubProjectOptions
-
getName
public final String getName()
Description copied from interface:ProjectOptions(experimental) This is the name of your project.Default: $BASEDIR
- Specified by:
getNamein interfaceProjectOptions
-
getCommitGenerated
public final Boolean getCommitGenerated()
Description copied from interface:ProjectOptions(experimental) Whether to commit the managed files by default.Default: true
- Specified by:
getCommitGeneratedin interfaceProjectOptions
-
getGitIgnoreOptions
public final IgnoreFileOptions getGitIgnoreOptions()
Description copied from interface:ProjectOptions(experimental) Configuration options for .gitignore file.- Specified by:
getGitIgnoreOptionsin interfaceProjectOptions
-
getGitOptions
public final GitOptions getGitOptions()
Description copied from interface:ProjectOptions(experimental) Configuration options for git.- Specified by:
getGitOptionsin interfaceProjectOptions
-
getLogging
public final LoggerOptions getLogging()
Description copied from interface:ProjectOptions(experimental) Configure logging options such as verbosity.Default: {}
- Specified by:
getLoggingin interfaceProjectOptions
-
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:
getOutdirin interfaceProjectOptions
-
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:
getParentin interfaceProjectOptions
-
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:
getProjenCommandin interfaceProjectOptions
-
getProjenrcJson
public final Boolean getProjenrcJson()
Description copied from interface:ProjectOptions(experimental) Generate (once) .projenrc.json (in JSON). Set tofalsein order to disable .projenrc.json generation.Default: false
- Specified by:
getProjenrcJsonin interfaceProjectOptions
-
getProjenrcJsonOptions
public final ProjenrcJsonOptions getProjenrcJsonOptions()
Description copied from interface:ProjectOptions(experimental) Options for .projenrc.json.Default: - default options
- Specified by:
getProjenrcJsonOptionsin interfaceProjectOptions
-
getRenovatebot
public final Boolean getRenovatebot()
Description copied from interface:ProjectOptions(experimental) Use renovatebot to handle dependency upgrades.Default: false
- Specified by:
getRenovatebotin interfaceProjectOptions
-
getRenovatebotOptions
public final RenovatebotOptions getRenovatebotOptions()
Description copied from interface:ProjectOptions(experimental) Options for renovatebot.Default: - default options
- Specified by:
getRenovatebotOptionsin interfaceProjectOptions
-
getAllowLibraryDependencies
public final Boolean getAllowLibraryDependencies()
Description copied from interface:NodePackageOptions(experimental) Allow the project to includepeerDependenciesandbundledDependencies.This is normally only allowed for libraries. For apps, there's no meaning for specifying these.
Default: true
- Specified by:
getAllowLibraryDependenciesin interfaceNodePackageOptions
-
getAuthorEmail
public final String getAuthorEmail()
Description copied from interface:NodePackageOptions(experimental) Author's e-mail.- Specified by:
getAuthorEmailin interfaceNodePackageOptions
-
getAuthorName
public final String getAuthorName()
Description copied from interface:NodePackageOptions(experimental) Author's name.- Specified by:
getAuthorNamein interfaceNodePackageOptions
-
getAuthorOrganization
public final Boolean getAuthorOrganization()
Description copied from interface:NodePackageOptions(experimental) Is the author an organization.- Specified by:
getAuthorOrganizationin interfaceNodePackageOptions
-
getAuthorUrl
public final String getAuthorUrl()
Description copied from interface:NodePackageOptions(experimental) Author's URL / Website.- Specified by:
getAuthorUrlin interfaceNodePackageOptions
-
getAutoDetectBin
public final Boolean getAutoDetectBin()
Description copied from interface:NodePackageOptions(experimental) Automatically add all executables under thebindirectory to yourpackage.jsonfile under thebinsection.Default: true
- Specified by:
getAutoDetectBinin interfaceNodePackageOptions
-
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 unlessautoDetectBinisfalse, every executable file underbinwill automatically be added to this section.- Specified by:
getBinin interfaceNodePackageOptions
-
getBugsEmail
public final String getBugsEmail()
Description copied from interface:NodePackageOptions(experimental) The email address to which issues should be reported.- Specified by:
getBugsEmailin interfaceNodePackageOptions
-
getBugsUrl
public final String getBugsUrl()
Description copied from interface:NodePackageOptions(experimental) The url to your project's issue tracker.- Specified by:
getBugsUrlin interfaceNodePackageOptions
-
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
dependenciessection andbundledDependenciessection of yourpackage.json.The recommendation is to only specify the module name here (e.g.
express). This will behave similar toyarn addornpm installin the sense that it will add the module as a dependency to yourpackage.jsonfile with the latest version (^). You can specify semver requirements in the same syntax passed tonpm ioryarn add(e.g.express@^2) and this will be what youpackage.jsonwill eventually include.- Specified by:
getBundledDepsin interfaceNodePackageOptions
-
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:
getCodeArtifactOptionsin interfaceNodePackageOptions
-
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 toyarn addornpm installin the sense that it will add the module as a dependency to yourpackage.jsonfile with the latest version (^). You can specify semver requirements in the same syntax passed tonpm ioryarn add(e.g.express@^2) and this will be what youpackage.jsonwill eventually include.Default: []
Example:
[ 'express', 'lodash', 'foo@^2' ]
- Specified by:
getDepsin interfaceNodePackageOptions
-
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:
getDescriptionin interfaceNodePackageOptions
-
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 toyarn addornpm installin the sense that it will add the module as a dependency to yourpackage.jsonfile with the latest version (^). You can specify semver requirements in the same syntax passed tonpm ioryarn add(e.g.express@^2) and this will be what youpackage.jsonwill eventually include.Default: []
Example:
[ 'typescript', '@types/express' ]
- Specified by:
getDevDepsin interfaceNodePackageOptions
-
getEntrypoint
public final String getEntrypoint()
Description copied from interface:NodePackageOptions(experimental) Module entrypoint (maininpackage.json).Set to an empty string to not include
mainin your package.jsonDefault: "lib/index.js"
- Specified by:
getEntrypointin interfaceNodePackageOptions
-
getHomepage
public final String getHomepage()
Description copied from interface:NodePackageOptions(experimental) Package's Homepage / Website.- Specified by:
getHomepagein interfaceNodePackageOptions
-
getKeywords
public final List<String> getKeywords()
Description copied from interface:NodePackageOptions(experimental) Keywords to include inpackage.json.- Specified by:
getKeywordsin interfaceNodePackageOptions
-
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
licensedoption if you want to no license to be specified.Default: "Apache-2.0"
- Specified by:
getLicensein interfaceNodePackageOptions
-
getLicensed
public final Boolean getLicensed()
Description copied from interface:NodePackageOptions(experimental) Indicates if a license should be added.Default: true
- Specified by:
getLicensedin interfaceNodePackageOptions
-
getMaxNodeVersion
public final String getMaxNodeVersion()
Description copied from interface:NodePackageOptions(experimental) Minimum node.js version to require viaengines(inclusive).Default: - no max
- Specified by:
getMaxNodeVersionin interfaceNodePackageOptions
-
getMinNodeVersion
public final String getMinNodeVersion()
Description copied from interface:NodePackageOptions(experimental) Minimum Node.js version to require via package.jsonengines(inclusive).Default: - no "engines" specified
- Specified by:
getMinNodeVersionin interfaceNodePackageOptions
-
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:
getNpmAccessin interfaceNodePackageOptions
-
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
ReleaseandPublishercomponents are usingpublibto 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:
getNpmProvenancein interfaceNodePackageOptions- 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:
getNpmRegistryin interfaceNodePackageOptions
-
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:
getNpmRegistryUrlin interfaceNodePackageOptions
-
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:
getNpmTokenSecretin interfaceNodePackageOptions
-
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:
getPackageManagerin interfaceNodePackageOptions
-
getPackageName
public final String getPackageName()
Description copied from interface:NodePackageOptions(experimental) The "name" in package.json.Default: - defaults to project name
- Specified by:
getPackageNamein interfaceNodePackageOptions
-
getPeerDependencyOptions
public final PeerDependencyOptions getPeerDependencyOptions()
Description copied from interface:NodePackageOptions(experimental) Options forpeerDeps.- Specified by:
getPeerDependencyOptionsin interfaceNodePackageOptions
-
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_modulestree 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.pinnedDevDependencyis 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:
getPeerDepsin interfaceNodePackageOptions
-
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:
getPnpmVersionin interfaceNodePackageOptions
-
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:
getRepositoryin interfaceNodePackageOptions
-
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:
getRepositoryDirectoryin interfaceNodePackageOptions
-
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:
getScopedPackagesOptionsin interfaceNodePackageOptions
-
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:
getScriptsin interfaceNodePackageOptions
-
getStability
public final String getStability()
Description copied from interface:NodePackageOptions(experimental) Package's Stability.- Specified by:
getStabilityin interfaceNodePackageOptions
-
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:
getYarnBerryOptionsin interfaceNodePackageOptions
-
getJsiiReleaseVersion
public final String getJsiiReleaseVersion()
Description copied from interface:ReleaseProjectOptions(experimental) Version requirement ofpublibwhich is used to publish modules to npm.Default: "latest"
- Specified by:
getJsiiReleaseVersionin interfaceReleaseProjectOptions
-
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:
getMajorVersionin interfaceReleaseProjectOptions
-
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:
getMinMajorVersionin interfaceReleaseProjectOptions
-
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
npmDistTagproperty for each branch.Default: "latest"
- Specified by:
getNpmDistTagin interfaceReleaseProjectOptions
-
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:
getPostBuildStepsin interfaceReleaseProjectOptions
-
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:
getPrereleasein interfaceReleaseProjectOptions
-
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:
getPublishDryRunin interfaceReleaseProjectOptions
-
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:
getPublishTasksin interfaceReleaseProjectOptions
-
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:
getReleasableCommitsin interfaceReleaseProjectOptions
-
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
majorVersionfield 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:
getReleaseBranchesin interfaceReleaseProjectOptions
-
getReleaseEveryCommit
public final Boolean getReleaseEveryCommit()
Description copied from interface:ReleaseProjectOptions(deprecated) Automatically release new versions every commit to one of branches inreleaseBranches.Default: true
- Specified by:
getReleaseEveryCommitin interfaceReleaseProjectOptions
-
getReleaseFailureIssue
public final Boolean getReleaseFailureIssue()
Description copied from interface:ReleaseProjectOptions(experimental) Create a github issue on every failed publishing task.Default: false
- Specified by:
getReleaseFailureIssuein interfaceReleaseProjectOptions
-
getReleaseFailureIssueLabel
public final String getReleaseFailureIssueLabel()
Description copied from interface:ReleaseProjectOptions(experimental) The label to apply to issues indicating publish failures.Only applies if
releaseFailureIssueis true.Default: "failed-release"
- Specified by:
getReleaseFailureIssueLabelin interfaceReleaseProjectOptions
-
getReleaseSchedule
public final String getReleaseSchedule()
Description copied from interface:ReleaseProjectOptions(deprecated) CRON schedule to trigger new releases.Default: - no scheduled releases
- Specified by:
getReleaseSchedulein interfaceReleaseProjectOptions
-
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:
getReleaseTagPrefixin interfaceReleaseProjectOptions
-
getReleaseTrigger
public final ReleaseTrigger getReleaseTrigger()
Description copied from interface:ReleaseProjectOptions(experimental) The release trigger to use.Default: - Continuous releases (`ReleaseTrigger.continuous()`)
- Specified by:
getReleaseTriggerin interfaceReleaseProjectOptions
-
getReleaseWorkflowName
public final String getReleaseWorkflowName()
Description copied from interface:ReleaseProjectOptions(experimental) The name of the default release workflow.Default: "release"
- Specified by:
getReleaseWorkflowNamein interfaceReleaseProjectOptions
-
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:
getReleaseWorkflowSetupStepsin interfaceReleaseProjectOptions
-
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:
getVersionrcOptionsin interfaceReleaseProjectOptions
-
getWorkflowContainerImage
public final String getWorkflowContainerImage()
Description copied from interface:ReleaseProjectOptions(experimental) Container image to use for GitHub workflows.Default: - default image
- Specified by:
getWorkflowContainerImagein interfaceReleaseProjectOptions
-
getWorkflowRunsOn
public final List<String> getWorkflowRunsOn()
Description copied from interface:ReleaseProjectOptions(experimental) Github Runner selection labels.Default: ["ubuntu-latest"]
- Specified by:
getWorkflowRunsOnin interfaceReleaseProjectOptions
-
getWorkflowRunsOnGroup
public final GroupRunnerOptions getWorkflowRunsOnGroup()
Description copied from interface:ReleaseProjectOptions(experimental) Github Runner Group selection options.- Specified by:
getWorkflowRunsOnGroupin interfaceReleaseProjectOptions
-
getCdkVersion
public final String getCdkVersion()
Description copied from interface:AwsCdkDepsCommonOptions(experimental) Minimum version of the AWS CDK to depend on.Default: "2.1.0"
- Specified by:
getCdkVersionin interfaceAwsCdkDepsCommonOptions
-
getCdkAssert
public final Boolean getCdkAssert()
Description copied from interface:AwsCdkDepsCommonOptions(deprecated) Warning: NodeJS only.Install the
Default: - will be included by default for AWS CDK >= 1.0.0 < 2.0.0
- Specified by:
getCdkAssertin interfaceAwsCdkDepsCommonOptions
-
getCdkAssertions
public final Boolean getCdkAssertions()
Description copied from interface:AwsCdkDepsCommonOptions(experimental) Install the assertions library?Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib'
Default: - will be included by default for AWS CDK >= 1.111.0 < 2.0.0
- Specified by:
getCdkAssertionsin interfaceAwsCdkDepsCommonOptions
-
getCdkDependencies
public final List<String> getCdkDependencies()
Description copied from interface:AwsCdkDepsCommonOptions(deprecated) Which AWS CDKv1 modules this project requires.- Specified by:
getCdkDependenciesin interfaceAwsCdkDepsCommonOptions
-
getCdkDependenciesAsDeps
public final Boolean getCdkDependenciesAsDeps()
Description copied from interface:AwsCdkDepsCommonOptions(deprecated) If this is enabled (default), all modules declared incdkDependencieswill be also added as normaldependencies(as well aspeerDependencies).This is to ensure that downstream consumers actually have your CDK dependencies installed when using npm < 7 or yarn, where peer dependencies are not automatically installed. If this is disabled,
cdkDependencieswill be added todevDependenciesto ensure they are present during development.Note: this setting only applies to construct library projects
Default: true
- Specified by:
getCdkDependenciesAsDepsin interfaceAwsCdkDepsCommonOptions
-
getCdkTestDependencies
public final List<String> getCdkTestDependencies()
Description copied from interface:AwsCdkDepsCommonOptions(deprecated) AWS CDK modules required for testing.- Specified by:
getCdkTestDependenciesin interfaceAwsCdkDepsCommonOptions
-
getCdkVersionPinning
public final Boolean getCdkVersionPinning()
Description copied from interface:AwsCdkDepsCommonOptions(experimental) Use pinned version instead of caret version for CDK.You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.
- Specified by:
getCdkVersionPinningin interfaceAwsCdkDepsCommonOptions
-
getConstructsVersion
public final String getConstructsVersion()
Description copied from interface:AwsCdkDepsCommonOptions(experimental) Minimum version of theconstructslibrary to depend on.Default: - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
- Specified by:
getConstructsVersionin interfaceAwsCdkDepsCommonOptions
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
-