cdk8s Submodule

Constructs

AutoDiscover

Automatically discovers and creates IntegrationTests from entry points found in the test tree.

Initializers

import { cdk8s } from 'projen'

new cdk8s.AutoDiscover(project: Project, options: AutoDiscoverOptions)

Name	Type	Description
project	projen.Project	No description.
options	AutoDiscoverOptions	No description.

---

project^Required

• Type: projen.Project

---

options^Required

• Type: AutoDiscoverOptions

---

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 { cdk8s } from 'projen'

cdk8s.AutoDiscover.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 { cdk8s } from 'projen'

cdk8s.AutoDiscover.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	projen.Project	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

project^Required

public readonly project: Project;

• Type: projen.Project

---

Cdk8sDeps

Manages dependencies on the CDK8s.

Initializers

import { cdk8s } from 'projen'

new cdk8s.Cdk8sDeps(project: Project, options: Cdk8sDepsOptions)

Name	Type	Description
project	projen.Project	No description.
options	Cdk8sDepsOptions	No description.

---

project^Required

• Type: projen.Project

---

options^Required

• Type: Cdk8sDepsOptions

---

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 { cdk8s } from 'projen'

cdk8s.Cdk8sDeps.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 { cdk8s } from 'projen'

cdk8s.Cdk8sDeps.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	projen.Project	No description.
cdk8sMajorVersion	number	The major version of the CDK8s (e.g. 1, 2, ...).
cdk8sMinimumVersion	string	The minimum version of the CDK8s (e.g. 2.0.0).
cdk8sVersion	string	The dependency requirement for CDK8s.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

project^Required

public readonly project: Project;

• Type: projen.Project

---

cdk8sMajorVersion^Required

public readonly cdk8sMajorVersion: number;

• Type: number

The major version of the CDK8s (e.g. 1, 2, ...).

---

cdk8sMinimumVersion^Required

public readonly cdk8sMinimumVersion: string;

• Type: string

The minimum version of the CDK8s (e.g. 2.0.0).

---

cdk8sVersion^Required

public readonly cdk8sVersion: string;

• Type: string

The dependency requirement for CDK8s.

---

Cdk8sDepsPy

Initializers

import { cdk8s } from 'projen'

new cdk8s.Cdk8sDepsPy(project: Project, options: Cdk8sDepsOptions)

Name	Type	Description
project	projen.Project	No description.
options	Cdk8sDepsOptions	No description.

---

project^Required

• Type: projen.Project

---

options^Required

• Type: Cdk8sDepsOptions

---

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 { cdk8s } from 'projen'

cdk8s.Cdk8sDepsPy.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 { cdk8s } from 'projen'

cdk8s.Cdk8sDepsPy.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	projen.Project	No description.
cdk8sMajorVersion	number	The major version of the CDK8s (e.g. 1, 2, ...).
cdk8sMinimumVersion	string	The minimum version of the CDK8s (e.g. 2.0.0).
cdk8sVersion	string	The dependency requirement for CDK8s.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

project^Required

public readonly project: Project;

• Type: projen.Project

---

cdk8sMajorVersion^Required

public readonly cdk8sMajorVersion: number;

• Type: number

The major version of the CDK8s (e.g. 1, 2, ...).

---

cdk8sMinimumVersion^Required

public readonly cdk8sMinimumVersion: string;

• Type: string

The minimum version of the CDK8s (e.g. 2.0.0).

---

cdk8sVersion^Required

public readonly cdk8sVersion: string;

• Type: string

The dependency requirement for CDK8s.

---

Cdk8sPythonApp

CDK8s app in Python.

Initializers

import { cdk8s } from 'projen'

new cdk8s.Cdk8sPythonApp(options: Cdk8sPythonOptions)

Name	Type	Description
options	Cdk8sPythonOptions	No description.

---

options^Required

• Type: Cdk8sPythonOptions

---

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	Marks the provided file(s) as being 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.
addDependency	Adds a runtime dependency.
addDevDependency	Adds a dev dependency.

---

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

Marks the provided file(s) as being generated.

This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown.

https://github.com/github/linguist/blob/master/docs/overrides.md

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: projen.Task

The task for which the command is required.

---

synth

public synth(): void

Synthesize all project files into outdir.

1. Call "this.preSynthesize()"
2. Delete all generated files
3. Synthesize all subprojects
4. Synthesize all components of this project
5. Call "postSynthesize()" for all components of this project
6. 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.

---

addDependency

public addDependency(spec: string): void

Adds a runtime dependency.

spec^Required

• Type: string

Format <module>@<semver>.

---

addDevDependency

public addDevDependency(spec: string): void

Adds a dev dependency.

spec^Required

• Type: string

Format <module>@<semver>.

---

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 { cdk8s } from 'projen'

cdk8s.Cdk8sPythonApp.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.

---

isProject

import { cdk8s } from 'projen'

cdk8s.Cdk8sPythonApp.isProject(x: any)

Test whether the given construct is a project.

x^Required

• Type: any

---

of

import { cdk8s } from 'projen'

cdk8s.Cdk8sPythonApp.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	projen.Task	No description.
commitGenerated	boolean	Whether to commit the managed files by default.
compileTask	projen.Task	No description.
components	projen.Component[]	Returns all the components within this project.
deps	projen.Dependencies	Project dependencies.
ejected	boolean	Whether or not the project is being ejected.
files	projen.FileBase[]	All files in this project.
gitattributes	projen.GitAttributesFile	The .gitattributes file for this repository.
gitignore	projen.IgnoreFile	.gitignore.
logger	projen.Logger	Logging utilities.
name	string	Project name.
outdir	string	Absolute output directory of this project.
packageTask	projen.Task	No description.
postCompileTask	projen.Task	No description.
preCompileTask	projen.Task	No description.
projectBuild	projen.ProjectBuild	Manages the build process of the project.
projenCommand	string	The command to use in order to run the projen CLI.
root	projen.Project	The root project.
subprojects	projen.Project[]	Returns all the subprojects within this project.
tasks	projen.Tasks	Project tasks.
testTask	projen.Task	No description.
defaultTask	projen.Task	This is the "default" task, the one that executes "projen".
initProject	projen.InitProject	The options used when this project is bootstrapped via projen new.
parent	projen.Project	A parent project.
projectType	projen.ProjectType	No description.
autoApprove	projen.github.AutoApprove	Auto approve set up for this project.
devContainer	projen.vscode.DevContainer	Access for .devcontainer.json (used for GitHub Codespaces).
github	projen.github.GitHub	Access all github components.
gitpod	projen.Gitpod	Access for Gitpod.
vscode	projen.vscode.VsCode	Access all VSCode components.
depsManager	projen.python.IPythonDeps	API for managing dependencies.
envManager	projen.python.IPythonEnv	API for mangaging the Python runtime environment.
moduleName	string	Python module name (the project name, with any hyphens or periods replaced with underscores).
sampleTestdir	string	Directory where sample tests are located.
version	string	Version of the package for distribution (should follow semver).
packagingManager	projen.python.IPythonPackaging	API for managing packaging the project as a library.
pytest	projen.python.Pytest	Pytest component.
appEntrypoint	string	The CDK8s app entrypoint.
cdk8sDeps	Cdk8sDeps	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

buildTask^Required

public readonly buildTask: Task;

• Type: projen.Task

---

commitGenerated^Required

public readonly commitGenerated: boolean;

• Type: boolean

Whether to commit the managed files by default.

---

compileTask^Required

public readonly compileTask: Task;

• Type: projen.Task

---

components^Required

public readonly components: Component[];

• Type: projen.Component[]

Returns all the components within this project.

---

deps^Required

public readonly deps: Dependencies;

• Type: projen.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: projen.FileBase[]

All files in this project.

---

gitattributes^Required

public readonly gitattributes: GitAttributesFile;

• Type: projen.GitAttributesFile

The .gitattributes file for this repository.

---

gitignore^Required

public readonly gitignore: IgnoreFile;

• Type: projen.IgnoreFile

.gitignore.

---

logger^Required

public readonly logger: Logger;

• Type: projen.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: projen.Task

---

postCompileTask^Required

public readonly postCompileTask: Task;

• Type: projen.Task

---

preCompileTask^Required

public readonly preCompileTask: Task;

• Type: projen.Task

---

projectBuild^Required

public readonly projectBuild: ProjectBuild;

• Type: projen.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: projen.Project

The root project.

---

subprojects^Required

public readonly subprojects: Project[];

• Type: projen.Project[]

Returns all the subprojects within this project.

---

tasks^Required

public readonly tasks: Tasks;

• Type: projen.Tasks

Project tasks.

---

testTask^Required

public readonly testTask: Task;

• Type: projen.Task

---

defaultTask^Optional

public readonly defaultTask: Task;

• Type: projen.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: projen.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: projen.Project

A parent project.

If undefined, this is the root project.

---

projectType^Required

public readonly projectType: ProjectType;

• Type: projen.ProjectType

---

autoApprove^Optional

public readonly autoApprove: AutoApprove;

• Type: projen.github.AutoApprove

Auto approve set up for this project.

---

devContainer^Optional

public readonly devContainer: DevContainer;

• Type: projen.vscode.DevContainer

Access for .devcontainer.json (used for GitHub Codespaces).

This will be undefined if devContainer boolean is false

---

github^Optional

public readonly github: GitHub;

• Type: projen.github.GitHub

Access all github components.

This will be undefined for subprojects.

---

gitpod^Optional

public readonly gitpod: Gitpod;

• Type: projen.Gitpod

Access for Gitpod.

This will be undefined if gitpod boolean is false

---

vscode^Optional

public readonly vscode: VsCode;

• Type: projen.vscode.VsCode

Access all VSCode components.

This will be undefined for subprojects.

---

depsManager^Required

public readonly depsManager: IPythonDeps;

• Type: projen.python.IPythonDeps

API for managing dependencies.

---

envManager^Required

public readonly envManager: IPythonEnv;

• Type: projen.python.IPythonEnv

API for mangaging the Python runtime environment.

---

moduleName^Required

public readonly moduleName: string;

• Type: string

Python module name (the project name, with any hyphens or periods replaced with underscores).

---

sampleTestdir^Required

public readonly sampleTestdir: string;

• Type: string
• Default: "tests"

Directory where sample tests are located.

---

version^Required

public readonly version: string;

• Type: string

Version of the package for distribution (should follow semver).

---

packagingManager^Optional

public readonly packagingManager: IPythonPackaging;

• Type: projen.python.IPythonPackaging

API for managing packaging the project as a library.

Only applies when the projectType is LIB.

---

pytest^Optional

public readonly pytest: Pytest;

• Type: projen.python.Pytest

Pytest component.

---

appEntrypoint^Required

public readonly appEntrypoint: string;

• Type: string

The CDK8s app entrypoint.

---

cdk8sDeps^Required

public readonly cdk8sDeps: Cdk8sDeps;

• Type: Cdk8sDeps

---

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.

---

Cdk8sTypeScriptApp

CDK8s app in TypeScript.

Initializers

import { cdk8s } from 'projen'

new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)

Name	Type	Description
options	Cdk8sTypeScriptAppOptions	No description.

---

options^Required

• Type: Cdk8sTypeScriptAppOptions

---

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	Adds patterns to be ignored by npm.
addTask	Adds a new task to this project.
addTip	Prints a "tip" message during synthesis.
annotateGenerated	Marks the provided file(s) as being 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.
addBins	No description.
addBundledDeps	Defines bundled dependencies.
addCompileCommand	DEPRECATED.
addDeps	Defines normal dependencies.
addDevDeps	Defines development/test dependencies.
addFields	Directly set fields in package.json.
addKeywords	Adds keywords to package.json (deduplicated).
addPeerDeps	Defines peer dependencies.
addScripts	Replaces the contents of multiple npm package.json scripts.
addTestCommand	DEPRECATED.
hasScript	Indicates if a script by the name name is defined.
removeScript	Removes the npm script (always successful).
renderWorkflowSetup	Returns the set of workflow steps which should be executed to bootstrap a workflow.
setScript	Replaces the contents of an npm package.json script.

---

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

Adds patterns to be ignored by npm.

pattern^Required

• Type: string

The pattern to ignore.

---

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

Marks the provided file(s) as being generated.

This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown.

https://github.com/github/linguist/blob/master/docs/overrides.md

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.

This will typically be npx projen TASK.

task^Required

• Type: projen.Task

The task for which the command is required.

---

synth

public synth(): void

Synthesize all project files into outdir.

1. Call "this.preSynthesize()"
2. Delete all generated files
3. Synthesize all subprojects
4. Synthesize all components of this project
5. Call "postSynthesize()" for all components of this project
6. 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.

---

addBins

public addBins(bins: {[ key: string ]: string}): void

bins^Required

• Type: {[ key: string ]: string}

---

addBundledDeps

public addBundledDeps(deps: ...string[]): void

Defines bundled dependencies.

Bundled dependencies will be added as normal dependencies as well as to the bundledDependencies section of your package.json.

deps^Required

• Type: ...string[]

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

---

addCompileCommand

public addCompileCommand(commands: ...string[]): void

DEPRECATED.

commands^Required

• Type: ...string[]

---

addDeps

public addDeps(deps: ...string[]): void

Defines normal dependencies.

deps^Required

• Type: ...string[]

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

---

addDevDeps

public addDevDeps(deps: ...string[]): void

Defines development/test dependencies.

deps^Required

• Type: ...string[]

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

---

addFields

public addFields(fields: {[ key: string ]: any}): void

Directly set fields in package.json.

fields^Required

• Type: {[ key: string ]: any}

The fields to set.

---

addKeywords

public addKeywords(keywords: ...string[]): void

Adds keywords to package.json (deduplicated).

keywords^Required

• Type: ...string[]

The keywords to add.

---

addPeerDeps

public addPeerDeps(deps: ...string[]): void

Defines peer dependencies.

When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers.

deps^Required

• Type: ...string[]

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

---

addScripts

public addScripts(scripts: {[ key: string ]: string}): void

Replaces the contents of multiple npm package.json scripts.

scripts^Required

• Type: {[ key: string ]: string}

The scripts to set.

---

addTestCommand

public addTestCommand(commands: ...string[]): void

DEPRECATED.

commands^Required

• Type: ...string[]

---

hasScript

public hasScript(name: string): boolean

Indicates if a script by the name name is defined.

name^Required

• Type: string

The name of the script.

---

removeScript

public removeScript(name: string): void

Removes the npm script (always successful).

name^Required

• Type: string

The name of the script.

---

renderWorkflowSetup

public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]

Returns the set of workflow steps which should be executed to bootstrap a workflow.

options^Optional

• Type: projen.javascript.RenderWorkflowSetupOptions

Options.

---

setScript

public setScript(name: string, command: string): void

Replaces the contents of an npm package.json script.

name^Required

• Type: string

The script name.

---

command^Required

• Type: string

The command to execute.

---

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 { cdk8s } from 'projen'

cdk8s.Cdk8sTypeScriptApp.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.

---

isProject

import { cdk8s } from 'projen'

cdk8s.Cdk8sTypeScriptApp.isProject(x: any)

Test whether the given construct is a project.

x^Required

• Type: any

---

of

import { cdk8s } from 'projen'

cdk8s.Cdk8sTypeScriptApp.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	projen.Task	No description.
commitGenerated	boolean	Whether to commit the managed files by default.
compileTask	projen.Task	No description.
components	projen.Component[]	Returns all the components within this project.
deps	projen.Dependencies	Project dependencies.
ejected	boolean	Whether or not the project is being ejected.
files	projen.FileBase[]	All files in this project.
gitattributes	projen.GitAttributesFile	The .gitattributes file for this repository.
gitignore	projen.IgnoreFile	.gitignore.
logger	projen.Logger	Logging utilities.
name	string	Project name.
outdir	string	Absolute output directory of this project.
packageTask	projen.Task	No description.
postCompileTask	projen.Task	No description.
preCompileTask	projen.Task	No description.
projectBuild	projen.ProjectBuild	Manages the build process of the project.
projenCommand	string	The command to use in order to run the projen CLI.
root	projen.Project	The root project.
subprojects	projen.Project[]	Returns all the subprojects within this project.
tasks	projen.Tasks	Project tasks.
testTask	projen.Task	No description.
defaultTask	projen.Task	This is the "default" task, the one that executes "projen".
initProject	projen.InitProject	The options used when this project is bootstrapped via projen new.
parent	projen.Project	A parent project.
projectType	projen.ProjectType	No description.
autoApprove	projen.github.AutoApprove	Auto approve set up for this project.
devContainer	projen.vscode.DevContainer	Access for .devcontainer.json (used for GitHub Codespaces).
github	projen.github.GitHub	Access all github components.
gitpod	projen.Gitpod	Access for Gitpod.
vscode	projen.vscode.VsCode	Access all VSCode components.
allowLibraryDependencies	boolean	No description.
artifactsDirectory	string	The build output directory.
artifactsJavascriptDirectory	string	The location of the npm tarball after build (${artifactsDirectory}/js).
bundler	projen.javascript.Bundler	No description.
entrypoint	string	No description.
manifest	any	No description.
npmrc	projen.javascript.NpmConfig	The .npmrc file.
package	projen.javascript.NodePackage	API for managing the node package.
packageManager	projen.javascript.NodePackageManager	The package manager to use.
runScriptCommand	string	The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).
autoMerge	projen.github.AutoMerge	Component that sets up mergify for merging approved pull requests.
buildWorkflow	projen.build.BuildWorkflow	The PR build GitHub workflow.
buildWorkflowJobId	string	The job ID of the build workflow.
jest	projen.javascript.Jest	The Jest configuration (if enabled).
maxNodeVersion	string	Maximum node version supported by this package.
minNodeVersion	string	The minimum node version required by this package to function.
npmignore	projen.IgnoreFile	The .npmignore file.
prettier	projen.javascript.Prettier	No description.
publisher	projen.release.Publisher	Package publisher.
release	projen.release.Release	Release management.
upgradeWorkflow	projen.javascript.UpgradeDependencies	The upgrade workflow.
docsDirectory	string	No description.
libdir	string	The directory in which compiled .js files reside.
srcdir	string	The directory in which the .ts sources reside.
testdir	string	The directory in which tests reside.
tsconfigDev	projen.javascript.TypescriptConfig	A typescript configuration file which covers all files (sources, tests, projen).
watchTask	projen.Task	The "watch" task.
docgen	boolean	No description.
eslint	projen.javascript.Eslint	No description.
tsconfig	projen.javascript.TypescriptConfig	No description.
tsconfigEslint	projen.javascript.TypescriptConfig	No description.
appEntrypoint	string	The CDK8s app entrypoint.
cdk8sDeps	Cdk8sDeps	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

buildTask^Required

public readonly buildTask: Task;

• Type: projen.Task

---

commitGenerated^Required

public readonly commitGenerated: boolean;

• Type: boolean

Whether to commit the managed files by default.

---

compileTask^Required

public readonly compileTask: Task;

• Type: projen.Task

---

components^Required

public readonly components: Component[];

• Type: projen.Component[]

Returns all the components within this project.

---

deps^Required

public readonly deps: Dependencies;

• Type: projen.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: projen.FileBase[]

