Skip to content

API Reference

Constructs

CloudscapeReactTsWebsiteProject

Synthesizes a Cloudscape React Typescript Website Project.

Initializers 

import aws.pdk.cloudscape_react_ts_website

aws.pdk.cloudscape_react_ts_website.CloudscapeReactTsWebsiteProject(
  name: str,
  allow_library_dependencies: bool = None,
  artifacts_directory: str = None,
  author_email: str = None,
  author_name: str = None,
  author_organization: bool = None,
  author_url: str = None,
  auto_approve_options: AutoApproveOptions = None,
  auto_approve_upgrades: bool = None,
  auto_detect_bin: bool = None,
  auto_merge: bool = None,
  auto_merge_options: AutoMergeOptions = None,
  bin: typing.Mapping[str] = None,
  bugs_email: str = None,
  bugs_url: str = None,
  build_workflow: bool = None,
  build_workflow_options: BuildWorkflowOptions = None,
  build_workflow_triggers: Triggers = None,
  bundled_deps: typing.List[str] = None,
  bundler_options: BundlerOptions = None,
  check_licenses: LicenseCheckerOptions = None,
  clobber: bool = None,
  code_artifact_options: CodeArtifactOptions = None,
  code_cov: bool = None,
  code_cov_token_secret: str = None,
  commit_generated: bool = None,
  copyright_owner: str = None,
  copyright_period: str = None,
  default_release_branch: str = None,
  dependabot: bool = None,
  dependabot_options: DependabotOptions = None,
  deps: typing.List[str] = None,
  deps_upgrade: bool = None,
  deps_upgrade_options: UpgradeDependenciesOptions = None,
  description: str = None,
  dev_container: bool = None,
  dev_deps: typing.List[str] = None,
  disable_tsconfig: bool = None,
  disable_tsconfig_dev: bool = None,
  docgen: bool = None,
  docs_directory: str = None,
  entrypoint: str = None,
  entrypoint_types: str = None,
  eslint: bool = None,
  eslint_options: EslintOptions = None,
  github: bool = None,
  github_options: GitHubOptions = None,
  gitignore: typing.List[str] = None,
  git_ignore_options: IgnoreFileOptions = None,
  git_options: GitOptions = None,
  gitpod: bool = None,
  homepage: str = None,
  jest: bool = None,
  jest_options: JestOptions = None,
  jsii_release_version: str = None,
  keywords: typing.List[str] = None,
  libdir: str = None,
  license: str = None,
  licensed: bool = None,
  logging: LoggerOptions = None,
  major_version: typing.Union[int, float] = None,
  max_node_version: str = None,
  mergify: bool = None,
  mergify_options: MergifyOptions = None,
  min_major_version: typing.Union[int, float] = None,
  min_node_version: str = None,
  mutable_build: bool = None,
  npm_access: NpmAccess = None,
  npm_dist_tag: str = None,
  npmignore: typing.List[str] = None,
  npmignore_enabled: bool = None,
  npm_ignore_options: IgnoreFileOptions = None,
  npm_provenance: bool = None,
  npm_registry: str = None,
  npm_registry_url: str = None,
  npm_token_secret: str = None,
  outdir: str = None,
  package: bool = None,
  package_manager: NodePackageManager = None,
  package_name: str = None,
  parent: Project = None,
  peer_dependency_options: PeerDependencyOptions = None,
  peer_deps: typing.List[str] = None,
  pnpm_version: str = None,
  post_build_steps: typing.List[JobStep] = None,
  prerelease: str = None,
  prettier: bool = None,
  prettier_options: PrettierOptions = None,
  project_type: ProjectType = None,
  projen_command: str = None,
  projen_credentials: GithubCredentials = None,
  projen_dev_dependency: bool = None,
  projenrc_js: bool = None,
  projenrc_json: bool = None,
  projenrc_json_options: ProjenrcJsonOptions = None,
  projenrc_js_options: ProjenrcOptions = None,
  projenrc_ts: bool = None,
  projenrc_ts_options: ProjenrcOptions = None,
  projen_token_secret: str = None,
  projen_version: str = None,
  publish_dry_run: bool = None,
  publish_tasks: bool = None,
  pull_request_template: bool = None,
  pull_request_template_contents: typing.List[str] = None,
  readme: SampleReadmeProps = None,
  releasable_commits: ReleasableCommits = None,
  release: bool = None,
  release_branches: typing.Mapping[BranchOptions] = None,
  release_every_commit: bool = None,
  release_failure_issue: bool = None,
  release_failure_issue_label: str = None,
  release_schedule: str = None,
  release_tag_prefix: str = None,
  release_to_npm: bool = None,
  release_trigger: ReleaseTrigger = None,
  release_workflow: bool = None,
  release_workflow_name: str = None,
  release_workflow_setup_steps: typing.List[JobStep] = None,
  renovatebot: bool = None,
  renovatebot_options: RenovatebotOptions = None,
  repository: str = None,
  repository_directory: str = None,
  rewire: typing.Mapping[typing.Any] = None,
  scoped_packages_options: typing.List[ScopedPackagesOptions] = None,
  scripts: typing.Mapping[str] = None,
  srcdir: str = None,
  stability: str = None,
  stale: bool = None,
  stale_options: StaleOptions = None,
  testdir: str = None,
  tsconfig: TypescriptConfigOptions = None,
  tsconfig_dev: TypescriptConfigOptions = None,
  tsconfig_dev_file: str = None,
  ts_jest_options: TsJestOptions = None,
  typescript_version: str = None,
  versionrc_options: typing.Mapping[typing.Any] = None,
  vscode: bool = None,
  workflow_bootstrap_steps: typing.List[JobStep] = None,
  workflow_container_image: str = None,
  workflow_git_identity: GitIdentity = None,
  workflow_node_version: str = None,
  workflow_package_cache: bool = None,
  workflow_runs_on: typing.List[str] = None,
  workflow_runs_on_group: GroupRunnerOptions = None,
  yarn_berry_options: YarnBerryOptions = None,
  allow_signup: bool = None,
  application_name: str = None,
  public_dir: str = None,
  type_safe_api: TypeSafeApiProject = None,
  type_safe_apis: typing.List[TypeSafeApiProject] = None,
  type_safe_web_socket_apis: typing.List[TypeSafeWebSocketApiProject] = None
)
Name Type Description
name str No description.
allow_library_dependencies bool Allow the project to include peerDependencies and bundledDependencies.
artifacts_directory str A directory which will contain build artifacts.
author_email str Author's e-mail.
author_name str Author's name.
author_organization bool Is the author an organization.
author_url str Author's URL / Website.
auto_approve_options projen.github.AutoApproveOptions Enable and configure the 'auto approve' workflow.
auto_approve_upgrades bool Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
auto_detect_bin bool Automatically add all executables under the bin directory to your package.json file under the bin section.
auto_merge bool Enable automatic merging on GitHub.
auto_merge_options projen.github.AutoMergeOptions Configure options for automatic merging on GitHub.
bin typing.Mapping[str] Binary programs vended with your module.
bugs_email str The email address to which issues should be reported.
bugs_url str The url to your project's issue tracker.
build_workflow bool Define a GitHub workflow for building PRs.
build_workflow_options projen.javascript.BuildWorkflowOptions Options for PR build workflow.
build_workflow_triggers projen.github.workflows.Triggers Build workflow triggers.
bundled_deps typing.List[str] List of dependencies to bundle into this module.
bundler_options projen.javascript.BundlerOptions Options for Bundler.
check_licenses projen.javascript.LicenseCheckerOptions Configure which licenses should be deemed acceptable for use by dependencies.
clobber bool Add a clobber task which resets the repo to origin.
code_artifact_options projen.javascript.CodeArtifactOptions Options for npm packages using AWS CodeArtifact.
code_cov bool 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.
code_cov_token_secret str Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
commit_generated bool Whether to commit the managed files by default.
copyright_owner str License copyright owner.
copyright_period str The copyright years to put in the LICENSE file.
default_release_branch str The name of the main release branch.
dependabot bool Use dependabot to handle dependency upgrades.
dependabot_options projen.github.DependabotOptions Options for dependabot.
deps typing.List[str] Runtime dependencies of this module.
deps_upgrade bool Use tasks and github workflows to handle dependency upgrades.
deps_upgrade_options projen.javascript.UpgradeDependenciesOptions Options for UpgradeDependencies.
description str The description is just a string that helps people understand the purpose of the package.
dev_container bool Add a VSCode development environment (used for GitHub Codespaces).
dev_deps typing.List[str] Build dependencies for this module.
disable_tsconfig bool Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
disable_tsconfig_dev bool Do not generate a tsconfig.dev.json file.
docgen bool Docgen by Typedoc.
docs_directory str Docs directory.
entrypoint str Module entrypoint (main in package.json). Set to an empty string to not include main in your package.json.
entrypoint_types str The .d.ts file that includes the type declarations for this module.
eslint bool Setup eslint.
eslint_options projen.javascript.EslintOptions Eslint options.
github bool Enable GitHub integration.
github_options projen.github.GitHubOptions Options for GitHub integration.
gitignore typing.List[str] Additional entries to .gitignore.
git_ignore_options projen.IgnoreFileOptions Configuration options for .gitignore file.
git_options projen.GitOptions Configuration options for git.
gitpod bool Add a Gitpod development environment.
homepage str Package's Homepage / Website.
jest bool Setup jest unit tests.
jest_options projen.javascript.JestOptions Jest options.
jsii_release_version str Version requirement of publib which is used to publish modules to npm.
keywords typing.List[str] Keywords to include in package.json.
libdir str Typescript artifacts output directory.
license str License's SPDX identifier.
licensed bool Indicates if a license should be added.
logging projen.LoggerOptions Configure logging options such as verbosity.
major_version typing.Union[int, float] Major version to release from the default branch.
max_node_version str Minimum node.js version to require via engines (inclusive).
mergify bool Whether mergify should be enabled on this repository or not.
mergify_options projen.github.MergifyOptions Options for mergify.
min_major_version typing.Union[int, float] Minimal Major version to release.
min_node_version str Minimum Node.js version to require via package.json engines (inclusive).
mutable_build bool Automatically update files modified during builds to pull-request branches.
npm_access projen.javascript.NpmAccess Access level of the npm package.
npm_dist_tag str The npmDistTag to use when publishing from the default branch.
npmignore typing.List[str] Additional entries to .npmignore.
npmignore_enabled bool Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
npm_ignore_options projen.IgnoreFileOptions Configuration options for .npmignore file.
npm_provenance bool Should provenance statements be generated when the package is published.
npm_registry str The host name of the npm registry to publish to.
npm_registry_url str The base URL of the npm package registry.
npm_token_secret str GitHub secret which contains the NPM token to use when publishing packages.
outdir str The root directory of the project. Relative to this directory, all files are synthesized.
package bool Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
package_manager projen.javascript.NodePackageManager The Node Package Manager used to execute scripts.
package_name str The "name" in package.json.
parent projen.Project The parent project, if this project is part of a bigger project.
peer_dependency_options projen.javascript.PeerDependencyOptions Options for peerDeps.
peer_deps typing.List[str] Peer dependencies for this module.
pnpm_version str The version of PNPM to use if using PNPM as a package manager.
post_build_steps typing.List[projen.github.workflows.JobStep] Steps to execute after build as part of the release workflow.
prerelease str Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
prettier bool Setup prettier.
prettier_options projen.javascript.PrettierOptions Prettier options.
project_type projen.ProjectType Which type of project this is (library/app).
projen_command str The shell command to use in order to run the projen CLI.
projen_credentials projen.github.GithubCredentials Choose a method of providing GitHub API access for projen workflows.
projen_dev_dependency bool Indicates of "projen" should be installed as a devDependency.
projenrc_js bool Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
projenrc_json bool Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
projenrc_json_options projen.ProjenrcJsonOptions Options for .projenrc.json.
projenrc_js_options projen.javascript.ProjenrcOptions Options for .projenrc.js.
projenrc_ts bool Use TypeScript for your projenrc file (.projenrc.ts).
projenrc_ts_options projen.typescript.ProjenrcOptions Options for .projenrc.ts.
projen_token_secret str The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
projen_version str Version of projen to install.
publish_dry_run bool Instead of actually publishing to package managers, just print the publishing command.
publish_tasks bool Define publishing tasks that can be executed manually as well as workflows.
pull_request_template bool Include a GitHub pull request template.
pull_request_template_contents typing.List[str] The contents of the pull request template.
readme projen.SampleReadmeProps The README setup.
releasable_commits projen.ReleasableCommits Find commits that should be considered releasable Used to decide if a release is required.
release bool Add release management to this project.
release_branches typing.Mapping[projen.release.BranchOptions] Defines additional release branches.
release_every_commit bool Automatically release new versions every commit to one of branches in releaseBranches.
release_failure_issue bool Create a github issue on every failed publishing task.
release_failure_issue_label str The label to apply to issues indicating publish failures.
release_schedule str CRON schedule to trigger new releases.
release_tag_prefix str Automatically add the given prefix to release tags.
release_to_npm bool Automatically release to npm when new versions are introduced.
release_trigger projen.release.ReleaseTrigger The release trigger to use.
release_workflow bool DEPRECATED: renamed to release.
release_workflow_name str The name of the default release workflow.
release_workflow_setup_steps typing.List[projen.github.workflows.JobStep] A set of workflow steps to execute in order to setup the workflow container.
renovatebot bool Use renovatebot to handle dependency upgrades.
renovatebot_options projen.RenovatebotOptions Options for renovatebot.
repository str The repository is the location where the actual code for your package lives.
repository_directory str 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 typing.Mapping[typing.Any] Rewire webpack configuration. Use this property to override webpack configuration properties provided by create-react-app, without needing to eject.
scoped_packages_options typing.List[projen.javascript.ScopedPackagesOptions] Options for privately hosted scoped packages.
scripts typing.Mapping[str] npm scripts to include.
srcdir str Typescript sources directory.
stability str Package's Stability.
stale bool Auto-close of stale issues and pull request.
stale_options projen.github.StaleOptions Auto-close stale issues and pull requests.
testdir str Jest tests directory.
tsconfig projen.javascript.TypescriptConfigOptions Custom TSConfig.
tsconfig_dev projen.javascript.TypescriptConfigOptions Custom tsconfig options for the development tsconfig.json file (used for testing).
tsconfig_dev_file str The name of the development tsconfig.json file.
ts_jest_options projen.typescript.TsJestOptions Options for ts-jest.
typescript_version str TypeScript version to use.
versionrc_options typing.Mapping[typing.Any] Custom configuration used when creating changelog with standard-version package.
vscode bool Enable VSCode integration.
workflow_bootstrap_steps typing.List[projen.github.workflows.JobStep] Workflow steps to use in order to bootstrap this repo.
workflow_container_image str Container image to use for GitHub workflows.
workflow_git_identity projen.github.GitIdentity The git identity to use in workflows.
workflow_node_version str The node version to use in GitHub workflows.
workflow_package_cache bool Enable Node.js package cache in GitHub workflows.
workflow_runs_on typing.List[str] Github Runner selection labels.
workflow_runs_on_group projen.GroupRunnerOptions Github Runner Group selection options.
yarn_berry_options projen.javascript.YarnBerryOptions Options for Yarn Berry.
allow_signup bool Whether to enable self sign-up.
application_name str Name of the application name.
public_dir str Public directory.
type_safe_api aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject TypeSafeApi instance to use when setting up the initial project sample code.
type_safe_apis typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject] TypeSafeApi instances to use when setting up the initial project sample code.
type_safe_web_socket_apis typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeWebSocketApiProject] TypeSafeWebSocketApi instances to use when setting up the initial project sample code.
nameRequired
  • Type: str
