Uses of Class
io.github.cdklabs.projen.Component

Packages that use Component

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.circleci
io.github.cdklabs.projen.github
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

Uses of Component in io.github.cdklabs.projen

Subclasses of Component in io.github.cdklabs.projen

Modifier and Type	Class	Description
class	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.
class	DockerCompose	(experimental) Create a docker-compose YAML file.
class	FileBase
class	GitAttributesFile	(experimental) Assign attributes to file names in a git repository.
class	Gitpod	(experimental) The Gitpod component which emits .gitpod.yml.
class	IgnoreFile
class	IniFile	(experimental) Represents an INI file.
class	JsonFile	(experimental) Represents a JSON file.
class	License
class	Logger	(experimental) Project-level logging utilities.
class	Makefile	(experimental) Minimal Makefile.
class	ObjectFile	(experimental) Represents an Object file.
class	ProjectBuild	(experimental) Manages a standard build process for all projects.
class	ProjectTree
class	Projenrc	Deprecated. use ProjenrcJson
class	ProjenrcFile	(experimental) A component representing the projen runtime configuration.
class	ProjenrcJson	(experimental) Sets up a project to use JSON for projenrc.
class	Renovatebot	(experimental) Defines renovatebot configuration for projen project.
class	SampleDir	(experimental) Renders the given files into the directory if the directory does not exist.
class	SampleFile	(experimental) Produces a file with the given contents but only once, if the file doesn't already exist.
class	SampleReadme	(experimental) Represents a README.md sample file.
class	SourceCode	(experimental) Represents a source file.
class	Tasks	(experimental) Defines project tasks.
class	TextFile	(experimental) A text file.
class	TomlFile	(experimental) Represents a TOML file.
class	Version
class	XmlFile	(experimental) Represents an XML file.
class	YamlFile	(experimental) Represents a YAML file.

Methods in io.github.cdklabs.projen that return types with arguments of type Component

Modifier and Type	Method	Description
List<Component>	Project.getComponents()	(experimental) Returns all the components within this project.

Uses of Component in io.github.cdklabs.projen.awscdk

Subclasses of Component in io.github.cdklabs.projen.awscdk

Modifier and Type	Class	Description
class	AutoDiscover	(experimental) Discovers and creates integration tests and lambdas from code in the project's source and test trees.
class	AwsCdkDeps	(experimental) Manages dependencies on the AWS CDK.
class	AwsCdkDepsJava	(experimental) Manages dependencies on the AWS CDK for Java projects.
class	AwsCdkDepsJs	(experimental) Manages dependencies on the AWS CDK for Node.js projects.
class	AwsCdkDepsPy	(experimental) Manages dependencies on the AWS CDK for Python projects.
class	CdkConfig	(experimental) Represents cdk.json file.
class	CdkTasks	(experimental) Adds standard AWS CDK tasks to your project.
class	EdgeLambdaAutoDiscover	(experimental) Creates edge lambdas from entry points discovered in the project's source tree.
class	IntegrationTest	(experimental) Cloud integration tests.
class	IntegrationTestAutoDiscover	(experimental) Creates integration tests from entry points discovered in the test tree.
class	LambdaAutoDiscover	(experimental) Creates lambdas from entry points discovered in the project's source tree.
class	LambdaExtension	(experimental) Create a Lambda Extension.
class	LambdaExtensionAutoDiscover	(experimental) Creates Lambda Extensions from entrypoints discovered in the project's source tree.
class	LambdaFunction	(experimental) Generates a pre-bundled AWS Lambda function construct from handler code.

Uses of Component in io.github.cdklabs.projen.build

Subclasses of Component in io.github.cdklabs.projen.build

Modifier and Type	Class	Description
class	BuildWorkflow

Uses of Component in io.github.cdklabs.projen.cdk

Subclasses of Component in io.github.cdklabs.projen.cdk

Modifier and Type	Class	Description
class	AutoDiscoverBase	(experimental) Base class for auto-discovering and creating project subcomponents.
class	IntegrationTestAutoDiscoverBase	(experimental) Base class for locating integration tests in the project's test tree.
class	IntegrationTestBase

Uses of Component in io.github.cdklabs.projen.cdk8s

Subclasses of Component in io.github.cdklabs.projen.cdk8s

Modifier and Type	Class	Description
class	AutoDiscover	(experimental) Automatically discovers and creates IntegrationTests from entry points found in the test tree.
class	Cdk8sDeps	(experimental) Manages dependencies on the CDK8s.
class	Cdk8sDepsPy
class	IntegrationTest	(experimental) CDK8S integration test.
class	IntegrationTestAutoDiscover	(experimental) Discovers and creates integration tests from files in the test root.

Uses of Component in io.github.cdklabs.projen.circleci

Subclasses of Component in io.github.cdklabs.projen.circleci

Modifier and Type	Class	Description
class	Circleci	(experimental) Circleci Class to manage .circleci/config.yml.

Uses of Component in io.github.cdklabs.projen.github

Subclasses of Component in io.github.cdklabs.projen.github

