API Reference

Submodules

The following submodules are available:

Constructs

Component

Represents a project component.

Initializers

import { Component } from 'projen'

new Component(scope: IConstruct, id?: string)

Name	Type	Description
`scope`	`constructs.IConstruct`	No description.
`id`	`string`	No description.

`scope`^Required

Type: constructs.IConstruct

`id`^Optional

Type: string

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { Component } from 'projen'

Component.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { Component } from 'projen'

Component.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

Dependencies

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.

To add a dependency you can use a project-type specific API such as nodeProject.addDeps() or use the generic API of project.deps:

Initializers

import { Dependencies } from 'projen'

new Dependencies(project: Project)

Name	Type	Description
`project`	`Project`	The parent project.

`project`^Required

Type: Project

The parent project.

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.
`addDependency`	Adds a dependency to this project.
`getDependency`	Returns a dependency by name.
`isDependencySatisfied`	Checks if an existing dependency satisfies a dependency requirement.
`removeDependency`	Removes a dependency.
`tryGetDependency`	Returns a dependency by name.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

`addDependency`

public addDependency(spec: string, type: DependencyType, metadata?: {[ key: string ]: any}): Dependency

Adds a dependency to this project.

`spec`^Required

Type: string

The dependency spec in the format MODULE[@VERSION] where MODULE is the package-manager-specific module name and VERSION is an optional semantic version requirement (e.g. ^3.4.0).

`type`^Required

Type: DependencyType

The type of the dependency.

`metadata`^Optional

Type: {[ key: string ]: any}

`getDependency`

public getDependency(name: string, type?: DependencyType): Dependency

Returns a dependency by name.

Fails if there is no dependency defined by that name or if type is not provided and there is more then one dependency type for this dependency.

`name`^Required

Type: string

The name of the dependency.

`type`^Optional

Type: DependencyType

The dependency type.

If this dependency is defined only for a single type, this argument can be omitted.

`isDependencySatisfied`

public isDependencySatisfied(name: string, type: DependencyType, expectedRange: string): boolean

Checks if an existing dependency satisfies a dependency requirement.

`name`^Required

Type: string

The name of the dependency to check (without the version).

`type`^Required

Type: DependencyType

The dependency type.

`expectedRange`^Required

Type: string

The version constraint to check (e.g. ^3.4.0). The constraint of the dependency must be a subset of the expected range to satisfy the requirements.

`removeDependency`

public removeDependency(name: string, type?: DependencyType): void

Removes a dependency.

`name`^Required

Type: string

The name of the module to remove (without the version).

`type`^Optional

Type: DependencyType

The dependency type.

This is only required if there the dependency is defined for multiple types.

`tryGetDependency`

public tryGetDependency(name: string, type?: DependencyType): Dependency

Returns a dependency by name.

Returns undefined if there is no dependency defined by that name or if type is not provided and there is more then one dependency type for this dependency.

`name`^Required

Type: string

The name of the dependency.

`type`^Optional

Type: DependencyType

The dependency type.

If this dependency is defined only for a single type, this argument can be omitted.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.
`parseDependency`	Returns the coordinates of a dependency spec.

`isConstruct`

import { Dependencies } from 'projen'

Dependencies.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { Dependencies } from 'projen'

Dependencies.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`parseDependency`

import { Dependencies } from 'projen'

Dependencies.parseDependency(spec: string)

Returns the coordinates of a dependency spec.

Given foo@^3.4.0 returns { name: "foo", version: "^3.4.0" }. Given bar@npm:@bar/legacy returns { name: "bar", version: "npm:@bar/legacy" }.

`spec`^Required

Type: string

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`all`	`Dependency[]`	A copy of all dependencies recorded for this project.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`all`^Required

public readonly all: Dependency[];

Type: Dependency[]

A copy of all dependencies recorded for this project.

The list is sorted by type->name->version

Constants

Name	Type	Description
`MANIFEST_FILE`	`string`	The project-relative path of the deps manifest file.

`MANIFEST_FILE`^Required

public readonly MANIFEST_FILE: string;

Type: string

The project-relative path of the deps manifest file.

DockerCompose

Create a docker-compose YAML file.

Initializers

import { DockerCompose } from 'projen'

new DockerCompose(project: Project, props?: DockerComposeProps)

Name	Type	Description
`project`	`Project`	No description.
`props`	`DockerComposeProps`	No description.

`project`^Required

Type: Project

`props`^Optional

Type: DockerComposeProps

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.
`addService`	Add a service to the docker-compose file.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

`addService`

public addService(serviceName: string, description: DockerComposeServiceDescription): DockerComposeService

Add a service to the docker-compose file.

`serviceName`^Required

Type: string

name of the service.

`description`^Required

Type: DockerComposeServiceDescription

a service description.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.
`bindVolume`	Create a bind volume that binds a host path to the target path in the container.
`namedVolume`	Create a named volume and mount it to the target path.
`network`	Create a named network and mount it to the target path.
`portMapping`	Create a port mapping.
`serviceName`	Depends on a service name.

`isConstruct`

import { DockerCompose } from 'projen'

DockerCompose.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { DockerCompose } from 'projen'

DockerCompose.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`bindVolume`

import { DockerCompose } from 'projen'

DockerCompose.bindVolume(sourcePath: string, targetPath: string)

Create a bind volume that binds a host path to the target path in the container.

`sourcePath`^Required

Type: string

Host path name.

`targetPath`^Required

Type: string

Target path name.

`namedVolume`

import { DockerCompose } from 'projen'

DockerCompose.namedVolume(volumeName: string, targetPath: string, options?: DockerComposeVolumeConfig)

Create a named volume and mount it to the target path.

If you use this named volume in several services, the volume will be shared. In this case, the volume configuration of the first-provided options are used.

`volumeName`^Required

Type: string

Name of the volume.

`targetPath`^Required

Type: string

Target path.

`options`^Optional

Type: DockerComposeVolumeConfig

volume configuration (default: docker compose defaults).

`network`

import { DockerCompose } from 'projen'

DockerCompose.network(networkName: string, options?: DockerComposeNetworkConfig)

Create a named network and mount it to the target path.

If you use this named network in several services, the network will be shared. In this case, the network configuration of the first-provided options are used.

`networkName`^Required

Type: string

Name of the network.

`options`^Optional

Type: DockerComposeNetworkConfig

network configuration.

`portMapping`

import { DockerCompose } from 'projen'

DockerCompose.portMapping(publishedPort: number, targetPort: number, options?: DockerComposePortMappingOptions)

Create a port mapping.

`publishedPort`^Required

Type: number

