Skip to content

API Reference

Constructs

CloudscapeReactTsWebsiteProject

Synthesizes a Cloudscape React Typescript Website Project.

Initializers 

import software.aws.pdk.cloudscape_react_ts_website.CloudscapeReactTsWebsiteProject;

CloudscapeReactTsWebsiteProject.Builder.create()
    .name(java.lang.String)
//  .allowLibraryDependencies(java.lang.Boolean)
//  .artifactsDirectory(java.lang.String)
//  .authorEmail(java.lang.String)
//  .authorName(java.lang.String)
//  .authorOrganization(java.lang.Boolean)
//  .authorUrl(java.lang.String)
//  .autoApproveOptions(AutoApproveOptions)
//  .autoApproveUpgrades(java.lang.Boolean)
//  .autoDetectBin(java.lang.Boolean)
//  .autoMerge(java.lang.Boolean)
//  .autoMergeOptions(AutoMergeOptions)
//  .bin(java.util.Map<java.lang.String, java.lang.String>)
//  .bugsEmail(java.lang.String)
//  .bugsUrl(java.lang.String)
//  .buildWorkflow(java.lang.Boolean)
//  .buildWorkflowOptions(BuildWorkflowOptions)
//  .buildWorkflowTriggers(Triggers)
//  .bundledDeps(java.util.List<java.lang.String>)
//  .bundlerOptions(BundlerOptions)
//  .checkLicenses(LicenseCheckerOptions)
//  .clobber(java.lang.Boolean)
//  .codeArtifactOptions(CodeArtifactOptions)
//  .codeCov(java.lang.Boolean)
//  .codeCovTokenSecret(java.lang.String)
//  .commitGenerated(java.lang.Boolean)
//  .copyrightOwner(java.lang.String)
//  .copyrightPeriod(java.lang.String)
//  .defaultReleaseBranch(java.lang.String)
//  .dependabot(java.lang.Boolean)
//  .dependabotOptions(DependabotOptions)
//  .deps(java.util.List<java.lang.String>)
//  .depsUpgrade(java.lang.Boolean)
//  .depsUpgradeOptions(UpgradeDependenciesOptions)
//  .description(java.lang.String)
//  .devContainer(java.lang.Boolean)
//  .devDeps(java.util.List<java.lang.String>)
//  .disableTsconfig(java.lang.Boolean)
//  .disableTsconfigDev(java.lang.Boolean)
//  .docgen(java.lang.Boolean)
//  .docsDirectory(java.lang.String)
//  .entrypoint(java.lang.String)
//  .entrypointTypes(java.lang.String)
//  .eslint(java.lang.Boolean)
//  .eslintOptions(EslintOptions)
//  .github(java.lang.Boolean)
//  .githubOptions(GitHubOptions)
//  .gitignore(java.util.List<java.lang.String>)
//  .gitIgnoreOptions(IgnoreFileOptions)
//  .gitOptions(GitOptions)
//  .gitpod(java.lang.Boolean)
//  .homepage(java.lang.String)
//  .jest(java.lang.Boolean)
//  .jestOptions(JestOptions)
//  .jsiiReleaseVersion(java.lang.String)
//  .keywords(java.util.List<java.lang.String>)
//  .libdir(java.lang.String)
//  .license(java.lang.String)
//  .licensed(java.lang.Boolean)
//  .logging(LoggerOptions)
//  .majorVersion(java.lang.Number)
//  .maxNodeVersion(java.lang.String)
//  .mergify(java.lang.Boolean)
//  .mergifyOptions(MergifyOptions)
//  .minMajorVersion(java.lang.Number)
//  .minNodeVersion(java.lang.String)
//  .mutableBuild(java.lang.Boolean)
//  .npmAccess(NpmAccess)
//  .npmDistTag(java.lang.String)
//  .npmignore(java.util.List<java.lang.String>)
//  .npmignoreEnabled(java.lang.Boolean)
//  .npmIgnoreOptions(IgnoreFileOptions)
//  .npmProvenance(java.lang.Boolean)
//  .npmRegistry(java.lang.String)
//  .npmRegistryUrl(java.lang.String)
//  .npmTokenSecret(java.lang.String)
//  .outdir(java.lang.String)
//  .package(java.lang.Boolean)
//  .packageManager(NodePackageManager)
//  .packageName(java.lang.String)
//  .parent(Project)
//  .peerDependencyOptions(PeerDependencyOptions)
//  .peerDeps(java.util.List<java.lang.String>)
//  .pnpmVersion(java.lang.String)
//  .postBuildSteps(java.util.List<JobStep>)
//  .prerelease(java.lang.String)
//  .prettier(java.lang.Boolean)
//  .prettierOptions(PrettierOptions)
//  .projectType(ProjectType)
//  .projenCommand(java.lang.String)
//  .projenCredentials(GithubCredentials)
//  .projenDevDependency(java.lang.Boolean)
//  .projenrcJs(java.lang.Boolean)
//  .projenrcJson(java.lang.Boolean)
//  .projenrcJsonOptions(ProjenrcJsonOptions)
//  .projenrcJsOptions(ProjenrcOptions)
//  .projenrcTs(java.lang.Boolean)
//  .projenrcTsOptions(ProjenrcOptions)
//  .projenTokenSecret(java.lang.String)
//  .projenVersion(java.lang.String)
//  .publishDryRun(java.lang.Boolean)
//  .publishTasks(java.lang.Boolean)
//  .pullRequestTemplate(java.lang.Boolean)
//  .pullRequestTemplateContents(java.util.List<java.lang.String>)
//  .readme(SampleReadmeProps)
//  .releasableCommits(ReleasableCommits)
//  .release(java.lang.Boolean)
//  .releaseBranches(java.util.Map<java.lang.String, BranchOptions>)
//  .releaseEveryCommit(java.lang.Boolean)
//  .releaseFailureIssue(java.lang.Boolean)
//  .releaseFailureIssueLabel(java.lang.String)
//  .releaseSchedule(java.lang.String)
//  .releaseTagPrefix(java.lang.String)
//  .releaseToNpm(java.lang.Boolean)
//  .releaseTrigger(ReleaseTrigger)
//  .releaseWorkflow(java.lang.Boolean)
//  .releaseWorkflowName(java.lang.String)
//  .releaseWorkflowSetupSteps(java.util.List<JobStep>)
//  .renovatebot(java.lang.Boolean)
//  .renovatebotOptions(RenovatebotOptions)
//  .repository(java.lang.String)
//  .repositoryDirectory(java.lang.String)
//  .rewire(java.util.Map<java.lang.String, java.lang.Object>)
//  .scopedPackagesOptions(java.util.List<ScopedPackagesOptions>)
//  .scripts(java.util.Map<java.lang.String, java.lang.String>)
//  .srcdir(java.lang.String)
//  .stability(java.lang.String)
//  .stale(java.lang.Boolean)
//  .staleOptions(StaleOptions)
//  .testdir(java.lang.String)
//  .tsconfig(TypescriptConfigOptions)
//  .tsconfigDev(TypescriptConfigOptions)
//  .tsconfigDevFile(java.lang.String)
//  .tsJestOptions(TsJestOptions)
//  .typescriptVersion(java.lang.String)
//  .versionrcOptions(java.util.Map<java.lang.String, java.lang.Object>)
//  .vscode(java.lang.Boolean)
//  .workflowBootstrapSteps(java.util.List<JobStep>)
//  .workflowContainerImage(java.lang.String)
//  .workflowGitIdentity(GitIdentity)
//  .workflowNodeVersion(java.lang.String)
//  .workflowPackageCache(java.lang.Boolean)
//  .workflowRunsOn(java.util.List<java.lang.String>)
//  .workflowRunsOnGroup(GroupRunnerOptions)
//  .yarnBerryOptions(YarnBerryOptions)
//  .allowSignup(java.lang.Boolean)
//  .applicationName(java.lang.String)
//  .publicDir(java.lang.String)
//  .typeSafeApi(TypeSafeApiProject)
//  .typeSafeApis(java.util.List<TypeSafeApiProject>)
//  .typeSafeWebSocketApis(java.util.List<TypeSafeWebSocketApiProject>)
    .build();
Name Type Description
name java.lang.String No description.
allowLibraryDependencies java.lang.Boolean Allow the project to include peerDependencies and bundledDependencies.
artifactsDirectory java.lang.String A directory which will contain build artifacts.
authorEmail java.lang.String Author's e-mail.
authorName java.lang.String Author's name.
authorOrganization java.lang.Boolean Is the author an organization.
authorUrl java.lang.String Author's URL / Website.
autoApproveOptions io.github.cdklabs.projen.github.AutoApproveOptions Enable and configure the 'auto approve' workflow.
autoApproveUpgrades java.lang.Boolean Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
autoDetectBin java.lang.Boolean Automatically add all executables under the bin directory to your package.json file under the bin section.
autoMerge java.lang.Boolean Enable automatic merging on GitHub.
autoMergeOptions io.github.cdklabs.projen.github.AutoMergeOptions Configure options for automatic merging on GitHub.
bin java.util.Map Binary programs vended with your module.
bugsEmail java.lang.String The email address to which issues should be reported.
bugsUrl java.lang.String The url to your project's issue tracker.
buildWorkflow java.lang.Boolean Define a GitHub workflow for building PRs.
buildWorkflowOptions io.github.cdklabs.projen.javascript.BuildWorkflowOptions Options for PR build workflow.
buildWorkflowTriggers io.github.cdklabs.projen.github.workflows.Triggers Build workflow triggers.
bundledDeps java.util.List List of dependencies to bundle into this module.
bundlerOptions io.github.cdklabs.projen.javascript.BundlerOptions Options for Bundler.
checkLicenses io.github.cdklabs.projen.javascript.LicenseCheckerOptions Configure which licenses should be deemed acceptable for use by dependencies.
clobber java.lang.Boolean Add a clobber task which resets the repo to origin.
codeArtifactOptions io.github.cdklabs.projen.javascript.CodeArtifactOptions Options for npm packages using AWS CodeArtifact.
codeCov java.lang.Boolean Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with @codeCovTokenSecret.
codeCovTokenSecret java.lang.String Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
commitGenerated java.lang.Boolean Whether to commit the managed files by default.
copyrightOwner java.lang.String License copyright owner.
copyrightPeriod java.lang.String The copyright years to put in the LICENSE file.
defaultReleaseBranch java.lang.String The name of the main release branch.
dependabot java.lang.Boolean Use dependabot to handle dependency upgrades.
dependabotOptions io.github.cdklabs.projen.github.DependabotOptions Options for dependabot.
deps java.util.List Runtime dependencies of this module.
depsUpgrade java.lang.Boolean Use tasks and github workflows to handle dependency upgrades.
depsUpgradeOptions io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions Options for UpgradeDependencies.
description java.lang.String The description is just a string that helps people understand the purpose of the package.
devContainer java.lang.Boolean Add a VSCode development environment (used for GitHub Codespaces).
devDeps java.util.List Build dependencies for this module.
disableTsconfig java.lang.Boolean Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
disableTsconfigDev java.lang.Boolean Do not generate a tsconfig.dev.json file.
docgen java.lang.Boolean Docgen by Typedoc.
docsDirectory java.lang.String Docs directory.
entrypoint java.lang.String Module entrypoint (main in package.json). Set to an empty string to not include main in your package.json.
entrypointTypes java.lang.String The .d.ts file that includes the type declarations for this module.
eslint java.lang.Boolean Setup eslint.
eslintOptions io.github.cdklabs.projen.javascript.EslintOptions Eslint options.
github java.lang.Boolean Enable GitHub integration.
githubOptions io.github.cdklabs.projen.github.GitHubOptions Options for GitHub integration.
gitignore java.util.List Additional entries to .gitignore.
gitIgnoreOptions io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file.
gitOptions io.github.cdklabs.projen.GitOptions Configuration options for git.
gitpod java.lang.Boolean Add a Gitpod development environment.
homepage java.lang.String Package's Homepage / Website.
jest java.lang.Boolean Setup jest unit tests.
jestOptions io.github.cdklabs.projen.javascript.JestOptions Jest options.
jsiiReleaseVersion java.lang.String Version requirement of publib which is used to publish modules to npm.
keywords java.util.List Keywords to include in package.json.
libdir java.lang.String Typescript artifacts output directory.
license java.lang.String License's SPDX identifier.
licensed java.lang.Boolean Indicates if a license should be added.
logging io.github.cdklabs.projen.LoggerOptions Configure logging options such as verbosity.
majorVersion java.lang.Number Major version to release from the default branch.
maxNodeVersion java.lang.String Minimum node.js version to require via engines (inclusive).
mergify java.lang.Boolean Whether mergify should be enabled on this repository or not.
mergifyOptions io.github.cdklabs.projen.github.MergifyOptions Options for mergify.
minMajorVersion java.lang.Number Minimal Major version to release.
minNodeVersion java.lang.String Minimum Node.js version to require via package.json engines (inclusive).
mutableBuild java.lang.Boolean Automatically update files modified during builds to pull-request branches.
npmAccess io.github.cdklabs.projen.javascript.NpmAccess Access level of the npm package.
npmDistTag java.lang.String The npmDistTag to use when publishing from the default branch.
npmignore java.util.List Additional entries to .npmignore.
npmignoreEnabled java.lang.Boolean Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
npmIgnoreOptions io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .npmignore file.
npmProvenance java.lang.Boolean Should provenance statements be generated when the package is published.
npmRegistry java.lang.String The host name of the npm registry to publish to.
npmRegistryUrl java.lang.String The base URL of the npm package registry.
npmTokenSecret java.lang.String GitHub secret which contains the NPM token to use when publishing packages.
outdir java.lang.String The root directory of the project. Relative to this directory, all files are synthesized.
package java.lang.Boolean Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
packageManager io.github.cdklabs.projen.javascript.NodePackageManager The Node Package Manager used to execute scripts.
packageName java.lang.String The "name" in package.json.
parent io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project.
peerDependencyOptions io.github.cdklabs.projen.javascript.PeerDependencyOptions Options for peerDeps.
peerDeps java.util.List Peer dependencies for this module.
pnpmVersion java.lang.String The version of PNPM to use if using PNPM as a package manager.
postBuildSteps java.util.List Steps to execute after build as part of the release workflow.
prerelease java.lang.String Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
prettier java.lang.Boolean Setup prettier.
prettierOptions io.github.cdklabs.projen.javascript.PrettierOptions Prettier options.
projectType io.github.cdklabs.projen.ProjectType Which type of project this is (library/app).
projenCommand java.lang.String The shell command to use in order to run the projen CLI.
projenCredentials io.github.cdklabs.projen.github.GithubCredentials Choose a method of providing GitHub API access for projen workflows.
projenDevDependency java.lang.Boolean Indicates of "projen" should be installed as a devDependency.
projenrcJs java.lang.Boolean Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
projenrcJson java.lang.Boolean Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
projenrcJsonOptions io.github.cdklabs.projen.ProjenrcJsonOptions Options for .projenrc.json.
projenrcJsOptions io.github.cdklabs.projen.javascript.ProjenrcOptions Options for .projenrc.js.
projenrcTs java.lang.Boolean Use TypeScript for your projenrc file (.projenrc.ts).
projenrcTsOptions io.github.cdklabs.projen.typescript.ProjenrcOptions Options for .projenrc.ts.
projenTokenSecret java.lang.String The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
projenVersion java.lang.String Version of projen to install.
publishDryRun java.lang.Boolean Instead of actually publishing to package managers, just print the publishing command.
publishTasks java.lang.Boolean Define publishing tasks that can be executed manually as well as workflows.
pullRequestTemplate java.lang.Boolean Include a GitHub pull request template.
pullRequestTemplateContents java.util.List The contents of the pull request template.
readme io.github.cdklabs.projen.SampleReadmeProps The README setup.
releasableCommits io.github.cdklabs.projen.ReleasableCommits Find commits that should be considered releasable Used to decide if a release is required.
release java.lang.Boolean Add release management to this project.
releaseBranches java.util.Map Defines additional release branches.
releaseEveryCommit java.lang.Boolean Automatically release new versions every commit to one of branches in releaseBranches.
releaseFailureIssue java.lang.Boolean Create a github issue on every failed publishing task.
releaseFailureIssueLabel java.lang.String The label to apply to issues indicating publish failures.
releaseSchedule java.lang.String CRON schedule to trigger new releases.
releaseTagPrefix java.lang.String Automatically add the given prefix to release tags.
releaseToNpm java.lang.Boolean Automatically release to npm when new versions are introduced.
releaseTrigger io.github.cdklabs.projen.release.ReleaseTrigger The release trigger to use.
releaseWorkflow java.lang.Boolean DEPRECATED: renamed to release.
releaseWorkflowName java.lang.String The name of the default release workflow.
releaseWorkflowSetupSteps java.util.List A set of workflow steps to execute in order to setup the workflow container.
renovatebot java.lang.Boolean Use renovatebot to handle dependency upgrades.
renovatebotOptions io.github.cdklabs.projen.RenovatebotOptions Options for renovatebot.
repository java.lang.String The repository is the location where the actual code for your package lives.
repositoryDirectory java.lang.String 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.
rewire java.util.Map Rewire webpack configuration. Use this property to override webpack configuration properties provided by create-react-app, without needing to eject.
scopedPackagesOptions java.util.List Options for privately hosted scoped packages.
scripts java.util.Map npm scripts to include.
srcdir java.lang.String Typescript sources directory.
stability java.lang.String Package's Stability.
stale java.lang.Boolean Auto-close of stale issues and pull request.
staleOptions io.github.cdklabs.projen.github.StaleOptions Auto-close stale issues and pull requests.
testdir java.lang.String Jest tests directory.
tsconfig io.github.cdklabs.projen.javascript.TypescriptConfigOptions Custom TSConfig.
tsconfigDev io.github.cdklabs.projen.javascript.TypescriptConfigOptions Custom tsconfig options for the development tsconfig.json file (used for testing).
tsconfigDevFile java.lang.String The name of the development tsconfig.json file.
tsJestOptions io.github.cdklabs.projen.typescript.TsJestOptions Options for ts-jest.
typescriptVersion java.lang.String TypeScript version to use.
versionrcOptions java.util.Map Custom configuration used when creating changelog with standard-version package.
vscode java.lang.Boolean Enable VSCode integration.
workflowBootstrapSteps java.util.List Workflow steps to use in order to bootstrap this repo.
workflowContainerImage java.lang.String Container image to use for GitHub workflows.
workflowGitIdentity io.github.cdklabs.projen.github.GitIdentity The git identity to use in workflows.
workflowNodeVersion java.lang.String The node version to use in GitHub workflows.
workflowPackageCache java.lang.Boolean Enable Node.js package cache in GitHub workflows.
workflowRunsOn java.util.List Github Runner selection labels.
workflowRunsOnGroup io.github.cdklabs.projen.GroupRunnerOptions Github Runner Group selection options.
yarnBerryOptions io.github.cdklabs.projen.javascript.YarnBerryOptions Options for Yarn Berry.
allowSignup java.lang.Boolean Whether to enable self sign-up.
applicationName java.lang.String Name of the application name.
publicDir java.lang.String Public directory.
typeSafeApi software.aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject TypeSafeApi instance to use when setting up the initial project sample code.
typeSafeApis java.util.List TypeSafeApi instances to use when setting up the initial project sample code.
typeSafeWebSocketApis java.util.List TypeSafeWebSocketApi instances to use when setting up the initial project sample code.
nameRequired
  • Type: java.lang.String
allowLibraryDependenciesOptional
  • Type: java.lang.Boolean
  • Default: true

Allow the project to include peerDependencies and bundledDependencies.

This is normally only allowed for libraries. For apps, there's no meaning for specifying these.

artifactsDirectoryOptional
  • Type: java.lang.String
  • Default: "dist"

A directory which will contain build artifacts.