All files in this project.

---

gitattributes^Required

public readonly gitattributes: GitAttributesFile;

• Type: projen.GitAttributesFile

The .gitattributes file for this repository.

---

gitignore^Required

public readonly gitignore: IgnoreFile;

• Type: projen.IgnoreFile

.gitignore.

---

logger^Required

public readonly logger: Logger;

• Type: projen.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: projen.Task

---

postCompileTask^Required

public readonly postCompileTask: Task;

• Type: projen.Task

---

preCompileTask^Required

public readonly preCompileTask: Task;

• Type: projen.Task

---

projectBuild^Required

public readonly projectBuild: ProjectBuild;

• Type: projen.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: projen.Project

The root project.

---

subprojects^Required

public readonly subprojects: Project[];

• Type: projen.Project[]

Returns all the subprojects within this project.

---

tasks^Required

public readonly tasks: Tasks;

• Type: projen.Tasks

Project tasks.

---

testTask^Required

public readonly testTask: Task;

• Type: projen.Task

---

defaultTask^Optional

public readonly defaultTask: Task;

• Type: projen.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: projen.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: projen.Project

A parent project.

If undefined, this is the root project.

---

projectType^Required

public readonly projectType: ProjectType;

• Type: projen.ProjectType

---

autoApprove^Optional

public readonly autoApprove: AutoApprove;

• Type: projen.github.AutoApprove

Auto approve set up for this project.

---

devContainer^Optional

public readonly devContainer: DevContainer;

• Type: projen.vscode.DevContainer

Access for .devcontainer.json (used for GitHub Codespaces).

This will be undefined if devContainer boolean is false

---

github^Optional

public readonly github: GitHub;

• Type: projen.github.GitHub

Access all github components.

This will be undefined for subprojects.

---

gitpod^Optional

public readonly gitpod: Gitpod;

• Type: projen.Gitpod

Access for Gitpod.

This will be undefined if gitpod boolean is false

---

vscode^Optional

public readonly vscode: VsCode;

• Type: projen.vscode.VsCode

Access all VSCode components.

This will be undefined for subprojects.

---

allowLibraryDependencies^Required

• Deprecated: use package.allowLibraryDependencies

public readonly allowLibraryDependencies: boolean;

• Type: boolean

---

artifactsDirectory^Required

public readonly artifactsDirectory: string;

• Type: string

The build output directory.

An npm tarball will be created under the js subdirectory. For example, if this is set to dist (the default), the npm tarball will be placed under dist/js/boom-boom-1.2.3.tg.

---

artifactsJavascriptDirectory^Required

public readonly artifactsJavascriptDirectory: string;

• Type: string

The location of the npm tarball after build (${artifactsDirectory}/js).

---

bundler^Required

public readonly bundler: Bundler;

• Type: projen.javascript.Bundler

---

entrypoint^Required

• Deprecated: use package.entrypoint

public readonly entrypoint: string;

• Type: string

---

manifest^Required

• Deprecated: use package.addField(x, y)

public readonly manifest: any;

• Type: any

---

npmrc^Required

public readonly npmrc: NpmConfig;

• Type: projen.javascript.NpmConfig

The .npmrc file.

---

package^Required

public readonly package: NodePackage;

• Type: projen.javascript.NodePackage

API for managing the node package.

---

packageManager^Required

• Deprecated: use package.packageManager

public readonly packageManager: NodePackageManager;

• Type: projen.javascript.NodePackageManager

The package manager to use.

---

runScriptCommand^Required

public readonly runScriptCommand: string;

• Type: string

The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).

---

autoMerge^Optional

public readonly autoMerge: AutoMerge;

• Type: projen.github.AutoMerge

Component that sets up mergify for merging approved pull requests.

---

buildWorkflow^Optional

public readonly buildWorkflow: BuildWorkflow;

• Type: projen.build.BuildWorkflow

The PR build GitHub workflow.

undefined if buildWorkflow is disabled.

---

buildWorkflowJobId^Optional

public readonly buildWorkflowJobId: string;

• Type: string

The job ID of the build workflow.

---

jest^Optional

public readonly jest: Jest;

• Type: projen.javascript.Jest

The Jest configuration (if enabled).

---

maxNodeVersion^Optional

public readonly maxNodeVersion: string;

• Type: string

Maximum node version supported by this package.

The value indicates the package is incompatible with newer versions.

---

minNodeVersion^Optional

public readonly minNodeVersion: string;

• Type: string

The minimum node version required by this package to function.

This value indicates the package is incompatible with older versions.

---

npmignore^Optional

public readonly npmignore: IgnoreFile;

• Type: projen.IgnoreFile

The .npmignore file.

---

prettier^Optional

public readonly prettier: Prettier;

• Type: projen.javascript.Prettier

---

publisher^Optional

• Deprecated: use release.publisher.

public readonly publisher: Publisher;

• Type: projen.release.Publisher

Package publisher.

This will be undefined if the project does not have a release workflow.

---

release^Optional

public readonly release: Release;

• Type: projen.release.Release

Release management.

---

upgradeWorkflow^Optional

public readonly upgradeWorkflow: UpgradeDependencies;

• Type: projen.javascript.UpgradeDependencies

The upgrade workflow.

---

docsDirectory^Required

public readonly docsDirectory: string;

• Type: string

---

libdir^Required

public readonly libdir: string;

• Type: string

The directory in which compiled .js files reside.

---

srcdir^Required

public readonly srcdir: string;

• Type: string

The directory in which the .ts sources reside.

---

testdir^Required

public readonly testdir: string;

• Type: string

The directory in which tests reside.

---

tsconfigDev^Required

public readonly tsconfigDev: TypescriptConfig;

• Type: projen.javascript.TypescriptConfig

A typescript configuration file which covers all files (sources, tests, projen).

---

watchTask^Required

public readonly watchTask: Task;

• Type: projen.Task

The "watch" task.

---

docgen^Optional

public readonly docgen: boolean;

• Type: boolean

---

eslint^Optional

public readonly eslint: Eslint;

• Type: projen.javascript.Eslint

---

tsconfig^Optional

public readonly tsconfig: TypescriptConfig;

• Type: projen.javascript.TypescriptConfig

---

tsconfigEslint^Optional

public readonly tsconfigEslint: TypescriptConfig;

• Type: projen.javascript.TypescriptConfig

---

appEntrypoint^Required

public readonly appEntrypoint: string;

• Type: string

The CDK8s app entrypoint.

---

cdk8sDeps^Required

public readonly cdk8sDeps: Cdk8sDeps;

• Type: Cdk8sDeps

---

Constants

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

---

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.

---

DEFAULT_TS_JEST_TRANFORM_PATTERN^Required

public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;

• Type: string

---

ConstructLibraryCdk8s

CDK8s construct library project.

A multi-language (jsii) construct library which vends constructs designed to use within the CDK for Kubernetes (CDK8s), with a friendly workflow and automatic publishing to the construct catalog.

Initializers

import { cdk8s } from 'projen'

new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)

Name	Type	Description
options	ConstructLibraryCdk8sOptions	No description.

---

options^Required

• Type: ConstructLibraryCdk8sOptions

---

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	Adds patterns to be ignored by npm.
addTask	Adds a new task to this project.
addTip	Prints a "tip" message during synthesis.
annotateGenerated	Marks the provided file(s) as being 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.
addBins	No description.
addBundledDeps	Defines bundled dependencies.
addCompileCommand	DEPRECATED.
addDeps	Defines normal dependencies.
addDevDeps	Defines development/test dependencies.
addFields	Directly set fields in package.json.
addKeywords	Adds keywords to package.json (deduplicated).
addPeerDeps	Defines peer dependencies.
addScripts	Replaces the contents of multiple npm package.json scripts.
addTestCommand	DEPRECATED.
hasScript	Indicates if a script by the name name is defined.
removeScript	Removes the npm script (always successful).
renderWorkflowSetup	Returns the set of workflow steps which should be executed to bootstrap a workflow.
setScript	Replaces the contents of an npm package.json script.

---

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

Adds patterns to be ignored by npm.

pattern^Required

• Type: string

The pattern to ignore.

---

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

Marks the provided file(s) as being generated.

This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown.

https://github.com/github/linguist/blob/master/docs/overrides.md

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.

This will typically be npx projen TASK.

task^Required

• Type: projen.Task

The task for which the command is required.

---

synth

public synth(): void

Synthesize all project files into outdir.

1. Call "this.preSynthesize()"
2. Delete all generated files
3. Synthesize all subprojects
4. Synthesize all components of this project
5. Call "postSynthesize()" for all components of this project
6. 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.

---

addBins

public addBins(bins: {[ key: string ]: string}): void

bins^Required

• Type: {[ key: string ]: string}

---

addBundledDeps

public addBundledDeps(deps: ...string[]): void

Defines bundled dependencies.

Bundled dependencies will be added as normal dependencies as well as to the bundledDependencies section of your package.json.

deps^Required

• Type: ...string[]

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

---

addCompileCommand

public addCompileCommand(commands: ...string[]): void

DEPRECATED.

commands^Required

• Type: ...string[]

---

addDeps

public addDeps(deps: ...string[]): void

Defines normal dependencies.

deps^Required

• Type: ...string[]

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

---

addDevDeps

public addDevDeps(deps: ...string[]): void

Defines development/test dependencies.

deps^Required

• Type: ...string[]

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

---

addFields

public addFields(fields: {[ key: string ]: any}): void

Directly set fields in package.json.

fields^Required

• Type: {[ key: string ]: any}

The fields to set.

---

addKeywords

public addKeywords(keywords: ...string[]): void

Adds keywords to package.json (deduplicated).

keywords^Required

• Type: ...string[]

The keywords to add.

---

addPeerDeps

public addPeerDeps(deps: ...string[]): void

Defines peer dependencies.

When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers.

deps^Required

• Type: ...string[]

Names modules to install.

By default, the the dependency will be installed in the next npx projen run and the version will be recorded in your package.json file. You can upgrade manually or using yarn add/upgrade. If you wish to specify a version range use this syntax: module@^7.

---

addScripts

public addScripts(scripts: {[ key: string ]: string}): void

Replaces the contents of multiple npm package.json scripts.

scripts^Required

• Type: {[ key: string ]: string}

The scripts to set.

---

addTestCommand

public addTestCommand(commands: ...string[]): void

DEPRECATED.

commands^Required

• Type: ...string[]

---

hasScript

public hasScript(name: string): boolean

Indicates if a script by the name name is defined.

name^Required

• Type: string

The name of the script.

---

removeScript

public removeScript(name: string): void

Removes the npm script (always successful).

name^Required

• Type: string

The name of the script.

---

renderWorkflowSetup

public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]

Returns the set of workflow steps which should be executed to bootstrap a workflow.

options^Optional

• Type: projen.javascript.RenderWorkflowSetupOptions

Options.

---

setScript

public setScript(name: string, command: string): void

Replaces the contents of an npm package.json script.

name^Required

• Type: string

The script name.

---

command^Required

• Type: string

The command to execute.

---

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 { cdk8s } from 'projen'

cdk8s.ConstructLibraryCdk8s.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.

---

isProject

import { cdk8s } from 'projen'

cdk8s.ConstructLibraryCdk8s.isProject(x: any)

Test whether the given construct is a project.

x^Required

• Type: any

---

of

import { cdk8s } from 'projen'

cdk8s.ConstructLibraryCdk8s.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	projen.Task	No description.
commitGenerated	boolean	Whether to commit the managed files by default.
compileTask	projen.Task	No description.
components	projen.Component[]	Returns all the components within this project.
deps	projen.Dependencies	Project dependencies.
ejected	boolean	Whether or not the project is being ejected.
files	projen.FileBase[]	All files in this project.
gitattributes	projen.GitAttributesFile	The .gitattributes file for this repository.
gitignore	projen.IgnoreFile	.gitignore.
logger	projen.Logger	Logging utilities.
name	string	Project name.
outdir	string	Absolute output directory of this project.
packageTask	projen.Task	No description.
postCompileTask	projen.Task	No description.
preCompileTask	projen.Task	No description.
projectBuild	projen.ProjectBuild	Manages the build process of the project.
projenCommand	string	The command to use in order to run the projen CLI.
root	projen.Project	The root project.
subprojects	projen.Project[]	Returns all the subprojects within this project.
tasks	projen.Tasks	Project tasks.
testTask	projen.Task	No description.
defaultTask	projen.Task	This is the "default" task, the one that executes "projen".
initProject	projen.InitProject	The options used when this project is bootstrapped via projen new.
parent	projen.Project	A parent project.
projectType	projen.ProjectType	No description.
autoApprove	projen.github.AutoApprove	Auto approve set up for this project.
devContainer	projen.vscode.DevContainer	Access for .devcontainer.json (used for GitHub Codespaces).
github	projen.github.GitHub	Access all github components.
gitpod	projen.Gitpod	Access for Gitpod.
vscode	projen.vscode.VsCode	Access all VSCode components.
allowLibraryDependencies	boolean	No description.
artifactsDirectory	string	The build output directory.
artifactsJavascriptDirectory	string	The location of the npm tarball after build (${artifactsDirectory}/js).
bundler	projen.javascript.Bundler	No description.
entrypoint	string	No description.
manifest	any	No description.
npmrc	projen.javascript.NpmConfig	The .npmrc file.
package	projen.javascript.NodePackage	API for managing the node package.
packageManager	projen.javascript.NodePackageManager	The package manager to use.
runScriptCommand	string	The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).
autoMerge	projen.github.AutoMerge	Component that sets up mergify for merging approved pull requests.
buildWorkflow	projen.build.BuildWorkflow	The PR build GitHub workflow.
buildWorkflowJobId	string	The job ID of the build workflow.
jest	projen.javascript.Jest	The Jest configuration (if enabled).
maxNodeVersion	string	Maximum node version supported by this package.
minNodeVersion	string	The minimum node version required by this package to function.
npmignore	projen.IgnoreFile	The .npmignore file.
prettier	projen.javascript.Prettier	No description.
publisher	projen.release.Publisher	Package publisher.
release	projen.release.Release	Release management.
upgradeWorkflow	projen.javascript.UpgradeDependencies	The upgrade workflow.
docsDirectory	string	No description.
libdir	string	The directory in which compiled .js files reside.
srcdir	string	The directory in which the .ts sources reside.
testdir	string	The directory in which tests reside.
tsconfigDev	projen.javascript.TypescriptConfig	A typescript configuration file which covers all files (sources, tests, projen).
watchTask	projen.Task	The "watch" task.
docgen	boolean	No description.
eslint	projen.javascript.Eslint	No description.
tsconfig	projen.javascript.TypescriptConfig	No description.
tsconfigEslint	projen.javascript.TypescriptConfig	No description.
cdk8sVersion	string	The CDK8s version this app is using.
constructsVersion	string	The constructs version this app is using.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

buildTask^Required

public readonly buildTask: Task;

• Type: projen.Task

---

commitGenerated^Required

public readonly commitGenerated: boolean;

• Type: boolean

Whether to commit the managed files by default.

---

compileTask^Required

public readonly compileTask: Task;

• Type: projen.Task

---

components^Required

public readonly components: Component[];

• Type: projen.Component[]

Returns all the components within this project.

---

deps^Required

public readonly deps: Dependencies;

• Type: projen.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: projen.FileBase[]

All files in this project.

---

gitattributes^Required

public readonly gitattributes: GitAttributesFile;

• Type: projen.GitAttributesFile

The .gitattributes file for this repository.

---

gitignore^Required

public readonly gitignore: IgnoreFile;

• Type: projen.IgnoreFile

.gitignore.

---

logger^Required

public readonly logger: Logger;

• Type: projen.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: projen.Task

---

postCompileTask^Required

public readonly postCompileTask: Task;

• Type: projen.Task

---

preCompileTask^Required

public readonly preCompileTask: Task;

• Type: projen.Task

---

projectBuild^Required

public readonly projectBuild: ProjectBuild;

• Type: projen.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: projen.Project

The root project.

---

subprojects^Required

public readonly subprojects: Project[];

• Type: projen.Project[]

Returns all the subprojects within this project.

---

tasks^Required

public readonly tasks: Tasks;

• Type: projen.Tasks

Project tasks.

---

testTask^Required

public readonly testTask: Task;

• Type: projen.Task

---

defaultTask^Optional

public readonly defaultTask: Task;

• Type: projen.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: projen.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: projen.Project

A parent project.

If undefined, this is the root project.

---

projectType^Required

public readonly projectType: ProjectType;

• Type: projen.ProjectType

---

autoApprove^Optional

public readonly autoApprove: AutoApprove;

• Type: projen.github.AutoApprove

Auto approve set up for this project.

---

devContainer^Optional

public readonly devContainer: DevContainer;

• Type: projen.vscode.DevContainer

Access for .devcontainer.json (used for GitHub Codespaces).

This will be undefined if devContainer boolean is false

---

github^Optional

public readonly github: GitHub;

• Type: projen.github.GitHub

Access all github components.

This will be undefined for subprojects.

---

gitpod^Optional

public readonly gitpod: Gitpod;

• Type: projen.Gitpod

Access for Gitpod.

This will be undefined if gitpod boolean is false

---

vscode^Optional

public readonly vscode: VsCode;

• Type: projen.vscode.VsCode

Access all VSCode components.

This will be undefined for subprojects.

---

allowLibraryDependencies^Required

• Deprecated: use package.allowLibraryDependencies

public readonly allowLibraryDependencies: boolean;

• Type: boolean

---

artifactsDirectory^Required

public readonly artifactsDirectory: string;

• Type: string

The build output directory.

An npm tarball will be created under the js subdirectory. For example, if this is set to dist (the default), the npm tarball will be placed under dist/js/boom-boom-1.2.3.tg.

---

artifactsJavascriptDirectory^Required

public readonly artifactsJavascriptDirectory: string;

• Type: string

The location of the npm tarball after build (${artifactsDirectory}/js).

---

bundler^Required

public readonly bundler: Bundler;

• Type: projen.javascript.Bundler

---

entrypoint^Required

• Deprecated: use package.entrypoint

public readonly entrypoint: string;

• Type: string

---

manifest^Required

• Deprecated: use package.addField(x, y)

public readonly manifest: any;

• Type: any

---

npmrc^Required

public readonly npmrc: NpmConfig;

• Type: projen.javascript.NpmConfig

The .npmrc file.

---

package^Required

public readonly package: NodePackage;

• Type: projen.javascript.NodePackage

API for managing the node package.

---

packageManager^Required

• Deprecated: use package.packageManager

public readonly packageManager: NodePackageManager;

• Type: projen.javascript.NodePackageManager

The package manager to use.

---

runScriptCommand^Required

public readonly runScriptCommand: string;

• Type: string

The command to use to run scripts (e.g. yarn run or npm run depends on the package manager).

---

autoMerge^Optional

public readonly autoMerge: AutoMerge;

• Type: projen.github.AutoMerge

Component that sets up mergify for merging approved pull requests.

---

buildWorkflow^Optional

public readonly buildWorkflow: BuildWorkflow;

• Type: projen.build.BuildWorkflow

The PR build GitHub workflow.

undefined if buildWorkflow is disabled.