allow_library_dependenciesOptional
  • Type: bool
  • 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.

artifacts_directoryOptional
  • Type: str
  • Default: "dist"

A directory which will contain build artifacts.

author_emailOptional
  • Type: str

Author's e-mail.

author_nameOptional
  • Type: str

Author's name.

author_organizationOptional
  • Type: bool

Is the author an organization.

author_urlOptional
  • Type: str

Author's URL / Website.

auto_approve_optionsOptional
  • Type: projen.github.AutoApproveOptions
  • Default: auto approve is disabled

Enable and configure the 'auto approve' workflow.

auto_approve_upgradesOptional
  • Type: bool
  • 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.

auto_detect_binOptional
  • Type: bool
  • Default: true

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

auto_mergeOptional
  • Type: bool
  • Default: true

Enable automatic merging on GitHub.

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

auto_merge_optionsOptional
  • Type: 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: typing.Mapping[str]

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.

bugs_emailOptional
  • Type: str

The email address to which issues should be reported.

bugs_urlOptional
  • Type: str

The url to your project's issue tracker.

build_workflowOptional
  • Type: bool
  • Default: true if not a subproject

Define a GitHub workflow for building PRs.

build_workflow_optionsOptional
  • Type: projen.javascript.BuildWorkflowOptions

Options for PR build workflow.

~~build_workflow_triggers~~Optional

  • Deprecated: - Use buildWorkflowOptions.workflowTriggers

  • Type: projen.github.workflows.Triggers

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

Build workflow triggers.

bundled_depsOptional
  • Type: typing.List[str]

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.

bundler_optionsOptional
  • Type: projen.javascript.BundlerOptions

Options for Bundler.

check_licensesOptional
  • Type: 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: bool
  • Default: true, but false for subprojects

Add a clobber task which resets the repo to origin.

code_artifact_optionsOptional
  • Type: 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

code_covOptional
  • Type: bool
  • 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.

code_cov_token_secretOptional
  • Type: str
  • 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.

commit_generatedOptional
  • Type: bool
  • Default: true

Whether to commit the managed files by default.

  • Type: str
  • Default: defaults to the value of authorName or "" if authorName is undefined.

License copyright owner.

  • Type: str
  • Default: current year

The copyright years to put in the LICENSE file.

default_release_branchOptional
  • Type: str
  • Default: "main"

The name of the main release branch.

dependabotOptional
  • Type: bool
  • Default: false

Use dependabot to handle dependency upgrades.

Cannot be used in conjunction with depsUpgrade.

dependabot_optionsOptional
  • Type: projen.github.DependabotOptions
  • Default: default options

Options for dependabot.

depsOptional
  • Type: typing.List[str]
  • 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.

deps_upgradeOptional
  • Type: bool
  • Default: true

Use tasks and github workflows to handle dependency upgrades.

Cannot be used in conjunction with dependabot.

deps_upgrade_optionsOptional
  • Type: projen.javascript.UpgradeDependenciesOptions
  • Default: default options

Options for UpgradeDependencies.

descriptionOptional
  • Type: str

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

dev_containerOptional
  • Type: bool
  • Default: false

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

dev_depsOptional
  • Type: typing.List[str]
  • 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.

disable_tsconfigOptional
  • Type: bool
  • Default: false

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

disable_tsconfig_devOptional
  • Type: bool
  • Default: false

Do not generate a tsconfig.dev.json file.

docgenOptional
  • Type: bool
  • Default: false

Docgen by Typedoc.

docs_directoryOptional
  • Type: str
  • Default: "docs"

Docs directory.

entrypointOptional
  • Type: str
  • Default: "lib/index.js"

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

entrypoint_typesOptional
  • Type: str
  • 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: bool
  • Default: true

Setup eslint.

eslint_optionsOptional
  • Type: projen.javascript.EslintOptions
  • Default: opinionated default options

Eslint options.

githubOptional
  • Type: bool
  • Default: true

Enable GitHub integration.

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

github_optionsOptional
  • Type: projen.github.GitHubOptions
  • Default: see GitHubOptions

Options for GitHub integration.

gitignoreOptional
  • Type: typing.List[str]

Additional entries to .gitignore.

git_ignore_optionsOptional
  • Type: projen.IgnoreFileOptions

Configuration options for .gitignore file.

git_optionsOptional
  • Type: projen.GitOptions

Configuration options for git.

gitpodOptional
  • Type: bool
  • Default: false

Add a Gitpod development environment.

homepageOptional
  • Type: str

Package's Homepage / Website.

jestOptional
  • Type: bool
  • Default: true

Setup jest unit tests.

jest_optionsOptional
  • Type: projen.javascript.JestOptions
  • Default: default options

Jest options.

jsii_release_versionOptional
  • Type: str
  • Default: "latest"

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

keywordsOptional
  • Type: typing.List[str]

Keywords to include in package.json.

libdirOptional
  • Type: str
  • Default: "lib"

Typescript artifacts output directory.

licenseOptional
  • Type: str
  • 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: bool
  • Default: true

Indicates if a license should be added.

loggingOptional
  • Type: projen.LoggerOptions
  • Default: {}

Configure logging options such as verbosity.

major_versionOptional
  • Type: typing.Union[int, float]
  • 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.

max_node_versionOptional
  • Type: str
  • Default: no max

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

~~mergify~~Optional

  • Deprecated: use githubOptions.mergify instead

  • Type: bool

  • Default: true

Whether mergify should be enabled on this repository or not.

~~mergify_options~~Optional

  • Deprecated: use githubOptions.mergifyOptions instead

  • Type: projen.github.MergifyOptions

  • Default: default options

Options for mergify.

min_major_versionOptional
  • Type: typing.Union[int, float]
  • 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.

min_node_versionOptional
  • Type: str
  • Default: no "engines" specified

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

~~mutable_build~~Optional

  • Deprecated: - Use buildWorkflowOptions.mutableBuild

  • Type: bool

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

npm_accessOptional
  • Type: 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.

npm_dist_tagOptional
  • Type: str
  • 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: typing.List[str]

Additional entries to .npmignore.

npmignore_enabledOptional
  • Type: bool
  • Default: true

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

npm_ignore_optionsOptional
  • Type: projen.IgnoreFileOptions

Configuration options for .npmignore file.

npm_provenanceOptional
  • Type: bool
  • 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.

~~npm_registry~~Optional

  • Deprecated: use npmRegistryUrl instead

  • Type: str

The host name of the npm registry to publish to.

Cannot be set together with npmRegistryUrl.

npm_registry_urlOptional

The base URL of the npm package registry.

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

npm_token_secretOptional
  • Type: str
  • Default: "NPM_TOKEN"

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

outdirOptional
  • Type: str
  • 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: bool
  • Default: true

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

package_managerOptional
  • Type: projen.javascript.NodePackageManager
  • Default: NodePackageManager.YARN_CLASSIC

The Node Package Manager used to execute scripts.

package_nameOptional
  • Type: str
  • Default: defaults to project name

The "name" in package.json.

parentOptional
  • Type: projen.Project

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

peer_dependency_optionsOptional
  • Type: projen.javascript.PeerDependencyOptions

Options for peerDeps.

peer_depsOptional
  • Type: typing.List[str]
  • 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.

pnpm_versionOptional
  • Type: str
  • Default: "7"

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

post_build_stepsOptional
  • Type: typing.List[projen.github.workflows.JobStep]
  • Default: []

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

prereleaseOptional
  • Type: str
  • Default: normal semantic versions

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

prettierOptional
  • Type: bool
  • Default: false

Setup prettier.

prettier_optionsOptional
  • Type: projen.javascript.PrettierOptions
  • Default: default options

Prettier options.

~~project_type~~Optional

  • Deprecated: no longer supported at the base project level

  • Type: projen.ProjectType

  • Default: ProjectType.UNKNOWN

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

projen_commandOptional
  • Type: str
  • Default: "npx projen"

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

Can be used to customize in special environments.

projen_credentialsOptional
  • Type: projen.github.GithubCredentials
  • Default: use a personal access token named PROJEN_GITHUB_TOKEN

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

projen_dev_dependencyOptional
  • Type: bool
  • Default: true if not a subproject

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

projenrc_jsOptional
  • Type: bool
  • Default: true if projenrcJson is false

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

projenrc_jsonOptional
  • Type: bool
  • Default: false

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

projenrc_json_optionsOptional
  • Type: projen.ProjenrcJsonOptions
  • Default: default options

Options for .projenrc.json.

projenrc_js_optionsOptional
  • Type: projen.javascript.ProjenrcOptions
  • Default: default options

Options for .projenrc.js.

projenrc_tsOptional
  • Type: bool
  • Default: false

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

projenrc_ts_optionsOptional
  • Type: projen.typescript.ProjenrcOptions

Options for .projenrc.ts.

~~projen_token_secret~~Optional

  • Deprecated: use projenCredentials

  • Type: str

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

projen_versionOptional
  • Type: str
  • Default: Defaults to the latest version.

Version of projen to install.

publish_dry_runOptional
  • Type: bool
  • Default: false

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

publish_tasksOptional
  • Type: bool
  • 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.

pull_request_templateOptional
  • Type: bool
  • Default: true

Include a GitHub pull request template.

pull_request_template_contentsOptional
  • Type: typing.List[str]
  • Default: default content

The contents of the pull request template.

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

The README setup.

releasable_commitsOptional
  • Type: projen.ReleasableCommits
  • Default: ReleasableCommits.everyCommit()

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

releaseOptional
  • Type: bool
  • Default: true (false for subprojects)

Add release management to this project.

release_branchesOptional
  • Type: typing.Mapping[projen.release.BranchOptions]
  • 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.

~~release_every_commit~~Optional

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

  • Type: bool

  • Default: true

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

release_failure_issueOptional
  • Type: bool
  • Default: false

Create a github issue on every failed publishing task.

release_failure_issue_labelOptional
  • Type: str
  • Default: "failed-release"

The label to apply to issues indicating publish failures.

Only applies if releaseFailureIssue is true.

~~release_schedule~~Optional

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

  • Type: str

  • Default: no scheduled releases

CRON schedule to trigger new releases.

release_tag_prefixOptional
  • Type: str
  • 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.

release_to_npmOptional
  • Type: bool
  • Default: false

Automatically release to npm when new versions are introduced.

release_triggerOptional
  • Type: projen.release.ReleaseTrigger
  • Default: Continuous releases (ReleaseTrigger.continuous())

The release trigger to use.

~~release_workflow~~Optional

  • Deprecated: see release.

  • Type: bool

  • Default: true if not a subproject

DEPRECATED: renamed to release.

release_workflow_nameOptional
  • Type: str
  • Default: "release"

The name of the default release workflow.

release_workflow_setup_stepsOptional
  • Type: typing.List[projen.github.workflows.JobStep]

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

renovatebotOptional
  • Type: bool
  • Default: false

Use renovatebot to handle dependency upgrades.

renovatebot_optionsOptional
  • Type: projen.RenovatebotOptions
  • Default: default options

Options for renovatebot.

repositoryOptional
  • Type: str

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

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

repository_directoryOptional
  • Type: str

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: typing.Mapping[typing.Any]
  • 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;
}
scoped_packages_optionsOptional
  • Type: typing.List[projen.javascript.ScopedPackagesOptions]
  • 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: typing.Mapping[str]

  • 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: str
  • Default: "src"

Typescript sources directory.

stabilityOptional
  • Type: str

Package's Stability.

staleOptional
  • Type: bool
  • Default: false

Auto-close of stale issues and pull request.

See staleOptions for options.

stale_optionsOptional
  • Type: projen.github.StaleOptions
  • Default: see defaults in StaleOptions

Auto-close stale issues and pull requests.

To disable set stale to false.

testdirOptional
  • Type: str
  • 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: projen.javascript.TypescriptConfigOptions
  • Default: default options

Custom TSConfig.

tsconfig_devOptional
  • Type: projen.javascript.TypescriptConfigOptions
  • Default: use the production tsconfig options

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

tsconfig_dev_fileOptional
  • Type: str
  • Default: "tsconfig.dev.json"

The name of the development tsconfig.json file.

ts_jest_optionsOptional
  • Type: projen.typescript.TsJestOptions

Options for ts-jest.

typescript_versionOptional
  • Type: str
  • 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).

versionrc_optionsOptional
  • Type: typing.Mapping[typing.Any]
  • 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: bool
  • Default: true

Enable VSCode integration.

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

workflow_bootstrap_stepsOptional
  • Type: typing.List[projen.github.workflows.JobStep]
  • Default: "yarn install --frozen-lockfile && yarn projen"

Workflow steps to use in order to bootstrap this repo.

workflow_container_imageOptional
  • Type: str
  • Default: default image

Container image to use for GitHub workflows.

workflow_git_identityOptional
  • Type: projen.github.GitIdentity
  • Default: GitHub Actions

The git identity to use in workflows.

workflow_node_versionOptional
  • Type: str
  • Default: same as minNodeVersion

The node version to use in GitHub workflows.

workflow_package_cacheOptional
  • Type: bool
  • Default: false

Enable Node.js package cache in GitHub workflows.

workflow_runs_onOptional
  • Type: typing.List[str]
  • Default: ["ubuntu-latest"]

Github Runner selection labels.

workflow_runs_on_groupOptional
  • Type: projen.GroupRunnerOptions

Github Runner Group selection options.