authorEmailOptional
  • Type: java.lang.String

Author's e-mail.

authorNameOptional
  • Type: java.lang.String

Author's name.

authorOrganizationOptional
  • Type: java.lang.Boolean

Is the author an organization.

authorUrlOptional
  • Type: java.lang.String

Author's URL / Website.

autoApproveOptionsOptional
  • Type: io.github.cdklabs.projen.github.AutoApproveOptions
  • Default: auto approve is disabled

Enable and configure the 'auto approve' workflow.

autoApproveUpgradesOptional
  • Type: java.lang.Boolean
  • Default: true

Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).

Throw if set to true but autoApproveOptions are not defined.

autoDetectBinOptional
  • Type: java.lang.Boolean
  • Default: true

Automatically add all executables under the bin directory to your package.json file under the bin section.

autoMergeOptional
  • Type: java.lang.Boolean
  • Default: true

Enable automatic merging on GitHub.

Has no effect if github.mergify is set to false.

autoMergeOptionsOptional
  • Type: io.github.cdklabs.projen.github.AutoMergeOptions
  • Default: see defaults in AutoMergeOptions

Configure options for automatic merging on GitHub.

Has no effect if github.mergify or autoMerge is set to false.

binOptional
  • Type: java.util.Map

Binary programs vended with your module.

You can use this option to add/customize how binaries are represented in your package.json, but unless autoDetectBin is false, every executable file under bin will automatically be added to this section.

bugsEmailOptional
  • Type: java.lang.String

The email address to which issues should be reported.

bugsUrlOptional
  • Type: java.lang.String

The url to your project's issue tracker.

buildWorkflowOptional
  • Type: java.lang.Boolean
  • Default: true if not a subproject

Define a GitHub workflow for building PRs.

buildWorkflowOptionsOptional
  • Type: io.github.cdklabs.projen.javascript.BuildWorkflowOptions

Options for PR build workflow.

~~buildWorkflowTriggers~~Optional

  • Deprecated: - Use buildWorkflowOptions.workflowTriggers

  • Type: io.github.cdklabs.projen.github.workflows.Triggers

  • Default: "{ pullRequest: {}, workflowDispatch: {} }"

Build workflow triggers.

bundledDepsOptional
  • Type: java.util.List

List of dependencies to bundle into this module.

These modules will be added both to the dependencies section and bundledDependencies section of your package.json.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

bundlerOptionsOptional
  • Type: io.github.cdklabs.projen.javascript.BundlerOptions

Options for Bundler.

checkLicensesOptional
  • Type: io.github.cdklabs.projen.javascript.LicenseCheckerOptions
  • Default: no license checks are run during the build and all licenses will be accepted

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.

clobberOptional
  • Type: java.lang.Boolean
  • Default: true, but false for subprojects

Add a clobber task which resets the repo to origin.

codeArtifactOptionsOptional
  • Type: io.github.cdklabs.projen.javascript.CodeArtifactOptions
  • Default: undefined

Options for npm packages using AWS CodeArtifact.

This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact

codeCovOptional
  • Type: java.lang.Boolean
  • Default: false

Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with @codeCovTokenSecret.

codeCovTokenSecretOptional
  • Type: java.lang.String
  • Default: if this option is not specified, only public repositories are supported

Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.

commitGeneratedOptional
  • Type: java.lang.Boolean
  • Default: true

Whether to commit the managed files by default.

copyrightOwnerOptional
  • Type: java.lang.String
  • Default: defaults to the value of authorName or "" if authorName is undefined.

License copyright owner.

copyrightPeriodOptional
  • Type: java.lang.String
  • Default: current year

The copyright years to put in the LICENSE file.

defaultReleaseBranchOptional
  • Type: java.lang.String
  • Default: "main"

The name of the main release branch.

dependabotOptional
  • Type: java.lang.Boolean
  • Default: false

Use dependabot to handle dependency upgrades.

Cannot be used in conjunction with depsUpgrade.

dependabotOptionsOptional
  • Type: io.github.cdklabs.projen.github.DependabotOptions
  • Default: default options

Options for dependabot.

depsOptional
  • Type: java.util.List
  • Default: []

Runtime dependencies of this module.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

depsUpgradeOptional
  • Type: java.lang.Boolean
  • Default: true

Use tasks and github workflows to handle dependency upgrades.

Cannot be used in conjunction with dependabot.

depsUpgradeOptionsOptional
  • Type: io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions
  • Default: default options

Options for UpgradeDependencies.

descriptionOptional
  • Type: java.lang.String

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

devContainerOptional
  • Type: java.lang.Boolean
  • Default: false

Add a VSCode development environment (used for GitHub Codespaces).

devDepsOptional
  • Type: java.util.List
  • Default: []

Build dependencies for this module.

These dependencies will only be available in your build environment but will not be fetched when this module is consumed.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

disableTsconfigOptional
  • Type: java.lang.Boolean
  • Default: false

Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).

disableTsconfigDevOptional
  • Type: java.lang.Boolean
  • Default: false

Do not generate a tsconfig.dev.json file.

docgenOptional
  • Type: java.lang.Boolean
  • Default: false

Docgen by Typedoc.

docsDirectoryOptional
  • Type: java.lang.String
  • Default: "docs"

Docs directory.

entrypointOptional
  • Type: java.lang.String
  • Default: "lib/index.js"

Module entrypoint (main in package.json). Set to an empty string to not include main in your package.json.

entrypointTypesOptional
  • Type: java.lang.String
  • Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)

The .d.ts file that includes the type declarations for this module.

eslintOptional
  • Type: java.lang.Boolean
  • Default: true

Setup eslint.

eslintOptionsOptional
  • Type: io.github.cdklabs.projen.javascript.EslintOptions
  • Default: opinionated default options

Eslint options.

githubOptional
  • Type: java.lang.Boolean
  • Default: true

Enable GitHub integration.

Enabled by default for root projects. Disabled for non-root projects.

githubOptionsOptional
  • Type: io.github.cdklabs.projen.github.GitHubOptions
  • Default: see GitHubOptions

Options for GitHub integration.

gitignoreOptional
  • Type: java.util.List

Additional entries to .gitignore.

gitIgnoreOptionsOptional
  • Type: io.github.cdklabs.projen.IgnoreFileOptions

Configuration options for .gitignore file.

gitOptionsOptional
  • Type: io.github.cdklabs.projen.GitOptions

Configuration options for git.

gitpodOptional
  • Type: java.lang.Boolean
  • Default: false

Add a Gitpod development environment.

homepageOptional
  • Type: java.lang.String

Package's Homepage / Website.

jestOptional
  • Type: java.lang.Boolean
  • Default: true

Setup jest unit tests.

jestOptionsOptional
  • Type: io.github.cdklabs.projen.javascript.JestOptions
  • Default: default options

Jest options.

jsiiReleaseVersionOptional
  • Type: java.lang.String
  • Default: "latest"

Version requirement of publib which is used to publish modules to npm.

keywordsOptional
  • Type: java.util.List

Keywords to include in package.json.

libdirOptional
  • Type: java.lang.String
  • Default: "lib"

Typescript artifacts output directory.

licenseOptional
  • Type: java.lang.String
  • Default: "Apache-2.0"

License's SPDX identifier.

See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the licensed option if you want to no license to be specified.

licensedOptional
  • Type: java.lang.Boolean
  • Default: true

Indicates if a license should be added.

loggingOptional
  • Type: io.github.cdklabs.projen.LoggerOptions
  • Default: {}

Configure logging options such as verbosity.

majorVersionOptional
  • Type: java.lang.Number
  • Default: Major version is not enforced.

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.

maxNodeVersionOptional
  • Type: java.lang.String
  • Default: no max

Minimum node.js version to require via engines (inclusive).

~~mergify~~Optional

  • Deprecated: use githubOptions.mergify instead

  • Type: java.lang.Boolean

  • Default: true

Whether mergify should be enabled on this repository or not.

~~mergifyOptions~~Optional

  • Deprecated: use githubOptions.mergifyOptions instead

  • Type: io.github.cdklabs.projen.github.MergifyOptions

  • Default: default options

Options for mergify.

minMajorVersionOptional
  • Type: java.lang.Number
  • Default: No minimum version is being enforced

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.

minNodeVersionOptional
  • Type: java.lang.String
  • Default: no "engines" specified

Minimum Node.js version to require via package.json engines (inclusive).

~~mutableBuild~~Optional

  • Deprecated: - Use buildWorkflowOptions.mutableBuild

  • Type: java.lang.Boolean

  • Default: true

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.

npmAccessOptional
  • Type: io.github.cdklabs.projen.javascript.NpmAccess
  • Default: for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.

Access level of the npm package.

npmDistTagOptional
  • Type: java.lang.String
  • Default: "latest"

The npmDistTag to use when publishing from the default branch.

To set the npm dist-tag for release branches, set the npmDistTag property for each branch.

~~npmignore~~Optional

  • Deprecated: - use project.addPackageIgnore

  • Type: java.util.List

Additional entries to .npmignore.

npmignoreEnabledOptional
  • Type: java.lang.Boolean
  • Default: true

Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.

npmIgnoreOptionsOptional
  • Type: io.github.cdklabs.projen.IgnoreFileOptions

Configuration options for .npmignore file.

npmProvenanceOptional
  • Type: java.lang.Boolean
  • Default: true for public packages, false otherwise

Should provenance statements be generated when the package is published.

A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider.

Note that the projen Release and Publisher components are using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.

~~npmRegistry~~Optional

  • Deprecated: use npmRegistryUrl instead

  • Type: java.lang.String

The host name of the npm registry to publish to.

Cannot be set together with npmRegistryUrl.

npmRegistryUrlOptional

The base URL of the npm package registry.

Must be a URL (e.g. start with "https://" or "http://")

npmTokenSecretOptional
  • Type: java.lang.String
  • Default: "NPM_TOKEN"

GitHub secret which contains the NPM token to use when publishing packages.

outdirOptional
  • Type: java.lang.String
  • Default: "."

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.

packageOptional
  • Type: java.lang.Boolean
  • Default: true

Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).

packageManagerOptional
  • Type: io.github.cdklabs.projen.javascript.NodePackageManager
  • Default: NodePackageManager.YARN_CLASSIC

The Node Package Manager used to execute scripts.

packageNameOptional
  • Type: java.lang.String
  • Default: defaults to project name

The "name" in package.json.

parentOptional
  • Type: io.github.cdklabs.projen.Project

The parent project, if this project is part of a bigger project.

peerDependencyOptionsOptional
  • Type: io.github.cdklabs.projen.javascript.PeerDependencyOptions

Options for peerDeps.

peerDepsOptional
  • Type: java.util.List
  • Default: []

Peer dependencies for this module.

Dependencies listed here are required to be installed (and satisfied) by the consumer of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the node_modules tree of your consumers.

Note that prior to npm@7, peer dependencies are not automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers.

Unless peerDependencyOptions.pinnedDevDependency is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required.

pnpmVersionOptional
  • Type: java.lang.String
  • Default: "7"

The version of PNPM to use if using PNPM as a package manager.

postBuildStepsOptional
  • Type: java.util.List
  • Default: []

Steps to execute after build as part of the release workflow.

prereleaseOptional
  • Type: java.lang.String
  • Default: normal semantic versions

Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

prettierOptional
  • Type: java.lang.Boolean
  • Default: false

Setup prettier.

prettierOptionsOptional
  • Type: io.github.cdklabs.projen.javascript.PrettierOptions
  • Default: default options

Prettier options.

~~projectType~~Optional

  • Deprecated: no longer supported at the base project level

  • Type: io.github.cdklabs.projen.ProjectType

  • Default: ProjectType.UNKNOWN

Which type of project this is (library/app).

projenCommandOptional
  • Type: java.lang.String
  • Default: "npx projen"

The shell command to use in order to run the projen CLI.

Can be used to customize in special environments.

projenCredentialsOptional
  • Type: io.github.cdklabs.projen.github.GithubCredentials
  • Default: use a personal access token named PROJEN_GITHUB_TOKEN

Choose a method of providing GitHub API access for projen workflows.

projenDevDependencyOptional
  • Type: java.lang.Boolean
  • Default: true if not a subproject

Indicates of "projen" should be installed as a devDependency.

projenrcJsOptional
  • Type: java.lang.Boolean
  • Default: true if projenrcJson is false

Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.

projenrcJsonOptional
  • Type: java.lang.Boolean
  • Default: false

Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

projenrcJsonOptionsOptional
  • Type: io.github.cdklabs.projen.ProjenrcJsonOptions
  • Default: default options

Options for .projenrc.json.

projenrcJsOptionsOptional
  • Type: io.github.cdklabs.projen.javascript.ProjenrcOptions
  • Default: default options

Options for .projenrc.js.

projenrcTsOptional
  • Type: java.lang.Boolean
  • Default: false

Use TypeScript for your projenrc file (.projenrc.ts).

projenrcTsOptionsOptional
  • Type: io.github.cdklabs.projen.typescript.ProjenrcOptions

Options for .projenrc.ts.

~~projenTokenSecret~~Optional

  • Deprecated: use projenCredentials

  • Type: java.lang.String

  • Default: "PROJEN_GITHUB_TOKEN"

The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.

This token needs to have the repo, workflows and packages scope.

projenVersionOptional
  • Type: java.lang.String
  • Default: Defaults to the latest version.

Version of projen to install.

publishDryRunOptional
  • Type: java.lang.Boolean
  • Default: false

Instead of actually publishing to package managers, just print the publishing command.

publishTasksOptional
  • Type: java.lang.Boolean
  • Default: false

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.

pullRequestTemplateOptional
  • Type: java.lang.Boolean
  • Default: true

Include a GitHub pull request template.

pullRequestTemplateContentsOptional
  • Type: java.util.List
  • Default: default content

The contents of the pull request template.

readmeOptional
  • Type: io.github.cdklabs.projen.SampleReadmeProps
  • Default: { filename: 'README.md', contents: '# replace this' }

The README setup.

releasableCommitsOptional
  • Type: io.github.cdklabs.projen.ReleasableCommits
  • Default: ReleasableCommits.everyCommit()

Find commits that should be considered releasable Used to decide if a release is required.

releaseOptional
  • Type: java.lang.Boolean
  • Default: true (false for subprojects)

Add release management to this project.

releaseBranchesOptional
  • Type: java.util.Map
  • Default: no additional branches are used for release. you can use addBranch() to add additional branches.

Defines additional release branches.

A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch must be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the majorVersion field must also be provided for the default branch.

~~releaseEveryCommit~~Optional

  • Deprecated: Use releaseTrigger: ReleaseTrigger.continuous() instead

  • Type: java.lang.Boolean

  • Default: true

Automatically release new versions every commit to one of branches in releaseBranches.

releaseFailureIssueOptional
  • Type: java.lang.Boolean
  • Default: false

Create a github issue on every failed publishing task.

releaseFailureIssueLabelOptional
  • Type: java.lang.String
  • Default: "failed-release"

The label to apply to issues indicating publish failures.

Only applies if releaseFailureIssue is true.

~~releaseSchedule~~Optional

  • Deprecated: Use releaseTrigger: ReleaseTrigger.scheduled() instead

  • Type: java.lang.String

  • Default: no scheduled releases

CRON schedule to trigger new releases.

releaseTagPrefixOptional
  • Type: java.lang.String
  • Default: "v"

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.

releaseToNpmOptional
  • Type: java.lang.Boolean
  • Default: false

Automatically release to npm when new versions are introduced.

releaseTriggerOptional
  • Type: io.github.cdklabs.projen.release.ReleaseTrigger
  • Default: Continuous releases (ReleaseTrigger.continuous())

The release trigger to use.

~~releaseWorkflow~~Optional

  • Deprecated: see release.

  • Type: java.lang.Boolean

  • Default: true if not a subproject

DEPRECATED: renamed to release.

releaseWorkflowNameOptional
  • Type: java.lang.String
  • Default: "release"

The name of the default release workflow.

releaseWorkflowSetupStepsOptional
  • Type: java.util.List

A set of workflow steps to execute in order to setup the workflow container.

renovatebotOptional
  • Type: java.lang.Boolean
  • Default: false

Use renovatebot to handle dependency upgrades.

renovatebotOptionsOptional
  • Type: io.github.cdklabs.projen.RenovatebotOptions
  • Default: default options

Options for renovatebot.

repositoryOptional
  • Type: java.lang.String

The repository is the location where the actual code for your package lives.

See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository

repositoryDirectoryOptional
  • Type: java.lang.String

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.

rewireOptional
  • Type: java.util.Map
  • Default: No rewired config.

Rewire webpack configuration. Use this property to override webpack configuration properties provided by create-react-app, without needing to eject.

This property will create a config-overrides.js file in your root directory, which will contain the desired rewiring code.

To override the configuration, you can provide simple key value pairs. Keys take the form of js code directives that traverse to the desired property. Values should be JSON serializable objects.

For example, the following config:

rewire: { "module.unknownContextCritical": false }

Will translate to the following config-overrides.js file:

module.exports = function override(config, env) {
  config.module.unknownContextCritical = false;
}
scopedPackagesOptionsOptional
  • Type: java.util.List
  • Default: fetch all scoped packages from the public npm registry

Options for privately hosted scoped packages.

~~scripts~~Optional

  • Deprecated: use project.addTask() or package.setScript()

  • Type: java.util.Map

  • Default: {}

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.

srcdirOptional
  • Type: java.lang.String
  • Default: "src"

Typescript sources directory.

stabilityOptional
  • Type: java.lang.String

Package's Stability.

staleOptional
  • Type: java.lang.Boolean
  • Default: false

Auto-close of stale issues and pull request.

See staleOptions for options.

staleOptionsOptional
  • Type: io.github.cdklabs.projen.github.StaleOptions
  • Default: see defaults in StaleOptions

Auto-close stale issues and pull requests.

To disable set stale to false.

testdirOptional
  • Type: java.lang.String
  • Default: "test"

Jest tests directory.

Tests files should be named xxx.test.ts. If this directory is under srcdir (e.g. src/test, src/__tests__), then tests are going to be compiled into lib/ and executed as javascript. If the test directory is outside of src, then we configure jest to compile the code in-memory.

tsconfigOptional
  • Type: io.github.cdklabs.projen.javascript.TypescriptConfigOptions
  • Default: default options

Custom TSConfig.

tsconfigDevOptional
  • Type: io.github.cdklabs.projen.javascript.TypescriptConfigOptions
  • Default: use the production tsconfig options

Custom tsconfig options for the development tsconfig.json file (used for testing).

tsconfigDevFileOptional
  • Type: java.lang.String
  • Default: "tsconfig.dev.json"

The name of the development tsconfig.json file.

tsJestOptionsOptional
  • Type: io.github.cdklabs.projen.typescript.TsJestOptions

Options for ts-jest.

typescriptVersionOptional
  • Type: java.lang.String
  • Default: "latest"

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).

versionrcOptionsOptional
  • Type: java.util.Map
  • Default: standard configuration applicable for GitHub repositories

Custom configuration used when creating changelog with standard-version package.

Given values either append to default configuration or overwrite values in it.

vscodeOptional
  • Type: java.lang.Boolean
  • Default: true

Enable VSCode integration.

Enabled by default for root projects. Disabled for non-root projects.

workflowBootstrapStepsOptional
  • Type: java.util.List
  • Default: "yarn install --frozen-lockfile && yarn projen"

Workflow steps to use in order to bootstrap this repo.

workflowContainerImageOptional
  • Type: java.lang.String
  • Default: default image

Container image to use for GitHub workflows.

workflowGitIdentityOptional
  • Type: io.github.cdklabs.projen.github.GitIdentity
  • Default: GitHub Actions

The git identity to use in workflows.

workflowNodeVersionOptional
  • Type: java.lang.String
  • Default: same as minNodeVersion

The node version to use in GitHub workflows.