Published port number.

`targetPort`^Required

Type: number

Container's port number.

`options`^Optional

Type: DockerComposePortMappingOptions

Port mapping options.

`serviceName`

import { DockerCompose } from 'projen'

DockerCompose.serviceName(serviceName: string)

Depends on a service name.

`serviceName`^Required

Type: string

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`file`	`YamlFile`	The Docker Compose file.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`file`^Required

public readonly file: YamlFile;

Type: YamlFile

The Docker Compose file.

FileBase

Initializers

import { FileBase } from 'projen'

new FileBase(scope: IConstruct, filePath: string, options?: FileBaseOptions)

Name	Type	Description
`scope`	`constructs.IConstruct`	No description.
`filePath`	`string`	No description.
`options`	`FileBaseOptions`	No description.

`scope`^Required

Type: constructs.IConstruct

`filePath`^Required

Type: string

`options`^Optional

Type: FileBaseOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Writes the file to the project's output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Writes the file to the project's output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { FileBase } from 'projen'

FileBase.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { FileBase } from 'projen'

FileBase.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`absolutePath`	`string`	The absolute path of this file.
`path`	`string`	The file path, relative to the project's outdir.
`changed`	`boolean`	Indicates if the file has been changed during synthesis.
`marker`	`string`	The projen marker, used to identify files as projen-generated.
`executable`	`boolean`	Indicates if the file should be marked as executable.
`readonly`	`boolean`	Indicates if the file should be read-only or read-write.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`absolutePath`^Required

public readonly absolutePath: string;

Type: string

The absolute path of this file.

`path`^Required

public readonly path: string;

Type: string

The file path, relative to the project's outdir.

`changed`^Optional

public readonly changed: boolean;

Type: boolean

Indicates if the file has been changed during synthesis.

This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

`marker`^Optional

public readonly marker: string;

Type: string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

`executable`^Required

public readonly executable: boolean;

Type: boolean

Indicates if the file should be marked as executable.

`readonly`^Required

public readonly readonly: boolean;

Type: boolean

Indicates if the file should be read-only or read-write.

GitAttributesFile

Assign attributes to file names in a git repository.

https://git-scm.com/docs/gitattributes

Initializers

import { GitAttributesFile } from 'projen'

new GitAttributesFile(scope: IConstruct, options?: GitAttributesFileOptions)

Name	Type	Description
`scope`	`constructs.IConstruct`	No description.
`options`	`GitAttributesFileOptions`	No description.

`scope`^Required

Type: constructs.IConstruct

`options`^Optional

Type: GitAttributesFileOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Writes the file to the project's output directory.
`addAttributes`	Maps a set of attributes to a set of files.
`addLfsPattern`	Add attributes necessary to mark these files as stored in LFS.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Writes the file to the project's output directory.

`addAttributes`

public addAttributes(glob: string, attributes: ...string[]): void

Maps a set of attributes to a set of files.

`glob`^Required

Type: string

Glob pattern to match files in the repo.

`attributes`^Required

Type: ...string[]

Attributes to assign to these files.

`addLfsPattern`

public addLfsPattern(glob: string): void

Add attributes necessary to mark these files as stored in LFS.

`glob`^Required

Type: string

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { GitAttributesFile } from 'projen'

GitAttributesFile.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { GitAttributesFile } from 'projen'

GitAttributesFile.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`absolutePath`	`string`	The absolute path of this file.
`path`	`string`	The file path, relative to the project's outdir.
`changed`	`boolean`	Indicates if the file has been changed during synthesis.
`marker`	`string`	The projen marker, used to identify files as projen-generated.
`executable`	`boolean`	Indicates if the file should be marked as executable.
`readonly`	`boolean`	Indicates if the file should be read-only or read-write.
`endOfLine`	`EndOfLine`	The default end of line character for text files.
`hasLfsPatterns`	`boolean`	Whether the current gitattributes file has any LFS patterns.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`absolutePath`^Required

public readonly absolutePath: string;

Type: string

The absolute path of this file.

`path`^Required

public readonly path: string;

Type: string

The file path, relative to the project's outdir.

`changed`^Optional

public readonly changed: boolean;

Type: boolean

Indicates if the file has been changed during synthesis.

This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

`marker`^Optional

public readonly marker: string;

Type: string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

`executable`^Required

public readonly executable: boolean;

Type: boolean

Indicates if the file should be marked as executable.

`readonly`^Required

public readonly readonly: boolean;

Type: boolean

Indicates if the file should be read-only or read-write.

`endOfLine`^Required

public readonly endOfLine: EndOfLine;

Type: EndOfLine

The default end of line character for text files.

`hasLfsPatterns`^Required

public readonly hasLfsPatterns: boolean;

Type: boolean

Whether the current gitattributes file has any LFS patterns.

Gitpod

Implements: IDevEnvironment

The Gitpod component which emits .gitpod.yml.

Initializers

import { Gitpod } from 'projen'

new Gitpod(project: Project, options?: GitpodOptions)

Name	Type	Description
`project`	`Project`	No description.
`options`	`GitpodOptions`	No description.

`project`^Required

Type: Project

`options`^Optional

Type: GitpodOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.
`addCustomTask`	Add a task with more granular options.
`addDockerImage`	Add a custom Docker image or Dockerfile for the container.
`addPorts`	Add ports that should be exposed (forwarded) from the container.
`addPrebuilds`	Add a prebuilds configuration for the Gitpod App.
`addTasks`	Add tasks to run when gitpod starts.
`addVscodeExtensions`	Add a list of VSCode extensions that should be automatically installed in the container.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

`addCustomTask`

public addCustomTask(options: GitpodTask): void

Add a task with more granular options.

By default, all tasks will be run in parallel. To run tasks in sequence, create a new Task and set the other tasks as subtasks.

`options`^Required

Type: GitpodTask

The task parameters.

`addDockerImage`

public addDockerImage(image: DevEnvironmentDockerImage): void

Add a custom Docker image or Dockerfile for the container.

`image`^Required

Type: DevEnvironmentDockerImage

The Docker image.

`addPorts`

public addPorts(ports: ...string[]): void

Add ports that should be exposed (forwarded) from the container.

`ports`^Required

Type: ...string[]

The new ports.

`addPrebuilds`

public addPrebuilds(config: GitpodPrebuilds): void

Add a prebuilds configuration for the Gitpod App.

`config`^Required

Type: GitpodPrebuilds

The configuration.

`addTasks`

public addTasks(tasks: ...Task[]): void

Add tasks to run when gitpod starts.

By default, all tasks will be run in parallel. To run tasks in sequence, create a new Task and specify the other tasks as subtasks.