yarn_berry_optionsOptional
  • Type: projen.javascript.YarnBerryOptions
  • Default: Yarn Berry v4 with all default options

Options for Yarn Berry.

allow_signupOptional
  • Type: bool
  • Default: false

Whether to enable self sign-up.

application_nameOptional
  • Type: str
  • Default: "Sample App"

Name of the application name.

public_dirOptional
  • Type: str
  • Default: "public"

Public directory.

~~type_safe_api~~Optional

  • Deprecated: use typeSafeApis

  • Type: aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject

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

type_safe_apisOptional
  • Type: typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject]

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

type_safe_web_socket_apisOptional
  • Type: typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeWebSocketApiProject]

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

Methods

Name Description
to_string Returns a string representation of this construct.
add_exclude_from_cleanup Exclude the matching files from pre-synth cleanup.
add_git_ignore Adds a .gitignore pattern.
add_package_ignore Adds patterns to be ignored by npm.
add_task Adds a new task to this project.
add_tip Prints a "tip" message during synthesis.
annotate_generated Marks the provided file(s) as being generated.
post_synthesize Called after all components are synthesized.
pre_synthesize Called before all components are synthesized.
remove_task Removes a task from a project.
run_task_command Returns the shell command to execute in order to run a task.
synth Synthesize all project files into outdir.
try_find_file Finds a file at the specified relative path within this project and all its subprojects.
try_find_json_file Finds a json file by name.
try_find_object_file Finds an object file (like JsonFile, YamlFile, etc.) by name.
try_remove_file Finds a file at the specified relative path within this project and removes it.
add_bins No description.
add_bundled_deps Defines bundled dependencies.
add_compile_command DEPRECATED.
add_deps Defines normal dependencies.
add_dev_deps Defines development/test dependencies.
add_fields Directly set fields in package.json.
add_keywords Adds keywords to package.json (deduplicated).
add_peer_deps Defines peer dependencies.
add_scripts Replaces the contents of multiple npm package.json scripts.
add_test_command DEPRECATED.
has_script Indicates if a script by the name name is defined.
remove_script Removes the npm script (always successful).
render_workflow_setup Returns the set of workflow steps which should be executed to bootstrap a workflow.
set_script Replaces the contents of an npm package.json script.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_exclude_from_cleanup 
def add_exclude_from_cleanup(
  globs: str
) -> None

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: str

The glob patterns to match.

add_git_ignore 
def add_git_ignore(
  pattern: str
) -> None

Adds a .gitignore pattern.

patternRequired
  • Type: str

The glob pattern to ignore.

add_package_ignore 
def add_package_ignore(
  pattern: str
) -> None

Adds patterns to be ignored by npm.

patternRequired
  • Type: str

The pattern to ignore.

add_task 
def add_task(
  name: str,
  condition: str = None,
  cwd: str = None,
  description: str = None,
  env: typing.Mapping[str] = None,
  required_env: typing.List[str] = None,
  args: typing.List[str] = None,
  exec: str = None,
  receive_args: bool = None,
  steps: typing.List[TaskStep] = None
) -> Task

Adds a new task to this project.

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

nameRequired
  • Type: str

The task name to add.

conditionOptional
  • Type: str

A shell command which determines if the this task should be executed.

If the program exits with a zero exit code, steps will be executed. A non-zero code means that task will be skipped.

cwdOptional
  • Type: str
  • Default: process.cwd()

The working directory for all steps in this task (unless overridden by the step).

descriptionOptional
  • Type: str
  • Default: the task name

The description of this build command.

envOptional
  • Type: typing.Mapping[str]
  • Default: {}

Defines environment variables for the execution of this task.

Values in this map will be evaluated in a shell, so you can do stuff like $(echo "foo").

required_envOptional
  • Type: typing.List[str]

A set of environment variables that must be defined in order to execute this task.

Task execution will fail if one of these is not defined.

argsOptional
  • Type: typing.List[str]
  • Default: no arguments are passed to the step

Should the provided exec shell command receive fixed args.

{@link TaskStepOptions.args }

execOptional
  • Type: str
  • Default: add steps using task.exec(command) or task.spawn(subtask)

Shell command to execute as the first command of the task.

receive_argsOptional
  • Type: bool
  • Default: false

Should the provided exec shell command receive args passed to the task.

{@link TaskStepOptions.receiveArgs }

stepsOptional
  • Type: typing.List[projen.TaskStep]

List of task steps to run.

~~add_tip~~ 
def add_tip(
  message: str
) -> None

Prints a "tip" message during synthesis.

messageRequired
  • Type: str

The message.

annotate_generated 
def annotate_generated(
  glob: str
) -> None

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: str

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

post_synthesize 
def post_synthesize() -> None

Called after all components are synthesized.

Order is not guaranteed.

pre_synthesize 
def pre_synthesize() -> None

Called before all components are synthesized.

remove_task 
def remove_task(
  name: str
) -> Task

Removes a task from a project.

nameRequired
  • Type: str

The name of the task to remove.

run_task_command 
def run_task_command(
  task: Task
) -> str

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

This will typically be npx projen TASK.

taskRequired
  • Type: projen.Task

The task for which the command is required.

synth 
def synth() -> None

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()"
try_find_file 
def try_find_file(
  file_path: str
) -> FileBase

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

file_pathRequired
  • Type: str

The file path.

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

~~try_find_json_file~~ 
def try_find_json_file(
  file_path: str
) -> JsonFile

Finds a json file by name.

file_pathRequired
  • Type: str

The file path.

try_find_object_file 
def try_find_object_file(
  file_path: str
) -> ObjectFile

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

file_pathRequired
  • Type: str

The file path.

try_remove_file 
def try_remove_file(
  file_path: str
) -> FileBase

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

file_pathRequired
  • Type: str

The file path.

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

add_bins 
def add_bins(
  bins: typing.Mapping[str]
) -> None
binsRequired
  • Type: typing.Mapping[str]
add_bundled_deps 
def add_bundled_deps(
  deps: str
) -> None

Defines bundled dependencies.

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

depsRequired
  • Type: str

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.

~~add_compile_command~~ 
def add_compile_command(
  commands: str
) -> None

DEPRECATED.

commandsRequired
  • Type: str
add_deps 
def add_deps(
  deps: str
) -> None

Defines normal dependencies.

depsRequired
  • Type: str

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.

add_dev_deps 
def add_dev_deps(
  deps: str
) -> None

Defines development/test dependencies.

depsRequired
  • Type: str

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.

add_fields 
def add_fields(
  fields: typing.Mapping[typing.Any]
) -> None

Directly set fields in package.json.

fieldsRequired
  • Type: typing.Mapping[typing.Any]

The fields to set.

add_keywords 
def add_keywords(
  keywords: str
) -> None

Adds keywords to package.json (deduplicated).

keywordsRequired
  • Type: str

The keywords to add.

add_peer_deps 
def add_peer_deps(
  deps: str
) -> None

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: str

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.

add_scripts 
def add_scripts(
  scripts: typing.Mapping[str]
) -> None

Replaces the contents of multiple npm package.json scripts.

scriptsRequired
  • Type: typing.Mapping[str]

The scripts to set.

~~add_test_command~~ 
def add_test_command(
  commands: str
) -> None

DEPRECATED.

commandsRequired
  • Type: str
~~has_script~~ 
def has_script(
  name: str
) -> bool

Indicates if a script by the name name is defined.

nameRequired
  • Type: str

The name of the script.

remove_script 
def remove_script(
  name: str
) -> None

Removes the npm script (always successful).

nameRequired
  • Type: str

The name of the script.

render_workflow_setup 
def render_workflow_setup(
  install_step_configuration: JobStepConfiguration = None,
  mutable: bool = None
) -> typing.List[JobStep]

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

install_step_configurationOptional
  • Type: projen.github.workflows.JobStepConfiguration
  • Default: { name: "Install dependencies" }

Configure the install step in the workflow setup.

Example

- { env: { NPM_TOKEN: "token" }} for installing from private npm registry.
mutableOptional
  • Type: bool
  • Default: false

Should the package lockfile be updated?

set_script 
def set_script(
  name: str,
  command: str
) -> None

Replaces the contents of an npm package.json script.

nameRequired
  • Type: str

The script name.

commandRequired
  • Type: str

The command to execute.

Static Functions

Name Description
is_construct Checks if x is a construct.
is_project Test whether the given construct is a project.
of Find the closest ancestor project for given construct.
is_construct 
import aws.pdk.cloudscape_react_ts_website

aws.pdk.cloudscape_react_ts_website.CloudscapeReactTsWebsiteProject.is_construct(
  x: typing.Any
)

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: typing.Any

Any object.

is_project 
import aws.pdk.cloudscape_react_ts_website

aws.pdk.cloudscape_react_ts_website.CloudscapeReactTsWebsiteProject.is_project(
  x: typing.Any
)

Test whether the given construct is a project.

xRequired
  • Type: typing.Any
of 
import aws.pdk.cloudscape_react_ts_website

aws.pdk.cloudscape_react_ts_website.CloudscapeReactTsWebsiteProject.of(
  construct: IConstruct
)

Find the closest ancestor project for given construct.

When given a project, this it the project itself.

constructRequired
  • Type: constructs.IConstruct

Properties

Name Type Description
node constructs.Node The tree node.
build_task projen.Task No description.
commit_generated bool Whether to commit the managed files by default.
compile_task projen.Task No description.
components typing.List[projen.Component] Returns all the components within this project.
deps projen.Dependencies Project dependencies.
ejected bool Whether or not the project is being ejected.
files typing.List[projen.FileBase] All files in this project.
gitattributes projen.GitAttributesFile The .gitattributes file for this repository.
gitignore projen.IgnoreFile .gitignore.
logger projen.Logger Logging utilities.
name str Project name.
outdir str Absolute output directory of this project.
package_task projen.Task No description.
post_compile_task projen.Task No description.
pre_compile_task projen.Task No description.
project_build projen.ProjectBuild Manages the build process of the project.
projen_command str The command to use in order to run the projen CLI.
root projen.Project The root project.
subprojects typing.List[projen.Project] Returns all the subprojects within this project.
tasks projen.Tasks Project tasks.
test_task projen.Task No description.
default_task projen.Task This is the "default" task, the one that executes "projen".
init_project projen.InitProject The options used when this project is bootstrapped via projen new.
parent projen.Project A parent project.
project_type projen.ProjectType No description.
auto_approve projen.github.AutoApprove Auto approve set up for this project.
dev_container projen.vscode.DevContainer Access for .devcontainer.json (used for GitHub Codespaces).
github projen.github.GitHub Access all github components.
gitpod projen.Gitpod Access for Gitpod.
vscode projen.vscode.VsCode Access all VSCode components.
allow_library_dependencies bool No description.
artifacts_directory str The build output directory.
artifacts_javascript_directory str The location of the npm tarball after build (${artifactsDirectory}/js).
bundler projen.javascript.Bundler No description.
entrypoint str No description.
manifest typing.Any No description.
npmrc projen.javascript.NpmConfig The .npmrc file.
package projen.javascript.NodePackage API for managing the node package.
package_manager projen.javascript.NodePackageManager The package manager to use.
run_script_command str The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).
auto_merge projen.github.AutoMerge Component that sets up mergify for merging approved pull requests.
build_workflow projen.build.BuildWorkflow The PR build GitHub workflow.
build_workflow_job_id str The job ID of the build workflow.
jest projen.javascript.Jest The Jest configuration (if enabled).
max_node_version str Maximum node version required by this package.
min_node_version str Minimum node.js version required by this package.
npmignore projen.IgnoreFile The .npmignore file.
prettier projen.javascript.Prettier No description.
publisher projen.release.Publisher Package publisher.
release projen.release.Release Release management.
upgrade_workflow projen.javascript.UpgradeDependencies The upgrade workflow.
docs_directory str No description.
libdir str The directory in which compiled .js files reside.
srcdir str The directory in which source files reside.
testdir str The directory in which tests reside.
tsconfig_dev projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen).
watch_task projen.Task The "watch" task.
docgen bool No description.
eslint projen.javascript.Eslint No description.
tsconfig projen.javascript.TypescriptConfig No description.
tsconfig_eslint projen.javascript.TypescriptConfig No description.
allow_signup bool No description.
application_name str No description.
public_dir str No description.
type_safe_apis typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject] No description.
type_safe_web_socket_apis typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeWebSocketApiProject] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

build_taskRequired 
build_task: Task
  • Type: projen.Task
commit_generatedRequired 
commit_generated: bool
  • Type: bool

Whether to commit the managed files by default.

compile_taskRequired 
compile_task: Task
  • Type: projen.Task
componentsRequired 
components: typing.List[Component]
  • Type: typing.List[projen.Component]

Returns all the components within this project.

depsRequired 
deps: Dependencies
  • Type: projen.Dependencies

Project dependencies.

ejectedRequired 
ejected: bool
  • Type: bool

Whether or not the project is being ejected.

filesRequired 
files: typing.List[FileBase]
  • Type: typing.List[projen.FileBase]

All files in this project.

gitattributesRequired 
gitattributes: GitAttributesFile
  • Type: projen.GitAttributesFile

The .gitattributes file for this repository.

gitignoreRequired 
gitignore: IgnoreFile
  • Type: projen.IgnoreFile

.gitignore.

loggerRequired 
logger: Logger
  • Type: projen.Logger

Logging utilities.

nameRequired 
name: str
  • Type: str

Project name.

outdirRequired 
outdir: str
  • Type: str

Absolute output directory of this project.

package_taskRequired 
package_task: Task
  • Type: projen.Task
post_compile_taskRequired 
post_compile_task: Task
  • Type: projen.Task
pre_compile_taskRequired 
pre_compile_task: Task
  • Type: projen.Task
project_buildRequired 
project_build: ProjectBuild
  • Type: projen.ProjectBuild

Manages the build process of the project.

projen_commandRequired 
projen_command: str
  • Type: str

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

rootRequired 
root: Project
  • Type: projen.Project

The root project.

subprojectsRequired 
subprojects: typing.List[Project]
  • Type: typing.List[projen.Project]

Returns all the subprojects within this project.

tasksRequired 
tasks: Tasks
  • Type: projen.Tasks

Project tasks.

test_taskRequired 
test_task: Task
  • Type: projen.Task
default_taskOptional 
default_task: Task
  • Type: projen.Task

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

Undefined if the project is being ejected.

init_projectOptional 
init_project: InitProject
  • Type: 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 
parent: Project
  • Type: projen.Project

A parent project.

If undefined, this is the root project.

project_typeRequired 
project_type: ProjectType
  • Type: projen.ProjectType