workflowPackageCacheOptional
  • Type: java.lang.Boolean
  • Default: false

Enable Node.js package cache in GitHub workflows.

workflowRunsOnOptional
  • Type: java.util.List
  • Default: ["ubuntu-latest"]

Github Runner selection labels.

workflowRunsOnGroupOptional
  • Type: io.github.cdklabs.projen.GroupRunnerOptions

Github Runner Group selection options.

yarnBerryOptionsOptional
  • Type: io.github.cdklabs.projen.javascript.YarnBerryOptions
  • Default: Yarn Berry v4 with all default options

Options for Yarn Berry.

allowSignupOptional
  • Type: java.lang.Boolean
  • Default: false

Whether to enable self sign-up.

applicationNameOptional
  • Type: java.lang.String
  • Default: "Sample App"

Name of the application name.

publicDirOptional
  • Type: java.lang.String
  • Default: "public"

Public directory.

~~typeSafeApi~~Optional

  • Deprecated: use typeSafeApis

  • Type: software.aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject

TypeSafeApi instance to use when setting up the initial project sample code.

typeSafeApisOptional
  • Type: java.util.List

TypeSafeApi instances to use when setting up the initial project sample code.

typeSafeWebSocketApisOptional
  • Type: java.util.List

TypeSafeWebSocketApi instances to use when setting up the initial project sample code.

Methods

Name Description
toString Returns a string representation of this construct.
addExcludeFromCleanup Exclude the matching files from pre-synth cleanup.
addGitIgnore Adds a .gitignore pattern.
addPackageIgnore Adds patterns to be ignored by npm.
addTask Adds a new task to this project.
addTip Prints a "tip" message during synthesis.
annotateGenerated Marks the provided file(s) as being generated.
postSynthesize Called after all components are synthesized.
preSynthesize Called before all components are synthesized.
removeTask Removes a task from a project.
runTaskCommand Returns the shell command to execute in order to run a task.
synth Synthesize all project files into outdir.
tryFindFile Finds a file at the specified relative path within this project and all its subprojects.
tryFindJsonFile Finds a json file by name.
tryFindObjectFile Finds an object file (like JsonFile, YamlFile, etc.) by name.
tryRemoveFile Finds a file at the specified relative path within this project and removes it.
addBins No description.
addBundledDeps Defines bundled dependencies.
addCompileCommand DEPRECATED.
addDeps Defines normal dependencies.
addDevDeps Defines development/test dependencies.
addFields Directly set fields in package.json.
addKeywords Adds keywords to package.json (deduplicated).
addPeerDeps Defines peer dependencies.
addScripts Replaces the contents of multiple npm package.json scripts.
addTestCommand DEPRECATED.
hasScript Indicates if a script by the name name is defined.
removeScript Removes the npm script (always successful).
renderWorkflowSetup Returns the set of workflow steps which should be executed to bootstrap a workflow.
setScript Replaces the contents of an npm package.json script.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addExcludeFromCleanup 
public void addExcludeFromCleanup(java.lang.String globs)

Exclude the matching files from pre-synth cleanup.

Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth.

globsRequired
  • Type: java.lang.String

The glob patterns to match.

addGitIgnore 
public void addGitIgnore(java.lang.String pattern)

Adds a .gitignore pattern.

patternRequired
  • Type: java.lang.String

The glob pattern to ignore.

addPackageIgnore 
public void addPackageIgnore(java.lang.String pattern)

Adds patterns to be ignored by npm.

patternRequired
  • Type: java.lang.String

The pattern to ignore.

addTask 
public Task addTask(java.lang.String name)
public Task addTask(java.lang.String name, TaskOptions props)

Adds a new task to this project.

This will fail if the project already has a task with this name.

nameRequired
  • Type: java.lang.String

The task name to add.

propsOptional
  • Type: io.github.cdklabs.projen.TaskOptions

Task properties.

~~addTip~~ 
public void addTip(java.lang.String message)

Prints a "tip" message during synthesis.

messageRequired
  • Type: java.lang.String

The message.

annotateGenerated 
public void annotateGenerated(java.lang.String glob)

Marks the provided file(s) as being generated.

This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown.

https://github.com/github/linguist/blob/master/docs/overrides.md

globRequired
  • Type: java.lang.String

the glob pattern to match (could be a file path).

postSynthesize 
public void postSynthesize()

Called after all components are synthesized.

Order is not guaranteed.

preSynthesize 
public void preSynthesize()

Called before all components are synthesized.

removeTask 
public Task removeTask(java.lang.String name)

Removes a task from a project.

nameRequired
  • Type: java.lang.String

The name of the task to remove.

runTaskCommand 
public java.lang.String runTaskCommand(Task task)

Returns the shell command to execute in order to run a task.

This will typically be npx projen TASK.

taskRequired
  • Type: io.github.cdklabs.projen.Task

The task for which the command is required.

synth 
public void synth()

Synthesize all project files into outdir.

  1. Call "this.preSynthesize()"
  2. Delete all generated files
  3. Synthesize all subprojects
  4. Synthesize all components of this project
  5. Call "postSynthesize()" for all components of this project
  6. Call "this.postSynthesize()"
tryFindFile 
public FileBase tryFindFile(java.lang.String filePath)

Finds a file at the specified relative path within this project and all its subprojects.

filePathRequired
  • Type: java.lang.String

The file path.

If this path is relative, it will be resolved from the root of this project.

~~tryFindJsonFile~~ 
public JsonFile tryFindJsonFile(java.lang.String filePath)

Finds a json file by name.

filePathRequired
  • Type: java.lang.String

The file path.

tryFindObjectFile 
public ObjectFile tryFindObjectFile(java.lang.String filePath)

Finds an object file (like JsonFile, YamlFile, etc.) by name.

filePathRequired
  • Type: java.lang.String

The file path.

tryRemoveFile 
public FileBase tryRemoveFile(java.lang.String filePath)

Finds a file at the specified relative path within this project and removes it.

filePathRequired
  • Type: java.lang.String

The file path.

If this path is relative, it will be resolved from the root of this project.

addBins 
public void addBins(java.util.Map<java.lang.String, java.lang.String> bins)
binsRequired
  • Type: java.util.Map
addBundledDeps 
public void addBundledDeps(java.lang.String deps)

Defines bundled dependencies.

Bundled dependencies will be added as normal dependencies as well as to the bundledDependencies section of your package.json.

depsRequired
  • Type: java.lang.String

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

~~addCompileCommand~~ 
public void addCompileCommand(java.lang.String commands)

DEPRECATED.

commandsRequired
  • Type: java.lang.String
addDeps 
public void addDeps(java.lang.String deps)

Defines normal dependencies.

depsRequired
  • Type: java.lang.String

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

addDevDeps 
public void addDevDeps(java.lang.String deps)

Defines development/test dependencies.

depsRequired
  • Type: java.lang.String

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

addFields 
public void addFields(java.util.Map<java.lang.String, java.lang.Object> fields)

Directly set fields in package.json.

fieldsRequired
  • Type: java.util.Map

The fields to set.

addKeywords 
public void addKeywords(java.lang.String keywords)

Adds keywords to package.json (deduplicated).

keywordsRequired
  • Type: java.lang.String

The keywords to add.

addPeerDeps 
public void addPeerDeps(java.lang.String deps)

Defines peer dependencies.

When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers.

depsRequired
  • Type: java.lang.String

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

addScripts 
public void addScripts(java.util.Map<java.lang.String, java.lang.String> scripts)

Replaces the contents of multiple npm package.json scripts.

scriptsRequired
  • Type: java.util.Map

The scripts to set.

~~addTestCommand~~ 
public void addTestCommand(java.lang.String commands)

DEPRECATED.

commandsRequired
  • Type: java.lang.String
~~hasScript~~ 
public java.lang.Boolean hasScript(java.lang.String name)

Indicates if a script by the name name is defined.

nameRequired
  • Type: java.lang.String

The name of the script.

removeScript 
public void removeScript(java.lang.String name)

Removes the npm script (always successful).

nameRequired
  • Type: java.lang.String

The name of the script.

renderWorkflowSetup 
public java.util.List<JobStep> renderWorkflowSetup()
public java.util.List<JobStep> renderWorkflowSetup(RenderWorkflowSetupOptions options)

Returns the set of workflow steps which should be executed to bootstrap a workflow.

optionsOptional
  • Type: io.github.cdklabs.projen.javascript.RenderWorkflowSetupOptions

Options.

setScript 
public void setScript(java.lang.String name, java.lang.String command)

Replaces the contents of an npm package.json script.

nameRequired
  • Type: java.lang.String

The script name.

commandRequired
  • Type: java.lang.String

The command to execute.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isProject Test whether the given construct is a project.
of Find the closest ancestor project for given construct.
isConstruct 
import software.aws.pdk.cloudscape_react_ts_website.CloudscapeReactTsWebsiteProject;

CloudscapeReactTsWebsiteProject.isConstruct(java.lang.Object x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: java.lang.Object

Any object.

isProject 
import software.aws.pdk.cloudscape_react_ts_website.CloudscapeReactTsWebsiteProject;

CloudscapeReactTsWebsiteProject.isProject(java.lang.Object x)

Test whether the given construct is a project.

xRequired
  • Type: java.lang.Object
of 
import software.aws.pdk.cloudscape_react_ts_website.CloudscapeReactTsWebsiteProject;

CloudscapeReactTsWebsiteProject.of(IConstruct construct)

Find the closest ancestor project for given construct.

When given a project, this it the project itself.

constructRequired
  • Type: software.constructs.IConstruct

Properties

Name Type Description
node software.constructs.Node The tree node.
buildTask io.github.cdklabs.projen.Task No description.
commitGenerated java.lang.Boolean Whether to commit the managed files by default.
compileTask io.github.cdklabs.projen.Task No description.
components java.util.List Returns all the components within this project.
deps io.github.cdklabs.projen.Dependencies Project dependencies.
ejected java.lang.Boolean Whether or not the project is being ejected.
files java.util.List All files in this project.
gitattributes io.github.cdklabs.projen.GitAttributesFile The .gitattributes file for this repository.
gitignore io.github.cdklabs.projen.IgnoreFile .gitignore.
logger io.github.cdklabs.projen.Logger Logging utilities.
name java.lang.String Project name.
outdir java.lang.String Absolute output directory of this project.
packageTask io.github.cdklabs.projen.Task No description.
postCompileTask io.github.cdklabs.projen.Task No description.
preCompileTask io.github.cdklabs.projen.Task No description.
projectBuild io.github.cdklabs.projen.ProjectBuild Manages the build process of the project.
projenCommand java.lang.String The command to use in order to run the projen CLI.
root io.github.cdklabs.projen.Project The root project.
subprojects java.util.List Returns all the subprojects within this project.
tasks io.github.cdklabs.projen.Tasks Project tasks.
testTask io.github.cdklabs.projen.Task No description.
defaultTask io.github.cdklabs.projen.Task This is the "default" task, the one that executes "projen".
initProject io.github.cdklabs.projen.InitProject The options used when this project is bootstrapped via projen new.
parent io.github.cdklabs.projen.Project A parent project.
projectType io.github.cdklabs.projen.ProjectType No description.
autoApprove io.github.cdklabs.projen.github.AutoApprove Auto approve set up for this project.
devContainer io.github.cdklabs.projen.vscode.DevContainer Access for .devcontainer.json (used for GitHub Codespaces).
github io.github.cdklabs.projen.github.GitHub Access all github components.
gitpod io.github.cdklabs.projen.Gitpod Access for Gitpod.
vscode io.github.cdklabs.projen.vscode.VsCode Access all VSCode components.
allowLibraryDependencies java.lang.Boolean No description.
artifactsDirectory java.lang.String The build output directory.
artifactsJavascriptDirectory java.lang.String The location of the npm tarball after build (${artifactsDirectory}/js).
bundler io.github.cdklabs.projen.javascript.Bundler No description.
entrypoint java.lang.String No description.
manifest java.lang.Object No description.
npmrc io.github.cdklabs.projen.javascript.NpmConfig The .npmrc file.
package io.github.cdklabs.projen.javascript.NodePackage API for managing the node package.
packageManager io.github.cdklabs.projen.javascript.NodePackageManager The package manager to use.
runScriptCommand java.lang.String The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).
autoMerge io.github.cdklabs.projen.github.AutoMerge Component that sets up mergify for merging approved pull requests.
buildWorkflow io.github.cdklabs.projen.build.BuildWorkflow The PR build GitHub workflow.
buildWorkflowJobId java.lang.String The job ID of the build workflow.
jest io.github.cdklabs.projen.javascript.Jest The Jest configuration (if enabled).
maxNodeVersion java.lang.String Maximum node version required by this package.
minNodeVersion java.lang.String Minimum node.js version required by this package.
npmignore io.github.cdklabs.projen.IgnoreFile The .npmignore file.
prettier io.github.cdklabs.projen.javascript.Prettier No description.
publisher io.github.cdklabs.projen.release.Publisher Package publisher.
release io.github.cdklabs.projen.release.Release Release management.
upgradeWorkflow io.github.cdklabs.projen.javascript.UpgradeDependencies The upgrade workflow.
docsDirectory java.lang.String No description.
libdir java.lang.String The directory in which compiled .js files reside.
srcdir java.lang.String The directory in which source files reside.
testdir java.lang.String The directory in which tests reside.
tsconfigDev io.github.cdklabs.projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen).
watchTask io.github.cdklabs.projen.Task The "watch" task.
docgen java.lang.Boolean No description.
eslint io.github.cdklabs.projen.javascript.Eslint No description.
tsconfig io.github.cdklabs.projen.javascript.TypescriptConfig No description.
tsconfigEslint io.github.cdklabs.projen.javascript.TypescriptConfig No description.
allowSignup java.lang.Boolean No description.
applicationName java.lang.String No description.
publicDir java.lang.String No description.
typeSafeApis java.util.List No description.
typeSafeWebSocketApis java.util.List No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

buildTaskRequired 
public Task getBuildTask();
  • Type: io.github.cdklabs.projen.Task
commitGeneratedRequired 
public java.lang.Boolean getCommitGenerated();
  • Type: java.lang.Boolean

Whether to commit the managed files by default.

compileTaskRequired 
public Task getCompileTask();
  • Type: io.github.cdklabs.projen.Task
componentsRequired 
public java.util.List<Component> getComponents();
  • Type: java.util.List

Returns all the components within this project.

depsRequired 
public Dependencies getDeps();
  • Type: io.github.cdklabs.projen.Dependencies

Project dependencies.

ejectedRequired 
public java.lang.Boolean getEjected();
  • Type: java.lang.Boolean

Whether or not the project is being ejected.

filesRequired 
public java.util.List<FileBase> getFiles();
  • Type: java.util.List

All files in this project.

gitattributesRequired 
public GitAttributesFile getGitattributes();
  • Type: io.github.cdklabs.projen.GitAttributesFile

The .gitattributes file for this repository.

gitignoreRequired 
public IgnoreFile getGitignore();
  • Type: io.github.cdklabs.projen.IgnoreFile

.gitignore.

loggerRequired 
public Logger getLogger();
  • Type: io.github.cdklabs.projen.Logger

Logging utilities.

nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

Project name.

outdirRequired 
public java.lang.String getOutdir();
  • Type: java.lang.String

Absolute output directory of this project.

packageTaskRequired 
public Task getPackageTask();
  • Type: io.github.cdklabs.projen.Task
postCompileTaskRequired 
public Task getPostCompileTask();
  • Type: io.github.cdklabs.projen.Task
preCompileTaskRequired 
public Task getPreCompileTask();
  • Type: io.github.cdklabs.projen.Task
projectBuildRequired 
public ProjectBuild getProjectBuild();
  • Type: io.github.cdklabs.projen.ProjectBuild

Manages the build process of the project.

projenCommandRequired 
public java.lang.String getProjenCommand();
  • Type: java.lang.String

The command to use in order to run the projen CLI.

rootRequired 
public Project getRoot();
  • Type: io.github.cdklabs.projen.Project

The root project.

subprojectsRequired 
public java.util.List<Project> getSubprojects();
  • Type: java.util.List

Returns all the subprojects within this project.

tasksRequired 
public Tasks getTasks();
  • Type: io.github.cdklabs.projen.Tasks

Project tasks.

testTaskRequired 
public Task getTestTask();
  • Type: io.github.cdklabs.projen.Task
defaultTaskOptional 
public Task getDefaultTask();
  • Type: io.github.cdklabs.projen.Task

This is the "default" task, the one that executes "projen".

Undefined if the project is being ejected.

initProjectOptional 
public InitProject getInitProject();
  • Type: io.github.cdklabs.projen.InitProject

The options used when this project is bootstrapped via projen new.

It includes the original set of options passed to the CLI and also the JSII FQN of the project type.

parentOptional 
public Project getParent();
  • Type: io.github.cdklabs.projen.Project

A parent project.

If undefined, this is the root project.

projectTypeRequired 
public ProjectType getProjectType();
  • Type: io.github.cdklabs.projen.ProjectType
autoApproveOptional 
public AutoApprove getAutoApprove();
  • Type: io.github.cdklabs.projen.github.AutoApprove

Auto approve set up for this project.

devContainerOptional 
public DevContainer getDevContainer();
  • Type: io.github.cdklabs.projen.vscode.DevContainer

Access for .devcontainer.json (used for GitHub Codespaces).

This will be undefined if devContainer boolean is false

githubOptional 
public GitHub getGithub();
  • Type: io.github.cdklabs.projen.github.GitHub

Access all github components.

This will be undefined for subprojects.

gitpodOptional 
public Gitpod getGitpod();
  • Type: io.github.cdklabs.projen.Gitpod

Access for Gitpod.

This will be undefined if gitpod boolean is false

vscodeOptional 
public VsCode getVscode();
  • Type: io.github.cdklabs.projen.vscode.VsCode

Access all VSCode components.

This will be undefined for subprojects.

~~allowLibraryDependencies~~Required
  • Deprecated: use package.allowLibraryDependencies
public java.lang.Boolean getAllowLibraryDependencies();
  • Type: java.lang.Boolean
artifactsDirectoryRequired 
public java.lang.String getArtifactsDirectory();
  • Type: java.lang.String

The build output directory.

An npm tarball will be created under the js subdirectory. For example, if this is set to dist (the default), the npm tarball will be placed under dist/js/boom-boom-1.2.3.tg.

artifactsJavascriptDirectoryRequired 
public java.lang.String getArtifactsJavascriptDirectory();
  • Type: java.lang.String

The location of the npm tarball after build (${artifactsDirectory}/js).

bundlerRequired 
public Bundler getBundler();
  • Type: io.github.cdklabs.projen.javascript.Bundler
~~entrypoint~~Required
  • Deprecated: use package.entrypoint
public java.lang.String getEntrypoint();
  • Type: java.lang.String
~~manifest~~Required
  • Deprecated: use package.addField(x, y)
public java.lang.Object getManifest();
  • Type: java.lang.Object
npmrcRequired 
public NpmConfig getNpmrc();
  • Type: io.github.cdklabs.projen.javascript.NpmConfig

The .npmrc file.

packageRequired 
public NodePackage getPackage();
  • Type: io.github.cdklabs.projen.javascript.NodePackage

API for managing the node package.

~~packageManager~~Required
  • Deprecated: use package.packageManager
public NodePackageManager getPackageManager();
  • Type: io.github.cdklabs.projen.javascript.NodePackageManager

The package manager to use.

runScriptCommandRequired 
public java.lang.String getRunScriptCommand();
  • Type: java.lang.String

The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).

autoMergeOptional 
public AutoMerge getAutoMerge();
  • Type: io.github.cdklabs.projen.github.AutoMerge

Component that sets up mergify for merging approved pull requests.

buildWorkflowOptional 
public BuildWorkflow getBuildWorkflow();
  • Type: io.github.cdklabs.projen.build.BuildWorkflow

