Optional ReadonlyallowAllow the project to include peerDependencies and bundledDependencies.
This is normally only allowed for libraries. For apps, there's no meaning
for specifying these.
Optional ReadonlyartifactsA directory which will contain build artifacts.
Optional ReadonlyauthorAuthor's e-mail.
Optional ReadonlyauthorAuthor's name.
Optional ReadonlyauthorIs the author an organization.
Optional ReadonlyauthorAuthor's URL / Website.
Optional ReadonlyautoEnable and configure the 'auto approve' workflow.
Optional ReadonlyautoAutomatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
Throw if set to true but autoApproveOptions are not defined.
Optional ReadonlyautoAutomatically add all executables under the bin directory to your package.json file under the bin section.
Optional ReadonlyautoEnable automatic merging on GitHub.
Has no effect if github.mergify
is set to false.
Optional ReadonlyautoConfigure options for automatic merging on GitHub.
Has no effect if
github.mergify or autoMerge is set to false.
Optional ReadonlybinBinary 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.
Optional ReadonlybugsThe email address to which issues should be reported.
Optional ReadonlybugsThe url to your project's issue tracker.
Optional ReadonlybuildDefine a GitHub workflow for building PRs.
Optional ReadonlybuildOptions for PR build workflow.
Optional ReadonlybundledList 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.
Optional ReadonlybundlerOptions for Bundler.
Optional ReadonlycheckConfigure 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.
Optional ReadonlyclobberAdd a clobber task which resets the repo to origin.
Optional ReadonlycodeOptions for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact
Optional ReadonlycodeDefine 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.
Optional ReadonlycodeDefine the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
Optional ReadonlycommitWhether to commit the managed files by default.
Optional ReadonlycopyrightLicense copyright owner.
Optional ReadonlycopyrightThe copyright years to put in the LICENSE file.
Optional ReadonlydefaultThe name of the main release branch.
Optional ReadonlydependabotUse dependabot to handle dependency upgrades.
Cannot be used in conjunction with depsUpgrade.
Optional ReadonlydependabotOptions for dependabot.
Optional ReadonlydepsRuntime 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.
Optional ReadonlydepsUse tasks and github workflows to handle dependency upgrades.
Cannot be used in conjunction with dependabot.
Optional ReadonlydepsOptions for UpgradeDependencies.
Optional ReadonlydescriptionThe 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
Optional ReadonlydevAdd a VSCode development environment (used for GitHub Codespaces).
Optional ReadonlydevBuild 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.
Optional ReadonlydisableDo not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
Optional ReadonlydisableDo not generate a tsconfig.dev.json file.
Optional ReadonlydocgenDocgen by Typedoc.
Optional ReadonlydocsDocs directory.
Optional ReadonlyentrypointModule entrypoint (main in package.json).
Set to an empty string to not include main in your package.json
Optional ReadonlyentrypointThe .d.ts file that includes the type declarations for this module.
Optional ReadonlyeslintSetup eslint.
Optional ReadonlyeslintEslint options.
Optional ReadonlygitConfiguration options for .gitignore file.
Optional ReadonlygitConfiguration options for git.
Optional ReadonlygithubEnable GitHub integration. Enabled by default for root projects. Disabled for non-root projects.
Optional ReadonlygithubOptions for GitHub integration.
Optional ReadonlygitignoreAdditional entries to .gitignore.
Optional ReadonlygitpodAdd a Gitpod development environment.
Optional ReadonlyhomepagePackage's Homepage / Website.
Optional ReadonlyjestSetup jest unit tests.
Optional ReadonlyjestJest options.
Optional ReadonlyjsiiVersion requirement of publib which is used to publish modules to npm.
Optional ReadonlykeywordsKeywords to include in package.json.
Optional ReadonlylibdirTypescript artifacts output directory.
Optional ReadonlylicenseLicense'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.
Optional ReadonlylicensedIndicates if a license should be added.
Optional ReadonlyloggingConfigure logging options such as verbosity.
Optional ReadonlymajorMajor 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.
Optional ReadonlymaxMinimum node.js version to require via engines (inclusive).
Optional ReadonlyminMinimal 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.
Optional ReadonlyminMinimum Node.js version to require via package.json engines (inclusive).
ReadonlynameThis is the name of your project.
Optional ReadonlynpmAccess level of the npm package.
Optional ReadonlynpmThe 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.
Optional ReadonlynpmConfiguration options for .npmignore file.
Optional ReadonlynpmShould 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.
Optional ReadonlynpmThe base URL of the npm package registry. Must be a URL (e.g. start with "https://" or "http://")
Optional ReadonlynpmGitHub secret which contains the NPM token to use when publishing packages.
Optional ReadonlynpmignoreDefines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
Optional ReadonlyoutdirThe 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.
Optional ReadonlypackageDefines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
Optional ReadonlypackageThe Node Package Manager used to execute scripts.
Optional ReadonlypackageThe "name" in package.json.
Optional ReadonlyparentThe parent project, if this project is part of a bigger project.
Optional ReadonlypeerOptions for peerDeps.
Optional ReadonlypeerPeer 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.
Optional ReadonlypnpmThe version of PNPM to use if using PNPM as a package manager.
Optional ReadonlypostSteps to execute after build as part of the release workflow.
Optional ReadonlyprereleaseBump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
Optional ReadonlyprettierSetup prettier.
Optional ReadonlyprettierPrettier options.
Optional ReadonlyprojenThe shell command to use in order to run the projen CLI. Can be used to customize in special environments.
Optional ReadonlyprojenChoose a method of providing GitHub API access for projen workflows.
Optional ReadonlyprojenIndicates of "projen" should be installed as a devDependency.
Optional ReadonlyprojenVersion of projen to install.
Optional ReadonlyprojenrcGenerate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
Optional ReadonlyprojenrcOptions for .projenrc.js.
Optional ReadonlyprojenrcGenerate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
Optional ReadonlyprojenrcOptions for .projenrc.json.
Optional ReadonlyprojenrcUse TypeScript for your projenrc file (.projenrc.ts).
Optional ReadonlyprojenrcOptions for .projenrc.ts.
Optional ReadonlypublishInstead of actually publishing to package managers, just print the publishing command.
Optional ReadonlypublishDefine 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.
Optional ReadonlypullInclude a GitHub pull request template.
Optional ReadonlypullThe contents of the pull request template.
Optional ReadonlyreadmeThe README setup.
Optional ReadonlyreleasableFind commits that should be considered releasable Used to decide if a release is required.
Optional ReadonlyreleaseAdd release management to this project.
Optional ReadonlyreleaseDefines 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.
Optional ReadonlyreleaseCreate a github issue on every failed publishing task.
Optional ReadonlyreleaseThe label to apply to issues indicating publish failures.
Only applies if releaseFailureIssue is true.
Optional ReadonlyreleaseAutomatically 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.
Optional ReadonlyreleaseAutomatically release to npm when new versions are introduced.
Optional ReadonlyreleaseThe release trigger to use.
Optional ReadonlyreleaseThe name of the default release workflow.
Optional ReadonlyreleaseA set of workflow steps to execute in order to setup the workflow container.
Optional ReadonlyrenovatebotUse renovatebot to handle dependency upgrades.
Optional ReadonlyrenovatebotOptions for renovatebot.
Optional ReadonlyrepositoryThe repository is the location where the actual code for your package lives. See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
Optional ReadonlyrepositoryIf 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.
Optional ReadonlysampleGenerate one-time sample in src/ and test/ if there are no files there.
Optional ReadonlyscopedOptions for privately hosted scoped packages.
Optional ReadonlysrcdirTypescript sources directory.
Optional ReadonlystabilityPackage's Stability.
Optional ReadonlystaleAuto-close of stale issues and pull request.
See staleOptions for options.
Optional ReadonlystaleAuto-close stale issues and pull requests.
To disable set stale to false.
Optional ReadonlytestdirJest 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.
Optional ReadonlytsOptions for ts-jest.
Optional ReadonlytsconfigCustom TSConfig.
Optional ReadonlytsconfigTypescriptConfigExtends to use as base.
Optional ReadonlytsconfigCustom tsconfig options for the development tsconfig.json file (used for testing).
Optional ReadonlytsconfigThe name of the development tsconfig.json file.
Optional ReadonlytypescriptTypeScript 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).
Optional ReadonlyunbuildUse unbuild for bundling/transpiling.
Optional ReadonlyversionrcCustom configuration used when creating changelog with standard-version package. Given values either append to default configuration or overwrite values in it.
Optional ReadonlyvscodeEnable VSCode integration. Enabled by default for root projects. Disabled for non-root projects.
Optional ReadonlyworkflowWorkflow steps to use in order to bootstrap this repo.
Optional ReadonlyworkflowContainer image to use for GitHub workflows.
Optional ReadonlyworkflowThe git identity to use in workflows.
Optional ReadonlyworkflowThe node version to use in GitHub workflows.
Optional ReadonlyworkflowEnable Node.js package cache in GitHub workflows.
Optional ReadonlyworkflowGithub Runner selection labels.
Optional ReadonlyworkflowGithub Runner Group selection options.
Optional ReadonlyworkspaceDependencies linked by the workspace protocol.
Optional ReadonlyyarnOptions for Yarn Berry.
TypeScriptProjectOptions