auto_approveOptional 
auto_approve: AutoApprove
  • Type: projen.github.AutoApprove

Auto approve set up for this project.

dev_containerOptional 
dev_container: DevContainer
  • Type: projen.vscode.DevContainer

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

This will be undefined if devContainer boolean is false

githubOptional 
github: GitHub
  • Type: projen.github.GitHub

Access all github components.

This will be undefined for subprojects.

gitpodOptional 
gitpod: Gitpod
  • Type: projen.Gitpod

Access for Gitpod.

This will be undefined if gitpod boolean is false

vscodeOptional 
vscode: VsCode
  • Type: projen.vscode.VsCode

Access all VSCode components.

This will be undefined for subprojects.

~~allow_library_dependencies~~Required
  • Deprecated: use package.allowLibraryDependencies
allow_library_dependencies: bool
  • Type: bool
artifacts_directoryRequired 
artifacts_directory: str
  • Type: str

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.

artifacts_javascript_directoryRequired 
artifacts_javascript_directory: str
  • Type: str

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

bundlerRequired 
bundler: Bundler
  • Type: projen.javascript.Bundler
~~entrypoint~~Required
  • Deprecated: use package.entrypoint
entrypoint: str
  • Type: str
~~manifest~~Required
  • Deprecated: use package.addField(x, y)
manifest: typing.Any
  • Type: typing.Any
npmrcRequired 
npmrc: NpmConfig
  • Type: projen.javascript.NpmConfig

The .npmrc file.

packageRequired 
package: NodePackage
  • Type: projen.javascript.NodePackage

API for managing the node package.

~~package_manager~~Required
  • Deprecated: use package.packageManager
package_manager: NodePackageManager
  • Type: projen.javascript.NodePackageManager

The package manager to use.

run_script_commandRequired 
run_script_command: str
  • Type: str

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

auto_mergeOptional 
auto_merge: AutoMerge
  • Type: projen.github.AutoMerge

Component that sets up mergify for merging approved pull requests.

build_workflowOptional 
build_workflow: BuildWorkflow
  • Type: projen.build.BuildWorkflow

The PR build GitHub workflow.

undefined if buildWorkflow is disabled.

build_workflow_job_idOptional 
build_workflow_job_id: str
  • Type: str

The job ID of the build workflow.

jestOptional 
jest: Jest
  • Type: projen.javascript.Jest

The Jest configuration (if enabled).

max_node_versionOptional 
max_node_version: str
  • Type: str

Maximum node version required by this package.

min_node_versionOptional 
min_node_version: str
  • Type: str

Minimum node.js version required by this package.

npmignoreOptional 
npmignore: IgnoreFile
  • Type: projen.IgnoreFile

The .npmignore file.

prettierOptional 
prettier: Prettier
  • Type: projen.javascript.Prettier
~~publisher~~Optional
  • Deprecated: use release.publisher.
publisher: Publisher
  • Type: projen.release.Publisher

Package publisher.

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

releaseOptional 
release: Release
  • Type: projen.release.Release

Release management.

upgrade_workflowOptional 
upgrade_workflow: UpgradeDependencies
  • Type: projen.javascript.UpgradeDependencies

The upgrade workflow.

docs_directoryRequired 
docs_directory: str
  • Type: str
libdirRequired 
libdir: str
  • Type: str

The directory in which compiled .js files reside.

srcdirRequired 
srcdir: str
  • Type: str

The directory in which source files reside.

testdirRequired 
testdir: str
  • Type: str

The directory in which tests reside.

tsconfig_devRequired 
tsconfig_dev: TypescriptConfig
  • Type: projen.javascript.TypescriptConfig

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

watch_taskRequired 
watch_task: Task
  • Type: projen.Task

The "watch" task.

docgenOptional 
docgen: bool
  • Type: bool
eslintOptional 
eslint: Eslint
  • Type: projen.javascript.Eslint
tsconfigOptional 
tsconfig: TypescriptConfig
  • Type: projen.javascript.TypescriptConfig
tsconfig_eslintOptional 
tsconfig_eslint: TypescriptConfig
  • Type: projen.javascript.TypescriptConfig
allow_signupRequired 
allow_signup: bool
  • Type: bool
application_nameRequired 
application_name: str
  • Type: str
public_dirRequired 
public_dir: str
  • Type: str
type_safe_apisOptional 
type_safe_apis: typing.List[TypeSafeApiProject]
  • Type: typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject]
type_safe_web_socket_apisOptional 
type_safe_web_socket_apis: typing.List[TypeSafeWebSocketApiProject]
  • Type: typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeWebSocketApiProject]

Constants

Name Type Description
DEFAULT_TASK str The name of the default task (the task executed when projen is run without arguments).
DEFAULT_TS_JEST_TRANFORM_PATTERN str No description.
DEFAULT_TASKRequired 
DEFAULT_TASK: str
  • Type: str

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 
DEFAULT_TS_JEST_TRANFORM_PATTERN: str
  • Type: str

Structs

CloudscapeReactTsWebsiteProjectOptions

Configuration options for the CloudscapeReactTsWebsiteProject.

Initializer 

import aws.pdk.cloudscape_react_ts_website

aws.pdk.cloudscape_react_ts_website.CloudscapeReactTsWebsiteProjectOptions(
  name: str,
  allow_library_dependencies: bool = None,
  artifacts_directory: str = None,
  author_email: str = None,
  author_name: str = None,
  author_organization: bool = None,
  author_url: str = None,
  auto_approve_options: AutoApproveOptions = None,
  auto_approve_upgrades: bool = None,
  auto_detect_bin: bool = None,
  auto_merge: bool = None,
  auto_merge_options: AutoMergeOptions = None,
  bin: typing.Mapping[str] = None,
  bugs_email: str = None,
  bugs_url: str = None,
  build_workflow: bool = None,
  build_workflow_options: BuildWorkflowOptions = None,
  build_workflow_triggers: Triggers = None,
  bundled_deps: typing.List[str] = None,
  bundler_options: BundlerOptions = None,
  check_licenses: LicenseCheckerOptions = None,
  clobber: bool = None,
  code_artifact_options: CodeArtifactOptions = None,
  code_cov: bool = None,
  code_cov_token_secret: str = None,
  commit_generated: bool = None,
  copyright_owner: str = None,
  copyright_period: str = None,
  default_release_branch: str = None,
  dependabot: bool = None,
  dependabot_options: DependabotOptions = None,
  deps: typing.List[str] = None,
  deps_upgrade: bool = None,
  deps_upgrade_options: UpgradeDependenciesOptions = None,
  description: str = None,
  dev_container: bool = None,
  dev_deps: typing.List[str] = None,
  disable_tsconfig: bool = None,
  disable_tsconfig_dev: bool = None,
  docgen: bool = None,
  docs_directory: str = None,
  entrypoint: str = None,
  entrypoint_types: str = None,
  eslint: bool = None,
  eslint_options: EslintOptions = None,
  github: bool = None,
  github_options: GitHubOptions = None,
  gitignore: typing.List[str] = None,
  git_ignore_options: IgnoreFileOptions = None,
  git_options: GitOptions = None,
  gitpod: bool = None,
  homepage: str = None,
  jest: bool = None,
  jest_options: JestOptions = None,
  jsii_release_version: str = None,
  keywords: typing.List[str] = None,
  libdir: str = None,
  license: str = None,
  licensed: bool = None,
  logging: LoggerOptions = None,
  major_version: typing.Union[int, float] = None,
  max_node_version: str = None,
  mergify: bool = None,
  mergify_options: MergifyOptions = None,
  min_major_version: typing.Union[int, float] = None,
  min_node_version: str = None,
  mutable_build: bool = None,
  npm_access: NpmAccess = None,
  npm_dist_tag: str = None,
  npmignore: typing.List[str] = None,
  npmignore_enabled: bool = None,
  npm_ignore_options: IgnoreFileOptions = None,
  npm_provenance: bool = None,
  npm_registry: str = None,
  npm_registry_url: str = None,
  npm_token_secret: str = None,
  outdir: str = None,
  package: bool = None,
  package_manager: NodePackageManager = None,
  package_name: str = None,
  parent: Project = None,
  peer_dependency_options: PeerDependencyOptions = None,
  peer_deps: typing.List[str] = None,
  pnpm_version: str = None,
  post_build_steps: typing.List[JobStep] = None,
  prerelease: str = None,
  prettier: bool = None,
  prettier_options: PrettierOptions = None,
  project_type: ProjectType = None,
  projen_command: str = None,
  projen_credentials: GithubCredentials = None,
  projen_dev_dependency: bool = None,
  projenrc_js: bool = None,
  projenrc_json: bool = None,
  projenrc_json_options: ProjenrcJsonOptions = None,
  projenrc_js_options: ProjenrcOptions = None,
  projenrc_ts: bool = None,
  projenrc_ts_options: ProjenrcOptions = None,
  projen_token_secret: str = None,
  projen_version: str = None,
  publish_dry_run: bool = None,
  publish_tasks: bool = None,
  pull_request_template: bool = None,
  pull_request_template_contents: typing.List[str] = None,
  readme: SampleReadmeProps = None,
  releasable_commits: ReleasableCommits = None,
  release: bool = None,
  release_branches: typing.Mapping[BranchOptions] = None,
  release_every_commit: bool = None,
  release_failure_issue: bool = None,
  release_failure_issue_label: str = None,
  release_schedule: str = None,
  release_tag_prefix: str = None,
  release_to_npm: bool = None,
  release_trigger: ReleaseTrigger = None,
  release_workflow: bool = None,
  release_workflow_name: str = None,
  release_workflow_setup_steps: typing.List[JobStep] = None,
  renovatebot: bool = None,
  renovatebot_options: RenovatebotOptions = None,
  repository: str = None,
  repository_directory: str = None,
  rewire: typing.Mapping[typing.Any] = None,
  scoped_packages_options: typing.List[ScopedPackagesOptions] = None,
  scripts: typing.Mapping[str] = None,
  srcdir: str = None,
  stability: str = None,
  stale: bool = None,
  stale_options: StaleOptions = None,
  testdir: str = None,
  tsconfig: TypescriptConfigOptions = None,
  tsconfig_dev: TypescriptConfigOptions = None,
  tsconfig_dev_file: str = None,
  ts_jest_options: TsJestOptions = None,
  typescript_version: str = None,
  versionrc_options: typing.Mapping[typing.Any] = None,
  vscode: bool = None,
  workflow_bootstrap_steps: typing.List[JobStep] = None,
  workflow_container_image: str = None,
  workflow_git_identity: GitIdentity = None,
  workflow_node_version: str = None,
  workflow_package_cache: bool = None,
  workflow_runs_on: typing.List[str] = None,
  workflow_runs_on_group: GroupRunnerOptions = None,
  yarn_berry_options: YarnBerryOptions = None,
  allow_signup: bool = None,
  application_name: str = None,
  public_dir: str = None,
  type_safe_api: TypeSafeApiProject = None,
  type_safe_apis: typing.List[TypeSafeApiProject] = None,
  type_safe_web_socket_apis: typing.List[TypeSafeWebSocketApiProject] = None
)

Properties