The PR build GitHub workflow.

undefined if buildWorkflow is disabled.

buildWorkflowJobIdOptional 
public java.lang.String getBuildWorkflowJobId();
  • Type: java.lang.String

The job ID of the build workflow.

jestOptional 
public Jest getJest();
  • Type: io.github.cdklabs.projen.javascript.Jest

The Jest configuration (if enabled).

maxNodeVersionOptional 
public java.lang.String getMaxNodeVersion();
  • Type: java.lang.String

Maximum node version required by this package.

minNodeVersionOptional 
public java.lang.String getMinNodeVersion();
  • Type: java.lang.String

Minimum node.js version required by this package.

npmignoreOptional 
public IgnoreFile getNpmignore();
  • Type: io.github.cdklabs.projen.IgnoreFile

The .npmignore file.

prettierOptional 
public Prettier getPrettier();
  • Type: io.github.cdklabs.projen.javascript.Prettier
~~publisher~~Optional
  • Deprecated: use release.publisher.
public Publisher getPublisher();
  • Type: io.github.cdklabs.projen.release.Publisher

Package publisher.

This will be undefined if the project does not have a release workflow.

releaseOptional 
public Release getRelease();
  • Type: io.github.cdklabs.projen.release.Release

Release management.

upgradeWorkflowOptional 
public UpgradeDependencies getUpgradeWorkflow();
  • Type: io.github.cdklabs.projen.javascript.UpgradeDependencies

The upgrade workflow.

docsDirectoryRequired 
public java.lang.String getDocsDirectory();
  • Type: java.lang.String
libdirRequired 
public java.lang.String getLibdir();
  • Type: java.lang.String

The directory in which compiled .js files reside.

srcdirRequired 
public java.lang.String getSrcdir();
  • Type: java.lang.String

The directory in which source files reside.

testdirRequired 
public java.lang.String getTestdir();
  • Type: java.lang.String

The directory in which tests reside.

tsconfigDevRequired 
public TypescriptConfig getTsconfigDev();
  • Type: io.github.cdklabs.projen.javascript.TypescriptConfig

A typescript configuration file which covers all files (sources, tests, projen).

watchTaskRequired 
public Task getWatchTask();
  • Type: io.github.cdklabs.projen.Task

The "watch" task.

docgenOptional 
public java.lang.Boolean getDocgen();
  • Type: java.lang.Boolean
eslintOptional 
public Eslint getEslint();
  • Type: io.github.cdklabs.projen.javascript.Eslint
tsconfigOptional 
public TypescriptConfig getTsconfig();
  • Type: io.github.cdklabs.projen.javascript.TypescriptConfig
tsconfigEslintOptional 
public TypescriptConfig getTsconfigEslint();
  • Type: io.github.cdklabs.projen.javascript.TypescriptConfig
allowSignupRequired 
public java.lang.Boolean getAllowSignup();
  • Type: java.lang.Boolean
applicationNameRequired 
public java.lang.String getApplicationName();
  • Type: java.lang.String
publicDirRequired 
public java.lang.String getPublicDir();
  • Type: java.lang.String
typeSafeApisOptional 
public java.util.List<TypeSafeApiProject> getTypeSafeApis();
  • Type: java.util.List
typeSafeWebSocketApisOptional 
public java.util.List<TypeSafeWebSocketApiProject> getTypeSafeWebSocketApis();
  • Type: java.util.List

Constants

Name Type Description
DEFAULT_TASK java.lang.String The name of the default task (the task executed when projen is run without arguments).
DEFAULT_TS_JEST_TRANFORM_PATTERN java.lang.String No description.
DEFAULT_TASKRequired 
public java.lang.String getDefaultTask();
  • Type: java.lang.String

The name of the default task (the task executed when projen is run without arguments).

Normally this task should synthesize the project files.

DEFAULT_TS_JEST_TRANFORM_PATTERNRequired 
public java.lang.String getDefaultTsJestTranformPattern();
  • Type: java.lang.String

Structs

CloudscapeReactTsWebsiteProjectOptions

Configuration options for the CloudscapeReactTsWebsiteProject.

Initializer 

import software.aws.pdk.cloudscape_react_ts_website.CloudscapeReactTsWebsiteProjectOptions;

CloudscapeReactTsWebsiteProjectOptions.builder()
    .name(java.lang.String)
//  .allowLibraryDependencies(java.lang.Boolean)
//  .artifactsDirectory(java.lang.String)
//  .authorEmail(java.lang.String)
//  .authorName(java.lang.String)
//  .authorOrganization(java.lang.Boolean)
//  .authorUrl(java.lang.String)
//  .autoApproveOptions(AutoApproveOptions)
//  .autoApproveUpgrades(java.lang.Boolean)
//  .autoDetectBin(java.lang.Boolean)
//  .autoMerge(java.lang.Boolean)
//  .autoMergeOptions(AutoMergeOptions)
//  .bin(java.util.Map<java.lang.String, java.lang.String>)
//  .bugsEmail(java.lang.String)
//  .bugsUrl(java.lang.String)
//  .buildWorkflow(java.lang.Boolean)
//  .buildWorkflowOptions(BuildWorkflowOptions)
//  .buildWorkflowTriggers(Triggers)
//  .bundledDeps(java.util.List<java.lang.String>)
//  .bundlerOptions(BundlerOptions)
//  .checkLicenses(LicenseCheckerOptions)
//  .clobber(java.lang.Boolean)
//  .codeArtifactOptions(CodeArtifactOptions)
//  .codeCov(java.lang.Boolean)
//  .codeCovTokenSecret(java.lang.String)
//  .commitGenerated(java.lang.Boolean)
//  .copyrightOwner(java.lang.String)
//  .copyrightPeriod(java.lang.String)
//  .defaultReleaseBranch(java.lang.String)
//  .dependabot(java.lang.Boolean)
//  .dependabotOptions(DependabotOptions)
//  .deps(java.util.List<java.lang.String>)
//  .depsUpgrade(java.lang.Boolean)
//  .depsUpgradeOptions(UpgradeDependenciesOptions)
//  .description(java.lang.String)
//  .devContainer(java.lang.Boolean)
//  .devDeps(java.util.List<java.lang.String>)
//  .disableTsconfig(java.lang.Boolean)
//  .disableTsconfigDev(java.lang.Boolean)
//  .docgen(java.lang.Boolean)
//  .docsDirectory(java.lang.String)
//  .entrypoint(java.lang.String)
//  .entrypointTypes(java.lang.String)
//  .eslint(java.lang.Boolean)
//  .eslintOptions(EslintOptions)
//  .github(java.lang.Boolean)
//  .githubOptions(GitHubOptions)
//  .gitignore(java.util.List<java.lang.String>)
//  .gitIgnoreOptions(IgnoreFileOptions)
//  .gitOptions(GitOptions)
//  .gitpod(java.lang.Boolean)
//  .homepage(java.lang.String)
//  .jest(java.lang.Boolean)
//  .jestOptions(JestOptions)
//  .jsiiReleaseVersion(java.lang.String)
//  .keywords(java.util.List<java.lang.String>)
//  .libdir(java.lang.String)
//  .license(java.lang.String)
//  .licensed(java.lang.Boolean)
//  .logging(LoggerOptions)
//  .majorVersion(java.lang.Number)
//  .maxNodeVersion(java.lang.String)
//  .mergify(java.lang.Boolean)
//  .mergifyOptions(MergifyOptions)
//  .minMajorVersion(java.lang.Number)
//  .minNodeVersion(java.lang.String)
//  .mutableBuild(java.lang.Boolean)
//  .npmAccess(NpmAccess)
//  .npmDistTag(java.lang.String)
//  .npmignore(java.util.List<java.lang.String>)
//  .npmignoreEnabled(java.lang.Boolean)
//  .npmIgnoreOptions(IgnoreFileOptions)
//  .npmProvenance(java.lang.Boolean)
//  .npmRegistry(java.lang.String)
//  .npmRegistryUrl(java.lang.String)
//  .npmTokenSecret(java.lang.String)
//  .outdir(java.lang.String)
//  .package(java.lang.Boolean)
//  .packageManager(NodePackageManager)
//  .packageName(java.lang.String)
//  .parent(Project)
//  .peerDependencyOptions(PeerDependencyOptions)
//  .peerDeps(java.util.List<java.lang.String>)
//  .pnpmVersion(java.lang.String)
//  .postBuildSteps(java.util.List<JobStep>)
//  .prerelease(java.lang.String)
//  .prettier(java.lang.Boolean)
//  .prettierOptions(PrettierOptions)
//  .projectType(ProjectType)
//  .projenCommand(java.lang.String)
//  .projenCredentials(GithubCredentials)
//  .projenDevDependency(java.lang.Boolean)
//  .projenrcJs(java.lang.Boolean)
//  .projenrcJson(java.lang.Boolean)
//  .projenrcJsonOptions(ProjenrcJsonOptions)
//  .projenrcJsOptions(ProjenrcOptions)
//  .projenrcTs(java.lang.Boolean)
//  .projenrcTsOptions(ProjenrcOptions)
//  .projenTokenSecret(java.lang.String)
//  .projenVersion(java.lang.String)
//  .publishDryRun(java.lang.Boolean)
//  .publishTasks(java.lang.Boolean)
//  .pullRequestTemplate(java.lang.Boolean)
//  .pullRequestTemplateContents(java.util.List<java.lang.String>)
//  .readme(SampleReadmeProps)
//  .releasableCommits(ReleasableCommits)
//  .release(java.lang.Boolean)
//  .releaseBranches(java.util.Map<java.lang.String, BranchOptions>)
//  .releaseEveryCommit(java.lang.Boolean)
//  .releaseFailureIssue(java.lang.Boolean)
//  .releaseFailureIssueLabel(java.lang.String)
//  .releaseSchedule(java.lang.String)
//  .releaseTagPrefix(java.lang.String)
//  .releaseToNpm(java.lang.Boolean)
//  .releaseTrigger(ReleaseTrigger)
//  .releaseWorkflow(java.lang.Boolean)
//  .releaseWorkflowName(java.lang.String)
//  .releaseWorkflowSetupSteps(java.util.List<JobStep>)
//  .renovatebot(java.lang.Boolean)
//  .renovatebotOptions(RenovatebotOptions)
//  .repository(java.lang.String)
//  .repositoryDirectory(java.lang.String)
//  .rewire(java.util.Map<java.lang.String, java.lang.Object>)
//  .scopedPackagesOptions(java.util.List<ScopedPackagesOptions>)
//  .scripts(java.util.Map<java.lang.String, java.lang.String>)
//  .srcdir(java.lang.String)
//  .stability(java.lang.String)
//  .stale(java.lang.Boolean)
//  .staleOptions(StaleOptions)
//  .testdir(java.lang.String)
//  .tsconfig(TypescriptConfigOptions)
//  .tsconfigDev(TypescriptConfigOptions)
//  .tsconfigDevFile(java.lang.String)
//  .tsJestOptions(TsJestOptions)
//  .typescriptVersion(java.lang.String)
//  .versionrcOptions(java.util.Map<java.lang.String, java.lang.Object>)
//  .vscode(java.lang.Boolean)
//  .workflowBootstrapSteps(java.util.List<JobStep>)
//  .workflowContainerImage(java.lang.String)
//  .workflowGitIdentity(GitIdentity)
//  .workflowNodeVersion(java.lang.String)
//  .workflowPackageCache(java.lang.Boolean)
//  .workflowRunsOn(java.util.List<java.lang.String>)
//  .workflowRunsOnGroup(GroupRunnerOptions)
//  .yarnBerryOptions(YarnBerryOptions)
//  .allowSignup(java.lang.Boolean)
//  .applicationName(java.lang.String)
//  .publicDir(java.lang.String)
//  .typeSafeApi(TypeSafeApiProject)
//  .typeSafeApis(java.util.List<TypeSafeApiProject>)
//  .typeSafeWebSocketApis(java.util.List<TypeSafeWebSocketApiProject>)
    .build();

Properties

Name Type Description
name java.lang.String No description.
allowLibraryDependencies java.lang.Boolean Allow the project to include peerDependencies and bundledDependencies.
artifactsDirectory java.lang.String A directory which will contain build artifacts.
authorEmail java.lang.String Author's e-mail.
authorName java.lang.String Author's name.
authorOrganization java.lang.Boolean Is the author an organization.
authorUrl java.lang.String Author's URL / Website.
autoApproveOptions io.github.cdklabs.projen.github.AutoApproveOptions Enable and configure the 'auto approve' workflow.
autoApproveUpgrades java.lang.Boolean Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
autoDetectBin java.lang.Boolean Automatically add all executables under the bin directory to your package.json file under the bin section.
autoMerge java.lang.Boolean Enable automatic merging on GitHub.
autoMergeOptions io.github.cdklabs.projen.github.AutoMergeOptions Configure options for automatic merging on GitHub.
bin java.util.Map Binary programs vended with your module.
bugsEmail java.lang.String The email address to which issues should be reported.
bugsUrl java.lang.String The url to your project's issue tracker.
buildWorkflow java.lang.Boolean Define a GitHub workflow for building PRs.
buildWorkflowOptions io.github.cdklabs.projen.javascript.BuildWorkflowOptions Options for PR build workflow.
buildWorkflowTriggers io.github.cdklabs.projen.github.workflows.Triggers Build workflow triggers.
bundledDeps java.util.List List of dependencies to bundle into this module.
bundlerOptions io.github.cdklabs.projen.javascript.BundlerOptions Options for Bundler.
checkLicenses io.github.cdklabs.projen.javascript.LicenseCheckerOptions Configure which licenses should be deemed acceptable for use by dependencies.
clobber java.lang.Boolean Add a clobber task which resets the repo to origin.
codeArtifactOptions io.github.cdklabs.projen.javascript.CodeArtifactOptions Options for npm packages using AWS CodeArtifact.
codeCov java.lang.Boolean Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with @codeCovTokenSecret.
codeCovTokenSecret java.lang.String Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
commitGenerated java.lang.Boolean Whether to commit the managed files by default.
copyrightOwner java.lang.String License copyright owner.
copyrightPeriod java.lang.String The copyright years to put in the LICENSE file.
defaultReleaseBranch java.lang.String The name of the main release branch.
dependabot java.lang.Boolean Use dependabot to handle dependency upgrades.
dependabotOptions io.github.cdklabs.projen.github.DependabotOptions Options for dependabot.
deps java.util.List Runtime dependencies of this module.
depsUpgrade java.lang.Boolean Use tasks and github workflows to handle dependency upgrades.
depsUpgradeOptions io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions Options for UpgradeDependencies.
description java.lang.String The description is just a string that helps people understand the purpose of the package.
devContainer java.lang.Boolean Add a VSCode development environment (used for GitHub Codespaces).
devDeps java.util.List Build dependencies for this module.
disableTsconfig java.lang.Boolean Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
disableTsconfigDev java.lang.Boolean Do not generate a tsconfig.dev.json file.
docgen java.lang.Boolean Docgen by Typedoc.
docsDirectory java.lang.String Docs directory.
entrypoint java.lang.String Module entrypoint (main in package.json). Set to an empty string to not include main in your package.json.
entrypointTypes java.lang.String The .d.ts file that includes the type declarations for this module.
eslint java.lang.Boolean Setup eslint.
eslintOptions io.github.cdklabs.projen.javascript.EslintOptions Eslint options.
github java.lang.Boolean Enable GitHub integration.
githubOptions io.github.cdklabs.projen.github.GitHubOptions Options for GitHub integration.
gitignore java.util.List Additional entries to .gitignore.
gitIgnoreOptions io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file.
gitOptions io.github.cdklabs.projen.GitOptions Configuration options for git.
gitpod java.lang.Boolean Add a Gitpod development environment.
homepage java.lang.String Package's Homepage / Website.
jest java.lang.Boolean Setup jest unit tests.
jestOptions io.github.cdklabs.projen.javascript.JestOptions Jest options.
jsiiReleaseVersion java.lang.String Version requirement of publib which is used to publish modules to npm.
keywords java.util.List Keywords to include in package.json.
libdir java.lang.String Typescript artifacts output directory.
license java.lang.String License's SPDX identifier.
licensed java.lang.Boolean Indicates if a license should be added.
logging io.github.cdklabs.projen.LoggerOptions Configure logging options such as verbosity.
majorVersion java.lang.Number Major version to release from the default branch.
maxNodeVersion java.lang.String Minimum node.js version to require via engines (inclusive).
mergify java.lang.Boolean Whether mergify should be enabled on this repository or not.
mergifyOptions io.github.cdklabs.projen.github.MergifyOptions Options for mergify.
minMajorVersion java.lang.Number Minimal Major version to release.
minNodeVersion java.lang.String Minimum Node.js version to require via package.json engines (inclusive).
mutableBuild java.lang.Boolean Automatically update files modified during builds to pull-request branches.
npmAccess io.github.cdklabs.projen.javascript.NpmAccess Access level of the npm package.
npmDistTag java.lang.String The npmDistTag to use when publishing from the default branch.
npmignore java.util.List Additional entries to .npmignore.
npmignoreEnabled java.lang.Boolean Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
npmIgnoreOptions io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .npmignore file.
npmProvenance java.lang.Boolean Should provenance statements be generated when the package is published.
npmRegistry java.lang.String The host name of the npm registry to publish to.
npmRegistryUrl java.lang.String The base URL of the npm package registry.
npmTokenSecret java.lang.String GitHub secret which contains the NPM token to use when publishing packages.
outdir java.lang.String The root directory of the project. Relative to this directory, all files are synthesized.
package java.lang.Boolean Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
packageManager io.github.cdklabs.projen.javascript.NodePackageManager The Node Package Manager used to execute scripts.
packageName java.lang.String The "name" in package.json.
parent io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project.
peerDependencyOptions io.github.cdklabs.projen.javascript.PeerDependencyOptions Options for peerDeps.
peerDeps java.util.List Peer dependencies for this module.
pnpmVersion java.lang.String The version of PNPM to use if using PNPM as a package manager.
postBuildSteps java.util.List Steps to execute after build as part of the release workflow.
prerelease java.lang.String Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
prettier java.lang.Boolean Setup prettier.
prettierOptions io.github.cdklabs.projen.javascript.PrettierOptions Prettier options.
projectType io.github.cdklabs.projen.ProjectType Which type of project this is (library/app).
projenCommand java.lang.String The shell command to use in order to run the projen CLI.
projenCredentials io.github.cdklabs.projen.github.GithubCredentials Choose a method of providing GitHub API access for projen workflows.
projenDevDependency java.lang.Boolean Indicates of "projen" should be installed as a devDependency.
projenrcJs java.lang.Boolean Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
projenrcJson java.lang.Boolean Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
projenrcJsonOptions io.github.cdklabs.projen.ProjenrcJsonOptions Options for .projenrc.json.
projenrcJsOptions io.github.cdklabs.projen.javascript.ProjenrcOptions Options for .projenrc.js.
projenrcTs java.lang.Boolean Use TypeScript for your projenrc file (.projenrc.ts).
projenrcTsOptions io.github.cdklabs.projen.typescript.ProjenrcOptions Options for .projenrc.ts.
projenTokenSecret java.lang.String The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
projenVersion java.lang.String Version of projen to install.
publishDryRun java.lang.Boolean Instead of actually publishing to package managers, just print the publishing command.
publishTasks java.lang.Boolean Define publishing tasks that can be executed manually as well as workflows.
pullRequestTemplate java.lang.Boolean Include a GitHub pull request template.
pullRequestTemplateContents java.util.List The contents of the pull request template.
readme io.github.cdklabs.projen.SampleReadmeProps The README setup.
releasableCommits io.github.cdklabs.projen.ReleasableCommits Find commits that should be considered releasable Used to decide if a release is required.
release java.lang.Boolean Add release management to this project.
releaseBranches java.util.Map Defines additional release branches.
releaseEveryCommit java.lang.Boolean Automatically release new versions every commit to one of branches in releaseBranches.
releaseFailureIssue java.lang.Boolean Create a github issue on every failed publishing task.
releaseFailureIssueLabel java.lang.String The label to apply to issues indicating publish failures.
releaseSchedule java.lang.String CRON schedule to trigger new releases.
releaseTagPrefix java.lang.String Automatically add the given prefix to release tags.
releaseToNpm java.lang.Boolean Automatically release to npm when new versions are introduced.
releaseTrigger io.github.cdklabs.projen.release.ReleaseTrigger The release trigger to use.
releaseWorkflow java.lang.Boolean DEPRECATED: renamed to release.
releaseWorkflowName java.lang.String The name of the default release workflow.
releaseWorkflowSetupSteps java.util.List A set of workflow steps to execute in order to setup the workflow container.
renovatebot java.lang.Boolean Use renovatebot to handle dependency upgrades.
renovatebotOptions io.github.cdklabs.projen.RenovatebotOptions Options for renovatebot.
repository java.lang.String The repository is the location where the actual code for your package lives.
repositoryDirectory java.lang.String 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.
rewire java.util.Map Rewire webpack configuration. Use this property to override webpack configuration properties provided by create-react-app, without needing to eject.
scopedPackagesOptions java.util.List Options for privately hosted scoped packages.
scripts java.util.Map npm scripts to include.
srcdir java.lang.String Typescript sources directory.
stability java.lang.String Package's Stability.
stale java.lang.Boolean Auto-close of stale issues and pull request.
staleOptions io.github.cdklabs.projen.github.StaleOptions Auto-close stale issues and pull requests.
testdir java.lang.String Jest tests directory.
tsconfig io.github.cdklabs.projen.javascript.TypescriptConfigOptions Custom TSConfig.
tsconfigDev io.github.cdklabs.projen.javascript.TypescriptConfigOptions Custom tsconfig options for the development tsconfig.json file (used for testing).
tsconfigDevFile java.lang.String The name of the development tsconfig.json file.
tsJestOptions io.github.cdklabs.projen.typescript.TsJestOptions Options for ts-jest.
typescriptVersion java.lang.String TypeScript version to use.
versionrcOptions java.util.Map Custom configuration used when creating changelog with standard-version package.
vscode java.lang.Boolean Enable VSCode integration.
workflowBootstrapSteps java.util.List Workflow steps to use in order to bootstrap this repo.
workflowContainerImage java.lang.String Container image to use for GitHub workflows.
workflowGitIdentity io.github.cdklabs.projen.github.GitIdentity The git identity to use in workflows.
workflowNodeVersion java.lang.String The node version to use in GitHub workflows.
workflowPackageCache java.lang.Boolean Enable Node.js package cache in GitHub workflows.
workflowRunsOn java.util.List Github Runner selection labels.
workflowRunsOnGroup io.github.cdklabs.projen.GroupRunnerOptions Github Runner Group selection options.
yarnBerryOptions io.github.cdklabs.projen.javascript.YarnBerryOptions Options for Yarn Berry.
allowSignup java.lang.Boolean Whether to enable self sign-up.
applicationName java.lang.String Name of the application name.
publicDir java.lang.String Public directory.
typeSafeApi software.aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject TypeSafeApi instance to use when setting up the initial project sample code.
typeSafeApis java.util.List TypeSafeApi instances to use when setting up the initial project sample code.
typeSafeWebSocketApis java.util.List TypeSafeWebSocketApi instances to use when setting up the initial project sample code.
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
allowLibraryDependenciesOptional 
public java.lang.Boolean getAllowLibraryDependencies();
  • Type: java.lang.Boolean
  • Default: true