---

buildWorkflowJobId^Optional

public readonly buildWorkflowJobId: string;

• Type: string

The job ID of the build workflow.

---

jest^Optional

public readonly jest: Jest;

• Type: projen.javascript.Jest

The Jest configuration (if enabled).

---

maxNodeVersion^Optional

public readonly maxNodeVersion: string;

• Type: string

Maximum node version supported by this package.

The value indicates the package is incompatible with newer versions.

---

minNodeVersion^Optional

public readonly minNodeVersion: string;

• Type: string

The minimum node version required by this package to function.

This value indicates the package is incompatible with older versions.

---

npmignore^Optional

public readonly npmignore: IgnoreFile;

• Type: projen.IgnoreFile

The .npmignore file.

---

prettier^Optional

public readonly prettier: Prettier;

• Type: projen.javascript.Prettier

---

publisher^Optional

• Deprecated: use release.publisher.

public readonly publisher: Publisher;

• Type: projen.release.Publisher

Package publisher.

This will be undefined if the project does not have a release workflow.

---

release^Optional

public readonly release: Release;

• Type: projen.release.Release

Release management.

---

upgradeWorkflow^Optional

public readonly upgradeWorkflow: UpgradeDependencies;

• Type: projen.javascript.UpgradeDependencies

The upgrade workflow.

---

docsDirectory^Required

public readonly docsDirectory: string;

• Type: string

---

libdir^Required

public readonly libdir: string;

• Type: string

The directory in which compiled .js files reside.

---

srcdir^Required

public readonly srcdir: string;

• Type: string

The directory in which the .ts sources reside.

---

testdir^Required

public readonly testdir: string;

• Type: string

The directory in which tests reside.

---

tsconfigDev^Required

public readonly tsconfigDev: TypescriptConfig;

• Type: projen.javascript.TypescriptConfig

A typescript configuration file which covers all files (sources, tests, projen).

---

watchTask^Required

public readonly watchTask: Task;

• Type: projen.Task

The "watch" task.

---

docgen^Optional

public readonly docgen: boolean;

• Type: boolean

---

eslint^Optional

public readonly eslint: Eslint;

• Type: projen.javascript.Eslint

---

tsconfig^Optional

public readonly tsconfig: TypescriptConfig;

• Type: projen.javascript.TypescriptConfig

---

tsconfigEslint^Optional

public readonly tsconfigEslint: TypescriptConfig;

• Type: projen.javascript.TypescriptConfig

---

cdk8sVersion^Required

public readonly cdk8sVersion: string;

• Type: string

The CDK8s version this app is using.

---

constructsVersion^Required

public readonly constructsVersion: string;

• Type: string

The constructs version this app is using.

---

Constants

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

---

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.

---

DEFAULT_TS_JEST_TRANFORM_PATTERN^Required

public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;

• Type: string

---

IntegrationTest

CDK8S integration test.

Initializers

import { cdk8s } from 'projen'

new cdk8s.IntegrationTest(project: Project, options: IntegrationTestOptions)

Name	Type	Description
project	projen.Project	No description.
options	IntegrationTestOptions	No description.

---

project^Required

• Type: projen.Project

---

options^Required

• Type: IntegrationTestOptions

---

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 { cdk8s } from 'projen'

cdk8s.IntegrationTest.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 { cdk8s } from 'projen'

cdk8s.IntegrationTest.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	projen.Project	No description.
assertTask	projen.Task	Synthesizes the integration test and compares against a local copy (runs during build).
deployTask	projen.Task	Deploy the integration test and update the snapshot upon success.
snapshotTask	projen.Task	Just update snapshot (without deployment).

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

project^Required

public readonly project: Project;

• Type: projen.Project

---

assertTask^Required

public readonly assertTask: Task;

• Type: projen.Task

Synthesizes the integration test and compares against a local copy (runs during build).

---

deployTask^Required

public readonly deployTask: Task;

• Type: projen.Task

Deploy the integration test and update the snapshot upon success.

---

snapshotTask^Required

public readonly snapshotTask: Task;

• Type: projen.Task

Just update snapshot (without deployment).

---

IntegrationTestAutoDiscover

Discovers and creates integration tests from files in the test root.

Initializers

import { cdk8s } from 'projen'

new cdk8s.IntegrationTestAutoDiscover(project: Project, options: IntegrationTestAutoDiscoverOptions)

Name	Type	Description
project	projen.Project	No description.
options	IntegrationTestAutoDiscoverOptions	No description.

---

project^Required

• Type: projen.Project

---

options^Required

• Type: IntegrationTestAutoDiscoverOptions

---

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 { cdk8s } from 'projen'

cdk8s.IntegrationTestAutoDiscover.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 { cdk8s } from 'projen'

cdk8s.IntegrationTestAutoDiscover.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	projen.Project	No description.
entrypoints	string[]	Auto-discovered entry points with paths relative to the project directory.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

project^Required

public readonly project: Project;

• Type: projen.Project

---

entrypoints^Required

public readonly entrypoints: string[];

• Type: string[]

Auto-discovered entry points with paths relative to the project directory.

---

Structs

AutoDiscoverOptions

Options for AutoDiscover.

Initializer

import { cdk8s } from 'projen'

const autoDiscoverOptions: cdk8s.AutoDiscoverOptions = { ... }

Properties

Name	Type	Description
testdir	string	Test source tree.
tsconfigPath	string	Path to the tsconfig file to use for integration tests.
integrationTestAutoDiscover	boolean	Automatically discover integration tests.

---

testdir^Required

public readonly testdir: string;

• Type: string

Test source tree.

---

tsconfigPath^Required

public readonly tsconfigPath: string;

• Type: string

Path to the tsconfig file to use for integration tests.

---

integrationTestAutoDiscover^Optional

public readonly integrationTestAutoDiscover: boolean;

• Type: boolean
• Default: true

Automatically discover integration tests.

---

Cdk8sDepsCommonOptions

Options for Cdk8sDeps.

Initializer

import { cdk8s } from 'projen'

const cdk8sDepsCommonOptions: cdk8s.Cdk8sDepsCommonOptions = { ... }

Properties

Name	Type	Description
cdk8sVersion	string	Minimum version of the cdk8s to depend on.
cdk8sCliVersion	string	Minimum version of the cdk8s-cli to depend on.
cdk8sCliVersionPinning	boolean	Use pinned version instead of caret version for cdk8s-cli.
cdk8sPlus	boolean	Include cdk8s-plus.
cdk8sPlusVersion	string	Minimum version of the cdk8s-plus-XX to depend on.
cdk8sPlusVersionPinning	boolean	Use pinned version instead of caret version for cdk8s-plus-17.
cdk8sVersionPinning	boolean	Use pinned version instead of caret version for cdk8s.
constructsVersion	string	Minimum version of the constructs library to depend on.
constructsVersionPinning	boolean	Use pinned version instead of caret version for constructs.
k8sMinorVersion	number	The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.

---

cdk8sVersion^Required

public readonly cdk8sVersion: string;

• Type: string
• Default: "2.3.33"

Minimum version of the cdk8s to depend on.

---

cdk8sCliVersion^Optional

public readonly cdk8sCliVersion: string;

• Type: string
• Default: "2.0.28"

Minimum version of the cdk8s-cli to depend on.

---

cdk8sCliVersionPinning^Optional

public readonly cdk8sCliVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s-cli.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

cdk8sPlus^Optional

public readonly cdk8sPlus: boolean;

• Type: boolean
• Default: true

Include cdk8s-plus.

---

cdk8sPlusVersion^Optional

public readonly cdk8sPlusVersion: string;

• Type: string
• Default: "2.0.0-rc.26"

Minimum version of the cdk8s-plus-XX to depend on.

---

cdk8sPlusVersionPinning^Optional

public readonly cdk8sPlusVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s-plus-17.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

cdk8sVersionPinning^Optional

public readonly cdk8sVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

constructsVersion^Optional

public readonly constructsVersion: string;

• Type: string
• Default: "10.1.42"

Minimum version of the constructs library to depend on.

---

constructsVersionPinning^Optional

public readonly constructsVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for constructs.

You can use this to prevent yarn to mix versions for your consructs package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

k8sMinorVersion^Optional

public readonly k8sMinorVersion: number;

• Type: number
• Default: 22

The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.

---

Cdk8sDepsOptions

Initializer

import { cdk8s } from 'projen'

const cdk8sDepsOptions: cdk8s.Cdk8sDepsOptions = { ... }

Properties

Name	Type	Description
cdk8sVersion	string	Minimum version of the cdk8s to depend on.
cdk8sCliVersion	string	Minimum version of the cdk8s-cli to depend on.
cdk8sCliVersionPinning	boolean	Use pinned version instead of caret version for cdk8s-cli.
cdk8sPlus	boolean	Include cdk8s-plus.
cdk8sPlusVersion	string	Minimum version of the cdk8s-plus-XX to depend on.
cdk8sPlusVersionPinning	boolean	Use pinned version instead of caret version for cdk8s-plus-17.
cdk8sVersionPinning	boolean	Use pinned version instead of caret version for cdk8s.
constructsVersion	string	Minimum version of the constructs library to depend on.
constructsVersionPinning	boolean	Use pinned version instead of caret version for constructs.
k8sMinorVersion	number	The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.
cdk8sCliDependency	boolean	Add cdk8s-cli only to Node projects.
dependencyType	projen.DependencyType	The type of dependency to use for runtime CDK8s and constructs modules.

---

cdk8sVersion^Required

public readonly cdk8sVersion: string;

• Type: string
• Default: "2.3.33"

Minimum version of the cdk8s to depend on.

---

cdk8sCliVersion^Optional

public readonly cdk8sCliVersion: string;

• Type: string
• Default: "2.0.28"

Minimum version of the cdk8s-cli to depend on.

---

cdk8sCliVersionPinning^Optional

public readonly cdk8sCliVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s-cli.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

cdk8sPlus^Optional

public readonly cdk8sPlus: boolean;

• Type: boolean
• Default: true

Include cdk8s-plus.

---

cdk8sPlusVersion^Optional

public readonly cdk8sPlusVersion: string;

• Type: string
• Default: "2.0.0-rc.26"

Minimum version of the cdk8s-plus-XX to depend on.

---

cdk8sPlusVersionPinning^Optional

public readonly cdk8sPlusVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s-plus-17.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

cdk8sVersionPinning^Optional

public readonly cdk8sVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

constructsVersion^Optional

public readonly constructsVersion: string;

• Type: string
• Default: "10.1.42"

Minimum version of the constructs library to depend on.

---

constructsVersionPinning^Optional

public readonly constructsVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for constructs.

You can use this to prevent yarn to mix versions for your consructs package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

k8sMinorVersion^Optional

public readonly k8sMinorVersion: number;

• Type: number
• Default: 22

The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.

---

cdk8sCliDependency^Required

public readonly cdk8sCliDependency: boolean;

• Type: boolean
• Default: false

Add cdk8s-cli only to Node projects.

---

dependencyType^Required

public readonly dependencyType: DependencyType;

• Type: projen.DependencyType

The type of dependency to use for runtime CDK8s and constructs modules.

For libraries, use peer dependencies and for apps use runtime dependencies.

---

Cdk8sPackageNames

Initializer

import { cdk8s } from 'projen'

const cdk8sPackageNames: cdk8s.Cdk8sPackageNames = { ... }

Properties

Name	Type	Description
cdk8s	string	Fully qualified name of the core framework package.
cdk8sPlus	string	Fully qualified name of the cdk9s-plus-XX library package.
constructs	string	Fully qualified name of the constructs library package.
cdk8sClient	string	Fully qualified name of the client package.

---

cdk8s^Required

public readonly cdk8s: string;

• Type: string

Fully qualified name of the core framework package.

---

cdk8sPlus^Required

public readonly cdk8sPlus: string;

• Type: string

Fully qualified name of the cdk9s-plus-XX library package.

---

constructs^Required

public readonly constructs: string;

• Type: string

Fully qualified name of the constructs library package.

---

cdk8sClient^Optional

public readonly cdk8sClient: string;

• Type: string

Fully qualified name of the client package.

Used only on Node projects

---

Cdk8sPythonOptions

Options for Cdk8sPythonApp.

Initializer

import { cdk8s } from 'projen'

const cdk8sPythonOptions: cdk8s.Cdk8sPythonOptions = { ... }

Properties

Name	Type	Description
name	string	This is the name of your project.
commitGenerated	boolean	Whether to commit the managed files by default.
gitIgnoreOptions	projen.IgnoreFileOptions	Configuration options for .gitignore file.
gitOptions	projen.GitOptions	Configuration options for git.
logging	projen.LoggerOptions	Configure logging options such as verbosity.
outdir	string	The root directory of the project.
parent	projen.Project	The parent project, if this project is part of a bigger project.
projenCommand	string	The shell command to use in order to run the projen CLI.
projenrcJson	boolean	Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
projenrcJsonOptions	projen.ProjenrcJsonOptions	Options for .projenrc.json.
renovatebot	boolean	Use renovatebot to handle dependency upgrades.
renovatebotOptions	projen.RenovatebotOptions	Options for renovatebot.
autoApproveOptions	projen.github.AutoApproveOptions	Enable and configure the 'auto approve' workflow.
autoMerge	boolean	Enable automatic merging on GitHub.
autoMergeOptions	projen.github.AutoMergeOptions	Configure options for automatic merging on GitHub.
clobber	boolean	Add a clobber task which resets the repo to origin.
devContainer	boolean	Add a VSCode development environment (used for GitHub Codespaces).
github	boolean	Enable GitHub integration.
githubOptions	projen.github.GitHubOptions	Options for GitHub integration.
gitpod	boolean	Add a Gitpod development environment.
mergify	boolean	Whether mergify should be enabled on this repository or not.
mergifyOptions	projen.github.MergifyOptions	Options for mergify.
projectType	projen.ProjectType	Which type of project this is (library/app).
projenCredentials	projen.github.GithubCredentials	Choose a method of providing GitHub API access for projen workflows.
projenTokenSecret	string	The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
readme	projen.SampleReadmeProps	The README setup.
stale	boolean	Auto-close of stale issues and pull request.
staleOptions	projen.github.StaleOptions	Auto-close stale issues and pull requests.
vscode	boolean	Enable VSCode integration.
authorEmail	string	Author's e-mail.
authorName	string	Author's name.
version	string	Version of the package.
classifiers	string[]	A list of PyPI trove classifiers that describe the project.
description	string	A short description of the package.
homepage	string	A URL to the website of the project.
license	string	License of this package as an SPDX identifier.
packageName	string	Package name.
poetryOptions	projen.python.PoetryPyprojectOptionsWithoutDeps	Additional options to set for poetry if using poetry.
setupConfig	{[ key: string ]: any}	Additional fields to pass in the setup() function if using setuptools.
pythonExec	string	Path to the python executable to use.
moduleName	string	Name of the python package as used in imports and filenames.
deps	string[]	List of runtime dependencies for this project.
devDeps	string[]	List of dev dependencies for this project.
pip	boolean	Use pip with a requirements.txt file to track project dependencies.
poetry	boolean	Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
projenrcJs	boolean	Use projenrc in javascript.
projenrcJsOptions	projen.javascript.ProjenrcOptions	Options related to projenrc in JavaScript.
projenrcPython	boolean	Use projenrc in Python.
projenrcPythonOptions	projen.python.ProjenrcOptions	Options related to projenrc in python.
projenrcTs	boolean	Use projenrc in TypeScript.
projenrcTsOptions	projen.typescript.ProjenrcTsOptions	Options related to projenrc in TypeScript.
pytest	boolean	Include pytest tests.
pytestOptions	projen.python.PytestOptions	pytest options.
sample	boolean	Include sample code and test if the relevant directories don't exist.
sampleTestdir	string	Location of sample tests.
setuptools	boolean	Use setuptools with a setup.py script for packaging and publishing.
venv	boolean	Use venv to manage a virtual environment for installing dependencies inside.
venvOptions	projen.python.VenvOptions	Venv options.
cdk8sVersion	string	Minimum version of the cdk8s to depend on.
cdk8sCliVersion	string	Minimum version of the cdk8s-cli to depend on.
cdk8sCliVersionPinning	boolean	Use pinned version instead of caret version for cdk8s-cli.
cdk8sPlus	boolean	Include cdk8s-plus.
cdk8sPlusVersion	string	Minimum version of the cdk8s-plus-XX to depend on.
cdk8sPlusVersionPinning	boolean	Use pinned version instead of caret version for cdk8s-plus-17.
cdk8sVersionPinning	boolean	Use pinned version instead of caret version for cdk8s.
constructsVersion	string	Minimum version of the constructs library to depend on.
constructsVersionPinning	boolean	Use pinned version instead of caret version for constructs.
k8sMinorVersion	number	The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.
appEntrypoint	string	The CDK8s app's entrypoint.
cdk8sImports	string[]	Import additional specs.
k8sSpecVersion	string	Import a specific Kubernetes spec version.

---

name^Required

public readonly name: string;

• Type: string
• Default: $BASEDIR

This is the name of your project.

---

commitGenerated^Optional

public readonly commitGenerated: boolean;

• Type: boolean
• Default: true

Whether to commit the managed files by default.

---

gitIgnoreOptions^Optional

public readonly gitIgnoreOptions: IgnoreFileOptions;

• Type: projen.IgnoreFileOptions

Configuration options for .gitignore file.

---

gitOptions^Optional

public readonly gitOptions: GitOptions;

• Type: projen.GitOptions

Configuration options for git.

---

logging^Optional

public readonly logging: LoggerOptions;

• Type: projen.LoggerOptions
• Default: {}

Configure logging options such as verbosity.

---

outdir^Optional

public readonly outdir: string;

• Type: string
• Default: "."

The root directory of the project.

Relative to this directory, all files are synthesized.

If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other subprojects.

---

parent^Optional

public readonly parent: Project;

• Type: projen.Project

The parent project, if this project is part of a bigger project.

---

projenCommand^Optional

public readonly projenCommand: string;

• Type: string
• Default: "npx projen"

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

Can be used to customize in special environments.

---

projenrcJson^Optional

public readonly projenrcJson: boolean;

• Type: boolean
• Default: false

Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

---

projenrcJsonOptions^Optional

public readonly projenrcJsonOptions: ProjenrcJsonOptions;

• Type: projen.ProjenrcJsonOptions
• Default: default options

Options for .projenrc.json.

---

renovatebot^Optional

public readonly renovatebot: boolean;

• Type: boolean
• Default: false

Use renovatebot to handle dependency upgrades.

---

renovatebotOptions^Optional

public readonly renovatebotOptions: RenovatebotOptions;

• Type: projen.RenovatebotOptions
• Default: default options

Options for renovatebot.

---

autoApproveOptions^Optional

public readonly autoApproveOptions: AutoApproveOptions;

• Type: projen.github.AutoApproveOptions
• Default: auto approve is disabled

Enable and configure the 'auto approve' workflow.

---

autoMerge^Optional

public readonly autoMerge: boolean;

• Type: boolean
• Default: true

Enable automatic merging on GitHub.

Has no effect if github.mergify is set to false.

---

autoMergeOptions^Optional