Name Type Description
name str No description.
allow_library_dependencies bool Allow the project to include peerDependencies and bundledDependencies.
artifacts_directory str A directory which will contain build artifacts.
author_email str Author's e-mail.
author_name str Author's name.
author_organization bool Is the author an organization.
author_url str Author's URL / Website.
auto_approve_options projen.github.AutoApproveOptions Enable and configure the 'auto approve' workflow.
auto_approve_upgrades bool Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
auto_detect_bin bool Automatically add all executables under the bin directory to your package.json file under the bin section.
auto_merge bool Enable automatic merging on GitHub.
auto_merge_options projen.github.AutoMergeOptions Configure options for automatic merging on GitHub.
bin typing.Mapping[str] Binary programs vended with your module.
bugs_email str The email address to which issues should be reported.
bugs_url str The url to your project's issue tracker.
build_workflow bool Define a GitHub workflow for building PRs.
build_workflow_options projen.javascript.BuildWorkflowOptions Options for PR build workflow.
build_workflow_triggers projen.github.workflows.Triggers Build workflow triggers.
bundled_deps typing.List[str] List of dependencies to bundle into this module.
bundler_options projen.javascript.BundlerOptions Options for Bundler.
check_licenses projen.javascript.LicenseCheckerOptions Configure which licenses should be deemed acceptable for use by dependencies.
clobber bool Add a clobber task which resets the repo to origin.
code_artifact_options projen.javascript.CodeArtifactOptions Options for npm packages using AWS CodeArtifact.
code_cov bool 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.
code_cov_token_secret str Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
commit_generated bool Whether to commit the managed files by default.
copyright_owner str License copyright owner.
copyright_period str The copyright years to put in the LICENSE file.
default_release_branch str The name of the main release branch.
dependabot bool Use dependabot to handle dependency upgrades.
dependabot_options projen.github.DependabotOptions Options for dependabot.
deps typing.List[str] Runtime dependencies of this module.
deps_upgrade bool Use tasks and github workflows to handle dependency upgrades.
deps_upgrade_options projen.javascript.UpgradeDependenciesOptions Options for UpgradeDependencies.
description str The description is just a string that helps people understand the purpose of the package.
dev_container bool Add a VSCode development environment (used for GitHub Codespaces).
dev_deps typing.List[str] Build dependencies for this module.
disable_tsconfig bool Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
disable_tsconfig_dev bool Do not generate a tsconfig.dev.json file.
docgen bool Docgen by Typedoc.
docs_directory str Docs directory.
entrypoint str Module entrypoint (main in package.json). Set to an empty string to not include main in your package.json.
entrypoint_types str The .d.ts file that includes the type declarations for this module.
eslint bool Setup eslint.
eslint_options projen.javascript.EslintOptions Eslint options.
github bool Enable GitHub integration.
github_options projen.github.GitHubOptions Options for GitHub integration.
gitignore typing.List[str] Additional entries to .gitignore.
git_ignore_options projen.IgnoreFileOptions Configuration options for .gitignore file.
git_options projen.GitOptions Configuration options for git.
gitpod bool Add a Gitpod development environment.
homepage str Package's Homepage / Website.
jest bool Setup jest unit tests.
jest_options projen.javascript.JestOptions Jest options.
jsii_release_version str Version requirement of publib which is used to publish modules to npm.
keywords typing.List[str] Keywords to include in package.json.
libdir str Typescript artifacts output directory.
license str License's SPDX identifier.
licensed bool Indicates if a license should be added.
logging projen.LoggerOptions Configure logging options such as verbosity.
major_version typing.Union[int, float] Major version to release from the default branch.
max_node_version str Minimum node.js version to require via engines (inclusive).
mergify bool Whether mergify should be enabled on this repository or not.
mergify_options projen.github.MergifyOptions Options for mergify.
min_major_version typing.Union[int, float] Minimal Major version to release.
min_node_version str Minimum Node.js version to require via package.json engines (inclusive).
mutable_build bool Automatically update files modified during builds to pull-request branches.
npm_access projen.javascript.NpmAccess Access level of the npm package.
npm_dist_tag str The npmDistTag to use when publishing from the default branch.
npmignore typing.List[str] Additional entries to .npmignore.
npmignore_enabled bool Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
npm_ignore_options projen.IgnoreFileOptions Configuration options for .npmignore file.
npm_provenance bool Should provenance statements be generated when the package is published.
npm_registry str The host name of the npm registry to publish to.
npm_registry_url str The base URL of the npm package registry.
npm_token_secret str GitHub secret which contains the NPM token to use when publishing packages.
outdir str The root directory of the project. Relative to this directory, all files are synthesized.
package bool Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
package_manager projen.javascript.NodePackageManager The Node Package Manager used to execute scripts.
package_name str The "name" in package.json.
parent projen.Project The parent project, if this project is part of a bigger project.
peer_dependency_options projen.javascript.PeerDependencyOptions Options for peerDeps.
peer_deps typing.List[str] Peer dependencies for this module.
pnpm_version str The version of PNPM to use if using PNPM as a package manager.
post_build_steps typing.List[projen.github.workflows.JobStep] Steps to execute after build as part of the release workflow.
prerelease str Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
prettier bool Setup prettier.
prettier_options projen.javascript.PrettierOptions Prettier options.
project_type projen.ProjectType Which type of project this is (library/app).
projen_command str The shell command to use in order to run the projen CLI.
projen_credentials projen.github.GithubCredentials Choose a method of providing GitHub API access for projen workflows.
projen_dev_dependency bool Indicates of "projen" should be installed as a devDependency.
projenrc_js bool Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
projenrc_json bool Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
projenrc_json_options projen.ProjenrcJsonOptions Options for .projenrc.json.
projenrc_js_options projen.javascript.ProjenrcOptions Options for .projenrc.js.
projenrc_ts bool Use TypeScript for your projenrc file (.projenrc.ts).
projenrc_ts_options projen.typescript.ProjenrcOptions Options for .projenrc.ts.
projen_token_secret str The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
projen_version str Version of projen to install.
publish_dry_run bool Instead of actually publishing to package managers, just print the publishing command.
publish_tasks bool Define publishing tasks that can be executed manually as well as workflows.
pull_request_template bool Include a GitHub pull request template.
pull_request_template_contents typing.List[str] The contents of the pull request template.
readme projen.SampleReadmeProps The README setup.
releasable_commits projen.ReleasableCommits Find commits that should be considered releasable Used to decide if a release is required.
release bool Add release management to this project.
release_branches typing.Mapping[projen.release.BranchOptions] Defines additional release branches.
release_every_commit bool Automatically release new versions every commit to one of branches in releaseBranches.
release_failure_issue bool Create a github issue on every failed publishing task.
release_failure_issue_label str The label to apply to issues indicating publish failures.
release_schedule str CRON schedule to trigger new releases.
release_tag_prefix str Automatically add the given prefix to release tags.
release_to_npm bool Automatically release to npm when new versions are introduced.
release_trigger projen.release.ReleaseTrigger The release trigger to use.
release_workflow bool DEPRECATED: renamed to release.
release_workflow_name str The name of the default release workflow.
release_workflow_setup_steps typing.List[projen.github.workflows.JobStep] A set of workflow steps to execute in order to setup the workflow container.
renovatebot bool Use renovatebot to handle dependency upgrades.
renovatebot_options projen.RenovatebotOptions Options for renovatebot.
repository str The repository is the location where the actual code for your package lives.
repository_directory str 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 typing.Mapping[typing.Any] Rewire webpack configuration. Use this property to override webpack configuration properties provided by create-react-app, without needing to eject.
scoped_packages_options typing.List[projen.javascript.ScopedPackagesOptions] Options for privately hosted scoped packages.
scripts typing.Mapping[str] npm scripts to include.
srcdir str Typescript sources directory.
stability str Package's Stability.
stale bool Auto-close of stale issues and pull request.
stale_options projen.github.StaleOptions Auto-close stale issues and pull requests.
testdir str Jest tests directory.
tsconfig projen.javascript.TypescriptConfigOptions Custom TSConfig.
tsconfig_dev projen.javascript.TypescriptConfigOptions Custom tsconfig options for the development tsconfig.json file (used for testing).
tsconfig_dev_file str The name of the development tsconfig.json file.
ts_jest_options projen.typescript.TsJestOptions Options for ts-jest.
typescript_version str TypeScript version to use.
versionrc_options typing.Mapping[typing.Any] Custom configuration used when creating changelog with standard-version package.
vscode bool Enable VSCode integration.
workflow_bootstrap_steps typing.List[projen.github.workflows.JobStep] Workflow steps to use in order to bootstrap this repo.
workflow_container_image str Container image to use for GitHub workflows.
workflow_git_identity projen.github.GitIdentity The git identity to use in workflows.
workflow_node_version str The node version to use in GitHub workflows.
workflow_package_cache bool Enable Node.js package cache in GitHub workflows.
workflow_runs_on typing.List[str] Github Runner selection labels.
workflow_runs_on_group projen.GroupRunnerOptions Github Runner Group selection options.
yarn_berry_options projen.javascript.YarnBerryOptions Options for Yarn Berry.
allow_signup bool Whether to enable self sign-up.
application_name str Name of the application name.
public_dir str Public directory.
type_safe_api aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject TypeSafeApi instance to use when setting up the initial project sample code.
type_safe_apis typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject] TypeSafeApi instances to use when setting up the initial project sample code.
type_safe_web_socket_apis typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeWebSocketApiProject] TypeSafeWebSocketApi instances to use when setting up the initial project sample code.
nameRequired 
name: str
  • Type: str
allow_library_dependenciesOptional 
allow_library_dependencies: bool
  • Type: bool
  • 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.

artifacts_directoryOptional 
artifacts_directory: str
  • Type: str
  • Default: "dist"

A directory which will contain build artifacts.

author_emailOptional 
author_email: str
  • Type: str

Author's e-mail.

author_nameOptional 
author_name: str
  • Type: str

Author's name.

author_organizationOptional 
author_organization: bool
  • Type: bool

Is the author an organization.

author_urlOptional 
author_url: str
  • Type: str

Author's URL / Website.

auto_approve_optionsOptional 
auto_approve_options: AutoApproveOptions
  • Type: projen.github.AutoApproveOptions
  • Default: auto approve is disabled

Enable and configure the 'auto approve' workflow.

auto_approve_upgradesOptional 
auto_approve_upgrades: bool
  • Type: bool
  • 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.

auto_detect_binOptional 
auto_detect_bin: bool
  • Type: bool
  • Default: true

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

auto_mergeOptional 
auto_merge: bool
  • Type: bool
  • Default: true

Enable automatic merging on GitHub.

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

auto_merge_optionsOptional 
auto_merge_options: AutoMergeOptions
  • Type: 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 
bin: typing.Mapping[str]
  • Type: typing.Mapping[str]

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.

bugs_emailOptional 
bugs_email: str
  • Type: str

The email address to which issues should be reported.

bugs_urlOptional 
bugs_url: str
  • Type: str

The url to your project's issue tracker.

build_workflowOptional 
build_workflow: bool
  • Type: bool
  • Default: true if not a subproject

Define a GitHub workflow for building PRs.

build_workflow_optionsOptional 
build_workflow_options: BuildWorkflowOptions
  • Type: projen.javascript.BuildWorkflowOptions

Options for PR build workflow.

~~build_workflow_triggers~~Optional
  • Deprecated: - Use buildWorkflowOptions.workflowTriggers
build_workflow_triggers: Triggers
  • Type: projen.github.workflows.Triggers
  • Default: "{ pullRequest: {}, workflowDispatch: {} }"

Build workflow triggers.

bundled_depsOptional 
bundled_deps: typing.List[str]
  • Type: typing.List[str]

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.

bundler_optionsOptional 
bundler_options: BundlerOptions
  • Type: projen.javascript.BundlerOptions

Options for Bundler.

check_licensesOptional 
check_licenses: LicenseCheckerOptions
  • Type: 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 
clobber: bool
  • Type: bool
  • Default: true, but false for subprojects

Add a clobber task which resets the repo to origin.

code_artifact_optionsOptional 
code_artifact_options: CodeArtifactOptions
  • Type: 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

code_covOptional 
code_cov: bool
  • Type: bool
  • 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.

code_cov_token_secretOptional 
code_cov_token_secret: str
  • Type: str
  • 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.

commit_generatedOptional 
commit_generated: bool
  • Type: bool
  • Default: true

Whether to commit the managed files by default.

copyright_owner: str
  • Type: str
  • Default: defaults to the value of authorName or "" if authorName is undefined.

License copyright owner.

copyright_period: str
  • Type: str
  • Default: current year

The copyright years to put in the LICENSE file.

default_release_branchOptional 
default_release_branch: str
  • Type: str
  • Default: "main"

The name of the main release branch.

dependabotOptional 
dependabot: bool
  • Type: bool
  • Default: false

Use dependabot to handle dependency upgrades.

Cannot be used in conjunction with depsUpgrade.

dependabot_optionsOptional 
dependabot_options: DependabotOptions
  • Type: projen.github.DependabotOptions
  • Default: default options

Options for dependabot.

depsOptional 
deps: typing.List[str]
  • Type: typing.List[str]
  • 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.

deps_upgradeOptional 
deps_upgrade: bool
  • Type: bool
  • Default: true

Use tasks and github workflows to handle dependency upgrades.

Cannot be used in conjunction with dependabot.

deps_upgrade_optionsOptional 
deps_upgrade_options: UpgradeDependenciesOptions
  • Type: projen.javascript.UpgradeDependenciesOptions
  • Default: default options

Options for UpgradeDependencies.

descriptionOptional 
description: str
  • Type: str

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

dev_containerOptional 
dev_container: bool
  • Type: bool
  • Default: false

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

dev_depsOptional 
dev_deps: typing.List[str]
  • Type: typing.List[str]
  • 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.

disable_tsconfigOptional 
disable_tsconfig: bool
  • Type: bool
  • Default: false

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

disable_tsconfig_devOptional 
disable_tsconfig_dev: bool
  • Type: bool
  • Default: false

Do not generate a tsconfig.dev.json file.

docgenOptional 
docgen: bool
  • Type: bool
  • Default: false

Docgen by Typedoc.

docs_directoryOptional 
docs_directory: str
  • Type: str
  • Default: "docs"

Docs directory.

entrypointOptional 
entrypoint: str
  • Type: str
  • Default: "lib/index.js"

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

entrypoint_typesOptional 
entrypoint_types: str
  • Type: str
  • 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 
eslint: bool
  • Type: bool
  • Default: true

Setup eslint.

eslint_optionsOptional 
eslint_options: EslintOptions
  • Type: projen.javascript.EslintOptions
  • Default: opinionated default options

Eslint options.

githubOptional 
github: bool
  • Type: bool
  • Default: true

Enable GitHub integration.

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

github_optionsOptional 
github_options: GitHubOptions
  • Type: projen.github.GitHubOptions
  • Default: see GitHubOptions

Options for GitHub integration.

gitignoreOptional 
gitignore: typing.List[str]
  • Type: typing.List[str]

Additional entries to .gitignore.

git_ignore_optionsOptional 
git_ignore_options: IgnoreFileOptions
  • Type: projen.IgnoreFileOptions

Configuration options for .gitignore file.

git_optionsOptional 
git_options: GitOptions
  • Type: projen.GitOptions

Configuration options for git.

gitpodOptional 
gitpod: bool
  • Type: bool
  • Default: false

Add a Gitpod development environment.

homepageOptional 
homepage: str
  • Type: str

Package's Homepage / Website.

jestOptional 
jest: bool
  • Type: bool
  • Default: true

Setup jest unit tests.

jest_optionsOptional 
jest_options: JestOptions
  • Type: projen.javascript.JestOptions
  • Default: default options

Jest options.

jsii_release_versionOptional 
jsii_release_version: str
  • Type: str
  • Default: "latest"

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

keywordsOptional 
keywords: typing.List[str]
  • Type: typing.List[str]

Keywords to include in package.json.

libdirOptional 
libdir: str
  • Type: str
  • Default: "lib"

Typescript artifacts output directory.

licenseOptional 
license: str
  • Type: str
  • 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 
licensed: bool
  • Type: bool
  • Default: true

Indicates if a license should be added.

loggingOptional 
logging: LoggerOptions
  • Type: projen.LoggerOptions
  • Default: {}

Configure logging options such as verbosity.

major_versionOptional 
major_version: typing.Union[int, float]
  • Type: typing.Union[int, float]
  • 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.

max_node_versionOptional 
max_node_version: str
  • Type: str
  • Default: no max

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

~~mergify~~Optional
  • Deprecated: use githubOptions.mergify instead
mergify: bool
  • Type: bool
  • Default: true

Whether mergify should be enabled on this repository or not.

~~mergify_options~~Optional
  • Deprecated: use githubOptions.mergifyOptions instead
mergify_options: MergifyOptions
  • Type: projen.github.MergifyOptions
  • Default: default options

Options for mergify.

min_major_versionOptional 
min_major_version: typing.Union[int, float]
  • Type: typing.Union[int, float]
  • 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.

min_node_versionOptional 
min_node_version: str
  • Type: str
  • Default: no "engines" specified

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

~~mutable_build~~Optional
  • Deprecated: - Use buildWorkflowOptions.mutableBuild
mutable_build: bool
  • Type: bool
  • 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.

npm_accessOptional 
npm_access: NpmAccess
  • Type: 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.

npm_dist_tagOptional 
npm_dist_tag: str
  • Type: str
  • 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
npmignore: typing.List[str]
  • Type: typing.List[str]

Additional entries to .npmignore.

npmignore_enabledOptional 
npmignore_enabled: bool
  • Type: bool
  • Default: true

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

npm_ignore_optionsOptional 
npm_ignore_options: IgnoreFileOptions
  • Type: projen.IgnoreFileOptions

Configuration options for .npmignore file.

npm_provenanceOptional 
npm_provenance: bool
  • Type: bool
  • 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.