Allow the project to include peerDependencies and bundledDependencies.

This is normally only allowed for libraries. For apps, there's no meaning for specifying these.

artifactsDirectoryOptional 
public java.lang.String getArtifactsDirectory();
  • Type: java.lang.String
  • Default: "dist"

A directory which will contain build artifacts.

authorEmailOptional 
public java.lang.String getAuthorEmail();
  • Type: java.lang.String

Author's e-mail.

authorNameOptional 
public java.lang.String getAuthorName();
  • Type: java.lang.String

Author's name.

authorOrganizationOptional 
public java.lang.Boolean getAuthorOrganization();
  • Type: java.lang.Boolean

Is the author an organization.

authorUrlOptional 
public java.lang.String getAuthorUrl();
  • Type: java.lang.String

Author's URL / Website.

autoApproveOptionsOptional 
public AutoApproveOptions getAutoApproveOptions();
  • Type: io.github.cdklabs.projen.github.AutoApproveOptions
  • Default: auto approve is disabled

Enable and configure the 'auto approve' workflow.

autoApproveUpgradesOptional 
public java.lang.Boolean getAutoApproveUpgrades();
  • Type: java.lang.Boolean
  • Default: true

Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).

Throw if set to true but autoApproveOptions are not defined.

autoDetectBinOptional 
public java.lang.Boolean getAutoDetectBin();
  • Type: java.lang.Boolean
  • Default: true

Automatically add all executables under the bin directory to your package.json file under the bin section.

autoMergeOptional 
public java.lang.Boolean getAutoMerge();
  • Type: java.lang.Boolean
  • Default: true

Enable automatic merging on GitHub.

Has no effect if github.mergify is set to false.

autoMergeOptionsOptional 
public AutoMergeOptions getAutoMergeOptions();
  • Type: io.github.cdklabs.projen.github.AutoMergeOptions
  • Default: see defaults in AutoMergeOptions

Configure options for automatic merging on GitHub.

Has no effect if github.mergify or autoMerge is set to false.

binOptional 
public java.util.Map<java.lang.String, java.lang.String> getBin();
  • Type: java.util.Map

Binary programs vended with your module.

You can use this option to add/customize how binaries are represented in your package.json, but unless autoDetectBin is false, every executable file under bin will automatically be added to this section.

bugsEmailOptional 
public java.lang.String getBugsEmail();
  • Type: java.lang.String

The email address to which issues should be reported.

bugsUrlOptional 
public java.lang.String getBugsUrl();
  • Type: java.lang.String

The url to your project's issue tracker.

buildWorkflowOptional 
public java.lang.Boolean getBuildWorkflow();
  • Type: java.lang.Boolean
  • Default: true if not a subproject

Define a GitHub workflow for building PRs.

buildWorkflowOptionsOptional 
public BuildWorkflowOptions getBuildWorkflowOptions();
  • Type: io.github.cdklabs.projen.javascript.BuildWorkflowOptions

Options for PR build workflow.

~~buildWorkflowTriggers~~Optional
  • Deprecated: - Use buildWorkflowOptions.workflowTriggers
public Triggers getBuildWorkflowTriggers();
  • Type: io.github.cdklabs.projen.github.workflows.Triggers
  • Default: "{ pullRequest: {}, workflowDispatch: {} }"

Build workflow triggers.

bundledDepsOptional 
public java.util.List<java.lang.String> getBundledDeps();
  • Type: java.util.List

List of dependencies to bundle into this module.

These modules will be added both to the dependencies section and bundledDependencies section of your package.json.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

bundlerOptionsOptional 
public BundlerOptions getBundlerOptions();
  • Type: io.github.cdklabs.projen.javascript.BundlerOptions

Options for Bundler.

checkLicensesOptional 
public LicenseCheckerOptions getCheckLicenses();
  • Type: io.github.cdklabs.projen.javascript.LicenseCheckerOptions
  • Default: no license checks are run during the build and all licenses will be accepted

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.

clobberOptional 
public java.lang.Boolean getClobber();
  • Type: java.lang.Boolean
  • Default: true, but false for subprojects

Add a clobber task which resets the repo to origin.

codeArtifactOptionsOptional 
public CodeArtifactOptions getCodeArtifactOptions();
  • Type: io.github.cdklabs.projen.javascript.CodeArtifactOptions
  • Default: undefined

Options for npm packages using AWS CodeArtifact.

This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact

codeCovOptional 
public java.lang.Boolean getCodeCov();
  • Type: java.lang.Boolean
  • Default: false

Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with @codeCovTokenSecret.

codeCovTokenSecretOptional 
public java.lang.String getCodeCovTokenSecret();
  • Type: java.lang.String
  • Default: if this option is not specified, only public repositories are supported

Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.

commitGeneratedOptional 
public java.lang.Boolean getCommitGenerated();
  • Type: java.lang.Boolean
  • Default: true

Whether to commit the managed files by default.

copyrightOwnerOptional 
public java.lang.String getCopyrightOwner();
  • Type: java.lang.String
  • Default: defaults to the value of authorName or "" if authorName is undefined.

License copyright owner.

copyrightPeriodOptional 
public java.lang.String getCopyrightPeriod();
  • Type: java.lang.String
  • Default: current year

The copyright years to put in the LICENSE file.

defaultReleaseBranchOptional 
public java.lang.String getDefaultReleaseBranch();
  • Type: java.lang.String
  • Default: "main"

The name of the main release branch.

dependabotOptional 
public java.lang.Boolean getDependabot();
  • Type: java.lang.Boolean
  • Default: false

Use dependabot to handle dependency upgrades.

Cannot be used in conjunction with depsUpgrade.

dependabotOptionsOptional 
public DependabotOptions getDependabotOptions();
  • Type: io.github.cdklabs.projen.github.DependabotOptions
  • Default: default options

Options for dependabot.

depsOptional 
public java.util.List<java.lang.String> getDeps();
  • Type: java.util.List
  • Default: []

Runtime dependencies of this module.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

depsUpgradeOptional 
public java.lang.Boolean getDepsUpgrade();
  • Type: java.lang.Boolean
  • Default: true

Use tasks and github workflows to handle dependency upgrades.

Cannot be used in conjunction with dependabot.

depsUpgradeOptionsOptional 
public UpgradeDependenciesOptions getDepsUpgradeOptions();
  • Type: io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions
  • Default: default options

Options for UpgradeDependencies.

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.String

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

devContainerOptional 
public java.lang.Boolean getDevContainer();
  • Type: java.lang.Boolean
  • Default: false

Add a VSCode development environment (used for GitHub Codespaces).

devDepsOptional 
public java.util.List<java.lang.String> getDevDeps();
  • Type: java.util.List
  • Default: []

Build dependencies for this module.

These dependencies will only be available in your build environment but will not be fetched when this module is consumed.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

disableTsconfigOptional 
public java.lang.Boolean getDisableTsconfig();
  • Type: java.lang.Boolean
  • Default: false

Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).

disableTsconfigDevOptional 
public java.lang.Boolean getDisableTsconfigDev();
  • Type: java.lang.Boolean
  • Default: false

Do not generate a tsconfig.dev.json file.

docgenOptional 
public java.lang.Boolean getDocgen();
  • Type: java.lang.Boolean
  • Default: false

Docgen by Typedoc.

docsDirectoryOptional 
public java.lang.String getDocsDirectory();
  • Type: java.lang.String
  • Default: "docs"

Docs directory.

entrypointOptional 
public java.lang.String getEntrypoint();
  • Type: java.lang.String
  • Default: "lib/index.js"

Module entrypoint (main in package.json). Set to an empty string to not include main in your package.json.

entrypointTypesOptional 
public java.lang.String getEntrypointTypes();
  • Type: java.lang.String
  • Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)

The .d.ts file that includes the type declarations for this module.

eslintOptional 
public java.lang.Boolean getEslint();
  • Type: java.lang.Boolean
  • Default: true

Setup eslint.

eslintOptionsOptional 
public EslintOptions getEslintOptions();
  • Type: io.github.cdklabs.projen.javascript.EslintOptions
  • Default: opinionated default options

Eslint options.

githubOptional 
public java.lang.Boolean getGithub();
  • Type: java.lang.Boolean
  • Default: true

Enable GitHub integration.

Enabled by default for root projects. Disabled for non-root projects.

githubOptionsOptional 
public GitHubOptions getGithubOptions();
  • Type: io.github.cdklabs.projen.github.GitHubOptions
  • Default: see GitHubOptions

Options for GitHub integration.

gitignoreOptional 
public java.util.List<java.lang.String> getGitignore();
  • Type: java.util.List

Additional entries to .gitignore.

gitIgnoreOptionsOptional 
public IgnoreFileOptions getGitIgnoreOptions();
  • Type: io.github.cdklabs.projen.IgnoreFileOptions

Configuration options for .gitignore file.

gitOptionsOptional 
public GitOptions getGitOptions();
  • Type: io.github.cdklabs.projen.GitOptions

Configuration options for git.

gitpodOptional 
public java.lang.Boolean getGitpod();
  • Type: java.lang.Boolean
  • Default: false

Add a Gitpod development environment.

homepageOptional 
public java.lang.String getHomepage();
  • Type: java.lang.String

Package's Homepage / Website.

jestOptional 
public java.lang.Boolean getJest();
  • Type: java.lang.Boolean
  • Default: true

Setup jest unit tests.

jestOptionsOptional 
public JestOptions getJestOptions();
  • Type: io.github.cdklabs.projen.javascript.JestOptions
  • Default: default options

Jest options.

jsiiReleaseVersionOptional 
public java.lang.String getJsiiReleaseVersion();
  • Type: java.lang.String
  • Default: "latest"

Version requirement of publib which is used to publish modules to npm.

keywordsOptional 
public java.util.List<java.lang.String> getKeywords();
  • Type: java.util.List

Keywords to include in package.json.

libdirOptional 
public java.lang.String getLibdir();
  • Type: java.lang.String
  • Default: "lib"

Typescript artifacts output directory.

licenseOptional 
public java.lang.String getLicense();
  • Type: java.lang.String
  • Default: "Apache-2.0"

License's SPDX identifier.

See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the licensed option if you want to no license to be specified.

licensedOptional 
public java.lang.Boolean getLicensed();
  • Type: java.lang.Boolean
  • Default: true

Indicates if a license should be added.

loggingOptional 
public LoggerOptions getLogging();
  • Type: io.github.cdklabs.projen.LoggerOptions
  • Default: {}

Configure logging options such as verbosity.

majorVersionOptional 
public java.lang.Number getMajorVersion();
  • Type: java.lang.Number
  • Default: Major version is not enforced.

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.

maxNodeVersionOptional 
public java.lang.String getMaxNodeVersion();
  • Type: java.lang.String
  • Default: no max

Minimum node.js version to require via engines (inclusive).

~~mergify~~Optional
  • Deprecated: use githubOptions.mergify instead
public java.lang.Boolean getMergify();
  • Type: java.lang.Boolean
  • Default: true

Whether mergify should be enabled on this repository or not.

~~mergifyOptions~~Optional
  • Deprecated: use githubOptions.mergifyOptions instead
public MergifyOptions getMergifyOptions();
  • Type: io.github.cdklabs.projen.github.MergifyOptions
  • Default: default options

Options for mergify.

minMajorVersionOptional 
public java.lang.Number getMinMajorVersion();
  • Type: java.lang.Number
  • Default: No minimum version is being enforced

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.

minNodeVersionOptional 
public java.lang.String getMinNodeVersion();
  • Type: java.lang.String
  • Default: no "engines" specified

Minimum Node.js version to require via package.json engines (inclusive).

~~mutableBuild~~Optional
  • Deprecated: - Use buildWorkflowOptions.mutableBuild
public java.lang.Boolean getMutableBuild();
  • Type: java.lang.Boolean
  • Default: true

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.

npmAccessOptional 
public NpmAccess getNpmAccess();
  • Type: io.github.cdklabs.projen.javascript.NpmAccess
  • Default: for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.

Access level of the npm package.

npmDistTagOptional 
public java.lang.String getNpmDistTag();
  • Type: java.lang.String
  • Default: "latest"

The npmDistTag to use when publishing from the default branch.

To set the npm dist-tag for release branches, set the npmDistTag property for each branch.

~~npmignore~~Optional
  • Deprecated: - use project.addPackageIgnore
public java.util.List<java.lang.String> getNpmignore();
  • Type: java.util.List

Additional entries to .npmignore.

npmignoreEnabledOptional 
public java.lang.Boolean getNpmignoreEnabled();
  • Type: java.lang.Boolean
  • Default: true

Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.

npmIgnoreOptionsOptional 
public IgnoreFileOptions getNpmIgnoreOptions();
  • Type: io.github.cdklabs.projen.IgnoreFileOptions

Configuration options for .npmignore file.

npmProvenanceOptional 
public java.lang.Boolean getNpmProvenance();
  • Type: java.lang.Boolean
  • Default: true for public packages, false otherwise

Should provenance statements be generated when the package is published.

A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider.

Note that the projen Release and Publisher components are using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.

~~npmRegistry~~Optional
  • Deprecated: use npmRegistryUrl instead
public java.lang.String getNpmRegistry();
  • Type: java.lang.String

The host name of the npm registry to publish to.

Cannot be set together with npmRegistryUrl.

npmRegistryUrlOptional 
public java.lang.String getNpmRegistryUrl();

The base URL of the npm package registry.

Must be a URL (e.g. start with "https://" or "http://")

npmTokenSecretOptional 
public java.lang.String getNpmTokenSecret();
  • Type: java.lang.String
  • Default: "NPM_TOKEN"

GitHub secret which contains the NPM token to use when publishing packages.

outdirOptional 
public java.lang.String getOutdir();
  • Type: java.lang.String
  • Default: "."

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.

packageOptional 
public java.lang.Boolean getPackage();
  • Type: java.lang.Boolean
  • Default: true

Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).

packageManagerOptional 
public NodePackageManager getPackageManager();
  • Type: io.github.cdklabs.projen.javascript.NodePackageManager
  • Default: NodePackageManager.YARN_CLASSIC

The Node Package Manager used to execute scripts.

packageNameOptional 
public java.lang.String getPackageName();
  • Type: java.lang.String
  • Default: defaults to project name

The "name" in package.json.

parentOptional 
public Project getParent();
  • Type: io.github.cdklabs.projen.Project

The parent project, if this project is part of a bigger project.

peerDependencyOptionsOptional 
public PeerDependencyOptions getPeerDependencyOptions();
  • Type: io.github.cdklabs.projen.javascript.PeerDependencyOptions

Options for peerDeps.

peerDepsOptional 
public java.util.List<java.lang.String> getPeerDeps();
  • Type: java.util.List
  • Default: []

Peer dependencies for this module.

Dependencies listed here are required to be installed (and satisfied) by the consumer of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the node_modules tree of your consumers.

Note that prior to npm@7, peer dependencies are not automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers.

Unless peerDependencyOptions.pinnedDevDependency is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required.

pnpmVersionOptional 
public java.lang.String getPnpmVersion();
  • Type: java.lang.String
  • Default: "7"

The version of PNPM to use if using PNPM as a package manager.

postBuildStepsOptional 
public java.util.List<JobStep> getPostBuildSteps();
  • Type: java.util.List
  • Default: []

Steps to execute after build as part of the release workflow.

prereleaseOptional 
public java.lang.String getPrerelease();
  • Type: java.lang.String
  • Default: normal semantic versions

Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

prettierOptional 
public java.lang.Boolean getPrettier();
  • Type: java.lang.Boolean
  • Default: false

Setup prettier.

prettierOptionsOptional 
public PrettierOptions getPrettierOptions();
  • Type: io.github.cdklabs.projen.javascript.PrettierOptions
  • Default: default options

Prettier options.

~~projectType~~Optional
  • Deprecated: no longer supported at the base project level
public ProjectType getProjectType();
  • Type: io.github.cdklabs.projen.ProjectType
  • Default: ProjectType.UNKNOWN

Which type of project this is (library/app).

projenCommandOptional 
public java.lang.String getProjenCommand();
  • Type: java.lang.String
  • Default: "npx projen"

The shell command to use in order to run the projen CLI.

Can be used to customize in special environments.