Modifier and Type	Class	Description
class	AutoApprove	(experimental) Auto approve pull requests that meet a criteria.
class	AutoMerge	(experimental) Sets up mergify to merging approved pull requests.
class	Dependabot	(experimental) Defines dependabot configuration for node projects.
class	GitHub
class	GithubWorkflow	(experimental) Workflow for GitHub.
class	Mergify
class	PullRequestLint	(experimental) Configure validations to run on GitHub pull requests.
class	PullRequestTemplate	(experimental) Template for GitHub pull requests.
class	Stale	(experimental) Warns and then closes issues and PRs that have had no activity for a specified amount of time.
class	TaskWorkflow	(experimental) A GitHub workflow for common build tasks within a project.
class	TaskWorkflowJob	(experimental) The primary or initial job of a TaskWorkflow.

Uses of Component in io.github.cdklabs.projen.gitlab

Subclasses of Component in io.github.cdklabs.projen.gitlab

Modifier and Type	Class	Description
class	CiConfiguration	(experimental) CI for GitLab.
class	GitlabConfiguration	(experimental) A GitLab CI for the main .gitlab-ci.yml file.
class	NestedConfiguration	(experimental) A GitLab CI for templates that are created and included in the .gitlab-ci.yml file.

Uses of Component in io.github.cdklabs.projen.java

Subclasses of Component in io.github.cdklabs.projen.java

Modifier and Type	Class	Description
class	Junit	(experimental) Implements JUnit-based testing.
class	MavenCompile	(experimental) Adds the maven-compiler plugin to a POM file and the compile task.
class	MavenPackaging	(experimental) Configures a maven project to produce a .jar archive with sources and javadocs.
class	MavenSample	(experimental) Java code sample.
class	Pom	(experimental) A Project Object Model or POM is the fundamental unit of work in Maven.
class	Projenrc	(experimental) Allows writing projenrc files in java.

Uses of Component in io.github.cdklabs.projen.javascript

Subclasses of Component in io.github.cdklabs.projen.javascript

Modifier and Type	Class	Description
class	Bundler	(experimental) Adds support for bundling JavaScript applications and dependencies into a single file.
class	Eslint	(experimental) Represents eslint configuration.
class	Jest	(experimental) Installs the following npm scripts:.
class	LicenseChecker	(experimental) Enforces allowed licenses used by dependencies.
class	NodePackage	(experimental) Represents the npm package.json file.
class	NpmConfig	(experimental) File representing the local NPM config in .npmrc.
class	Prettier	(experimental) Represents prettier configuration.
class	Projenrc	(experimental) Sets up a javascript project to use TypeScript for projenrc.
class	TypescriptConfig
class	UpgradeDependencies	(experimental) Upgrade node project dependencies.
class	Yarnrc

Uses of Component in io.github.cdklabs.projen.python

Subclasses of Component in io.github.cdklabs.projen.python

Modifier and Type	Class	Description
class	Pip	(experimental) Manages dependencies using a requirements.txt file and the pip CLI tool.
class	Poetry	(experimental) Manage project dependencies, virtual environments, and packaging through the poetry CLI tool.
class	PoetryPyproject	(experimental) Represents configuration of a pyproject.toml file for a Poetry project.
class	Projenrc	(experimental) Allows writing projenrc files in python.
class	Pytest
class	PytestSample	(experimental) Python test code sample.
class	PythonSample	(experimental) Python code sample.
class	RequirementsFile	(experimental) Specifies a list of packages to be installed using pip.
class	SetupPy	(experimental) Python packaging script where package metadata can be placed.
class	Setuptools	(experimental) Manages packaging through setuptools with a setup.py script.
class	Venv	(experimental) Manages a virtual environment through the Python venv module.

Uses of Component in io.github.cdklabs.projen.release

Subclasses of Component in io.github.cdklabs.projen.release

Modifier and Type	Class	Description
class	Publisher	(experimental) Implements GitHub jobs for publishing modules to package managers.
class	Release	(experimental) Manages releases (currently through GitHub workflows).

Uses of Component in io.github.cdklabs.projen.typescript

Subclasses of Component in io.github.cdklabs.projen.typescript

Modifier and Type	Class	Description
class	Projenrc	(experimental) Sets up a typescript project to use TypeScript for projenrc.
class	ProjenrcTs	(experimental) A projenrc file written in TypeScript.

Uses of Component in io.github.cdklabs.projen.vscode

Subclasses of Component in io.github.cdklabs.projen.vscode

Modifier and Type	Class	Description
class	DevContainer	(experimental) A development environment running VSCode in a container;
class	VsCode
class	VsCodeLaunchConfig	(experimental) VSCode launch configuration file (launch.json), useful for enabling in-editor debugger.
class	VsCodeRecommendedExtensions	(experimental) VS Code Workspace recommended extensions Source: https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions.
class	VsCodeSettings	(experimental) VS Code Workspace settings Source: https://code.visualstudio.com/docs/getstarted/settings#_workspace-settings.

Uses of Component in io.github.cdklabs.projen.web

Subclasses of Component in io.github.cdklabs.projen.web

Modifier and Type	Class	Description
class	NextComponent
class	ReactComponent
class	ReactTypeDef	Deprecated. No longer used.