Uses of Package
io.github.cdklabs.projen

Packages that use io.github.cdklabs.projen

Package	Description
io.github.cdklabs.projen
io.github.cdklabs.projen.awscdk
io.github.cdklabs.projen.build
io.github.cdklabs.projen.cdk
io.github.cdklabs.projen.cdk8s
io.github.cdklabs.projen.cdktf
io.github.cdklabs.projen.circleci
io.github.cdklabs.projen.github
io.github.cdklabs.projen.github.workflows
io.github.cdklabs.projen.gitlab
io.github.cdklabs.projen.java
io.github.cdklabs.projen.javascript
io.github.cdklabs.projen.python
io.github.cdklabs.projen.release
io.github.cdklabs.projen.typescript
io.github.cdklabs.projen.vscode
io.github.cdklabs.projen.web

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen

Class	Description
Component	(experimental) Represents a project component.
CreateProjectOptions
CreateProjectOptions.Builder	A builder for CreateProjectOptions
Dependencies	(experimental) The Dependencies component is responsible to track the list of dependencies a project has, and then used by project types as the model for rendering project-specific dependency manifests such as the dependencies section package.json files.
Dependency	(experimental) Represents a project dependency.
Dependency.Builder	A builder for Dependency
DependencyCoordinates	(experimental) Coordinates of the dependency (name and version).
DependencyCoordinates.Builder	A builder for DependencyCoordinates
DependencyType	(experimental) Type of dependency.
DepsManifest
DepsManifest.Builder	A builder for DepsManifest
DevEnvironmentDockerImage	(experimental) Options for specifying the Docker image of the container.
DevEnvironmentOptions	(experimental) Base options for configuring a container-based development environment.
DevEnvironmentOptions.Builder	A builder for DevEnvironmentOptions
DockerCompose	(experimental) Create a docker-compose YAML file.
DockerCompose.Builder	(experimental) A fluent builder for DockerCompose.
DockerComposeBuild	(experimental) Build arguments for creating a docker image.
DockerComposeBuild.Builder	A builder for DockerComposeBuild
DockerComposeNetworkConfig	(experimental) Network configuration.
DockerComposeNetworkConfig.Builder	A builder for DockerComposeNetworkConfig
DockerComposeNetworkIpamConfig	(experimental) IPAM configuration.
DockerComposeNetworkIpamConfig.Builder	A builder for DockerComposeNetworkIpamConfig
DockerComposeNetworkIpamSubnetConfig	(experimental) IPAM subnet configuration.
DockerComposeNetworkIpamSubnetConfig.Builder	A builder for DockerComposeNetworkIpamSubnetConfig
DockerComposePortMappingOptions	(experimental) Options for port mappings.
DockerComposePortMappingOptions.Builder	A builder for DockerComposePortMappingOptions
DockerComposeProps	(experimental) Props for DockerCompose.
DockerComposeProps.Builder	A builder for DockerComposeProps
DockerComposeProtocol	(experimental) Network protocol for port mapping.
DockerComposeService	(experimental) A docker-compose service.
DockerComposeService.Builder	(experimental) A fluent builder for DockerComposeService.
DockerComposeServiceDescription	(experimental) Description of a docker-compose.yml service.
DockerComposeServiceDescription.Builder	A builder for DockerComposeServiceDescription
DockerComposeServicePort	(experimental) A service port mapping.
DockerComposeServicePort.Builder	A builder for DockerComposeServicePort
DockerComposeVolumeConfig	(experimental) Volume configuration.
DockerComposeVolumeConfig.Builder	A builder for DockerComposeVolumeConfig
DockerComposeVolumeMount	(experimental) Service volume mounting information.
DockerComposeVolumeMount.Builder	A builder for DockerComposeVolumeMount
FileBase
FileBaseOptions
FileBaseOptions.Builder	A builder for FileBaseOptions
GitAttributesFile	(experimental) Assign attributes to file names in a git repository.
GitOptions	(experimental) Git configuration options.
GitOptions.Builder	A builder for GitOptions
Gitpod	(experimental) The Gitpod component which emits .gitpod.yml.
Gitpod.Builder	(experimental) A fluent builder for Gitpod.
GitpodOnOpen	(experimental) What to do when a service on a port is detected.
GitpodOpenIn	(experimental) Configure where in the IDE the terminal should be opened.
GitpodOpenMode	(experimental) Configure how the terminal should be opened relative to the previous task.
GitpodOptions	(experimental) Constructor options for the Gitpod component.
GitpodOptions.Builder	A builder for GitpodOptions
GitpodPort	(experimental) Options for an exposed port on Gitpod.
GitpodPort.Builder	A builder for GitpodPort
GitpodPortVisibility	(experimental) Whether the port visibility should be private or public.
GitpodPrebuilds	(experimental) Configure the Gitpod App for prebuilds.
GitpodPrebuilds.Builder	A builder for GitpodPrebuilds
GitpodTask	(experimental) Configure options for a task to be run when opening a Gitpod workspace (e.g.
GitpodTask.Builder	A builder for GitpodTask
GroupRunnerOptions
GroupRunnerOptions.Builder	A builder for GroupRunnerOptions
IDevEnvironment	(experimental) Abstract interface for container-based development environments, such as Gitpod and GitHub Codespaces.
IDevEnvironment.Jsii$Default	Internal default implementation for IDevEnvironment.
IDockerComposeNetworkBinding	(experimental) Network binding information.
IDockerComposeNetworkBinding.Jsii$Default	Internal default implementation for IDockerComposeNetworkBinding.
IDockerComposeNetworkConfig	(experimental) Storage for network configuration.
IDockerComposeNetworkConfig.Jsii$Default	Internal default implementation for IDockerComposeNetworkConfig.
IDockerComposeServiceName	(experimental) An interface providing the name of a docker compose service.
IDockerComposeServiceName.Jsii$Default	Internal default implementation for IDockerComposeServiceName.
IDockerComposeVolumeBinding	(experimental) Volume binding information.
IDockerComposeVolumeBinding.Jsii$Default	Internal default implementation for IDockerComposeVolumeBinding.
IDockerComposeVolumeConfig	(experimental) Storage for volume configuration.
IDockerComposeVolumeConfig.Jsii$Default	Internal default implementation for IDockerComposeVolumeConfig.
IgnoreFile
IgnoreFile.Builder	(experimental) A fluent builder for IgnoreFile.
IgnoreFileOptions
IgnoreFileOptions.Builder	A builder for IgnoreFileOptions
IniFile	(experimental) Represents an INI file.
IniFile.Builder	(experimental) A fluent builder for IniFile.
IniFileOptions	(experimental) Options for IniFile.
IniFileOptions.Builder	A builder for IniFileOptions
InitProject	(experimental) Information passed from projen new to the project object when the project is first created.
InitProject.Builder	A builder for InitProject
InitProjectOptionHints	(experimental) Choices for how to display commented out options in projenrc files.
IResolvable
IResolvable.Jsii$Default	Internal default implementation for IResolvable.
IResolver	(experimental) API for resolving tokens when synthesizing file content.
IResolver.Jsii$Default	Internal default implementation for IResolver.
JsonFile	(experimental) Represents a JSON file.
JsonFile.Builder	(experimental) A fluent builder for JsonFile.
JsonFileOptions	(experimental) Options for JsonFile.
JsonFileOptions.Builder	A builder for JsonFileOptions
JsonPatch	(experimental) Utility for applying RFC-6902 JSON-Patch to a document.
License
License.Builder	(experimental) A fluent builder for License.
LicenseOptions
LicenseOptions.Builder	A builder for LicenseOptions
Logger	(experimental) Project-level logging utilities.
Logger.Builder	(experimental) A fluent builder for Logger.
LoggerOptions	(experimental) Options for logging utilities.
LoggerOptions.Builder	A builder for LoggerOptions
LogLevel	(experimental) Logging verbosity.
Makefile	(experimental) Minimal Makefile.
Makefile.Builder	(experimental) A fluent builder for Makefile.
MakefileOptions	(experimental) Options for Makefiles.
MakefileOptions.Builder	A builder for MakefileOptions
ObjectFile	(experimental) Represents an Object file.
ObjectFileOptions	(experimental) Options for ObjectFile.
ObjectFileOptions.Builder	A builder for ObjectFileOptions
Project	(experimental) Base project.
Project.Builder	(experimental) A fluent builder for Project.
ProjectBuild	(experimental) Manages a standard build process for all projects.
ProjectOptions	(experimental) Options for Project.
ProjectOptions.Builder	A builder for ProjectOptions
ProjectType	Deprecated. no longer supported at the base project level
Projenrc	Deprecated. use ProjenrcJson
Projenrc.Builder	Deprecated. (experimental) A fluent builder for Projenrc.
ProjenrcFile	(experimental) A component representing the projen runtime configuration.
ProjenrcJson	(experimental) Sets up a project to use JSON for projenrc.
ProjenrcJson.Builder	(experimental) A fluent builder for ProjenrcJson.
ProjenrcJsonOptions
ProjenrcJsonOptions.Builder	A builder for ProjenrcJsonOptions
ProjenrcOptions	Deprecated. use ProjenrcJsonOptions
ProjenrcOptions.Builder	Deprecated.
ReleasableCommits	(experimental) Find commits that should be considered releasable to decide if a release is required.
Renovatebot	(experimental) Defines renovatebot configuration for projen project.
Renovatebot.Builder	(experimental) A fluent builder for Renovatebot.
RenovatebotOptions	(experimental) Options for Renovatebot.
RenovatebotOptions.Builder	A builder for RenovatebotOptions
RenovatebotScheduleInterval	(experimental) How often to check for new versions and raise pull requests for version updates.
ResolveOptions	(experimental) Resolve options.
ResolveOptions.Builder	A builder for ResolveOptions
Rule	(experimental) A Make rule.
Rule.Builder	A builder for Rule
SampleDir	(experimental) Renders the given files into the directory if the directory does not exist.
SampleDir.Builder	(experimental) A fluent builder for SampleDir.
SampleDirOptions	(experimental) SampleDir options.
SampleDirOptions.Builder	A builder for SampleDirOptions
SampleFile	(experimental) Produces a file with the given contents but only once, if the file doesn't already exist.
SampleFile.Builder	(experimental) A fluent builder for SampleFile.
SampleFileOptions	(experimental) Options for the SampleFile object.
SampleFileOptions.Builder	A builder for SampleFileOptions
SampleReadme	(experimental) Represents a README.md sample file.
SampleReadme.Builder	(experimental) A fluent builder for SampleReadme.
SampleReadmeProps	(experimental) SampleReadme Properties.
SampleReadmeProps.Builder	A builder for SampleReadmeProps
Semver	Deprecated. This class will be removed in upcoming releases.
SnapshotOptions	(experimental) Options for the Snapshot synthesis.
SnapshotOptions.Builder	A builder for SnapshotOptions
SourceCode	(experimental) Represents a source file.
SourceCode.Builder	(experimental) A fluent builder for SourceCode.
SourceCodeOptions	(experimental) Options for SourceCodeFile.
SourceCodeOptions.Builder	A builder for SourceCodeOptions
Task	(experimental) A task that can be performed on the project.
Task.Builder	(experimental) A fluent builder for Task.
TaskCommonOptions
TaskCommonOptions.Builder	A builder for TaskCommonOptions
TaskOptions
TaskOptions.Builder	A builder for TaskOptions
Tasks	(experimental) Defines project tasks.
TasksManifest	(experimental) Schema for tasks.json.
TasksManifest.Builder	A builder for TasksManifest
TaskSpec	(experimental) Specification of a single task.
TaskSpec.Builder	A builder for TaskSpec
TaskStep	(experimental) A single step within a task.
TaskStep.Builder	A builder for TaskStep
TaskStepOptions	(experimental) Options for task steps.
TaskStepOptions.Builder	A builder for TaskStepOptions
TestFailureBehavior
TextFile	(experimental) A text file.
TextFile.Builder	(experimental) A fluent builder for TextFile.
TextFileOptions	(experimental) Options for TextFile.
TextFileOptions.Builder	A builder for TextFileOptions
TomlFile	(experimental) Represents a TOML file.
TomlFile.Builder	(experimental) A fluent builder for TomlFile.
TomlFileOptions	(experimental) Options for TomlFile.
TomlFileOptions.Builder	A builder for TomlFileOptions
Version
Version.Builder	(experimental) A fluent builder for Version.
VersionOptions	(experimental) Options for Version.
VersionOptions.Builder	A builder for VersionOptions
XmlFile	(experimental) Represents an XML file.
XmlFile.Builder	(experimental) A fluent builder for XmlFile.
XmlFileOptions	(experimental) Options for XmlFile.
XmlFileOptions.Builder	A builder for XmlFileOptions
YamlFile	(experimental) Represents a YAML file.
YamlFile.Builder	(experimental) A fluent builder for YamlFile.
YamlFileOptions	(experimental) Options for JsonFile.
YamlFileOptions.Builder	A builder for YamlFileOptions

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.awscdk

Class	Description
Component	(experimental) Represents a project component.
DependencyType	(experimental) Type of dependency.
GitOptions	(experimental) Git configuration options.
GroupRunnerOptions
IgnoreFileOptions
JsonFile	(experimental) Represents a JSON file.
LoggerOptions	(experimental) Options for logging utilities.
Project	(experimental) Base project.
ProjectOptions	(experimental) Options for Project.
ProjectType	Deprecated. no longer supported at the base project level
ProjenrcJsonOptions
ReleasableCommits	(experimental) Find commits that should be considered releasable to decide if a release is required.
RenovatebotOptions	(experimental) Options for Renovatebot.
SampleReadmeProps	(experimental) SampleReadme Properties.
Task	(experimental) A task that can be performed on the project.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.build

Class	Description
Component	(experimental) Represents a project component.
GroupRunnerOptions
Project	(experimental) Base project.
Task	(experimental) A task that can be performed on the project.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.cdk

Class	Description
Component	(experimental) Represents a project component.
GitOptions	(experimental) Git configuration options.
GroupRunnerOptions
IgnoreFileOptions
LoggerOptions	(experimental) Options for logging utilities.
Project	(experimental) Base project.
ProjectOptions	(experimental) Options for Project.
ProjectType	Deprecated. no longer supported at the base project level
ProjenrcJsonOptions
ReleasableCommits	(experimental) Find commits that should be considered releasable to decide if a release is required.
RenovatebotOptions	(experimental) Options for Renovatebot.
SampleReadmeProps	(experimental) SampleReadme Properties.
Task	(experimental) A task that can be performed on the project.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.cdk8s

Class	Description
Component	(experimental) Represents a project component.
DependencyType	(experimental) Type of dependency.
GitOptions	(experimental) Git configuration options.
GroupRunnerOptions
IgnoreFileOptions
LoggerOptions	(experimental) Options for logging utilities.
Project	(experimental) Base project.
ProjectOptions	(experimental) Options for Project.
ProjectType	Deprecated. no longer supported at the base project level
ProjenrcJsonOptions
ReleasableCommits	(experimental) Find commits that should be considered releasable to decide if a release is required.
RenovatebotOptions	(experimental) Options for Renovatebot.
SampleReadmeProps	(experimental) SampleReadme Properties.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.cdktf

Class	Description
GitOptions	(experimental) Git configuration options.
GroupRunnerOptions
IgnoreFileOptions
LoggerOptions	(experimental) Options for logging utilities.
Project	(experimental) Base project.
ProjectOptions	(experimental) Options for Project.
ProjectType	Deprecated. no longer supported at the base project level
ProjenrcJsonOptions
ReleasableCommits	(experimental) Find commits that should be considered releasable to decide if a release is required.
RenovatebotOptions	(experimental) Options for Renovatebot.
SampleReadmeProps	(experimental) SampleReadme Properties.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.circleci

Class	Description
Component	(experimental) Represents a project component.
Project	(experimental) Base project.
YamlFile	(experimental) Represents a YAML file.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.github

Class	Description
Component	(experimental) Represents a project component.
FileBase
GitOptions	(experimental) Git configuration options.
Gitpod	(experimental) The Gitpod component which emits .gitpod.yml.
GroupRunnerOptions
IgnoreFileOptions
LoggerOptions	(experimental) Options for logging utilities.
Project	(experimental) Base project.
ProjectOptions	(experimental) Options for Project.
ProjectType	Deprecated. no longer supported at the base project level
ProjenrcJsonOptions
RenovatebotOptions	(experimental) Options for Renovatebot.
SampleReadmeProps	(experimental) SampleReadme Properties.
Task	(experimental) A task that can be performed on the project.
TextFile	(experimental) A text file.
YamlFile	(experimental) Represents a YAML file.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.github.workflows

Class	Description
GroupRunnerOptions

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.gitlab

Class	Description
Component	(experimental) Represents a project component.
Project	(experimental) Base project.
YamlFile	(experimental) Represents a YAML file.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.java

Class	Description
Component	(experimental) Represents a project component.
Dependency	(experimental) Represents a project dependency.
GitOptions	(experimental) Git configuration options.
IgnoreFileOptions
LoggerOptions	(experimental) Options for logging utilities.
Project	(experimental) Base project.
ProjectOptions	(experimental) Options for Project.
ProjectType	Deprecated. no longer supported at the base project level
ProjenrcFile	(experimental) A component representing the projen runtime configuration.
ProjenrcJsonOptions
RenovatebotOptions	(experimental) Options for Renovatebot.
SampleReadmeProps	(experimental) SampleReadme Properties.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.javascript

Class	Description
Component	(experimental) Represents a project component.
DependencyType	(experimental) Type of dependency.
GitOptions	(experimental) Git configuration options.
GroupRunnerOptions
IgnoreFile
IgnoreFileOptions
JsonFile	(experimental) Represents a JSON file.
LoggerOptions	(experimental) Options for logging utilities.
Project	(experimental) Base project.
ProjectOptions	(experimental) Options for Project.
ProjectType	Deprecated. no longer supported at the base project level
ProjenrcFile	(experimental) A component representing the projen runtime configuration.
ProjenrcJsonOptions
ReleasableCommits	(experimental) Find commits that should be considered releasable to decide if a release is required.
RenovatebotOptions	(experimental) Options for Renovatebot.
SampleReadmeProps	(experimental) SampleReadme Properties.
Task	(experimental) A task that can be performed on the project.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.python

Class	Description
Component	(experimental) Represents a project component.
Dependency	(experimental) Represents a project dependency.
FileBase
GitOptions	(experimental) Git configuration options.
IgnoreFileOptions
IResolver	(experimental) API for resolving tokens when synthesizing file content.
LoggerOptions	(experimental) Options for logging utilities.
Project	(experimental) Base project.
ProjectOptions	(experimental) Options for Project.
ProjectType	Deprecated. no longer supported at the base project level
ProjenrcFile	(experimental) A component representing the projen runtime configuration.
ProjenrcJsonOptions
RenovatebotOptions	(experimental) Options for Renovatebot.
SampleReadmeProps	(experimental) SampleReadme Properties.
Task	(experimental) A task that can be performed on the project.
TomlFile	(experimental) Represents a TOML file.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.release

Class	Description
Component	(experimental) Represents a project component.
GroupRunnerOptions
Project	(experimental) Base project.
ReleasableCommits	(experimental) Find commits that should be considered releasable to decide if a release is required.
Task	(experimental) A task that can be performed on the project.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.typescript

Class	Description
Component	(experimental) Represents a project component.
GitOptions	(experimental) Git configuration options.
GroupRunnerOptions
IgnoreFileOptions
LoggerOptions	(experimental) Options for logging utilities.
Project	(experimental) Base project.
ProjectOptions	(experimental) Options for Project.
ProjectType	Deprecated. no longer supported at the base project level
ProjenrcFile	(experimental) A component representing the projen runtime configuration.
ProjenrcJsonOptions
ReleasableCommits	(experimental) Find commits that should be considered releasable to decide if a release is required.
RenovatebotOptions	(experimental) Options for Renovatebot.
SampleReadmeProps	(experimental) SampleReadme Properties.
Task	(experimental) A task that can be performed on the project.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.vscode

Class	Description
Component	(experimental) Represents a project component.
DevEnvironmentDockerImage	(experimental) Options for specifying the Docker image of the container.
DevEnvironmentOptions	(experimental) Base options for configuring a container-based development environment.
IDevEnvironment	(experimental) Abstract interface for container-based development environments, such as Gitpod and GitHub Codespaces.
IDevEnvironment.Jsii$Default	Internal default implementation for IDevEnvironment.
JsonFile	(experimental) Represents a JSON file.
Project	(experimental) Base project.
Task	(experimental) A task that can be performed on the project.

Classes in io.github.cdklabs.projen used by io.github.cdklabs.projen.web

Class	Description
Component	(experimental) Represents a project component.
FileBase
FileBaseOptions
GitOptions	(experimental) Git configuration options.
GroupRunnerOptions
IgnoreFileOptions
IResolver	(experimental) API for resolving tokens when synthesizing file content.
JsonFile	(experimental) Represents a JSON file.
LoggerOptions	(experimental) Options for logging utilities.
Project	(experimental) Base project.
ProjectOptions	(experimental) Options for Project.
ProjectType	Deprecated. no longer supported at the base project level
ProjenrcJsonOptions
ReleasableCommits	(experimental) Find commits that should be considered releasable to decide if a release is required.
RenovatebotOptions	(experimental) Options for Renovatebot.
SampleReadmeProps	(experimental) SampleReadme Properties.