`javascript` Submodule

Constructs

Biome

Biome component.

Initializers

import { javascript } from 'projen'

new javascript.Biome(project: NodeProject, options?: BiomeOptions)

Name	Type	Description
`project`	`NodeProject`	No description.
`options`	`BiomeOptions`	No description.

`project`^Required

Type: NodeProject

`options`^Optional

Type: BiomeOptions

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.
`addFilePattern`	No description.

`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.

`addFilePattern`

public addFilePattern(pattern: string): void

`pattern`^Required

Type: string

Static Functions

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

`isConstruct`

import { javascript } from 'projen'

javascript.Biome.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 { javascript } from 'projen'

javascript.Biome.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { javascript } from 'projen'

javascript.Biome.of(project: Project)

`project`^Required

Type: projen.Project

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`file`	`projen.JsonFile`	Biome configuration file content.
`task`	`projen.Task`	Biome task.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`file`^Required

public readonly file: JsonFile;

Type: projen.JsonFile

Biome configuration file content.

`task`^Required

public readonly task: Task;

Type: projen.Task

Biome task.

Bundler

Adds support for bundling JavaScript applications and dependencies into a single file.

In the future, this will also supports bundling websites.

Initializers

import { javascript } from 'projen'

new javascript.Bundler(project: Project, options?: BundlerOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`BundlerOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Optional

Type: BundlerOptions

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.
`addBundle`	Adds a task to the project which bundles a specific entrypoint and all of its dependencies into a single javascript output file.

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

`addBundle`

public addBundle(entrypoint: string, options: AddBundleOptions): Bundle

Adds a task to the project which bundles a specific entrypoint and all of its dependencies into a single javascript output file.

`entrypoint`^Required

Type: string

The relative path of the artifact within the project.

`options`^Required

Type: AddBundleOptions

Bundling options.

Static Functions

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

`isConstruct`

import { javascript } from 'projen'

javascript.Bundler.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { javascript } from 'projen'

javascript.Bundler.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { javascript } from 'projen'

javascript.Bundler.of(project: Project)

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

`project`^Required

Type: projen.Project

The project.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`bundledir`	`string`	Root bundle directory.
`bundleTask`	`projen.Task`	Gets or creates the singleton "bundle" task of the project.
`esbuildVersion`	`string`	The semantic version requirement for `esbuild` (if defined).

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`bundledir`^Required

public readonly bundledir: string;

Type: string

Root bundle directory.

`bundleTask`^Required

public readonly bundleTask: Task;

Type: projen.Task

Gets or creates the singleton "bundle" task of the project.

If the project doesn't have a "bundle" task, it will be created and spawned during the pre-compile phase.

`esbuildVersion`^Optional

public readonly esbuildVersion: string;

Type: string

The semantic version requirement for esbuild (if defined).

Eslint

Represents eslint configuration.

Initializers

import { javascript } from 'projen'

new javascript.Eslint(project: NodeProject, options: EslintOptions)

Name	Type	Description
`project`	`NodeProject`	No description.
`options`	`EslintOptions`	No description.

`project`^Required

Type: NodeProject

`options`^Required

Type: EslintOptions

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.
`addExtends`	Adds an `extends` item to the eslint configuration.
`addIgnorePattern`	Do not lint these files.
`addLintPattern`	Add a file, glob pattern or directory with source files to lint (e.g. [ "src" ]).
`addOverride`	Add an eslint override.
`addPlugins`	Adds an eslint plugin.
`addRules`	Add an eslint rule.
`allowDevDeps`	Add a glob file pattern which allows importing dev dependencies.

`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.

`addExtends`

public addExtends(extendList: ...string[]): void

Adds an extends item to the eslint configuration.

`extendList`^Required

Type: ...string[]

The list of "extends" to add.

`addIgnorePattern`

public addIgnorePattern(pattern: string): void

Do not lint these files.

`pattern`^Required

Type: string

`addLintPattern`

public addLintPattern(pattern: string): void

Add a file, glob pattern or directory with source files to lint (e.g. [ "src" ]).

`pattern`^Required

Type: string

`addOverride`

public addOverride(override: EslintOverride): void

Add an eslint override.

`override`^Required

Type: EslintOverride

`addPlugins`

public addPlugins(plugins: ...string[]): void

Adds an eslint plugin.

`plugins`^Required

Type: ...string[]

The names of plugins to add.

`addRules`

public addRules(rules: {[ key: string ]: any}): void

Add an eslint rule.

`rules`^Required

Type: {[ key: string ]: any}

`allowDevDeps`

public allowDevDeps(pattern: string): void

Add a glob file pattern which allows importing dev dependencies.

`pattern`^Required

Type: string

glob pattern.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.
`of`	Returns the singleton Eslint component of a project or undefined if there is none.

`isConstruct`

import { javascript } from 'projen'

javascript.Eslint.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { javascript } from 'projen'

javascript.Eslint.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { javascript } from 'projen'

javascript.Eslint.of(project: Project)

Returns the singleton Eslint component of a project or undefined if there is none.

`project`^Required

Type: projen.Project

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`config`	`any`	Direct access to the eslint configuration (escape hatch).
`eslintTask`	`projen.Task`	eslint task.
`file`	`projen.ObjectFile`	The underlying config file.
`ignorePatterns`	`string[]`	File patterns that should not be linted.
`lintPatterns`	`string[]`	Returns an immutable copy of the lintPatterns being used by this eslint configuration.
`overrides`	`EslintOverride[]`	eslint overrides.
`rules`	`{[ key: string ]: any}`	eslint rules.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`config`^Required

public readonly config: any;

Type: any

Direct access to the eslint configuration (escape hatch).

`eslintTask`^Required

public readonly eslintTask: Task;

Type: projen.Task

eslint task.

`file`^Required

public readonly file: ObjectFile;

Type: projen.ObjectFile

The underlying config file.

`ignorePatterns`^Required

public readonly ignorePatterns: string[];

Type: string[]

File patterns that should not be linted.

`lintPatterns`^Required

public readonly lintPatterns: string[];

Type: string[]

Returns an immutable copy of the lintPatterns being used by this eslint configuration.

`overrides`^Required

public readonly overrides: EslintOverride[];

Type: EslintOverride[]

eslint overrides.

`rules`^Required

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

Type: {[ key: string ]: any}

eslint rules.

Jest

Installs the following npm scripts:.

test, intended for testing locally and in CI. Will update snapshots unless updateSnapshot: UpdateSnapshot: NEVER is set.

test:watch, intended for automatically rerunning tests when files change.
test:update, intended for testing locally and updating snapshots to match the latest unit under test. Only available when updateSnapshot: UpdateSnapshot: NEVER.

Initializers

import { javascript } from 'projen'

new javascript.Jest(scope: IConstruct, options?: JestOptions)

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

`scope`^Required

Type: constructs.IConstruct

`options`^Optional

Type: JestOptions

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.
`addIgnorePattern`	No description.
`addModuleNameMappers`	Adds one or more moduleNameMapper entries to Jest's configuration.
`addModulePaths`	Adds one or more modulePaths to Jest's configuration.
`addReporter`	No description.
`addRoots`	Adds one or more roots to Jest's configuration.
`addSetupFile`	Adds a a setup file to Jest's setupFiles configuration.
`addSetupFileAfterEnv`	Adds a a setup file to Jest's setupFilesAfterEnv configuration.
`addSnapshotResolver`	No description.
`addTestMatch`	Adds a test match pattern.
`addWatchIgnorePattern`	Adds a watch ignore pattern.
`discoverTestMatchPatternsForDirs`	Build standard test match patterns for a 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.

`addIgnorePattern`

public addIgnorePattern(pattern: string): void

`pattern`^Required

Type: string

`addModuleNameMappers`

public addModuleNameMappers(moduleNameMapperAdditions: {[ key: string ]: string | string[]}): void

Adds one or more moduleNameMapper entries to Jest's configuration.

Will overwrite if the same key is used as a pre-existing one.

`moduleNameMapperAdditions`^Required

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

A map from regular expressions to module names or to arrays of module names that allow to stub out resources, like images or styles with a single module.

`addModulePaths`

public addModulePaths(modulePaths: ...string[]): void

Adds one or more modulePaths to Jest's configuration.

`modulePaths`^Required

Type: ...string[]

An array of absolute paths to additional locations to search when resolving modules *.

`addReporter`

public addReporter(reporter: JestReporter): void

`reporter`^Required

Type: JestReporter

`addRoots`

public addRoots(roots: ...string[]): void

Adds one or more roots to Jest's configuration.

`roots`^Required

Type: ...string[]

A list of paths to directories that Jest should use to search for files in.

`addSetupFile`

public addSetupFile(file: string): void

Adds a a setup file to Jest's setupFiles configuration.

`file`^Required

Type: string

File path to setup file.

`addSetupFileAfterEnv`

public addSetupFileAfterEnv(file: string): void

Adds a a setup file to Jest's setupFilesAfterEnv configuration.

`file`^Required

Type: string

File path to setup file.

`addSnapshotResolver`

public addSnapshotResolver(file: string): void

`file`^Required

Type: string

`addTestMatch`

public addTestMatch(pattern: string): void

Adds a test match pattern.

`pattern`^Required

Type: string

glob pattern to match for tests.

`addWatchIgnorePattern`

public addWatchIgnorePattern(pattern: string): void

Adds a watch ignore pattern.

`pattern`^Required

Type: string

The pattern (regular expression).

`discoverTestMatchPatternsForDirs`

public discoverTestMatchPatternsForDirs(dirs: string[], options?: JestDiscoverTestMatchPatternsForDirsOptions): void

Build standard test match patterns for a directory.

`dirs`^Required

Type: string[]

The directories to add test matches for.

Matches any folder if not specified or an empty array.

`options`^Optional

Type: JestDiscoverTestMatchPatternsForDirsOptions

Options for building test match patterns.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.
`of`	Returns the singleton Jest component of a project or undefined if there is none.

`isConstruct`

import { javascript } from 'projen'

javascript.Jest.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { javascript } from 'projen'

javascript.Jest.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { javascript } from 'projen'

javascript.Jest.of(project: Project)

Returns the singleton Jest component of a project or undefined if there is none.

`project`^Required

Type: projen.Project

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`NodeProject`	No description.
`config`	`any`	Escape hatch.
`jestVersion`	`string`	Jest version, including `@` symbol, like `@^29`.
`file`	`projen.JsonFile`	Jest config file.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: NodeProject;

Type: NodeProject

`config`^Required

public readonly config: any;

Type: any

Escape hatch.

`jestVersion`^Required

public readonly jestVersion: string;

Type: string

Jest version, including @ symbol, like @^29.

`file`^Optional

public readonly file: JsonFile;

Type: projen.JsonFile

Jest config file.

undefined if settings are written to package.json

LicenseChecker

Enforces allowed licenses used by dependencies.

Initializers

import { javascript } from 'projen'

new javascript.LicenseChecker(scope: Construct, options: LicenseCheckerOptions)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`options`	`LicenseCheckerOptions`	No description.

`scope`^Required

Type: constructs.Construct

`options`^Required

Type: LicenseCheckerOptions

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

javascript.LicenseChecker.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { javascript } from 'projen'

javascript.LicenseChecker.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.
`task`	`projen.Task`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`task`^Required

public readonly task: Task;

Type: projen.Task

NodePackage

Represents the npm package.json file.

Initializers

import { javascript } from 'projen'

new javascript.NodePackage(project: Project, options?: NodePackageOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`NodePackageOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Optional

Type: NodePackageOptions

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.
`addBin`	No description.
`addBundledDeps`	Defines bundled dependencies.
`addDeps`	Defines normal dependencies.
`addDevDeps`	Defines development/test dependencies.
`addEngine`	Adds an `engines` requirement to your package.
`addField`	Directly set fields in `package.json`.
`addKeywords`	Adds keywords to package.json (deduplicated).
`addPackageResolutions`	Defines resolutions for dependencies to change the normally resolved version of a dependency to something else.
`addPeerDeps`	Defines peer dependencies.
`addVersion`	Sets the package version.
`hasScript`	Indicates if a script by the given name is defined.
`removeScript`	Removes an npm script (always successful).
`setScript`	Add a npm package.json script.
`tryResolveDependencyVersion`	Attempt to resolve the currently installed version for a given dependency.

`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.

`addBin`

public addBin(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.

`addDeps`

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

Defines normal dependencies.

`deps`^Required

Type: ...string[]

Names modules to install.

`addDevDeps`

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

Defines development/test dependencies.

`deps`^Required

Type: ...string[]

Names modules to install.

`addEngine`

public addEngine(engine: string, version: string): void

Adds an engines requirement to your package.

`engine`^Required

Type: string

The engine (e.g. node).

`version`^Required

Type: string

The semantic version requirement (e.g. ^10).

`addField`

public addField(name: string, value: any): void

Directly set fields in package.json.

`name`^Required

Type: string

field name.

`value`^Required

Type: any

field value.

`addKeywords`

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

Adds keywords to package.json (deduplicated).

`keywords`^Required

Type: ...string[]

The keywords to add.

`addPackageResolutions`

public addPackageResolutions(resolutions: ...string[]): void

Defines resolutions for dependencies to change the normally resolved version of a dependency to something else.

`resolutions`^Required

Type: ...string[]

Names resolutions to be added.

Specify a version or range with this syntax: module@^7

`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.

`addVersion`

public addVersion(version: string): void

Sets the package version.

`version`^Required

Type: string

Package version.

`hasScript`

public hasScript(name: string): boolean

Indicates if a script by the given name is defined.

`name`^Required

Type: string

The name of the script.

`removeScript`

public removeScript(name: string): void

Removes an npm script (always successful).

`name`^Required

Type: string

The name of the script.

`setScript`

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

Add a npm package.json script.

`name`^Required

Type: string

The script name.

`command`^Required

Type: string

The command to execute.

`tryResolveDependencyVersion`

public tryResolveDependencyVersion(dependencyName: string): string

Attempt to resolve the currently installed version for a given dependency.

`dependencyName`^Required

Type: string

Dependency to resolve for.

Static Functions

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

`isConstruct`

import { javascript } from 'projen'

javascript.NodePackage.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { javascript } from 'projen'

javascript.NodePackage.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { javascript } from 'projen'

javascript.NodePackage.of(project: Project)

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

`project`^Required

Type: projen.Project

The project.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`allowLibraryDependencies`	`boolean`	Allow project to take library dependencies.
`entrypoint`	`string`	The module's entrypoint (e.g. `lib/index.js`).
`file`	`projen.JsonFile`	The package.json file.
`installAndUpdateLockfileCommand`	`string`	Renders `yarn install` or `npm install` with lockfile update (not frozen).
`installCiTask`	`projen.Task`	The task for installing project dependencies (frozen).
`installCommand`	`string`	Returns the command to execute in order to install all dependencies (always frozen).
`installTask`	`projen.Task`	The task for installing project dependencies (non-frozen).
`lockFile`	`string`	The name of the lock file.
`manifest`	`any`	No description.
`npmAccess`	`NpmAccess`	npm package access level.
`npmProvenance`	`boolean`	Should provenance statements be generated when package is published.
`npmRegistry`	`string`	The npm registry host (e.g. `registry.npmjs.org`).
`npmRegistryUrl`	`string`	npm registry (e.g. `https://registry.npmjs.org`). Use `npmRegistryHost` to get just the host name.
`packageManager`	`NodePackageManager`	The package manager to use.
`packageName`	`string`	The name of the npm package.
`projenCommand`	`string`	The command which executes "projen".
`bunVersion`	`string`	The version of Bun to use if using Bun as a package manager.
`codeArtifactOptions`	`CodeArtifactOptions`	Options for npm packages using AWS CodeArtifact.
`license`	`string`	The SPDX license of this module.
`maxNodeVersion`	`string`	Maximum node version supported by this package.
`minNodeVersion`	`string`	The minimum node version required by this package to function.
`npmTokenSecret`	`string`	GitHub secret which contains the NPM token to use when publishing packages.
`pnpmVersion`	`string`	The version of PNPM to use if using PNPM as a package manager.
`scopedPackagesOptions`	`ScopedPackagesOptions[]`	Options for privately hosted scoped packages.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`allowLibraryDependencies`^Required

public readonly allowLibraryDependencies: boolean;

Type: boolean

Allow project to take library dependencies.

`entrypoint`^Required

public readonly entrypoint: string;

Type: string

The module's entrypoint (e.g. lib/index.js).

`file`^Required

public readonly file: JsonFile;

Type: projen.JsonFile

The package.json file.

`installAndUpdateLockfileCommand`^Required

public readonly installAndUpdateLockfileCommand: string;

Type: string

Renders yarn install or npm install with lockfile update (not frozen).

`installCiTask`^Required

public readonly installCiTask: Task;

Type: projen.Task

The task for installing project dependencies (frozen).

`installCommand`^Required

public readonly installCommand: string;

Type: string

Returns the command to execute in order to install all dependencies (always frozen).

`installTask`^Required

public readonly installTask: Task;

Type: projen.Task

The task for installing project dependencies (non-frozen).

`lockFile`^Required

public readonly lockFile: string;

Type: string

The name of the lock file.

`manifest`^Required

Deprecated: use addField(x, y)

public readonly manifest: any;

Type: any

`npmAccess`^Required

public readonly npmAccess: NpmAccess;

Type: NpmAccess

npm package access level.

`npmProvenance`^Required

public readonly npmProvenance: boolean;

Type: boolean

Should provenance statements be generated when package is published.

`npmRegistry`^Required

public readonly npmRegistry: string;

Type: string

The npm registry host (e.g. registry.npmjs.org).

`npmRegistryUrl`^Required

public readonly npmRegistryUrl: string;

Type: string