~~npm_registry~~Optional
  • Deprecated: use npmRegistryUrl instead
npm_registry: str
  • Type: str

The host name of the npm registry to publish to.

Cannot be set together with npmRegistryUrl.

npm_registry_urlOptional 
npm_registry_url: str

The base URL of the npm package registry.

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

npm_token_secretOptional 
npm_token_secret: str
  • Type: str
  • Default: "NPM_TOKEN"

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

outdirOptional 
outdir: str
  • Type: str
  • 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 
package: bool
  • Type: bool
  • Default: true

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

package_managerOptional 
package_manager: NodePackageManager
  • Type: projen.javascript.NodePackageManager
  • Default: NodePackageManager.YARN_CLASSIC

The Node Package Manager used to execute scripts.

package_nameOptional 
package_name: str
  • Type: str
  • Default: defaults to project name

The "name" in package.json.

parentOptional 
parent: Project
  • Type: projen.Project

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

peer_dependency_optionsOptional 
peer_dependency_options: PeerDependencyOptions
  • Type: projen.javascript.PeerDependencyOptions

Options for peerDeps.

peer_depsOptional 
peer_deps: typing.List[str]
  • Type: typing.List[str]
  • 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.

pnpm_versionOptional 
pnpm_version: str
  • Type: str
  • Default: "7"

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

post_build_stepsOptional 
post_build_steps: typing.List[JobStep]
  • Type: typing.List[projen.github.workflows.JobStep]
  • Default: []

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

prereleaseOptional 
prerelease: str
  • Type: str
  • Default: normal semantic versions

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

prettierOptional 
prettier: bool
  • Type: bool
  • Default: false

Setup prettier.

prettier_optionsOptional 
prettier_options: PrettierOptions
  • Type: projen.javascript.PrettierOptions
  • Default: default options

Prettier options.

~~project_type~~Optional
  • Deprecated: no longer supported at the base project level
project_type: ProjectType
  • Type: projen.ProjectType
  • Default: ProjectType.UNKNOWN

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

projen_commandOptional 
projen_command: str
  • Type: str
  • Default: "npx projen"

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

Can be used to customize in special environments.

projen_credentialsOptional 
projen_credentials: GithubCredentials
  • Type: projen.github.GithubCredentials
  • Default: use a personal access token named PROJEN_GITHUB_TOKEN

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

projen_dev_dependencyOptional 
projen_dev_dependency: bool
  • Type: bool
  • Default: true if not a subproject

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

projenrc_jsOptional 
projenrc_js: bool
  • Type: bool
  • Default: true if projenrcJson is false

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

projenrc_jsonOptional 
projenrc_json: bool
  • Type: bool
  • Default: false

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

projenrc_json_optionsOptional 
projenrc_json_options: ProjenrcJsonOptions
  • Type: projen.ProjenrcJsonOptions
  • Default: default options

Options for .projenrc.json.

projenrc_js_optionsOptional 
projenrc_js_options: ProjenrcOptions
  • Type: projen.javascript.ProjenrcOptions
  • Default: default options

Options for .projenrc.js.

projenrc_tsOptional 
projenrc_ts: bool
  • Type: bool
  • Default: false

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

projenrc_ts_optionsOptional 
projenrc_ts_options: ProjenrcOptions
  • Type: projen.typescript.ProjenrcOptions

Options for .projenrc.ts.

~~projen_token_secret~~Optional
  • Deprecated: use projenCredentials
projen_token_secret: str
  • Type: str
  • 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.

projen_versionOptional 
projen_version: str
  • Type: str
  • Default: Defaults to the latest version.

Version of projen to install.

publish_dry_runOptional 
publish_dry_run: bool
  • Type: bool
  • Default: false

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

publish_tasksOptional 
publish_tasks: bool
  • Type: bool
  • 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.

pull_request_templateOptional 
pull_request_template: bool
  • Type: bool
  • Default: true

Include a GitHub pull request template.

pull_request_template_contentsOptional 
pull_request_template_contents: typing.List[str]
  • Type: typing.List[str]
  • Default: default content

The contents of the pull request template.

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

The README setup.

releasable_commitsOptional 
releasable_commits: ReleasableCommits
  • Type: projen.ReleasableCommits
  • Default: ReleasableCommits.everyCommit()

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

releaseOptional 
release: bool
  • Type: bool
  • Default: true (false for subprojects)

Add release management to this project.

release_branchesOptional 
release_branches: typing.Mapping[BranchOptions]
  • Type: typing.Mapping[projen.release.BranchOptions]
  • 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.

~~release_every_commit~~Optional
  • Deprecated: Use releaseTrigger: ReleaseTrigger.continuous() instead
release_every_commit: bool
  • Type: bool
  • Default: true

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

release_failure_issueOptional 
release_failure_issue: bool
  • Type: bool
  • Default: false

Create a github issue on every failed publishing task.

release_failure_issue_labelOptional 
release_failure_issue_label: str
  • Type: str
  • Default: "failed-release"

The label to apply to issues indicating publish failures.

Only applies if releaseFailureIssue is true.

~~release_schedule~~Optional
  • Deprecated: Use releaseTrigger: ReleaseTrigger.scheduled() instead
release_schedule: str
  • Type: str
  • Default: no scheduled releases

CRON schedule to trigger new releases.

release_tag_prefixOptional 
release_tag_prefix: str
  • Type: str
  • 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.

release_to_npmOptional 
release_to_npm: bool
  • Type: bool
  • Default: false

Automatically release to npm when new versions are introduced.

release_triggerOptional 
release_trigger: ReleaseTrigger
  • Type: projen.release.ReleaseTrigger
  • Default: Continuous releases (ReleaseTrigger.continuous())

The release trigger to use.

~~release_workflow~~Optional
  • Deprecated: see release.
release_workflow: bool
  • Type: bool
  • Default: true if not a subproject

DEPRECATED: renamed to release.

release_workflow_nameOptional 
release_workflow_name: str
  • Type: str
  • Default: "release"

The name of the default release workflow.

release_workflow_setup_stepsOptional 
release_workflow_setup_steps: typing.List[JobStep]
  • Type: typing.List[projen.github.workflows.JobStep]

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

renovatebotOptional 
renovatebot: bool
  • Type: bool
  • Default: false

Use renovatebot to handle dependency upgrades.

renovatebot_optionsOptional 
renovatebot_options: RenovatebotOptions
  • Type: projen.RenovatebotOptions
  • Default: default options

Options for renovatebot.

repositoryOptional 
repository: str
  • Type: str

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

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

repository_directoryOptional 
repository_directory: str
  • Type: str

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 
rewire: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
  • 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;
}
scoped_packages_optionsOptional 
scoped_packages_options: typing.List[ScopedPackagesOptions]
  • Type: typing.List[projen.javascript.ScopedPackagesOptions]
  • 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()
scripts: typing.Mapping[str]
  • Type: typing.Mapping[str]
  • 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 
srcdir: str
  • Type: str
  • Default: "src"

Typescript sources directory.

stabilityOptional 
stability: str
  • Type: str

Package's Stability.

staleOptional 
stale: bool
  • Type: bool
  • Default: false

Auto-close of stale issues and pull request.

See staleOptions for options.

stale_optionsOptional 
stale_options: StaleOptions
  • Type: projen.github.StaleOptions
  • Default: see defaults in StaleOptions

Auto-close stale issues and pull requests.

To disable set stale to false.

testdirOptional 
testdir: str
  • Type: str
  • 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 
tsconfig: TypescriptConfigOptions
  • Type: projen.javascript.TypescriptConfigOptions
  • Default: default options

Custom TSConfig.

tsconfig_devOptional 
tsconfig_dev: TypescriptConfigOptions
  • Type: projen.javascript.TypescriptConfigOptions
  • Default: use the production tsconfig options

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

tsconfig_dev_fileOptional 
tsconfig_dev_file: str
  • Type: str
  • Default: "tsconfig.dev.json"

The name of the development tsconfig.json file.

ts_jest_optionsOptional 
ts_jest_options: TsJestOptions
  • Type: projen.typescript.TsJestOptions

Options for ts-jest.

typescript_versionOptional 
typescript_version: str
  • Type: str
  • 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).

versionrc_optionsOptional 
versionrc_options: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
  • 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 
vscode: bool
  • Type: bool
  • Default: true

Enable VSCode integration.

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

workflow_bootstrap_stepsOptional 
workflow_bootstrap_steps: typing.List[JobStep]
  • Type: typing.List[projen.github.workflows.JobStep]
  • Default: "yarn install --frozen-lockfile && yarn projen"

Workflow steps to use in order to bootstrap this repo.

workflow_container_imageOptional 
workflow_container_image: str
  • Type: str
  • Default: default image

Container image to use for GitHub workflows.

workflow_git_identityOptional 
workflow_git_identity: GitIdentity
  • Type: projen.github.GitIdentity
  • Default: GitHub Actions

The git identity to use in workflows.

workflow_node_versionOptional 
workflow_node_version: str
  • Type: str
  • Default: same as minNodeVersion

The node version to use in GitHub workflows.

workflow_package_cacheOptional 
workflow_package_cache: bool
  • Type: bool
  • Default: false

Enable Node.js package cache in GitHub workflows.

workflow_runs_onOptional 
workflow_runs_on: typing.List[str]
  • Type: typing.List[str]
  • Default: ["ubuntu-latest"]

Github Runner selection labels.

workflow_runs_on_groupOptional 
workflow_runs_on_group: GroupRunnerOptions
  • Type: projen.GroupRunnerOptions

Github Runner Group selection options.

yarn_berry_optionsOptional 
yarn_berry_options: YarnBerryOptions
  • Type: projen.javascript.YarnBerryOptions
  • Default: Yarn Berry v4 with all default options

Options for Yarn Berry.

allow_signupOptional 
allow_signup: bool
  • Type: bool
  • Default: false

Whether to enable self sign-up.

application_nameOptional 
application_name: str
  • Type: str
  • Default: "Sample App"

Name of the application name.

public_dirOptional 
public_dir: str
  • Type: str
  • Default: "public"

Public directory.

~~type_safe_api~~Optional
  • Deprecated: use typeSafeApis
type_safe_api: TypeSafeApiProject
  • Type: aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject

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

type_safe_apisOptional 
type_safe_apis: typing.List[TypeSafeApiProject]
  • Type: typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeApiProject]

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

type_safe_web_socket_apisOptional 
type_safe_web_socket_apis: typing.List[TypeSafeWebSocketApiProject]
  • Type: typing.List[aws.pdk.cloudscape_react_ts_website.TypeSafeWebSocketApiProject]

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

ReactTypeScriptProjectOptions

ReactTypeScriptProjectOptions.

Initializer 

import aws.pdk.cloudscape_react_ts_website

aws.pdk.cloudscape_react_ts_website.ReactTypeScriptProjectOptions(
  name: str,
  allow_library_dependencies: bool = None,
  artifacts_directory: str = None,
  author_email: str = None,
  author_name: str = None,
  author_organization: bool = None,
  author_url: str = None,
  auto_approve_options: AutoApproveOptions = None,
  auto_approve_upgrades: bool = None,
  auto_detect_bin: bool = None,
  auto_merge: bool = None,
  auto_merge_options: AutoMergeOptions = None,
  bin: typing.Mapping[str] = None,
  bugs_email: str = None,
  bugs_url: str = None,
  build_workflow: bool = None,
  build_workflow_options: BuildWorkflowOptions = None,
  build_workflow_triggers: Triggers = None,
  bundled_deps: typing.List[str] = None,
  bundler_options: BundlerOptions = None,
  check_licenses: LicenseCheckerOptions = None,
  clobber: bool = None,
  code_artifact_options: CodeArtifactOptions = None,
  code_cov: bool = None,
  code_cov_token_secret: str = None,
  commit_generated: bool = None,
  copyright_owner: str = None,
  copyright_period: str = None,
  default_release_branch: str = None,
  dependabot: bool = None,
  dependabot_options: DependabotOptions = None,
  deps: typing.List[str] = None,
  deps_upgrade: bool = None,
  deps_upgrade_options: UpgradeDependenciesOptions = None,
  description: str = None,
  dev_container: bool = None,
  dev_deps: typing.List[str] = None,
  disable_tsconfig: bool = None,
  disable_tsconfig_dev: bool = None,
  docgen: bool = None,
  docs_directory: str = None,
  entrypoint: str = None,
  entrypoint_types: str = None,
  eslint: bool = None,
  eslint_options: EslintOptions = None,
  github: bool = None,
  github_options: GitHubOptions = None,
  gitignore: typing.List[str] = None,
  git_ignore_options: IgnoreFileOptions = None,
  git_options: GitOptions = None,
  gitpod: bool = None,
  homepage: str = None,
  jest: bool = None,
  jest_options: JestOptions = None,
  jsii_release_version: str = None,
  keywords: typing.List[str] = None,
  libdir: str = None,
  license: str = None,
  licensed: bool = None,
  logging: LoggerOptions = None,
  major_version: typing.Union[int, float] = None,
  max_node_version: str = None,
  mergify: bool = None,
  mergify_options: MergifyOptions = None,
  min_major_version: typing.Union[int, float] = None,
  min_node_version: str = None,
  mutable_build: bool = None,
  npm_access: NpmAccess = None,
  npm_dist_tag: str = None,
  npmignore: typing.List[str] = None,
  npmignore_enabled: bool = None,
  npm_ignore_options: IgnoreFileOptions = None,
  npm_provenance: bool = None,
  npm_registry: str = None,
  npm_registry_url: str = None,
  npm_token_secret: str = None,
  outdir: str = None,
  package: bool = None,
  package_manager: NodePackageManager = None,
  package_name: str = None,
  parent: Project = None,
  peer_dependency_options: PeerDependencyOptions = None,
  peer_deps: typing.List[str] = None,
  pnpm_version: str = None,
  post_build_steps: typing.List[JobStep] = None,
  prerelease: str = None,
  prettier: bool = None,
  prettier_options: PrettierOptions = None,
  project_type: ProjectType = None,
  projen_command: str = None,
  projen_credentials: GithubCredentials = None,
  projen_dev_dependency: bool = None,
  projenrc_js: bool = None,
  projenrc_json: bool = None,
  projenrc_json_options: ProjenrcJsonOptions = None,
  projenrc_js_options: ProjenrcOptions = None,
  projenrc_ts: bool = None,
  projenrc_ts_options: ProjenrcOptions = None,
  projen_token_secret: str = None,
  projen_version: str = None,
  publish_dry_run: bool = None,
  publish_tasks: bool = None,
  pull_request_template: bool = None,
  pull_request_template_contents: typing.List[str] = None,
  readme: SampleReadmeProps = None,
  releasable_commits: ReleasableCommits = None,
  release: bool = None,
  release_branches: typing.Mapping[BranchOptions] = None,
  release_every_commit: bool = None,
  release_failure_issue: bool = None,
  release_failure_issue_label: str = None,
  release_schedule: str = None,
  release_tag_prefix: str = None,
  release_to_npm: bool = None,
  release_trigger: ReleaseTrigger = None,
  release_workflow: bool = None,
  release_workflow_name: str = None,
  release_workflow_setup_steps: typing.List[JobStep] = None,
  renovatebot: bool = None,
  renovatebot_options: RenovatebotOptions = None,
  repository: str = None,
  repository_directory: str = None,
  rewire: typing.Mapping[typing.Any] = None,
  scoped_packages_options: typing.List[ScopedPackagesOptions] = None,
  scripts: typing.Mapping[str] = None,
  srcdir: str = None,
  stability: str = None,
  stale: bool = None,
  stale_options: StaleOptions = None,
  testdir: str = None,
  tsconfig: TypescriptConfigOptions = None,
  tsconfig_dev: TypescriptConfigOptions = None,
  tsconfig_dev_file: str = None,
  ts_jest_options: TsJestOptions = None,
  typescript_version: str = None,
  versionrc_options: typing.Mapping[typing.Any] = None,
  vscode: bool = None,
  workflow_bootstrap_steps: typing.List[JobStep] = None,
  workflow_container_image: str = None,
  workflow_git_identity: GitIdentity = None,
  workflow_node_version: str = None,
  workflow_package_cache: bool = None,
  workflow_runs_on: typing.List[str] = None,
  workflow_runs_on_group: GroupRunnerOptions = None,
  yarn_berry_options: YarnBerryOptions = None
)