projenCredentialsOptional 
public GithubCredentials getProjenCredentials();
  • Type: io.github.cdklabs.projen.github.GithubCredentials
  • Default: use a personal access token named PROJEN_GITHUB_TOKEN

Choose a method of providing GitHub API access for projen workflows.

projenDevDependencyOptional 
public java.lang.Boolean getProjenDevDependency();
  • Type: java.lang.Boolean
  • Default: true if not a subproject

Indicates of "projen" should be installed as a devDependency.

projenrcJsOptional 
public java.lang.Boolean getProjenrcJs();
  • Type: java.lang.Boolean
  • Default: true if projenrcJson is false

Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.

projenrcJsonOptional 
public java.lang.Boolean getProjenrcJson();
  • Type: java.lang.Boolean
  • Default: false

Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

projenrcJsonOptionsOptional 
public ProjenrcJsonOptions getProjenrcJsonOptions();
  • Type: io.github.cdklabs.projen.ProjenrcJsonOptions
  • Default: default options

Options for .projenrc.json.

projenrcJsOptionsOptional 
public ProjenrcOptions getProjenrcJsOptions();
  • Type: io.github.cdklabs.projen.javascript.ProjenrcOptions
  • Default: default options

Options for .projenrc.js.

projenrcTsOptional 
public java.lang.Boolean getProjenrcTs();
  • Type: java.lang.Boolean
  • Default: false

Use TypeScript for your projenrc file (.projenrc.ts).

projenrcTsOptionsOptional 
public ProjenrcOptions getProjenrcTsOptions();
  • Type: io.github.cdklabs.projen.typescript.ProjenrcOptions

Options for .projenrc.ts.

~~projenTokenSecret~~Optional
  • Deprecated: use projenCredentials
public java.lang.String getProjenTokenSecret();
  • Type: java.lang.String
  • Default: "PROJEN_GITHUB_TOKEN"

The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.

This token needs to have the repo, workflows and packages scope.

projenVersionOptional 
public java.lang.String getProjenVersion();
  • Type: java.lang.String
  • Default: Defaults to the latest version.

Version of projen to install.

publishDryRunOptional 
public java.lang.Boolean getPublishDryRun();
  • Type: java.lang.Boolean
  • Default: false

Instead of actually publishing to package managers, just print the publishing command.

publishTasksOptional 
public java.lang.Boolean getPublishTasks();
  • Type: java.lang.Boolean
  • Default: false

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.

pullRequestTemplateOptional 
public java.lang.Boolean getPullRequestTemplate();
  • Type: java.lang.Boolean
  • Default: true

Include a GitHub pull request template.

pullRequestTemplateContentsOptional 
public java.util.List<java.lang.String> getPullRequestTemplateContents();
  • Type: java.util.List
  • Default: default content

The contents of the pull request template.

readmeOptional 
public SampleReadmeProps getReadme();
  • Type: io.github.cdklabs.projen.SampleReadmeProps
  • Default: { filename: 'README.md', contents: '# replace this' }

The README setup.

releasableCommitsOptional 
public ReleasableCommits getReleasableCommits();
  • Type: io.github.cdklabs.projen.ReleasableCommits
  • Default: ReleasableCommits.everyCommit()

Find commits that should be considered releasable Used to decide if a release is required.

releaseOptional 
public java.lang.Boolean getRelease();
  • Type: java.lang.Boolean
  • Default: true (false for subprojects)

Add release management to this project.

releaseBranchesOptional 
public java.util.Map<java.lang.String, BranchOptions> getReleaseBranches();
  • Type: java.util.Map
  • Default: no additional branches are used for release. you can use addBranch() to add additional branches.

Defines additional release branches.

A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch must be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the majorVersion field must also be provided for the default branch.

~~releaseEveryCommit~~Optional
  • Deprecated: Use releaseTrigger: ReleaseTrigger.continuous() instead
public java.lang.Boolean getReleaseEveryCommit();
  • Type: java.lang.Boolean
  • Default: true

Automatically release new versions every commit to one of branches in releaseBranches.

releaseFailureIssueOptional 
public java.lang.Boolean getReleaseFailureIssue();
  • Type: java.lang.Boolean
  • Default: false

Create a github issue on every failed publishing task.

releaseFailureIssueLabelOptional 
public java.lang.String getReleaseFailureIssueLabel();
  • Type: java.lang.String
  • Default: "failed-release"

The label to apply to issues indicating publish failures.

Only applies if releaseFailureIssue is true.

~~releaseSchedule~~Optional
  • Deprecated: Use releaseTrigger: ReleaseTrigger.scheduled() instead
public java.lang.String getReleaseSchedule();
  • Type: java.lang.String
  • Default: no scheduled releases

CRON schedule to trigger new releases.

releaseTagPrefixOptional 
public java.lang.String getReleaseTagPrefix();
  • Type: java.lang.String
  • Default: "v"

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.

releaseToNpmOptional 
public java.lang.Boolean getReleaseToNpm();
  • Type: java.lang.Boolean
  • Default: false

Automatically release to npm when new versions are introduced.

releaseTriggerOptional 
public ReleaseTrigger getReleaseTrigger();
  • Type: io.github.cdklabs.projen.release.ReleaseTrigger
  • Default: Continuous releases (ReleaseTrigger.continuous())

The release trigger to use.

~~releaseWorkflow~~Optional
  • Deprecated: see release.
public java.lang.Boolean getReleaseWorkflow();
  • Type: java.lang.Boolean
  • Default: true if not a subproject

DEPRECATED: renamed to release.

releaseWorkflowNameOptional 
public java.lang.String getReleaseWorkflowName();
  • Type: java.lang.String
  • Default: "release"

The name of the default release workflow.

releaseWorkflowSetupStepsOptional 
public java.util.List<JobStep> getReleaseWorkflowSetupSteps();
  • Type: java.util.List

A set of workflow steps to execute in order to setup the workflow container.

renovatebotOptional 
public java.lang.Boolean getRenovatebot();
  • Type: java.lang.Boolean
  • Default: false

Use renovatebot to handle dependency upgrades.

renovatebotOptionsOptional 
public RenovatebotOptions getRenovatebotOptions();
  • Type: io.github.cdklabs.projen.RenovatebotOptions
  • Default: default options

Options for renovatebot.

repositoryOptional 
public java.lang.String getRepository();
  • Type: java.lang.String

The repository is the location where the actual code for your package lives.

See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository

repositoryDirectoryOptional 
public java.lang.String getRepositoryDirectory();
  • Type: java.lang.String

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.

rewireOptional 
public java.util.Map<java.lang.String, java.lang.Object> getRewire();
  • Type: java.util.Map
  • Default: No rewired config.

Rewire webpack configuration. Use this property to override webpack configuration properties provided by create-react-app, without needing to eject.

This property will create a config-overrides.js file in your root directory, which will contain the desired rewiring code.

To override the configuration, you can provide simple key value pairs. Keys take the form of js code directives that traverse to the desired property. Values should be JSON serializable objects.

For example, the following config:

rewire: { "module.unknownContextCritical": false }

Will translate to the following config-overrides.js file:

module.exports = function override(config, env) {
  config.module.unknownContextCritical = false;
}
scopedPackagesOptionsOptional 
public java.util.List<ScopedPackagesOptions> getScopedPackagesOptions();
  • Type: java.util.List
  • Default: fetch all scoped packages from the public npm registry

Options for privately hosted scoped packages.

~~scripts~~Optional
  • Deprecated: use project.addTask() or package.setScript()
public java.util.Map<java.lang.String, java.lang.String> getScripts();
  • Type: java.util.Map
  • Default: {}

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.

srcdirOptional 
public java.lang.String getSrcdir();
  • Type: java.lang.String
  • Default: "src"

Typescript sources directory.

stabilityOptional 
public java.lang.String getStability();
  • Type: java.lang.String

Package's Stability.

staleOptional 
public java.lang.Boolean getStale();
  • Type: java.lang.Boolean
  • Default: false

Auto-close of stale issues and pull request.

See staleOptions for options.

staleOptionsOptional 
public StaleOptions getStaleOptions();
  • Type: io.github.cdklabs.projen.github.StaleOptions
  • Default: see defaults in StaleOptions

Auto-close stale issues and pull requests.

To disable set stale to false.

testdirOptional 
public java.lang.String getTestdir();
  • Type: java.lang.String
  • Default: "test"

Jest tests directory.

Tests files should be named xxx.test.ts. If this directory is under srcdir (e.g. src/test, src/__tests__), then tests are going to be compiled into lib/ and executed as javascript. If the test directory is outside of src, then we configure jest to compile the code in-memory.

tsconfigOptional 
public TypescriptConfigOptions getTsconfig();
  • Type: io.github.cdklabs.projen.javascript.TypescriptConfigOptions
  • Default: default options

Custom TSConfig.

tsconfigDevOptional 
public TypescriptConfigOptions getTsconfigDev();
  • Type: io.github.cdklabs.projen.javascript.TypescriptConfigOptions
  • Default: use the production tsconfig options

Custom tsconfig options for the development tsconfig.json file (used for testing).

tsconfigDevFileOptional 
public java.lang.String getTsconfigDevFile();
  • Type: java.lang.String
  • Default: "tsconfig.dev.json"

The name of the development tsconfig.json file.

tsJestOptionsOptional 
public TsJestOptions getTsJestOptions();
  • Type: io.github.cdklabs.projen.typescript.TsJestOptions

Options for ts-jest.

typescriptVersionOptional 
public java.lang.String getTypescriptVersion();
  • Type: java.lang.String
  • Default: "latest"

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).

versionrcOptionsOptional 
public java.util.Map<java.lang.String, java.lang.Object> getVersionrcOptions();
  • Type: java.util.Map
  • Default: standard configuration applicable for GitHub repositories

Custom configuration used when creating changelog with standard-version package.

Given values either append to default configuration or overwrite values in it.

vscodeOptional 
public java.lang.Boolean getVscode();
  • Type: java.lang.Boolean
  • Default: true

Enable VSCode integration.

Enabled by default for root projects. Disabled for non-root projects.

workflowBootstrapStepsOptional 
public java.util.List<JobStep> getWorkflowBootstrapSteps();
  • Type: java.util.List
  • Default: "yarn install --frozen-lockfile && yarn projen"

Workflow steps to use in order to bootstrap this repo.

workflowContainerImageOptional 
public java.lang.String getWorkflowContainerImage();
  • Type: java.lang.String
  • Default: default image

Container image to use for GitHub workflows.

workflowGitIdentityOptional 
public GitIdentity getWorkflowGitIdentity();
  • Type: io.github.cdklabs.projen.github.GitIdentity
  • Default: GitHub Actions

The git identity to use in workflows.

workflowNodeVersionOptional 
public java.lang.String getWorkflowNodeVersion();
  • Type: java.lang.String
  • Default: same as minNodeVersion

The node version to use in GitHub workflows.

workflowPackageCacheOptional 
public java.lang.Boolean getWorkflowPackageCache();
  • Type: java.lang.Boolean
  • Default: false

Enable Node.js package cache in GitHub workflows.

workflowRunsOnOptional 
public java.util.List<java.lang.String> getWorkflowRunsOn();
  • Type: java.util.List
  • Default: ["ubuntu-latest"]

Github Runner selection labels.

workflowRunsOnGroupOptional 
public GroupRunnerOptions getWorkflowRunsOnGroup();
  • Type: io.github.cdklabs.projen.GroupRunnerOptions

Github Runner Group selection options.

yarnBerryOptionsOptional 
public YarnBerryOptions getYarnBerryOptions();
  • Type: io.github.cdklabs.projen.javascript.YarnBerryOptions
  • Default: Yarn Berry v4 with all default options

Options for Yarn Berry.

allowSignupOptional 
public java.lang.Boolean getAllowSignup();
  • Type: java.lang.Boolean
  • Default: false

Whether to enable self sign-up.

applicationNameOptional 
public java.lang.String getApplicationName();
  • Type: java.lang.String
  • Default: "Sample App"

Name of the application name.

publicDirOptional 
public java.lang.String getPublicDir();
  • Type: java.lang.String
  • Default: "public"

Public directory.

~~typeSafeApi~~Optional
  • Deprecated: use typeSafeApis
public TypeSafeApiProject getTypeSafeApi();
  • Type: software.aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject

TypeSafeApi instance to use when setting up the initial project sample code.

typeSafeApisOptional 
public java.util.List<TypeSafeApiProject> getTypeSafeApis();
  • Type: java.util.List

TypeSafeApi instances to use when setting up the initial project sample code.

typeSafeWebSocketApisOptional 
public java.util.List<TypeSafeWebSocketApiProject> getTypeSafeWebSocketApis();
  • Type: java.util.List

TypeSafeWebSocketApi instances to use when setting up the initial project sample code.

ReactTypeScriptProjectOptions

ReactTypeScriptProjectOptions.

Initializer 

import software.aws.pdk.cloudscape_react_ts_website.ReactTypeScriptProjectOptions;

ReactTypeScriptProjectOptions.builder()
    .name(java.lang.String)
//  .allowLibraryDependencies(java.lang.Boolean)
//  .artifactsDirectory(java.lang.String)
//  .authorEmail(java.lang.String)
//  .authorName(java.lang.String)
//  .authorOrganization(java.lang.Boolean)
//  .authorUrl(java.lang.String)
//  .autoApproveOptions(AutoApproveOptions)
//  .autoApproveUpgrades(java.lang.Boolean)
//  .autoDetectBin(java.lang.Boolean)
//  .autoMerge(java.lang.Boolean)
//  .autoMergeOptions(AutoMergeOptions)
//  .bin(java.util.Map<java.lang.String, java.lang.String>)
//  .bugsEmail(java.lang.String)
//  .bugsUrl(java.lang.String)
//  .buildWorkflow(java.lang.Boolean)
//  .buildWorkflowOptions(BuildWorkflowOptions)
//  .buildWorkflowTriggers(Triggers)
//  .bundledDeps(java.util.List<java.lang.String>)
//  .bundlerOptions(BundlerOptions)
//  .checkLicenses(LicenseCheckerOptions)
//  .clobber(java.lang.Boolean)
//  .codeArtifactOptions(CodeArtifactOptions)
//  .codeCov(java.lang.Boolean)
//  .codeCovTokenSecret(java.lang.String)
//  .commitGenerated(java.lang.Boolean)
//  .copyrightOwner(java.lang.String)
//  .copyrightPeriod(java.lang.String)
//  .defaultReleaseBranch(java.lang.String)
//  .dependabot(java.lang.Boolean)
//  .dependabotOptions(DependabotOptions)
//  .deps(java.util.List<java.lang.String>)
//  .depsUpgrade(java.lang.Boolean)
//  .depsUpgradeOptions(UpgradeDependenciesOptions)
//  .description(java.lang.String)
//  .devContainer(java.lang.Boolean)
//  .devDeps(java.util.List<java.lang.String>)
//  .disableTsconfig(java.lang.Boolean)
//  .disableTsconfigDev(java.lang.Boolean)
//  .docgen(java.lang.Boolean)
//  .docsDirectory(java.lang.String)
//  .entrypoint(java.lang.String)
//  .entrypointTypes(java.lang.String)
//  .eslint(java.lang.Boolean)
//  .eslintOptions(EslintOptions)
//  .github(java.lang.Boolean)
//  .githubOptions(GitHubOptions)
//  .gitignore(java.util.List<java.lang.String>)
//  .gitIgnoreOptions(IgnoreFileOptions)
//  .gitOptions(GitOptions)
//  .gitpod(java.lang.Boolean)
//  .homepage(java.lang.String)
//  .jest(java.lang.Boolean)
//  .jestOptions(JestOptions)
//  .jsiiReleaseVersion(java.lang.String)
//  .keywords(java.util.List<java.lang.String>)
//  .libdir(java.lang.String)
//  .license(java.lang.String)
//  .licensed(java.lang.Boolean)
//  .logging(LoggerOptions)
//  .majorVersion(java.lang.Number)
//  .maxNodeVersion(java.lang.String)
//  .mergify(java.lang.Boolean)
//  .mergifyOptions(MergifyOptions)
//  .minMajorVersion(java.lang.Number)
//  .minNodeVersion(java.lang.String)
//  .mutableBuild(java.lang.Boolean)
//  .npmAccess(NpmAccess)
//  .npmDistTag(java.lang.String)
//  .npmignore(java.util.List<java.lang.String>)
//  .npmignoreEnabled(java.lang.Boolean)
//  .npmIgnoreOptions(IgnoreFileOptions)
//  .npmProvenance(java.lang.Boolean)
//  .npmRegistry(java.lang.String)
//  .npmRegistryUrl(java.lang.String)
//  .npmTokenSecret(java.lang.String)
//  .outdir(java.lang.String)
//  .package(java.lang.Boolean)
//  .packageManager(NodePackageManager)
//  .packageName(java.lang.String)
//  .parent(Project)
//  .peerDependencyOptions(PeerDependencyOptions)
//  .peerDeps(java.util.List<java.lang.String>)
//  .pnpmVersion(java.lang.String)
//  .postBuildSteps(java.util.List<JobStep>)
//  .prerelease(java.lang.String)
//  .prettier(java.lang.Boolean)
//  .prettierOptions(PrettierOptions)
//  .projectType(ProjectType)
//  .projenCommand(java.lang.String)
//  .projenCredentials(GithubCredentials)
//  .projenDevDependency(java.lang.Boolean)
//  .projenrcJs(java.lang.Boolean)
//  .projenrcJson(java.lang.Boolean)
//  .projenrcJsonOptions(ProjenrcJsonOptions)
//  .projenrcJsOptions(ProjenrcOptions)
//  .projenrcTs(java.lang.Boolean)
//  .projenrcTsOptions(ProjenrcOptions)
//  .projenTokenSecret(java.lang.String)
//  .projenVersion(java.lang.String)
//  .publishDryRun(java.lang.Boolean)
//  .publishTasks(java.lang.Boolean)
//  .pullRequestTemplate(java.lang.Boolean)
//  .pullRequestTemplateContents(java.util.List<java.lang.String>)
//  .readme(SampleReadmeProps)
//  .releasableCommits(ReleasableCommits)
//  .release(java.lang.Boolean)
//  .releaseBranches(java.util.Map<java.lang.String, BranchOptions>)
//  .releaseEveryCommit(java.lang.Boolean)
//  .releaseFailureIssue(java.lang.Boolean)
//  .releaseFailureIssueLabel(java.lang.String)
//  .releaseSchedule(java.lang.String)
//  .releaseTagPrefix(java.lang.String)
//  .releaseToNpm(java.lang.Boolean)
//  .releaseTrigger(ReleaseTrigger)
//  .releaseWorkflow(java.lang.Boolean)
//  .releaseWorkflowName(java.lang.String)
//  .releaseWorkflowSetupSteps(java.util.List<JobStep>)
//  .renovatebot(java.lang.Boolean)
//  .renovatebotOptions(RenovatebotOptions)
//  .repository(java.lang.String)
//  .repositoryDirectory(java.lang.String)
//  .rewire(java.util.Map<java.lang.String, java.lang.Object>)
//  .scopedPackagesOptions(java.util.List<ScopedPackagesOptions>)
//  .scripts(java.util.Map<java.lang.String, java.lang.String>)
//  .srcdir(java.lang.String)
//  .stability(java.lang.String)
//  .stale(java.lang.Boolean)
//  .staleOptions(StaleOptions)
//  .testdir(java.lang.String)
//  .tsconfig(TypescriptConfigOptions)
//  .tsconfigDev(TypescriptConfigOptions)
//  .tsconfigDevFile(java.lang.String)
//  .tsJestOptions(TsJestOptions)
//  .typescriptVersion(java.lang.String)
//  .versionrcOptions(java.util.Map<java.lang.String, java.lang.Object>)
//  .vscode(java.lang.Boolean)
//  .workflowBootstrapSteps(java.util.List<JobStep>)
//  .workflowContainerImage(java.lang.String)
//  .workflowGitIdentity(GitIdentity)
//  .workflowNodeVersion(java.lang.String)
//  .workflowPackageCache(java.lang.Boolean)
//  .workflowRunsOn(java.util.List<java.lang.String>)
//  .workflowRunsOnGroup(GroupRunnerOptions)
//  .yarnBerryOptions(YarnBerryOptions)
    .build();