npm registry (e.g. https://registry.npmjs.org). Use npmRegistryHost to get just the host name.

`packageManager`^Required

public readonly packageManager: NodePackageManager;

Type: NodePackageManager

The package manager to use.

`packageName`^Required

public readonly packageName: string;

Type: string

The name of the npm package.

`projenCommand`^Required

Deprecated: use project.projenCommand instead.

public readonly projenCommand: string;

Type: string

The command which executes "projen".

`bunVersion`^Optional

public readonly bunVersion: string;

Type: string

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

`codeArtifactOptions`^Optional

public readonly codeArtifactOptions: CodeArtifactOptions;

Type: CodeArtifactOptions
Default: undefined

Options for npm packages using AWS CodeArtifact.

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

`license`^Optional

public readonly license: string;

Type: string

The SPDX license of this module.

undefined if this package is not licensed.

`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.

`npmTokenSecret`^Optional

public readonly npmTokenSecret: string;

Type: string

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

`pnpmVersion`^Optional

public readonly pnpmVersion: string;

Type: string

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

`scopedPackagesOptions`^Optional

public readonly scopedPackagesOptions: ScopedPackagesOptions[];

Type: ScopedPackagesOptions[]
Default: undefined

Options for privately hosted scoped packages.

NodeProject

Node.js project.

Initializers

import { javascript } from 'projen'

new javascript.NodeProject(options: NodeProjectOptions)

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

`options`^Required

Type: NodeProjectOptions

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.

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

`tryFindFile`

public tryFindFile(filePath: string): FileBase

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

`filePath`^Required

Type: string

The file path.

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

`tryFindJsonFile`

public tryFindJsonFile(filePath: string): JsonFile

Finds a json file by name.

`filePath`^Required

Type: string

The file path.

`tryFindObjectFile`

public tryFindObjectFile(filePath: string): ObjectFile

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

`filePath`^Required

Type: string

The file path.

`tryRemoveFile`

public tryRemoveFile(filePath: string): FileBase

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

`filePath`^Required

Type: string

The file path.

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

`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.

`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.

`addDevDeps`

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

Defines development/test dependencies.

`deps`^Required

Type: ...string[]

Names modules to install.

`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.

`deps`^Required

Type: ...string[]

Names modules to install.

`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: 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 { javascript } from 'projen'

javascript.NodeProject.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isProject`

import { javascript } from 'projen'

javascript.NodeProject.isProject(x: any)

Test whether the given construct is a project.

`x`^Required

Type: any

`of`

import { javascript } from 'projen'

javascript.NodeProject.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`	`Bundler`	No description.
`entrypoint`	`string`	No description.
`manifest`	`any`	No description.
`npmrc`	`NpmConfig`	The .npmrc file.
`package`	`NodePackage`	API for managing the node package.
`packageManager`	`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.
`biome`	`Biome`	No description.
`buildWorkflow`	`projen.build.BuildWorkflow`	The PR build GitHub workflow.
`buildWorkflowJobId`	`string`	The job ID of the build workflow.
`jest`	`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`	`Prettier`	No description.
`publisher`	`projen.release.Publisher`	Package publisher.
`release`	`projen.release.Release`	Release management.
`upgradeWorkflow`	`UpgradeDependencies`	The upgrade workflow.

`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: 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: NpmConfig

The .npmrc file.

`package`^Required

public readonly package: NodePackage;

Type: NodePackage

API for managing the node package.

`packageManager`^Required

Deprecated: use package.packageManager

public readonly packageManager: NodePackageManager;

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

`biome`^Optional

public readonly biome: Biome;

Type: Biome

`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: 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: 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: UpgradeDependencies

The upgrade workflow.

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.

NpmConfig

File representing the local NPM config in .npmrc.

Initializers

import { javascript } from 'projen'

new javascript.NpmConfig(project: NodeProject, options?: NpmConfigOptions)

Name	Type	Description
`project`	`NodeProject`	No description.
`options`	`NpmConfigOptions`	No description.

`project`^Required

Type: NodeProject

`options`^Optional

Type: NpmConfigOptions

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.
`addConfig`	configure a generic property.
`addRegistry`	configure a scoped registry.

`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.

`addConfig`

public addConfig(name: string, value: string): void

configure a generic property.

`name`^Required

Type: string

the name of the property.

`value`^Required

Type: string

the value of the property.

`addRegistry`

public addRegistry(url: string, scope?: string): void

configure a scoped registry.

`url`^Required

Type: string

the URL of the registry to use.

`scope`^Optional

Type: string

the scope the registry is used for;

leave empty for the default registry

Static Functions

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

`isConstruct`

import { javascript } from 'projen'

javascript.NpmConfig.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { javascript } from 'projen'

javascript.NpmConfig.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

Prettier

Represents prettier configuration.

Initializers

import { javascript } from 'projen'

new javascript.Prettier(project: NodeProject, options: PrettierOptions)

Name	Type	Description
`project`	`NodeProject`	No description.
`options`	`PrettierOptions`	No description.

`project`^Required

Type: NodeProject

`options`^Required

Type: PrettierOptions

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.
`addIgnorePattern`	Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore.
`addOverride`	Add a prettier override.

`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.

`addIgnorePattern`

public addIgnorePattern(pattern: string): void

Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore.

`pattern`^Required

Type: string

filepatterns so exclude from prettier formatting.

`addOverride`

public addOverride(override: PrettierOverride): void

Add a prettier override.

https://prettier.io/docs/en/configuration.html#configuration-overrides

`override`^Required

Type: PrettierOverride

Static Functions

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

`isConstruct`

import { javascript } from 'projen'

javascript.Prettier.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { javascript } from 'projen'

javascript.Prettier.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { javascript } from 'projen'

javascript.Prettier.of(project: Project)

`project`^Required

Type: projen.Project

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`overrides`	`PrettierOverride[]`	Returns all Prettier overrides.
`settings`	`PrettierSettings`	Direct access to the prettier settings.
`ignoreFile`	`projen.IgnoreFile`	The .prettierIgnore file.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`overrides`^Required

public readonly overrides: PrettierOverride[];

Type: PrettierOverride[]

Returns all Prettier overrides.

`settings`^Required

public readonly settings: PrettierSettings;

Type: PrettierSettings

Direct access to the prettier settings.

`ignoreFile`^Optional

public readonly ignoreFile: IgnoreFile;

Type: projen.IgnoreFile

The .prettierIgnore file.

Projenrc

A projenrc file written in JavaScript.

This component can be instantiated in any type of project and has no expectations around the project's main language.

Initializers

import { javascript } from 'projen'

new javascript.Projenrc(project: Project, options?: ProjenrcOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`ProjenrcOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Optional

Type: ProjenrcOptions

Methods

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

`toString`

public toString(): string

Returns a string representation of this construct.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

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

`isConstruct`

import { javascript } from 'projen'

javascript.Projenrc.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { javascript } from 'projen'

javascript.Projenrc.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { javascript } from 'projen'

javascript.Projenrc.of(project: Project)

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

`project`^Required

Type: projen.Project

The project.

Properties

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

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`filePath`^Required

public readonly filePath: string;

Type: string

The path of the projenrc file.

TypescriptConfig

Initializers

import { javascript } from 'projen'

new javascript.TypescriptConfig(project: Project, options: TypescriptConfigOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`TypescriptConfigOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Required

Type: TypescriptConfigOptions

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.
`addExclude`	Add an exclude pattern to the `exclude` array of the TSConfig.
`addExtends`	Extend from base `TypescriptConfig` instance.
`addInclude`	Add an include pattern to the `include` array of the TSConfig.
`removeExclude`	Remove an exclude pattern from the `exclude` array of the TSConfig.
`removeInclude`	Remove an include pattern from the `include` array of the TSConfig.
`resolveExtendsPath`	Resolve valid TypeScript extends paths relative to this config.

`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.

`addExclude`

public addExclude(pattern: string): void

Add an exclude pattern to the exclude array of the TSConfig.

https://www.typescriptlang.org/tsconfig#exclude

`pattern`^Required

Type: string

The pattern to add.

`addExtends`

public addExtends(value: TypescriptConfig): void

Extend from base TypescriptConfig instance.

`value`^Required

Type: TypescriptConfig

Base TypescriptConfig instance.

`addInclude`

public addInclude(pattern: string): void

Add an include pattern to the include array of the TSConfig.

https://www.typescriptlang.org/tsconfig#include

`pattern`^Required

Type: string

The pattern to add.

`removeExclude`

public removeExclude(pattern: string): void

Remove an exclude pattern from the exclude array of the TSConfig.

https://www.typescriptlang.org/tsconfig#exclude

`pattern`^Required

Type: string

The pattern to remove.

`removeInclude`

public removeInclude(pattern: string): void

Remove an include pattern from the include array of the TSConfig.

https://www.typescriptlang.org/tsconfig#include

`pattern`^Required

Type: string

The pattern to remove.

`resolveExtendsPath`

public resolveExtendsPath(configPath: string): string

Resolve valid TypeScript extends paths relative to this config.

`configPath`^Required

Type: string

Path to resolve against.

Static Functions

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

`isConstruct`

import { javascript } from 'projen'

javascript.TypescriptConfig.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { javascript } from 'projen'

javascript.TypescriptConfig.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.
`exclude`	`string[]`	No description.
`extends`	`string[]`	Array of base `tsconfig.json` paths. Any absolute paths are resolved relative to this instance, while any relative paths are used as is.
`file`	`projen.JsonFile`	No description.
`fileName`	`string`	No description.
`include`	`string[]`	No description.
`compilerOptions`	`TypeScriptCompilerOptions`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`exclude`^Required

public readonly exclude: string[];

Type: string[]

`extends`^Required

public readonly extends: string[];

Type: string[]

Array of base tsconfig.json paths. Any absolute paths are resolved relative to this instance, while any relative paths are used as is.

`file`^Required

public readonly file: JsonFile;

Type: projen.JsonFile

`fileName`^Required

public readonly fileName: string;

Type: string

`include`^Required

public readonly include: string[];

Type: string[]

`compilerOptions`^Optional

public readonly compilerOptions: TypeScriptCompilerOptions;

Type: TypeScriptCompilerOptions

UpgradeDependencies

Upgrade node project dependencies.

Initializers

import { javascript } from 'projen'

new javascript.UpgradeDependencies(project: NodeProject, options?: UpgradeDependenciesOptions)

Name	Type	Description
`project`	`NodeProject`	No description.
`options`	`UpgradeDependenciesOptions`	No description.

`project`^Required

Type: NodeProject

`options`^Optional

Type: UpgradeDependenciesOptions

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.
`addPostBuildSteps`	Add steps to execute a successful build.

`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.

`addPostBuildSteps`

public addPostBuildSteps(steps: ...JobStep[]): void

Add steps to execute a successful build.

`steps`^Required

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

workflow steps.

Static Functions

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

`isConstruct`

import { javascript } from 'projen'

javascript.UpgradeDependencies.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { javascript } from 'projen'

javascript.UpgradeDependencies.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`	`NodeProject`	No description.
`postUpgradeTask`	`projen.Task`	A task run after the upgrade task.
`upgradeTask`	`projen.Task`	The upgrade task.
`workflows`	`projen.github.GithubWorkflow[]`	The workflows that execute the upgrades.
`containerOptions`	`projen.github.workflows.ContainerOptions`	Container definitions for the upgrade workflow.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: NodeProject;

Type: NodeProject

`postUpgradeTask`^Required

public readonly postUpgradeTask: Task;

Type: projen.Task

A task run after the upgrade task.

`upgradeTask`^Required

public readonly upgradeTask: Task;

Type: projen.Task

The upgrade task.

`workflows`^Required

public readonly workflows: GithubWorkflow[];

Type: projen.github.GithubWorkflow[]

The workflows that execute the upgrades.

One workflow per branch.

`containerOptions`^Optional

public readonly containerOptions: ContainerOptions;

Type: projen.github.workflows.ContainerOptions

Container definitions for the upgrade workflow.

Yarnrc

Initializers

import { javascript } from 'projen'

new javascript.Yarnrc(project: Project, version: string, options?: YarnrcOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`version`	`string`	No description.
`options`	`YarnrcOptions`	No description.

`project`^Required

Type: projen.Project

`version`^Required

Type: string

`options`^Optional

Type: YarnrcOptions

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

javascript.Yarnrc.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { javascript } from 'projen'

javascript.Yarnrc.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

Structs

AddBundleOptions

Options for addBundle().

Initializer

import { javascript } from 'projen'

const addBundleOptions: javascript.AddBundleOptions = { ... }

Properties

Name	Type	Description
`externals`	`string[]`	You can mark a file or a package as external to exclude it from your build.
`sourcemap`	`boolean`	Include a source map in the bundle.
`watchTask`	`boolean`	In addition to the `bundle:xyz` task, creates `bundle:xyz:watch` task which will invoke the same esbuild command with the `--watch` flag.
`platform`	`string`	esbuild platform.
`target`	`string`	esbuild target.
`banner`	`string`	Use this to insert an arbitrary string at the beginning of generated JavaScript files.
`charset`	`Charset`	The charset to use for esbuild's output.
`define`	`{[ key: string ]: string}`	Replace global identifiers with constant expressions.
`esbuildArgs`	`{[ key: string ]: string \| boolean}`	Build arguments to pass into esbuild.
`executable`	`boolean`	Mark the output file as executable.
`footer`	`string`	Use this to insert an arbitrary string at the end of generated JavaScript files.
`format`	`string`	Output format for the generated JavaScript files.
`inject`	`string[]`	This option allows you to automatically replace a global variable with an import from another file.
`keepNames`	`boolean`	Whether to preserve the original `name` values even in minified code.
`loaders`	`{[ key: string ]: string}`	Map of file extensions (without dot) and loaders to use for this file type.
`logLevel`	`BundleLogLevel`	Log level for esbuild.
`mainFields`	`string[]`	How to determine the entry point for modules.
`metafile`	`boolean`	This option tells esbuild to write out a JSON file relative to output directory with metadata about the build.
`minify`	`boolean`	Whether to minify files when bundling.
`outfile`	`string`	Bundler output path relative to the asset's output directory.
`sourceMapMode`	`SourceMapMode`	Source map mode to be used when bundling.
`sourcesContent`	`boolean`	Whether to include original source code in source maps when bundling.
`tsconfigPath`	`string`	The path of the tsconfig.json file to use for bundling.

`externals`^Optional

public readonly externals: string[];

Type: string[]
Default: []

You can mark a file or a package as external to exclude it from your build.

Instead of being bundled, the import will be preserved (using require for the iife and cjs formats and using import for the esm format) and will be evaluated at run time instead.

This has several uses. First of all, it can be used to trim unnecessary code from your bundle for a code path that you know will never be executed. For example, a package may contain code that only runs in node but you will only be using that package in the browser. It can also be used to import code in node at run time from a package that cannot be bundled. For example, the fsevents package contains a native extension, which esbuild doesn't support.

`sourcemap`^Optional

public readonly sourcemap: boolean;

Type: boolean
Default: false

Include a source map in the bundle.

`watchTask`^Optional

public readonly watchTask: boolean;

Type: boolean
Default: true

In addition to the bundle:xyz task, creates bundle:xyz:watch task which will invoke the same esbuild command with the --watch flag.

This can be used to continusouly watch for changes.

`platform`^Required

public readonly platform: string;

Type: string

esbuild platform.

Example

"node"

`target`^Required

public readonly target: string;

Type: string

esbuild target.

Example

"node12"

`banner`^Optional

public readonly banner: string;

Type: string
Default: no comments are passed

Use this to insert an arbitrary string at the beginning of generated JavaScript files.

This is similar to footer which inserts at the end instead of the beginning.

This is commonly used to insert comments:

`charset`^Optional

public readonly charset: Charset;

Type: Charset
Default: Charset.ASCII

The charset to use for esbuild's output.

By default esbuild's output is ASCII-only. Any non-ASCII characters are escaped using backslash escape sequences. Using escape sequences makes the generated output slightly bigger, and also makes it harder to read. If you would like for esbuild to print the original characters without using escape sequences, use Charset.UTF8.

https://esbuild.github.io/api/#charset

`define`^Optional

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

Type: {[ key: string ]: string}
Default: no replacements are made

Replace global identifiers with constant expressions.

For example, { 'process.env.DEBUG': 'true' }.

Another example, { 'process.env.API_KEY': JSON.stringify('xxx-xxxx-xxx') }.

`esbuildArgs`^Optional

public readonly esbuildArgs: {[ key: string ]: string | boolean};

Type: {[ key: string ]: string | boolean}
Default: no additional esbuild arguments are passed

Build arguments to pass into esbuild.

For example, to add the --log-limit flag:

project.bundler.addBundle("./src/hello.ts", {
  platform: "node",
  target: "node22",
  sourcemap: true,
  format: "esm",
  esbuildArgs: {
    "--log-limit": "0",
  },
});

`executable`^Optional

public readonly executable: boolean;

Type: boolean
Default: false

Mark the output file as executable.

`footer`^Optional

public readonly footer: string;

Type: string
Default: no comments are passed

Use this to insert an arbitrary string at the end of generated JavaScript files.

This is similar to banner which inserts at the beginning instead of the end.

This is commonly used to insert comments

`format`^Optional

public readonly format: string;

Type: string
Default: undefined

Output format for the generated JavaScript files.

There are currently three possible values that can be configured: "iife", "cjs", and "esm".

If not set (undefined), esbuild picks an output format for you based on platform:

"cjs" if platform is "node"
"iife" if platform is "browser"
"esm" if platform is "neutral"

Note: If making a bundle to run under node with ESM, set format to "esm" instead of setting platform to "neutral".

https://esbuild.github.io/api/#format

`inject`^Optional

public readonly inject: string[];

Type: string[]
Default: no code is injected

This option allows you to automatically replace a global variable with an import from another file.

https://esbuild.github.io/api/#inject

`keepNames`^Optional

public readonly keepNames: boolean;

Type: boolean
Default: false

Whether to preserve the original name values even in minified code.

In JavaScript the name property on functions and classes defaults to a nearby identifier in the source code.

However, minification renames symbols to reduce code size and bundling sometimes need to rename symbols to avoid collisions. That changes value of the name property for many of these cases. This is usually fine because the name property is normally only used for debugging. However, some frameworks rely on the name property for registration and binding purposes. If this is the case, you can enable this option to preserve the original name values even in minified code.

`loaders`^Optional

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

Type: {[ key: string ]: string}

Map of file extensions (without dot) and loaders to use for this file type.

Loaders are appended to the esbuild command by --loader:.extension=loader

`logLevel`^Optional

public readonly logLevel: BundleLogLevel;

Type: BundleLogLevel
Default: LogLevel.WARNING

Log level for esbuild.

This is also propagated to the package manager and applies to its specific install command.

`mainFields`^Optional

public readonly mainFields: string[];

Type: string[]
Default: []

How to determine the entry point for modules.

Try ['module', 'main'] to default to ES module versions.

`metafile`^Optional

public readonly metafile: boolean;

Type: boolean
Default: false

This option tells esbuild to write out a JSON file relative to output directory with metadata about the build.

The metadata in this JSON file follows this schema (specified using TypeScript syntax):

{
  outputs: {
    [path: string]: {
      bytes: number
      inputs: {
        [path: string]: { bytesInOutput: number }
      }
      imports: { path: string }[]
      exports: string[]
    }
  }
}

This data can then be analyzed by other tools. For example, bundle buddy can consume esbuild's metadata format and generates a treemap visualization of the modules in your bundle and how much space each one takes up.

https://esbuild.github.io/api/#metafile

`minify`^Optional

public readonly minify: boolean;

Type: boolean
Default: false

Whether to minify files when bundling.

`outfile`^Optional

public readonly outfile: string;

Type: string
Default: "index.js"

Bundler output path relative to the asset's output directory.

`sourceMapMode`^Optional

public readonly sourceMapMode: SourceMapMode;

Type: SourceMapMode
Default: SourceMapMode.DEFAULT

Source map mode to be used when bundling.

https://esbuild.github.io/api/#sourcemap

`sourcesContent`^Optional

public readonly sourcesContent: boolean;

Type: boolean
Default: true

Whether to include original source code in source maps when bundling.

https://esbuild.github.io/api/#sources-content

`tsconfigPath`^Optional

public readonly tsconfigPath: string;

Type: string
Default: "tsconfig.json"

The path of the tsconfig.json file to use for bundling.

AuditOptions

Options for security audit configuration.

Initializer

import { javascript } from 'projen'

const auditOptions: javascript.AuditOptions = { ... }

Properties

Name	Type	Description
`level`	`string`	Minimum vulnerability level to check for during audit.
`prodOnly`	`boolean`	Only audit production dependencies.
`runOn`	`string`	When to run the audit task.

`level`^Optional

public readonly level: string;

Type: string
Default: "high"

Minimum vulnerability level to check for during audit.

`prodOnly`^Optional

public readonly prodOnly: boolean;

Type: boolean
Default: false

Only audit production dependencies.

When false, both production and development dependencies are audited. This is recommended as build dependencies can also contain security vulnerabilities.

`runOn`^Optional

public readonly runOn: string;

Type: string
Default: "build"

When to run the audit task.

"build": Run during every build (default)

"release": Only run during release workflow
"manual": Create the task but don't run it automatically

BiomeOptions

Initializer

import { javascript } from 'projen'

const biomeOptions: javascript.BiomeOptions = { ... }

Properties

Name	Type	Description
`assist`	`boolean`	Enable code assist with recommended actions.
`biomeConfig`	`BiomeConfiguration`	Full Biome configuration.
`formatter`	`boolean`	Enable code formatter with recommended settings.
`ignoreGeneratedFiles`	`boolean`	Automatically ignore all generated files.
`linter`	`boolean`	Enable linting with recommended rules.
`mergeArraysInConfiguration`	`boolean`	Should arrays be merged or overwritten when creating Biome configuration.
`version`	`string`	Version of Biome to use.

`assist`^Optional

public readonly assist: boolean;

Type: boolean
Default: true

Enable code assist with recommended actions.

`biomeConfig`^Optional

public readonly biomeConfig: BiomeConfiguration;

Type: BiomeConfiguration

Full Biome configuration.

This configuration dictates the final outcome if value is set. For example, if the linter is disabled at the top-level, it can be enabled with biomeConfig.linter.enabled.

`formatter`^Optional

public readonly formatter: boolean;

Type: boolean
Default: true

Enable code formatter with recommended settings.

`ignoreGeneratedFiles`^Optional

public readonly ignoreGeneratedFiles: boolean;

Type: boolean
Default: true

Automatically ignore all generated files.

This prevents Biome from trying to format or lint files that are marked as generated, which would fail since generated files are typically read-only.

`linter`^Optional

public readonly linter: boolean;

Type: boolean
Default: true

Enable linting with recommended rules.

`mergeArraysInConfiguration`^Optional

public readonly mergeArraysInConfiguration: boolean;

Type: boolean
Default: true

Should arrays be merged or overwritten when creating Biome configuration.

By default arrays are merged and duplicate values are removed

`version`^Optional

public readonly version: string;

Type: string
Default: "^2"

Version of Biome to use.

BuildWorkflowOptions

Build workflow options for NodeProject.

Initializer

import { javascript } from 'projen'

const buildWorkflowOptions: javascript.BuildWorkflowOptions = { ... }

Properties

Name	Type	Description
`env`	`{[ key: string ]: string}`	Build environment variables.
`name`	`string`	Name of the buildfile (e.g. "build" becomes "build.yml").
`permissions`	`projen.github.workflows.JobPermissions`	Permissions granted to the build job To limit job permissions for `contents`, the desired permissions have to be explicitly set, e.g.: `{ contents: JobPermission.NONE }`.
`preBuildSteps`	`projen.github.workflows.JobStep[]`	Steps to execute before the build.
`workflowTriggers`	`projen.github.workflows.Triggers`	Build workflow triggers.
`mutableBuild`	`boolean`	Automatically update files modified during builds to pull-request branches.

`env`^Optional

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

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

Build environment variables.

`name`^Optional

public readonly name: string;

Type: string
Default: "build"

Name of the buildfile (e.g. "build" becomes "build.yml").

`permissions`^Optional

public readonly permissions: JobPermissions;

Type: projen.github.workflows.JobPermissions
Default: { contents: JobPermission.WRITE }

Permissions granted to the build job To limit job permissions for contents, the desired permissions have to be explicitly set, e.g.: { contents: JobPermission.NONE }.

`preBuildSteps`^Optional

public readonly preBuildSteps: JobStep[];

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

Steps to execute before the build.

`workflowTriggers`^Optional

public readonly workflowTriggers: Triggers;

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

Build workflow triggers.

`mutableBuild`^Optional

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.

Bundle

Initializer

import { javascript } from 'projen'

const bundle: javascript.Bundle = { ... }

Properties

Name	Type	Description
`bundleTask`	`projen.Task`	The task that produces this bundle.
`outdir`	`string`	Base directory containing the output file (relative to project root).
`outfile`	`string`	Location of the output file (relative to project root).
`watchTask`	`projen.Task`	The "watch" task for this bundle.

`bundleTask`^Required

public readonly bundleTask: Task;

Type: projen.Task

The task that produces this bundle.

`outdir`^Required

public readonly outdir: string;

Type: string

Base directory containing the output file (relative to project root).

`outfile`^Required

public readonly outfile: string;

Type: string

Location of the output file (relative to project root).

`watchTask`^Optional

public readonly watchTask: Task;

Type: projen.Task

The "watch" task for this bundle.

BundlerOptions

Options for Bundler.

Initializer

import { javascript } from 'projen'

const bundlerOptions: javascript.BundlerOptions = { ... }

Properties

Name	Type	Description
`addToPreCompile`	`boolean`	Install the `bundle` command as a pre-compile phase.
`assetsDir`	`string`	Output directory for all bundles.
`esbuildVersion`	`string`	The semantic version requirement for `esbuild`.
`loaders`	`{[ key: string ]: string}`	Map of file extensions (without dot) and loaders to use for this file type.
`runBundleTask`	`RunBundleTask`	Choose which phase (if any) to add the `bundle` command to.

`addToPreCompile`^Optional

Deprecated: Use runBundleTask instead.

public readonly addToPreCompile: boolean;

Type: boolean
Default: true

Install the bundle command as a pre-compile phase.

`assetsDir`^Optional

public readonly assetsDir: string;

Type: string
Default: "assets"

Output directory for all bundles.

`esbuildVersion`^Optional

public readonly esbuildVersion: string;

Type: string
Default: no specific version (implies latest)

The semantic version requirement for esbuild.

`loaders`^Optional

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

Type: {[ key: string ]: string}

Map of file extensions (without dot) and loaders to use for this file type.

Loaders are appended to the esbuild command by --loader:.extension=loader

`runBundleTask`^Optional

public readonly runBundleTask: RunBundleTask;

Type: RunBundleTask
Default: RunBundleTask.PRE_COMPILE

Choose which phase (if any) to add the bundle command to.

Note: If using addBundle() with the bundleCompiledResults, this option must be set to RunBundleTask.POST_COMPILE or RunBundleTask.MANUAL.

[AddBundleOptions.bundleCompiledResults *](AddBundleOptions.bundleCompiledResults *)

BundlingOptions

Options for bundling.

Initializer

import { javascript } from 'projen'

const bundlingOptions: javascript.BundlingOptions = { ... }

Properties

Name	Type	Description
`externals`	`string[]`	You can mark a file or a package as external to exclude it from your build.
`sourcemap`	`boolean`	Include a source map in the bundle.
`watchTask`	`boolean`	In addition to the `bundle:xyz` task, creates `bundle:xyz:watch` task which will invoke the same esbuild command with the `--watch` flag.

`externals`^Optional

public readonly externals: string[];

Type: string[]
Default: []

You can mark a file or a package as external to exclude it from your build.

Instead of being bundled, the import will be preserved (using require for the iife and cjs formats and using import for the esm format) and will be evaluated at run time instead.

`sourcemap`^Optional

public readonly sourcemap: boolean;

Type: boolean
Default: false

Include a source map in the bundle.

`watchTask`^Optional

public readonly watchTask: boolean;

Type: boolean
Default: true

In addition to the bundle:xyz task, creates bundle:xyz:watch task which will invoke the same esbuild command with the --watch flag.

This can be used to continusouly watch for changes.

CodeArtifactOptions

Options for publishing npm packages to AWS CodeArtifact.

Initializer

import { javascript } from 'projen'

const codeArtifactOptions: javascript.CodeArtifactOptions = { ... }

Properties

Name	Type	Description
`accessKeyIdSecret`	`string`	GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.
`authProvider`	`CodeArtifactAuthProvider`	Provider to use for authorizing requests to AWS CodeArtifact.
`roleToAssume`	`string`	ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (`registry` contains AWS CodeArtifact URL).
`secretAccessKeySecret`	`string`	GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.

`accessKeyIdSecret`^Optional

public readonly accessKeyIdSecret: string;

Type: string
Default: When the authProvider value is set to CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR, the default is "AWS_ACCESS_KEY_ID". For CodeArtifactAuthProvider.GITHUB_OIDC, this value must be left undefined.

GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.

This property must be specified only when publishing to AWS CodeArtifact (npmRegistryUrl contains AWS CodeArtifact URL).

`authProvider`^Optional

public readonly authProvider: CodeArtifactAuthProvider;

Type: CodeArtifactAuthProvider
Default: CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR

Provider to use for authorizing requests to AWS CodeArtifact.

`roleToAssume`^Optional

public readonly roleToAssume: string;

Type: string
Default: undefined

ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (registry contains AWS CodeArtifact URL).

When using the CodeArtifactAuthProvider.GITHUB_OIDC auth provider, this value must be defined.

`secretAccessKeySecret`^Optional

public readonly secretAccessKeySecret: string;

Type: string
Default: When the authProvider value is set to CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR, the default is "AWS_SECRET_ACCESS_KEY". For CodeArtifactAuthProvider.GITHUB_OIDC, this value must be left undefined.

GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.

This property must be specified only when publishing to AWS CodeArtifact (npmRegistryUrl contains AWS CodeArtifact URL).

CoverageThreshold

Initializer

import { javascript } from 'projen'

const coverageThreshold: javascript.CoverageThreshold = { ... }

Properties

Name	Type	Description
`branches`	`number`	No description.
`functions`	`number`	No description.
`lines`	`number`	No description.
`statements`	`number`	No description.

`branches`^Optional

public readonly branches: number;

Type: number

`functions`^Optional

public readonly functions: number;

Type: number

`lines`^Optional

public readonly lines: number;

Type: number

`statements`^Optional

public readonly statements: number;

Type: number

EslintCommandOptions

Initializer

import { javascript } from 'projen'

const eslintCommandOptions: javascript.EslintCommandOptions = { ... }

Properties

Name	Type	Description
`extraArgs`	`string[]`	Extra flag arguments to pass to eslint command.
`fix`	`boolean`	Whether to fix eslint issues when running the eslint task.

`extraArgs`^Optional

public readonly extraArgs: string[];

Type: string[]

Extra flag arguments to pass to eslint command.

`fix`^Optional

public readonly fix: boolean;

Type: boolean
Default: true

Whether to fix eslint issues when running the eslint task.

EslintOptions

Initializer

import { javascript } from 'projen'

const eslintOptions: javascript.EslintOptions = { ... }

Properties

Name	Type	Description
`dirs`	`string[]`	Files or glob patterns or directories with source files to lint (e.g. [ "src" ]).
`aliasExtensions`	`string[]`	Enable import alias for module paths.
`aliasMap`	`{[ key: string ]: string}`	Enable import alias for module paths.
`commandOptions`	`EslintCommandOptions`	Options for eslint command executed by eslint task.
`devdirs`	`string[]`	Files or glob patterns or directories with source files that include tests and build tools.
`fileExtensions`	`string[]`	File types that should be linted (e.g. [ ".js", ".ts" ]).
`ignorePatterns`	`string[]`	List of file patterns that should not be linted, using the same syntax as .gitignore patterns.
`lintProjenRc`	`boolean`	Should we lint .projenrc.js.
`lintProjenRcFile`	`string`	Projenrc file to lint.
`prettier`	`boolean`	Enable prettier for code formatting.
`sortExtends`	`projen.ICompareString`	The extends array in eslint is order dependent.
`tsAlwaysTryTypes`	`boolean`	Always try to resolve types under `<root>@types` directory even it doesn't contain any source code.
`tsconfigPath`	`string`	Path to `tsconfig.json` which should be used by eslint.
`yaml`	`boolean`	Write eslint configuration as YAML instead of JSON.

`dirs`^Required

public readonly dirs: string[];

Type: string[]

Files or glob patterns or directories with source files to lint (e.g. [ "src" ]).

`aliasExtensions`^Optional

public readonly aliasExtensions: string[];

Type: string[]
Default: undefined

Enable import alias for module paths.

`aliasMap`^Optional

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

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

Enable import alias for module paths.

`commandOptions`^Optional

public readonly commandOptions: EslintCommandOptions;

Type: EslintCommandOptions

Options for eslint command executed by eslint task.

`devdirs`^Optional

public readonly devdirs: string[];

Type: string[]
Default: []

Files or glob patterns or directories with source files that include tests and build tools.

These sources are linted but may also import packages from devDependencies.

`fileExtensions`^Optional

public readonly fileExtensions: string[];

Type: string[]
Default: [".ts"]

File types that should be linted (e.g. [ ".js", ".ts" ]).

`ignorePatterns`^Optional

public readonly ignorePatterns: string[];

Type: string[]
Default: [ '.js', '.d.ts', 'node_modules/', '*.generated.ts', 'coverage' ]

List of file patterns that should not be linted, using the same syntax as .gitignore patterns.

`lintProjenRc`^Optional

Deprecated: set to false to remove any automatic rules and add manually

public readonly lintProjenRc: boolean;

Type: boolean
Default: true

Should we lint .projenrc.js.

`lintProjenRcFile`^Optional

Deprecated: provide as devdirs

public readonly lintProjenRcFile: string;

Type: string
Default: "projenrc.js"

Projenrc file to lint.

Use empty string to disable.

`prettier`^Optional

public readonly prettier: boolean;

Type: boolean
Default: false

Enable prettier for code formatting.

`sortExtends`^Optional

public readonly sortExtends: ICompareString;

Type: projen.ICompareString
Default: Use known ESLint best practices to place "prettier" plugins at the end of the array

The extends array in eslint is order dependent.

This option allows to sort the extends array in any way seen fit.

`tsAlwaysTryTypes`^Optional

public readonly tsAlwaysTryTypes: boolean;

Type: boolean
Default: true

Always try to resolve types under <root>@types directory even it doesn't contain any source code.

This prevents import/no-unresolved eslint errors when importing a @types/* module that would otherwise remain unresolved.

`tsconfigPath`^Optional

public readonly tsconfigPath: string;

Type: string
Default: "./tsconfig.json"

Path to tsconfig.json which should be used by eslint.

`yaml`^Optional

public readonly yaml: boolean;

Type: boolean
Default: false

Write eslint configuration as YAML instead of JSON.

EslintOverride

eslint rules override.

Initializer

import { javascript } from 'projen'

const eslintOverride: javascript.EslintOverride = { ... }

Properties

Name	Type	Description
`files`	`string[]`	Files or file patterns on which to apply the override.
`excludedFiles`	`string[]`	Pattern(s) to exclude from this override.
`extends`	`string[]`	Config(s) to extend in this override.
`parser`	`string`	The overridden parser.
`plugins`	`string[]`	`plugins` override.
`rules`	`{[ key: string ]: any}`	The overridden rules.

`files`^Required

public readonly files: string[];

Type: string[]

Files or file patterns on which to apply the override.

`excludedFiles`^Optional

public readonly excludedFiles: string[];

Type: string[]

Pattern(s) to exclude from this override.

If a file matches any of the excluded patterns, the configuration won’t apply.

`extends`^Optional

public readonly extends: string[];

Type: string[]

Config(s) to extend in this override.

`parser`^Optional

public readonly parser: string;

Type: string

The overridden parser.

`plugins`^Optional

public readonly plugins: string[];

Type: string[]

plugins override.

`rules`^Optional

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

Type: {[ key: string ]: any}

The overridden rules.

HasteConfig

Initializer

import { javascript } from 'projen'

const hasteConfig: javascript.HasteConfig = { ... }

Properties

Name	Type	Description
`computeSha1`	`boolean`	No description.
`defaultPlatform`	`string`	No description.
`hasteImplModulePath`	`string`	No description.
`platforms`	`string[]`	No description.
`throwOnModuleCollision`	`boolean`	No description.

`computeSha1`^Optional

public readonly computeSha1: boolean;

Type: boolean

`defaultPlatform`^Optional

public readonly defaultPlatform: string;

Type: string

`hasteImplModulePath`^Optional

public readonly hasteImplModulePath: string;

Type: string

`platforms`^Optional

public readonly platforms: string[];

Type: string[]

`throwOnModuleCollision`^Optional

public readonly throwOnModuleCollision: boolean;

Type: boolean

JestConfigOptions

Initializer

import { javascript } from 'projen'

const jestConfigOptions: javascript.JestConfigOptions = { ... }

Properties

Name	Type	Description
`additionalOptions`	`{[ key: string ]: any}`	Escape hatch to allow any value.
`automock`	`boolean`	This option tells Jest that all imported modules in your tests should be mocked automatically.
`bail`	`number \| boolean`	By default, Jest runs all tests and produces all errors into the console upon completion.
`cacheDirectory`	`string`	The directory where Jest should store its cached dependency information.
`clearMocks`	`boolean`	Automatically clear mock calls and instances before every test.
`collectCoverage`	`boolean`	Indicates whether the coverage information should be collected while executing the test.
`collectCoverageFrom`	`string[]`	An array of glob patterns indicating a set of files for which coverage information should be collected.
`coverageDirectory`	`string`	The directory where Jest should output its coverage files.
`coveragePathIgnorePatterns`	`string[]`	An array of regexp pattern strings that are matched against all file paths before executing the test.
`coverageProvider`	`string`	Indicates which provider should be used to instrument code for coverage.
`coverageReporters`	`string[]`	A list of reporter names that Jest uses when writing coverage reports.
`coverageThreshold`	`CoverageThreshold`	Specify the global coverage thresholds.
`dependencyExtractor`	`string`	This option allows the use of a custom dependency extractor.
`displayName`	`any`	Allows for a label to be printed alongside a test while it is running.
`errorOnDeprecated`	`boolean`	Make calling deprecated APIs throw helpful error messages.
`extraGlobals`	`string[]`	Test files run inside a vm, which slows calls to global context properties (e.g. Math). With this option you can specify extra properties to be defined inside the vm for faster lookups.
`forceCoverageMatch`	`string[]`	Test files are normally ignored from collecting code coverage.
`globals`	`any`	A set of global variables that need to be available in all test environments.
`globalSetup`	`string`	This option allows the use of a custom global setup module which exports an async function that is triggered once before all test suites.
`globalTeardown`	`string`	This option allows the use of a custom global teardown module which exports an async function that is triggered once after all test suites.
`haste`	`HasteConfig`	This will be used to configure the behavior of jest-haste-map, Jest's internal file crawler/cache system.
`injectGlobals`	`boolean`	Insert Jest's globals (expect, test, describe, beforeEach etc.) into the global environment. If you set this to false, you should import from.
`maxConcurrency`	`number`	A number limiting the number of tests that are allowed to run at the same time when using test.concurrent. Any test above this limit will be queued and executed once a slot is released.
`maxWorkers`	`string \| number`	Specifies the maximum number of workers the worker-pool will spawn for running tests.
`moduleDirectories`	`string[]`	An array of directory names to be searched recursively up from the requiring module's location.
`moduleFileExtensions`	`string[]`	An array of file extensions your modules use.
`moduleNameMapper`	`{[ key: string ]: string \| string[]}`	A map from regular expressions to module names or to arrays of module names that allow to stub out resources, like images or styles with a single module.
`modulePathIgnorePatterns`	`string[]`	An array of regexp pattern strings that are matched against all module paths before those paths are to be considered 'visible' to the module loader.
`modulePaths`	`string[]`	An alternative API to setting the NODE_PATH env variable, modulePaths is an array of absolute paths to additional locations to search when resolving modules.
`notify`	`boolean`	Activates notifications for test results.
`notifyMode`	`string`	Specifies notification mode.
`preset`	`string`	A preset that is used as a base for Jest's configuration.
`prettierPath`	`string`	Sets the path to the prettier node module used to update inline snapshots.
`projects`	`string \| {[ key: string ]: any}[]`	When the projects configuration is provided with an array of paths or glob patterns, Jest will run tests in all of the specified projects at the same time.
`reporters`	`JestReporter[]`	Use this configuration option to add custom reporters to Jest.
`resetMocks`	`boolean`	Automatically reset mock state before every test.
`resetModules`	`boolean`	By default, each test file gets its own independent module registry.
`resolver`	`string`	This option allows the use of a custom resolver.
`restoreMocks`	`boolean`	Automatically restore mock state before every test.
`rootDir`	`string`	The root directory that Jest should scan for tests and modules within.
`roots`	`string[]`	A list of paths to directories that Jest should use to search for files in.
`runner`	`string`	This option allows you to use a custom runner instead of Jest's default test runner.
`setupFiles`	`string[]`	A list of paths to modules that run some code to configure or set up the testing environment.
`setupFilesAfterEnv`	`string[]`	A list of paths to modules that run some code to configure or set up the testing framework before each test file in the suite is executed.
`slowTestThreshold`	`number`	The number of seconds after which a test is considered as slow and reported as such in the results.
`snapshotResolver`	`string`	The path to a module that can resolve test<->snapshot path.
`snapshotSerializers`	`string[]`	A list of paths to snapshot serializer modules Jest should use for snapshot testing.
`testEnvironment`	`string`	The test environment that will be used for testing.
`testEnvironmentOptions`	`any`	Test environment options that will be passed to the testEnvironment.
`testFailureExitCode`	`number`	The exit code Jest returns on test failure.
`testMatch`	`string[]`	The glob patterns Jest uses to detect test files.
`testPathIgnorePatterns`	`string[]`	An array of regexp pattern strings that are matched against all test paths before executing the test.
`testRegex`	`string \| string[]`	The pattern or patterns Jest uses to detect test files.
`testResultsProcessor`	`string`	This option allows the use of a custom results processor.
`testRunner`	`string`	This option allows the use of a custom test runner.
`testSequencer`	`string`	This option allows you to use a custom sequencer instead of Jest's default.
`testTimeout`	`number`	Default timeout of a test in milliseconds.
`testURL`	`string`	This option sets the URL for the jsdom environment.
`timers`	`string`	Setting this value to legacy or fake allows the use of fake timers for functions such as setTimeout.
`transform`	`{[ key: string ]: Transform}`	A map from regular expressions to paths to transformers.
`transformIgnorePatterns`	`string[]`	An array of regexp pattern strings that are matched against all source file paths before transformation.
`unmockedModulePathPatterns`	`string[]`	An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them.
`verbose`	`boolean`	Indicates whether each individual test should be reported during the run.
`watchman`	`boolean`	Whether to use watchman for file crawling.
`watchPathIgnorePatterns`	`string[]`	An array of RegExp patterns that are matched against all source file paths before re-running tests in watch mode.
`watchPlugins`	`WatchPlugin[]`	No description.

`additionalOptions`^Optional

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

Type: {[ key: string ]: any}

Escape hatch to allow any value.

`automock`^Optional

public readonly automock: boolean;

Type: boolean
Default: false

This option tells Jest that all imported modules in your tests should be mocked automatically.

All modules used in your tests will have a replacement implementation, keeping the API surface

`bail`^Optional

public readonly bail: number | boolean;

Type: number | boolean
Default: 0

By default, Jest runs all tests and produces all errors into the console upon completion.

The bail config option can be used here to have Jest stop running tests after n failures. Setting bail to true is the same as setting bail to 1.

`cacheDirectory`^Optional

public readonly cacheDirectory: string;

Type: string
Default: "/tmp/"

The directory where Jest should store its cached dependency information.

`clearMocks`^Optional

public readonly clearMocks: boolean;

Type: boolean
Default: true

Automatically clear mock calls and instances before every test.

Equivalent to calling jest.clearAllMocks() before each test. This does not remove any mock implementation that may have been provided

`collectCoverage`^Optional

public readonly collectCoverage: boolean;

Type: boolean
Default: true

Indicates whether the coverage information should be collected while executing the test.

Because this retrofits all executed files with coverage collection statements, it may significantly slow down your tests

`collectCoverageFrom`^Optional

public readonly collectCoverageFrom: string[];

Type: string[]
Default: undefined

An array of glob patterns indicating a set of files for which coverage information should be collected.

`coverageDirectory`^Optional

public readonly coverageDirectory: string;

Type: string
Default: "coverage"

The directory where Jest should output its coverage files.

`coveragePathIgnorePatterns`^Optional

public readonly coveragePathIgnorePatterns: string[];

Type: string[]
Default: "/node_modules/"

An array of regexp pattern strings that are matched against all file paths before executing the test.

If the file path matches any of the patterns, coverage information will be skipped

`coverageProvider`^Optional

public readonly coverageProvider: string;

Type: string
Default: "v8"

Indicates which provider should be used to instrument code for coverage.

Allowed values are v8 (default) or babel

`coverageReporters`^Optional

public readonly coverageReporters: string[];

Type: string[]
Default: ["json", "lcov", "text", "clover", "cobertura"]

A list of reporter names that Jest uses when writing coverage reports.

Any istanbul reporter can be used

`coverageThreshold`^Optional

public readonly coverageThreshold: CoverageThreshold;

Type: CoverageThreshold
Default: undefined

Specify the global coverage thresholds.

This will be used to configure minimum threshold enforcement for coverage results. Thresholds can be specified as global, as a glob, and as a directory or file path. If thresholds aren't met, jest will fail.

`dependencyExtractor`^Optional

public readonly dependencyExtractor: string;

Type: string
Default: undefined

This option allows the use of a custom dependency extractor.

It must be a node module that exports an object with an extract function

`displayName`^Optional

public readonly displayName: any;

Type: any
Default: undefined

Allows for a label to be printed alongside a test while it is running.

`errorOnDeprecated`^Optional

public readonly errorOnDeprecated: boolean;

Type: boolean
Default: false

Make calling deprecated APIs throw helpful error messages.

Useful for easing the upgrade process.

`extraGlobals`^Optional

public readonly extraGlobals: string[];

Type: string[]
Default: undefined

Test files run inside a vm, which slows calls to global context properties (e.g. Math). With this option you can specify extra properties to be defined inside the vm for faster lookups.

`forceCoverageMatch`^Optional

public readonly forceCoverageMatch: string[];

Type: string[]
Default: ['']

Test files are normally ignored from collecting code coverage.

With this option, you can overwrite this behavior and include otherwise ignored files in code coverage.

`globals`^Optional

public readonly globals: any;

Type: any
Default: {}

A set of global variables that need to be available in all test environments.

`globalSetup`^Optional

public readonly globalSetup: string;

Type: string
Default: undefined

This option allows the use of a custom global setup module which exports an async function that is triggered once before all test suites.

This function gets Jest's globalConfig object as a parameter.

`globalTeardown`^Optional

public readonly globalTeardown: string;

Type: string
Default: undefined

This option allows the use of a custom global teardown module which exports an async function that is triggered once after all test suites.

This function gets Jest's globalConfig object as a parameter.

`haste`^Optional

public readonly haste: HasteConfig;

Type: HasteConfig
Default: {}

This will be used to configure the behavior of jest-haste-map, Jest's internal file crawler/cache system.

`injectGlobals`^Optional

public readonly injectGlobals: boolean;

Type: boolean
Default: true

Insert Jest's globals (expect, test, describe, beforeEach etc.) into the global environment. If you set this to false, you should import from.

`maxConcurrency`^Optional

public readonly maxConcurrency: number;

Type: number
Default: 5

A number limiting the number of tests that are allowed to run at the same time when using test.concurrent. Any test above this limit will be queued and executed once a slot is released.

`maxWorkers`^Optional

public readonly maxWorkers: string | number;

Type: string | number
Default: the number of the cores available on your machine minus one for the main thread

Specifies the maximum number of workers the worker-pool will spawn for running tests.

In single run mode, this defaults to the number of the cores available on your machine minus one for the main thread In watch mode, this defaults to half of the available cores on your machine. For environments with variable CPUs available, you can use percentage based configuration: "maxWorkers": "50%"

`moduleDirectories`^Optional

public readonly moduleDirectories: string[];

Type: string[]
Default: ["node_modules"]

An array of directory names to be searched recursively up from the requiring module's location.

Setting this option will override the default, if you wish to still search node_modules for packages include it along with any other options: ["node_modules", "bower_components"]

`moduleFileExtensions`^Optional

public readonly moduleFileExtensions: string[];

Type: string[]
Default: ["js", "json", "jsx", "ts", "tsx", "node"]

An array of file extensions your modules use.

If you require modules without specifying a file extension, these are the extensions Jest will look for, in left-to-right order.

`moduleNameMapper`^Optional

public readonly moduleNameMapper: {[ key: string ]: string | string[]};

Type: {[ key: string ]: string | string[]}
Default: null

A map from regular expressions to module names or to arrays of module names that allow to stub out resources, like images or styles with a single module.

`modulePathIgnorePatterns`^Optional

public readonly modulePathIgnorePatterns: string[];

Type: string[]
Default: []

An array of regexp pattern strings that are matched against all module paths before those paths are to be considered 'visible' to the module loader.

If a given module's path matches any of the patterns, it will not be require()-able in the test environment.

`modulePaths`^Optional

public readonly modulePaths: string[];

Type: string[]
Default: []

An alternative API to setting the NODE_PATH env variable, modulePaths is an array of absolute paths to additional locations to search when resolving modules.

Use the string token to include the path to your project's root directory. Example: ["/app/"].

`notify`^Optional

public readonly notify: boolean;

Type: boolean
Default: false

Activates notifications for test results.

`notifyMode`^Optional

public readonly notifyMode: string;

Type: string
Default: failure-change

Specifies notification mode.

Requires notify: true

`preset`^Optional

public readonly preset: string;

Type: string
Default: undefined

A preset that is used as a base for Jest's configuration.

A preset should point to an npm module that has a jest-preset.json or jest-preset.js file at the root.

`prettierPath`^Optional

public readonly prettierPath: string;

Type: string
Default: "prettier"

Sets the path to the prettier node module used to update inline snapshots.

`projects`^Optional

public readonly projects: (string | {[ key: string ]: any})[];

Type: string | {[ key: string ]: any}[]
Default: undefined

When the projects configuration is provided with an array of paths or glob patterns, Jest will run tests in all of the specified projects at the same time.

This is great for monorepos or when working on multiple projects at the same time.

`reporters`^Optional

public readonly reporters: JestReporter[];

Type: JestReporter[]
Default: undefined

Use this configuration option to add custom reporters to Jest.

A custom reporter is a class that implements onRunStart, onTestStart, onTestResult, onRunComplete methods that will be called when any of those events occurs.

`resetMocks`^Optional

public readonly resetMocks: boolean;

Type: boolean
Default: false

Automatically reset mock state before every test.

Equivalent to calling jest.resetAllMocks() before each test. This will lead to any mocks having their fake implementations removed but does not restore their initial implementation.

`resetModules`^Optional

public readonly resetModules: boolean;

Type: boolean
Default: false

By default, each test file gets its own independent module registry.

Enabling resetModules goes a step further and resets the module registry before running each individual test.

`resolver`^Optional

public readonly resolver: string;

Type: string
Default: undefined

This option allows the use of a custom resolver.

https://jestjs.io/docs/en/configuration#resolver-string

`restoreMocks`^Optional

public readonly restoreMocks: boolean;

Type: boolean
Default: false

Automatically restore mock state before every test.

Equivalent to calling jest.restoreAllMocks() before each test. This will lead to any mocks having their fake implementations removed and restores their initial implementation.

`rootDir`^Optional

public readonly rootDir: string;

Type: string
Default: directory of the package.json

The root directory that Jest should scan for tests and modules within.

If you put your Jest config inside your package.json and want the root directory to be the root of your repo, the value for this config param will default to the directory of the package.json.

`roots`^Optional

public readonly roots: string[];

Type: string[]
Default: [""]

A list of paths to directories that Jest should use to search for files in.

`runner`^Optional

public readonly runner: string;

Type: string
Default: "jest-runner"

This option allows you to use a custom runner instead of Jest's default test runner.

`setupFiles`^Optional

public readonly setupFiles: string[];

Type: string[]
Default: []

A list of paths to modules that run some code to configure or set up the testing environment.

Each setupFile will be run once per test file. Since every test runs in its own environment, these scripts will be executed in the testing environment immediately before executing the test code itself.

`setupFilesAfterEnv`^Optional

public readonly setupFilesAfterEnv: string[];

Type: string[]
Default: []

A list of paths to modules that run some code to configure or set up the testing framework before each test file in the suite is executed.

Since setupFiles executes before the test framework is installed in the environment, this script file presents you the opportunity of running some code immediately after the test framework has been installed in the environment.

`slowTestThreshold`^Optional

public readonly slowTestThreshold: number;

Type: number
Default: 5

The number of seconds after which a test is considered as slow and reported as such in the results.

`snapshotResolver`^Optional

public readonly snapshotResolver: string;

Type: string
Default: undefined

The path to a module that can resolve test<->snapshot path.

This config option lets you customize where Jest stores snapshot files on disk.

`snapshotSerializers`^Optional

public readonly snapshotSerializers: string[];

Type: string[]
Default: = []

A list of paths to snapshot serializer modules Jest should use for snapshot testing.

`testEnvironment`^Optional

public readonly testEnvironment: string;

Type: string
Default: "jsdom"

The test environment that will be used for testing.

The default environment in Jest is a browser-like environment through jsdom. If you are building a node service, you can use the node option to use a node-like environment instead.

`testEnvironmentOptions`^Optional

public readonly testEnvironmentOptions: any;

Type: any
Default: {}

Test environment options that will be passed to the testEnvironment.

The relevant options depend on the environment.

`testFailureExitCode`^Optional

public readonly testFailureExitCode: number;

Type: number
Default: 1

The exit code Jest returns on test failure.

`testMatch`^Optional

public readonly testMatch: string[];

Type: string[]
Default: ['/tests//.[jt]s?(x)', '**/(*.)@(spec|test).[tj]s?(x)']

The glob patterns Jest uses to detect test files.

By default it looks for .js, .jsx, .ts and .tsx files inside of tests folders, as well as any files with a suffix of .test or .spec (e.g. Component.test.js or Component.spec.js). It will also find files called test.js or spec.js.

`testPathIgnorePatterns`^Optional

public readonly testPathIgnorePatterns: string[];

Type: string[]
Default: ["/node_modules/"]

An array of regexp pattern strings that are matched against all test paths before executing the test.

If the test path matches any of the patterns, it will be skipped.

`testRegex`^Optional

public readonly testRegex: string | string[];

Type: string | string[]
Default: (/tests/.*|(\.|/)(test|spec))\.[jt]sx?$

The pattern or patterns Jest uses to detect test files.

`testResultsProcessor`^Optional

public readonly testResultsProcessor: string;

Type: string
Default: undefined

This option allows the use of a custom results processor.

`testRunner`^Optional

public readonly testRunner: string;

Type: string
Default: "jasmine2"

This option allows the use of a custom test runner.

The default is jasmine2. A custom test runner can be provided by specifying a path to a test runner implementation.

`testSequencer`^Optional

public readonly testSequencer: string;

Type: string
Default: "@jest/test-sequencer"

This option allows you to use a custom sequencer instead of Jest's default.

Sort may optionally return a Promise.

`testTimeout`^Optional

public readonly testTimeout: number;

Type: number
Default: 5000

Default timeout of a test in milliseconds.

`testURL`^Optional

public readonly testURL: string;

Type: string
Default: "http://localhost"

This option sets the URL for the jsdom environment.

It is reflected in properties such as location.href.

`timers`^Optional

public readonly timers: string;

Type: string
Default: "real"

Setting this value to legacy or fake allows the use of fake timers for functions such as setTimeout.

Fake timers are useful when a piece of code sets a long timeout that we don't want to wait for in a test.

`transform`^Optional

public readonly transform: {[ key: string ]: Transform};

Type: {[ key: string ]: Transform}
Default: {"\.[jt]sx?$": "babel-jest"}

A map from regular expressions to paths to transformers.

A transformer is a module that provides a synchronous function for transforming source files.

`transformIgnorePatterns`^Optional

public readonly transformIgnorePatterns: string[];

Type: string[]
Default: ["/node_modules/", "\.pnp\.[^\/]+$"]

An array of regexp pattern strings that are matched against all source file paths before transformation.

If the test path matches any of the patterns, it will not be transformed.

`unmockedModulePathPatterns`^Optional

public readonly unmockedModulePathPatterns: string[];

Type: string[]
Default: []

An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them.

If a module's path matches any of the patterns in this list, it will not be automatically mocked by the module loader.

`verbose`^Optional

public readonly verbose: boolean;

Type: boolean
Default: false

Indicates whether each individual test should be reported during the run.

All errors will also still be shown on the bottom after execution. Note that if there is only one test file being run it will default to true.

`watchman`^Optional

public readonly watchman: boolean;

Type: boolean
Default: true

Whether to use watchman for file crawling.

`watchPathIgnorePatterns`^Optional

public readonly watchPathIgnorePatterns: string[];

Type: string[]
Default: []

An array of RegExp patterns that are matched against all source file paths before re-running tests in watch mode.

If the file path matches any of the patterns, when it is updated, it will not trigger a re-run of tests.

`watchPlugins`^Optional

public readonly watchPlugins: WatchPlugin[];

Type: WatchPlugin[]
Default:

JestDiscoverTestMatchPatternsForDirsOptions

Options for discoverTestMatchPatternsForDirs.

Initializer

import { javascript } from 'projen'

const jestDiscoverTestMatchPatternsForDirsOptions: javascript.JestDiscoverTestMatchPatternsForDirsOptions = { ... }

Properties

Name	Type	Description
`fileExtensionPattern`	`string`	The file extension pattern to use.

`fileExtensionPattern`^Optional

public readonly fileExtensionPattern: string;

Type: string

The file extension pattern to use.

Defaults to "[jt]s?(x)".

JestOptions

Initializer

import { javascript } from 'projen'

const jestOptions: javascript.JestOptions = { ... }

Properties

Name	Type	Description
`configFilePath`	`string`	Path to JSON config file for Jest.
`coverage`	`boolean`	Collect coverage.
`coverageText`	`boolean`	Include the `text` coverage reporter, which means that coverage summary is printed at the end of the jest execution.
`extraCliOptions`	`string[]`	Additional options to pass to the Jest CLI invocation.
`ignorePatterns`	`string[]`	Defines `testPathIgnorePatterns` and `coveragePathIgnorePatterns`.
`jestConfig`	`JestConfigOptions`	Jest configuration.
`jestVersion`	`string`	The version of jest to use.
`junitReporting`	`boolean`	Result processing with jest-junit.
`passWithNoTests`	`boolean`	Pass with no tests.
`preserveDefaultReporters`	`boolean`	Preserve the default Jest reporter when additional reporters are added.
`updateSnapshot`	`UpdateSnapshot`	Whether to update snapshots in task "test" (which is executed in task "build" and build workflows), or create a separate task "test:update" for updating snapshots.

`configFilePath`^Optional

public readonly configFilePath: string;

Type: string
Default: No separate config file, jest settings are stored in package.json

Path to JSON config file for Jest.

`coverage`^Optional

Deprecated: use jestConfig.collectCoverage

public readonly coverage: boolean;

Type: boolean
Default: true

Collect coverage.

Deprecated

`coverageText`^Optional

public readonly coverageText: boolean;

Type: boolean
Default: true

Include the text coverage reporter, which means that coverage summary is printed at the end of the jest execution.

`extraCliOptions`^Optional

public readonly extraCliOptions: string[];

Type: string[]
Default: no extra options

Additional options to pass to the Jest CLI invocation.

`ignorePatterns`^Optional

Deprecated: use jestConfig.coveragePathIgnorePatterns or jestConfig.testPathIgnorePatterns respectively

public readonly ignorePatterns: string[];

Type: string[]
Default: ["/node_modules/"]

Defines testPathIgnorePatterns and coveragePathIgnorePatterns.

`jestConfig`^Optional

public readonly jestConfig: JestConfigOptions;

Type: JestConfigOptions
Default: default jest configuration

Jest configuration.

`jestVersion`^Optional

public readonly jestVersion: string;

Type: string
Default: installs the latest jest version

The version of jest to use.

Note that same version is used as version of @types/jest and ts-jest (if Typescript in use), so given version should work also for those.

With Jest 30 ts-jest version 29 is used (if Typescript in use)

`junitReporting`^Optional

public readonly junitReporting: boolean;

Type: boolean
Default: true

Result processing with jest-junit.

Output directory is test-reports/.

`passWithNoTests`^Optional

public readonly passWithNoTests: boolean;

Type: boolean
Default: true

Pass with no tests.

`preserveDefaultReporters`^Optional

public readonly preserveDefaultReporters: boolean;

Type: boolean
Default: true

Preserve the default Jest reporter when additional reporters are added.

`updateSnapshot`^Optional

public readonly updateSnapshot: UpdateSnapshot;

Type: UpdateSnapshot
Default: ALWAYS

Whether to update snapshots in task "test" (which is executed in task "build" and build workflows), or create a separate task "test:update" for updating snapshots.

LicenseCheckerOptions

Options to configure the license checker.

Initializer

import { javascript } from 'projen'

const licenseCheckerOptions: javascript.LicenseCheckerOptions = { ... }

Properties

Name	Type	Description
`allow`	`string[]`	List of SPDX license identifiers that are allowed to be used.
`deny`	`string[]`	List of SPDX license identifiers that are prohibited to be used.
`development`	`boolean`	Check development dependencies.
`production`	`boolean`	Check production dependencies.
`taskName`	`string`	The name of the task that is added to check licenses.

`allow`^Optional

public readonly allow: string[];

Type: string[]
Default: no licenses are allowed

List of SPDX license identifiers that are allowed to be used.

For the license check to pass, all detected licenses MUST be in this list. Only one of allowedLicenses and prohibitedLicenses can be provided and must not be empty.

`deny`^Optional

public readonly deny: string[];

Type: string[]
Default: no licenses are prohibited

List of SPDX license identifiers that are prohibited to be used.

For the license check to pass, no detected licenses can be in this list. Only one of allowedLicenses and prohibitedLicenses can be provided and must not be empty.

`development`^Optional

public readonly development: boolean;

Type: boolean
Default: false

Check development dependencies.

`production`^Optional

public readonly production: boolean;

Type: boolean
Default: true

Check production dependencies.

`taskName`^Optional

public readonly taskName: string;

Type: string
Default: "check-licenses"

The name of the task that is added to check licenses.

NodePackageOptions

Initializer

import { javascript } from 'projen'

const nodePackageOptions: javascript.NodePackageOptions = { ... }

Properties

Name	Type	Description
`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.
`bunVersion`	`string`	The version of Bun to use if using Bun as a package manager.
`codeArtifactOptions`	`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`	`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.
`npmTrustedPublishing`	`boolean`	Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
`packageManager`	`NodePackageManager`	The Node Package Manager used to execute scripts.
`packageName`	`string`	The "name" in package.json.
`peerDependencyOptions`	`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`	`ScopedPackagesOptions[]`	Options for privately hosted scoped packages.
`scripts`	`{[ key: string ]: string}`	npm scripts to include.
`stability`	`string`	Package's Stability.
`yarnBerryOptions`	`YarnBerryOptions`	Options for Yarn Berry.

`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.

`bunVersion`^Optional

public readonly bunVersion: string;

Type: string
Default: "latest"

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

`codeArtifactOptions`^Optional

public readonly codeArtifactOptions: CodeArtifactOptions;

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

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.

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

`npmTrustedPublishing`^Optional

public readonly npmTrustedPublishing: boolean;

Type: boolean
Default: false

Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.

`packageManager`^Optional

public readonly packageManager: NodePackageManager;

Type: 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: 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: "9"

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: 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: YarnBerryOptions
Default: Yarn Berry v4 with all default options

Options for Yarn Berry.

NodeProjectOptions

Initializer

import { javascript } from 'projen'

const nodeProjectOptions: javascript.NodeProjectOptions = { ... }

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.
`bunVersion`	`string`	The version of Bun to use if using Bun as a package manager.
`codeArtifactOptions`	`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`	`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.
`npmTrustedPublishing`	`boolean`	Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.
`packageManager`	`NodePackageManager`	The Node Package Manager used to execute scripts.
`packageName`	`string`	The "name" in package.json.
`peerDependencyOptions`	`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`	`ScopedPackagesOptions[]`	Options for privately hosted scoped packages.
`scripts`	`{[ key: string ]: string}`	npm scripts to include.
`stability`	`string`	Package's Stability.
`yarnBerryOptions`	`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.
`releaseEnvironment`	`string`	The GitHub Actions environment used for the release.
`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.
`releaseWorkflowEnv`	`{[ key: string ]: string}`	Build environment variables for release workflows.
`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.
`auditDeps`	`boolean`	Run security audit on dependencies.
`auditDepsOptions`	`AuditOptions`	Security audit options.
`autoApproveUpgrades`	`boolean`	Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
`biome`	`boolean`	Setup Biome.
`biomeOptions`	`BiomeOptions`	Biome options.
`buildWorkflow`	`boolean`	Define a GitHub workflow for building PRs.
`buildWorkflowOptions`	`BuildWorkflowOptions`	Options for PR build workflow.
`buildWorkflowTriggers`	`projen.github.workflows.Triggers`	Build workflow triggers.
`bundlerOptions`	`BundlerOptions`	Options for `Bundler`.
`checkLicenses`	`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@v5 By default, OIDC auth is used. Alternatively a token can be provided via `codeCovTokenSecret`.
`codeCovTokenSecret`	`string`	Define the secret name for a specified https://codecov.io/ token.
`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`	`UpgradeDependenciesOptions`	Options for `UpgradeDependencies`.
`gitignore`	`string[]`	Additional entries to .gitignore.
`jest`	`boolean`	Setup jest unit tests.
`jestOptions`	`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`	`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`	`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.

`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.

`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.

`bunVersion`^Optional

public readonly bunVersion: string;

Type: string
Default: "latest"

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

`codeArtifactOptions`^Optional

public readonly codeArtifactOptions: CodeArtifactOptions;

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

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.

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.

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

`npmAccess`^Optional

public readonly npmAccess: NpmAccess;

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

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.

`npmTrustedPublishing`^Optional

public readonly npmTrustedPublishing: boolean;

Type: boolean
Default: false

Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work.

`packageManager`^Optional

public readonly packageManager: NodePackageManager;

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

Options for peerDeps.

`peerDeps`^Optional

public readonly peerDeps: string[];

Type: string[]
Default: []

Peer dependencies for this module.

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.

`pnpmVersion`^Optional

public readonly pnpmVersion: string;

Type: string
Default: "9"

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: 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: 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.
$SUGGESTED_BUMP: the suggested bump action based on commits. One of major|minor|patch|none.

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.

`releaseEnvironment`^Optional

public readonly releaseEnvironment: string;

Type: string
Default: no environment used, unless set at the artifact level

The GitHub Actions environment used for the release.

This can be used to add an explicit approval step to the release or limit who can initiate a release through environment protection rules.

When multiple artifacts are released, the environment can be overwritten on a per artifact basis.

`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.

`releaseWorkflowEnv`^Optional

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

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

Build environment variables for release workflows.

`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.

`auditDeps`^Optional

public readonly auditDeps: boolean;

Type: boolean
Default: false

Run security audit on dependencies.

When enabled, creates an "audit" task that checks for known security vulnerabilities in dependencies. By default, runs during every build and checks for "high" severity vulnerabilities or above in all dependencies (including dev dependencies).

`auditDepsOptions`^Optional

public readonly auditDepsOptions: AuditOptions;

Type: AuditOptions
Default: default options

Security audit options.

`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.

`biome`^Optional

public readonly biome: boolean;

Type: boolean
Default: false

Setup Biome.

`biomeOptions`^Optional

public readonly biomeOptions: BiomeOptions;

Type: BiomeOptions
Default: default options

Biome options.

`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: 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: BundlerOptions

Options for Bundler.

`checkLicenses`^Optional

public readonly checkLicenses: LicenseCheckerOptions;

Type: 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@v5 By default, OIDC auth is used. Alternatively a token can be provided via codeCovTokenSecret.

`codeCovTokenSecret`^Optional

public readonly codeCovTokenSecret: string;

Type: string
Default: OIDC auth is used

Define the secret name for a specified https://codecov.io/ token.

`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: 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: 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: 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: 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: default GitHub Actions user

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.

NpmConfigOptions

Options to configure the local NPM config.

Initializer

import { javascript } from 'projen'

const npmConfigOptions: javascript.NpmConfigOptions = { ... }

Properties

Name	Type	Description
`omitEmpty`	`boolean`	Omits empty objects and arrays.
`registry`	`string`	URL of the registry mirror to use.

`omitEmpty`^Optional

public readonly omitEmpty: boolean;

Type: boolean
Default: false

Omits empty objects and arrays.

`registry`^Optional

public readonly registry: string;

Type: string
Default: use npmjs default registry

URL of the registry mirror to use.

You can change this or add scoped registries using the addRegistry method

PeerDependencyOptions

Initializer

import { javascript } from 'projen'

const peerDependencyOptions: javascript.PeerDependencyOptions = { ... }

Properties

Name	Type	Description
`pinnedDevDependency`	`boolean`	Automatically add a pinned dev dependency.

`pinnedDevDependency`^Optional

public readonly pinnedDevDependency: boolean;

Type: boolean
Default: true

Automatically add a pinned dev dependency.

PrettierOptions

Options for Prettier.

Initializer

import { javascript } from 'projen'

const prettierOptions: javascript.PrettierOptions = { ... }

Properties

Name	Type	Description
`ignoreFile`	`boolean`	Defines an .prettierIgnore file.
`ignoreFileOptions`	`projen.IgnoreFileOptions`	Configuration options for .prettierignore file.
`overrides`	`PrettierOverride[]`	Provide a list of patterns to override prettier configuration.
`settings`	`PrettierSettings`	Prettier settings.
`yaml`	`boolean`	Write prettier configuration as YAML instead of JSON.

`ignoreFile`^Optional

public readonly ignoreFile: boolean;

Type: boolean
Default: true

Defines an .prettierIgnore file.

`ignoreFileOptions`^Optional

public readonly ignoreFileOptions: IgnoreFileOptions;

Type: projen.IgnoreFileOptions

Configuration options for .prettierignore file.

`overrides`^Optional

public readonly overrides: PrettierOverride[];

Type: PrettierOverride[]
Default: []

Provide a list of patterns to override prettier configuration.

https://prettier.io/docs/en/configuration.html#configuration-overrides

`settings`^Optional

public readonly settings: PrettierSettings;

Type: PrettierSettings
Default: default settings

Prettier settings.

`yaml`^Optional

public readonly yaml: boolean;

Type: boolean
Default: false

Write prettier configuration as YAML instead of JSON.

PrettierOverride

Initializer

import { javascript } from 'projen'

const prettierOverride: javascript.PrettierOverride = { ... }

Properties

Name	Type	Description
`files`	`string \| string[]`	Include these files in this override.
`options`	`PrettierSettings`	The options to apply for this override.
`excludeFiles`	`string \| string[]`	Exclude these files from this override.

`files`^Required

public readonly files: string | string[];

Type: string | string[]

Include these files in this override.

`options`^Required

public readonly options: PrettierSettings;

Type: PrettierSettings

The options to apply for this override.

`excludeFiles`^Optional

public readonly excludeFiles: string | string[];

Type: string | string[]

Exclude these files from this override.

PrettierSettings

Options to set in Prettier directly or through overrides.

https://prettier.io/docs/en/options.html

Initializer

import { javascript } from 'projen'

const prettierSettings: javascript.PrettierSettings = { ... }

Properties

Name	Type	Description
`arrowParens`	`ArrowParens`	Include parentheses around a sole arrow function parameter.
`bracketSameLine`	`boolean`	Put > of opening tags on the last line instead of on a new line.
`bracketSpacing`	`boolean`	Print spaces between brackets.
`cursorOffset`	`number`	Print (to stderr) where a cursor at the given position would move to after formatting.
`embeddedLanguageFormatting`	`EmbeddedLanguageFormatting`	Control how Prettier formats quoted code embedded in the file.
`endOfLine`	`EndOfLine`	Which end of line characters to apply.
`filepath`	`string`	Specify the input filepath.
`htmlWhitespaceSensitivity`	`HTMLWhitespaceSensitivity`	How to handle whitespaces in HTML.
`insertPragma`	`boolean`	Insert.
`jsxSingleQuote`	`boolean`	Use single quotes in JSX.
`parser`	`string`	Which parser to use.
`plugins`	`string[]`	Add a plugin.
`pluginSearchDirs`	`string[]`	Custom directory that contains prettier plugins in node_modules subdirectory.
`printWidth`	`number`	The line length where Prettier will try wrap.
`proseWrap`	`ProseWrap`	How to wrap prose.
`quoteProps`	`QuoteProps`	Change when properties in objects are quoted.
`rangeEnd`	`number`	Format code ending at a given character offset (exclusive).
`rangeStart`	`number`	Format code starting at a given character offset.
`requirePragma`	`boolean`	Require either '@prettier' or '@format' to be present in the file's first docblock comment in order for it to be formatted.
`semi`	`boolean`	Print semicolons.
`singleQuote`	`boolean`	Use single quotes instead of double quotes.
`tabWidth`	`number`	Number of spaces per indentation level.
`trailingComma`	`TrailingComma`	Print trailing commas wherever possible when multi-line.
`useTabs`	`boolean`	Indent with tabs instead of spaces.
`vueIndentScriptAndStyle`	`boolean`	Indent script and style tags in Vue files.

`arrowParens`^Optional

public readonly arrowParens: ArrowParens;

Type: ArrowParens
Default: ArrowParens.ALWAYS

Include parentheses around a sole arrow function parameter.

`bracketSameLine`^Optional

public readonly bracketSameLine: boolean;

Type: boolean
Default: false

Put > of opening tags on the last line instead of on a new line.

`bracketSpacing`^Optional

public readonly bracketSpacing: boolean;

Type: boolean
Default: true

Print spaces between brackets.

`cursorOffset`^Optional

public readonly cursorOffset: number;

Type: number
Default: 1

Print (to stderr) where a cursor at the given position would move to after formatting.

This option cannot be used with --range-start and --range-end.

`embeddedLanguageFormatting`^Optional

public readonly embeddedLanguageFormatting: EmbeddedLanguageFormatting;

Type: EmbeddedLanguageFormatting
Default: EmbeddedLanguageFormatting.AUTO

Control how Prettier formats quoted code embedded in the file.

`endOfLine`^Optional

public readonly endOfLine: EndOfLine;

Type: EndOfLine
Default: EndOfLine.LF

Which end of line characters to apply.

`filepath`^Optional

public readonly filepath: string;

Type: string
Default: none

Specify the input filepath.

This will be used to do parser inference.

`htmlWhitespaceSensitivity`^Optional

public readonly htmlWhitespaceSensitivity: HTMLWhitespaceSensitivity;

Type: HTMLWhitespaceSensitivity
Default: HTMLWhitespaceSensitivity.CSS

How to handle whitespaces in HTML.

`insertPragma`^Optional

public readonly insertPragma: boolean;

Type: boolean
Default: false

Insert.

`jsxSingleQuote`^Optional

public readonly jsxSingleQuote: boolean;

Type: boolean
Default: false

Use single quotes in JSX.

`parser`^Optional

public readonly parser: string;

Type: string
Default: Prettier automatically infers the parser from the input file path, so you shouldn’t have to change this setting.

Which parser to use.

`plugins`^Optional

public readonly plugins: string[];

Type: string[]
Default: []

Add a plugin.

Multiple plugins can be passed as separate --plugins.

`pluginSearchDirs`^Optional

public readonly pluginSearchDirs: string[];

Type: string[]
Default: []

Custom directory that contains prettier plugins in node_modules subdirectory.

Overrides default behavior when plugins are searched relatively to the location of Prettier. Multiple values are accepted.

`printWidth`^Optional

public readonly printWidth: number;

Type: number
Default: 80

The line length where Prettier will try wrap.

`proseWrap`^Optional

public readonly proseWrap: ProseWrap;

Type: ProseWrap
Default: ProseWrap.PRESERVE

How to wrap prose.

`quoteProps`^Optional

public readonly quoteProps: QuoteProps;

Type: QuoteProps
Default: QuoteProps.ASNEEDED

Change when properties in objects are quoted.

`rangeEnd`^Optional

public readonly rangeEnd: number;

Type: number
Default: null

Format code ending at a given character offset (exclusive).

The range will extend forwards to the end of the selected statement. This option cannot be used with --cursor-offset.

`rangeStart`^Optional

public readonly rangeStart: number;

Type: number
Default: 0

Format code starting at a given character offset.

The range will extend backwards to the start of the first line containing the selected statement. This option cannot be used with --cursor-offset.

`requirePragma`^Optional

public readonly requirePragma: boolean;

Type: boolean
Default: false

Require either '@prettier' or '@format' to be present in the file's first docblock comment in order for it to be formatted.

`semi`^Optional

public readonly semi: boolean;

Type: boolean
Default: true

Print semicolons.

`singleQuote`^Optional

public readonly singleQuote: boolean;

Type: boolean
Default: false

Use single quotes instead of double quotes.

`tabWidth`^Optional

public readonly tabWidth: number;

Type: number
Default: 2

Number of spaces per indentation level.

`trailingComma`^Optional

public readonly trailingComma: TrailingComma;

Type: TrailingComma
Default: TrailingComma.ES5

Print trailing commas wherever possible when multi-line.

`useTabs`^Optional

public readonly useTabs: boolean;

Type: boolean
Default: false

Indent with tabs instead of spaces.

`vueIndentScriptAndStyle`^Optional

public readonly vueIndentScriptAndStyle: boolean;

Type: boolean
Default: false

Indent script and style tags in Vue files.

ProjenrcOptions

Initializer

import { javascript } from 'projen'

const projenrcOptions: javascript.ProjenrcOptions = { ... }

Properties

Name	Type	Description
`filename`	`string`	The name of the projenrc file.

`filename`^Optional

public readonly filename: string;

Type: string
Default: ".projenrc.js"

The name of the projenrc file.

RenderWorkflowSetupOptions

Options for renderWorkflowSetup().

Initializer

import { javascript } from 'projen'

const renderWorkflowSetupOptions: javascript.RenderWorkflowSetupOptions = { ... }

Properties

Name	Type	Description
`installStepConfiguration`	`projen.github.workflows.JobStepConfiguration`	Configure the install step in the workflow setup.
`mutable`	`boolean`	Should the package lockfile be updated?

`installStepConfiguration`^Optional

public readonly installStepConfiguration: JobStepConfiguration;

Type: projen.github.workflows.JobStepConfiguration
Default: { name: "Install dependencies" }

Configure the install step in the workflow setup.

Example

- { env: { NPM_TOKEN: "token" }} for installing from private npm registry.

`mutable`^Optional

public readonly mutable: boolean;

Type: boolean
Default: false

Should the package lockfile be updated?

ScopedPackagesOptions

Options for scoped packages.

Initializer

import { javascript } from 'projen'

const scopedPackagesOptions: javascript.ScopedPackagesOptions = { ... }

Properties

Name	Type	Description
`registryUrl`	`string`	URL of the registry for scoped packages.
`scope`	`string`	Scope of the packages.

`registryUrl`^Required

public readonly registryUrl: string;

Type: string

URL of the registry for scoped packages.

`scope`^Required

public readonly scope: string;

Type: string

Scope of the packages.

Example

"@angular"

TypeScriptCompilerOptions

Initializer

import { javascript } from 'projen'

const typeScriptCompilerOptions: javascript.TypeScriptCompilerOptions = { ... }

Properties

Name	Type	Description
`allowArbitraryExtensions`	`boolean`	Suppress arbitrary extension import errors with the assumption that a bundler will be handling it.
`allowImportingTsExtensions`	`boolean`	Allows TypeScript files to import each other with TypeScript-specific extensions (`.ts`, `.mts`, `.tsx`). Requires `noEmit` or `emitDeclarationOnly`.
`allowJs`	`boolean`	Allow JavaScript files to be compiled.
`allowSyntheticDefaultImports`	`boolean`	Allow default imports from modules with no default export.
`allowUnreachableCode`	`boolean`	Allow Unreachable Code.
`allowUnusedLabels`	`boolean`	Allow Unused Labels.
`alwaysStrict`	`boolean`	Ensures that your files are parsed in the ECMAScript strict mode, and emit “use strict” for each source file.
`baseUrl`	`string`	Lets you set a base directory to resolve non-absolute module names.
`checkJs`	`boolean`	Check JS.
`customConditions`	`string[]`	List of additional conditions that should succeed when TypeScript resolves from an `exports` or `imports` field of a `package.json`.
`declaration`	`boolean`	To be specified along with the above.
`declarationDir`	`string`	Offers a way to configure the root directory for where declaration files are emitted.
`declarationMap`	`boolean`	Generates a source map for .d.ts files which map back to the original .ts source file. This will allow editors such as VS Code to go to the original .ts file when using features like Go to Definition.
`downlevelIteration`	`boolean`	Downleveling is TypeScript’s term for transpiling to an older version of JavaScript.
`emitDeclarationOnly`	`boolean`	Only emit .d.ts files; do not emit .js files.
`emitDecoratorMetadata`	`boolean`	Enables experimental support for decorators, which is in stage 2 of the TC39 standardization process.
`esModuleInterop`	`boolean`	Emit __importStar and __importDefault helpers for runtime babel ecosystem compatibility and enable --allowSyntheticDefaultImports for typesystem compatibility.
`exactOptionalPropertyTypes`	`boolean`	Specifies that optional property types should be interpreted exactly as written, meaning that `\| undefined` is not added to the type Available with TypeScript 4.4 and newer.
`experimentalDecorators`	`boolean`	Enables experimental support for decorators, which is in stage 2 of the TC39 standardization process.
`forceConsistentCasingInFileNames`	`boolean`	Disallow inconsistently-cased references to the same file.
`importsNotUsedAsValues`	`TypeScriptImportsNotUsedAsValues`	This flag works because you can use `import type` to explicitly create an `import` statement which should never be emitted into JavaScript.
`incremental`	`boolean`	Tells TypeScript to save information about the project graph from the last compilation to files stored on disk.
`inlineSourceMap`	`boolean`	When set, instead of writing out a .js.map file to provide source maps, TypeScript will embed the source map content in the .js files.
`inlineSources`	`boolean`	When set, TypeScript will include the original content of the .ts file as an embedded string in the source map. This is often useful in the same cases as inlineSourceMap.
`isolatedModules`	`boolean`	Perform additional checks to ensure that separate compilation (such as with transpileModule or.
`jsx`	`TypeScriptJsxMode`	Support JSX in .tsx files: "react", "preserve", "react-native" etc.
`jsxImportSource`	`string`	Declares the module specifier to be used for importing the jsx and jsxs factory functions when using jsx.
`lib`	`string[]`	Reference for type definitions / libraries to use (eg.
`module`	`string`	Sets the module system for the program.
`moduleDetection`	`TypeScriptModuleDetection`	This setting controls how TypeScript determines whether a file is a script or a module.
`moduleResolution`	`TypeScriptModuleResolution`	Determine how modules get resolved.
`noEmit`	`boolean`	Do not emit outputs.
`noEmitOnError`	`boolean`	Do not emit compiler output files like JavaScript source code, source-maps or declarations if any errors were reported.
`noFallthroughCasesInSwitch`	`boolean`	Report errors for fallthrough cases in switch statements.
`noImplicitAny`	`boolean`	In some cases where no type annotations are present, TypeScript will fall back to a type of any for a variable when it cannot infer the type.
`noImplicitOverride`	`boolean`	Using `noImplicitOverride`, you can ensure that sub-classes never go out of sync as they are required to explicitly declare that they are overriding a member using the `override` keyword.
`noImplicitReturns`	`boolean`	When enabled, TypeScript will check all code paths in a function to ensure they return a value.
`noImplicitThis`	`boolean`	Raise error on ‘this’ expressions with an implied ‘any’ type.
`noPropertyAccessFromIndexSignature`	`boolean`	Raise error on use of the dot syntax to access fields which are not defined.
`noUncheckedIndexedAccess`	`boolean`	Raise error when accessing indexes on objects with unknown keys defined in index signatures.
`noUnusedLocals`	`boolean`	Report errors on unused local variables.
`noUnusedParameters`	`boolean`	Report errors on unused parameters in functions.
`outDir`	`string`	Output directory for the compiled files.
`paths`	`{[ key: string ]: string[]}`	A series of entries which re-map imports to lookup locations relative to the baseUrl, there is a larger coverage of paths in the handbook.
`resolveJsonModule`	`boolean`	Allows importing modules with a ‘.json’ extension, which is a common practice in node projects. This includes generating a type for the import based on the static JSON shape.
`resolvePackageJsonExports`	`boolean`	Forces TypeScript to consult the `exports` field of `package.json` files if it ever reads from a package in `node_modules`.
`resolvePackageJsonImports`	`boolean`	Forces TypeScript to consult the `imports` field of `package.json` when performing a lookup that begins with `#` from a file that has a `package.json` as an ancestor.
`rootDir`	`string`	Specifies the root directory of input files.
`skipLibCheck`	`boolean`	Skip type checking of all declaration files (*.d.ts).
`sourceMap`	`boolean`	Enables the generation of sourcemap files.
`sourceRoot`	`string`	Specify the location where a debugger should locate TypeScript files instead of relative source locations.
`strict`	`boolean`	The strict flag enables a wide range of type checking behavior that results in stronger guarantees of program correctness.
`strictNullChecks`	`boolean`	When strictNullChecks is false, null and undefined are effectively ignored by the language.
`strictPropertyInitialization`	`boolean`	When set to true, TypeScript will raise an error when a class property was declared but not set in the constructor.
`stripInternal`	`boolean`	Do not emit declarations for code that has an `@internal` annotation in it’s JSDoc comment.
`target`	`string`	Modern browsers support all ES6 features, so ES6 is a good choice.
`tsBuildInfoFile`	`string`	This setting lets you specify a file for storing incremental compilation information as a part of composite projects which enables faster building of larger TypeScript codebases.
`typeRoots`	`string[]`	If typeRoots is specified, only packages under typeRoots will be included.
`types`	`string[]`	If types is specified, only packages listed will be included in the global scope.
`useUnknownInCatchVariables`	`boolean`	Change the type of the variable in a catch clause from any to unknown Available with TypeScript 4.4 and newer.
`verbatimModuleSyntax`	`boolean`	Simplifies TypeScript's handling of import/export `type` modifiers.

`allowArbitraryExtensions`^Optional

public readonly allowArbitraryExtensions: boolean;

Type: boolean
Default: undefined

Suppress arbitrary extension import errors with the assumption that a bundler will be handling it.

https://www.typescriptlang.org/tsconfig#allowArbitraryExtensions

`allowImportingTsExtensions`^Optional

public readonly allowImportingTsExtensions: boolean;

Type: boolean
Default: undefined

Allows TypeScript files to import each other with TypeScript-specific extensions (.ts, .mts, .tsx). Requires noEmit or emitDeclarationOnly.

`allowJs`^Optional

public readonly allowJs: boolean;

Type: boolean
Default: false

Allow JavaScript files to be compiled.

`allowSyntheticDefaultImports`^Optional

public readonly allowSyntheticDefaultImports: boolean;

Type: boolean

Allow default imports from modules with no default export.

This does not affect code emit, just typechecking.

`allowUnreachableCode`^Optional

public readonly allowUnreachableCode: boolean;

Type: boolean

Allow Unreachable Code.

When:

undefined (default) provide suggestions as warnings to editors
true unreachable code is ignored
false raises compiler errors about unreachable code

These warnings are only about code which is provably unreachable due to the use of JavaScript syntax.

https://www.typescriptlang.org/tsconfig#allowUnreachableCode

`allowUnusedLabels`^Optional

public readonly allowUnusedLabels: boolean;

Type: boolean

Allow Unused Labels.

When:

undefined (default) provide suggestions as warnings to editors
true unused labels are ignored
false raises compiler errors about unused labels

Labels are very rare in JavaScript and typically indicate an attempt to write an object literal:

function verifyAge(age: number) {
  // Forgot 'return' statement
  if (age > 18) {
    verified: true;
//  ^^^^^^^^ Unused label.
  }
}

https://www.typescriptlang.org/tsconfig#allowUnusedLabels

`alwaysStrict`^Optional

public readonly alwaysStrict: boolean;

Type: boolean
Default: true

Ensures that your files are parsed in the ECMAScript strict mode, and emit “use strict” for each source file.

`baseUrl`^Optional

public readonly baseUrl: string;

Type: string

Lets you set a base directory to resolve non-absolute module names.

You can define a root folder where you can do absolute file resolution.

`checkJs`^Optional

public readonly checkJs: boolean;

Type: boolean

Check JS.

Works in tandem with allowJs. When checkJs is enabled then errors are reported in JavaScript files. This is the equivalent of including //

https://www.typescriptlang.org/tsconfig#checkJs

`customConditions`^Optional

public readonly customConditions: string[];

Type: string[]
Default: undefined

List of additional conditions that should succeed when TypeScript resolves from an exports or imports field of a package.json.

https://www.typescriptlang.org/tsconfig#customConditions

`declaration`^Optional

public readonly declaration: boolean;

Type: boolean

To be specified along with the above.

`declarationDir`^Optional

public readonly declarationDir: string;

Type: string

Offers a way to configure the root directory for where declaration files are emitted.

`declarationMap`^Optional

public readonly declarationMap: boolean;

Type: boolean

Generates a source map for .d.ts files which map back to the original .ts source file. This will allow editors such as VS Code to go to the original .ts file when using features like Go to Definition.

[{@link https://www.typescriptlang.org/tsconfig#declarationMap}]({@link https://www.typescriptlang.org/tsconfig#declarationMap})

`downlevelIteration`^Optional

public readonly downlevelIteration: boolean;

Type: boolean

Downleveling is TypeScript’s term for transpiling to an older version of JavaScript.

This flag is to enable support for a more accurate implementation of how modern JavaScript iterates through new concepts in older JavaScript runtimes.

ECMAScript 6 added several new iteration primitives: the for / of loop (for (el of arr)), Array spread ([a, ...b]), argument spread (fn(...args)), and Symbol.iterator. downlevelIteration allows for these iteration primitives to be used more accurately in ES5 environments if a Symbol.iterator implementation is present.

`emitDeclarationOnly`^Optional

public readonly emitDeclarationOnly: boolean;

Type: boolean
Default: false

Only emit .d.ts files; do not emit .js files.

`emitDecoratorMetadata`^Optional

public readonly emitDecoratorMetadata: boolean;

Type: boolean
Default: undefined

Enables experimental support for decorators, which is in stage 2 of the TC39 standardization process.

Decorators are a language feature which hasn’t yet been fully ratified into the JavaScript specification. This means that the implementation version in TypeScript may differ from the implementation in JavaScript when it it decided by TC39. You can find out more about decorator support in TypeScript in the handbook.

https://www.typescriptlang.org/docs/handbook/decorators.html

`esModuleInterop`^Optional

public readonly esModuleInterop: boolean;

Type: boolean
Default: false

Emit __importStar and __importDefault helpers for runtime babel ecosystem compatibility and enable --allowSyntheticDefaultImports for typesystem compatibility.

`exactOptionalPropertyTypes`^Optional

public readonly exactOptionalPropertyTypes: boolean;

Type: boolean
Default: false

Specifies that optional property types should be interpreted exactly as written, meaning that | undefined is not added to the type Available with TypeScript 4.4 and newer.

`experimentalDecorators`^Optional

public readonly experimentalDecorators: boolean;

Type: boolean
Default: true

Enables experimental support for decorators, which is in stage 2 of the TC39 standardization process.

`forceConsistentCasingInFileNames`^Optional

public readonly forceConsistentCasingInFileNames: boolean;

Type: boolean
Default: false

Disallow inconsistently-cased references to the same file.

`importsNotUsedAsValues`^Optional

public readonly importsNotUsedAsValues: TypeScriptImportsNotUsedAsValues;

Type: TypeScriptImportsNotUsedAsValues
Default: "remove"

This flag works because you can use import type to explicitly create an import statement which should never be emitted into JavaScript.

https://www.typescriptlang.org/tsconfig#importsNotUsedAsValues

`incremental`^Optional

public readonly incremental: boolean;

Type: boolean

Tells TypeScript to save information about the project graph from the last compilation to files stored on disk.

This creates a series of .tsbuildinfo files in the same folder as your compilation output. They are not used by your JavaScript at runtime and can be safely deleted. You can read more about the flag in the 3.4 release notes.

[https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#faster-subsequent-builds-with-the---incremental-flag

To control which folders you want to the files to be built to, use the config option tsBuildInfoFile.](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-4.html#faster-subsequent-builds-with-the---incremental-flag

To control which folders you want to the files to be built to, use the config option tsBuildInfoFile.)

`inlineSourceMap`^Optional

public readonly inlineSourceMap: boolean;

Type: boolean
Default: true

When set, instead of writing out a .js.map file to provide source maps, TypeScript will embed the source map content in the .js files.

`inlineSources`^Optional

public readonly inlineSources: boolean;

Type: boolean
Default: true

When set, TypeScript will include the original content of the .ts file as an embedded string in the source map. This is often useful in the same cases as inlineSourceMap.

`isolatedModules`^Optional

public readonly isolatedModules: boolean;

Type: boolean
Default: false

Perform additional checks to ensure that separate compilation (such as with transpileModule or.

`jsx`^Optional

public readonly jsx: TypeScriptJsxMode;

Type: TypeScriptJsxMode
Default: undefined

Support JSX in .tsx files: "react", "preserve", "react-native" etc.

`jsxImportSource`^Optional

public readonly jsxImportSource: string;

Type: string
Default: undefined

Declares the module specifier to be used for importing the jsx and jsxs factory functions when using jsx.

`lib`^Optional

public readonly lib: string[];

Type: string[]
Default: [ "es2018" ]

Reference for type definitions / libraries to use (eg.

ES2016, ES5, ES2018).

`module`^Optional

public readonly module: string;

Type: string
Default: "CommonJS"

Sets the module system for the program.

See https://www.typescriptlang.org/docs/handbook/modules.html#ambient-modules.

`moduleDetection`^Optional

public readonly moduleDetection: TypeScriptModuleDetection;

Type: TypeScriptModuleDetection
Default: "auto"

This setting controls how TypeScript determines whether a file is a script or a module.

`moduleResolution`^Optional

public readonly moduleResolution: TypeScriptModuleResolution;

Type: TypeScriptModuleResolution
Default: "node"

Determine how modules get resolved.

Either "Node" for Node.js/io.js style resolution, or "Classic".

`noEmit`^Optional

public readonly noEmit: boolean;

Type: boolean
Default: false

Do not emit outputs.

`noEmitOnError`^Optional

public readonly noEmitOnError: boolean;

Type: boolean
Default: true

Do not emit compiler output files like JavaScript source code, source-maps or declarations if any errors were reported.

`noFallthroughCasesInSwitch`^Optional

public readonly noFallthroughCasesInSwitch: boolean;

Type: boolean
Default: true

Report errors for fallthrough cases in switch statements.

Ensures that any non-empty case inside a switch statement includes either break or return. This means you won’t accidentally ship a case fallthrough bug.

`noImplicitAny`^Optional

public readonly noImplicitAny: boolean;

Type: boolean
Default: true

In some cases where no type annotations are present, TypeScript will fall back to a type of any for a variable when it cannot infer the type.

`noImplicitOverride`^Optional

public readonly noImplicitOverride: boolean;

Type: boolean
Default: false

Using noImplicitOverride, you can ensure that sub-classes never go out of sync as they are required to explicitly declare that they are overriding a member using the override keyword.

This also improves readability of the programmer's intent.

Available with TypeScript 4.3 and newer.

`noImplicitReturns`^Optional

public readonly noImplicitReturns: boolean;

Type: boolean
Default: true

When enabled, TypeScript will check all code paths in a function to ensure they return a value.

`noImplicitThis`^Optional

public readonly noImplicitThis: boolean;

Type: boolean
Default: true

Raise error on ‘this’ expressions with an implied ‘any’ type.

`noPropertyAccessFromIndexSignature`^Optional

public readonly noPropertyAccessFromIndexSignature: boolean;

Type: boolean
Default: true

Raise error on use of the dot syntax to access fields which are not defined.

`noUncheckedIndexedAccess`^Optional

public readonly noUncheckedIndexedAccess: boolean;

Type: boolean
Default: true

Raise error when accessing indexes on objects with unknown keys defined in index signatures.

`noUnusedLocals`^Optional

public readonly noUnusedLocals: boolean;

Type: boolean
Default: true

Report errors on unused local variables.

`noUnusedParameters`^Optional

public readonly noUnusedParameters: boolean;

Type: boolean
Default: true

Report errors on unused parameters in functions.

`outDir`^Optional

public readonly outDir: string;

Type: string

Output directory for the compiled files.

`paths`^Optional

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

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

A series of entries which re-map imports to lookup locations relative to the baseUrl, there is a larger coverage of paths in the handbook.

paths lets you declare how TypeScript should resolve an import in your require/imports.

`resolveJsonModule`^Optional

public readonly resolveJsonModule: boolean;

Type: boolean
Default: true

Allows importing modules with a ‘.json’ extension, which is a common practice in node projects. This includes generating a type for the import based on the static JSON shape.

`resolvePackageJsonExports`^Optional

public readonly resolvePackageJsonExports: boolean;

Type: boolean
Default: true

Forces TypeScript to consult the exports field of package.json files if it ever reads from a package in node_modules.

`resolvePackageJsonImports`^Optional

public readonly resolvePackageJsonImports: boolean;

Type: boolean
Default: undefined

Forces TypeScript to consult the imports field of package.json when performing a lookup that begins with # from a file that has a package.json as an ancestor.

`rootDir`^Optional

public readonly rootDir: string;

Type: string

Specifies the root directory of input files.

Only use to control the output directory structure with outDir.

`skipLibCheck`^Optional

public readonly skipLibCheck: boolean;

Type: boolean
Default: false

Skip type checking of all declaration files (*.d.ts).

`sourceMap`^Optional

public readonly sourceMap: boolean;

Type: boolean
Default: undefined

Enables the generation of sourcemap files.

`sourceRoot`^Optional

public readonly sourceRoot: string;

Type: string
Default: undefined

Specify the location where a debugger should locate TypeScript files instead of relative source locations.

`strict`^Optional

public readonly strict: boolean;

Type: boolean
Default: true

The strict flag enables a wide range of type checking behavior that results in stronger guarantees of program correctness.

Turning this on is equivalent to enabling all of the strict mode family options, which are outlined below. You can then turn off individual strict mode family checks as needed.

`strictNullChecks`^Optional

public readonly strictNullChecks: boolean;

Type: boolean
Default: true

When strictNullChecks is false, null and undefined are effectively ignored by the language.

This can lead to unexpected errors at runtime. When strictNullChecks is true, null and undefined have their own distinct types and you’ll get a type error if you try to use them where a concrete value is expected.

`strictPropertyInitialization`^Optional

public readonly strictPropertyInitialization: boolean;

Type: boolean
Default: true

When set to true, TypeScript will raise an error when a class property was declared but not set in the constructor.

`stripInternal`^Optional

public readonly stripInternal: boolean;

Type: boolean
Default: true

Do not emit declarations for code that has an @internal annotation in it’s JSDoc comment.

`target`^Optional

public readonly target: string;

Type: string
Default: "ES2018"

Modern browsers support all ES6 features, so ES6 is a good choice.

You might choose to set a lower target if your code is deployed to older environments, or a higher target if your code is guaranteed to run in newer environments.

`tsBuildInfoFile`^Optional

public readonly tsBuildInfoFile: string;

Type: string

This setting lets you specify a file for storing incremental compilation information as a part of composite projects which enables faster building of larger TypeScript codebases.

You can read more about composite projects in the handbook.

`typeRoots`^Optional

public readonly typeRoots: string[];

Type: string[]

If typeRoots is specified, only packages under typeRoots will be included.

https://www.typescriptlang.org/tsconfig/#typeRoots

`types`^Optional

public readonly types: string[];

Type: string[]

If types is specified, only packages listed will be included in the global scope.

https://www.typescriptlang.org/tsconfig#types

`useUnknownInCatchVariables`^Optional

public readonly useUnknownInCatchVariables: boolean;

Type: boolean
Default: true

Change the type of the variable in a catch clause from any to unknown Available with TypeScript 4.4 and newer.

`verbatimModuleSyntax`^Optional

public readonly verbatimModuleSyntax: boolean;

Type: boolean
Default: undefined

Simplifies TypeScript's handling of import/export type modifiers.

https://www.typescriptlang.org/tsconfig#verbatimModuleSyntax

TypescriptConfigOptions

Initializer

import { javascript } from 'projen'

const typescriptConfigOptions: javascript.TypescriptConfigOptions = { ... }

Properties

Name	Type	Description
`compilerOptions`	`TypeScriptCompilerOptions`	Compiler options to use.
`exclude`	`string[]`	Filters results from the "include" option.
`extends`	`TypescriptConfigExtends`	Base `tsconfig.json` configuration(s) to inherit from.
`fileName`	`string`	No description.
`include`	`string[]`	Specifies a list of glob patterns that match TypeScript files to be included in compilation.

`compilerOptions`^Optional

public readonly compilerOptions: TypeScriptCompilerOptions;

Type: TypeScriptCompilerOptions

Compiler options to use.

`exclude`^Optional

public readonly exclude: string[];

Type: string[]
Default: node_modules is excluded by default

Filters results from the "include" option.

`extends`^Optional

public readonly extends: TypescriptConfigExtends;

Type: TypescriptConfigExtends

Base tsconfig.json configuration(s) to inherit from.

`fileName`^Optional

public readonly fileName: string;

Type: string
Default: "tsconfig.json"

`include`^Optional

public readonly include: string[];

Type: string[]
Default: all .ts files recursively

Specifies a list of glob patterns that match TypeScript files to be included in compilation.

UpgradeDependenciesOptions

Options for UpgradeDependencies.

Initializer

import { javascript } from 'projen'

const upgradeDependenciesOptions: javascript.UpgradeDependenciesOptions = { ... }

Properties

Name	Type	Description
`cooldown`	`number`	Exclude package versions published within the specified number of days.
`exclude`	`string[]`	List of package names to exclude during the upgrade.
`include`	`string[]`	List of package names to include during the upgrade.
`includeDeprecatedVersions`	`boolean`	Include deprecated packages.
`pullRequestTitle`	`string`	Title of the pull request to use (should be all lower-case).
`satisfyPeerDependencies`	`boolean`	Check peer dependencies of installed packages and filter updates to compatible versions.
`semanticCommit`	`string`	The semantic commit type.
`signoff`	`boolean`	Add Signed-off-by line by the committer at the end of the commit log message.
`target`	`string`	Determines the target version to upgrade dependencies to.
`taskName`	`string`	The name of the task that will be created.
`types`	`projen.DependencyType[]`	Specify which dependency types the upgrade should operate on.
`workflow`	`boolean`	Include a github workflow for creating PR's that upgrades the required dependencies, either by manual dispatch, or by a schedule.
`workflowOptions`	`UpgradeDependenciesWorkflowOptions`	Options for the github workflow.

`cooldown`^Optional

public readonly cooldown: number;

Type: number
Default: No cooldown period.

Exclude package versions published within the specified number of days.

This may provide some protection against supply chain attacks, simply by avoiding newly published packages that may be malicious. It gives the ecosystem more time to detect malicious packages. However it comes at the cost of updating other packages slower, which might also contain vulnerabilities or bugs in need of a fix.

The cooldown period applies to both npm-check-updates discovery and the package manager update command.

https://yarnpkg.com/configuration/yarnrc#npmMinimalAgeGate

`exclude`^Optional

public readonly exclude: string[];

Type: string[]
Default: Nothing is excluded.

List of package names to exclude during the upgrade.

`include`^Optional

public readonly include: string[];

Type: string[]
Default: Everything is included.

List of package names to include during the upgrade.

`includeDeprecatedVersions`^Optional

public readonly includeDeprecatedVersions: boolean;

Type: boolean
Default: false

Include deprecated packages.

By default, deprecated versions will be excluded from upgrades.

https://github.com/raineorshine/npm-check-updates?tab=readme-ov-file#options

`pullRequestTitle`^Optional

public readonly pullRequestTitle: string;

Type: string
Default: "upgrade dependencies"

Title of the pull request to use (should be all lower-case).

`satisfyPeerDependencies`^Optional

public readonly satisfyPeerDependencies: boolean;

Type: boolean
Default: true

Check peer dependencies of installed packages and filter updates to compatible versions.

By default, the upgrade workflow will adhere to version constraints from peer dependencies. Sometimes this is not desirable and can be disabled.

https://github.com/raineorshine/npm-check-updates#peer

`semanticCommit`^Optional

public readonly semanticCommit: string;

Type: string
Default: 'chore'

The semantic commit type.

`signoff`^Optional

public readonly signoff: boolean;

Type: boolean
Default: true

Add Signed-off-by line by the committer at the end of the commit log message.

`target`^Optional

public readonly target: string;

Type: string
Default: "minor"

Determines the target version to upgrade dependencies to.

https://github.com/raineorshine/npm-check-updates#target

`taskName`^Optional

public readonly taskName: string;

Type: string
Default: "upgrade".

The name of the task that will be created.

This will also be the workflow name.

`types`^Optional

public readonly types: DependencyType[];

Type: projen.DependencyType[]
Default: All dependency types.

Specify which dependency types the upgrade should operate on.

`workflow`^Optional

public readonly workflow: boolean;

Type: boolean
Default: true for root projects, false for subprojects.

Include a github workflow for creating PR's that upgrades the required dependencies, either by manual dispatch, or by a schedule.

If this is false, only a local projen task is created, which can be executed manually to upgrade the dependencies.

`workflowOptions`^Optional

public readonly workflowOptions: UpgradeDependenciesWorkflowOptions;

Type: UpgradeDependenciesWorkflowOptions
Default: default options.

Options for the github workflow.

Only applies if workflow is true.

UpgradeDependenciesWorkflowOptions

Options for UpgradeDependencies.workflowOptions.

Initializer

import { javascript } from 'projen'

const upgradeDependenciesWorkflowOptions: javascript.UpgradeDependenciesWorkflowOptions = { ... }

Properties

Name	Type	Description
`assignees`	`string[]`	Assignees to add on the PR.
`branches`	`string[]`	List of branches to create PR's for.
`container`	`projen.github.workflows.ContainerOptions`	Job container options.
`env`	`{[ key: string ]: string}`	Build environment variables for the upgrade job.
`gitIdentity`	`projen.github.GitIdentity`	The git identity to use for commits.
`labels`	`string[]`	Labels to apply on the PR.
`permissions`	`projen.github.workflows.JobPermissions`	Permissions granted to the upgrade job To limit job permissions for `contents`, the desired permissions have to be explicitly set, e.g.: `{ contents: JobPermission.NONE }`.
`projenCredentials`	`projen.github.GithubCredentials`	Choose a method for authenticating with GitHub for creating the PR.
`runsOn`	`string[]`	Github Runner selection labels.
`runsOnGroup`	`projen.GroupRunnerOptions`	Github Runner Group selection options.
`schedule`	`UpgradeDependenciesSchedule`	Schedule to run on.

`assignees`^Optional

public readonly assignees: string[];

Type: string[]
Default: no assignees

Assignees to add on the PR.

`branches`^Optional

public readonly branches: string[];

Type: string[]
Default: All release branches configured for the project.

List of branches to create PR's for.

`container`^Optional

public readonly container: ContainerOptions;

Type: projen.github.workflows.ContainerOptions
Default: defaults

Job container options.

`env`^Optional

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

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

Build environment variables for the upgrade job.

`gitIdentity`^Optional

public readonly gitIdentity: GitIdentity;

Type: projen.github.GitIdentity
Default: default GitHub Actions user

The git identity to use for commits.

`labels`^Optional

public readonly labels: string[];

Type: string[]
Default: no labels.

Labels to apply on the PR.

`permissions`^Optional

public readonly permissions: JobPermissions;

Type: projen.github.workflows.JobPermissions
Default: { contents: JobPermission.READ }

Permissions granted to the upgrade job To limit job permissions for contents, the desired permissions have to be explicitly set, e.g.: { contents: JobPermission.NONE }.

`projenCredentials`^Optional

public readonly projenCredentials: GithubCredentials;

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

Choose a method for authenticating with GitHub for creating the PR.

When using the default github token, PR's created by this workflow will not trigger any subsequent workflows (i.e the build workflow), so projen requires API access to be provided through e.g. a personal access token or other method.

https://github.com/peter-evans/create-pull-request/issues/48

`runsOn`^Optional

public readonly runsOn: string[];

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

Github Runner selection labels.

`runsOnGroup`^Optional

public readonly runsOnGroup: GroupRunnerOptions;

Type: projen.GroupRunnerOptions

Github Runner Group selection options.

`schedule`^Optional

public readonly schedule: UpgradeDependenciesSchedule;

Type: UpgradeDependenciesSchedule
Default: UpgradeDependenciesSchedule.DAILY

Schedule to run on.

YarnBerryOptions

Configure Yarn Berry.

Initializer

import { javascript } from 'projen'

const yarnBerryOptions: javascript.YarnBerryOptions = { ... }

Properties

Name	Type	Description
`version`	`string`	A fully specified version to use for yarn (e.g., x.x.x).
`yarnRcOptions`	`YarnrcOptions`	The yarnrc configuration.
`zeroInstalls`	`boolean`	Should zero-installs be enabled?

`version`^Optional

public readonly version: string;

Type: string
Default: 4.0.1

A fully specified version to use for yarn (e.g., x.x.x).

`yarnRcOptions`^Optional

public readonly yarnRcOptions: YarnrcOptions;

Type: YarnrcOptions
Default: a blank Yarn RC file

The yarnrc configuration.

`zeroInstalls`^Optional

public readonly zeroInstalls: boolean;

Type: boolean
Default: false

Should zero-installs be enabled?

Learn more at: https://yarnpkg.com/features/caching#zero-installs

YarnLogFilter

https://yarnpkg.com/configuration/yarnrc#logFilters.

Initializer

import { javascript } from 'projen'

const yarnLogFilter: javascript.YarnLogFilter = { ... }

Properties

Name	Type	Description
`code`	`string`	No description.
`level`	`YarnLogFilterLevel`	No description.
`pattern`	`string`	No description.
`text`	`string`	No description.

`code`^Optional

public readonly code: string;

Type: string

`level`^Optional

public readonly level: YarnLogFilterLevel;

Type: YarnLogFilterLevel

`pattern`^Optional

public readonly pattern: string;

Type: string

`text`^Optional

public readonly text: string;

Type: string

YarnNetworkSetting

https://yarnpkg.com/configuration/yarnrc#networkSettings.

Initializer

import { javascript } from 'projen'

const yarnNetworkSetting: javascript.YarnNetworkSetting = { ... }

Properties

Name	Type	Description
`caFilePath`	`string`	No description.
`enableNetwork`	`boolean`	No description.
`httpProxy`	`string`	No description.
`httpsCaFilePath`	`string`	No description.
`httpsCertFilePath`	`string`	No description.
`httpsKeyFilePath`	`string`	No description.
`httpsProxy`	`string`	No description.

`caFilePath`^Optional

Deprecated: - use httpsCaFilePath in Yarn v4 and newer

public readonly caFilePath: string;

Type: string

`enableNetwork`^Optional

public readonly enableNetwork: boolean;

Type: boolean

`httpProxy`^Optional

public readonly httpProxy: string;

Type: string

`httpsCaFilePath`^Optional

public readonly httpsCaFilePath: string;

Type: string

`httpsCertFilePath`^Optional

public readonly httpsCertFilePath: string;

Type: string

`httpsKeyFilePath`^Optional

public readonly httpsKeyFilePath: string;

Type: string

`httpsProxy`^Optional

public readonly httpsProxy: string;

Type: string

YarnNpmRegistry

https://yarnpkg.com/configuration/yarnrc#npmRegistries.

Initializer

import { javascript } from 'projen'

const yarnNpmRegistry: javascript.YarnNpmRegistry = { ... }

Properties

Name	Type	Description
`npmAlwaysAuth`	`boolean`	No description.
`npmAuthIdent`	`string`	No description.
`npmAuthToken`	`string`	No description.

`npmAlwaysAuth`^Optional

public readonly npmAlwaysAuth: boolean;

Type: boolean

`npmAuthIdent`^Optional

public readonly npmAuthIdent: string;

Type: string

`npmAuthToken`^Optional

public readonly npmAuthToken: string;

Type: string

YarnNpmScope

https://yarnpkg.com/configuration/yarnrc#npmScopes.

Initializer

import { javascript } from 'projen'

const yarnNpmScope: javascript.YarnNpmScope = { ... }

Properties

Name	Type	Description
`npmAlwaysAuth`	`boolean`	No description.
`npmAuthIdent`	`string`	No description.
`npmAuthToken`	`string`	No description.
`npmPublishRegistry`	`string`	No description.
`npmRegistryServer`	`string`	No description.

`npmAlwaysAuth`^Optional

public readonly npmAlwaysAuth: boolean;

Type: boolean

`npmAuthIdent`^Optional

public readonly npmAuthIdent: string;

Type: string

`npmAuthToken`^Optional

public readonly npmAuthToken: string;

Type: string

`npmPublishRegistry`^Optional

public readonly npmPublishRegistry: string;

Type: string

`npmRegistryServer`^Optional

public readonly npmRegistryServer: string;

Type: string

YarnPackageExtension

https://yarnpkg.com/configuration/yarnrc#packageExtensions.

Initializer

import { javascript } from 'projen'

const yarnPackageExtension: javascript.YarnPackageExtension = { ... }

Properties

Name	Type	Description
`dependencies`	`{[ key: string ]: string}`	No description.
`peerDependencies`	`{[ key: string ]: string}`	No description.
`peerDependenciesMeta`	`{[ key: string ]: {[ key: string ]: YarnPeerDependencyMeta}}`	No description.

`dependencies`^Optional

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

Type: {[ key: string ]: string}

`peerDependencies`^Optional

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

Type: {[ key: string ]: string}

`peerDependenciesMeta`^Optional

public readonly peerDependenciesMeta: {[ key: string ]: {[ key: string ]: YarnPeerDependencyMeta}};

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

YarnPeerDependencyMeta

https://yarnpkg.com/configuration/yarnrc#packageExtensions.

Initializer

import { javascript } from 'projen'

const yarnPeerDependencyMeta: javascript.YarnPeerDependencyMeta = { ... }

Properties

Name	Type	Description
`optional`	`boolean`	No description.

`optional`^Optional

public readonly optional: boolean;

Type: boolean

YarnrcOptions

Configuration for .yarnrc.yml in Yarn Berry v4.

Initializer

import { javascript } from 'projen'

const yarnrcOptions: javascript.YarnrcOptions = { ... }

Properties

Name	Type	Description
`cacheFolder`	`string`	https://yarnpkg.com/configuration/yarnrc#cacheFolder.
`cacheMigrationMode`	`YarnCacheMigrationMode`	https://yarnpkg.com/configuration/yarnrc#cacheMigrationMode.
`changesetBaseRefs`	`string[]`	https://yarnpkg.com/configuration/yarnrc#changesetBaseRefs.
`changesetIgnorePatterns`	`string[]`	https://yarnpkg.com/configuration/yarnrc#changesetIgnorePatterns.
`checksumBehavior`	`YarnChecksumBehavior`	https://yarnpkg.com/configuration/yarnrc#checksumBehavior.
`cloneConcurrency`	`number`	https://yarnpkg.com/configuration/yarnrc#cloneConcurrency.
`compressionLevel`	`string \| number`	https://yarnpkg.com/configuration/yarnrc#compressionLevel.
`constraintsPath`	`string`	https://yarnpkg.com/configuration/yarnrc#constraintsPath.
`defaultLanguageName`	`string`	https://yarnpkg.com/configuration/yarnrc#defaultLanguageName.
`defaultProtocol`	`string`	https://yarnpkg.com/configuration/yarnrc#defaultProtocol.
`defaultSemverRangePrefix`	`YarnDefaultSemverRangePrefix`	https://yarnpkg.com/configuration/yarnrc#defaultSemverRangePrefix.
`deferredVersionFolder`	`string`	https://yarnpkg.com/configuration/yarnrc#deferredVersionFolder.
`enableColors`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableColors.
`enableConstraintsCheck`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableConstraintsCheck.
`enableGlobalCache`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableGlobalCache.
`enableHardenedMode`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableHardenedMode.
`enableHyperlinks`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableHyperlinks.
`enableImmutableCache`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableImmutableCache.
`enableImmutableInstalls`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableImmutableInstalls.
`enableInlineBuilds`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableInlineBuilds.
`enableInlineHunks`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableInlineHunks.
`enableMessageNames`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableMessageNames.
`enableMirror`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableMirror.
`enableNetwork`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableNetwork.
`enableOfflineMode`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableOfflineMode.
`enableProgressBars`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableProgressBars.
`enableScripts`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableScripts.
`enableStrictSsl`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableStrictSsl.
`enableTelemetry`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableTelemetry.
`enableTimers`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableTimers.
`enableTransparentWorkspaces`	`boolean`	https://yarnpkg.com/configuration/yarnrc#enableTransparentWorkspaces.
`globalFolder`	`string`	https://yarnpkg.com/configuration/yarnrc#globalFolder.
`httpProxy`	`string`	https://yarnpkg.com/configuration/yarnrc#httpProxy.
`httpRetry`	`number`	https://yarnpkg.com/configuration/yarnrc#httpRetry.
`httpsCaFilePath`	`string`	https://yarnpkg.com/configuration/yarnrc#httpsCaFilePath.
`httpsCertFilePath`	`string`	https://yarnpkg.com/configuration/yarnrc#httpsCertFilePath.
`httpsKeyFilePath`	`string`	https://yarnpkg.com/configuration/yarnrc#httpsKeyFilePath.
`httpsProxy`	`string`	https://yarnpkg.com/configuration/yarnrc#httpsProxy.
`httpTimeout`	`number`	https://yarnpkg.com/configuration/yarnrc#httpTimeout.
`ignoreCwd`	`boolean`	https://v3.yarnpkg.com/configuration/yarnrc#ignoreCwd.
`ignorePath`	`boolean`	https://yarnpkg.com/configuration/yarnrc#ignorePath.
`immutablePatterns`	`string[]`	https://yarnpkg.com/configuration/yarnrc#immutablePatterns.
`initFields`	`{[ key: string ]: any}`	https://yarnpkg.com/configuration/yarnrc#initFields.
`initScope`	`string`	https://yarnpkg.com/configuration/yarnrc#initScope.
`injectEnvironmentFiles`	`string[]`	https://yarnpkg.com/configuration/yarnrc#injectEnvironmentFiles.
`installStatePath`	`string`	https://yarnpkg.com/configuration/yarnrc#installStatePath.
`lockfileFilename`	`string`	https://v3.yarnpkg.com/configuration/yarnrc#lockfileFilename.
`logFilters`	`YarnLogFilter[]`	https://yarnpkg.com/configuration/yarnrc#logFilters.
`networkConcurrency`	`number`	https://yarnpkg.com/configuration/yarnrc#networkConcurrency.
`networkSettings`	`{[ key: string ]: YarnNetworkSetting}`	https://yarnpkg.com/configuration/yarnrc#networkSettings.
`nmHoistingLimits`	`YarnNmHoistingLimit`	https://yarnpkg.com/configuration/yarnrc#nmHoistingLimits.
`nmMode`	`YarnNmMode`	https://yarnpkg.com/configuration/yarnrc#nmMode.
`nmSelfReferences`	`boolean`	https://yarnpkg.com/configuration/yarnrc#nmSelfReferences.
`nodeLinker`	`YarnNodeLinker`	https://yarnpkg.com/configuration/yarnrc#nodeLinker.
`npmAlwaysAuth`	`boolean`	https://yarnpkg.com/configuration/yarnrc#npmAlwaysAuth.
`npmAuditExcludePackages`	`string[]`	https://yarnpkg.com/configuration/yarnrc#npmAuditExcludePackages.
`npmAuditIgnoreAdvisories`	`string[]`	https://yarnpkg.com/configuration/yarnrc#npmAuditIgnoreAdvisories.
`npmAuditRegistry`	`string`	https://yarnpkg.com/configuration/yarnrc#npmAuditRegistry.
`npmAuthIdent`	`string`	https://yarnpkg.com/configuration/yarnrc#npmAuthIdent.
`npmAuthToken`	`string`	https://yarnpkg.com/configuration/yarnrc#npmAuthToken.
`npmPublishAccess`	`YarnNpmPublishAccess`	https://yarnpkg.com/configuration/yarnrc#npmPublishAccess.
`npmPublishRegistry`	`string`	https://yarnpkg.com/configuration/yarnrc#npmPublishRegistry.
`npmRegistries`	`{[ key: string ]: YarnNpmRegistry}`	https://yarnpkg.com/configuration/yarnrc#npmRegistries.
`npmRegistryServer`	`string`	https://yarnpkg.com/configuration/yarnrc#npmRegistryServer.
`npmScopes`	`{[ key: string ]: YarnNpmScope}`	https://yarnpkg.com/configuration/yarnrc#npmScopes.
`packageExtensions`	`{[ key: string ]: YarnPackageExtension}`	https://yarnpkg.com/configuration/yarnrc#packageExtensions.
`patchFolder`	`string`	https://yarnpkg.com/configuration/yarnrc#patchFolder.
`pnpDataPath`	`string`	https://v3.yarnpkg.com/configuration/yarnrc#pnpDataPath.
`pnpEnableEsmLoader`	`boolean`	https://yarnpkg.com/configuration/yarnrc#pnpEnableEsmLoader.
`pnpEnableInlining`	`boolean`	https://yarnpkg.com/configuration/yarnrc#pnpEnableInlining.
`pnpFallbackMode`	`YarnPnpFallbackMode`	https://yarnpkg.com/configuration/yarnrc#pnpFallbackMode.
`pnpIgnorePatterns`	`string[]`	https://yarnpkg.com/configuration/yarnrc#pnpIgnorePatterns.
`pnpMode`	`YarnPnpMode`	https://yarnpkg.com/configuration/yarnrc#pnpMode.
`pnpShebang`	`string`	https://yarnpkg.com/configuration/yarnrc#pnpShebang.
`pnpUnpluggedFolder`	`string`	https://yarnpkg.com/configuration/yarnrc#pnpUnpluggedFolder.
`preferAggregateCacheInfo`	`boolean`	https://v3.yarnpkg.com/configuration/yarnrc#preferAggregateCacheInfo.
`preferDeferredVersions`	`boolean`	https://yarnpkg.com/configuration/yarnrc#preferDeferredVersions.
`preferInteractive`	`boolean`	https://yarnpkg.com/configuration/yarnrc#preferInteractive.
`preferReuse`	`boolean`	https://yarnpkg.com/configuration/yarnrc#preferReuse.
`preferTruncatedLines`	`boolean`	https://yarnpkg.com/configuration/yarnrc#preferTruncatedLines.
`progressBarStyle`	`YarnProgressBarStyle`	https://yarnpkg.com/configuration/yarnrc#progressBarStyle.
`rcFilename`	`string`	https://yarnpkg.com/configuration/yarnrc#rcFilename.
`supportedArchitectures`	`YarnSupportedArchitectures`	https://yarnpkg.com/configuration/yarnrc#supportedArchitectures.
`taskPoolConcurrency`	`string`	https://yarnpkg.com/configuration/yarnrc#taskPoolConcurrency.
`telemetryInterval`	`number`	https://yarnpkg.com/configuration/yarnrc#telemetryInterval.
`telemetryUserId`	`string`	https://yarnpkg.com/configuration/yarnrc#telemetryUserId.
`tsEnableAutoTypes`	`boolean`	https://yarnpkg.com/configuration/yarnrc#tsEnableAutoTypes.
`unsafeHttpWhitelist`	`string[]`	https://yarnpkg.com/configuration/yarnrc#unsafeHttpWhitelist.
`virtualFolder`	`string`	https://yarnpkg.com/configuration/yarnrc#virtualFolder.
`winLinkType`	`YarnWinLinkType`	https://yarnpkg.com/configuration/yarnrc#winLinkType.
`workerPoolMode`	`YarnWorkerPoolMode`	https://yarnpkg.com/configuration/yarnrc#workerPoolMode.
`yarnPath`	`string`	https://yarnpkg.com/configuration/yarnrc#yarnPath.

`cacheFolder`^Optional

public readonly cacheFolder: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#cacheFolder.

`cacheMigrationMode`^Optional

public readonly cacheMigrationMode: YarnCacheMigrationMode;

Type: YarnCacheMigrationMode

https://yarnpkg.com/configuration/yarnrc#cacheMigrationMode.

`changesetBaseRefs`^Optional

public readonly changesetBaseRefs: string[];

Type: string[]

https://yarnpkg.com/configuration/yarnrc#changesetBaseRefs.

`changesetIgnorePatterns`^Optional

public readonly changesetIgnorePatterns: string[];

Type: string[]

https://yarnpkg.com/configuration/yarnrc#changesetIgnorePatterns.

`checksumBehavior`^Optional

public readonly checksumBehavior: YarnChecksumBehavior;

Type: YarnChecksumBehavior

https://yarnpkg.com/configuration/yarnrc#checksumBehavior.

`cloneConcurrency`^Optional

public readonly cloneConcurrency: number;

Type: number

https://yarnpkg.com/configuration/yarnrc#cloneConcurrency.

`compressionLevel`^Optional

public readonly compressionLevel: string | number;

Type: string | number

https://yarnpkg.com/configuration/yarnrc#compressionLevel.

`constraintsPath`^Optional

public readonly constraintsPath: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#constraintsPath.

`defaultLanguageName`^Optional

public readonly defaultLanguageName: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#defaultLanguageName.

`defaultProtocol`^Optional

public readonly defaultProtocol: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#defaultProtocol.

`defaultSemverRangePrefix`^Optional

public readonly defaultSemverRangePrefix: YarnDefaultSemverRangePrefix;

Type: YarnDefaultSemverRangePrefix

https://yarnpkg.com/configuration/yarnrc#defaultSemverRangePrefix.

`deferredVersionFolder`^Optional

public readonly deferredVersionFolder: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#deferredVersionFolder.

`enableColors`^Optional

public readonly enableColors: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableColors.

`enableConstraintsCheck`^Optional

public readonly enableConstraintsCheck: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableConstraintsCheck.

`enableGlobalCache`^Optional

public readonly enableGlobalCache: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableGlobalCache.

`enableHardenedMode`^Optional

public readonly enableHardenedMode: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableHardenedMode.

`enableHyperlinks`^Optional

public readonly enableHyperlinks: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableHyperlinks.

`enableImmutableCache`^Optional

public readonly enableImmutableCache: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableImmutableCache.

`enableImmutableInstalls`^Optional

public readonly enableImmutableInstalls: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableImmutableInstalls.

`enableInlineBuilds`^Optional

public readonly enableInlineBuilds: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableInlineBuilds.

`enableInlineHunks`^Optional

public readonly enableInlineHunks: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableInlineHunks.

`enableMessageNames`^Optional

public readonly enableMessageNames: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableMessageNames.

`enableMirror`^Optional

public readonly enableMirror: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableMirror.

`enableNetwork`^Optional

public readonly enableNetwork: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableNetwork.

`enableOfflineMode`^Optional

public readonly enableOfflineMode: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableOfflineMode.

`enableProgressBars`^Optional

public readonly enableProgressBars: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableProgressBars.

`enableScripts`^Optional

public readonly enableScripts: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableScripts.

`enableStrictSsl`^Optional

public readonly enableStrictSsl: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableStrictSsl.

`enableTelemetry`^Optional

public readonly enableTelemetry: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableTelemetry.

`enableTimers`^Optional

public readonly enableTimers: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableTimers.

`enableTransparentWorkspaces`^Optional

public readonly enableTransparentWorkspaces: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#enableTransparentWorkspaces.

`globalFolder`^Optional

public readonly globalFolder: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#globalFolder.

`httpProxy`^Optional

public readonly httpProxy: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#httpProxy.

`httpRetry`^Optional

public readonly httpRetry: number;

Type: number

https://yarnpkg.com/configuration/yarnrc#httpRetry.

`httpsCaFilePath`^Optional

public readonly httpsCaFilePath: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#httpsCaFilePath.

`httpsCertFilePath`^Optional

public readonly httpsCertFilePath: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#httpsCertFilePath.

`httpsKeyFilePath`^Optional

public readonly httpsKeyFilePath: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#httpsKeyFilePath.

`httpsProxy`^Optional

public readonly httpsProxy: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#httpsProxy.

`httpTimeout`^Optional

public readonly httpTimeout: number;

Type: number

https://yarnpkg.com/configuration/yarnrc#httpTimeout.

`ignoreCwd`^Optional

Deprecated: - removed in Yarn v4 and newer

public readonly ignoreCwd: boolean;

Type: boolean

https://v3.yarnpkg.com/configuration/yarnrc#ignoreCwd.

`ignorePath`^Optional

public readonly ignorePath: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#ignorePath.

`immutablePatterns`^Optional

public readonly immutablePatterns: string[];

Type: string[]

https://yarnpkg.com/configuration/yarnrc#immutablePatterns.

`initFields`^Optional

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

Type: {[ key: string ]: any}

https://yarnpkg.com/configuration/yarnrc#initFields.

`initScope`^Optional

public readonly initScope: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#initScope.

`injectEnvironmentFiles`^Optional

public readonly injectEnvironmentFiles: string[];

Type: string[]

https://yarnpkg.com/configuration/yarnrc#injectEnvironmentFiles.

`installStatePath`^Optional

public readonly installStatePath: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#installStatePath.

`lockfileFilename`^Optional

Deprecated: - removed in Yarn v4 and newer

public readonly lockfileFilename: string;

Type: string

https://v3.yarnpkg.com/configuration/yarnrc#lockfileFilename.

`logFilters`^Optional

public readonly logFilters: YarnLogFilter[];

Type: YarnLogFilter[]

https://yarnpkg.com/configuration/yarnrc#logFilters.

`networkConcurrency`^Optional

public readonly networkConcurrency: number;

Type: number

https://yarnpkg.com/configuration/yarnrc#networkConcurrency.

`networkSettings`^Optional

public readonly networkSettings: {[ key: string ]: YarnNetworkSetting};

Type: {[ key: string ]: YarnNetworkSetting}

https://yarnpkg.com/configuration/yarnrc#networkSettings.

`nmHoistingLimits`^Optional

public readonly nmHoistingLimits: YarnNmHoistingLimit;

Type: YarnNmHoistingLimit

https://yarnpkg.com/configuration/yarnrc#nmHoistingLimits.

`nmMode`^Optional

public readonly nmMode: YarnNmMode;

Type: YarnNmMode

https://yarnpkg.com/configuration/yarnrc#nmMode.

`nmSelfReferences`^Optional

public readonly nmSelfReferences: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#nmSelfReferences.

`nodeLinker`^Optional

public readonly nodeLinker: YarnNodeLinker;

Type: YarnNodeLinker

https://yarnpkg.com/configuration/yarnrc#nodeLinker.

`npmAlwaysAuth`^Optional

public readonly npmAlwaysAuth: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#npmAlwaysAuth.

`npmAuditExcludePackages`^Optional

public readonly npmAuditExcludePackages: string[];

Type: string[]

https://yarnpkg.com/configuration/yarnrc#npmAuditExcludePackages.

`npmAuditIgnoreAdvisories`^Optional

public readonly npmAuditIgnoreAdvisories: string[];

Type: string[]

https://yarnpkg.com/configuration/yarnrc#npmAuditIgnoreAdvisories.

`npmAuditRegistry`^Optional

public readonly npmAuditRegistry: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#npmAuditRegistry.

`npmAuthIdent`^Optional

public readonly npmAuthIdent: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#npmAuthIdent.

`npmAuthToken`^Optional

public readonly npmAuthToken: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#npmAuthToken.

`npmPublishAccess`^Optional

public readonly npmPublishAccess: YarnNpmPublishAccess;

Type: YarnNpmPublishAccess

https://yarnpkg.com/configuration/yarnrc#npmPublishAccess.

`npmPublishRegistry`^Optional

public readonly npmPublishRegistry: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#npmPublishRegistry.

`npmRegistries`^Optional

public readonly npmRegistries: {[ key: string ]: YarnNpmRegistry};

Type: {[ key: string ]: YarnNpmRegistry}

https://yarnpkg.com/configuration/yarnrc#npmRegistries.

`npmRegistryServer`^Optional

public readonly npmRegistryServer: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#npmRegistryServer.

`npmScopes`^Optional

public readonly npmScopes: {[ key: string ]: YarnNpmScope};

Type: {[ key: string ]: YarnNpmScope}

https://yarnpkg.com/configuration/yarnrc#npmScopes.

`packageExtensions`^Optional

public readonly packageExtensions: {[ key: string ]: YarnPackageExtension};

Type: {[ key: string ]: YarnPackageExtension}

https://yarnpkg.com/configuration/yarnrc#packageExtensions.

`patchFolder`^Optional

public readonly patchFolder: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#patchFolder.

`pnpDataPath`^Optional

Deprecated: - removed in Yarn v4 and newer

public readonly pnpDataPath: string;

Type: string

https://v3.yarnpkg.com/configuration/yarnrc#pnpDataPath.

`pnpEnableEsmLoader`^Optional

public readonly pnpEnableEsmLoader: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#pnpEnableEsmLoader.

`pnpEnableInlining`^Optional

public readonly pnpEnableInlining: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#pnpEnableInlining.

`pnpFallbackMode`^Optional

public readonly pnpFallbackMode: YarnPnpFallbackMode;

Type: YarnPnpFallbackMode

https://yarnpkg.com/configuration/yarnrc#pnpFallbackMode.

`pnpIgnorePatterns`^Optional

public readonly pnpIgnorePatterns: string[];

Type: string[]

https://yarnpkg.com/configuration/yarnrc#pnpIgnorePatterns.

`pnpMode`^Optional

public readonly pnpMode: YarnPnpMode;

Type: YarnPnpMode

https://yarnpkg.com/configuration/yarnrc#pnpMode.

`pnpShebang`^Optional

public readonly pnpShebang: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#pnpShebang.

`pnpUnpluggedFolder`^Optional

public readonly pnpUnpluggedFolder: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#pnpUnpluggedFolder.

`preferAggregateCacheInfo`^Optional

Deprecated: - removed in Yarn v4 and newer

public readonly preferAggregateCacheInfo: boolean;

Type: boolean

https://v3.yarnpkg.com/configuration/yarnrc#preferAggregateCacheInfo.

`preferDeferredVersions`^Optional

public readonly preferDeferredVersions: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#preferDeferredVersions.

`preferInteractive`^Optional

public readonly preferInteractive: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#preferInteractive.

`preferReuse`^Optional

public readonly preferReuse: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#preferReuse.

`preferTruncatedLines`^Optional

public readonly preferTruncatedLines: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#preferTruncatedLines.

`progressBarStyle`^Optional

public readonly progressBarStyle: YarnProgressBarStyle;

Type: YarnProgressBarStyle

https://yarnpkg.com/configuration/yarnrc#progressBarStyle.

`rcFilename`^Optional

public readonly rcFilename: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#rcFilename.

`supportedArchitectures`^Optional

public readonly supportedArchitectures: YarnSupportedArchitectures;

Type: YarnSupportedArchitectures

https://yarnpkg.com/configuration/yarnrc#supportedArchitectures.

`taskPoolConcurrency`^Optional

public readonly taskPoolConcurrency: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#taskPoolConcurrency.

`telemetryInterval`^Optional

public readonly telemetryInterval: number;

Type: number

https://yarnpkg.com/configuration/yarnrc#telemetryInterval.

`telemetryUserId`^Optional

public readonly telemetryUserId: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#telemetryUserId.

`tsEnableAutoTypes`^Optional

public readonly tsEnableAutoTypes: boolean;

Type: boolean

https://yarnpkg.com/configuration/yarnrc#tsEnableAutoTypes.

`unsafeHttpWhitelist`^Optional

public readonly unsafeHttpWhitelist: string[];

Type: string[]

https://yarnpkg.com/configuration/yarnrc#unsafeHttpWhitelist.

`virtualFolder`^Optional

public readonly virtualFolder: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#virtualFolder.

`winLinkType`^Optional

public readonly winLinkType: YarnWinLinkType;

Type: YarnWinLinkType

https://yarnpkg.com/configuration/yarnrc#winLinkType.

`workerPoolMode`^Optional

public readonly workerPoolMode: YarnWorkerPoolMode;

Type: YarnWorkerPoolMode

https://yarnpkg.com/configuration/yarnrc#workerPoolMode.

`yarnPath`^Optional

public readonly yarnPath: string;

Type: string

https://yarnpkg.com/configuration/yarnrc#yarnPath.

YarnSupportedArchitectures

https://yarnpkg.com/configuration/yarnrc#supportedArchitectures.

Initializer

import { javascript } from 'projen'

const yarnSupportedArchitectures: javascript.YarnSupportedArchitectures = { ... }

Properties

Name	Type	Description
`cpu`	`string[]`	No description.
`libc`	`string[]`	No description.
`os`	`string[]`	No description.

`cpu`^Optional

public readonly cpu: string[];

Type: string[]

`libc`^Optional

public readonly libc: string[];

Type: string[]

`os`^Optional

public readonly os: string[];

Type: string[]

Classes

JestReporter

Initializers

import { javascript } from 'projen'

new javascript.JestReporter(name: string, options?: {[ key: string ]: any})

Name	Type	Description
`name`	`string`	No description.
`options`	`{[ key: string ]: any}`	No description.

`name`^Required

Type: string

`options`^Optional

Type: {[ key: string ]: any}

Transform

Initializers

import { javascript } from 'projen'

new javascript.Transform(name: string, options?: any)

Name	Type	Description
`name`	`string`	No description.
`options`	`any`	No description.

`name`^Required

Type: string

`options`^Optional

Type: any

TypescriptConfigExtends

Container for TypescriptConfig tsconfig.json base configuration(s). Extending from more than one base config file requires TypeScript 5.0+.

Methods

Name	Description
`toJSON`	No description.

`toJSON`

public toJSON(): string[]

Static Functions

Name	Description
`fromPaths`	Factory for creation from array of file paths.
`fromTypescriptConfigs`	Factory for creation from array of other `TypescriptConfig` instances.

`fromPaths`

import { javascript } from 'projen'

javascript.TypescriptConfigExtends.fromPaths(paths: string[])

Factory for creation from array of file paths.

`paths`^Required

Type: string[]

Absolute or relative paths to base tsconfig.json files.

`fromTypescriptConfigs`

import { javascript } from 'projen'

javascript.TypescriptConfigExtends.fromTypescriptConfigs(configs: TypescriptConfig[])

Factory for creation from array of other TypescriptConfig instances.

`configs`^Required

Type: TypescriptConfig[]

Base TypescriptConfig instances.

UpgradeDependenciesSchedule

How often to check for new versions and raise pull requests for version upgrades.

Static Functions

Name	Description
`expressions`	Create a schedule from a raw cron expression.

`expressions`

import { javascript } from 'projen'

javascript.UpgradeDependenciesSchedule.expressions(cron: string[])

Create a schedule from a raw cron expression.

`cron`^Required

Type: string[]

Properties

Name	Type	Description
`cron`	`string[]`	No description.

`cron`^Required

public readonly cron: string[];

Type: string[]

Constants

Name	Type	Description
`DAILY`	`UpgradeDependenciesSchedule`	At 00:00.
`MONTHLY`	`UpgradeDependenciesSchedule`	At 00:00 on day-of-month 1.
`NEVER`	`UpgradeDependenciesSchedule`	Disables automatic upgrades.
`WEEKDAY`	`UpgradeDependenciesSchedule`	At 00:00 on every day-of-week from Monday through Friday.
`WEEKLY`	`UpgradeDependenciesSchedule`	At 00:00 on Monday.

`DAILY`^Required

public readonly DAILY: UpgradeDependenciesSchedule;

Type: UpgradeDependenciesSchedule

At 00:00.

`MONTHLY`^Required

public readonly MONTHLY: UpgradeDependenciesSchedule;

Type: UpgradeDependenciesSchedule

At 00:00 on day-of-month 1.

`NEVER`^Required

public readonly NEVER: UpgradeDependenciesSchedule;

Type: UpgradeDependenciesSchedule

Disables automatic upgrades.

`WEEKDAY`^Required

public readonly WEEKDAY: UpgradeDependenciesSchedule;

Type: UpgradeDependenciesSchedule

At 00:00 on every day-of-week from Monday through Friday.

`WEEKLY`^Required

public readonly WEEKLY: UpgradeDependenciesSchedule;

Type: UpgradeDependenciesSchedule

At 00:00 on Monday.

WatchPlugin

Initializers

import { javascript } from 'projen'

new javascript.WatchPlugin(name: string, options?: any)

Name	Type	Description
`name`	`string`	No description.
`options`	`any`	No description.

`name`^Required

Type: string

`options`^Optional

Type: any

Enums

ArrowParens

Members

Name	Description
`ALWAYS`	Always include parens.
`AVOID`	Omit parens when possible.

`ALWAYS`

Always include parens.

Example: (x) => x

`AVOID`

Omit parens when possible.

Example: x => x

AutoRelease

Automatic bump modes.

Members

Name	Description
`EVERY_COMMIT`	Automatically bump & release a new version for every commit to "main".
`DAILY`	Automatically bump & release a new version on a daily basis.

`EVERY_COMMIT`

Automatically bump & release a new version for every commit to "main".

`DAILY`

Automatically bump & release a new version on a daily basis.

BundleLogLevel

Log levels for esbuild and package managers' install commands.

Members

Name	Description
`VERBOSE`	Show everything.
`DEBUG`	Show everything from info and some additional messages for debugging.
`INFO`	Show warnings, errors, and an output file summary.
`WARNING`	Show warnings and errors.
`ERROR`	Show errors only.
`SILENT`	Show nothing.

`VERBOSE`

Show everything.

`DEBUG`

Show everything from info and some additional messages for debugging.

`INFO`

Show warnings, errors, and an output file summary.

`WARNING`

Show warnings and errors.

`ERROR`

Show errors only.

`SILENT`

Show nothing.

Charset

Charset for esbuild's output.

Members

Name	Description
`ASCII`	ASCII.
`UTF8`	UTF-8.

`ASCII`

ASCII.

Any non-ASCII characters are escaped using backslash escape sequences

`UTF8`

UTF-8.

Keep original characters without using escape sequences

CodeArtifactAuthProvider

Options for authorizing requests to a AWS CodeArtifact npm repository.

Members

Name	Description
`ACCESS_AND_SECRET_KEY_PAIR`	Fixed credentials provided via Github secrets.
`GITHUB_OIDC`	Ephemeral credentials provided via Github's OIDC integration with an IAM role.

`ACCESS_AND_SECRET_KEY_PAIR`

Fixed credentials provided via Github secrets.

`GITHUB_OIDC`

Ephemeral credentials provided via Github's OIDC integration with an IAM role.

See: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services

EmbeddedLanguageFormatting

Members

Name	Description
`AUTO`	Format embedded code if Prettier can automatically identify it.
`OFF`	Never automatically format embedded code.

`AUTO`

Format embedded code if Prettier can automatically identify it.

`OFF`

Never automatically format embedded code.

EndOfLine

Members

Name	Description
`AUTO`	Maintain existing (mixed values within one file are normalised by looking at what's used after the first line).
`CR`	Carriage Return character only (\r), used very rarely.
`CRLF`	Carriage Return + Line Feed characters (\r\n), common on Windows.
`LF`	Line Feed only (\n), common on Linux and macOS as well as inside git repos.

`AUTO`

Maintain existing (mixed values within one file are normalised by looking at what's used after the first line).

`CR`

Carriage Return character only (\r), used very rarely.

`CRLF`

Carriage Return + Line Feed characters (\r\n), common on Windows.

`LF`

Line Feed only (\n), common on Linux and macOS as well as inside git repos.

HTMLWhitespaceSensitivity

Members

Name	Description
`CSS`	Respect the default value of CSS display property.
`IGNORE`	Whitespaces are considered insignificant.
`STRICT`	Whitespaces are considered significant.

`CSS`

Respect the default value of CSS display property.

`IGNORE`

Whitespaces are considered insignificant.

`STRICT`

Whitespaces are considered significant.

NodePackageManager

The node package manager to use.

Members

Name	Description
`YARN`	Use `yarn` as the package manager.
`YARN2`	Use `yarn` versions >= 2 as the package manager.
`YARN_CLASSIC`	Use `yarn` 1.x as the package manager.
`YARN_BERRY`	Use `yarn` versions >= 2 as the package manager.
`NPM`	Use `npm` as the package manager.
`PNPM`	Use `pnpm` as the package manager.
`BUN`	Use `bun` as the package manager.

`YARN`

Deprecated: For yarn 1.x use YARN_CLASSIC for yarn >= 2 use YARN_BERRY. Currently, NodePackageManager.YARN means YARN_CLASSIC. In the future, we might repurpose it to mean YARN_BERRY.

Use yarn as the package manager.

`YARN2`

Deprecated: use YARN_BERRY instead

Use yarn versions >= 2 as the package manager.

`YARN_CLASSIC`

Use yarn 1.x as the package manager.

`YARN_BERRY`

Use yarn versions >= 2 as the package manager.

`NPM`

Use npm as the package manager.

`PNPM`

Use pnpm as the package manager.

`BUN`

Use bun as the package manager.

NpmAccess

Npm package access level.

Members

Name	Description
`PUBLIC`	Package is public.
`RESTRICTED`	Package can only be accessed with credentials.

`PUBLIC`

Package is public.

`RESTRICTED`

Package can only be accessed with credentials.

ProseWrap

Members

Name	Description
`ALWAYS`	Wrap prose if it exceeds the print width.
`NEVER`	Do not wrap prose.
`PRESERVE`	Wrap prose as-is.

`ALWAYS`

Wrap prose if it exceeds the print width.

`NEVER`

Do not wrap prose.

`PRESERVE`

Wrap prose as-is.

QuoteProps

Members

Name	Description
`ASNEEDED`	Only add quotes around object properties where required.
`CONSISTENT`	If at least one property in an object requires quotes, quote all properties.
`PRESERVE`	Respect the input use of quotes in object properties.

`ASNEEDED`

Only add quotes around object properties where required.

`CONSISTENT`

If at least one property in an object requires quotes, quote all properties.

`PRESERVE`

Respect the input use of quotes in object properties.

RunBundleTask

Options for BundlerOptions.runBundleTask.

Members

Name	Description
`MANUAL`	Don't bundle automatically as part of the build.
`PRE_COMPILE`	Bundle automatically before compilation.
`POST_COMPILE`	Bundle automatically after compilation. This is useful if you want to bundle the compiled results.

`MANUAL`

Don't bundle automatically as part of the build.

`PRE_COMPILE`

Bundle automatically before compilation.

`POST_COMPILE`

Bundle automatically after compilation. This is useful if you want to bundle the compiled results.

Thus will run compilation tasks (using tsc, etc.) before running file through bundling step.

This is only required unless you are using new experimental features that are not supported by esbuild but are supported by typescript's tsc compiler. One example of such feature is emitDecoratorMetadata.

// In a TypeScript project with output configured
// to go to the "lib" directory:
const project = new TypeScriptProject({
  name: "test",
  defaultReleaseBranch: "main",
  tsconfig: {
    compilerOptions: {
      outDir: "lib",
    },
  },
  bundlerOptions: {
    // ensure we compile with `tsc` before bundling
    runBundleTask: RunBundleTask.POST_COMPILE,
  },
});

// Tell the bundler to bundle the compiled results (from the "lib" directory)
project.bundler.addBundle("./lib/index.js", {
  platform: "node",
  target: "node22",
  sourcemap: false,
  format: "esm",
});

SourceMapMode

SourceMap mode for esbuild.

https://esbuild.github.io/api/#sourcemap

Members

Name	Description
`DEFAULT`	Default sourceMap mode - will generate a .js.map file alongside any generated .js file and add a special //# sourceMappingURL= comment to the bottom of the .js file pointing to the .js.map file.
`EXTERNAL`	External sourceMap mode - If you want to omit the special //# sourceMappingURL= comment from the generated .js file but you still want to generate the .js.map files.
`INLINE`	Inline sourceMap mode - If you want to insert the entire source map into the .js file instead of generating a separate .js.map file.
`BOTH`	Both sourceMap mode - If you want to have the effect of both inline and external simultaneously.

`DEFAULT`

Default sourceMap mode - will generate a .js.map file alongside any generated .js file and add a special //# sourceMappingURL= comment to the bottom of the .js file pointing to the .js.map file.

`EXTERNAL`

External sourceMap mode - If you want to omit the special //# sourceMappingURL= comment from the generated .js file but you still want to generate the .js.map files.

`INLINE`

Inline sourceMap mode - If you want to insert the entire source map into the .js file instead of generating a separate .js.map file.

`BOTH`

Both sourceMap mode - If you want to have the effect of both inline and external simultaneously.

TrailingComma

Members

Name	Description
`ALL`	Trailing commas wherever possible (including function arguments).
`ES5`	Trailing commas where valid in ES5 (objects, arrays, etc.).
`NONE`	No trailing commas.

`ALL`

Trailing commas wherever possible (including function arguments).

`ES5`

Trailing commas where valid in ES5 (objects, arrays, etc.).

`NONE`

No trailing commas.

TypeScriptImportsNotUsedAsValues

This flag controls how import works, there are 3 different options.

https://www.typescriptlang.org/tsconfig#importsNotUsedAsValues

Members

Name	Description
`REMOVE`	The default behavior of dropping `import` statements which only reference types.
`PRESERVE`	Preserves all `import` statements whose values or types are never used.
`ERROR`	This preserves all imports (the same as the preserve option), but will error when a value import is only used as a type.

`REMOVE`

The default behavior of dropping import statements which only reference types.

`PRESERVE`

Preserves all import statements whose values or types are never used.

This can cause imports/side-effects to be preserved.

`ERROR`

This preserves all imports (the same as the preserve option), but will error when a value import is only used as a type.

This might be useful if you want to ensure no values are being accidentally imported, but still make side-effect imports explicit.

TypeScriptJsxMode

Determines how JSX should get transformed into valid JavaScript.

https://www.typescriptlang.org/docs/handbook/jsx.html

Members

Name	Description
`PRESERVE`	Keeps the JSX as part of the output to be further consumed by another transform step (e.g. Babel).
`REACT`	Converts JSX syntax into React.createElement, does not need to go through a JSX transformation before use, and the output will have a .js file extension.
`REACT_NATIVE`	Keeps all JSX like 'preserve' mode, but output will have a .js extension.
`REACT_JSX`	Passes `key` separately from props and always passes `children` as props (since React 17).
`REACT_JSXDEV`	Same as `REACT_JSX` with additional debug data.

`PRESERVE`

Keeps the JSX as part of the output to be further consumed by another transform step (e.g. Babel).

`REACT`

Converts JSX syntax into React.createElement, does not need to go through a JSX transformation before use, and the output will have a .js file extension.

`REACT_NATIVE`

Keeps all JSX like 'preserve' mode, but output will have a .js extension.

`REACT_JSX`

Passes key separately from props and always passes children as props (since React 17).

https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-1.html#react-17-jsx-factories

`REACT_JSXDEV`

Same as REACT_JSX with additional debug data.

TypeScriptModuleDetection

This setting controls how TypeScript determines whether a file is a script or a module.

https://www.typescriptlang.org/docs/handbook/modules/theory.html#scripts-and-modules-in-javascript

Members

Name	Description
`AUTO`	TypeScript will not only look for import and export statements, but it will also check whether the "type" field in a package.json is set to "module" when running with module: nodenext or node16, and check whether the current file is a JSX file when running under jsx: react-jsx.
`LEGACY`	The same behavior as 4.6 and prior, usings import and export statements to determine whether a file is a module.
`FORCE`	Ensures that every non-declaration file is treated as a module.

`AUTO`

TypeScript will not only look for import and export statements, but it will also check whether the "type" field in a package.json is set to "module" when running with module: nodenext or node16, and check whether the current file is a JSX file when running under jsx: react-jsx.

https://www.typescriptlang.org/tsconfig/#moduleDetection

`LEGACY`

The same behavior as 4.6 and prior, usings import and export statements to determine whether a file is a module.

https://www.typescriptlang.org/tsconfig/#moduleDetection

`FORCE`

Ensures that every non-declaration file is treated as a module.

https://www.typescriptlang.org/tsconfig/#moduleDetection

TypeScriptModuleResolution

Determines how modules get resolved.

https://www.typescriptlang.org/docs/handbook/module-resolution.html

Members

Name	Description
`CLASSIC`	TypeScript's former default resolution strategy.
`NODE`	Resolution strategy which attempts to mimic the Node.js module resolution strategy at runtime.
`NODE10`	`--moduleResolution node` was renamed to `node10` (keeping `node` as an alias for backward compatibility) in TypeScript 5.0. It reflects the CommonJS module resolution algorithm as it existed in Node.js versions earlier than v12. It should no longer be used.
`NODE16`	Node.js’ ECMAScript Module Support from TypeScript 4.7 onwards.
`NODE_NEXT`	Node.js’ ECMAScript Module Support from TypeScript 4.7 onwards.
`BUNDLER`	Resolution strategy which attempts to mimic resolution patterns of modern bundlers;

`CLASSIC`

TypeScript's former default resolution strategy.

https://www.typescriptlang.org/docs/handbook/module-resolution.html#classic

`NODE`

Resolution strategy which attempts to mimic the Node.js module resolution strategy at runtime.

https://www.typescriptlang.org/docs/handbook/module-resolution.html#node

`NODE10`

--moduleResolution node was renamed to node10 (keeping node as an alias for backward compatibility) in TypeScript 5.0. It reflects the CommonJS module resolution algorithm as it existed in Node.js versions earlier than v12. It should no longer be used.

https://www.typescriptlang.org/docs/handbook/modules/reference.html#node10-formerly-known-as-node

`NODE16`

Node.js’ ECMAScript Module Support from TypeScript 4.7 onwards.

https://www.typescriptlang.org/tsconfig#moduleResolution

`NODE_NEXT`

Node.js’ ECMAScript Module Support from TypeScript 4.7 onwards.

https://www.typescriptlang.org/tsconfig#moduleResolution

`BUNDLER`

Resolution strategy which attempts to mimic resolution patterns of modern bundlers;

from TypeScript 5.0 onwards.

https://www.typescriptlang.org/tsconfig#moduleResolution

UpdateSnapshot

Members

Name	Description
`ALWAYS`	Always update snapshots in "test" task.
`NEVER`	Never update snapshots in "test" task and create a separate "test:update" task.

`ALWAYS`

Always update snapshots in "test" task.

`NEVER`

Never update snapshots in "test" task and create a separate "test:update" task.

YarnCacheMigrationMode

https://yarnpkg.com/configuration/yarnrc#cacheMigrationMode.

Members

Name	Description
`REQUIRED_ONLY`	No description.
`MATCH_SPEC`	No description.
`ALWAYS`	No description.

`REQUIRED_ONLY`

`MATCH_SPEC`

`ALWAYS`

YarnChecksumBehavior

https://yarnpkg.com/configuration/yarnrc#checksumBehavior.

Members

Name	Description
`THROW`	No description.
`UPDATE`	No description.
`RESET`	No description.
`IGNORE`	No description.

`THROW`

`UPDATE`

`RESET`

`IGNORE`

YarnDefaultSemverRangePrefix

https://yarnpkg.com/configuration/yarnrc#defaultSemverRangePrefix.

Members

Name	Description
`CARET`	No description.
`TILDE`	No description.
`EMPTY_STRING`	No description.

`CARET`

`TILDE`

`EMPTY_STRING`

YarnLogFilterLevel

https://v3.yarnpkg.com/configuration/yarnrc#logFilters.0.level.

Members

Name	Description
`INFO`	No description.
`WARNING`	No description.
`ERROR`	No description.
`DISCARD`	No description.

`INFO`

`WARNING`

`ERROR`

`DISCARD`

YarnNmHoistingLimit

https://yarnpkg.com/configuration/yarnrc#nmHoistingLimits.

Members

Name	Description
`DEPENDENCIES`	No description.
`NONE`	No description.
`WORKSPACES`	No description.

`DEPENDENCIES`

`NONE`

`WORKSPACES`

YarnNmMode

https://yarnpkg.com/configuration/yarnrc#nmMode.

Members

Name	Description
`CLASSIC`	No description.
`HARDLINKS_LOCAL`	No description.
`HARDLINKS_GLOBAL`	No description.

`CLASSIC`

`HARDLINKS_LOCAL`

`HARDLINKS_GLOBAL`

YarnNodeLinker

https://yarnpkg.com/configuration/yarnrc#nodeLinker.

Members

Name	Description
`PNP`	No description.
`PNPM`	No description.
`NODE_MODULES`	No description.

`PNP`

`PNPM`

`NODE_MODULES`

YarnNpmPublishAccess

https://yarnpkg.com/configuration/yarnrc#npmPublishAccess.

Members

Name	Description
`PUBLIC`	No description.
`RESTRICTED`	No description.

`PUBLIC`

`RESTRICTED`

YarnPnpFallbackMode

https://yarnpkg.com/configuration/yarnrc#pnpFallbackMode.

Members

Name	Description
`NONE`	No description.
`DEPENDENCIES_ONLY`	No description.
`ALL`	No description.

`NONE`

`DEPENDENCIES_ONLY`

`ALL`

YarnPnpMode

https://yarnpkg.com/configuration/yarnrc#pnpMode.

Members

Name	Description
`STRICT`	No description.
`LOOSE`	No description.

`STRICT`

`LOOSE`

YarnProgressBarStyle

https://yarnpkg.com/configuration/yarnrc#progressBarStyle.

Members

Name	Description
`PATRICK`	No description.
`SIMBA`	No description.
`JACK`	No description.
`HOGSFATHER`	No description.
`DEFAULT`	No description.

`PATRICK`

`SIMBA`

`JACK`

`HOGSFATHER`

`DEFAULT`

YarnWinLinkType

https://yarnpkg.com/configuration/yarnrc#winLinkType.

Members

Name	Description
`JUNCTIONS`	No description.
`SYMLINKS`	No description.

`JUNCTIONS`

`SYMLINKS`

YarnWorkerPoolMode

Members

Name	Description
`ASYNC`	No description.
`WORKERS`	No description.

Constructs ​

Biome ​

Initializers ​

projectRequired ​

optionsOptional ​

Methods ​

toString ​

postSynthesize ​

preSynthesize ​

synthesize ​

addFilePattern ​

patternRequired ​

Static Functions ​

isConstruct ​

xRequired ​

isComponent ​

xRequired ​

of ​

projectRequired ​

Properties ​

nodeRequired ​

projectRequired ​

fileRequired ​

taskRequired ​

Bundler ​

Initializers ​

projectRequired ​

optionsOptional ​

Methods ​

toString ​

postSynthesize ​

preSynthesize ​

synthesize ​

addBundle ​

entrypointRequired ​

optionsRequired ​

Static Functions ​

isConstruct ​

xRequired ​

isComponent ​

xRequired ​

of ​

projectRequired ​

Properties ​

nodeRequired ​

projectRequired ​

bundledirRequired ​

bundleTaskRequired ​

esbuildVersionOptional ​

Eslint ​

Initializers ​

projectRequired ​

optionsRequired ​

Methods ​

toString ​

postSynthesize ​

preSynthesize ​

synthesize ​

addExtends ​

extendListRequired ​

addIgnorePattern ​

patternRequired ​

addLintPattern ​

patternRequired ​

addOverride ​

overrideRequired ​

addPlugins ​

pluginsRequired ​

addRules ​

rulesRequired ​

allowDevDeps ​

patternRequired ​

Static Functions ​

isConstruct ​

xRequired ​

isComponent ​

xRequired ​

of ​

projectRequired ​

Properties ​

Constructs

Biome

Initializers

`project`^Required

`options`^Optional

Methods

`toString`

`postSynthesize`

`preSynthesize`

`synthesize`

`addFilePattern`

`pattern`^Required

Static Functions

`isConstruct`

`x`^Required

`isComponent`

`x`^Required

`of`

`project`^Required

Properties

`node`^Required

`project`^Required

`file`^Required

`task`^Required

Bundler

Initializers

`project`^Required

`options`^Optional

Methods

`toString`

`postSynthesize`

`preSynthesize`

`synthesize`

`addBundle`

`entrypoint`^Required

`options`^Required

Static Functions

`isConstruct`

`x`^Required

`isComponent`

`x`^Required

`of`

`project`^Required

Properties

`node`^Required

`project`^Required

`bundledir`^Required

`bundleTask`^Required

`esbuildVersion`^Optional

Eslint

Initializers

`project`^Required

`options`^Required

Methods

`toString`

`postSynthesize`

`preSynthesize`

`synthesize`

`addExtends`

`extendList`^Required

`addIgnorePattern`

`pattern`^Required

`addLintPattern`

`pattern`^Required

`addOverride`

`override`^Required

`addPlugins`

`plugins`^Required

`addRules`

`rules`^Required

`allowDevDeps`

`pattern`^Required

Static Functions

`isConstruct`

`x`^Required

`isComponent`

`x`^Required

`of`

`project`^Required

Properties