public readonly autoMergeOptions: AutoMergeOptions;

• Type: projen.github.AutoMergeOptions
• Default: see defaults in AutoMergeOptions

Configure options for automatic merging on GitHub.

Has no effect if github.mergify or autoMerge is set to false.

---

clobber^Optional

public readonly clobber: boolean;

• Type: boolean
• Default: true, but false for subprojects

Add a clobber task which resets the repo to origin.

---

devContainer^Optional

public readonly devContainer: boolean;

• Type: boolean
• Default: false

Add a VSCode development environment (used for GitHub Codespaces).

---

github^Optional

public readonly github: boolean;

• Type: boolean
• Default: true

Enable GitHub integration.

Enabled by default for root projects. Disabled for non-root projects.

---

githubOptions^Optional

public readonly githubOptions: GitHubOptions;

• Type: projen.github.GitHubOptions
• Default: see GitHubOptions

Options for GitHub integration.

---

gitpod^Optional

public readonly gitpod: boolean;

• Type: boolean
• Default: false

Add a Gitpod development environment.

---

mergify^Optional

• Deprecated: use githubOptions.mergify instead

public readonly mergify: boolean;

• Type: boolean
• Default: true

Whether mergify should be enabled on this repository or not.

---

mergifyOptions^Optional

• Deprecated: use githubOptions.mergifyOptions instead

public readonly mergifyOptions: MergifyOptions;

• Type: projen.github.MergifyOptions
• Default: default options

Options for mergify.

---

projectType^Optional

• Deprecated: no longer supported at the base project level

public readonly projectType: ProjectType;

• Type: projen.ProjectType
• Default: ProjectType.UNKNOWN

Which type of project this is (library/app).

---

projenCredentials^Optional

public readonly projenCredentials: GithubCredentials;

• Type: projen.github.GithubCredentials
• Default: use a personal access token named PROJEN_GITHUB_TOKEN

Choose a method of providing GitHub API access for projen workflows.

---

projenTokenSecret^Optional

• Deprecated: use projenCredentials

public readonly projenTokenSecret: string;

• Type: string
• Default: "PROJEN_GITHUB_TOKEN"

The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.

This token needs to have the repo, workflows and packages scope.

---

readme^Optional

public readonly readme: SampleReadmeProps;

• Type: projen.SampleReadmeProps
• Default: { filename: 'README.md', contents: '# replace this' }

The README setup.

---

Example

"{ filename: 'readme.md', contents: '# title' }"

stale^Optional

public readonly stale: boolean;

• Type: boolean
• Default: false

Auto-close of stale issues and pull request.

See staleOptions for options.

---

staleOptions^Optional

public readonly staleOptions: StaleOptions;

• Type: projen.github.StaleOptions
• Default: see defaults in StaleOptions

Auto-close stale issues and pull requests.

To disable set stale to false.

---

vscode^Optional

public readonly vscode: boolean;

• Type: boolean
• Default: true

Enable VSCode integration.

Enabled by default for root projects. Disabled for non-root projects.

---

authorEmail^Required

public readonly authorEmail: string;

• Type: string
• Default: $GIT_USER_EMAIL

Author's e-mail.

---

authorName^Required

public readonly authorName: string;

• Type: string
• Default: $GIT_USER_NAME

Author's name.

---

version^Required

public readonly version: string;

• Type: string
• Default: "0.1.0"

Version of the package.

---

classifiers^Optional

public readonly classifiers: string[];

• Type: string[]

A list of PyPI trove classifiers that describe the project.

https://pypi.org/classifiers/

---

description^Optional

public readonly description: string;

• Type: string

A short description of the package.

---

homepage^Optional

public readonly homepage: string;

• Type: string

A URL to the website of the project.

---

license^Optional

public readonly license: string;

• Type: string

License of this package as an SPDX identifier.

---

packageName^Optional

public readonly packageName: string;

• Type: string

Package name.

---

poetryOptions^Optional

public readonly poetryOptions: PoetryPyprojectOptionsWithoutDeps;

• Type: projen.python.PoetryPyprojectOptionsWithoutDeps

Additional options to set for poetry if using poetry.

---

setupConfig^Optional

public readonly setupConfig: {[ key: string ]: any};

• Type: {[ key: string ]: any}

Additional fields to pass in the setup() function if using setuptools.

---

pythonExec^Optional

public readonly pythonExec: string;

• Type: string
• Default: "python"

Path to the python executable to use.

---

moduleName^Required

public readonly moduleName: string;

• Type: string
• Default: $PYTHON_MODULE_NAME

Name of the python package as used in imports and filenames.

Must only consist of alphanumeric characters and underscores.

---

deps^Optional

public readonly deps: string[];

• Type: string[]
• Default: []

List of runtime dependencies for this project.

Dependencies use the format: <module>@<semver>

Additional dependencies can be added via project.addDependency().

---

devDeps^Optional

public readonly devDeps: string[];

• Type: string[]
• Default: []

List of dev dependencies for this project.

Dependencies use the format: <module>@<semver>

Additional dependencies can be added via project.addDevDependency().

---

pip^Optional

public readonly pip: boolean;

• Type: boolean
• Default: true, unless poetry is true, then false

Use pip with a requirements.txt file to track project dependencies.

---

poetry^Optional

public readonly poetry: boolean;

• Type: boolean
• Default: false

Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.

This feature is incompatible with pip, setuptools, or venv. If you set this option to true, then pip, setuptools, and venv must be set to false.

---

projenrcJs^Optional

public readonly projenrcJs: boolean;

• Type: boolean
• Default: false

Use projenrc in javascript.

This will install projen as a JavaScript dependency and add a synth task which will run .projenrc.js.

---

projenrcJsOptions^Optional

public readonly projenrcJsOptions: ProjenrcOptions;

• Type: projen.javascript.ProjenrcOptions
• Default: default options

Options related to projenrc in JavaScript.

---

projenrcPython^Optional

public readonly projenrcPython: boolean;

• Type: boolean
• Default: true

Use projenrc in Python.

This will install projen as a Python dependency and add a synth task which will run .projenrc.py.

---

projenrcPythonOptions^Optional

public readonly projenrcPythonOptions: ProjenrcOptions;

• Type: projen.python.ProjenrcOptions
• Default: default options

Options related to projenrc in python.

---

projenrcTs^Optional

public readonly projenrcTs: boolean;

• Type: boolean
• Default: false

Use projenrc in TypeScript.

This will create a tsconfig file (default: tsconfig.projen.json) and use ts-node in the default task to parse the project source files.

---

projenrcTsOptions^Optional

public readonly projenrcTsOptions: ProjenrcTsOptions;

• Type: projen.typescript.ProjenrcTsOptions
• Default: default options

Options related to projenrc in TypeScript.

---

pytest^Optional

public readonly pytest: boolean;

• Type: boolean
• Default: true

Include pytest tests.

---

pytestOptions^Optional

public readonly pytestOptions: PytestOptions;

• Type: projen.python.PytestOptions
• Default: defaults

pytest options.

---

sample^Optional

public readonly sample: boolean;

• Type: boolean
• Default: true

Include sample code and test if the relevant directories don't exist.

---

sampleTestdir^Optional

public readonly sampleTestdir: string;

• Type: string
• Default: "tests"

Location of sample tests.

Typically the same directory where project tests will be located.

---

setuptools^Optional

public readonly setuptools: boolean;

• Type: boolean
• Default: true, unless poetry is true, then false

Use setuptools with a setup.py script for packaging and publishing.

---

venv^Optional

public readonly venv: boolean;

• Type: boolean
• Default: true, unless poetry is true, then false

Use venv to manage a virtual environment for installing dependencies inside.

---

venvOptions^Optional

public readonly venvOptions: VenvOptions;

• Type: projen.python.VenvOptions
• Default: defaults

Venv options.

---

cdk8sVersion^Required

public readonly cdk8sVersion: string;

• Type: string
• Default: "2.3.33"

Minimum version of the cdk8s to depend on.

---

cdk8sCliVersion^Optional

public readonly cdk8sCliVersion: string;

• Type: string
• Default: "2.0.28"

Minimum version of the cdk8s-cli to depend on.

---

cdk8sCliVersionPinning^Optional

public readonly cdk8sCliVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s-cli.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

cdk8sPlus^Optional

public readonly cdk8sPlus: boolean;

• Type: boolean
• Default: true

Include cdk8s-plus.

---

cdk8sPlusVersion^Optional

public readonly cdk8sPlusVersion: string;

• Type: string
• Default: "2.0.0-rc.26"

Minimum version of the cdk8s-plus-XX to depend on.

---

cdk8sPlusVersionPinning^Optional

public readonly cdk8sPlusVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s-plus-17.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

cdk8sVersionPinning^Optional

public readonly cdk8sVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

constructsVersion^Optional

public readonly constructsVersion: string;

• Type: string
• Default: "10.1.42"

Minimum version of the constructs library to depend on.

---

constructsVersionPinning^Optional

public readonly constructsVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for constructs.

You can use this to prevent yarn to mix versions for your consructs package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

k8sMinorVersion^Optional

public readonly k8sMinorVersion: number;

• Type: number
• Default: 22

The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.

---

appEntrypoint^Optional

public readonly appEntrypoint: string;

• Type: string
• Default: "app.py"

The CDK8s app's entrypoint.

---

cdk8sImports^Optional

public readonly cdk8sImports: string[];

• Type: string[]
• Default: no additional specs imported

Import additional specs.

---

k8sSpecVersion^Optional

public readonly k8sSpecVersion: string;

• Type: string
• Default: Use the cdk8s default

Import a specific Kubernetes spec version.

---

Cdk8sTypeScriptAppOptions

Initializer

import { cdk8s } from 'projen'

const cdk8sTypeScriptAppOptions: cdk8s.Cdk8sTypeScriptAppOptions = { ... }

Properties

Name	Type	Description
name	string	This is the name of your project.
commitGenerated	boolean	Whether to commit the managed files by default.
gitIgnoreOptions	projen.IgnoreFileOptions	Configuration options for .gitignore file.
gitOptions	projen.GitOptions	Configuration options for git.
logging	projen.LoggerOptions	Configure logging options such as verbosity.
outdir	string	The root directory of the project.
parent	projen.Project	The parent project, if this project is part of a bigger project.
projenCommand	string	The shell command to use in order to run the projen CLI.
projenrcJson	boolean	Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
projenrcJsonOptions	projen.ProjenrcJsonOptions	Options for .projenrc.json.
renovatebot	boolean	Use renovatebot to handle dependency upgrades.
renovatebotOptions	projen.RenovatebotOptions	Options for renovatebot.
autoApproveOptions	projen.github.AutoApproveOptions	Enable and configure the 'auto approve' workflow.
autoMerge	boolean	Enable automatic merging on GitHub.
autoMergeOptions	projen.github.AutoMergeOptions	Configure options for automatic merging on GitHub.
clobber	boolean	Add a clobber task which resets the repo to origin.
devContainer	boolean	Add a VSCode development environment (used for GitHub Codespaces).
github	boolean	Enable GitHub integration.
githubOptions	projen.github.GitHubOptions	Options for GitHub integration.
gitpod	boolean	Add a Gitpod development environment.
mergify	boolean	Whether mergify should be enabled on this repository or not.
mergifyOptions	projen.github.MergifyOptions	Options for mergify.
projectType	projen.ProjectType	Which type of project this is (library/app).
projenCredentials	projen.github.GithubCredentials	Choose a method of providing GitHub API access for projen workflows.
projenTokenSecret	string	The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
readme	projen.SampleReadmeProps	The README setup.
stale	boolean	Auto-close of stale issues and pull request.
staleOptions	projen.github.StaleOptions	Auto-close stale issues and pull requests.
vscode	boolean	Enable VSCode integration.
allowLibraryDependencies	boolean	Allow the project to include peerDependencies and bundledDependencies.
authorEmail	string	Author's e-mail.
authorName	string	Author's name.
authorOrganization	boolean	Is the author an organization.
authorUrl	string	Author's URL / Website.
autoDetectBin	boolean	Automatically add all executables under the bin directory to your package.json file under the bin section.
bin	{[ key: string ]: string}	Binary programs vended with your module.
bugsEmail	string	The email address to which issues should be reported.
bugsUrl	string	The url to your project's issue tracker.
bundledDeps	string[]	List of dependencies to bundle into this module.
codeArtifactOptions	projen.javascript.CodeArtifactOptions	Options for npm packages using AWS CodeArtifact.
deps	string[]	Runtime dependencies of this module.
description	string	The description is just a string that helps people understand the purpose of the package.
devDeps	string[]	Build dependencies for this module.
entrypoint	string	Module entrypoint (main in package.json).
homepage	string	Package's Homepage / Website.
keywords	string[]	Keywords to include in package.json.
license	string	License's SPDX identifier.
licensed	boolean	Indicates if a license should be added.
maxNodeVersion	string	The maximum node version supported by this package. Most projects should not use this option.
minNodeVersion	string	The minimum node version required by this package to function. Most projects should not use this option.
npmAccess	projen.javascript.NpmAccess	Access level of the npm package.
npmProvenance	boolean	Should provenance statements be generated when the package is published.
npmRegistry	string	The host name of the npm registry to publish to.
npmRegistryUrl	string	The base URL of the npm package registry.
npmTokenSecret	string	GitHub secret which contains the NPM token to use when publishing packages.
packageManager	projen.javascript.NodePackageManager	The Node Package Manager used to execute scripts.
packageName	string	The "name" in package.json.
peerDependencyOptions	projen.javascript.PeerDependencyOptions	Options for peerDeps.
peerDeps	string[]	Peer dependencies for this module.
pnpmVersion	string	The version of PNPM to use if using PNPM as a package manager.
repository	string	The repository is the location where the actual code for your package lives.
repositoryDirectory	string	If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
scopedPackagesOptions	projen.javascript.ScopedPackagesOptions[]	Options for privately hosted scoped packages.
scripts	{[ key: string ]: string}	npm scripts to include.
stability	string	Package's Stability.
yarnBerryOptions	projen.javascript.YarnBerryOptions	Options for Yarn Berry.
bumpPackage	string	The commit-and-tag-version compatible package used to bump the package version, as a dependency string.
jsiiReleaseVersion	string	Version requirement of publib which is used to publish modules to npm.
majorVersion	number	Major version to release from the default branch.
minMajorVersion	number	Minimal Major version to release.
nextVersionCommand	string	A shell command to control the next version to release.
npmDistTag	string	The npmDistTag to use when publishing from the default branch.
postBuildSteps	projen.github.workflows.JobStep[]	Steps to execute after build as part of the release workflow.
prerelease	string	Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
publishDryRun	boolean	Instead of actually publishing to package managers, just print the publishing command.
publishTasks	boolean	Define publishing tasks that can be executed manually as well as workflows.
releasableCommits	projen.ReleasableCommits	Find commits that should be considered releasable Used to decide if a release is required.
releaseBranches	{[ key: string ]: projen.release.BranchOptions}	Defines additional release branches.
releaseEveryCommit	boolean	Automatically release new versions every commit to one of branches in releaseBranches.
releaseFailureIssue	boolean	Create a github issue on every failed publishing task.
releaseFailureIssueLabel	string	The label to apply to issues indicating publish failures.
releaseSchedule	string	CRON schedule to trigger new releases.
releaseTagPrefix	string	Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
releaseTrigger	projen.release.ReleaseTrigger	The release trigger to use.
releaseWorkflowName	string	The name of the default release workflow.
releaseWorkflowSetupSteps	projen.github.workflows.JobStep[]	A set of workflow steps to execute in order to setup the workflow container.
versionrcOptions	{[ key: string ]: any}	Custom configuration used when creating changelog with commit-and-tag-version package.
workflowContainerImage	string	Container image to use for GitHub workflows.
workflowRunsOn	string[]	Github Runner selection labels.
workflowRunsOnGroup	projen.GroupRunnerOptions	Github Runner Group selection options.
defaultReleaseBranch	string	The name of the main release branch.
artifactsDirectory	string	A directory which will contain build artifacts.
autoApproveUpgrades	boolean	Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
buildWorkflow	boolean	Define a GitHub workflow for building PRs.
buildWorkflowOptions	projen.javascript.BuildWorkflowOptions	Options for PR build workflow.
buildWorkflowTriggers	projen.github.workflows.Triggers	Build workflow triggers.
bundlerOptions	projen.javascript.BundlerOptions	Options for Bundler.
checkLicenses	projen.javascript.LicenseCheckerOptions	Configure which licenses should be deemed acceptable for use by dependencies.
codeCov	boolean	Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with @codeCovTokenSecret.
codeCovTokenSecret	string	Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
copyrightOwner	string	License copyright owner.
copyrightPeriod	string	The copyright years to put in the LICENSE file.
dependabot	boolean	Use dependabot to handle dependency upgrades.
dependabotOptions	projen.github.DependabotOptions	Options for dependabot.
depsUpgrade	boolean	Use tasks and github workflows to handle dependency upgrades.
depsUpgradeOptions	projen.javascript.UpgradeDependenciesOptions	Options for UpgradeDependencies.
gitignore	string[]	Additional entries to .gitignore.
jest	boolean	Setup jest unit tests.
jestOptions	projen.javascript.JestOptions	Jest options.
mutableBuild	boolean	Automatically update files modified during builds to pull-request branches.
npmignore	string[]	Additional entries to .npmignore.
npmignoreEnabled	boolean	Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
npmIgnoreOptions	projen.IgnoreFileOptions	Configuration options for .npmignore file.
package	boolean	Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
prettier	boolean	Setup prettier.
prettierOptions	projen.javascript.PrettierOptions	Prettier options.
projenDevDependency	boolean	Indicates of "projen" should be installed as a devDependency.
projenrcJs	boolean	Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
projenrcJsOptions	projen.javascript.ProjenrcOptions	Options for .projenrc.js.
projenVersion	string	Version of projen to install.
pullRequestTemplate	boolean	Include a GitHub pull request template.
pullRequestTemplateContents	string[]	The contents of the pull request template.
release	boolean	Add release management to this project.
releaseToNpm	boolean	Automatically release to npm when new versions are introduced.
releaseWorkflow	boolean	DEPRECATED: renamed to release.
workflowBootstrapSteps	projen.github.workflows.JobStep[]	Workflow steps to use in order to bootstrap this repo.
workflowGitIdentity	projen.github.GitIdentity	The git identity to use in workflows.
workflowNodeVersion	string	The node version used in GitHub Actions workflows.
workflowPackageCache	boolean	Enable Node.js package cache in GitHub workflows.
disableTsconfig	boolean	Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
disableTsconfigDev	boolean	Do not generate a tsconfig.dev.json file.
docgen	boolean	Docgen by Typedoc.
docsDirectory	string	Docs directory.
entrypointTypes	string	The .d.ts file that includes the type declarations for this module.
eslint	boolean	Setup eslint.
eslintOptions	projen.javascript.EslintOptions	Eslint options.
libdir	string	Typescript artifacts output directory.
projenrcTs	boolean	Use TypeScript for your projenrc file (.projenrc.ts).
projenrcTsOptions	projen.typescript.ProjenrcOptions	Options for .projenrc.ts.
sampleCode	boolean	Generate one-time sample in src/ and test/ if there are no files there.
srcdir	string	Typescript sources directory.
testdir	string	Jest tests directory. Tests files should be named xxx.test.ts.
tsconfig	projen.javascript.TypescriptConfigOptions	Custom TSConfig.
tsconfigDev	projen.javascript.TypescriptConfigOptions	Custom tsconfig options for the development tsconfig.json file (used for testing).
tsconfigDevFile	string	The name of the development tsconfig.json file.
tsJestOptions	projen.typescript.TsJestOptions	Options for ts-jest.
typescriptVersion	string	TypeScript version to use.
cdk8sVersion	string	Minimum version of the cdk8s to depend on.
cdk8sCliVersion	string	Minimum version of the cdk8s-cli to depend on.
cdk8sCliVersionPinning	boolean	Use pinned version instead of caret version for cdk8s-cli.
cdk8sPlus	boolean	Include cdk8s-plus.
cdk8sPlusVersion	string	Minimum version of the cdk8s-plus-XX to depend on.
cdk8sPlusVersionPinning	boolean	Use pinned version instead of caret version for cdk8s-plus-17.
cdk8sVersionPinning	boolean	Use pinned version instead of caret version for cdk8s.
constructsVersion	string	Minimum version of the constructs library to depend on.
constructsVersionPinning	boolean	Use pinned version instead of caret version for constructs.
k8sMinorVersion	number	The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.
appEntrypoint	string	The CDK8s app's entrypoint (relative to the source directory, which is "src" by default).
cdk8sImports	string[]	Import additional specs.
integrationTestAutoDiscover	boolean	Automatically adds an cdk8s.IntegrationTest for each .integ.ts app in your test directory. If this is disabled, you can manually add an cdk8s.AutoDiscover component to your project.
k8sSpecVersion	string	Import a specific Kubernetes spec version.