Properties

Name Type Description
name java.lang.String No description.
allowLibraryDependencies java.lang.Boolean Allow the project to include peerDependencies and bundledDependencies.
artifactsDirectory java.lang.String A directory which will contain build artifacts.
authorEmail java.lang.String Author's e-mail.
authorName java.lang.String Author's name.
authorOrganization java.lang.Boolean Is the author an organization.
authorUrl java.lang.String Author's URL / Website.
autoApproveOptions io.github.cdklabs.projen.github.AutoApproveOptions Enable and configure the 'auto approve' workflow.
autoApproveUpgrades java.lang.Boolean Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
autoDetectBin java.lang.Boolean Automatically add all executables under the bin directory to your package.json file under the bin section.
autoMerge java.lang.Boolean Enable automatic merging on GitHub.
autoMergeOptions io.github.cdklabs.projen.github.AutoMergeOptions Configure options for automatic merging on GitHub.
bin java.util.Map Binary programs vended with your module.
bugsEmail java.lang.String The email address to which issues should be reported.
bugsUrl java.lang.String The url to your project's issue tracker.
buildWorkflow java.lang.Boolean Define a GitHub workflow for building PRs.
buildWorkflowOptions io.github.cdklabs.projen.javascript.BuildWorkflowOptions Options for PR build workflow.
buildWorkflowTriggers io.github.cdklabs.projen.github.workflows.Triggers Build workflow triggers.
bundledDeps java.util.List List of dependencies to bundle into this module.
bundlerOptions io.github.cdklabs.projen.javascript.BundlerOptions Options for Bundler.
checkLicenses io.github.cdklabs.projen.javascript.LicenseCheckerOptions Configure which licenses should be deemed acceptable for use by dependencies.
clobber java.lang.Boolean Add a clobber task which resets the repo to origin.
codeArtifactOptions io.github.cdklabs.projen.javascript.CodeArtifactOptions Options for npm packages using AWS CodeArtifact.
codeCov java.lang.Boolean Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with @codeCovTokenSecret.
codeCovTokenSecret java.lang.String Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
commitGenerated java.lang.Boolean Whether to commit the managed files by default.
copyrightOwner java.lang.String License copyright owner.
copyrightPeriod java.lang.String The copyright years to put in the LICENSE file.
defaultReleaseBranch java.lang.String The name of the main release branch.
dependabot java.lang.Boolean Use dependabot to handle dependency upgrades.
dependabotOptions io.github.cdklabs.projen.github.DependabotOptions Options for dependabot.
deps java.util.List Runtime dependencies of this module.
depsUpgrade java.lang.Boolean Use tasks and github workflows to handle dependency upgrades.
depsUpgradeOptions io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions Options for UpgradeDependencies.
description java.lang.String The description is just a string that helps people understand the purpose of the package.
devContainer java.lang.Boolean Add a VSCode development environment (used for GitHub Codespaces).
devDeps java.util.List Build dependencies for this module.
disableTsconfig java.lang.Boolean Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
disableTsconfigDev java.lang.Boolean Do not generate a tsconfig.dev.json file.
docgen java.lang.Boolean Docgen by Typedoc.
docsDirectory java.lang.String Docs directory.
entrypoint java.lang.String Module entrypoint (main in package.json). Set to an empty string to not include main in your package.json.
entrypointTypes java.lang.String The .d.ts file that includes the type declarations for this module.
eslint java.lang.Boolean Setup eslint.
eslintOptions io.github.cdklabs.projen.javascript.EslintOptions Eslint options.
github java.lang.Boolean Enable GitHub integration.
githubOptions io.github.cdklabs.projen.github.GitHubOptions Options for GitHub integration.
gitignore java.util.List Additional entries to .gitignore.
gitIgnoreOptions io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .gitignore file.
gitOptions io.github.cdklabs.projen.GitOptions Configuration options for git.
gitpod java.lang.Boolean Add a Gitpod development environment.
homepage java.lang.String Package's Homepage / Website.
jest java.lang.Boolean Setup jest unit tests.
jestOptions io.github.cdklabs.projen.javascript.JestOptions Jest options.
jsiiReleaseVersion java.lang.String Version requirement of publib which is used to publish modules to npm.
keywords java.util.List Keywords to include in package.json.
libdir java.lang.String Typescript artifacts output directory.
license java.lang.String License's SPDX identifier.
licensed java.lang.Boolean Indicates if a license should be added.
logging io.github.cdklabs.projen.LoggerOptions Configure logging options such as verbosity.
majorVersion java.lang.Number Major version to release from the default branch.
maxNodeVersion java.lang.String Minimum node.js version to require via engines (inclusive).
mergify java.lang.Boolean Whether mergify should be enabled on this repository or not.
mergifyOptions io.github.cdklabs.projen.github.MergifyOptions Options for mergify.
minMajorVersion java.lang.Number Minimal Major version to release.
minNodeVersion java.lang.String Minimum Node.js version to require via package.json engines (inclusive).
mutableBuild java.lang.Boolean Automatically update files modified during builds to pull-request branches.
npmAccess io.github.cdklabs.projen.javascript.NpmAccess Access level of the npm package.
npmDistTag java.lang.String The npmDistTag to use when publishing from the default branch.
npmignore java.util.List Additional entries to .npmignore.
npmignoreEnabled java.lang.Boolean Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
npmIgnoreOptions io.github.cdklabs.projen.IgnoreFileOptions Configuration options for .npmignore file.
npmProvenance java.lang.Boolean Should provenance statements be generated when the package is published.
npmRegistry java.lang.String The host name of the npm registry to publish to.
npmRegistryUrl java.lang.String The base URL of the npm package registry.
npmTokenSecret java.lang.String GitHub secret which contains the NPM token to use when publishing packages.
outdir java.lang.String The root directory of the project. Relative to this directory, all files are synthesized.
package java.lang.Boolean Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
packageManager io.github.cdklabs.projen.javascript.NodePackageManager The Node Package Manager used to execute scripts.
packageName java.lang.String The "name" in package.json.
parent io.github.cdklabs.projen.Project The parent project, if this project is part of a bigger project.
peerDependencyOptions io.github.cdklabs.projen.javascript.PeerDependencyOptions Options for peerDeps.
peerDeps java.util.List Peer dependencies for this module.
pnpmVersion java.lang.String The version of PNPM to use if using PNPM as a package manager.
postBuildSteps java.util.List Steps to execute after build as part of the release workflow.
prerelease java.lang.String Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
prettier java.lang.Boolean Setup prettier.
prettierOptions io.github.cdklabs.projen.javascript.PrettierOptions Prettier options.
projectType io.github.cdklabs.projen.ProjectType Which type of project this is (library/app).
projenCommand java.lang.String The shell command to use in order to run the projen CLI.
projenCredentials io.github.cdklabs.projen.github.GithubCredentials Choose a method of providing GitHub API access for projen workflows.
projenDevDependency java.lang.Boolean Indicates of "projen" should be installed as a devDependency.
projenrcJs java.lang.Boolean Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
projenrcJson java.lang.Boolean Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
projenrcJsonOptions io.github.cdklabs.projen.ProjenrcJsonOptions Options for .projenrc.json.
projenrcJsOptions io.github.cdklabs.projen.javascript.ProjenrcOptions Options for .projenrc.js.
projenrcTs java.lang.Boolean Use TypeScript for your projenrc file (.projenrc.ts).
projenrcTsOptions io.github.cdklabs.projen.typescript.ProjenrcOptions Options for .projenrc.ts.
projenTokenSecret java.lang.String The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
projenVersion java.lang.String Version of projen to install.
publishDryRun java.lang.Boolean Instead of actually publishing to package managers, just print the publishing command.
publishTasks java.lang.Boolean Define publishing tasks that can be executed manually as well as workflows.
pullRequestTemplate java.lang.Boolean Include a GitHub pull request template.
pullRequestTemplateContents java.util.List The contents of the pull request template.
readme io.github.cdklabs.projen.SampleReadmeProps The README setup.
releasableCommits io.github.cdklabs.projen.ReleasableCommits Find commits that should be considered releasable Used to decide if a release is required.
release java.lang.Boolean Add release management to this project.
releaseBranches java.util.Map Defines additional release branches.
releaseEveryCommit java.lang.Boolean Automatically release new versions every commit to one of branches in releaseBranches.
releaseFailureIssue java.lang.Boolean Create a github issue on every failed publishing task.
releaseFailureIssueLabel java.lang.String The label to apply to issues indicating publish failures.
releaseSchedule java.lang.String CRON schedule to trigger new releases.
releaseTagPrefix java.lang.String Automatically add the given prefix to release tags.
releaseToNpm java.lang.Boolean Automatically release to npm when new versions are introduced.
releaseTrigger io.github.cdklabs.projen.release.ReleaseTrigger The release trigger to use.
releaseWorkflow java.lang.Boolean DEPRECATED: renamed to release.
releaseWorkflowName java.lang.String The name of the default release workflow.
releaseWorkflowSetupSteps java.util.List A set of workflow steps to execute in order to setup the workflow container.
renovatebot java.lang.Boolean Use renovatebot to handle dependency upgrades.
renovatebotOptions io.github.cdklabs.projen.RenovatebotOptions Options for renovatebot.
repository java.lang.String The repository is the location where the actual code for your package lives.
repositoryDirectory java.lang.String 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.
rewire java.util.Map Rewire webpack configuration. Use this property to override webpack configuration properties provided by create-react-app, without needing to eject.
scopedPackagesOptions java.util.List Options for privately hosted scoped packages.
scripts java.util.Map npm scripts to include.
srcdir java.lang.String Typescript sources directory.
stability java.lang.String Package's Stability.
stale java.lang.Boolean Auto-close of stale issues and pull request.
staleOptions io.github.cdklabs.projen.github.StaleOptions Auto-close stale issues and pull requests.
testdir java.lang.String Jest tests directory.
tsconfig io.github.cdklabs.projen.javascript.TypescriptConfigOptions Custom TSConfig.
tsconfigDev io.github.cdklabs.projen.javascript.TypescriptConfigOptions Custom tsconfig options for the development tsconfig.json file (used for testing).
tsconfigDevFile java.lang.String The name of the development tsconfig.json file.
tsJestOptions io.github.cdklabs.projen.typescript.TsJestOptions Options for ts-jest.
typescriptVersion java.lang.String TypeScript version to use.
versionrcOptions java.util.Map Custom configuration used when creating changelog with standard-version package.
vscode java.lang.Boolean Enable VSCode integration.
workflowBootstrapSteps java.util.List Workflow steps to use in order to bootstrap this repo.
workflowContainerImage java.lang.String Container image to use for GitHub workflows.
workflowGitIdentity io.github.cdklabs.projen.github.GitIdentity The git identity to use in workflows.
workflowNodeVersion java.lang.String The node version to use in GitHub workflows.
workflowPackageCache java.lang.Boolean Enable Node.js package cache in GitHub workflows.
workflowRunsOn java.util.List Github Runner selection labels.
workflowRunsOnGroup io.github.cdklabs.projen.GroupRunnerOptions Github Runner Group selection options.
yarnBerryOptions io.github.cdklabs.projen.javascript.YarnBerryOptions Options for Yarn Berry.
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
allowLibraryDependenciesOptional 
public java.lang.Boolean getAllowLibraryDependencies();
  • Type: java.lang.Boolean
  • Default: true

Allow the project to include peerDependencies and bundledDependencies.

This is normally only allowed for libraries. For apps, there's no meaning for specifying these.

artifactsDirectoryOptional 
public java.lang.String getArtifactsDirectory();
  • Type: java.lang.String
  • Default: "dist"

A directory which will contain build artifacts.

authorEmailOptional 
public java.lang.String getAuthorEmail();
  • Type: java.lang.String

Author's e-mail.

authorNameOptional 
public java.lang.String getAuthorName();
  • Type: java.lang.String

Author's name.

authorOrganizationOptional 
public java.lang.Boolean getAuthorOrganization();
  • Type: java.lang.Boolean

Is the author an organization.

authorUrlOptional 
public java.lang.String getAuthorUrl();
  • Type: java.lang.String

Author's URL / Website.

autoApproveOptionsOptional 
public AutoApproveOptions getAutoApproveOptions();
  • Type: io.github.cdklabs.projen.github.AutoApproveOptions
  • Default: auto approve is disabled

Enable and configure the 'auto approve' workflow.

autoApproveUpgradesOptional 
public java.lang.Boolean getAutoApproveUpgrades();
  • Type: java.lang.Boolean
  • Default: true

Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).

Throw if set to true but autoApproveOptions are not defined.

autoDetectBinOptional 
public java.lang.Boolean getAutoDetectBin();
  • Type: java.lang.Boolean
  • Default: true

Automatically add all executables under the bin directory to your package.json file under the bin section.

autoMergeOptional 
public java.lang.Boolean getAutoMerge();
  • Type: java.lang.Boolean
  • Default: true

Enable automatic merging on GitHub.

Has no effect if github.mergify is set to false.

autoMergeOptionsOptional 
public AutoMergeOptions getAutoMergeOptions();
  • Type: io.github.cdklabs.projen.github.AutoMergeOptions
  • Default: see defaults in AutoMergeOptions

Configure options for automatic merging on GitHub.

Has no effect if github.mergify or autoMerge is set to false.

binOptional 
public java.util.Map<java.lang.String, java.lang.String> getBin();
  • Type: java.util.Map

Binary programs vended with your module.

You can use this option to add/customize how binaries are represented in your package.json, but unless autoDetectBin is false, every executable file under bin will automatically be added to this section.

bugsEmailOptional 
public java.lang.String getBugsEmail();
  • Type: java.lang.String

The email address to which issues should be reported.

bugsUrlOptional 
public java.lang.String getBugsUrl();
  • Type: java.lang.String

The url to your project's issue tracker.

buildWorkflowOptional 
public java.lang.Boolean getBuildWorkflow();
  • Type: java.lang.Boolean
  • Default: true if not a subproject

Define a GitHub workflow for building PRs.

buildWorkflowOptionsOptional 
public BuildWorkflowOptions getBuildWorkflowOptions();
  • Type: io.github.cdklabs.projen.javascript.BuildWorkflowOptions

Options for PR build workflow.

~~buildWorkflowTriggers~~Optional
  • Deprecated: - Use buildWorkflowOptions.workflowTriggers
public Triggers getBuildWorkflowTriggers();
  • Type: io.github.cdklabs.projen.github.workflows.Triggers
  • Default: "{ pullRequest: {}, workflowDispatch: {} }"

Build workflow triggers.

bundledDepsOptional 
public java.util.List<java.lang.String> getBundledDeps();
  • Type: java.util.List

List of dependencies to bundle into this module.

These modules will be added both to the dependencies section and bundledDependencies section of your package.json.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

bundlerOptionsOptional 
public BundlerOptions getBundlerOptions();
  • Type: io.github.cdklabs.projen.javascript.BundlerOptions

Options for Bundler.

checkLicensesOptional 
public LicenseCheckerOptions getCheckLicenses();
  • Type: io.github.cdklabs.projen.javascript.LicenseCheckerOptions
  • Default: no license checks are run during the build and all licenses will be accepted

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.

clobberOptional 
public java.lang.Boolean getClobber();
  • Type: java.lang.Boolean
  • Default: true, but false for subprojects

Add a clobber task which resets the repo to origin.

codeArtifactOptionsOptional 
public CodeArtifactOptions getCodeArtifactOptions();
  • Type: io.github.cdklabs.projen.javascript.CodeArtifactOptions
  • Default: undefined

Options for npm packages using AWS CodeArtifact.

This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact

codeCovOptional 
public java.lang.Boolean getCodeCov();
  • Type: java.lang.Boolean
  • Default: false

Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with @codeCovTokenSecret.

codeCovTokenSecretOptional 
public java.lang.String getCodeCovTokenSecret();
  • Type: java.lang.String
  • Default: if this option is not specified, only public repositories are supported

Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.

commitGeneratedOptional 
public java.lang.Boolean getCommitGenerated();
  • Type: java.lang.Boolean
  • Default: true

Whether to commit the managed files by default.

copyrightOwnerOptional 
public java.lang.String getCopyrightOwner();
  • Type: java.lang.String
  • Default: defaults to the value of authorName or "" if authorName is undefined.

License copyright owner.

copyrightPeriodOptional 
public java.lang.String getCopyrightPeriod();
  • Type: java.lang.String
  • Default: current year

The copyright years to put in the LICENSE file.

defaultReleaseBranchOptional 
public java.lang.String getDefaultReleaseBranch();
  • Type: java.lang.String
  • Default: "main"

The name of the main release branch.

dependabotOptional 
public java.lang.Boolean getDependabot();
  • Type: java.lang.Boolean
  • Default: false

Use dependabot to handle dependency upgrades.

Cannot be used in conjunction with depsUpgrade.

dependabotOptionsOptional 
public DependabotOptions getDependabotOptions();
  • Type: io.github.cdklabs.projen.github.DependabotOptions
  • Default: default options

Options for dependabot.

depsOptional 
public java.util.List<java.lang.String> getDeps();
  • Type: java.util.List
  • Default: []

Runtime dependencies of this module.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

depsUpgradeOptional 
public java.lang.Boolean getDepsUpgrade();
  • Type: java.lang.Boolean
  • Default: true

Use tasks and github workflows to handle dependency upgrades.

Cannot be used in conjunction with dependabot.

depsUpgradeOptionsOptional 
public UpgradeDependenciesOptions getDepsUpgradeOptions();
  • Type: io.github.cdklabs.projen.javascript.UpgradeDependenciesOptions
  • Default: default options

Options for UpgradeDependencies.

descriptionOptional 
public java.lang.String getDescription();
  • Type: java.lang.String

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

devContainerOptional 
public java.lang.Boolean getDevContainer();
  • Type: java.lang.Boolean
  • Default: false

Add a VSCode development environment (used for GitHub Codespaces).

devDepsOptional 
public java.util.List<java.lang.String> getDevDeps();
  • Type: java.util.List
  • Default: []

Build dependencies for this module.

These dependencies will only be available in your build environment but will not be fetched when this module is consumed.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

disableTsconfigOptional 
public java.lang.Boolean getDisableTsconfig();
  • Type: java.lang.Boolean
  • Default: false

Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).

disableTsconfigDevOptional 
public java.lang.Boolean getDisableTsconfigDev();
  • Type: java.lang.Boolean
  • Default: false

Do not generate a tsconfig.dev.json file.

docgenOptional 
public java.lang.Boolean getDocgen();
  • Type: java.lang.Boolean
  • Default: false

Docgen by Typedoc.

docsDirectoryOptional 
public java.lang.String getDocsDirectory();
  • Type: java.lang.String
  • Default: "docs"

Docs directory.

entrypointOptional 
public java.lang.String getEntrypoint();
  • Type: java.lang.String
  • Default: "lib/index.js"

Module entrypoint (main in package.json). Set to an empty string to not include main in your package.json.

entrypointTypesOptional 
public java.lang.String getEntrypointTypes();
  • Type: java.lang.String
  • Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)

The .d.ts file that includes the type declarations for this module.

eslintOptional 
public java.lang.Boolean getEslint();
  • Type: java.lang.Boolean
  • Default: true

Setup eslint.

eslintOptionsOptional 
public EslintOptions getEslintOptions();
  • Type: io.github.cdklabs.projen.javascript.EslintOptions
  • Default: opinionated default options

Eslint options.