Properties

Name Type Description
name str No description.
allow_library_dependencies bool Allow the project to include peerDependencies and bundledDependencies.
artifacts_directory str A directory which will contain build artifacts.
author_email str Author's e-mail.
author_name str Author's name.
author_organization bool Is the author an organization.
author_url str Author's URL / Website.
auto_approve_options projen.github.AutoApproveOptions Enable and configure the 'auto approve' workflow.
auto_approve_upgrades bool Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
auto_detect_bin bool Automatically add all executables under the bin directory to your package.json file under the bin section.
auto_merge bool Enable automatic merging on GitHub.
auto_merge_options projen.github.AutoMergeOptions Configure options for automatic merging on GitHub.
bin typing.Mapping[str] Binary programs vended with your module.
bugs_email str The email address to which issues should be reported.
bugs_url str The url to your project's issue tracker.
build_workflow bool Define a GitHub workflow for building PRs.
build_workflow_options projen.javascript.BuildWorkflowOptions Options for PR build workflow.
build_workflow_triggers projen.github.workflows.Triggers Build workflow triggers.
bundled_deps typing.List[str] List of dependencies to bundle into this module.
bundler_options projen.javascript.BundlerOptions Options for Bundler.
check_licenses projen.javascript.LicenseCheckerOptions Configure which licenses should be deemed acceptable for use by dependencies.
clobber bool Add a clobber task which resets the repo to origin.
code_artifact_options projen.javascript.CodeArtifactOptions Options for npm packages using AWS CodeArtifact.
code_cov bool 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.
code_cov_token_secret str Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
commit_generated bool Whether to commit the managed files by default.
copyright_owner str License copyright owner.
copyright_period str The copyright years to put in the LICENSE file.
default_release_branch str The name of the main release branch.
dependabot bool Use dependabot to handle dependency upgrades.
dependabot_options projen.github.DependabotOptions Options for dependabot.
deps typing.List[str] Runtime dependencies of this module.
deps_upgrade bool Use tasks and github workflows to handle dependency upgrades.
deps_upgrade_options projen.javascript.UpgradeDependenciesOptions Options for UpgradeDependencies.
description str The description is just a string that helps people understand the purpose of the package.
dev_container bool Add a VSCode development environment (used for GitHub Codespaces).
dev_deps typing.List[str] Build dependencies for this module.
disable_tsconfig bool Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
disable_tsconfig_dev bool Do not generate a tsconfig.dev.json file.
docgen bool Docgen by Typedoc.
docs_directory str Docs directory.
entrypoint str Module entrypoint (main in package.json). Set to an empty string to not include main in your package.json.
entrypoint_types str The .d.ts file that includes the type declarations for this module.
eslint bool Setup eslint.
eslint_options projen.javascript.EslintOptions Eslint options.
github bool Enable GitHub integration.
github_options projen.github.GitHubOptions Options for GitHub integration.
gitignore typing.List[str] Additional entries to .gitignore.
git_ignore_options projen.IgnoreFileOptions Configuration options for .gitignore file.
git_options projen.GitOptions Configuration options for git.
gitpod bool Add a Gitpod development environment.
homepage str Package's Homepage / Website.
jest bool Setup jest unit tests.
jest_options projen.javascript.JestOptions Jest options.
jsii_release_version str Version requirement of publib which is used to publish modules to npm.
keywords typing.List[str] Keywords to include in package.json.
libdir str Typescript artifacts output directory.
license str License's SPDX identifier.
licensed bool Indicates if a license should be added.
logging projen.LoggerOptions Configure logging options such as verbosity.
major_version typing.Union[int, float] Major version to release from the default branch.
max_node_version str Minimum node.js version to require via engines (inclusive).
mergify bool Whether mergify should be enabled on this repository or not.
mergify_options projen.github.MergifyOptions Options for mergify.
min_major_version typing.Union[int, float] Minimal Major version to release.
min_node_version str Minimum Node.js version to require via package.json engines (inclusive).
mutable_build bool Automatically update files modified during builds to pull-request branches.
npm_access projen.javascript.NpmAccess Access level of the npm package.
npm_dist_tag str The npmDistTag to use when publishing from the default branch.
npmignore typing.List[str] Additional entries to .npmignore.
npmignore_enabled bool Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
npm_ignore_options projen.IgnoreFileOptions Configuration options for .npmignore file.
npm_provenance bool Should provenance statements be generated when the package is published.
npm_registry str The host name of the npm registry to publish to.
npm_registry_url str The base URL of the npm package registry.
npm_token_secret str GitHub secret which contains the NPM token to use when publishing packages.
outdir str The root directory of the project. Relative to this directory, all files are synthesized.
package bool Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
package_manager projen.javascript.NodePackageManager The Node Package Manager used to execute scripts.
package_name str The "name" in package.json.
parent projen.Project The parent project, if this project is part of a bigger project.
peer_dependency_options projen.javascript.PeerDependencyOptions Options for peerDeps.
peer_deps typing.List[str] Peer dependencies for this module.
pnpm_version str The version of PNPM to use if using PNPM as a package manager.
post_build_steps typing.List[projen.github.workflows.JobStep] Steps to execute after build as part of the release workflow.
prerelease str Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
prettier bool Setup prettier.
prettier_options projen.javascript.PrettierOptions Prettier options.
project_type projen.ProjectType Which type of project this is (library/app).
projen_command str The shell command to use in order to run the projen CLI.
projen_credentials projen.github.GithubCredentials Choose a method of providing GitHub API access for projen workflows.
projen_dev_dependency bool Indicates of "projen" should be installed as a devDependency.
projenrc_js bool Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
projenrc_json bool Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
projenrc_json_options projen.ProjenrcJsonOptions Options for .projenrc.json.
projenrc_js_options projen.javascript.ProjenrcOptions Options for .projenrc.js.
projenrc_ts bool Use TypeScript for your projenrc file (.projenrc.ts).
projenrc_ts_options projen.typescript.ProjenrcOptions Options for .projenrc.ts.
projen_token_secret str The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
projen_version str Version of projen to install.
publish_dry_run bool Instead of actually publishing to package managers, just print the publishing command.
publish_tasks bool Define publishing tasks that can be executed manually as well as workflows.
pull_request_template bool Include a GitHub pull request template.
pull_request_template_contents typing.List[str] The contents of the pull request template.
readme projen.SampleReadmeProps The README setup.
releasable_commits projen.ReleasableCommits Find commits that should be considered releasable Used to decide if a release is required.
release bool Add release management to this project.
release_branches typing.Mapping[projen.release.BranchOptions] Defines additional release branches.
release_every_commit bool Automatically release new versions every commit to one of branches in releaseBranches.
release_failure_issue bool Create a github issue on every failed publishing task.
release_failure_issue_label str The label to apply to issues indicating publish failures.
release_schedule str CRON schedule to trigger new releases.
release_tag_prefix str Automatically add the given prefix to release tags.
release_to_npm bool Automatically release to npm when new versions are introduced.
release_trigger projen.release.ReleaseTrigger The release trigger to use.
release_workflow bool DEPRECATED: renamed to release.
release_workflow_name str The name of the default release workflow.
release_workflow_setup_steps typing.List[projen.github.workflows.JobStep] A set of workflow steps to execute in order to setup the workflow container.
renovatebot bool Use renovatebot to handle dependency upgrades.
renovatebot_options projen.RenovatebotOptions Options for renovatebot.
repository str The repository is the location where the actual code for your package lives.
repository_directory str 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 typing.Mapping[typing.Any] Rewire webpack configuration. Use this property to override webpack configuration properties provided by create-react-app, without needing to eject.
scoped_packages_options typing.List[projen.javascript.ScopedPackagesOptions] Options for privately hosted scoped packages.
scripts typing.Mapping[str] npm scripts to include.
srcdir str Typescript sources directory.
stability str Package's Stability.
stale bool Auto-close of stale issues and pull request.
stale_options projen.github.StaleOptions Auto-close stale issues and pull requests.
testdir str Jest tests directory.
tsconfig projen.javascript.TypescriptConfigOptions Custom TSConfig.
tsconfig_dev projen.javascript.TypescriptConfigOptions Custom tsconfig options for the development tsconfig.json file (used for testing).
tsconfig_dev_file str The name of the development tsconfig.json file.
ts_jest_options projen.typescript.TsJestOptions Options for ts-jest.
typescript_version str TypeScript version to use.
versionrc_options typing.Mapping[typing.Any] Custom configuration used when creating changelog with standard-version package.
vscode bool Enable VSCode integration.
workflow_bootstrap_steps typing.List[projen.github.workflows.JobStep] Workflow steps to use in order to bootstrap this repo.
workflow_container_image str Container image to use for GitHub workflows.
workflow_git_identity projen.github.GitIdentity The git identity to use in workflows.
workflow_node_version str The node version to use in GitHub workflows.
workflow_package_cache bool Enable Node.js package cache in GitHub workflows.
workflow_runs_on typing.List[str] Github Runner selection labels.
workflow_runs_on_group projen.GroupRunnerOptions Github Runner Group selection options.
yarn_berry_options projen.javascript.YarnBerryOptions Options for Yarn Berry.
nameRequired 
name: str
  • Type: str
allow_library_dependenciesOptional 
allow_library_dependencies: bool
  • Type: bool
  • 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.

artifacts_directoryOptional 
artifacts_directory: str
  • Type: str
  • Default: "dist"

A directory which will contain build artifacts.

author_emailOptional 
author_email: str
  • Type: str

Author's e-mail.

author_nameOptional 
author_name: str
  • Type: str

Author's name.

author_organizationOptional 
author_organization: bool
  • Type: bool

Is the author an organization.

author_urlOptional 
author_url: str
  • Type: str

Author's URL / Website.

auto_approve_optionsOptional 
auto_approve_options: AutoApproveOptions
  • Type: projen.github.AutoApproveOptions
  • Default: auto approve is disabled

Enable and configure the 'auto approve' workflow.

auto_approve_upgradesOptional 
auto_approve_upgrades: bool
  • Type: bool
  • 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.

auto_detect_binOptional 
auto_detect_bin: bool
  • Type: bool
  • Default: true

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

auto_mergeOptional 
auto_merge: bool
  • Type: bool
  • Default: true

Enable automatic merging on GitHub.

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

auto_merge_optionsOptional 
auto_merge_options: AutoMergeOptions
  • Type: 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 
bin: typing.Mapping[str]
  • Type: typing.Mapping[str]

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.

bugs_emailOptional 
bugs_email: str
  • Type: str

The email address to which issues should be reported.

bugs_urlOptional 
bugs_url: str
  • Type: str

The url to your project's issue tracker.

build_workflowOptional 
build_workflow: bool
  • Type: bool
  • Default: true if not a subproject

Define a GitHub workflow for building PRs.

build_workflow_optionsOptional 
build_workflow_options: BuildWorkflowOptions
  • Type: projen.javascript.BuildWorkflowOptions

Options for PR build workflow.

~~build_workflow_triggers~~Optional
  • Deprecated: - Use buildWorkflowOptions.workflowTriggers
build_workflow_triggers: Triggers
  • Type: projen.github.workflows.Triggers
  • Default: "{ pullRequest: {}, workflowDispatch: {} }"

Build workflow triggers.

bundled_depsOptional 
bundled_deps: typing.List[str]
  • Type: typing.List[str]

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.

bundler_optionsOptional 
bundler_options: BundlerOptions
  • Type: projen.javascript.BundlerOptions

Options for Bundler.

check_licensesOptional 
check_licenses: LicenseCheckerOptions
  • Type: 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 
clobber: bool
  • Type: bool
  • Default: true, but false for subprojects

Add a clobber task which resets the repo to origin.

code_artifact_optionsOptional 
code_artifact_options: CodeArtifactOptions
  • Type: 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

code_covOptional 
code_cov: bool
  • Type: bool
  • 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.

code_cov_token_secretOptional 
code_cov_token_secret: str
  • Type: str
  • 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.

commit_generatedOptional 
commit_generated: bool
  • Type: bool
  • Default: true

Whether to commit the managed files by default.

copyright_owner: str
  • Type: str
  • Default: defaults to the value of authorName or "" if authorName is undefined.

License copyright owner.

copyright_period: str
  • Type: str
  • Default: current year

The copyright years to put in the LICENSE file.

default_release_branchOptional 
default_release_branch: str
  • Type: str
  • Default: "main"

The name of the main release branch.

dependabotOptional 
dependabot: bool
  • Type: bool
  • Default: false

Use dependabot to handle dependency upgrades.

Cannot be used in conjunction with depsUpgrade.

dependabot_optionsOptional 
dependabot_options: DependabotOptions
  • Type: projen.github.DependabotOptions
  • Default: default options

Options for dependabot.

depsOptional 
deps: typing.List[str]
  • Type: typing.List[str]
  • 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.