---

name^Required

public readonly name: string;

• Type: string
• Default: $BASEDIR

This is the name of your project.

---

commitGenerated^Optional

public readonly commitGenerated: boolean;

• Type: boolean
• Default: true

Whether to commit the managed files by default.

---

gitIgnoreOptions^Optional

public readonly gitIgnoreOptions: IgnoreFileOptions;

• Type: projen.IgnoreFileOptions

Configuration options for .gitignore file.

---

gitOptions^Optional

public readonly gitOptions: GitOptions;

• Type: projen.GitOptions

Configuration options for git.

---

logging^Optional

public readonly logging: LoggerOptions;

• Type: projen.LoggerOptions
• Default: {}

Configure logging options such as verbosity.

---

outdir^Optional

public readonly outdir: string;

• Type: string
• Default: "."

The root directory of the project.

Relative to this directory, all files are synthesized.

If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other subprojects.

---

parent^Optional

public readonly parent: Project;

• Type: projen.Project

The parent project, if this project is part of a bigger project.

---

projenCommand^Optional

public readonly projenCommand: string;

• Type: string
• Default: "npx projen"

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

Can be used to customize in special environments.

---

projenrcJson^Optional

public readonly projenrcJson: boolean;

• Type: boolean
• Default: false

Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

---

projenrcJsonOptions^Optional

public readonly projenrcJsonOptions: ProjenrcJsonOptions;

• Type: projen.ProjenrcJsonOptions
• Default: default options

Options for .projenrc.json.

---

renovatebot^Optional

public readonly renovatebot: boolean;

• Type: boolean
• Default: false

Use renovatebot to handle dependency upgrades.

---

renovatebotOptions^Optional

public readonly renovatebotOptions: RenovatebotOptions;

• Type: projen.RenovatebotOptions
• Default: default options

Options for renovatebot.

---

autoApproveOptions^Optional

public readonly autoApproveOptions: AutoApproveOptions;

• Type: projen.github.AutoApproveOptions
• Default: auto approve is disabled

Enable and configure the 'auto approve' workflow.

---

autoMerge^Optional

public readonly autoMerge: boolean;

• Type: boolean
• Default: true

Enable automatic merging on GitHub.

Has no effect if github.mergify is set to false.

---

autoMergeOptions^Optional

public readonly autoMergeOptions: AutoMergeOptions;

• Type: projen.github.AutoMergeOptions
• Default: see defaults in AutoMergeOptions

Configure options for automatic merging on GitHub.

Has no effect if github.mergify or autoMerge is set to false.

---

clobber^Optional

public readonly clobber: boolean;

• Type: boolean
• Default: true, but false for subprojects

Add a clobber task which resets the repo to origin.

---

devContainer^Optional

public readonly devContainer: boolean;

• Type: boolean
• Default: false

Add a VSCode development environment (used for GitHub Codespaces).

---

github^Optional

public readonly github: boolean;

• Type: boolean
• Default: true

Enable GitHub integration.

Enabled by default for root projects. Disabled for non-root projects.

---

githubOptions^Optional

public readonly githubOptions: GitHubOptions;

• Type: projen.github.GitHubOptions
• Default: see GitHubOptions

Options for GitHub integration.

---

gitpod^Optional

public readonly gitpod: boolean;

• Type: boolean
• Default: false

Add a Gitpod development environment.

---

mergify^Optional

• Deprecated: use githubOptions.mergify instead

public readonly mergify: boolean;

• Type: boolean
• Default: true

Whether mergify should be enabled on this repository or not.

---

mergifyOptions^Optional

• Deprecated: use githubOptions.mergifyOptions instead

public readonly mergifyOptions: MergifyOptions;

• Type: projen.github.MergifyOptions
• Default: default options

Options for mergify.

---

projectType^Optional

• Deprecated: no longer supported at the base project level

public readonly projectType: ProjectType;

• Type: projen.ProjectType
• Default: ProjectType.UNKNOWN

Which type of project this is (library/app).

---

projenCredentials^Optional

public readonly projenCredentials: GithubCredentials;

• Type: projen.github.GithubCredentials
• Default: use a personal access token named PROJEN_GITHUB_TOKEN

Choose a method of providing GitHub API access for projen workflows.

---

projenTokenSecret^Optional

• Deprecated: use projenCredentials

public readonly projenTokenSecret: string;

• Type: string
• Default: "PROJEN_GITHUB_TOKEN"

The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.

This token needs to have the repo, workflows and packages scope.

---

readme^Optional

public readonly readme: SampleReadmeProps;

• Type: projen.SampleReadmeProps
• Default: { filename: 'README.md', contents: '# replace this' }

The README setup.

---

Example

"{ filename: 'readme.md', contents: '# title' }"

stale^Optional

public readonly stale: boolean;

• Type: boolean
• Default: false

Auto-close of stale issues and pull request.

See staleOptions for options.

---

staleOptions^Optional

public readonly staleOptions: StaleOptions;

• Type: projen.github.StaleOptions
• Default: see defaults in StaleOptions

Auto-close stale issues and pull requests.

To disable set stale to false.

---

vscode^Optional

public readonly vscode: boolean;

• Type: boolean
• Default: true

Enable VSCode integration.

Enabled by default for root projects. Disabled for non-root projects.

---

allowLibraryDependencies^Optional

public readonly allowLibraryDependencies: boolean;

• Type: boolean
• Default: true

Allow the project to include peerDependencies and bundledDependencies.

This is normally only allowed for libraries. For apps, there's no meaning for specifying these.

---

authorEmail^Optional

public readonly authorEmail: string;

• Type: string

Author's e-mail.

---

authorName^Optional

public readonly authorName: string;

• Type: string

Author's name.

---

authorOrganization^Optional

public readonly authorOrganization: boolean;

• Type: boolean

Is the author an organization.

---

authorUrl^Optional

public readonly authorUrl: string;

• Type: string

Author's URL / Website.

---

autoDetectBin^Optional

public readonly autoDetectBin: boolean;

• Type: boolean
• Default: true

Automatically add all executables under the bin directory to your package.json file under the bin section.

---

bin^Optional

public readonly bin: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Binary programs vended with your module.

You can use this option to add/customize how binaries are represented in your package.json, but unless autoDetectBin is false, every executable file under bin will automatically be added to this section.

---

bugsEmail^Optional

public readonly bugsEmail: string;

• Type: string

The email address to which issues should be reported.

---

bugsUrl^Optional

public readonly bugsUrl: string;

• Type: string

The url to your project's issue tracker.

---

bundledDeps^Optional

public readonly bundledDeps: string[];

• Type: string[]

List of dependencies to bundle into this module.

These modules will be added both to the dependencies section and bundledDependencies section of your package.json.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

---

codeArtifactOptions^Optional

public readonly codeArtifactOptions: CodeArtifactOptions;

• Type: projen.javascript.CodeArtifactOptions
• Default: undefined

Options for npm packages using AWS CodeArtifact.

This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact

---

deps^Optional

public readonly deps: string[];

• Type: string[]
• Default: []

Runtime dependencies of this module.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

---

Example

[ 'express', 'lodash', 'foo@^2' ]

description^Optional

public readonly description: string;

• Type: string

The description is just a string that helps people understand the purpose of the package.

It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description

---

devDeps^Optional

public readonly devDeps: string[];

• Type: string[]
• Default: []

Build dependencies for this module.

These dependencies will only be available in your build environment but will not be fetched when this module is consumed.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

---

Example

[ 'typescript', '@types/express' ]

entrypoint^Optional

public readonly entrypoint: string;

• Type: string
• Default: "lib/index.js"

Module entrypoint (main in package.json).

Set to an empty string to not include main in your package.json

---

homepage^Optional

public readonly homepage: string;

• Type: string

Package's Homepage / Website.

---

keywords^Optional

public readonly keywords: string[];

• Type: string[]

Keywords to include in package.json.

---

license^Optional

public readonly license: string;

• Type: string
• Default: "Apache-2.0"

License's SPDX identifier.

See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the licensed option if you want to no license to be specified.

---

licensed^Optional

public readonly licensed: boolean;

• Type: boolean
• Default: true

Indicates if a license should be added.

---

maxNodeVersion^Optional

public readonly maxNodeVersion: string;

• Type: string
• Default: no maximum version is enforced

The maximum node version supported by this package. Most projects should not use this option.

The value indicates that the package is incompatible with any newer versions of node. This requirement is enforced via the engines field.

You will normally not need to set this option. Consider this option only if your package is known to not function with newer versions of node.

---

minNodeVersion^Optional

public readonly minNodeVersion: string;

• Type: string
• Default: no minimum version is enforced

The minimum node version required by this package to function. Most projects should not use this option.

The value indicates that the package is incompatible with any older versions of node. This requirement is enforced via the engines field.

You will normally not need to set this option, even if your package is incompatible with EOL versions of node. Consider this option only if your package depends on a specific feature, that is not available in other LTS versions. Setting this option has very high impact on the consumers of your package, as package managers will actively prevent usage with node versions you have marked as incompatible.

To change the node version of your CI/CD workflows, use workflowNodeVersion.

---

npmAccess^Optional

public readonly npmAccess: NpmAccess;

• Type: projen.javascript.NpmAccess
• Default: for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.

Access level of the npm package.

---

npmProvenance^Optional

public readonly npmProvenance: boolean;

• Type: boolean
• Default: true for public packages, false otherwise

Should provenance statements be generated when the package is published.

A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider.

Note that the projen Release and Publisher components are using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.

https://docs.npmjs.com/generating-provenance-statements

---

npmRegistry^Optional

• Deprecated: use npmRegistryUrl instead

public readonly npmRegistry: string;

• Type: string

The host name of the npm registry to publish to.

Cannot be set together with npmRegistryUrl.

---

npmRegistryUrl^Optional

public readonly npmRegistryUrl: string;

• Type: string
• Default: "https://registry.npmjs.org"

The base URL of the npm package registry.

Must be a URL (e.g. start with "https://" or "http://")

---

npmTokenSecret^Optional

public readonly npmTokenSecret: string;

• Type: string
• Default: "NPM_TOKEN"

GitHub secret which contains the NPM token to use when publishing packages.

---

packageManager^Optional

public readonly packageManager: NodePackageManager;

• Type: projen.javascript.NodePackageManager
• Default: NodePackageManager.YARN_CLASSIC

The Node Package Manager used to execute scripts.

---

packageName^Optional

public readonly packageName: string;

• Type: string
• Default: defaults to project name

The "name" in package.json.

---

peerDependencyOptions^Optional

public readonly peerDependencyOptions: PeerDependencyOptions;

• Type: projen.javascript.PeerDependencyOptions

Options for peerDeps.

---

peerDeps^Optional

public readonly peerDeps: string[];

• Type: string[]
• Default: []

Peer dependencies for this module.

Dependencies listed here are required to be installed (and satisfied) by the consumer of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the node_modules tree of your consumers.

Note that prior to npm@7, peer dependencies are not automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers.

Unless peerDependencyOptions.pinnedDevDependency is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required.

---

pnpmVersion^Optional

public readonly pnpmVersion: string;

• Type: string
• Default: "7"

The version of PNPM to use if using PNPM as a package manager.

---

repository^Optional

public readonly repository: string;

• Type: string

The repository is the location where the actual code for your package lives.

See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository

---

repositoryDirectory^Optional

public readonly repositoryDirectory: string;

• Type: string

If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.

---

scopedPackagesOptions^Optional

public readonly scopedPackagesOptions: ScopedPackagesOptions[];

• Type: projen.javascript.ScopedPackagesOptions[]
• Default: fetch all scoped packages from the public npm registry

Options for privately hosted scoped packages.

---

scripts^Optional

• Deprecated: use project.addTask() or package.setScript()

public readonly scripts: {[ key: string ]: string};

• Type: {[ key: string ]: string}
• Default: {}

npm scripts to include.

If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task.

---

stability^Optional

public readonly stability: string;

• Type: string

Package's Stability.

---

yarnBerryOptions^Optional

public readonly yarnBerryOptions: YarnBerryOptions;

• Type: projen.javascript.YarnBerryOptions
• Default: Yarn Berry v4 with all default options

Options for Yarn Berry.

---

bumpPackage^Optional

public readonly bumpPackage: string;

• Type: string
• Default: A recent version of "commit-and-tag-version"

The commit-and-tag-version compatible package used to bump the package version, as a dependency string.

This can be any compatible package version, including the deprecated standard-version@9.

---

jsiiReleaseVersion^Optional

public readonly jsiiReleaseVersion: string;

• Type: string
• Default: "latest"

Version requirement of publib which is used to publish modules to npm.

---

majorVersion^Optional

public readonly majorVersion: number;

• Type: number
• Default: Major version is not enforced.

Major version to release from the default branch.

If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version.

---

minMajorVersion^Optional

public readonly minMajorVersion: number;

• Type: number
• Default: No minimum version is being enforced

Minimal Major version to release.

This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number.

Can not be set together with majorVersion.

---

nextVersionCommand^Optional

public readonly nextVersionCommand: string;

• Type: string
• Default: The next version will be determined based on the commit history and project settings.

A shell command to control the next version to release.

If present, this shell command will be run before the bump is executed, and it determines what version to release. It will be executed in the following environment:

• Working directory: the project directory.
• $VERSION: the current version. Looks like 1.2.3.
• $LATEST_TAG: the most recent tag. Looks like prefix-v1.2.3, or may be unset.

The command should print one of the following to stdout:

• Nothing: the next version number will be determined based on commit history.
• x.y.z: the next version number will be x.y.z.
• major|minor|patch: the next version number will be the current version number with the indicated component bumped.

This setting cannot be specified together with minMajorVersion; the invoked script can be used to achieve the effects of minMajorVersion.

---

npmDistTag^Optional

public readonly npmDistTag: string;

• Type: string
• Default: "latest"

The npmDistTag to use when publishing from the default branch.

To set the npm dist-tag for release branches, set the npmDistTag property for each branch.

---

postBuildSteps^Optional

public readonly postBuildSteps: JobStep[];

• Type: projen.github.workflows.JobStep[]
• Default: []

Steps to execute after build as part of the release workflow.

---

prerelease^Optional

public readonly prerelease: string;

• Type: string
• Default: normal semantic versions

Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

---

publishDryRun^Optional

public readonly publishDryRun: boolean;

• Type: boolean
• Default: false

Instead of actually publishing to package managers, just print the publishing command.

---

publishTasks^Optional

public readonly publishTasks: boolean;

• Type: boolean
• Default: false

Define publishing tasks that can be executed manually as well as workflows.

Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.

---

releasableCommits^Optional

public readonly releasableCommits: ReleasableCommits;

• Type: projen.ReleasableCommits
• Default: ReleasableCommits.everyCommit()

Find commits that should be considered releasable Used to decide if a release is required.

---

releaseBranches^Optional

public readonly releaseBranches: {[ key: string ]: BranchOptions};

• Type: {[ key: string ]: projen.release.BranchOptions}
• Default: no additional branches are used for release. you can use addBranch() to add additional branches.

Defines additional release branches.

A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch must be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the majorVersion field must also be provided for the default branch.

---

releaseEveryCommit^Optional

• Deprecated: Use releaseTrigger: ReleaseTrigger.continuous() instead

public readonly releaseEveryCommit: boolean;

• Type: boolean
• Default: true

Automatically release new versions every commit to one of branches in releaseBranches.

---

releaseFailureIssue^Optional

public readonly releaseFailureIssue: boolean;

• Type: boolean
• Default: false

Create a github issue on every failed publishing task.

---

releaseFailureIssueLabel^Optional

public readonly releaseFailureIssueLabel: string;

• Type: string
• Default: "failed-release"

The label to apply to issues indicating publish failures.

Only applies if releaseFailureIssue is true.

---

releaseSchedule^Optional

• Deprecated: Use releaseTrigger: ReleaseTrigger.scheduled() instead

public readonly releaseSchedule: string;

• Type: string
• Default: no scheduled releases

CRON schedule to trigger new releases.

---

releaseTagPrefix^Optional

public readonly releaseTagPrefix: string;

• Type: string
• Default: "v"

Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.

Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix.

---

releaseTrigger^Optional

public readonly releaseTrigger: ReleaseTrigger;

• Type: projen.release.ReleaseTrigger
• Default: Continuous releases (ReleaseTrigger.continuous())

The release trigger to use.

---

releaseWorkflowName^Optional

public readonly releaseWorkflowName: string;

• Type: string
• Default: "release"

The name of the default release workflow.

---

releaseWorkflowSetupSteps^Optional

public readonly releaseWorkflowSetupSteps: JobStep[];

• Type: projen.github.workflows.JobStep[]

A set of workflow steps to execute in order to setup the workflow container.

---

versionrcOptions^Optional

public readonly versionrcOptions: {[ key: string ]: any};

• Type: {[ key: string ]: any}
• Default: standard configuration applicable for GitHub repositories

Custom configuration used when creating changelog with commit-and-tag-version package.

Given values either append to default configuration or overwrite values in it.

---

workflowContainerImage^Optional

public readonly workflowContainerImage: string;

• Type: string
• Default: default image

Container image to use for GitHub workflows.

---

workflowRunsOn^Optional

public readonly workflowRunsOn: string[];

• Type: string[]
• Default: ["ubuntu-latest"]

Github Runner selection labels.

---

workflowRunsOnGroup^Optional

public readonly workflowRunsOnGroup: GroupRunnerOptions;