githubOptional 
public java.lang.Boolean getGithub();
  • Type: java.lang.Boolean
  • Default: true

Enable GitHub integration.

Enabled by default for root projects. Disabled for non-root projects.

githubOptionsOptional 
public GitHubOptions getGithubOptions();
  • Type: io.github.cdklabs.projen.github.GitHubOptions
  • Default: see GitHubOptions

Options for GitHub integration.

gitignoreOptional 
public java.util.List<java.lang.String> getGitignore();
  • Type: java.util.List

Additional entries to .gitignore.

gitIgnoreOptionsOptional 
public IgnoreFileOptions getGitIgnoreOptions();
  • Type: io.github.cdklabs.projen.IgnoreFileOptions

Configuration options for .gitignore file.

gitOptionsOptional 
public GitOptions getGitOptions();
  • Type: io.github.cdklabs.projen.GitOptions

Configuration options for git.

gitpodOptional 
public java.lang.Boolean getGitpod();
  • Type: java.lang.Boolean
  • Default: false

Add a Gitpod development environment.

homepageOptional 
public java.lang.String getHomepage();
  • Type: java.lang.String

Package's Homepage / Website.

jestOptional 
public java.lang.Boolean getJest();
  • Type: java.lang.Boolean
  • Default: true

Setup jest unit tests.

jestOptionsOptional 
public JestOptions getJestOptions();
  • Type: io.github.cdklabs.projen.javascript.JestOptions
  • Default: default options

Jest options.

jsiiReleaseVersionOptional 
public java.lang.String getJsiiReleaseVersion();
  • Type: java.lang.String
  • Default: "latest"

Version requirement of publib which is used to publish modules to npm.

keywordsOptional 
public java.util.List<java.lang.String> getKeywords();
  • Type: java.util.List

Keywords to include in package.json.

libdirOptional 
public java.lang.String getLibdir();
  • Type: java.lang.String
  • Default: "lib"

Typescript artifacts output directory.

licenseOptional 
public java.lang.String getLicense();
  • Type: java.lang.String
  • Default: "Apache-2.0"

License's SPDX identifier.

See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the licensed option if you want to no license to be specified.

licensedOptional 
public java.lang.Boolean getLicensed();
  • Type: java.lang.Boolean
  • Default: true

Indicates if a license should be added.

loggingOptional 
public LoggerOptions getLogging();
  • Type: io.github.cdklabs.projen.LoggerOptions
  • Default: {}

Configure logging options such as verbosity.

majorVersionOptional 
public java.lang.Number getMajorVersion();
  • Type: java.lang.Number
  • Default: Major version is not enforced.

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.

maxNodeVersionOptional 
public java.lang.String getMaxNodeVersion();
  • Type: java.lang.String
  • Default: no max

Minimum node.js version to require via engines (inclusive).

~~mergify~~Optional
  • Deprecated: use githubOptions.mergify instead
public java.lang.Boolean getMergify();
  • Type: java.lang.Boolean
  • Default: true

Whether mergify should be enabled on this repository or not.

~~mergifyOptions~~Optional
  • Deprecated: use githubOptions.mergifyOptions instead
public MergifyOptions getMergifyOptions();
  • Type: io.github.cdklabs.projen.github.MergifyOptions
  • Default: default options

Options for mergify.

minMajorVersionOptional 
public java.lang.Number getMinMajorVersion();
  • Type: java.lang.Number
  • Default: No minimum version is being enforced

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.

minNodeVersionOptional 
public java.lang.String getMinNodeVersion();
  • Type: java.lang.String
  • Default: no "engines" specified

Minimum Node.js version to require via package.json engines (inclusive).

~~mutableBuild~~Optional
  • Deprecated: - Use buildWorkflowOptions.mutableBuild
public java.lang.Boolean getMutableBuild();
  • Type: java.lang.Boolean
  • Default: true

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.

npmAccessOptional 
public NpmAccess getNpmAccess();
  • Type: io.github.cdklabs.projen.javascript.NpmAccess
  • Default: for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.

Access level of the npm package.

npmDistTagOptional 
public java.lang.String getNpmDistTag();
  • Type: java.lang.String
  • Default: "latest"

The npmDistTag to use when publishing from the default branch.

To set the npm dist-tag for release branches, set the npmDistTag property for each branch.

~~npmignore~~Optional
  • Deprecated: - use project.addPackageIgnore
public java.util.List<java.lang.String> getNpmignore();
  • Type: java.util.List

Additional entries to .npmignore.

npmignoreEnabledOptional 
public java.lang.Boolean getNpmignoreEnabled();
  • Type: java.lang.Boolean
  • Default: true

Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.

npmIgnoreOptionsOptional 
public IgnoreFileOptions getNpmIgnoreOptions();
  • Type: io.github.cdklabs.projen.IgnoreFileOptions

Configuration options for .npmignore file.

npmProvenanceOptional 
public java.lang.Boolean getNpmProvenance();
  • Type: java.lang.Boolean
  • Default: true for public packages, false otherwise

Should provenance statements be generated when the package is published.

A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider.

Note that the projen Release and Publisher components are using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.

~~npmRegistry~~Optional
  • Deprecated: use npmRegistryUrl instead
public java.lang.String getNpmRegistry();
  • Type: java.lang.String

The host name of the npm registry to publish to.

Cannot be set together with npmRegistryUrl.

npmRegistryUrlOptional 
public java.lang.String getNpmRegistryUrl();

The base URL of the npm package registry.

Must be a URL (e.g. start with "https://" or "http://")

npmTokenSecretOptional 
public java.lang.String getNpmTokenSecret();
  • Type: java.lang.String
  • Default: "NPM_TOKEN"

GitHub secret which contains the NPM token to use when publishing packages.

outdirOptional 
public java.lang.String getOutdir();
  • Type: java.lang.String
  • Default: "."

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.

packageOptional 
public java.lang.Boolean getPackage();
  • Type: java.lang.Boolean
  • Default: true

Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).

packageManagerOptional 
public NodePackageManager getPackageManager();
  • Type: io.github.cdklabs.projen.javascript.NodePackageManager
  • Default: NodePackageManager.YARN_CLASSIC

The Node Package Manager used to execute scripts.

packageNameOptional 
public java.lang.String getPackageName();
  • Type: java.lang.String
  • Default: defaults to project name

The "name" in package.json.

parentOptional 
public Project getParent();
  • Type: io.github.cdklabs.projen.Project

The parent project, if this project is part of a bigger project.

peerDependencyOptionsOptional 
public PeerDependencyOptions getPeerDependencyOptions();
  • Type: io.github.cdklabs.projen.javascript.PeerDependencyOptions

Options for peerDeps.

peerDepsOptional 
public java.util.List<java.lang.String> getPeerDeps();
  • Type: java.util.List
  • Default: []

Peer dependencies for this module.

Dependencies listed here are required to be installed (and satisfied) by the consumer of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the node_modules tree of your consumers.

Note that prior to npm@7, peer dependencies are not automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers.

Unless peerDependencyOptions.pinnedDevDependency is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required.

pnpmVersionOptional 
public java.lang.String getPnpmVersion();
  • Type: java.lang.String
  • Default: "7"

The version of PNPM to use if using PNPM as a package manager.

postBuildStepsOptional 
public java.util.List<JobStep> getPostBuildSteps();
  • Type: java.util.List
  • Default: []

Steps to execute after build as part of the release workflow.

prereleaseOptional 
public java.lang.String getPrerelease();
  • Type: java.lang.String
  • Default: normal semantic versions

Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

prettierOptional 
public java.lang.Boolean getPrettier();
  • Type: java.lang.Boolean
  • Default: false

Setup prettier.

prettierOptionsOptional 
public PrettierOptions getPrettierOptions();
  • Type: io.github.cdklabs.projen.javascript.PrettierOptions
  • Default: default options

Prettier options.

~~projectType~~Optional
  • Deprecated: no longer supported at the base project level
public ProjectType getProjectType();
  • Type: io.github.cdklabs.projen.ProjectType
  • Default: ProjectType.UNKNOWN

Which type of project this is (library/app).

projenCommandOptional 
public java.lang.String getProjenCommand();
  • Type: java.lang.String
  • Default: "npx projen"

The shell command to use in order to run the projen CLI.

Can be used to customize in special environments.

projenCredentialsOptional 
public GithubCredentials getProjenCredentials();
  • Type: io.github.cdklabs.projen.github.GithubCredentials
  • Default: use a personal access token named PROJEN_GITHUB_TOKEN

Choose a method of providing GitHub API access for projen workflows.

projenDevDependencyOptional 
public java.lang.Boolean getProjenDevDependency();
  • Type: java.lang.Boolean
  • Default: true if not a subproject

Indicates of "projen" should be installed as a devDependency.

projenrcJsOptional 
public java.lang.Boolean getProjenrcJs();
  • Type: java.lang.Boolean
  • Default: true if projenrcJson is false

Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.

projenrcJsonOptional 
public java.lang.Boolean getProjenrcJson();
  • Type: java.lang.Boolean
  • Default: false

Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

projenrcJsonOptionsOptional 
public ProjenrcJsonOptions getProjenrcJsonOptions();
  • Type: io.github.cdklabs.projen.ProjenrcJsonOptions
  • Default: default options

Options for .projenrc.json.

projenrcJsOptionsOptional 
public ProjenrcOptions getProjenrcJsOptions();
  • Type: io.github.cdklabs.projen.javascript.ProjenrcOptions
  • Default: default options

Options for .projenrc.js.

projenrcTsOptional 
public java.lang.Boolean getProjenrcTs();
  • Type: java.lang.Boolean
  • Default: false

Use TypeScript for your projenrc file (.projenrc.ts).

projenrcTsOptionsOptional 
public ProjenrcOptions getProjenrcTsOptions();
  • Type: io.github.cdklabs.projen.typescript.ProjenrcOptions

Options for .projenrc.ts.

~~projenTokenSecret~~Optional
  • Deprecated: use projenCredentials
public java.lang.String getProjenTokenSecret();
  • Type: java.lang.String
  • Default: "PROJEN_GITHUB_TOKEN"

The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.

This token needs to have the repo, workflows and packages scope.

projenVersionOptional 
public java.lang.String getProjenVersion();
  • Type: java.lang.String
  • Default: Defaults to the latest version.

Version of projen to install.

publishDryRunOptional 
public java.lang.Boolean getPublishDryRun();
  • Type: java.lang.Boolean
  • Default: false

Instead of actually publishing to package managers, just print the publishing command.

publishTasksOptional 
public java.lang.Boolean getPublishTasks();
  • Type: java.lang.Boolean
  • Default: false

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.

pullRequestTemplateOptional 
public java.lang.Boolean getPullRequestTemplate();
  • Type: java.lang.Boolean
  • Default: true

Include a GitHub pull request template.

pullRequestTemplateContentsOptional 
public java.util.List<java.lang.String> getPullRequestTemplateContents();
  • Type: java.util.List
  • Default: default content

The contents of the pull request template.

readmeOptional 
public SampleReadmeProps getReadme();
  • Type: io.github.cdklabs.projen.SampleReadmeProps
  • Default: { filename: 'README.md', contents: '# replace this' }

The README setup.

releasableCommitsOptional 
public ReleasableCommits getReleasableCommits();
  • Type: io.github.cdklabs.projen.ReleasableCommits
  • Default: ReleasableCommits.everyCommit()

Find commits that should be considered releasable Used to decide if a release is required.

releaseOptional 
public java.lang.Boolean getRelease();
  • Type: java.lang.Boolean
  • Default: true (false for subprojects)

Add release management to this project.

releaseBranchesOptional 
public java.util.Map<java.lang.String, BranchOptions> getReleaseBranches();
  • Type: java.util.Map
  • Default: no additional branches are used for release. you can use addBranch() to add additional branches.

Defines additional release branches.

A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch must be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the majorVersion field must also be provided for the default branch.

~~releaseEveryCommit~~Optional
  • Deprecated: Use releaseTrigger: ReleaseTrigger.continuous() instead
public java.lang.Boolean getReleaseEveryCommit();
  • Type: java.lang.Boolean
  • Default: true

Automatically release new versions every commit to one of branches in releaseBranches.

releaseFailureIssueOptional 
public java.lang.Boolean getReleaseFailureIssue();
  • Type: java.lang.Boolean
  • Default: false

Create a github issue on every failed publishing task.

releaseFailureIssueLabelOptional 
public java.lang.String getReleaseFailureIssueLabel();
  • Type: java.lang.String
  • Default: "failed-release"

The label to apply to issues indicating publish failures.

Only applies if releaseFailureIssue is true.

~~releaseSchedule~~Optional
  • Deprecated: Use releaseTrigger: ReleaseTrigger.scheduled() instead
public java.lang.String getReleaseSchedule();
  • Type: java.lang.String
  • Default: no scheduled releases

CRON schedule to trigger new releases.

releaseTagPrefixOptional 
public java.lang.String getReleaseTagPrefix();
  • Type: java.lang.String
  • Default: "v"

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.

releaseToNpmOptional 
public java.lang.Boolean getReleaseToNpm();
  • Type: java.lang.Boolean
  • Default: false

Automatically release to npm when new versions are introduced.

releaseTriggerOptional 
public ReleaseTrigger getReleaseTrigger();
  • Type: io.github.cdklabs.projen.release.ReleaseTrigger
  • Default: Continuous releases (ReleaseTrigger.continuous())

The release trigger to use.

~~releaseWorkflow~~Optional
  • Deprecated: see release.
public java.lang.Boolean getReleaseWorkflow();
  • Type: java.lang.Boolean
  • Default: true if not a subproject

DEPRECATED: renamed to release.

releaseWorkflowNameOptional 
public java.lang.String getReleaseWorkflowName();
  • Type: java.lang.String
  • Default: "release"

The name of the default release workflow.

releaseWorkflowSetupStepsOptional 
public java.util.List<JobStep> getReleaseWorkflowSetupSteps();
  • Type: java.util.List

A set of workflow steps to execute in order to setup the workflow container.

renovatebotOptional 
public java.lang.Boolean getRenovatebot();
  • Type: java.lang.Boolean
  • Default: false

Use renovatebot to handle dependency upgrades.

renovatebotOptionsOptional 
public RenovatebotOptions getRenovatebotOptions();
  • Type: io.github.cdklabs.projen.RenovatebotOptions
  • Default: default options

Options for renovatebot.

repositoryOptional 
public java.lang.String getRepository();
  • Type: java.lang.String

The repository is the location where the actual code for your package lives.

See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository

repositoryDirectoryOptional 
public java.lang.String getRepositoryDirectory();
  • Type: java.lang.String

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.

rewireOptional 
public java.util.Map<java.lang.String, java.lang.Object> getRewire();
  • Type: java.util.Map
  • Default: No rewired config.

Rewire webpack configuration. Use this property to override webpack configuration properties provided by create-react-app, without needing to eject.

This property will create a config-overrides.js file in your root directory, which will contain the desired rewiring code.

To override the configuration, you can provide simple key value pairs. Keys take the form of js code directives that traverse to the desired property. Values should be JSON serializable objects.

For example, the following config:

rewire: { "module.unknownContextCritical": false }

Will translate to the following config-overrides.js file:

module.exports = function override(config, env) {
  config.module.unknownContextCritical = false;
}
scopedPackagesOptionsOptional 
public java.util.List<ScopedPackagesOptions> getScopedPackagesOptions();
  • Type: java.util.List
  • Default: fetch all scoped packages from the public npm registry

Options for privately hosted scoped packages.

~~scripts~~Optional
  • Deprecated: use project.addTask() or package.setScript()
public java.util.Map<java.lang.String, java.lang.String> getScripts();
  • Type: java.util.Map
  • Default: {}

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.

srcdirOptional 
public java.lang.String getSrcdir();
  • Type: java.lang.String
  • Default: "src"

Typescript sources directory.

stabilityOptional 
public java.lang.String getStability();
  • Type: java.lang.String

Package's Stability.

staleOptional 
public java.lang.Boolean getStale();
  • Type: java.lang.Boolean
  • Default: false

Auto-close of stale issues and pull request.

See staleOptions for options.

staleOptionsOptional 
public StaleOptions getStaleOptions();
  • Type: io.github.cdklabs.projen.github.StaleOptions
  • Default: see defaults in StaleOptions

Auto-close stale issues and pull requests.

To disable set stale to false.

testdirOptional 
public java.lang.String getTestdir();
  • Type: java.lang.String
  • Default: "test"

Jest tests directory.

Tests files should be named xxx.test.ts. If this directory is under srcdir (e.g. src/test, src/__tests__), then tests are going to be compiled into lib/ and executed as javascript. If the test directory is outside of src, then we configure jest to compile the code in-memory.

tsconfigOptional 
public TypescriptConfigOptions getTsconfig();
  • Type: io.github.cdklabs.projen.javascript.TypescriptConfigOptions
  • Default: default options

Custom TSConfig.

tsconfigDevOptional 
public TypescriptConfigOptions getTsconfigDev();
  • Type: io.github.cdklabs.projen.javascript.TypescriptConfigOptions
  • Default: use the production tsconfig options

Custom tsconfig options for the development tsconfig.json file (used for testing).

tsconfigDevFileOptional 
public java.lang.String getTsconfigDevFile();
  • Type: java.lang.String
  • Default: "tsconfig.dev.json"

The name of the development tsconfig.json file.

tsJestOptionsOptional 
public TsJestOptions getTsJestOptions();
  • Type: io.github.cdklabs.projen.typescript.TsJestOptions

Options for ts-jest.

typescriptVersionOptional 
public java.lang.String getTypescriptVersion();
  • Type: java.lang.String
  • Default: "latest"

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).

versionrcOptionsOptional 
public java.util.Map<java.lang.String, java.lang.Object> getVersionrcOptions();
  • Type: java.util.Map
  • Default: standard configuration applicable for GitHub repositories

Custom configuration used when creating changelog with standard-version package.

Given values either append to default configuration or overwrite values in it.

vscodeOptional 
public java.lang.Boolean getVscode();
  • Type: java.lang.Boolean
  • Default: true

Enable VSCode integration.

Enabled by default for root projects. Disabled for non-root projects.

workflowBootstrapStepsOptional 
public java.util.List<JobStep> getWorkflowBootstrapSteps();
  • Type: java.util.List
  • Default: "yarn install --frozen-lockfile && yarn projen"

Workflow steps to use in order to bootstrap this repo.

workflowContainerImageOptional 
public java.lang.String getWorkflowContainerImage();
  • Type: java.lang.String
  • Default: default image

Container image to use for GitHub workflows.

workflowGitIdentityOptional 
public GitIdentity getWorkflowGitIdentity();
  • Type: io.github.cdklabs.projen.github.GitIdentity
  • Default: GitHub Actions

The git identity to use in workflows.

workflowNodeVersionOptional 
public java.lang.String getWorkflowNodeVersion();
  • Type: java.lang.String
  • Default: same as minNodeVersion

The node version to use in GitHub workflows.

workflowPackageCacheOptional 
public java.lang.Boolean getWorkflowPackageCache();
  • Type: java.lang.Boolean
  • Default: false

Enable Node.js package cache in GitHub workflows.

workflowRunsOnOptional 
public java.util.List<java.lang.String> getWorkflowRunsOn();
  • Type: java.util.List
  • Default: ["ubuntu-latest"]

Github Runner selection labels.

workflowRunsOnGroupOptional 
public GroupRunnerOptions getWorkflowRunsOnGroup();
  • Type: io.github.cdklabs.projen.GroupRunnerOptions

Github Runner Group selection options.

yarnBerryOptionsOptional 
public YarnBerryOptions getYarnBerryOptions();
  • Type: io.github.cdklabs.projen.javascript.YarnBerryOptions
  • Default: Yarn Berry v4 with all default options

Options for Yarn Berry.

Last update: 2024-12-20