`tasks`^Required

Type: ...Task[]

The new tasks.

`addVscodeExtensions`

public addVscodeExtensions(extensions: ...string[]): void

Add a list of VSCode extensions that should be automatically installed in the container.

These must be in the format defined in the Open VSX registry.

https://www.gitpod.io/docs/vscode-extensions/

Example

'scala-lang.scala@0.3.9:O5XmjwY5Gz+0oDZAmqneJw=='

`extensions`^Required

Type: ...string[]

The extension IDs.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { Gitpod } from 'projen'

Gitpod.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { Gitpod } from 'projen'

Gitpod.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`config`	`any`	Direct access to the gitpod configuration (escape hatch).

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`config`^Required

public readonly config: any;

Type: any

Direct access to the gitpod configuration (escape hatch).

IgnoreFile

Initializers

import { IgnoreFile } from 'projen'

new IgnoreFile(project: Project, filePath: string, options?: IgnoreFileOptions)

Name	Type	Description
`project`	`Project`	The project to tie this file to.
`filePath`	`string`	- the relative path in the project to put the file.
`options`	`IgnoreFileOptions`	No description.

`project`^Required

Type: Project

The project to tie this file to.

`filePath`^Required

Type: string

the relative path in the project to put the file.

`options`^Optional

Type: IgnoreFileOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Writes the file to the project's output directory.
`addPatterns`	Add ignore patterns.
`exclude`	Ignore the files that match these patterns.
`include`	Always include the specified file patterns.
`removePatterns`	Removes patterns previously added from the ignore file.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Writes the file to the project's output directory.

`addPatterns`

public addPatterns(patterns: ...string[]): void

Add ignore patterns.

Files that match this pattern will be ignored. If the pattern starts with a negation mark !, files that match will not be ignored.