• Type: projen.GroupRunnerOptions

Github Runner Group selection options.

---

defaultReleaseBranch^Required

public readonly defaultReleaseBranch: string;

• Type: string
• Default: "main"

The name of the main release branch.

---

artifactsDirectory^Optional

public readonly artifactsDirectory: string;

• Type: string
• Default: "dist"

A directory which will contain build artifacts.

---

autoApproveUpgrades^Optional

public readonly autoApproveUpgrades: boolean;

• Type: boolean
• Default: true

Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).

Throw if set to true but autoApproveOptions are not defined.

---

buildWorkflow^Optional

public readonly buildWorkflow: boolean;

• Type: boolean
• Default: true if not a subproject

Define a GitHub workflow for building PRs.

---

buildWorkflowOptions^Optional

public readonly buildWorkflowOptions: BuildWorkflowOptions;

• Type: projen.javascript.BuildWorkflowOptions

Options for PR build workflow.

---

buildWorkflowTriggers^Optional

• Deprecated: - Use buildWorkflowOptions.workflowTriggers

public readonly buildWorkflowTriggers: Triggers;

• Type: projen.github.workflows.Triggers
• Default: "{ pullRequest: {}, workflowDispatch: {} }"

Build workflow triggers.

---

bundlerOptions^Optional

public readonly bundlerOptions: BundlerOptions;

• Type: projen.javascript.BundlerOptions

Options for Bundler.

---

checkLicenses^Optional

public readonly checkLicenses: LicenseCheckerOptions;

• Type: projen.javascript.LicenseCheckerOptions
• Default: no license checks are run during the build and all licenses will be accepted

Configure which licenses should be deemed acceptable for use by dependencies.

This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.

---

codeCov^Optional

public readonly codeCov: boolean;

• Type: boolean
• Default: false

Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with @codeCovTokenSecret.

---

codeCovTokenSecret^Optional

public readonly codeCovTokenSecret: string;

• Type: string
• Default: if this option is not specified, only public repositories are supported

Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.

---

copyrightOwner^Optional

public readonly copyrightOwner: string;

• Type: string
• Default: defaults to the value of authorName or "" if authorName is undefined.

License copyright owner.

---

copyrightPeriod^Optional

public readonly copyrightPeriod: string;

• Type: string
• Default: current year

The copyright years to put in the LICENSE file.

---

dependabot^Optional

public readonly dependabot: boolean;

• Type: boolean
• Default: false

Use dependabot to handle dependency upgrades.

Cannot be used in conjunction with depsUpgrade.

---

dependabotOptions^Optional

public readonly dependabotOptions: DependabotOptions;

• Type: projen.github.DependabotOptions
• Default: default options

Options for dependabot.

---

depsUpgrade^Optional

public readonly depsUpgrade: boolean;

• Type: boolean
• Default: true

Use tasks and github workflows to handle dependency upgrades.

Cannot be used in conjunction with dependabot.

---

depsUpgradeOptions^Optional

public readonly depsUpgradeOptions: UpgradeDependenciesOptions;

• Type: projen.javascript.UpgradeDependenciesOptions
• Default: default options

Options for UpgradeDependencies.

---

gitignore^Optional

public readonly gitignore: string[];

• Type: string[]

Additional entries to .gitignore.

---

jest^Optional

public readonly jest: boolean;

• Type: boolean
• Default: true

Setup jest unit tests.

---

jestOptions^Optional

public readonly jestOptions: JestOptions;

• Type: projen.javascript.JestOptions
• Default: default options

Jest options.

---

mutableBuild^Optional

• Deprecated: - Use buildWorkflowOptions.mutableBuild

public readonly mutableBuild: boolean;

• Type: boolean
• Default: true

Automatically update files modified during builds to pull-request branches.

This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged.

Implies that PR builds do not have anti-tamper checks.

---

npmignore^Optional

• Deprecated: - use project.addPackageIgnore

public readonly npmignore: string[];

• Type: string[]

Additional entries to .npmignore.

---

npmignoreEnabled^Optional

public readonly npmignoreEnabled: boolean;

• Type: boolean
• Default: true

Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.

---

npmIgnoreOptions^Optional

public readonly npmIgnoreOptions: IgnoreFileOptions;

• Type: projen.IgnoreFileOptions

Configuration options for .npmignore file.

---

package^Optional

public readonly package: boolean;

• Type: boolean
• Default: true

Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).

---

prettier^Optional

public readonly prettier: boolean;

• Type: boolean
• Default: false

Setup prettier.

---

prettierOptions^Optional

public readonly prettierOptions: PrettierOptions;

• Type: projen.javascript.PrettierOptions
• Default: default options

Prettier options.

---

projenDevDependency^Optional

public readonly projenDevDependency: boolean;

• Type: boolean
• Default: true if not a subproject

Indicates of "projen" should be installed as a devDependency.

---

projenrcJs^Optional

public readonly projenrcJs: boolean;

• Type: boolean
• Default: true if projenrcJson is false

Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.

---

projenrcJsOptions^Optional

public readonly projenrcJsOptions: ProjenrcOptions;

• Type: projen.javascript.ProjenrcOptions
• Default: default options

Options for .projenrc.js.

---

projenVersion^Optional

public readonly projenVersion: string;

• Type: string
• Default: Defaults to the latest version.

Version of projen to install.

---

pullRequestTemplate^Optional

public readonly pullRequestTemplate: boolean;

• Type: boolean
• Default: true

Include a GitHub pull request template.

---

pullRequestTemplateContents^Optional

public readonly pullRequestTemplateContents: string[];

• Type: string[]
• Default: default content

The contents of the pull request template.

---

release^Optional

public readonly release: boolean;

• Type: boolean
• Default: true (false for subprojects)

Add release management to this project.

---

releaseToNpm^Optional

public readonly releaseToNpm: boolean;

• Type: boolean
• Default: false

Automatically release to npm when new versions are introduced.

---

releaseWorkflow^Optional

• Deprecated: see release.

public readonly releaseWorkflow: boolean;

• Type: boolean
• Default: true if not a subproject

DEPRECATED: renamed to release.

---

workflowBootstrapSteps^Optional

public readonly workflowBootstrapSteps: JobStep[];

• Type: projen.github.workflows.JobStep[]
• Default: "yarn install --frozen-lockfile && yarn projen"

Workflow steps to use in order to bootstrap this repo.

---

workflowGitIdentity^Optional

public readonly workflowGitIdentity: GitIdentity;

• Type: projen.github.GitIdentity
• Default: GitHub Actions

The git identity to use in workflows.

---

workflowNodeVersion^Optional

public readonly workflowNodeVersion: string;