deps_upgradeOptional 
deps_upgrade: bool
  • Type: bool
  • Default: true

Use tasks and github workflows to handle dependency upgrades.

Cannot be used in conjunction with dependabot.

deps_upgrade_optionsOptional 
deps_upgrade_options: UpgradeDependenciesOptions
  • Type: projen.javascript.UpgradeDependenciesOptions
  • Default: default options

Options for UpgradeDependencies.

descriptionOptional 
description: str
  • Type: str

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

dev_containerOptional 
dev_container: bool
  • Type: bool
  • Default: false

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

dev_depsOptional 
dev_deps: typing.List[str]
  • Type: typing.List[str]
  • 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.

disable_tsconfigOptional 
disable_tsconfig: bool
  • Type: bool
  • Default: false

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

disable_tsconfig_devOptional 
disable_tsconfig_dev: bool
  • Type: bool
  • Default: false

Do not generate a tsconfig.dev.json file.

docgenOptional 
docgen: bool
  • Type: bool
  • Default: false

Docgen by Typedoc.

docs_directoryOptional 
docs_directory: str
  • Type: str
  • Default: "docs"

Docs directory.

entrypointOptional 
entrypoint: str
  • Type: str
  • Default: "lib/index.js"

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

entrypoint_typesOptional 
entrypoint_types: str
  • Type: str
  • 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 
eslint: bool
  • Type: bool
  • Default: true

Setup eslint.

eslint_optionsOptional 
eslint_options: EslintOptions
  • Type: projen.javascript.EslintOptions
  • Default: opinionated default options

Eslint options.

githubOptional 
github: bool
  • Type: bool
  • Default: true

Enable GitHub integration.

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

github_optionsOptional 
github_options: GitHubOptions
  • Type: projen.github.GitHubOptions
  • Default: see GitHubOptions

Options for GitHub integration.

gitignoreOptional 
gitignore: typing.List[str]
  • Type: typing.List[str]

Additional entries to .gitignore.

git_ignore_optionsOptional 
git_ignore_options: IgnoreFileOptions
  • Type: projen.IgnoreFileOptions

Configuration options for .gitignore file.

git_optionsOptional 
git_options: GitOptions
  • Type: projen.GitOptions

Configuration options for git.

gitpodOptional 
gitpod: bool
  • Type: bool
  • Default: false

Add a Gitpod development environment.

homepageOptional 
homepage: str
  • Type: str

Package's Homepage / Website.

jestOptional 
jest: bool
  • Type: bool
  • Default: true

Setup jest unit tests.

jest_optionsOptional 
jest_options: JestOptions
  • Type: projen.javascript.JestOptions
  • Default: default options

Jest options.

jsii_release_versionOptional 
jsii_release_version: str
  • Type: str
  • Default: "latest"

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

keywordsOptional 
keywords: typing.List[str]
  • Type: typing.List[str]

Keywords to include in package.json.

libdirOptional 
libdir: str
  • Type: str
  • Default: "lib"

Typescript artifacts output directory.

licenseOptional 
license: str
  • Type: str
  • 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 
licensed: bool
  • Type: bool
  • Default: true

Indicates if a license should be added.

loggingOptional 
logging: LoggerOptions
  • Type: projen.LoggerOptions
  • Default: {}

Configure logging options such as verbosity.

major_versionOptional 
major_version: typing.Union[int, float]
  • Type: typing.Union[int, float]
  • 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.

max_node_versionOptional 
max_node_version: str
  • Type: str
  • Default: no max

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

~~mergify~~Optional
  • Deprecated: use githubOptions.mergify instead
mergify: bool
  • Type: bool
  • Default: true

Whether mergify should be enabled on this repository or not.

~~mergify_options~~Optional
  • Deprecated: use githubOptions.mergifyOptions instead
mergify_options: MergifyOptions
  • Type: projen.github.MergifyOptions
  • Default: default options

Options for mergify.

min_major_versionOptional 
min_major_version: typing.Union[int, float]
  • Type: typing.Union[int, float]
  • 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.

min_node_versionOptional 
min_node_version: str
  • Type: str
  • Default: no "engines" specified

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

~~mutable_build~~Optional
  • Deprecated: - Use buildWorkflowOptions.mutableBuild
mutable_build: bool
  • Type: bool
  • 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.

npm_accessOptional 
npm_access: NpmAccess
  • Type: 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.

npm_dist_tagOptional 
npm_dist_tag: str
  • Type: str
  • 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
npmignore: typing.List[str]
  • Type: typing.List[str]

Additional entries to .npmignore.

npmignore_enabledOptional 
npmignore_enabled: bool
  • Type: bool
  • Default: true

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

npm_ignore_optionsOptional 
npm_ignore_options: IgnoreFileOptions
  • Type: projen.IgnoreFileOptions

Configuration options for .npmignore file.

npm_provenanceOptional 
npm_provenance: bool
  • Type: bool
  • 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.

~~npm_registry~~Optional
  • Deprecated: use npmRegistryUrl instead
npm_registry: str
  • Type: str

The host name of the npm registry to publish to.

Cannot be set together with npmRegistryUrl.

npm_registry_urlOptional 
npm_registry_url: str

The base URL of the npm package registry.

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

npm_token_secretOptional 
npm_token_secret: str
  • Type: str
  • Default: "NPM_TOKEN"

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

outdirOptional 
outdir: str
  • Type: str
  • 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 
package: bool
  • Type: bool
  • Default: true

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

package_managerOptional 
package_manager: NodePackageManager
  • Type: projen.javascript.NodePackageManager
  • Default: NodePackageManager.YARN_CLASSIC

The Node Package Manager used to execute scripts.

package_nameOptional 
package_name: str
  • Type: str
  • Default: defaults to project name

The "name" in package.json.

parentOptional 
parent: Project
  • Type: projen.Project

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

peer_dependency_optionsOptional 
peer_dependency_options: PeerDependencyOptions
  • Type: projen.javascript.PeerDependencyOptions

Options for peerDeps.

peer_depsOptional 
peer_deps: typing.List[str]
  • Type: typing.List[str]
  • 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.

pnpm_versionOptional 
pnpm_version: str
  • Type: str
  • Default: "7"

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

post_build_stepsOptional 
post_build_steps: typing.List[JobStep]
  • Type: typing.List[projen.github.workflows.JobStep]
  • Default: []

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

prereleaseOptional 
prerelease: str
  • Type: str
  • Default: normal semantic versions

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

prettierOptional 
prettier: bool
  • Type: bool
  • Default: false

Setup prettier.

prettier_optionsOptional 
prettier_options: PrettierOptions
  • Type: projen.javascript.PrettierOptions
  • Default: default options

Prettier options.

~~project_type~~Optional
  • Deprecated: no longer supported at the base project level
project_type: ProjectType
  • Type: projen.ProjectType
  • Default: ProjectType.UNKNOWN

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

projen_commandOptional 
projen_command: str
  • Type: str
  • Default: "npx projen"

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

Can be used to customize in special environments.

projen_credentialsOptional 
projen_credentials: GithubCredentials
  • Type: projen.github.GithubCredentials
  • Default: use a personal access token named PROJEN_GITHUB_TOKEN

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

projen_dev_dependencyOptional 
projen_dev_dependency: bool
  • Type: bool
  • Default: true if not a subproject

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

projenrc_jsOptional 
projenrc_js: bool
  • Type: bool
  • Default: true if projenrcJson is false

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

projenrc_jsonOptional 
projenrc_json: bool
  • Type: bool
  • Default: false

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

projenrc_json_optionsOptional 
projenrc_json_options: ProjenrcJsonOptions
  • Type: projen.ProjenrcJsonOptions
  • Default: default options

Options for .projenrc.json.

projenrc_js_optionsOptional 
projenrc_js_options: ProjenrcOptions
  • Type: projen.javascript.ProjenrcOptions
  • Default: default options

Options for .projenrc.js.

projenrc_tsOptional 
projenrc_ts: bool
  • Type: bool
  • Default: false

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

projenrc_ts_optionsOptional 
projenrc_ts_options: ProjenrcOptions
  • Type: projen.typescript.ProjenrcOptions

Options for .projenrc.ts.

~~projen_token_secret~~Optional
  • Deprecated: use projenCredentials
projen_token_secret: str
  • Type: str
  • 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.

projen_versionOptional 
projen_version: str
  • Type: str
  • Default: Defaults to the latest version.

Version of projen to install.

publish_dry_runOptional 
publish_dry_run: bool
  • Type: bool
  • Default: false

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

publish_tasksOptional 
publish_tasks: bool
  • Type: bool
  • 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.

pull_request_templateOptional 
pull_request_template: bool
  • Type: bool
  • Default: true

Include a GitHub pull request template.

pull_request_template_contentsOptional 
pull_request_template_contents: typing.List[str]
  • Type: typing.List[str]
  • Default: default content

The contents of the pull request template.

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

The README setup.

releasable_commitsOptional 
releasable_commits: ReleasableCommits
  • Type: projen.ReleasableCommits
  • Default: ReleasableCommits.everyCommit()

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

releaseOptional 
release: bool
  • Type: bool
  • Default: true (false for subprojects)

Add release management to this project.

release_branchesOptional 
release_branches: typing.Mapping[BranchOptions]
  • Type: typing.Mapping[projen.release.BranchOptions]
  • 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.

~~release_every_commit~~Optional
  • Deprecated: Use releaseTrigger: ReleaseTrigger.continuous() instead
release_every_commit: bool
  • Type: bool
  • Default: true

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

release_failure_issueOptional 
release_failure_issue: bool
  • Type: bool
  • Default: false

Create a github issue on every failed publishing task.

release_failure_issue_labelOptional 
release_failure_issue_label: str
  • Type: str
  • Default: "failed-release"

The label to apply to issues indicating publish failures.

Only applies if releaseFailureIssue is true.

~~release_schedule~~Optional
  • Deprecated: Use releaseTrigger: ReleaseTrigger.scheduled() instead
release_schedule: str
  • Type: str
  • Default: no scheduled releases

CRON schedule to trigger new releases.

release_tag_prefixOptional 
release_tag_prefix: str
  • Type: str
  • 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.

release_to_npmOptional 
release_to_npm: bool
  • Type: bool
  • Default: false

Automatically release to npm when new versions are introduced.

release_triggerOptional 
release_trigger: ReleaseTrigger
  • Type: projen.release.ReleaseTrigger
  • Default: Continuous releases (ReleaseTrigger.continuous())

The release trigger to use.

~~release_workflow~~Optional
  • Deprecated: see release.
release_workflow: bool
  • Type: bool
  • Default: true if not a subproject

DEPRECATED: renamed to release.

release_workflow_nameOptional 
release_workflow_name: str
  • Type: str
  • Default: "release"

The name of the default release workflow.

release_workflow_setup_stepsOptional 
release_workflow_setup_steps: typing.List[JobStep]
  • Type: typing.List[projen.github.workflows.JobStep]

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

renovatebotOptional 
renovatebot: bool
  • Type: bool
  • Default: false

Use renovatebot to handle dependency upgrades.

renovatebot_optionsOptional 
renovatebot_options: RenovatebotOptions
  • Type: projen.RenovatebotOptions
  • Default: default options

Options for renovatebot.

repositoryOptional 
repository: str
  • Type: str

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

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

repository_directoryOptional 
repository_directory: str
  • Type: str

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 
rewire: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
  • 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;
}
scoped_packages_optionsOptional 
scoped_packages_options: typing.List[ScopedPackagesOptions]
  • Type: typing.List[projen.javascript.ScopedPackagesOptions]
  • 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()
scripts: typing.Mapping[str]
  • Type: typing.Mapping[str]
  • 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 
srcdir: str
  • Type: str
  • Default: "src"

Typescript sources directory.

stabilityOptional 
stability: str
  • Type: str

Package's Stability.

staleOptional 
stale: bool
  • Type: bool
  • Default: false

Auto-close of stale issues and pull request.

See staleOptions for options.

stale_optionsOptional 
stale_options: StaleOptions
  • Type: projen.github.StaleOptions
  • Default: see defaults in StaleOptions

Auto-close stale issues and pull requests.

To disable set stale to false.

testdirOptional 
testdir: str
  • Type: str
  • 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 
tsconfig: TypescriptConfigOptions
  • Type: projen.javascript.TypescriptConfigOptions
  • Default: default options

Custom TSConfig.

tsconfig_devOptional 
tsconfig_dev: TypescriptConfigOptions
  • Type: projen.javascript.TypescriptConfigOptions
  • Default: use the production tsconfig options

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

tsconfig_dev_fileOptional 
tsconfig_dev_file: str
  • Type: str
  • Default: "tsconfig.dev.json"

The name of the development tsconfig.json file.

ts_jest_optionsOptional 
ts_jest_options: TsJestOptions
  • Type: projen.typescript.TsJestOptions

Options for ts-jest.

typescript_versionOptional 
typescript_version: str
  • Type: str
  • 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).

versionrc_optionsOptional 
versionrc_options: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
  • 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 
vscode: bool
  • Type: bool
  • Default: true

Enable VSCode integration.

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

workflow_bootstrap_stepsOptional 
workflow_bootstrap_steps: typing.List[JobStep]
  • Type: typing.List[projen.github.workflows.JobStep]
  • Default: "yarn install --frozen-lockfile && yarn projen"

Workflow steps to use in order to bootstrap this repo.

workflow_container_imageOptional 
workflow_container_image: str
  • Type: str
  • Default: default image

Container image to use for GitHub workflows.

workflow_git_identityOptional 
workflow_git_identity: GitIdentity
  • Type: projen.github.GitIdentity
  • Default: GitHub Actions

The git identity to use in workflows.

workflow_node_versionOptional 
workflow_node_version: str
  • Type: str
  • Default: same as minNodeVersion

The node version to use in GitHub workflows.

workflow_package_cacheOptional 
workflow_package_cache: bool
  • Type: bool
  • Default: false

Enable Node.js package cache in GitHub workflows.

workflow_runs_onOptional 
workflow_runs_on: typing.List[str]
  • Type: typing.List[str]
  • Default: ["ubuntu-latest"]

Github Runner selection labels.

workflow_runs_on_groupOptional 
workflow_runs_on_group: GroupRunnerOptions
  • Type: projen.GroupRunnerOptions

Github Runner Group selection options.

yarn_berry_optionsOptional 
yarn_berry_options: YarnBerryOptions
  • Type: projen.javascript.YarnBerryOptions
  • Default: Yarn Berry v4 with all default options

Options for Yarn Berry.

Last update: 2025-07-17