Comment lines (start with #) and blank lines ("") are filtered by default but can be included using options specified when instantiating the component.

`patterns`^Required

Type: ...string[]

Ignore patterns.

`exclude`

public exclude(patterns: ...string[]): void

Ignore the files that match these patterns.

`patterns`^Required

Type: ...string[]

The patterns to match.

`include`

public include(patterns: ...string[]): void

Always include the specified file patterns.

`patterns`^Required

Type: ...string[]

Patterns to include in git commits.

`removePatterns`

public removePatterns(patterns: ...string[]): void

Removes patterns previously added from the ignore file.

If addPattern() is called after this, the pattern will be added again.

`patterns`^Required

Type: ...string[]

patters to remove.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { IgnoreFile } from 'projen'

IgnoreFile.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { IgnoreFile } from 'projen'

IgnoreFile.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`absolutePath`	`string`	The absolute path of this file.
`path`	`string`	The file path, relative to the project's outdir.
`changed`	`boolean`	Indicates if the file has been changed during synthesis.
`marker`	`string`	The projen marker, used to identify files as projen-generated.
`executable`	`boolean`	Indicates if the file should be marked as executable.
`readonly`	`boolean`	Indicates if the file should be read-only or read-write.
`filterCommentLines`	`boolean`	No description.
`filterEmptyLines`	`boolean`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`absolutePath`^Required

public readonly absolutePath: string;

Type: string

The absolute path of this file.

`path`^Required

public readonly path: string;

Type: string

The file path, relative to the project's outdir.

`changed`^Optional

public readonly changed: boolean;

Type: boolean

Indicates if the file has been changed during synthesis.

This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

`marker`^Optional

public readonly marker: string;

Type: string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

`executable`^Required

public readonly executable: boolean;

Type: boolean

Indicates if the file should be marked as executable.

`readonly`^Required

public readonly readonly: boolean;

Type: boolean

Indicates if the file should be read-only or read-write.

`filterCommentLines`^Required

public readonly filterCommentLines: boolean;

Type: boolean

`filterEmptyLines`^Required

public readonly filterEmptyLines: boolean;

Type: boolean

IniFile

Represents an INI file.

Initializers

import { IniFile } from 'projen'

new IniFile(project: Project, filePath: string, options: IniFileOptions)

Name	Type	Description
`project`	`Project`	No description.
`filePath`	`string`	No description.
`options`	`IniFileOptions`	No description.

`project`^Required

Type: Project

`filePath`^Required

Type: string

`options`^Required

Type: IniFileOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Writes the file to the project's output directory.
`addDeletionOverride`	Syntactic sugar for `addOverride(path, undefined)`.
`addOverride`	Adds an override to the synthesized object file.
`addToArray`	Adds to an array in the synthesized object file.
`patch`	Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Writes the file to the project's output directory.

`addDeletionOverride`

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

`path`^Required

Type: string

The path of the value to delete.

`addOverride`

public addOverride(path: string, value: any): void

Adds an override to the synthesized object file.

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

project.tsconfig.file.addOverride('compilerOptions.alwaysStrict', true);
project.tsconfig.file.addOverride('compilerOptions.lib', ['dom', 'dom.iterable', 'esnext']);

would add the overrides

"compilerOptions": {
  "alwaysStrict": true,
  "lib": [
    "dom",
    "dom.iterable",
    "esnext"
  ]
  ...
}
...

`path`^Required

Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermediate keys will be created as needed.

`value`^Required

Type: any

The value.

Could be primitive or complex.

`addToArray`

public addToArray(path: string, values: ...any[]): void

Adds to an array in the synthesized object file.

If the array is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example, with the following object file

"compilerOptions": {
  "exclude": ["node_modules"],
  "lib": ["es2019"]
  ...
}
...

project.tsconfig.file.addToArray('compilerOptions.exclude', 'coverage');
project.tsconfig.file.addToArray('compilerOptions.lib', 'dom', 'dom.iterable', 'esnext');

would result in the following object file

"compilerOptions": {
  "exclude": ["node_modules", "coverage"],
  "lib": ["es2019", "dom", "dom.iterable", "esnext"]
  ...
}
...

`path`^Required

Type: string

The path of the property, you can use dot notation to att to arrays in complex types.

Any intermediate keys will be created as needed.

`values`^Required

Type: ...any[]

The values to add.

Could be primitive or complex.

`patch`

public patch(patches: ...JsonPatch[]): void

Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information.

For example, with the following object file

"compilerOptions": {
  "exclude": ["node_modules"],
  "lib": ["es2019"]
  ...
}
...

project.tsconfig.file.patch(JsonPatch.add("/compilerOptions/exclude/-", "coverage"));
project.tsconfig.file.patch(JsonPatch.replace("/compilerOptions/lib", ["dom", "dom.iterable", "esnext"]));

would result in the following object file

"compilerOptions": {
  "exclude": ["node_modules", "coverage"],
  "lib": ["dom", "dom.iterable", "esnext"]
  ...
}
...

`patches`^Required

Type: ...JsonPatch[]

The patch operations to apply.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { IniFile } from 'projen'

IniFile.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { IniFile } from 'projen'

IniFile.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`absolutePath`	`string`	The absolute path of this file.
`path`	`string`	The file path, relative to the project's outdir.
`changed`	`boolean`	Indicates if the file has been changed during synthesis.
`marker`	`string`	The projen marker, used to identify files as projen-generated.
`executable`	`boolean`	Indicates if the file should be marked as executable.
`readonly`	`boolean`	Indicates if the file should be read-only or read-write.
`omitEmpty`	`boolean`	Indicates if empty objects and arrays are omitted from the output object.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`absolutePath`^Required

public readonly absolutePath: string;

Type: string

The absolute path of this file.

`path`^Required

public readonly path: string;

Type: string

The file path, relative to the project's outdir.

`changed`^Optional

public readonly changed: boolean;

Type: boolean

Indicates if the file has been changed during synthesis.

This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

`marker`^Optional

public readonly marker: string;

Type: string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

`executable`^Required

public readonly executable: boolean;

Type: boolean

Indicates if the file should be marked as executable.

`readonly`^Required

public readonly readonly: boolean;

Type: boolean

Indicates if the file should be read-only or read-write.

`omitEmpty`^Required

public readonly omitEmpty: boolean;

Type: boolean

Indicates if empty objects and arrays are omitted from the output object.

JsonFile

Represents a JSON file.

Initializers

import { JsonFile } from 'projen'

new JsonFile(scope: IConstruct, filePath: string, options: JsonFileOptions)

Name	Type	Description
`scope`	`constructs.IConstruct`	No description.
`filePath`	`string`	No description.
`options`	`JsonFileOptions`	No description.

`scope`^Required

Type: constructs.IConstruct

`filePath`^Required

Type: string

`options`^Required

Type: JsonFileOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Writes the file to the project's output directory.
`addDeletionOverride`	Syntactic sugar for `addOverride(path, undefined)`.
`addOverride`	Adds an override to the synthesized object file.
`addToArray`	Adds to an array in the synthesized object file.
`patch`	Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Writes the file to the project's output directory.

`addDeletionOverride`

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

`path`^Required

Type: string

The path of the value to delete.

`addOverride`

public addOverride(path: string, value: any): void

Adds an override to the synthesized object file.

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

project.tsconfig.file.addOverride('compilerOptions.alwaysStrict', true);
project.tsconfig.file.addOverride('compilerOptions.lib', ['dom', 'dom.iterable', 'esnext']);

would add the overrides

"compilerOptions": {
  "alwaysStrict": true,
  "lib": [
    "dom",
    "dom.iterable",
    "esnext"
  ]
  ...
}
...

`path`^Required

Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermediate keys will be created as needed.

`value`^Required

Type: any

The value.

Could be primitive or complex.

`addToArray`

public addToArray(path: string, values: ...any[]): void

Adds to an array in the synthesized object file.

If the array is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example, with the following object file

"compilerOptions": {
  "exclude": ["node_modules"],
  "lib": ["es2019"]
  ...
}
...

project.tsconfig.file.addToArray('compilerOptions.exclude', 'coverage');
project.tsconfig.file.addToArray('compilerOptions.lib', 'dom', 'dom.iterable', 'esnext');

would result in the following object file

"compilerOptions": {
  "exclude": ["node_modules", "coverage"],
  "lib": ["es2019", "dom", "dom.iterable", "esnext"]
  ...
}
...

`path`^Required

Type: string

The path of the property, you can use dot notation to att to arrays in complex types.

Any intermediate keys will be created as needed.

`values`^Required

Type: ...any[]

The values to add.

Could be primitive or complex.

`patch`

public patch(patches: ...JsonPatch[]): void

Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information.

For example, with the following object file

"compilerOptions": {
  "exclude": ["node_modules"],
  "lib": ["es2019"]
  ...
}
...

project.tsconfig.file.patch(JsonPatch.add("/compilerOptions/exclude/-", "coverage"));
project.tsconfig.file.patch(JsonPatch.replace("/compilerOptions/lib", ["dom", "dom.iterable", "esnext"]));

would result in the following object file

"compilerOptions": {
  "exclude": ["node_modules", "coverage"],
  "lib": ["dom", "dom.iterable", "esnext"]
  ...
}
...

`patches`^Required

Type: ...JsonPatch[]

The patch operations to apply.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { JsonFile } from 'projen'

JsonFile.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { JsonFile } from 'projen'

JsonFile.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`absolutePath`	`string`	The absolute path of this file.
`path`	`string`	The file path, relative to the project's outdir.
`changed`	`boolean`	Indicates if the file has been changed during synthesis.
`marker`	`string`	The projen marker, used to identify files as projen-generated.
`executable`	`boolean`	Indicates if the file should be marked as executable.
`readonly`	`boolean`	Indicates if the file should be read-only or read-write.
`omitEmpty`	`boolean`	Indicates if empty objects and arrays are omitted from the output object.
`supportsComments`	`boolean`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`absolutePath`^Required

public readonly absolutePath: string;

Type: string

The absolute path of this file.

`path`^Required

public readonly path: string;

Type: string

The file path, relative to the project's outdir.

`changed`^Optional

public readonly changed: boolean;

Type: boolean

Indicates if the file has been changed during synthesis.

This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

`marker`^Optional

public readonly marker: string;

Type: string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

`executable`^Required

public readonly executable: boolean;

Type: boolean

Indicates if the file should be marked as executable.

`readonly`^Required

public readonly readonly: boolean;

Type: boolean

Indicates if the file should be read-only or read-write.

`omitEmpty`^Required

public readonly omitEmpty: boolean;

Type: boolean

Indicates if empty objects and arrays are omitted from the output object.

`supportsComments`^Required

public readonly supportsComments: boolean;

Type: boolean

License

Initializers

import { License } from 'projen'

new License(project: Project, options: LicenseOptions)

Name	Type	Description
`project`	`Project`	No description.
`options`	`LicenseOptions`	No description.

`project`^Required

Type: Project

`options`^Required

Type: LicenseOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Writes the file to the project's output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Writes the file to the project's output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { License } from 'projen'

License.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { License } from 'projen'

License.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`absolutePath`	`string`	The absolute path of this file.
`path`	`string`	The file path, relative to the project's outdir.
`changed`	`boolean`	Indicates if the file has been changed during synthesis.
`marker`	`string`	The projen marker, used to identify files as projen-generated.
`executable`	`boolean`	Indicates if the file should be marked as executable.
`readonly`	`boolean`	Indicates if the file should be read-only or read-write.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`absolutePath`^Required

public readonly absolutePath: string;

Type: string

The absolute path of this file.

`path`^Required

public readonly path: string;

Type: string

The file path, relative to the project's outdir.

`changed`^Optional

public readonly changed: boolean;

Type: boolean

Indicates if the file has been changed during synthesis.

This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

`marker`^Optional

public readonly marker: string;

Type: string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

`executable`^Required

public readonly executable: boolean;

Type: boolean

Indicates if the file should be marked as executable.

`readonly`^Required

public readonly readonly: boolean;

Type: boolean

Indicates if the file should be read-only or read-write.

Logger

Project-level logging utilities.

Initializers

import { Logger } from 'projen'

new Logger(scope: IConstruct, options?: LoggerOptions)

Name	Type	Description
`scope`	`constructs.IConstruct`	No description.
`options`	`LoggerOptions`	No description.

`scope`^Required

Type: constructs.IConstruct

`options`^Optional

Type: LoggerOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.
`debug`	Log a message to stderr with DEBUG severity.
`error`	Log a message to stderr with ERROR severity.
`info`	Log a message to stderr with INFO severity.
`log`	Log a message to stderr with a given logging level.
`verbose`	Log a message to stderr with VERBOSE severity.
`warn`	Log a message to stderr with WARN severity.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

`debug`

public debug(text: ...any[]): void

Log a message to stderr with DEBUG severity.

`text`^Required

Type: ...any[]

strings or objects to print.

`error`

public error(text: ...any[]): void

Log a message to stderr with ERROR severity.

`text`^Required

Type: ...any[]

strings or objects to print.

`info`

public info(text: ...any[]): void

Log a message to stderr with INFO severity.

`text`^Required

Type: ...any[]

strings or objects to print.

`log`

public log(level: LogLevel, text: ...any[]): void

Log a message to stderr with a given logging level.

The message will be printed as long as logger.level is set to the message's severity or higher.

`level`^Required

Type: LogLevel

Logging verbosity.

`text`^Required

Type: ...any[]

strings or objects to print.

`verbose`

public verbose(text: ...any[]): void

Log a message to stderr with VERBOSE severity.

`text`^Required

Type: ...any[]

strings or objects to print.

`warn`

public warn(text: ...any[]): void

Log a message to stderr with WARN severity.

`text`^Required

Type: ...any[]

strings or objects to print.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { Logger } from 'projen'

Logger.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { Logger } from 'projen'

Logger.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

Makefile

Minimal Makefile.

Initializers

import { Makefile } from 'projen'

new Makefile(project: Project, filePath: string, options?: MakefileOptions)

Name	Type	Description
`project`	`Project`	No description.
`filePath`	`string`	No description.
`options`	`MakefileOptions`	No description.

`project`^Required

Type: Project

`filePath`^Required

Type: string

`options`^Optional

Type: MakefileOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Writes the file to the project's output directory.
`addAll`	Add a target to all.
`addAlls`	Add multiple targets to all.
`addRule`	Add a rule to the Makefile.
`addRules`	Add multiple rules to the Makefile.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Writes the file to the project's output directory.

`addAll`

public addAll(target: string): Makefile

Add a target to all.

`target`^Required

Type: string

`addAlls`

public addAlls(targets: ...string[]): Makefile

Add multiple targets to all.

`targets`^Required

Type: ...string[]

`addRule`

public addRule(rule: Rule): Makefile

Add a rule to the Makefile.

`rule`^Required

Type: Rule

`addRules`

public addRules(rules: ...Rule[]): Makefile

Add multiple rules to the Makefile.

`rules`^Required

Type: ...Rule[]

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { Makefile } from 'projen'

Makefile.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { Makefile } from 'projen'

Makefile.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`absolutePath`	`string`	The absolute path of this file.
`path`	`string`	The file path, relative to the project's outdir.
`changed`	`boolean`	Indicates if the file has been changed during synthesis.
`marker`	`string`	The projen marker, used to identify files as projen-generated.
`executable`	`boolean`	Indicates if the file should be marked as executable.
`readonly`	`boolean`	Indicates if the file should be read-only or read-write.
`rules`	`Rule[]`	List of rule definitions.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`absolutePath`^Required

public readonly absolutePath: string;

Type: string

The absolute path of this file.

`path`^Required

public readonly path: string;

Type: string

The file path, relative to the project's outdir.

`changed`^Optional

public readonly changed: boolean;

Type: boolean

Indicates if the file has been changed during synthesis.

This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

`marker`^Optional

public readonly marker: string;

Type: string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

`executable`^Required

public readonly executable: boolean;

Type: boolean

Indicates if the file should be marked as executable.

`readonly`^Required

public readonly readonly: boolean;

Type: boolean

Indicates if the file should be read-only or read-write.

`rules`^Required

public readonly rules: Rule[];

Type: Rule[]

List of rule definitions.

ObjectFile

Represents an Object file.

Initializers

import { ObjectFile } from 'projen'

new ObjectFile(scope: IConstruct, filePath: string, options: ObjectFileOptions)

Name	Type	Description
`scope`	`constructs.IConstruct`	No description.
`filePath`	`string`	No description.
`options`	`ObjectFileOptions`	No description.

`scope`^Required

Type: constructs.IConstruct

`filePath`^Required

Type: string

`options`^Required

Type: ObjectFileOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Writes the file to the project's output directory.
`addDeletionOverride`	Syntactic sugar for `addOverride(path, undefined)`.
`addOverride`	Adds an override to the synthesized object file.
`addToArray`	Adds to an array in the synthesized object file.
`patch`	Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Writes the file to the project's output directory.

`addDeletionOverride`

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

`path`^Required

Type: string

The path of the value to delete.

`addOverride`

public addOverride(path: string, value: any): void

Adds an override to the synthesized object file.

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

project.tsconfig.file.addOverride('compilerOptions.alwaysStrict', true);
project.tsconfig.file.addOverride('compilerOptions.lib', ['dom', 'dom.iterable', 'esnext']);

would add the overrides

"compilerOptions": {
  "alwaysStrict": true,
  "lib": [
    "dom",
    "dom.iterable",
    "esnext"
  ]
  ...
}
...

`path`^Required

Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermediate keys will be created as needed.

`value`^Required

Type: any

The value.

Could be primitive or complex.

`addToArray`

public addToArray(path: string, values: ...any[]): void

Adds to an array in the synthesized object file.

If the array is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example, with the following object file

"compilerOptions": {
  "exclude": ["node_modules"],
  "lib": ["es2019"]
  ...
}
...

project.tsconfig.file.addToArray('compilerOptions.exclude', 'coverage');
project.tsconfig.file.addToArray('compilerOptions.lib', 'dom', 'dom.iterable', 'esnext');

would result in the following object file

"compilerOptions": {
  "exclude": ["node_modules", "coverage"],
  "lib": ["es2019", "dom", "dom.iterable", "esnext"]
  ...
}
...

`path`^Required

Type: string

The path of the property, you can use dot notation to att to arrays in complex types.

Any intermediate keys will be created as needed.

`values`^Required

Type: ...any[]

The values to add.

Could be primitive or complex.

`patch`

public patch(patches: ...JsonPatch[]): void

Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information.

For example, with the following object file

"compilerOptions": {
  "exclude": ["node_modules"],
  "lib": ["es2019"]
  ...
}
...

project.tsconfig.file.patch(JsonPatch.add("/compilerOptions/exclude/-", "coverage"));
project.tsconfig.file.patch(JsonPatch.replace("/compilerOptions/lib", ["dom", "dom.iterable", "esnext"]));

would result in the following object file

"compilerOptions": {
  "exclude": ["node_modules", "coverage"],
  "lib": ["dom", "dom.iterable", "esnext"]
  ...
}
...

`patches`^Required

Type: ...JsonPatch[]

The patch operations to apply.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { ObjectFile } from 'projen'

ObjectFile.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { ObjectFile } from 'projen'

ObjectFile.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`absolutePath`	`string`	The absolute path of this file.
`path`	`string`	The file path, relative to the project's outdir.
`changed`	`boolean`	Indicates if the file has been changed during synthesis.
`marker`	`string`	The projen marker, used to identify files as projen-generated.
`executable`	`boolean`	Indicates if the file should be marked as executable.
`readonly`	`boolean`	Indicates if the file should be read-only or read-write.
`omitEmpty`	`boolean`	Indicates if empty objects and arrays are omitted from the output object.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`absolutePath`^Required

public readonly absolutePath: string;

Type: string

The absolute path of this file.

`path`^Required

public readonly path: string;

Type: string

The file path, relative to the project's outdir.

`changed`^Optional

public readonly changed: boolean;

Type: boolean

Indicates if the file has been changed during synthesis.

This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

`marker`^Optional

public readonly marker: string;

Type: string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

`executable`^Required

public readonly executable: boolean;

Type: boolean

Indicates if the file should be marked as executable.

`readonly`^Required

public readonly readonly: boolean;

Type: boolean

Indicates if the file should be read-only or read-write.

`omitEmpty`^Required

public readonly omitEmpty: boolean;

Type: boolean

Indicates if empty objects and arrays are omitted from the output object.

Project

Base project.

Initializers

import { Project } from 'projen'

new Project(options: ProjectOptions)

Name	Type	Description
`options`	`ProjectOptions`	No description.

`options`^Required

Type: ProjectOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`addExcludeFromCleanup`	Exclude the matching files from pre-synth cleanup.
`addGitIgnore`	Adds a .gitignore pattern.
`addPackageIgnore`	Exclude these files from the bundled package.
`addTask`	Adds a new task to this project.
`addTip`	Prints a "tip" message during synthesis.
`annotateGenerated`	Consider a set of files as "generated".
`postSynthesize`	Called after all components are synthesized.
`preSynthesize`	Called before all components are synthesized.
`removeTask`	Removes a task from a project.
`runTaskCommand`	Returns the shell command to execute in order to run a task.
`synth`	Synthesize all project files into `outdir`.
`tryFindFile`	Finds a file at the specified relative path within this project and all its subprojects.
`tryFindJsonFile`	Finds a json file by name.
`tryFindObjectFile`	Finds an object file (like JsonFile, YamlFile, etc.) by name.
`tryRemoveFile`	Finds a file at the specified relative path within this project and removes it.

`toString`

public toString(): string

Returns a string representation of this construct.

`addExcludeFromCleanup`

public addExcludeFromCleanup(globs: ...string[]): void

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.

`globs`^Required

Type: ...string[]

The glob patterns to match.

`addGitIgnore`

public addGitIgnore(pattern: string): void

Adds a .gitignore pattern.

`pattern`^Required

Type: string

The glob pattern to ignore.

`addPackageIgnore`

public addPackageIgnore(_pattern: string): void

Exclude these files from the bundled package.

Implemented by project types based on the packaging mechanism. For example, NodeProject delegates this to .npmignore.

`_pattern`^Required

Type: string

The glob pattern to exclude.

`addTask`

public addTask(name: string, props?: TaskOptions): Task

Adds a new task to this project.

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

`name`^Required

Type: string

The task name to add.

`props`^Optional

Type: TaskOptions

Task properties.

`addTip`

public addTip(message: string): void

Prints a "tip" message during synthesis.

`message`^Required

Type: string

The message.

`annotateGenerated`

public annotateGenerated(_glob: string): void

Consider a set of files as "generated".

This method is implemented by derived classes and used for example, to add git attributes to tell GitHub that certain files are generated.

`_glob`^Required

Type: string

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

`postSynthesize`

public postSynthesize(): void

Called after all components are synthesized.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before all components are synthesized.

`removeTask`

public removeTask(name: string): Task

Removes a task from a project.

`name`^Required

Type: string

The name of the task to remove.

`runTaskCommand`

public runTaskCommand(task: Task): string

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

By default, this is npx projen@<version> <task>

`task`^Required

Type: Task

The task for which the command is required.

`synth`

public synth(): void

Synthesize all project files into outdir.

Call "this.preSynthesize()"
Delete all generated files
Synthesize all subprojects
Synthesize all components of this project
Call "postSynthesize()" for all components of this project
Call "this.postSynthesize()"

`tryFindFile`

public tryFindFile(filePath: string): FileBase

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

`filePath`^Required

Type: string

The file path.

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

`tryFindJsonFile`

public tryFindJsonFile(filePath: string): JsonFile

Finds a json file by name.

`filePath`^Required

Type: string

The file path.

`tryFindObjectFile`

public tryFindObjectFile(filePath: string): ObjectFile

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

`filePath`^Required

Type: string

The file path.

`tryRemoveFile`

public tryRemoveFile(filePath: string): FileBase

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

`filePath`^Required

Type: string

The file path.

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

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isProject`	Test whether the given construct is a project.
`of`	Find the closest ancestor project for given construct.

`isConstruct`

import { Project } from 'projen'

Project.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isProject`

import { Project } from 'projen'

Project.isProject(x: any)

Test whether the given construct is a project.

`x`^Required

Type: any

`of`

import { Project } from 'projen'

Project.of(construct: IConstruct)

Find the closest ancestor project for given construct.

When given a project, this it the project itself.

`construct`^Required

Type: constructs.IConstruct

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`buildTask`	`Task`	No description.
`commitGenerated`	`boolean`	Whether to commit the managed files by default.
`compileTask`	`Task`	No description.
`components`	`Component[]`	Returns all the components within this project.
`deps`	`Dependencies`	Project dependencies.
`ejected`	`boolean`	Whether or not the project is being ejected.
`files`	`FileBase[]`	All files in this project.
`gitattributes`	`GitAttributesFile`	The .gitattributes file for this repository.
`gitignore`	`IgnoreFile`	.gitignore.
`logger`	`Logger`	Logging utilities.
`name`	`string`	Project name.
`outdir`	`string`	Absolute output directory of this project.
`packageTask`	`Task`	No description.
`postCompileTask`	`Task`	No description.
`preCompileTask`	`Task`	No description.
`projectBuild`	`ProjectBuild`	Manages the build process of the project.
`projenCommand`	`string`	The command to use in order to run the projen CLI.
`root`	`Project`	The root project.
`subprojects`	`Project[]`	Returns all the subprojects within this project.
`tasks`	`Tasks`	Project tasks.
`testTask`	`Task`	No description.
`defaultTask`	`Task`	This is the "default" task, the one that executes "projen".
`initProject`	`InitProject`	The options used when this project is bootstrapped via `projen new`.
`parent`	`Project`	A parent project.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`buildTask`^Required

public readonly buildTask: Task;

Type: Task

`commitGenerated`^Required

public readonly commitGenerated: boolean;

Type: boolean

Whether to commit the managed files by default.

`compileTask`^Required

public readonly compileTask: Task;

Type: Task

`components`^Required

public readonly components: Component[];

Type: Component[]

Returns all the components within this project.

`deps`^Required

public readonly deps: Dependencies;

Type: Dependencies

Project dependencies.

`ejected`^Required

public readonly ejected: boolean;

Type: boolean

Whether or not the project is being ejected.

`files`^Required

public readonly files: FileBase[];

Type: FileBase[]

All files in this project.

`gitattributes`^Required

public readonly gitattributes: GitAttributesFile;

Type: GitAttributesFile

The .gitattributes file for this repository.

`gitignore`^Required

public readonly gitignore: IgnoreFile;

Type: IgnoreFile

.gitignore.

`logger`^Required

public readonly logger: Logger;

Type: Logger

Logging utilities.

`name`^Required

public readonly name: string;

Type: string

Project name.

`outdir`^Required

public readonly outdir: string;

Type: string

Absolute output directory of this project.

`packageTask`^Required

public readonly packageTask: Task;

Type: Task

`postCompileTask`^Required

public readonly postCompileTask: Task;

Type: Task

`preCompileTask`^Required

public readonly preCompileTask: Task;

Type: Task

`projectBuild`^Required

public readonly projectBuild: ProjectBuild;

Type: ProjectBuild

Manages the build process of the project.

`projenCommand`^Required

public readonly projenCommand: string;

Type: string

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

`root`^Required

public readonly root: Project;

Type: Project

The root project.

`subprojects`^Required

public readonly subprojects: Project[];

Type: Project[]

Returns all the subprojects within this project.

`tasks`^Required

public readonly tasks: Tasks;

Type: Tasks

Project tasks.

`testTask`^Required

public readonly testTask: Task;

Type: Task

`defaultTask`^Optional

public readonly defaultTask: Task;

Type: Task

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

Undefined if the project is being ejected.

`initProject`^Optional

public readonly initProject: InitProject;

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

`parent`^Optional

public readonly parent: Project;

Type: Project

A parent project.

If undefined, this is the root project.

Constants

Name	Type	Description
`DEFAULT_TASK`	`string`	The name of the default task (the task executed when `projen` is run without arguments).

`DEFAULT_TASK`^Required

public readonly DEFAULT_TASK: string;

Type: string

The name of the default task (the task executed when projen is run without arguments).

Normally this task should synthesize the project files.

ProjectBuild

Manages a standard build process for all projects.

Build spawns these tasks in order:

default
pre-compile
compile
post-compile
test
package

Initializers

import { ProjectBuild } from 'projen'

new ProjectBuild(project: Project)

Name	Type	Description
`project`	`Project`	No description.

`project`^Required

Type: Project

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { ProjectBuild } from 'projen'

ProjectBuild.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { ProjectBuild } from 'projen'

ProjectBuild.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`buildTask`	`Task`	The task responsible for a full release build.
`compileTask`	`Task`	Compiles the code.
`packageTask`	`Task`	The "package" task.
`postCompileTask`	`Task`	Post-compile task.
`preCompileTask`	`Task`	Pre-compile task.
`testTask`	`Task`	Tests the code.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`buildTask`^Required

public readonly buildTask: Task;

Type: Task

The task responsible for a full release build.

`compileTask`^Required

public readonly compileTask: Task;

Type: Task

Compiles the code.

By default for node.js projects this task is empty.

`packageTask`^Required

public readonly packageTask: Task;

Type: Task

The "package" task.

`postCompileTask`^Required

public readonly postCompileTask: Task;

Type: Task

Post-compile task.

`preCompileTask`^Required

public readonly preCompileTask: Task;

Type: Task

Pre-compile task.

`testTask`^Required

public readonly testTask: Task;

Type: Task

Tests the code.

ProjectTree

Initializers

import { ProjectTree } from 'projen'

new ProjectTree(project: Project)

Name	Type	Description
`project`	`Project`	No description.

`project`^Required

Type: Project

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { ProjectTree } from 'projen'

ProjectTree.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { ProjectTree } from 'projen'

ProjectTree.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`file`	`JsonFile`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`file`^Required

public readonly file: JsonFile;

Type: JsonFile

Projenrc

Initializers

import { Projenrc } from 'projen'

new Projenrc(project: Project, options?: ProjenrcJsonOptions)

Name	Type	Description
`project`	`Project`	No description.
`options`	`ProjenrcJsonOptions`	No description.

`project`^Required

Type: Project

`options`^Optional

Type: ProjenrcJsonOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.
`of`	Returns the `Projenrc` instance associated with a project or `undefined` if there is no Projenrc.

`isConstruct`

import { Projenrc } from 'projen'

Projenrc.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { Projenrc } from 'projen'

Projenrc.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { Projenrc } from 'projen'

Projenrc.of(project: Project)

Returns the Projenrc instance associated with a project or undefined if there is no Projenrc.

`project`^Required

Type: Project

The project.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`filePath`	`string`	The path of the projenrc file.

`node`^Required

Deprecated: use ProjenrcJson

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

Deprecated: use ProjenrcJson

public readonly project: Project;

Type: Project

`filePath`^Required

Deprecated: use ProjenrcJson

public readonly filePath: string;

Type: string

The path of the projenrc file.

ProjenrcFile

A component representing the projen runtime configuration.

Initializers

import { ProjenrcFile } from 'projen'

new ProjenrcFile(scope: IConstruct, id?: string)

Name	Type	Description
`scope`	`constructs.IConstruct`	No description.
`id`	`string`	No description.

`scope`^Required

Type: constructs.IConstruct

`id`^Optional

Type: string

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.
`of`	Returns the `Projenrc` instance associated with a project or `undefined` if there is no Projenrc.

`isConstruct`

import { ProjenrcFile } from 'projen'

ProjenrcFile.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { ProjenrcFile } from 'projen'

ProjenrcFile.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { ProjenrcFile } from 'projen'

ProjenrcFile.of(project: Project)

Returns the Projenrc instance associated with a project or undefined if there is no Projenrc.

`project`^Required

Type: Project

The project.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`filePath`	`string`	The path of the projenrc file.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`filePath`^Required

public readonly filePath: string;

Type: string

The path of the projenrc file.

ProjenrcJson

Sets up a project to use JSON for projenrc.

Initializers

import { ProjenrcJson } from 'projen'

new ProjenrcJson(project: Project, options?: ProjenrcJsonOptions)

Name	Type	Description
`project`	`Project`	No description.
`options`	`ProjenrcJsonOptions`	No description.

`project`^Required

Type: Project

`options`^Optional

Type: ProjenrcJsonOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.
`of`	Returns the `Projenrc` instance associated with a project or `undefined` if there is no Projenrc.

`isConstruct`

import { ProjenrcJson } from 'projen'

ProjenrcJson.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { ProjenrcJson } from 'projen'

ProjenrcJson.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { ProjenrcJson } from 'projen'

ProjenrcJson.of(project: Project)

Returns the Projenrc instance associated with a project or undefined if there is no Projenrc.

`project`^Required

Type: Project

The project.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`filePath`	`string`	The path of the projenrc file.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`filePath`^Required

public readonly filePath: string;

Type: string

The path of the projenrc file.

Renovatebot

Defines renovatebot configuration for projen project.

Ignores the versions controlled by Projen.

Initializers

import { Renovatebot } from 'projen'

new Renovatebot(project: Project, options?: RenovatebotOptions)

Name	Type	Description
`project`	`Project`	No description.
`options`	`RenovatebotOptions`	No description.

`project`^Required

Type: Project

`options`^Optional

Type: RenovatebotOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { Renovatebot } from 'projen'

Renovatebot.isConstruct(x: 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.

`x`^Required

Type: any

Any object.

`isComponent`

import { Renovatebot } from 'projen'

Renovatebot.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`Project`	No description.
`file`	`JsonFile`	The file holding the renovatebot configuration.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: Project

`file`^Required

public readonly file: JsonFile;

Type: JsonFile

The file holding the renovatebot configuration.

SampleDir

Renders the given files into the directory if the directory does not exist.

Use this to create sample code files

Initializers

import { SampleDir } from 'projen'

API Reference

Submodules ​

Constructs ​

Component ​

Initializers ​

scopeRequired ​

idOptional ​

Methods ​

toString ​

postSynthesize ​

preSynthesize ​

synthesize ​

Static Functions ​

isConstruct ​

xRequired ​

isComponent ​

xRequired ​

Properties ​

nodeRequired ​

projectRequired ​

Dependencies ​

Initializers ​

projectRequired ​

Methods ​

toString ​

postSynthesize ​

preSynthesize ​

synthesize ​

addDependency ​

specRequired ​

typeRequired ​

metadataOptional ​

getDependency ​

nameRequired ​

typeOptional ​

isDependencySatisfied ​

nameRequired ​

typeRequired ​

expectedRangeRequired ​

removeDependency ​

nameRequired ​

typeOptional ​

tryGetDependency ​

nameRequired ​

typeOptional ​

Static Functions ​

isConstruct ​

xRequired ​

isComponent ​

xRequired ​

parseDependency ​

specRequired ​

Properties ​

nodeRequired ​

projectRequired ​

allRequired ​

Constants ​

MANIFEST_FILERequired ​

DockerCompose ​

Initializers ​

projectRequired ​

propsOptional ​

Methods ​

toString ​

postSynthesize ​

preSynthesize ​

synthesize ​

addService ​

serviceNameRequired ​

descriptionRequired ​

Static Functions ​

isConstruct ​

xRequired ​

isComponent ​

xRequired ​

bindVolume ​

sourcePathRequired ​

targetPathRequired ​

namedVolume ​

volumeNameRequired ​

Submodules

Constructs

Component

Initializers

`scope`^Required

`id`^Optional

Methods

`toString`

`postSynthesize`

`preSynthesize`

`synthesize`

Static Functions

`isConstruct`

`x`^Required

`isComponent`

`x`^Required

Properties

`node`^Required

`project`^Required

Dependencies

Initializers

`project`^Required

Methods

`toString`

`postSynthesize`

`preSynthesize`

`synthesize`

`addDependency`

`spec`^Required

`type`^Required

`metadata`^Optional

`getDependency`

`name`^Required

`type`^Optional

`isDependencySatisfied`

`name`^Required

`type`^Required

`expectedRange`^Required

`removeDependency`

`name`^Required

`type`^Optional

`tryGetDependency`

`name`^Required

`type`^Optional

Static Functions

`isConstruct`

`x`^Required

`isComponent`

`x`^Required

`parseDependency`

`spec`^Required

Properties

`node`^Required

`project`^Required

`all`^Required

Constants

`MANIFEST_FILE`^Required

DockerCompose

Initializers

`project`^Required

`props`^Optional

Methods

`toString`

`postSynthesize`

`preSynthesize`

`synthesize`

`addService`

`serviceName`^Required

`description`^Required

Static Functions

`isConstruct`

`x`^Required

`isComponent`

`x`^Required

`bindVolume`

`sourcePath`^Required

`targetPath`^Required

`namedVolume`

`volumeName`^Required

`targetPath`^Required