@Stability(value=Experimental) @Internal public static final class TypeScriptProjectOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements TypeScriptProjectOptions
TypeScriptProjectOptionssoftware.amazon.jsii.JsiiObject.InitializationModeTypeScriptProjectOptions.Builder, TypeScriptProjectOptions.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
protected |
Jsii$Proxy(TypeScriptProjectOptions.Builder builder)
Constructor that initializes the object based on literal property values passed by the
TypeScriptProjectOptions.Builder. |
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
Boolean |
getAllowLibraryDependencies()
(experimental) Allow the project to include `peerDependencies` and `bundledDependencies`.
|
Boolean |
getAntitamper()
(experimental) Checks that after build there are no modified files on git.
|
String |
getArtifactsDirectory()
(experimental) A directory which will contain artifacts to be published to npm.
|
String |
getAuthorEmail()
(experimental) Author's e-mail.
|
String |
getAuthorName()
(experimental) Author's name.
|
Boolean |
getAuthorOrganization()
(experimental) Author's Organization.
|
String |
getAuthorUrl()
(experimental) Author's URL / Website.
|
AutoApproveOptions |
getAutoApproveOptions()
(experimental) Enable and configure the 'auto approve' workflow.
|
Boolean |
getAutoApproveProjenUpgrades()
(experimental) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).
|
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.
|
AutoMergeOptions |
getAutoMergeOptions()
(experimental) Configure options for automatic merging on GitHub.
|
Map<String,String> |
getBin()
(experimental) Binary programs vended with your module.
|
Boolean |
getBuildWorkflow()
(experimental) Define a GitHub workflow for building PRs.
|
List<String> |
getBundledDeps()
(experimental) List of dependencies to bundle into this module.
|
BundlerOptions |
getBundlerOptions()
(experimental) Options for `Bundler`.
|
Boolean |
getClobber()
(experimental) Add a `clobber` task which resets the repo to origin.
|
CodeArtifactOptions |
getCodeArtifactOptions()
(experimental) Options for publishing npm package to AWS CodeArtifact.
|
Boolean |
getCodeCov()
(experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos.
|
String |
getCodeCovTokenSecret()
(experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
|
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 github workflows to handle dependency upgrades.
|
UpgradeDependenciesOptions |
getDepsUpgradeOptions()
(experimental) Options for depsUpgrade.
|
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 |
getDocgen()
(experimental) Docgen by Typedoc.
|
String |
getDocsDirectory()
(experimental) Docs directory.
|
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.
|
Boolean |
getGithub()
(experimental) Enable GitHub integration.
|
GitHubOptions |
getGithubOptions()
(experimental) Options for GitHub integration.
|
List<String> |
getGitignore()
(experimental) Additional entries to .gitignore.
|
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 `jsii-release` which is used to publish modules to npm.
|
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.
|
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.
|
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 `yarn package` command that will produce a tarball and place it under `dist/js`.
|
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.
|
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.
|
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.
|
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).
|
ProjenrcOptions |
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.
|
Boolean |
getProjenUpgradeAutoMerge()
(deprecated) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).
|
List<String> |
getProjenUpgradeSchedule()
(experimental) Customize the projenUpgrade schedule in cron expression.
|
String |
getProjenUpgradeSecret()
(experimental) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).
|
String |
getProjenVersion()
(experimental) Version of projen to install.
|
Boolean |
getPublishTasks()
(experimental) Define publishing tasks that can be executed manually as well as workflows.
|
Boolean |
getPullRequestTemplate()
(experimental) Include a GitHub pull request template.
|
List<String> |
getPullRequestTemplateContents()
(experimental) The contents of the pull request template.
|
SampleReadmeProps |
getReadme()
(experimental) The README setup.
|
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.
|
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.
|
Boolean |
getSampleCode()
(experimental) Generate one-time sample in `src/` and `test/` if there are no files there.
|
Map<String,String> |
getScripts()
(experimental) 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.
|
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<Object> |
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.
|
List<String> |
getWorkflowRunsOn()
(experimental) Github Runner selection labels.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(TypeScriptProjectOptions.Builder builder)
TypeScriptProjectOptions.Builder.public final Boolean getDisableTsconfig()
TypeScriptProjectOptionsDefault: false
getDisableTsconfig in interface TypeScriptProjectOptionspublic final Boolean getDocgen()
TypeScriptProjectOptionsDefault: false
getDocgen in interface TypeScriptProjectOptionspublic final String getDocsDirectory()
TypeScriptProjectOptionsDefault: "docs"
getDocsDirectory in interface TypeScriptProjectOptionspublic final String getEntrypointTypes()
TypeScriptProjectOptionsDefault: - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
getEntrypointTypes in interface TypeScriptProjectOptionspublic final Boolean getEslint()
TypeScriptProjectOptionsDefault: true
getEslint in interface TypeScriptProjectOptionspublic final EslintOptions getEslintOptions()
TypeScriptProjectOptionsDefault: - opinionated default options
getEslintOptions in interface TypeScriptProjectOptionspublic final String getLibdir()
TypeScriptProjectOptionsDefault: "lib"
getLibdir in interface TypeScriptProjectOptionspublic final Boolean getPackageValue()
TypeScriptProjectOptionsDefault: true
getPackageValue in interface TypeScriptProjectOptionspublic final Boolean getProjenrcTs()
TypeScriptProjectOptionsDefault: false
getProjenrcTs in interface TypeScriptProjectOptionspublic final ProjenrcOptions getProjenrcTsOptions()
TypeScriptProjectOptionsgetProjenrcTsOptions in interface TypeScriptProjectOptionspublic final Boolean getSampleCode()
TypeScriptProjectOptionsDefault: true
getSampleCode in interface TypeScriptProjectOptionspublic final String getSrcdir()
TypeScriptProjectOptionsDefault: "src"
getSrcdir in interface TypeScriptProjectOptionspublic final String getTestdir()
TypeScriptProjectOptions
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"
getTestdir in interface TypeScriptProjectOptionspublic final TypescriptConfigOptions getTsconfig()
TypeScriptProjectOptionsDefault: - default options
getTsconfig in interface TypeScriptProjectOptionspublic final TypescriptConfigOptions getTsconfigDev()
TypeScriptProjectOptionsDefault: - use the production tsconfig options
getTsconfigDev in interface TypeScriptProjectOptionspublic final String getTsconfigDevFile()
TypeScriptProjectOptionsDefault: "tsconfig.dev.json"
getTsconfigDevFile in interface TypeScriptProjectOptionspublic final String getTypescriptVersion()
TypeScriptProjectOptions
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"
getTypescriptVersion in interface TypeScriptProjectOptionspublic final String getDefaultReleaseBranch()
NodeProjectOptionsDefault: "main"
getDefaultReleaseBranch in interface NodeProjectOptionspublic final Boolean getAutoApproveProjenUpgrades()
NodeProjectOptions
Throw if set to true but autoApproveOptions are not defined.
Default: false
getAutoApproveProjenUpgrades in interface NodeProjectOptionspublic final Boolean getAutoApproveUpgrades()
NodeProjectOptions
Throw if set to true but autoApproveOptions are not defined.
Default: - true
getAutoApproveUpgrades in interface NodeProjectOptionspublic final Boolean getBuildWorkflow()
NodeProjectOptionsDefault: - true if not a subproject
getBuildWorkflow in interface NodeProjectOptionspublic final BundlerOptions getBundlerOptions()
NodeProjectOptionsgetBundlerOptions in interface NodeProjectOptionspublic final Boolean getCodeCov()
NodeProjectOptionsDefault: false
getCodeCov in interface NodeProjectOptionspublic final String getCodeCovTokenSecret()
NodeProjectOptionsDefault: - if this option is not specified, only public repositories are supported
getCodeCovTokenSecret in interface NodeProjectOptionspublic final String getCopyrightOwner()
NodeProjectOptionsDefault: - defaults to the value of authorName or "" if `authorName` is undefined.
getCopyrightOwner in interface NodeProjectOptionspublic final String getCopyrightPeriod()
NodeProjectOptionsDefault: - current year
getCopyrightPeriod in interface NodeProjectOptionspublic final Boolean getDependabot()
NodeProjectOptions
Cannot be used in conjunction with depsUpgrade.
Default: false
getDependabot in interface NodeProjectOptionspublic final DependabotOptions getDependabotOptions()
NodeProjectOptionsDefault: - default options
getDependabotOptions in interface NodeProjectOptionspublic final Boolean getDepsUpgrade()
NodeProjectOptions
Cannot be used in conjunction with dependabot.
Default: true
getDepsUpgrade in interface NodeProjectOptionspublic final UpgradeDependenciesOptions getDepsUpgradeOptions()
NodeProjectOptionsDefault: - default options
getDepsUpgradeOptions in interface NodeProjectOptionspublic final List<String> getGitignore()
NodeProjectOptionsgetGitignore in interface NodeProjectOptionspublic final Boolean getJest()
NodeProjectOptionsDefault: true
getJest in interface NodeProjectOptionspublic final JestOptions getJestOptions()
NodeProjectOptionsDefault: - default options
getJestOptions in interface NodeProjectOptionspublic final Boolean getMutableBuild()
NodeProjectOptionsThis 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
getMutableBuild in interface NodeProjectOptionspublic final List<String> getNpmignore()
NodeProjectOptionsgetNpmignore in interface NodeProjectOptionspublic final Boolean getNpmignoreEnabled()
NodeProjectOptionsDefault: true
getNpmignoreEnabled in interface NodeProjectOptionspublic final Boolean getProjenDevDependency()
NodeProjectOptionsDefault: true
getProjenDevDependency in interface NodeProjectOptionspublic final Boolean getProjenrcJs()
NodeProjectOptionsDefault: - true if projenrcJson is false
getProjenrcJs in interface NodeProjectOptionspublic final ProjenrcOptions getProjenrcJsOptions()
NodeProjectOptionsDefault: - default options
getProjenrcJsOptions in interface NodeProjectOptionspublic final Boolean getProjenUpgradeAutoMerge()
NodeProjectOptions
Throw if set to true but autoApproveOptions are not defined.
Default: false
getProjenUpgradeAutoMerge in interface NodeProjectOptionspublic final List<String> getProjenUpgradeSchedule()
NodeProjectOptionsDefault: [ "0 6 * * *" ]
getProjenUpgradeSchedule in interface NodeProjectOptionspublic final String getProjenUpgradeSecret()
NodeProjectOptions
This setting is a GitHub secret name which contains a GitHub Access Token
with repo and workflow permissions.
This token is used to submit the upgrade pull request, which will likely include workflow updates.
To create a personal access token see https://github.com/settings/tokens
Default: - no automatic projen upgrade pull requests
getProjenUpgradeSecret in interface NodeProjectOptionspublic final String getProjenVersion()
NodeProjectOptionsDefault: - Defaults to the latest version.
getProjenVersion in interface NodeProjectOptionspublic final Boolean getPullRequestTemplate()
NodeProjectOptionsDefault: true
getPullRequestTemplate in interface NodeProjectOptionspublic final List<String> getPullRequestTemplateContents()
NodeProjectOptionsDefault: - default content
getPullRequestTemplateContents in interface NodeProjectOptionspublic final Boolean getRelease()
NodeProjectOptionsDefault: - true (false for subprojects)
getRelease in interface NodeProjectOptionspublic final Boolean getReleaseToNpm()
NodeProjectOptionsDefault: false
getReleaseToNpm in interface NodeProjectOptionspublic final Boolean getReleaseWorkflow()
NodeProjectOptionsDefault: - true if not a subproject
getReleaseWorkflow in interface NodeProjectOptionspublic final List<Object> getWorkflowBootstrapSteps()
NodeProjectOptionsDefault: "yarn install --frozen-lockfile && yarn projen"
getWorkflowBootstrapSteps in interface NodeProjectOptionspublic final GitIdentity getWorkflowGitIdentity()
NodeProjectOptionsDefault: - GitHub Actions
getWorkflowGitIdentity in interface NodeProjectOptionspublic final String getWorkflowNodeVersion()
NodeProjectOptionsDefault: - same as `minNodeVersion`
getWorkflowNodeVersion in interface NodeProjectOptionspublic final AutoApproveOptions getAutoApproveOptions()
GitHubProjectOptionsDefault: - auto approve is disabled
getAutoApproveOptions in interface GitHubProjectOptionspublic final AutoMergeOptions getAutoMergeOptions()
GitHubProjectOptions
Has no effect if
github.mergify is set to false.
Default: - see defaults in `AutoMergeOptions`
getAutoMergeOptions in interface GitHubProjectOptionspublic final Boolean getClobber()
GitHubProjectOptionsDefault: true
getClobber in interface GitHubProjectOptionspublic final Boolean getDevContainer()
GitHubProjectOptionsDefault: false
getDevContainer in interface GitHubProjectOptionspublic final Boolean getGithub()
GitHubProjectOptionsEnabled by default for root projects. Disabled for non-root projects.
Default: true
getGithub in interface GitHubProjectOptionspublic final GitHubOptions getGithubOptions()
GitHubProjectOptionsDefault: - see GitHubOptions
getGithubOptions in interface GitHubProjectOptionspublic final Boolean getGitpod()
GitHubProjectOptionsDefault: false
getGitpod in interface GitHubProjectOptionspublic final Boolean getMergify()
GitHubProjectOptionsDefault: true
getMergify in interface GitHubProjectOptionspublic final MergifyOptions getMergifyOptions()
GitHubProjectOptionsDefault: - default options
getMergifyOptions in interface GitHubProjectOptionspublic final ProjectType getProjectType()
GitHubProjectOptionsDefault: ProjectType.UNKNOWN
getProjectType in interface GitHubProjectOptionspublic final SampleReadmeProps getReadme()
GitHubProjectOptionsDefault: - { filename: 'README.md', contents: '# replace this' }
Example:
// Example automatically generated from non-compiling source. May contain errors.
"{ filename: 'readme.md', contents: '# title' }"
getReadme in interface GitHubProjectOptionspublic final Boolean getStale()
GitHubProjectOptions
See staleOptions for options.
Default: true
getStale in interface GitHubProjectOptionspublic final StaleOptions getStaleOptions()
GitHubProjectOptions
To disable set stale to false.
Default: - see defaults in `StaleOptions`
getStaleOptions in interface GitHubProjectOptionspublic final Boolean getVscode()
GitHubProjectOptionsEnabled by default for root projects. Disabled for non-root projects.
Default: true
getVscode in interface GitHubProjectOptionspublic final String getName()
ProjectOptionsDefault: $BASEDIR
getName in interface ProjectOptionspublic final LoggerOptions getLogging()
ProjectOptionsDefault: {}
getLogging in interface ProjectOptionspublic final String getOutdir()
ProjectOptionsRelative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects.
Default: "."
getOutdir in interface ProjectOptionspublic final Project getParent()
ProjectOptionsgetParent in interface ProjectOptionspublic final String getProjenCommand()
ProjectOptionsCan be used to customize in special environments.
Default: "npx projen"
getProjenCommand in interface ProjectOptionspublic final Boolean getProjenrcJson()
ProjectOptionsDefault: false
getProjenrcJson in interface ProjectOptionspublic final ProjenrcOptions getProjenrcJsonOptions()
ProjectOptionsDefault: - default options
getProjenrcJsonOptions in interface ProjectOptionspublic final Boolean getAllowLibraryDependencies()
NodePackageOptionsThis is normally only allowed for libraries. For apps, there's no meaning for specifying these.
Default: true
getAllowLibraryDependencies in interface NodePackageOptionspublic final String getAuthorEmail()
NodePackageOptionsgetAuthorEmail in interface NodePackageOptionspublic final String getAuthorName()
NodePackageOptionsgetAuthorName in interface NodePackageOptionspublic final Boolean getAuthorOrganization()
NodePackageOptionsgetAuthorOrganization in interface NodePackageOptionspublic final String getAuthorUrl()
NodePackageOptionsgetAuthorUrl in interface NodePackageOptionspublic final Boolean getAutoDetectBin()
NodePackageOptionsDefault: true
getAutoDetectBin in interface NodePackageOptionspublic final Map<String,String> getBin()
NodePackageOptions
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.
getBin in interface NodePackageOptionspublic final List<String> getBundledDeps()
NodePackageOptions
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.
getBundledDeps in interface NodePackageOptionspublic final CodeArtifactOptions getCodeArtifactOptions()
NodePackageOptionsDefault: - undefined
getCodeArtifactOptions in interface NodePackageOptionspublic final List<String> getDeps()
NodePackageOptions
The recommendation is to only specify the module name here (e.g.
express). This will behave similar to yarn add or npm install in the
sense that it will add the module as a dependency to your package.json
file with the latest version (^). You can specify semver requirements in
the same syntax passed to npm i or yarn add (e.g. express@^2) and
this will be what you package.json will eventually include.
Default: []
Example:
// Example automatically generated from non-compiling source. May contain errors. [ 'express', 'lodash', 'foo@^2' ]
getDeps in interface NodePackageOptionspublic final String getDescription()
NodePackageOptionsIt can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
getDescription in interface NodePackageOptionspublic final List<String> getDevDeps()
NodePackageOptionsThese dependencies will only be available in your build environment but will not be fetched when this module is consumed.
The recommendation is to only specify the module name here (e.g.
express). This will behave similar to yarn add or npm install in the
sense that it will add the module as a dependency to your package.json
file with the latest version (^). You can specify semver requirements in
the same syntax passed to npm i or yarn add (e.g. express@^2) and
this will be what you package.json will eventually include.
Default: []
Example:
// Example automatically generated from non-compiling source. May contain errors. [ 'typescript', '@types/express' ]
getDevDeps in interface NodePackageOptionspublic final String getEntrypoint()
NodePackageOptions
Set to an empty string to not include main in your package.json
Default: "lib/index.js"
getEntrypoint in interface NodePackageOptionspublic final String getHomepage()
NodePackageOptionsgetHomepage in interface NodePackageOptionspublic final List<String> getKeywords()
NodePackageOptionsgetKeywords in interface NodePackageOptionspublic final String getLicense()
NodePackageOptions
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"
getLicense in interface NodePackageOptionspublic final Boolean getLicensed()
NodePackageOptionsDefault: true
getLicensed in interface NodePackageOptionspublic final String getMaxNodeVersion()
NodePackageOptionsDefault: - no max
getMaxNodeVersion in interface NodePackageOptionspublic final String getMinNodeVersion()
NodePackageOptionsDefault: - no "engines" specified
getMinNodeVersion in interface NodePackageOptionspublic final NpmAccess getNpmAccess()
NodePackageOptionsDefault: - for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
getNpmAccess in interface NodePackageOptionspublic final String getNpmRegistry()
NodePackageOptions
Cannot be set together with npmRegistryUrl.
getNpmRegistry in interface NodePackageOptionspublic final String getNpmRegistryUrl()
NodePackageOptionsMust be a URL (e.g. start with "https://" or "http://")
Default: "https://registry.npmjs.org"
getNpmRegistryUrl in interface NodePackageOptionspublic final String getNpmTokenSecret()
NodePackageOptionsDefault: "NPM_TOKEN"
getNpmTokenSecret in interface NodePackageOptionspublic final NodePackageManager getPackageManager()
NodePackageOptionsDefault: NodePackageManager.YARN
getPackageManager in interface NodePackageOptionspublic final String getPackageName()
NodePackageOptionsDefault: - defaults to project name
getPackageName in interface NodePackageOptionspublic final PeerDependencyOptions getPeerDependencyOptions()
NodePackageOptionsgetPeerDependencyOptions in interface NodePackageOptionspublic final List<String> getPeerDeps()
NodePackageOptions
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: []
getPeerDeps in interface NodePackageOptionspublic final String getRepository()
NodePackageOptionsSee https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
getRepository in interface NodePackageOptionspublic final String getRepositoryDirectory()
NodePackageOptionsgetRepositoryDirectory in interface NodePackageOptionspublic final Map<String,String> getScripts()
NodePackageOptionsIf a script has the same name as a standard script, the standard script will be overwritten.
Default: {}
getScripts in interface NodePackageOptionspublic final String getStability()
NodePackageOptionsgetStability in interface NodePackageOptionspublic final Boolean getAntitamper()
ReleaseProjectOptionsDefault: true
getAntitamper in interface ReleaseProjectOptionspublic final String getArtifactsDirectory()
ReleaseProjectOptionsDefault: "dist"
getArtifactsDirectory in interface ReleaseProjectOptionspublic final String getJsiiReleaseVersion()
ReleaseProjectOptionsDefault: "latest"
getJsiiReleaseVersion in interface ReleaseProjectOptionspublic final Number getMajorVersion()
ReleaseProjectOptionsIf 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.
getMajorVersion in interface ReleaseProjectOptionspublic final String getNpmDistTag()
ReleaseProjectOptions
To set the npm dist-tag for release branches, set the npmDistTag property
for each branch.
Default: "latest"
getNpmDistTag in interface ReleaseProjectOptionspublic final List<JobStep> getPostBuildSteps()
ReleaseProjectOptionsDefault: []
getPostBuildSteps in interface ReleaseProjectOptionspublic final String getPrerelease()
ReleaseProjectOptionsDefault: - normal semantic versions
getPrerelease in interface ReleaseProjectOptionspublic final Boolean getPublishTasks()
ReleaseProjectOptionsNormally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.
Default: false
getPublishTasks in interface ReleaseProjectOptionspublic final Map<String,BranchOptions> getReleaseBranches()
ReleaseProjectOptions
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.
getReleaseBranches in interface ReleaseProjectOptionspublic final Boolean getReleaseEveryCommit()
ReleaseProjectOptionsDefault: true
getReleaseEveryCommit in interface ReleaseProjectOptionspublic final Boolean getReleaseFailureIssue()
ReleaseProjectOptionsDefault: false
getReleaseFailureIssue in interface ReleaseProjectOptionspublic final String getReleaseFailureIssueLabel()
ReleaseProjectOptions
Only applies if releaseFailureIssue is true.
Default: "failed-release"
getReleaseFailureIssueLabel in interface ReleaseProjectOptionspublic final String getReleaseSchedule()
ReleaseProjectOptionsDefault: - no scheduled releases
getReleaseSchedule in interface ReleaseProjectOptionspublic final String getReleaseTagPrefix()
ReleaseProjectOptionsNote: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix.
Default: - no prefix
getReleaseTagPrefix in interface ReleaseProjectOptionspublic final ReleaseTrigger getReleaseTrigger()
ReleaseProjectOptionsDefault: - Continuous releases (`ReleaseTrigger.continuous()`)
getReleaseTrigger in interface ReleaseProjectOptionspublic final String getReleaseWorkflowName()
ReleaseProjectOptionsDefault: "Release"
getReleaseWorkflowName in interface ReleaseProjectOptionspublic final List<JobStep> getReleaseWorkflowSetupSteps()
ReleaseProjectOptionsgetReleaseWorkflowSetupSteps in interface ReleaseProjectOptionspublic final Map<String,Object> getVersionrcOptions()
ReleaseProjectOptionsGiven values either append to default configuration or overwrite values in it.
Default: - standard configuration applicable for GitHub repositories
getVersionrcOptions in interface ReleaseProjectOptionspublic final String getWorkflowContainerImage()
ReleaseProjectOptionsDefault: - default image
getWorkflowContainerImage in interface ReleaseProjectOptionspublic final List<String> getWorkflowRunsOn()
ReleaseProjectOptionsDefault: ["ubuntu-latest"]
getWorkflowRunsOn in interface ReleaseProjectOptions@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2021. All rights reserved.