Readonly appReadonly artifactsThe 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.
Readonly artifactsThe location of the npm tarball after build (${artifactsDirectory}/js).
Optional Readonly autoAuto approve set up for this project.
Optional Readonly autoComponent that sets up mergify for merging approved pull requests.
Optional Readonly buildThe PR build GitHub workflow. undefined if buildWorkflow is disabled.
Readonly bundlerReadonly cdkcdk.json configuration.
Readonly cdkReadonly cdkCommon CDK tasks.
Readonly commitWhether to commit the managed files by default.
Optional Readonly defaultThis is the "default" task, the one that executes "projen". Undefined if the project is being ejected.
Readonly depsProject dependencies.
Readonly devAccess for .devcontainer.json (used for GitHub Codespaces)
This will be undefined if devContainer boolean is false
Optional Readonly docgenReadonly docsOptional Readonly eslintReadonly gitattributesThe .gitattributes file for this repository.
Readonly githubAccess all github components.
This will be undefined for subprojects.
Readonly gitignore.gitignore
Readonly gitpodAccess for Gitpod
This will be undefined if gitpod boolean is false
Optional Readonly initThe 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.
Optional Readonly jestThe Jest configuration (if enabled)
Readonly libdirThe directory in which compiled .js files reside.
Readonly loggerLogging utilities.
Readonly nameProject name.
Protected Optional Readonly nodeOptional Readonly npmignoreThe .npmignore file.
Readonly outdirAbsolute output directory of this project.
Readonly packageAPI for managing the node package.
Optional Readonly parentA parent project. If undefined, this is the root project.
Optional Readonly prettierReadonly projectManages the build process of the project.
Readonly projectReadonly projenThe command to use in order to run the projen CLI.
Optional Readonly publisherPackage publisher. This will be undefined if the project does not have a
release workflow.
use release.publisher.
Optional Readonly releaseRelease management.
Readonly rootThe root project.
Readonly runThe command to use to run scripts (e.g. yarn run or npm run depends on the package manager).
Readonly srcdirThe directory in which the .ts sources reside.
Readonly tasksProject tasks.
Readonly testdirThe directory in which tests reside.
Optional Readonly tsconfigReadonly tsconfigA typescript configuration file which covers all files (sources, tests, projen).
Optional Readonly tsconfigOptional Readonly upgradeThe upgrade workflow.
Readonly vscodeAccess all VSCode components.
This will be undefined for subprojects.
Readonly watchThe "watch" task.
Protected Readonly workflowStatic Readonly DEFAULT_The name of the default task (the task executed when projen is run without arguments). Normally
this task should synthesize the project files.
use package.allowLibraryDependencies
The job ID of the build workflow.
The CDK version this app is using.
Returns all the components within this project.
Whether or not the project is being ejected.
use package.entrypoint
All files in this project.
use package.addField(x, y)
Maximum node version required by this package.
Minimum node.js version required by this package.
The package manager to use.
use package.packageManager
Defines bundled dependencies.
Bundled dependencies will be added as normal dependencies as well as to the
bundledDependencies section of your package.json.
Rest ...deps: string[]Names modules to install. By default, the the dependency will
be installed in the next npx projen run and the version will be recorded
in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax:
module@^7.
Defines normal dependencies.
Rest ...deps: string[]Names modules to install. By default, the the dependency will
be installed in the next npx projen run and the version will be recorded
in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax:
module@^7.
Defines development/test dependencies.
Rest ...deps: string[]Names modules to install. By default, the the dependency will
be installed in the next npx projen run and the version will be recorded
in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax:
module@^7.
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.
Rest ...deps: string[]Names modules to install. By default, the the dependency will
be installed in the next npx projen run and the version will be recorded
in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax:
module@^7.
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
the glob pattern to match (could be a file path).
Finds a file at the specified relative path within this project and all its subprojects.
a FileBase or undefined if there is no file in that path
The file path. If this path is relative, it will be resolved from the root of this project.
Finds a file at the specified relative path within this project and removes it.
a FileBase if the file was found and removed, or undefined if
the file was not found.
The file path. If this path is relative, it will be resolved from the root of this project.
Generated using TypeDoc
The CDK app entrypoint