• Type: string
• Default: minNodeVersion if set, otherwise lts/*.

The node version used in GitHub Actions workflows.

Always use this option if your GitHub Actions workflows require a specific to run.

---

workflowPackageCache^Optional

public readonly workflowPackageCache: boolean;

• Type: boolean
• Default: false

Enable Node.js package cache in GitHub workflows.

---

disableTsconfig^Optional

public readonly disableTsconfig: boolean;

• Type: boolean
• Default: false

Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).

---

disableTsconfigDev^Optional

public readonly disableTsconfigDev: boolean;

• Type: boolean
• Default: false

Do not generate a tsconfig.dev.json file.

---

docgen^Optional

public readonly docgen: boolean;

• Type: boolean
• Default: false

Docgen by Typedoc.

---

docsDirectory^Optional

public readonly docsDirectory: string;

• Type: string
• Default: "docs"

Docs directory.

---

entrypointTypes^Optional

public readonly entrypointTypes: string;

• Type: string
• Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)

The .d.ts file that includes the type declarations for this module.

---

eslint^Optional

public readonly eslint: boolean;

• Type: boolean
• Default: true

Setup eslint.

---

eslintOptions^Optional

public readonly eslintOptions: EslintOptions;

• Type: projen.javascript.EslintOptions
• Default: opinionated default options

Eslint options.

---

libdir^Optional

public readonly libdir: string;

• Type: string
• Default: "lib"

Typescript artifacts output directory.

---

projenrcTs^Optional

public readonly projenrcTs: boolean;

• Type: boolean
• Default: false

Use TypeScript for your projenrc file (.projenrc.ts).

---

projenrcTsOptions^Optional

public readonly projenrcTsOptions: ProjenrcOptions;

• Type: projen.typescript.ProjenrcOptions

Options for .projenrc.ts.

---

sampleCode^Optional

public readonly sampleCode: boolean;

• Type: boolean
• Default: true

Generate one-time sample in src/ and test/ if there are no files there.

---

srcdir^Optional

public readonly srcdir: string;

• Type: string
• Default: "src"

Typescript sources directory.

---

testdir^Optional

public readonly testdir: string;

• Type: string
• Default: "test"

Jest tests directory. Tests files should be named xxx.test.ts.

If this directory is under srcdir (e.g. src/test, src/__tests__), then tests are going to be compiled into lib/ and executed as javascript. If the test directory is outside of src, then we configure jest to compile the code in-memory.

---

tsconfig^Optional

public readonly tsconfig: TypescriptConfigOptions;

• Type: projen.javascript.TypescriptConfigOptions
• Default: default options

Custom TSConfig.

---

tsconfigDev^Optional

public readonly tsconfigDev: TypescriptConfigOptions;

• Type: projen.javascript.TypescriptConfigOptions
• Default: use the production tsconfig options

Custom tsconfig options for the development tsconfig.json file (used for testing).

---

tsconfigDevFile^Optional

public readonly tsconfigDevFile: string;

• Type: string
• Default: "tsconfig.dev.json"

The name of the development tsconfig.json file.

---

tsJestOptions^Optional

public readonly tsJestOptions: TsJestOptions;

• Type: projen.typescript.TsJestOptions

Options for ts-jest.

---

typescriptVersion^Optional

public readonly typescriptVersion: string;

• Type: string
• Default: "latest"

TypeScript version to use.

NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~1.2.3).

---

cdk8sVersion^Required

public readonly cdk8sVersion: string;

• Type: string
• Default: "2.3.33"

Minimum version of the cdk8s to depend on.

---

cdk8sCliVersion^Optional

public readonly cdk8sCliVersion: string;

• Type: string
• Default: "2.0.28"

Minimum version of the cdk8s-cli to depend on.

---

cdk8sCliVersionPinning^Optional

public readonly cdk8sCliVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s-cli.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

cdk8sPlus^Optional

public readonly cdk8sPlus: boolean;

• Type: boolean
• Default: true

Include cdk8s-plus.

---

cdk8sPlusVersion^Optional

public readonly cdk8sPlusVersion: string;

• Type: string
• Default: "2.0.0-rc.26"

Minimum version of the cdk8s-plus-XX to depend on.

---

cdk8sPlusVersionPinning^Optional

public readonly cdk8sPlusVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s-plus-17.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

cdk8sVersionPinning^Optional

public readonly cdk8sVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

constructsVersion^Optional

public readonly constructsVersion: string;

• Type: string
• Default: "10.1.42"

Minimum version of the constructs library to depend on.

---

constructsVersionPinning^Optional

public readonly constructsVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for constructs.

You can use this to prevent yarn to mix versions for your consructs package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

k8sMinorVersion^Optional

public readonly k8sMinorVersion: number;

• Type: number
• Default: 22

The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.

---

appEntrypoint^Optional

public readonly appEntrypoint: string;

• Type: string
• Default: "main.ts"

The CDK8s app's entrypoint (relative to the source directory, which is "src" by default).

---

cdk8sImports^Optional

public readonly cdk8sImports: string[];

• Type: string[]
• Default: no additional specs imported

Import additional specs.

---

integrationTestAutoDiscover^Optional

public readonly integrationTestAutoDiscover: boolean;

• Type: boolean
• Default: true

Automatically adds an cdk8s.IntegrationTest for each .integ.ts app in your test directory. If this is disabled, you can manually add an cdk8s.AutoDiscover component to your project.

---

k8sSpecVersion^Optional

public readonly k8sSpecVersion: string;

• Type: string
• Default: Use the cdk8s default

Import a specific Kubernetes spec version.

---

ConstructLibraryCdk8sOptions

Initializer

import { cdk8s } from 'projen'

const constructLibraryCdk8sOptions: cdk8s.ConstructLibraryCdk8sOptions = { ... }

Properties

Name	Type	Description
name	string	This is the name of your project.
commitGenerated	boolean	Whether to commit the managed files by default.
gitIgnoreOptions	projen.IgnoreFileOptions	Configuration options for .gitignore file.
gitOptions	projen.GitOptions	Configuration options for git.
logging	projen.LoggerOptions	Configure logging options such as verbosity.
outdir	string	The root directory of the project.
parent	projen.Project	The parent project, if this project is part of a bigger project.
projenCommand	string	The shell command to use in order to run the projen CLI.
projenrcJson	boolean	Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.
projenrcJsonOptions	projen.ProjenrcJsonOptions	Options for .projenrc.json.
renovatebot	boolean	Use renovatebot to handle dependency upgrades.
renovatebotOptions	projen.RenovatebotOptions	Options for renovatebot.
autoApproveOptions	projen.github.AutoApproveOptions	Enable and configure the 'auto approve' workflow.
autoMerge	boolean	Enable automatic merging on GitHub.
autoMergeOptions	projen.github.AutoMergeOptions	Configure options for automatic merging on GitHub.
clobber	boolean	Add a clobber task which resets the repo to origin.
devContainer	boolean	Add a VSCode development environment (used for GitHub Codespaces).
github	boolean	Enable GitHub integration.
githubOptions	projen.github.GitHubOptions	Options for GitHub integration.
gitpod	boolean	Add a Gitpod development environment.
mergify	boolean	Whether mergify should be enabled on this repository or not.
mergifyOptions	projen.github.MergifyOptions	Options for mergify.
projectType	projen.ProjectType	Which type of project this is (library/app).
projenCredentials	projen.github.GithubCredentials	Choose a method of providing GitHub API access for projen workflows.
projenTokenSecret	string	The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
readme	projen.SampleReadmeProps	The README setup.
stale	boolean	Auto-close of stale issues and pull request.
staleOptions	projen.github.StaleOptions	Auto-close stale issues and pull requests.
vscode	boolean	Enable VSCode integration.
allowLibraryDependencies	boolean	Allow the project to include peerDependencies and bundledDependencies.
authorEmail	string	Author's e-mail.
authorName	string	Author's name.
authorOrganization	boolean	Is the author an organization.
authorUrl	string	Author's URL / Website.
autoDetectBin	boolean	Automatically add all executables under the bin directory to your package.json file under the bin section.
bin	{[ key: string ]: string}	Binary programs vended with your module.
bugsEmail	string	The email address to which issues should be reported.
bugsUrl	string	The url to your project's issue tracker.
bundledDeps	string[]	List of dependencies to bundle into this module.
codeArtifactOptions	projen.javascript.CodeArtifactOptions	Options for npm packages using AWS CodeArtifact.
deps	string[]	Runtime dependencies of this module.
description	string	The description is just a string that helps people understand the purpose of the package.
devDeps	string[]	Build dependencies for this module.
entrypoint	string	Module entrypoint (main in package.json).
homepage	string	Package's Homepage / Website.
keywords	string[]	Keywords to include in package.json.
license	string	License's SPDX identifier.
licensed	boolean	Indicates if a license should be added.
maxNodeVersion	string	The maximum node version supported by this package. Most projects should not use this option.
minNodeVersion	string	The minimum node version required by this package to function. Most projects should not use this option.
npmAccess	projen.javascript.NpmAccess	Access level of the npm package.
npmProvenance	boolean	Should provenance statements be generated when the package is published.
npmRegistry	string	The host name of the npm registry to publish to.
npmRegistryUrl	string	The base URL of the npm package registry.
npmTokenSecret	string	GitHub secret which contains the NPM token to use when publishing packages.
packageManager	projen.javascript.NodePackageManager	The Node Package Manager used to execute scripts.
packageName	string	The "name" in package.json.
peerDependencyOptions	projen.javascript.PeerDependencyOptions	Options for peerDeps.
peerDeps	string[]	Peer dependencies for this module.
pnpmVersion	string	The version of PNPM to use if using PNPM as a package manager.
repository	string	The repository is the location where the actual code for your package lives.
repositoryDirectory	string	If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
scopedPackagesOptions	projen.javascript.ScopedPackagesOptions[]	Options for privately hosted scoped packages.
scripts	{[ key: string ]: string}	npm scripts to include.
stability	string	Package's Stability.
yarnBerryOptions	projen.javascript.YarnBerryOptions	Options for Yarn Berry.
bumpPackage	string	The commit-and-tag-version compatible package used to bump the package version, as a dependency string.
jsiiReleaseVersion	string	Version requirement of publib which is used to publish modules to npm.
majorVersion	number	Major version to release from the default branch.
minMajorVersion	number	Minimal Major version to release.
nextVersionCommand	string	A shell command to control the next version to release.
npmDistTag	string	The npmDistTag to use when publishing from the default branch.
postBuildSteps	projen.github.workflows.JobStep[]	Steps to execute after build as part of the release workflow.
prerelease	string	Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
publishDryRun	boolean	Instead of actually publishing to package managers, just print the publishing command.
publishTasks	boolean	Define publishing tasks that can be executed manually as well as workflows.
releasableCommits	projen.ReleasableCommits	Find commits that should be considered releasable Used to decide if a release is required.
releaseBranches	{[ key: string ]: projen.release.BranchOptions}	Defines additional release branches.
releaseEveryCommit	boolean	Automatically release new versions every commit to one of branches in releaseBranches.
releaseFailureIssue	boolean	Create a github issue on every failed publishing task.
releaseFailureIssueLabel	string	The label to apply to issues indicating publish failures.
releaseSchedule	string	CRON schedule to trigger new releases.
releaseTagPrefix	string	Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
releaseTrigger	projen.release.ReleaseTrigger	The release trigger to use.
releaseWorkflowName	string	The name of the default release workflow.
releaseWorkflowSetupSteps	projen.github.workflows.JobStep[]	A set of workflow steps to execute in order to setup the workflow container.
versionrcOptions	{[ key: string ]: any}	Custom configuration used when creating changelog with commit-and-tag-version package.
workflowContainerImage	string	Container image to use for GitHub workflows.
workflowRunsOn	string[]	Github Runner selection labels.
workflowRunsOnGroup	projen.GroupRunnerOptions	Github Runner Group selection options.
defaultReleaseBranch	string	The name of the main release branch.
artifactsDirectory	string	A directory which will contain build artifacts.
autoApproveUpgrades	boolean	Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
buildWorkflow	boolean	Define a GitHub workflow for building PRs.
buildWorkflowOptions	projen.javascript.BuildWorkflowOptions	Options for PR build workflow.
buildWorkflowTriggers	projen.github.workflows.Triggers	Build workflow triggers.
bundlerOptions	projen.javascript.BundlerOptions	Options for Bundler.
checkLicenses	projen.javascript.LicenseCheckerOptions	Configure which licenses should be deemed acceptable for use by dependencies.
codeCov	boolean	Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with @codeCovTokenSecret.
codeCovTokenSecret	string	Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
copyrightOwner	string	License copyright owner.
copyrightPeriod	string	The copyright years to put in the LICENSE file.
dependabot	boolean	Use dependabot to handle dependency upgrades.
dependabotOptions	projen.github.DependabotOptions	Options for dependabot.
depsUpgrade	boolean	Use tasks and github workflows to handle dependency upgrades.
depsUpgradeOptions	projen.javascript.UpgradeDependenciesOptions	Options for UpgradeDependencies.
gitignore	string[]	Additional entries to .gitignore.
jest	boolean	Setup jest unit tests.
jestOptions	projen.javascript.JestOptions	Jest options.
mutableBuild	boolean	Automatically update files modified during builds to pull-request branches.
npmignore	string[]	Additional entries to .npmignore.
npmignoreEnabled	boolean	Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
npmIgnoreOptions	projen.IgnoreFileOptions	Configuration options for .npmignore file.
package	boolean	Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).
prettier	boolean	Setup prettier.
prettierOptions	projen.javascript.PrettierOptions	Prettier options.
projenDevDependency	boolean	Indicates of "projen" should be installed as a devDependency.
projenrcJs	boolean	Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.
projenrcJsOptions	projen.javascript.ProjenrcOptions	Options for .projenrc.js.
projenVersion	string	Version of projen to install.
pullRequestTemplate	boolean	Include a GitHub pull request template.
pullRequestTemplateContents	string[]	The contents of the pull request template.
release	boolean	Add release management to this project.
releaseToNpm	boolean	Automatically release to npm when new versions are introduced.
releaseWorkflow	boolean	DEPRECATED: renamed to release.
workflowBootstrapSteps	projen.github.workflows.JobStep[]	Workflow steps to use in order to bootstrap this repo.
workflowGitIdentity	projen.github.GitIdentity	The git identity to use in workflows.
workflowNodeVersion	string	The node version used in GitHub Actions workflows.
workflowPackageCache	boolean	Enable Node.js package cache in GitHub workflows.
disableTsconfig	boolean	Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
disableTsconfigDev	boolean	Do not generate a tsconfig.dev.json file.
docgen	boolean	Docgen by Typedoc.
docsDirectory	string	Docs directory.
entrypointTypes	string	The .d.ts file that includes the type declarations for this module.
eslint	boolean	Setup eslint.
eslintOptions	projen.javascript.EslintOptions	Eslint options.
libdir	string	Typescript artifacts output directory.
projenrcTs	boolean	Use TypeScript for your projenrc file (.projenrc.ts).
projenrcTsOptions	projen.typescript.ProjenrcOptions	Options for .projenrc.ts.
sampleCode	boolean	Generate one-time sample in src/ and test/ if there are no files there.
srcdir	string	Typescript sources directory.
testdir	string	Jest tests directory. Tests files should be named xxx.test.ts.
tsconfig	projen.javascript.TypescriptConfigOptions	Custom TSConfig.
tsconfigDev	projen.javascript.TypescriptConfigOptions	Custom tsconfig options for the development tsconfig.json file (used for testing).
tsconfigDevFile	string	The name of the development tsconfig.json file.
tsJestOptions	projen.typescript.TsJestOptions	Options for ts-jest.
typescriptVersion	string	TypeScript version to use.
author	string	The name of the library author.
authorAddress	string	Email or URL of the library author.
repositoryUrl	string	Git repository URL.
compat	boolean	Automatically run API compatibility test against the latest version published to npm after compilation.
compatIgnore	string	Name of the ignore file for API compatibility tests.
compressAssembly	boolean	Emit a compressed version of the assembly.
docgenFilePath	string	File path for generated docs.
dotnet	projen.cdk.JsiiDotNetTarget	No description.
excludeTypescript	string[]	Accepts a list of glob patterns.
jsiiVersion	string	Version of the jsii compiler to use.
publishToGo	projen.cdk.JsiiGoTarget	Publish Go bindings to a git repository.
publishToMaven	projen.cdk.JsiiJavaTarget	Publish to maven.
publishToNuget	projen.cdk.JsiiDotNetTarget	Publish to NuGet.
publishToPypi	projen.cdk.JsiiPythonTarget	Publish to pypi.
python	projen.cdk.JsiiPythonTarget	No description.
rootdir	string	No description.
catalog	projen.cdk.Catalog	Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.
cdk8sVersion	string	Minimum target version this library is tested against.
cdk8sPlusVersionPinning	boolean	Use pinned version instead of caret version for cdk8s-plus-17.
cdk8sVersionPinning	boolean	Use pinned version instead of caret version for CDK8s.
constructsVersion	string	constructs verion.
constructsVersionPinning	boolean	Use pinned version instead of caret version for constructs.
integrationTestAutoDiscover	boolean	Automatically adds an cdk8s.IntegrationTest for each .integ.ts app in your test directory. If this is disabled, you can manually add an cdk8s.AutoDiscover component to your project.

---

name^Required

public readonly name: string;

• Type: string
• Default: $BASEDIR

This is the name of your project.

---

commitGenerated^Optional

public readonly commitGenerated: boolean;

• Type: boolean
• Default: true

Whether to commit the managed files by default.

---

gitIgnoreOptions^Optional

public readonly gitIgnoreOptions: IgnoreFileOptions;

• Type: projen.IgnoreFileOptions

Configuration options for .gitignore file.

---

gitOptions^Optional

public readonly gitOptions: GitOptions;

• Type: projen.GitOptions

Configuration options for git.

---

logging^Optional

public readonly logging: LoggerOptions;

• Type: projen.LoggerOptions
• Default: {}

Configure logging options such as verbosity.

---

outdir^Optional

public readonly outdir: string;

• Type: string
• Default: "."

The root directory of the project.

Relative to this directory, all files are synthesized.

If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other subprojects.

---

parent^Optional

public readonly parent: Project;

• Type: projen.Project

The parent project, if this project is part of a bigger project.

---

projenCommand^Optional

public readonly projenCommand: string;

• Type: string
• Default: "npx projen"

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

Can be used to customize in special environments.

---

projenrcJson^Optional

public readonly projenrcJson: boolean;

• Type: boolean
• Default: false

Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

---

projenrcJsonOptions^Optional

public readonly projenrcJsonOptions: ProjenrcJsonOptions;

• Type: projen.ProjenrcJsonOptions
• Default: default options

Options for .projenrc.json.

---

renovatebot^Optional

public readonly renovatebot: boolean;

• Type: boolean
• Default: false

Use renovatebot to handle dependency upgrades.

---

renovatebotOptions^Optional

public readonly renovatebotOptions: RenovatebotOptions;

• Type: projen.RenovatebotOptions
• Default: default options

Options for renovatebot.

---

autoApproveOptions^Optional

public readonly autoApproveOptions: AutoApproveOptions;

• Type: projen.github.AutoApproveOptions
• Default: auto approve is disabled

Enable and configure the 'auto approve' workflow.

---

autoMerge^Optional

public readonly autoMerge: boolean;

• Type: boolean
• Default: true

Enable automatic merging on GitHub.

Has no effect if github.mergify is set to false.

---

autoMergeOptions^Optional

public readonly autoMergeOptions: AutoMergeOptions;

• Type: projen.github.AutoMergeOptions
• Default: see defaults in AutoMergeOptions

Configure options for automatic merging on GitHub.

Has no effect if github.mergify or autoMerge is set to false.

---

clobber^Optional

public readonly clobber: boolean;

• Type: boolean
• Default: true, but false for subprojects

Add a clobber task which resets the repo to origin.

---

devContainer^Optional

public readonly devContainer: boolean;

• Type: boolean
• Default: false

Add a VSCode development environment (used for GitHub Codespaces).

---

github^Optional

public readonly github: boolean;

• Type: boolean
• Default: true

Enable GitHub integration.

Enabled by default for root projects. Disabled for non-root projects.

---

githubOptions^Optional

public readonly githubOptions: GitHubOptions;

• Type: projen.github.GitHubOptions
• Default: see GitHubOptions

Options for GitHub integration.

---

gitpod^Optional

public readonly gitpod: boolean;

• Type: boolean
• Default: false

Add a Gitpod development environment.

---

mergify^Optional

• Deprecated: use githubOptions.mergify instead

public readonly mergify: boolean;

• Type: boolean
• Default: true

Whether mergify should be enabled on this repository or not.

---

mergifyOptions^Optional

• Deprecated: use githubOptions.mergifyOptions instead

public readonly mergifyOptions: MergifyOptions;

• Type: projen.github.MergifyOptions
• Default: default options

Options for mergify.

---

projectType^Optional

• Deprecated: no longer supported at the base project level

public readonly projectType: ProjectType;

• Type: projen.ProjectType
• Default: ProjectType.UNKNOWN

Which type of project this is (library/app).

---

projenCredentials^Optional

public readonly projenCredentials: GithubCredentials;

• Type: projen.github.GithubCredentials
• Default: use a personal access token named PROJEN_GITHUB_TOKEN

Choose a method of providing GitHub API access for projen workflows.

---

projenTokenSecret^Optional

• Deprecated: use projenCredentials

public readonly projenTokenSecret: string;

• Type: string
• Default: "PROJEN_GITHUB_TOKEN"

The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.

This token needs to have the repo, workflows and packages scope.

---

readme^Optional

public readonly readme: SampleReadmeProps;

• Type: projen.SampleReadmeProps
• Default: { filename: 'README.md', contents: '# replace this' }

The README setup.

---

Example

"{ filename: 'readme.md', contents: '# title' }"

stale^Optional

public readonly stale: boolean;

• Type: boolean
• Default: false

Auto-close of stale issues and pull request.

See staleOptions for options.

---

staleOptions^Optional

public readonly staleOptions: StaleOptions;

• Type: projen.github.StaleOptions
• Default: see defaults in StaleOptions

Auto-close stale issues and pull requests.

To disable set stale to false.

---

vscode^Optional

public readonly vscode: boolean;

• Type: boolean
• Default: true

Enable VSCode integration.

Enabled by default for root projects. Disabled for non-root projects.

---

allowLibraryDependencies^Optional

public readonly allowLibraryDependencies: boolean;

• Type: boolean
• Default: true

Allow the project to include peerDependencies and bundledDependencies.

This is normally only allowed for libraries. For apps, there's no meaning for specifying these.

---

authorEmail^Optional

public readonly authorEmail: string;

• Type: string

Author's e-mail.

---

authorName^Optional

public readonly authorName: string;

• Type: string

Author's name.

---

authorOrganization^Optional

public readonly authorOrganization: boolean;

• Type: boolean

Is the author an organization.

---

authorUrl^Optional

public readonly authorUrl: string;

• Type: string

Author's URL / Website.

---

autoDetectBin^Optional

public readonly autoDetectBin: boolean;

• Type: boolean
• Default: true

Automatically add all executables under the bin directory to your package.json file under the bin section.

---

bin^Optional

public readonly bin: {[ key: string ]: string};

• Type: {[ key: string ]: string}

Binary programs vended with your module.

You can use this option to add/customize how binaries are represented in your package.json, but unless autoDetectBin is false, every executable file under bin will automatically be added to this section.

---

bugsEmail^Optional

public readonly bugsEmail: string;

• Type: string

The email address to which issues should be reported.

---

bugsUrl^Optional

public readonly bugsUrl: string;

• Type: string

The url to your project's issue tracker.

---

bundledDeps^Optional

public readonly bundledDeps: string[];

• Type: string[]

List of dependencies to bundle into this module.

These modules will be added both to the dependencies section and bundledDependencies section of your package.json.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

---

codeArtifactOptions^Optional

public readonly codeArtifactOptions: CodeArtifactOptions;

• Type: projen.javascript.CodeArtifactOptions
• Default: undefined

Options for npm packages using AWS CodeArtifact.

This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact

---

deps^Optional

public readonly deps: string[];

• Type: string[]
• Default: []

Runtime dependencies of this module.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

---

Example

[ 'express', 'lodash', 'foo@^2' ]

description^Optional

public readonly description: string;

• Type: string

The description is just a string that helps people understand the purpose of the package.

It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description

---

devDeps^Optional

public readonly devDeps: string[];

• Type: string[]
• Default: []

Build dependencies for this module.

These dependencies will only be available in your build environment but will not be fetched when this module is consumed.

The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.

---

Example

[ 'typescript', '@types/express' ]

entrypoint^Optional

public readonly entrypoint: string;

• Type: string
• Default: "lib/index.js"

Module entrypoint (main in package.json).

Set to an empty string to not include main in your package.json

---

homepage^Optional

public readonly homepage: string;

• Type: string

Package's Homepage / Website.

---

keywords^Optional

public readonly keywords: string[];

• Type: string[]

Keywords to include in package.json.

---

license^Optional

public readonly license: string;

• Type: string
• Default: "Apache-2.0"

License's SPDX identifier.

See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the licensed option if you want to no license to be specified.

---

licensed^Optional

public readonly licensed: boolean;

• Type: boolean
• Default: true

Indicates if a license should be added.

---

maxNodeVersion^Optional

public readonly maxNodeVersion: string;

• Type: string
• Default: no maximum version is enforced

The maximum node version supported by this package. Most projects should not use this option.

The value indicates that the package is incompatible with any newer versions of node. This requirement is enforced via the engines field.

You will normally not need to set this option. Consider this option only if your package is known to not function with newer versions of node.

---

minNodeVersion^Optional

public readonly minNodeVersion: string;

• Type: string
• Default: no minimum version is enforced

The minimum node version required by this package to function. Most projects should not use this option.

The value indicates that the package is incompatible with any older versions of node. This requirement is enforced via the engines field.

You will normally not need to set this option, even if your package is incompatible with EOL versions of node. Consider this option only if your package depends on a specific feature, that is not available in other LTS versions. Setting this option has very high impact on the consumers of your package, as package managers will actively prevent usage with node versions you have marked as incompatible.

To change the node version of your CI/CD workflows, use workflowNodeVersion.

---

npmAccess^Optional

public readonly npmAccess: NpmAccess;

• Type: projen.javascript.NpmAccess
• Default: for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.

Access level of the npm package.

---

npmProvenance^Optional

public readonly npmProvenance: boolean;

• Type: boolean
• Default: true for public packages, false otherwise

Should provenance statements be generated when the package is published.

A supported package manager is required to publish a package with npm provenance statements and you will need to use a supported CI/CD provider.

Note that the projen Release and Publisher components are using publib to publish packages, which is using npm internally and supports provenance statements independently of the package manager used.

https://docs.npmjs.com/generating-provenance-statements

---

npmRegistry^Optional

• Deprecated: use npmRegistryUrl instead

public readonly npmRegistry: string;

• Type: string

The host name of the npm registry to publish to.

Cannot be set together with npmRegistryUrl.

---

npmRegistryUrl^Optional

public readonly npmRegistryUrl: string;

• Type: string
• Default: "https://registry.npmjs.org"

The base URL of the npm package registry.

Must be a URL (e.g. start with "https://" or "http://")

---

npmTokenSecret^Optional

public readonly npmTokenSecret: string;

• Type: string
• Default: "NPM_TOKEN"

GitHub secret which contains the NPM token to use when publishing packages.

---

packageManager^Optional

public readonly packageManager: NodePackageManager;

• Type: projen.javascript.NodePackageManager
• Default: NodePackageManager.YARN_CLASSIC

The Node Package Manager used to execute scripts.

---

packageName^Optional

public readonly packageName: string;

• Type: string
• Default: defaults to project name

The "name" in package.json.

---

peerDependencyOptions^Optional

public readonly peerDependencyOptions: PeerDependencyOptions;

• Type: projen.javascript.PeerDependencyOptions

Options for peerDeps.

---

peerDeps^Optional

public readonly peerDeps: string[];

• Type: string[]
• Default: []

Peer dependencies for this module.

Dependencies listed here are required to be installed (and satisfied) by the consumer of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the node_modules tree of your consumers.

Note that prior to npm@7, peer dependencies are not automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers.

Unless peerDependencyOptions.pinnedDevDependency is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required.

---

pnpmVersion^Optional

public readonly pnpmVersion: string;

• Type: string
• Default: "7"

The version of PNPM to use if using PNPM as a package manager.

---

repository^Optional

public readonly repository: string;

• Type: string

The repository is the location where the actual code for your package lives.

See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository

---

repositoryDirectory^Optional

public readonly repositoryDirectory: string;

• Type: string

If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.

---

scopedPackagesOptions^Optional

public readonly scopedPackagesOptions: ScopedPackagesOptions[];

• Type: projen.javascript.ScopedPackagesOptions[]
• Default: fetch all scoped packages from the public npm registry

Options for privately hosted scoped packages.

---

scripts^Optional

• Deprecated: use project.addTask() or package.setScript()

public readonly scripts: {[ key: string ]: string};

• Type: {[ key: string ]: string}
• Default: {}

npm scripts to include.

If a script has the same name as a standard script, the standard script will be overwritten. Also adds the script as a task.

---

stability^Optional

public readonly stability: string;

• Type: string

Package's Stability.

---

yarnBerryOptions^Optional

public readonly yarnBerryOptions: YarnBerryOptions;

• Type: projen.javascript.YarnBerryOptions
• Default: Yarn Berry v4 with all default options

Options for Yarn Berry.

---

bumpPackage^Optional

public readonly bumpPackage: string;

• Type: string
• Default: A recent version of "commit-and-tag-version"

The commit-and-tag-version compatible package used to bump the package version, as a dependency string.

This can be any compatible package version, including the deprecated standard-version@9.

---

jsiiReleaseVersion^Optional

public readonly jsiiReleaseVersion: string;

• Type: string
• Default: "latest"

Version requirement of publib which is used to publish modules to npm.

---

majorVersion^Optional

public readonly majorVersion: number;

• Type: number
• Default: Major version is not enforced.

Major version to release from the default branch.

If this is specified, we bump the latest version of this major version line. If not specified, we bump the global latest version.

---

minMajorVersion^Optional

public readonly minMajorVersion: number;

• Type: number
• Default: No minimum version is being enforced

Minimal Major version to release.

This can be useful to set to 1, as breaking changes before the 1.x major release are not incrementing the major version number.

Can not be set together with majorVersion.

---

nextVersionCommand^Optional

public readonly nextVersionCommand: string;

• Type: string
• Default: The next version will be determined based on the commit history and project settings.

A shell command to control the next version to release.

If present, this shell command will be run before the bump is executed, and it determines what version to release. It will be executed in the following environment:

• Working directory: the project directory.
• $VERSION: the current version. Looks like 1.2.3.
• $LATEST_TAG: the most recent tag. Looks like prefix-v1.2.3, or may be unset.

The command should print one of the following to stdout:

• Nothing: the next version number will be determined based on commit history.
• x.y.z: the next version number will be x.y.z.
• major|minor|patch: the next version number will be the current version number with the indicated component bumped.

This setting cannot be specified together with minMajorVersion; the invoked script can be used to achieve the effects of minMajorVersion.

---

npmDistTag^Optional

public readonly npmDistTag: string;

• Type: string
• Default: "latest"

The npmDistTag to use when publishing from the default branch.

To set the npm dist-tag for release branches, set the npmDistTag property for each branch.

---

postBuildSteps^Optional

public readonly postBuildSteps: JobStep[];

• Type: projen.github.workflows.JobStep[]
• Default: []

Steps to execute after build as part of the release workflow.

---

prerelease^Optional

public readonly prerelease: string;

• Type: string
• Default: normal semantic versions

Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").

---

publishDryRun^Optional

public readonly publishDryRun: boolean;

• Type: boolean
• Default: false

Instead of actually publishing to package managers, just print the publishing command.

---

publishTasks^Optional

public readonly publishTasks: boolean;

• Type: boolean
• Default: false

Define publishing tasks that can be executed manually as well as workflows.

Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity.

---

releasableCommits^Optional

public readonly releasableCommits: ReleasableCommits;

• Type: projen.ReleasableCommits
• Default: ReleasableCommits.everyCommit()

Find commits that should be considered releasable Used to decide if a release is required.

---

releaseBranches^Optional

public readonly releaseBranches: {[ key: string ]: BranchOptions};

• Type: {[ key: string ]: projen.release.BranchOptions}
• Default: no additional branches are used for release. you can use addBranch() to add additional branches.

Defines additional release branches.

A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch must be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the majorVersion field must also be provided for the default branch.

---

releaseEveryCommit^Optional

• Deprecated: Use releaseTrigger: ReleaseTrigger.continuous() instead

public readonly releaseEveryCommit: boolean;

• Type: boolean
• Default: true

Automatically release new versions every commit to one of branches in releaseBranches.

---

releaseFailureIssue^Optional

public readonly releaseFailureIssue: boolean;

• Type: boolean
• Default: false

Create a github issue on every failed publishing task.

---

releaseFailureIssueLabel^Optional

public readonly releaseFailureIssueLabel: string;

• Type: string
• Default: "failed-release"

The label to apply to issues indicating publish failures.

Only applies if releaseFailureIssue is true.

---

releaseSchedule^Optional

• Deprecated: Use releaseTrigger: ReleaseTrigger.scheduled() instead

public readonly releaseSchedule: string;

• Type: string
• Default: no scheduled releases

CRON schedule to trigger new releases.

---

releaseTagPrefix^Optional

public readonly releaseTagPrefix: string;

• Type: string
• Default: "v"

Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.

Note: this prefix is used to detect the latest tagged version when bumping, so if you change this on a project with an existing version history, you may need to manually tag your latest release with the new prefix.

---

releaseTrigger^Optional

public readonly releaseTrigger: ReleaseTrigger;

• Type: projen.release.ReleaseTrigger
• Default: Continuous releases (ReleaseTrigger.continuous())

The release trigger to use.

---

releaseWorkflowName^Optional

public readonly releaseWorkflowName: string;

• Type: string
• Default: "release"

The name of the default release workflow.

---

releaseWorkflowSetupSteps^Optional

public readonly releaseWorkflowSetupSteps: JobStep[];

• Type: projen.github.workflows.JobStep[]

A set of workflow steps to execute in order to setup the workflow container.

---

versionrcOptions^Optional

public readonly versionrcOptions: {[ key: string ]: any};

• Type: {[ key: string ]: any}
• Default: standard configuration applicable for GitHub repositories

Custom configuration used when creating changelog with commit-and-tag-version package.

Given values either append to default configuration or overwrite values in it.

---

workflowContainerImage^Optional

public readonly workflowContainerImage: string;

• Type: string
• Default: default image

Container image to use for GitHub workflows.

---

workflowRunsOn^Optional

public readonly workflowRunsOn: string[];

• Type: string[]
• Default: ["ubuntu-latest"]

Github Runner selection labels.

---

workflowRunsOnGroup^Optional

public readonly workflowRunsOnGroup: GroupRunnerOptions;

• Type: projen.GroupRunnerOptions

Github Runner Group selection options.

---

defaultReleaseBranch^Required

public readonly defaultReleaseBranch: string;

• Type: string
• Default: "main"

The name of the main release branch.

---

artifactsDirectory^Optional

public readonly artifactsDirectory: string;

• Type: string
• Default: "dist"

A directory which will contain build artifacts.

---

autoApproveUpgrades^Optional

public readonly autoApproveUpgrades: boolean;

• Type: boolean
• Default: true

Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).

Throw if set to true but autoApproveOptions are not defined.

---

buildWorkflow^Optional

public readonly buildWorkflow: boolean;

• Type: boolean
• Default: true if not a subproject

Define a GitHub workflow for building PRs.

---

buildWorkflowOptions^Optional

public readonly buildWorkflowOptions: BuildWorkflowOptions;

• Type: projen.javascript.BuildWorkflowOptions

Options for PR build workflow.

---

buildWorkflowTriggers^Optional

• Deprecated: - Use buildWorkflowOptions.workflowTriggers

public readonly buildWorkflowTriggers: Triggers;

• Type: projen.github.workflows.Triggers
• Default: "{ pullRequest: {}, workflowDispatch: {} }"

Build workflow triggers.

---

bundlerOptions^Optional

public readonly bundlerOptions: BundlerOptions;

• Type: projen.javascript.BundlerOptions

Options for Bundler.

---

checkLicenses^Optional

public readonly checkLicenses: LicenseCheckerOptions;

• Type: projen.javascript.LicenseCheckerOptions
• Default: no license checks are run during the build and all licenses will be accepted

Configure which licenses should be deemed acceptable for use by dependencies.

This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.

---

codeCov^Optional

public readonly codeCov: boolean;

• Type: boolean
• Default: false

Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v4 A secret is required for private repos. Configured with @codeCovTokenSecret.

---

codeCovTokenSecret^Optional

public readonly codeCovTokenSecret: string;

• Type: string
• Default: if this option is not specified, only public repositories are supported

Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.

---

copyrightOwner^Optional

public readonly copyrightOwner: string;

• Type: string
• Default: defaults to the value of authorName or "" if authorName is undefined.

License copyright owner.

---

copyrightPeriod^Optional

public readonly copyrightPeriod: string;

• Type: string
• Default: current year

The copyright years to put in the LICENSE file.

---

dependabot^Optional

public readonly dependabot: boolean;

• Type: boolean
• Default: false

Use dependabot to handle dependency upgrades.

Cannot be used in conjunction with depsUpgrade.

---

dependabotOptions^Optional

public readonly dependabotOptions: DependabotOptions;

• Type: projen.github.DependabotOptions
• Default: default options

Options for dependabot.

---

depsUpgrade^Optional

public readonly depsUpgrade: boolean;

• Type: boolean
• Default: true

Use tasks and github workflows to handle dependency upgrades.

Cannot be used in conjunction with dependabot.

---

depsUpgradeOptions^Optional

public readonly depsUpgradeOptions: UpgradeDependenciesOptions;

• Type: projen.javascript.UpgradeDependenciesOptions
• Default: default options

Options for UpgradeDependencies.

---

gitignore^Optional

public readonly gitignore: string[];

• Type: string[]

Additional entries to .gitignore.

---

jest^Optional

public readonly jest: boolean;

• Type: boolean
• Default: true

Setup jest unit tests.

---

jestOptions^Optional

public readonly jestOptions: JestOptions;

• Type: projen.javascript.JestOptions
• Default: default options

Jest options.

---

mutableBuild^Optional

• Deprecated: - Use buildWorkflowOptions.mutableBuild

public readonly mutableBuild: boolean;

• Type: boolean
• Default: true

Automatically update files modified during builds to pull-request branches.

This means that any files synthesized by projen or e.g. test snapshots will always be up-to-date before a PR is merged.

Implies that PR builds do not have anti-tamper checks.

---

npmignore^Optional

• Deprecated: - use project.addPackageIgnore

public readonly npmignore: string[];

• Type: string[]

Additional entries to .npmignore.

---

npmignoreEnabled^Optional

public readonly npmignoreEnabled: boolean;

• Type: boolean
• Default: true

Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.

---

npmIgnoreOptions^Optional

public readonly npmIgnoreOptions: IgnoreFileOptions;

• Type: projen.IgnoreFileOptions

Configuration options for .npmignore file.

---

package^Optional

public readonly package: boolean;

• Type: boolean
• Default: true

Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist).

---

prettier^Optional

public readonly prettier: boolean;

• Type: boolean
• Default: false

Setup prettier.

---

prettierOptions^Optional

public readonly prettierOptions: PrettierOptions;

• Type: projen.javascript.PrettierOptions
• Default: default options

Prettier options.

---

projenDevDependency^Optional

public readonly projenDevDependency: boolean;

• Type: boolean
• Default: true if not a subproject

Indicates of "projen" should be installed as a devDependency.

---

projenrcJs^Optional

public readonly projenrcJs: boolean;

• Type: boolean
• Default: true if projenrcJson is false

Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation.

---

projenrcJsOptions^Optional

public readonly projenrcJsOptions: ProjenrcOptions;

• Type: projen.javascript.ProjenrcOptions
• Default: default options

Options for .projenrc.js.

---

projenVersion^Optional

public readonly projenVersion: string;

• Type: string
• Default: Defaults to the latest version.

Version of projen to install.

---

pullRequestTemplate^Optional

public readonly pullRequestTemplate: boolean;

• Type: boolean
• Default: true

Include a GitHub pull request template.

---

pullRequestTemplateContents^Optional

public readonly pullRequestTemplateContents: string[];

• Type: string[]
• Default: default content

The contents of the pull request template.

---

release^Optional

public readonly release: boolean;

• Type: boolean
• Default: true (false for subprojects)

Add release management to this project.

---

releaseToNpm^Optional

public readonly releaseToNpm: boolean;

• Type: boolean
• Default: false

Automatically release to npm when new versions are introduced.

---

releaseWorkflow^Optional

• Deprecated: see release.

public readonly releaseWorkflow: boolean;

• Type: boolean
• Default: true if not a subproject

DEPRECATED: renamed to release.

---

workflowBootstrapSteps^Optional

public readonly workflowBootstrapSteps: JobStep[];

• Type: projen.github.workflows.JobStep[]
• Default: "yarn install --frozen-lockfile && yarn projen"

Workflow steps to use in order to bootstrap this repo.

---

workflowGitIdentity^Optional

public readonly workflowGitIdentity: GitIdentity;

• Type: projen.github.GitIdentity
• Default: GitHub Actions

The git identity to use in workflows.

---

workflowNodeVersion^Optional

public readonly workflowNodeVersion: string;

• Type: string
• Default: minNodeVersion if set, otherwise lts/*.

The node version used in GitHub Actions workflows.

Always use this option if your GitHub Actions workflows require a specific to run.

---

workflowPackageCache^Optional

public readonly workflowPackageCache: boolean;

• Type: boolean
• Default: false

Enable Node.js package cache in GitHub workflows.

---

disableTsconfig^Optional

public readonly disableTsconfig: boolean;

• Type: boolean
• Default: false

Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).

---

disableTsconfigDev^Optional

public readonly disableTsconfigDev: boolean;

• Type: boolean
• Default: false

Do not generate a tsconfig.dev.json file.

---

docgen^Optional

public readonly docgen: boolean;

• Type: boolean
• Default: false

Docgen by Typedoc.

---

docsDirectory^Optional

public readonly docsDirectory: string;

• Type: string
• Default: "docs"

Docs directory.

---

entrypointTypes^Optional

public readonly entrypointTypes: string;

• Type: string
• Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)

The .d.ts file that includes the type declarations for this module.

---

eslint^Optional

public readonly eslint: boolean;

• Type: boolean
• Default: true

Setup eslint.

---

eslintOptions^Optional

public readonly eslintOptions: EslintOptions;

• Type: projen.javascript.EslintOptions
• Default: opinionated default options

Eslint options.

---

libdir^Optional

public readonly libdir: string;

• Type: string
• Default: "lib"

Typescript artifacts output directory.

---

projenrcTs^Optional

public readonly projenrcTs: boolean;

• Type: boolean
• Default: false

Use TypeScript for your projenrc file (.projenrc.ts).

---

projenrcTsOptions^Optional

public readonly projenrcTsOptions: ProjenrcOptions;

• Type: projen.typescript.ProjenrcOptions

Options for .projenrc.ts.

---

sampleCode^Optional

public readonly sampleCode: boolean;

• Type: boolean
• Default: true

Generate one-time sample in src/ and test/ if there are no files there.

---

srcdir^Optional

public readonly srcdir: string;

• Type: string
• Default: "src"

Typescript sources directory.

---

testdir^Optional

public readonly testdir: string;

• Type: string
• Default: "test"

Jest tests directory. Tests files should be named xxx.test.ts.

If this directory is under srcdir (e.g. src/test, src/__tests__), then tests are going to be compiled into lib/ and executed as javascript. If the test directory is outside of src, then we configure jest to compile the code in-memory.

---

tsconfig^Optional

public readonly tsconfig: TypescriptConfigOptions;

• Type: projen.javascript.TypescriptConfigOptions
• Default: default options

Custom TSConfig.

---

tsconfigDev^Optional

public readonly tsconfigDev: TypescriptConfigOptions;

• Type: projen.javascript.TypescriptConfigOptions
• Default: use the production tsconfig options

Custom tsconfig options for the development tsconfig.json file (used for testing).

---

tsconfigDevFile^Optional

public readonly tsconfigDevFile: string;

• Type: string
• Default: "tsconfig.dev.json"

The name of the development tsconfig.json file.

---

tsJestOptions^Optional

public readonly tsJestOptions: TsJestOptions;

• Type: projen.typescript.TsJestOptions

Options for ts-jest.

---

typescriptVersion^Optional

public readonly typescriptVersion: string;

• Type: string
• Default: "latest"

TypeScript version to use.

NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~1.2.3).

---

author^Required

public readonly author: string;

• Type: string
• Default: $GIT_USER_NAME

The name of the library author.

---

authorAddress^Required

public readonly authorAddress: string;

• Type: string
• Default: $GIT_USER_EMAIL

Email or URL of the library author.

---

repositoryUrl^Required

public readonly repositoryUrl: string;

• Type: string
• Default: $GIT_REMOTE

Git repository URL.

---

compat^Optional

public readonly compat: boolean;

• Type: boolean
• Default: false

Automatically run API compatibility test against the latest version published to npm after compilation.

You can manually run compatibility tests using yarn compat if this feature is disabled.

• You can ignore compatibility failures by adding lines to a ".compatignore" file.

---

compatIgnore^Optional

public readonly compatIgnore: string;

• Type: string
• Default: ".compatignore"

Name of the ignore file for API compatibility tests.

---

compressAssembly^Optional

public readonly compressAssembly: boolean;

• Type: boolean
• Default: false

Emit a compressed version of the assembly.

---

docgenFilePath^Optional

public readonly docgenFilePath: string;

• Type: string
• Default: "API.md"

File path for generated docs.

---

dotnet^Optional

• Deprecated: use publishToNuget

public readonly dotnet: JsiiDotNetTarget;

• Type: projen.cdk.JsiiDotNetTarget

---

excludeTypescript^Optional

public readonly excludeTypescript: string[];

• Type: string[]

Accepts a list of glob patterns.

Files matching any of those patterns will be excluded from the TypeScript compiler input.

By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input. This can be problematic for example when the package's build or test procedure generates .ts files that cannot be compiled with jsii's compiler settings.

---

jsiiVersion^Optional

public readonly jsiiVersion: string;

• Type: string
• Default: "1.x"

Version of the jsii compiler to use.

Set to "*" if you want to manually manage the version of jsii in your project by managing updates to package.json on your own.

NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~5.0.0).

---

publishToGo^Optional

public readonly publishToGo: JsiiGoTarget;

• Type: projen.cdk.JsiiGoTarget
• Default: no publishing

Publish Go bindings to a git repository.

---

publishToMaven^Optional

public readonly publishToMaven: JsiiJavaTarget;

• Type: projen.cdk.JsiiJavaTarget
• Default: no publishing

Publish to maven.

---

publishToNuget^Optional

public readonly publishToNuget: JsiiDotNetTarget;

• Type: projen.cdk.JsiiDotNetTarget
• Default: no publishing

Publish to NuGet.

---

publishToPypi^Optional

public readonly publishToPypi: JsiiPythonTarget;

• Type: projen.cdk.JsiiPythonTarget
• Default: no publishing

Publish to pypi.

---

python^Optional

• Deprecated: use publishToPyPi

public readonly python: JsiiPythonTarget;

• Type: projen.cdk.JsiiPythonTarget

---

rootdir^Optional

public readonly rootdir: string;

• Type: string
• Default: "."

---

catalog^Optional

public readonly catalog: Catalog;

• Type: projen.cdk.Catalog
• Default: new version will be announced

Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.

https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION

The catalog will also post a tweet to https://twitter.com/awscdkio with the package name, description and the above link. You can disable these tweets through { announce: false }.

You can also add a Twitter handle through { twitter: 'xx' } which will be mentioned in the tweet.

https://github.com/construct-catalog/catalog

---

cdk8sVersion^Required

public readonly cdk8sVersion: string;

• Type: string
• Default: "1.4.10"

Minimum target version this library is tested against.

---

cdk8sPlusVersionPinning^Optional

public readonly cdk8sPlusVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for cdk8s-plus-17.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

cdk8sVersionPinning^Optional

public readonly cdk8sVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for CDK8s.

You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

constructsVersion^Optional

public readonly constructsVersion: string;

• Type: string
• Default: "3.3.196"

constructs verion.

---

constructsVersionPinning^Optional

public readonly constructsVersionPinning: boolean;

• Type: boolean
• Default: false

Use pinned version instead of caret version for constructs.

You can use this to prevent yarn to mix versions for your consructs package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

---

integrationTestAutoDiscover^Optional

public readonly integrationTestAutoDiscover: boolean;

• Type: boolean
• Default: true

Automatically adds an cdk8s.IntegrationTest for each .integ.ts app in your test directory. If this is disabled, you can manually add an cdk8s.AutoDiscover component to your project.

---

IntegrationTestAutoDiscoverOptions

Initializer

import { cdk8s } from 'projen'

const integrationTestAutoDiscoverOptions: cdk8s.IntegrationTestAutoDiscoverOptions = { ... }

Properties

Name	Type	Description
testdir	string	Test source tree.
tsconfigPath	string	Path to the tsconfig file to use for integration tests.

---

testdir^Required

public readonly testdir: string;

• Type: string

Test source tree.

---

tsconfigPath^Required

public readonly tsconfigPath: string;

• Type: string

Path to the tsconfig file to use for integration tests.

---

IntegrationTestOptions

Options for IntegrationTest.

Initializer

import { cdk8s } from 'projen'

const integrationTestOptions: cdk8s.IntegrationTestOptions = { ... }

Properties

Name	Type	Description
entrypoint	string	A path from the project root directory to a TypeScript file which contains the integration test app.
tsconfigPath	string	The path of the tsconfig.json file to use when running integration test cdk apps.
name	string	Name of the integration test.

---

entrypoint^Required

public readonly entrypoint: string;

• Type: string

A path from the project root directory to a TypeScript file which contains the integration test app.

This is relative to the root directory of the project.

---

Example

"test/subdir/foo.integ.ts"

tsconfigPath^Required

public readonly tsconfigPath: string;

• Type: string

The path of the tsconfig.json file to use when running integration test cdk apps.

---

name^Optional

public readonly name: string;

• Type: string
• Default: Derived from the entrypoint filename.

Name of the integration test.

---