# API Reference ## Constructs ### CdkConstructLibrary Create a Cdk Construct Library Project. #### Initializers ```typescript import { CdkConstructLibrary } from 'cdklabs-projen-project-types' new CdkConstructLibrary(options: CdkConstructLibraryOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | CdkConstructLibraryOptions | *No description.* | --- ##### `options`^Required - *Type:* CdkConstructLibraryOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to 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. | | addCdkDependencies | Adds dependencies to AWS CDK modules. | | addCdkTestDependencies | Adds AWS CDK modules as dev dependencies. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `addExcludeFromCleanup` ```typescript 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` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(pattern: string): void ``` Adds patterns to be ignored by npm. ###### `pattern`^Required - *Type:* string The pattern to ignore. --- ##### `addTask` ```typescript 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`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript 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](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` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. This will typically be `pnpm projen TASK`. ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all subprojects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript 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`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript 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` ```typescript public addBins(bins: {[ key: string ]: string}): void ``` ###### `bins`^Required - *Type:* {[ key: string ]: string} --- ##### `addBundledDeps` ```typescript 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 `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### ~~`addCompileCommand`~~ ```typescript public addCompileCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### `addDeps` ```typescript public addDeps(deps: ...string[]): void ``` Defines normal dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addDevDeps` ```typescript public addDevDeps(deps: ...string[]): void ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addFields` ```typescript public addFields(fields: {[ key: string ]: any}): void ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* {[ key: string ]: any} The fields to set. --- ##### `addKeywords` ```typescript public addKeywords(keywords: ...string[]): void ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* ...string[] The keywords to add. --- ##### `addPeerDeps` ```typescript public addPeerDeps(deps: ...string[]): void ``` Defines peer dependencies. When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addScripts` ```typescript 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`~~ ```typescript public addTestCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### ~~`hasScript`~~ ```typescript 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` ```typescript public removeScript(name: string): void ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* string The name of the script. --- ##### `renderWorkflowSetup` ```typescript public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[] ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `options`^Optional - *Type:* projen.javascript.RenderWorkflowSetupOptions Options. --- ##### `setScript` ```typescript 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. --- ##### ~~`addCdkDependencies`~~ ```typescript public addCdkDependencies(deps: ...string[]): void ``` Adds dependencies to AWS CDK modules. Since this is a library project, dependencies will be added as peer dependencies. ###### `deps`^Required - *Type:* ...string[] names of cdk modules (e.g. `@aws-cdk/aws-lambda`). --- ##### ~~`addCdkTestDependencies`~~ ```typescript public addCdkTestDependencies(deps: ...string[]): void ``` Adds AWS CDK modules as dev dependencies. ###### `deps`^Required - *Type:* ...string[] names of cdk modules (e.g. `@aws-cdk/aws-lambda`). --- #### 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` ```typescript import { CdkConstructLibrary } from 'cdklabs-projen-project-types' CdkConstructLibrary.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `isProject` ```typescript import { CdkConstructLibrary } from 'cdklabs-projen-project-types' CdkConstructLibrary.isProject(x: any) ``` Test whether the given construct is a project. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { CdkConstructLibrary } from 'cdklabs-projen-project-types' CdkConstructLibrary.of(construct: IConstruct) ``` Find the closest ancestor project for given construct. When given a project, this it the project itself. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | allowLibraryDependencies | boolean | *No description.* | | artifactsDirectory | string | The build output directory. | | artifactsJavascriptDirectory | string | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | projen.javascript.Bundler | *No description.* | | entrypoint | string | *No description.* | | manifest | any | *No description.* | | npmrc | projen.javascript.NpmConfig | The .npmrc file. | | package | projen.javascript.NodePackage | API for managing the node package. | | packageManager | projen.javascript.NodePackageManager | The package manager to use. | | runScriptCommand | string | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | autoMerge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | biome | projen.javascript.Biome | *No description.* | | buildWorkflow | projen.build.BuildWorkflow | The PR build GitHub workflow. | | buildWorkflowJobId | string | The job ID of the build workflow. | | jest | projen.javascript.Jest | The Jest configuration (if enabled). | | maxNodeVersion | string | Maximum node version supported by this package. | | minNodeVersion | string | The minimum node version required by this package to function. | | npmignore | projen.IgnoreFile | The .npmignore file. | | prettier | projen.javascript.Prettier | *No description.* | | publisher | projen.release.Publisher | Package publisher. | | release | projen.release.Release | Release management. | | upgradeWorkflow | projen.javascript.UpgradeDependencies | The upgrade workflow. | | docsDirectory | string | *No description.* | | libdir | string | The directory in which compiled .js files reside. | | srcdir | string | The directory in which the .ts sources reside. | | testdir | string | The directory in which tests reside. | | tsconfigDev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watchTask | projen.Task | The "watch" task. | | docgen | boolean | *No description.* | | eslint | projen.javascript.Eslint | *No description.* | | tsconfig | projen.javascript.TypescriptConfig | *No description.* | | tsconfigEslint | projen.javascript.TypescriptConfig | *No description.* | | cdkDeps | projen.awscdk.AwsCdkDeps | *No description.* | | cdkVersion | string | The target CDK version for this library. | | version | string | *No description.* | | private | boolean | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript 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 ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allowLibraryDependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean --- ##### `artifactsDirectory`^Required ```typescript 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 ```typescript public readonly artifactsJavascriptDirectory: string; ``` - *Type:* string The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```typescript public readonly bundler: Bundler; ``` - *Type:* projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```typescript public readonly entrypoint: string; ``` - *Type:* string --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```typescript public readonly manifest: any; ``` - *Type:* any --- ##### `npmrc`^Required ```typescript public readonly npmrc: NpmConfig; ``` - *Type:* projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```typescript public readonly package: NodePackage; ``` - *Type:* projen.javascript.NodePackage API for managing the node package. --- ##### ~~`packageManager`~~^Required - *Deprecated:* use `package.packageManager` ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager The package manager to use. --- ##### `runScriptCommand`^Required ```typescript 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 ```typescript public readonly autoMerge: AutoMerge; ``` - *Type:* projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `biome`^Optional ```typescript public readonly biome: Biome; ``` - *Type:* projen.javascript.Biome --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: BuildWorkflow; ``` - *Type:* projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `buildWorkflowJobId`^Optional ```typescript public readonly buildWorkflowJobId: string; ``` - *Type:* string The job ID of the build workflow. --- ##### `jest`^Optional ```typescript public readonly jest: Jest; ``` - *Type:* projen.javascript.Jest The Jest configuration (if enabled). --- ##### `maxNodeVersion`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly npmignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```typescript public readonly prettier: Prettier; ``` - *Type:* projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```typescript 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 ```typescript public readonly release: Release; ``` - *Type:* projen.release.Release Release management. --- ##### `upgradeWorkflow`^Optional ```typescript public readonly upgradeWorkflow: UpgradeDependencies; ``` - *Type:* projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docsDirectory`^Required ```typescript public readonly docsDirectory: string; ``` - *Type:* string --- ##### `libdir`^Required ```typescript public readonly libdir: string; ``` - *Type:* string The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```typescript public readonly srcdir: string; ``` - *Type:* string The directory in which the .ts sources reside. --- ##### `testdir`^Required ```typescript public readonly testdir: string; ``` - *Type:* string The directory in which tests reside. --- ##### `tsconfigDev`^Required ```typescript public readonly tsconfigDev: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watchTask`^Required ```typescript public readonly watchTask: Task; ``` - *Type:* projen.Task The "watch" task. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean --- ##### `eslint`^Optional ```typescript public readonly eslint: Eslint; ``` - *Type:* projen.javascript.Eslint --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `tsconfigEslint`^Optional ```typescript public readonly tsconfigEslint: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `cdkDeps`^Required ```typescript public readonly cdkDeps: AwsCdkDeps; ``` - *Type:* projen.awscdk.AwsCdkDeps --- ##### `cdkVersion`^Required ```typescript public readonly cdkVersion: string; ``` - *Type:* string The target CDK version for this library. --- ##### ~~`version`~~^Required - *Deprecated:* use `cdkVersion` ```typescript public readonly version: string; ``` - *Type:* string --- ##### `private`^Required ```typescript public readonly private: boolean; ``` - *Type:* boolean --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | | DEFAULT_TS_JEST_TRANFORM_PATTERN | string | *No description.* | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`^Required ```typescript public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string; ``` - *Type:* string --- ### CdkJsiiProject Create a Cdk Jsii Jsii project. #### Initializers ```typescript import { CdkJsiiProject } from 'cdklabs-projen-project-types' new CdkJsiiProject(options: CdkJsiiProjectOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | CdkJsiiProjectOptions | *No description.* | --- ##### `options`^Required - *Type:* CdkJsiiProjectOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `addExcludeFromCleanup` ```typescript 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` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(pattern: string): void ``` Adds patterns to be ignored by npm. ###### `pattern`^Required - *Type:* string The pattern to ignore. --- ##### `addTask` ```typescript 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`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript 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](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` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. This will typically be `pnpm projen TASK`. ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all subprojects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript 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`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript 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` ```typescript public addBins(bins: {[ key: string ]: string}): void ``` ###### `bins`^Required - *Type:* {[ key: string ]: string} --- ##### `addBundledDeps` ```typescript 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 `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### ~~`addCompileCommand`~~ ```typescript public addCompileCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### `addDeps` ```typescript public addDeps(deps: ...string[]): void ``` Defines normal dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addDevDeps` ```typescript public addDevDeps(deps: ...string[]): void ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addFields` ```typescript public addFields(fields: {[ key: string ]: any}): void ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* {[ key: string ]: any} The fields to set. --- ##### `addKeywords` ```typescript public addKeywords(keywords: ...string[]): void ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* ...string[] The keywords to add. --- ##### `addPeerDeps` ```typescript public addPeerDeps(deps: ...string[]): void ``` Defines peer dependencies. When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addScripts` ```typescript 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`~~ ```typescript public addTestCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### ~~`hasScript`~~ ```typescript 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` ```typescript public removeScript(name: string): void ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* string The name of the script. --- ##### `renderWorkflowSetup` ```typescript public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[] ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `options`^Optional - *Type:* projen.javascript.RenderWorkflowSetupOptions Options. --- ##### `setScript` ```typescript 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` ```typescript import { CdkJsiiProject } from 'cdklabs-projen-project-types' CdkJsiiProject.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `isProject` ```typescript import { CdkJsiiProject } from 'cdklabs-projen-project-types' CdkJsiiProject.isProject(x: any) ``` Test whether the given construct is a project. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { CdkJsiiProject } from 'cdklabs-projen-project-types' CdkJsiiProject.of(construct: IConstruct) ``` Find the closest ancestor project for given construct. When given a project, this it the project itself. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | allowLibraryDependencies | boolean | *No description.* | | artifactsDirectory | string | The build output directory. | | artifactsJavascriptDirectory | string | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | projen.javascript.Bundler | *No description.* | | entrypoint | string | *No description.* | | manifest | any | *No description.* | | npmrc | projen.javascript.NpmConfig | The .npmrc file. | | package | projen.javascript.NodePackage | API for managing the node package. | | packageManager | projen.javascript.NodePackageManager | The package manager to use. | | runScriptCommand | string | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | autoMerge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | biome | projen.javascript.Biome | *No description.* | | buildWorkflow | projen.build.BuildWorkflow | The PR build GitHub workflow. | | buildWorkflowJobId | string | The job ID of the build workflow. | | jest | projen.javascript.Jest | The Jest configuration (if enabled). | | maxNodeVersion | string | Maximum node version supported by this package. | | minNodeVersion | string | The minimum node version required by this package to function. | | npmignore | projen.IgnoreFile | The .npmignore file. | | prettier | projen.javascript.Prettier | *No description.* | | publisher | projen.release.Publisher | Package publisher. | | release | projen.release.Release | Release management. | | upgradeWorkflow | projen.javascript.UpgradeDependencies | The upgrade workflow. | | docsDirectory | string | *No description.* | | libdir | string | The directory in which compiled .js files reside. | | srcdir | string | The directory in which the .ts sources reside. | | testdir | string | The directory in which tests reside. | | tsconfigDev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watchTask | projen.Task | The "watch" task. | | docgen | boolean | *No description.* | | eslint | projen.javascript.Eslint | *No description.* | | tsconfig | projen.javascript.TypescriptConfig | *No description.* | | tsconfigEslint | projen.javascript.TypescriptConfig | *No description.* | | private | boolean | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript 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 ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allowLibraryDependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean --- ##### `artifactsDirectory`^Required ```typescript 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 ```typescript public readonly artifactsJavascriptDirectory: string; ``` - *Type:* string The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```typescript public readonly bundler: Bundler; ``` - *Type:* projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```typescript public readonly entrypoint: string; ``` - *Type:* string --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```typescript public readonly manifest: any; ``` - *Type:* any --- ##### `npmrc`^Required ```typescript public readonly npmrc: NpmConfig; ``` - *Type:* projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```typescript public readonly package: NodePackage; ``` - *Type:* projen.javascript.NodePackage API for managing the node package. --- ##### ~~`packageManager`~~^Required - *Deprecated:* use `package.packageManager` ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager The package manager to use. --- ##### `runScriptCommand`^Required ```typescript 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 ```typescript public readonly autoMerge: AutoMerge; ``` - *Type:* projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `biome`^Optional ```typescript public readonly biome: Biome; ``` - *Type:* projen.javascript.Biome --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: BuildWorkflow; ``` - *Type:* projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `buildWorkflowJobId`^Optional ```typescript public readonly buildWorkflowJobId: string; ``` - *Type:* string The job ID of the build workflow. --- ##### `jest`^Optional ```typescript public readonly jest: Jest; ``` - *Type:* projen.javascript.Jest The Jest configuration (if enabled). --- ##### `maxNodeVersion`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly npmignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```typescript public readonly prettier: Prettier; ``` - *Type:* projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```typescript 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 ```typescript public readonly release: Release; ``` - *Type:* projen.release.Release Release management. --- ##### `upgradeWorkflow`^Optional ```typescript public readonly upgradeWorkflow: UpgradeDependencies; ``` - *Type:* projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docsDirectory`^Required ```typescript public readonly docsDirectory: string; ``` - *Type:* string --- ##### `libdir`^Required ```typescript public readonly libdir: string; ``` - *Type:* string The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```typescript public readonly srcdir: string; ``` - *Type:* string The directory in which the .ts sources reside. --- ##### `testdir`^Required ```typescript public readonly testdir: string; ``` - *Type:* string The directory in which tests reside. --- ##### `tsconfigDev`^Required ```typescript public readonly tsconfigDev: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watchTask`^Required ```typescript public readonly watchTask: Task; ``` - *Type:* projen.Task The "watch" task. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean --- ##### `eslint`^Optional ```typescript public readonly eslint: Eslint; ``` - *Type:* projen.javascript.Eslint --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `tsconfigEslint`^Optional ```typescript public readonly tsconfigEslint: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `private`^Required ```typescript public readonly private: boolean; ``` - *Type:* boolean --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | | DEFAULT_TS_JEST_TRANFORM_PATTERN | string | *No description.* | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`^Required ```typescript public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string; ``` - *Type:* string --- ### CdklabsConstructLibrary Create a Cdklabs Construct Library Project. #### Initializers ```typescript import { CdklabsConstructLibrary } from 'cdklabs-projen-project-types' new CdklabsConstructLibrary(options: CdklabsConstructLibraryOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | CdklabsConstructLibraryOptions | *No description.* | --- ##### `options`^Required - *Type:* CdklabsConstructLibraryOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to 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. | | addCdkDependencies | Adds dependencies to AWS CDK modules. | | addCdkTestDependencies | Adds AWS CDK modules as dev dependencies. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `addExcludeFromCleanup` ```typescript 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` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(pattern: string): void ``` Adds patterns to be ignored by npm. ###### `pattern`^Required - *Type:* string The pattern to ignore. --- ##### `addTask` ```typescript 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`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript 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](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` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. This will typically be `pnpm projen TASK`. ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all subprojects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript 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`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript 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` ```typescript public addBins(bins: {[ key: string ]: string}): void ``` ###### `bins`^Required - *Type:* {[ key: string ]: string} --- ##### `addBundledDeps` ```typescript 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 `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### ~~`addCompileCommand`~~ ```typescript public addCompileCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### `addDeps` ```typescript public addDeps(deps: ...string[]): void ``` Defines normal dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addDevDeps` ```typescript public addDevDeps(deps: ...string[]): void ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addFields` ```typescript public addFields(fields: {[ key: string ]: any}): void ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* {[ key: string ]: any} The fields to set. --- ##### `addKeywords` ```typescript public addKeywords(keywords: ...string[]): void ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* ...string[] The keywords to add. --- ##### `addPeerDeps` ```typescript public addPeerDeps(deps: ...string[]): void ``` Defines peer dependencies. When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addScripts` ```typescript 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`~~ ```typescript public addTestCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### ~~`hasScript`~~ ```typescript 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` ```typescript public removeScript(name: string): void ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* string The name of the script. --- ##### `renderWorkflowSetup` ```typescript public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[] ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `options`^Optional - *Type:* projen.javascript.RenderWorkflowSetupOptions Options. --- ##### `setScript` ```typescript 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. --- ##### ~~`addCdkDependencies`~~ ```typescript public addCdkDependencies(deps: ...string[]): void ``` Adds dependencies to AWS CDK modules. Since this is a library project, dependencies will be added as peer dependencies. ###### `deps`^Required - *Type:* ...string[] names of cdk modules (e.g. `@aws-cdk/aws-lambda`). --- ##### ~~`addCdkTestDependencies`~~ ```typescript public addCdkTestDependencies(deps: ...string[]): void ``` Adds AWS CDK modules as dev dependencies. ###### `deps`^Required - *Type:* ...string[] names of cdk modules (e.g. `@aws-cdk/aws-lambda`). --- #### 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` ```typescript import { CdklabsConstructLibrary } from 'cdklabs-projen-project-types' CdklabsConstructLibrary.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `isProject` ```typescript import { CdklabsConstructLibrary } from 'cdklabs-projen-project-types' CdklabsConstructLibrary.isProject(x: any) ``` Test whether the given construct is a project. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { CdklabsConstructLibrary } from 'cdklabs-projen-project-types' CdklabsConstructLibrary.of(construct: IConstruct) ``` Find the closest ancestor project for given construct. When given a project, this it the project itself. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | allowLibraryDependencies | boolean | *No description.* | | artifactsDirectory | string | The build output directory. | | artifactsJavascriptDirectory | string | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | projen.javascript.Bundler | *No description.* | | entrypoint | string | *No description.* | | manifest | any | *No description.* | | npmrc | projen.javascript.NpmConfig | The .npmrc file. | | package | projen.javascript.NodePackage | API for managing the node package. | | packageManager | projen.javascript.NodePackageManager | The package manager to use. | | runScriptCommand | string | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | autoMerge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | biome | projen.javascript.Biome | *No description.* | | buildWorkflow | projen.build.BuildWorkflow | The PR build GitHub workflow. | | buildWorkflowJobId | string | The job ID of the build workflow. | | jest | projen.javascript.Jest | The Jest configuration (if enabled). | | maxNodeVersion | string | Maximum node version supported by this package. | | minNodeVersion | string | The minimum node version required by this package to function. | | npmignore | projen.IgnoreFile | The .npmignore file. | | prettier | projen.javascript.Prettier | *No description.* | | publisher | projen.release.Publisher | Package publisher. | | release | projen.release.Release | Release management. | | upgradeWorkflow | projen.javascript.UpgradeDependencies | The upgrade workflow. | | docsDirectory | string | *No description.* | | libdir | string | The directory in which compiled .js files reside. | | srcdir | string | The directory in which the .ts sources reside. | | testdir | string | The directory in which tests reside. | | tsconfigDev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watchTask | projen.Task | The "watch" task. | | docgen | boolean | *No description.* | | eslint | projen.javascript.Eslint | *No description.* | | tsconfig | projen.javascript.TypescriptConfig | *No description.* | | tsconfigEslint | projen.javascript.TypescriptConfig | *No description.* | | cdkDeps | projen.awscdk.AwsCdkDeps | *No description.* | | cdkVersion | string | The target CDK version for this library. | | version | string | *No description.* | | private | boolean | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript 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 ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allowLibraryDependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean --- ##### `artifactsDirectory`^Required ```typescript 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 ```typescript public readonly artifactsJavascriptDirectory: string; ``` - *Type:* string The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```typescript public readonly bundler: Bundler; ``` - *Type:* projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```typescript public readonly entrypoint: string; ``` - *Type:* string --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```typescript public readonly manifest: any; ``` - *Type:* any --- ##### `npmrc`^Required ```typescript public readonly npmrc: NpmConfig; ``` - *Type:* projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```typescript public readonly package: NodePackage; ``` - *Type:* projen.javascript.NodePackage API for managing the node package. --- ##### ~~`packageManager`~~^Required - *Deprecated:* use `package.packageManager` ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager The package manager to use. --- ##### `runScriptCommand`^Required ```typescript 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 ```typescript public readonly autoMerge: AutoMerge; ``` - *Type:* projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `biome`^Optional ```typescript public readonly biome: Biome; ``` - *Type:* projen.javascript.Biome --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: BuildWorkflow; ``` - *Type:* projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `buildWorkflowJobId`^Optional ```typescript public readonly buildWorkflowJobId: string; ``` - *Type:* string The job ID of the build workflow. --- ##### `jest`^Optional ```typescript public readonly jest: Jest; ``` - *Type:* projen.javascript.Jest The Jest configuration (if enabled). --- ##### `maxNodeVersion`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly npmignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```typescript public readonly prettier: Prettier; ``` - *Type:* projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```typescript 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 ```typescript public readonly release: Release; ``` - *Type:* projen.release.Release Release management. --- ##### `upgradeWorkflow`^Optional ```typescript public readonly upgradeWorkflow: UpgradeDependencies; ``` - *Type:* projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docsDirectory`^Required ```typescript public readonly docsDirectory: string; ``` - *Type:* string --- ##### `libdir`^Required ```typescript public readonly libdir: string; ``` - *Type:* string The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```typescript public readonly srcdir: string; ``` - *Type:* string The directory in which the .ts sources reside. --- ##### `testdir`^Required ```typescript public readonly testdir: string; ``` - *Type:* string The directory in which tests reside. --- ##### `tsconfigDev`^Required ```typescript public readonly tsconfigDev: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watchTask`^Required ```typescript public readonly watchTask: Task; ``` - *Type:* projen.Task The "watch" task. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean --- ##### `eslint`^Optional ```typescript public readonly eslint: Eslint; ``` - *Type:* projen.javascript.Eslint --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `tsconfigEslint`^Optional ```typescript public readonly tsconfigEslint: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `cdkDeps`^Required ```typescript public readonly cdkDeps: AwsCdkDeps; ``` - *Type:* projen.awscdk.AwsCdkDeps --- ##### `cdkVersion`^Required ```typescript public readonly cdkVersion: string; ``` - *Type:* string The target CDK version for this library. --- ##### ~~`version`~~^Required - *Deprecated:* use `cdkVersion` ```typescript public readonly version: string; ``` - *Type:* string --- ##### `private`^Required ```typescript public readonly private: boolean; ``` - *Type:* boolean --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | | DEFAULT_TS_JEST_TRANFORM_PATTERN | string | *No description.* | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`^Required ```typescript public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string; ``` - *Type:* string --- ### CdklabsJsiiProject Create a Cdklabs Jsii Project. #### Initializers ```typescript import { CdklabsJsiiProject } from 'cdklabs-projen-project-types' new CdklabsJsiiProject(options: CdklabsJsiiProjectOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | CdklabsJsiiProjectOptions | *No description.* | --- ##### `options`^Required - *Type:* CdklabsJsiiProjectOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `addExcludeFromCleanup` ```typescript 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` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(pattern: string): void ``` Adds patterns to be ignored by npm. ###### `pattern`^Required - *Type:* string The pattern to ignore. --- ##### `addTask` ```typescript 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`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript 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](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` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. This will typically be `pnpm projen TASK`. ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all subprojects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript 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`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript 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` ```typescript public addBins(bins: {[ key: string ]: string}): void ``` ###### `bins`^Required - *Type:* {[ key: string ]: string} --- ##### `addBundledDeps` ```typescript 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 `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### ~~`addCompileCommand`~~ ```typescript public addCompileCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### `addDeps` ```typescript public addDeps(deps: ...string[]): void ``` Defines normal dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addDevDeps` ```typescript public addDevDeps(deps: ...string[]): void ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addFields` ```typescript public addFields(fields: {[ key: string ]: any}): void ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* {[ key: string ]: any} The fields to set. --- ##### `addKeywords` ```typescript public addKeywords(keywords: ...string[]): void ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* ...string[] The keywords to add. --- ##### `addPeerDeps` ```typescript public addPeerDeps(deps: ...string[]): void ``` Defines peer dependencies. When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addScripts` ```typescript 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`~~ ```typescript public addTestCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### ~~`hasScript`~~ ```typescript 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` ```typescript public removeScript(name: string): void ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* string The name of the script. --- ##### `renderWorkflowSetup` ```typescript public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[] ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `options`^Optional - *Type:* projen.javascript.RenderWorkflowSetupOptions Options. --- ##### `setScript` ```typescript 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` ```typescript import { CdklabsJsiiProject } from 'cdklabs-projen-project-types' CdklabsJsiiProject.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `isProject` ```typescript import { CdklabsJsiiProject } from 'cdklabs-projen-project-types' CdklabsJsiiProject.isProject(x: any) ``` Test whether the given construct is a project. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { CdklabsJsiiProject } from 'cdklabs-projen-project-types' CdklabsJsiiProject.of(construct: IConstruct) ``` Find the closest ancestor project for given construct. When given a project, this it the project itself. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | allowLibraryDependencies | boolean | *No description.* | | artifactsDirectory | string | The build output directory. | | artifactsJavascriptDirectory | string | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | projen.javascript.Bundler | *No description.* | | entrypoint | string | *No description.* | | manifest | any | *No description.* | | npmrc | projen.javascript.NpmConfig | The .npmrc file. | | package | projen.javascript.NodePackage | API for managing the node package. | | packageManager | projen.javascript.NodePackageManager | The package manager to use. | | runScriptCommand | string | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | autoMerge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | biome | projen.javascript.Biome | *No description.* | | buildWorkflow | projen.build.BuildWorkflow | The PR build GitHub workflow. | | buildWorkflowJobId | string | The job ID of the build workflow. | | jest | projen.javascript.Jest | The Jest configuration (if enabled). | | maxNodeVersion | string | Maximum node version supported by this package. | | minNodeVersion | string | The minimum node version required by this package to function. | | npmignore | projen.IgnoreFile | The .npmignore file. | | prettier | projen.javascript.Prettier | *No description.* | | publisher | projen.release.Publisher | Package publisher. | | release | projen.release.Release | Release management. | | upgradeWorkflow | projen.javascript.UpgradeDependencies | The upgrade workflow. | | docsDirectory | string | *No description.* | | libdir | string | The directory in which compiled .js files reside. | | srcdir | string | The directory in which the .ts sources reside. | | testdir | string | The directory in which tests reside. | | tsconfigDev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watchTask | projen.Task | The "watch" task. | | docgen | boolean | *No description.* | | eslint | projen.javascript.Eslint | *No description.* | | tsconfig | projen.javascript.TypescriptConfig | *No description.* | | tsconfigEslint | projen.javascript.TypescriptConfig | *No description.* | | private | boolean | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript 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 ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allowLibraryDependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean --- ##### `artifactsDirectory`^Required ```typescript 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 ```typescript public readonly artifactsJavascriptDirectory: string; ``` - *Type:* string The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```typescript public readonly bundler: Bundler; ``` - *Type:* projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```typescript public readonly entrypoint: string; ``` - *Type:* string --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```typescript public readonly manifest: any; ``` - *Type:* any --- ##### `npmrc`^Required ```typescript public readonly npmrc: NpmConfig; ``` - *Type:* projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```typescript public readonly package: NodePackage; ``` - *Type:* projen.javascript.NodePackage API for managing the node package. --- ##### ~~`packageManager`~~^Required - *Deprecated:* use `package.packageManager` ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager The package manager to use. --- ##### `runScriptCommand`^Required ```typescript 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 ```typescript public readonly autoMerge: AutoMerge; ``` - *Type:* projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `biome`^Optional ```typescript public readonly biome: Biome; ``` - *Type:* projen.javascript.Biome --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: BuildWorkflow; ``` - *Type:* projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `buildWorkflowJobId`^Optional ```typescript public readonly buildWorkflowJobId: string; ``` - *Type:* string The job ID of the build workflow. --- ##### `jest`^Optional ```typescript public readonly jest: Jest; ``` - *Type:* projen.javascript.Jest The Jest configuration (if enabled). --- ##### `maxNodeVersion`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly npmignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```typescript public readonly prettier: Prettier; ``` - *Type:* projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```typescript 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 ```typescript public readonly release: Release; ``` - *Type:* projen.release.Release Release management. --- ##### `upgradeWorkflow`^Optional ```typescript public readonly upgradeWorkflow: UpgradeDependencies; ``` - *Type:* projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docsDirectory`^Required ```typescript public readonly docsDirectory: string; ``` - *Type:* string --- ##### `libdir`^Required ```typescript public readonly libdir: string; ``` - *Type:* string The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```typescript public readonly srcdir: string; ``` - *Type:* string The directory in which the .ts sources reside. --- ##### `testdir`^Required ```typescript public readonly testdir: string; ``` - *Type:* string The directory in which tests reside. --- ##### `tsconfigDev`^Required ```typescript public readonly tsconfigDev: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watchTask`^Required ```typescript public readonly watchTask: Task; ``` - *Type:* projen.Task The "watch" task. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean --- ##### `eslint`^Optional ```typescript public readonly eslint: Eslint; ``` - *Type:* projen.javascript.Eslint --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `tsconfigEslint`^Optional ```typescript public readonly tsconfigEslint: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `private`^Required ```typescript public readonly private: boolean; ``` - *Type:* boolean --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | | DEFAULT_TS_JEST_TRANFORM_PATTERN | string | *No description.* | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`^Required ```typescript public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string; ``` - *Type:* string --- ### CdkLabsMonorepo Opinionated implementation of yarn.Monorepo. #### Initializers ```typescript import { yarn } from 'cdklabs-projen-project-types' new yarn.CdkLabsMonorepo(options: CdkLabsMonorepoOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions | *No description.* | --- ##### `options`^Required - *Type:* cdklabs-projen-project-types.yarn.CdkLabsMonorepoOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to 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 | Hooks into the install dependencies cycle. | | 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. | | requestInstallDependencies | Allows a sub project to request installation of dependency at the Monorepo root They must provide a function that is executed after dependencies have been installed If this function returns true, the install command is run for a second time after all sub project requests have run. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `addExcludeFromCleanup` ```typescript 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` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(pattern: string): void ``` Adds patterns to be ignored by npm. ###### `pattern`^Required - *Type:* string The pattern to ignore. --- ##### `addTask` ```typescript 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`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript 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](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` ```typescript public postSynthesize(): void ``` Hooks into the install dependencies cycle. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. This will typically be `pnpm projen TASK`. ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all subprojects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript 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`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript 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` ```typescript public addBins(bins: {[ key: string ]: string}): void ``` ###### `bins`^Required - *Type:* {[ key: string ]: string} --- ##### `addBundledDeps` ```typescript 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 `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### ~~`addCompileCommand`~~ ```typescript public addCompileCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### `addDeps` ```typescript public addDeps(deps: ...string[]): void ``` Defines normal dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addDevDeps` ```typescript public addDevDeps(deps: ...string[]): void ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addFields` ```typescript public addFields(fields: {[ key: string ]: any}): void ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* {[ key: string ]: any} The fields to set. --- ##### `addKeywords` ```typescript public addKeywords(keywords: ...string[]): void ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* ...string[] The keywords to add. --- ##### `addPeerDeps` ```typescript public addPeerDeps(deps: ...string[]): void ``` Defines peer dependencies. When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addScripts` ```typescript 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`~~ ```typescript public addTestCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### ~~`hasScript`~~ ```typescript 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` ```typescript public removeScript(name: string): void ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* string The name of the script. --- ##### `renderWorkflowSetup` ```typescript public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[] ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `options`^Optional - *Type:* projen.javascript.RenderWorkflowSetupOptions Options. --- ##### `setScript` ```typescript 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. --- ##### `requestInstallDependencies` ```typescript public requestInstallDependencies(resolver: IDependencyResolver): void ``` Allows a sub project to request installation of dependency at the Monorepo root They must provide a function that is executed after dependencies have been installed If this function returns true, the install command is run for a second time after all sub project requests have run. This is used to resolve dependency versions from `*` to a concrete version constraint. ###### `resolver`^Required - *Type:* cdklabs-projen-project-types.yarn.IDependencyResolver --- #### 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. | | isMonorepo | *No description.* | --- ##### `isConstruct` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.CdkLabsMonorepo.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `isProject` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.CdkLabsMonorepo.isProject(x: any) ``` Test whether the given construct is a project. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.CdkLabsMonorepo.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 --- ##### `isMonorepo` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.CdkLabsMonorepo.isMonorepo(x: Project) ``` ###### `x`^Required - *Type:* projen.Project --- #### 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 | cdklabs-projen-project-types.yarn.TypeScriptWorkspace[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | allowLibraryDependencies | boolean | *No description.* | | artifactsDirectory | string | The build output directory. | | artifactsJavascriptDirectory | string | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | projen.javascript.Bundler | *No description.* | | entrypoint | string | *No description.* | | manifest | any | *No description.* | | npmrc | projen.javascript.NpmConfig | The .npmrc file. | | package | projen.javascript.NodePackage | API for managing the node package. | | packageManager | projen.javascript.NodePackageManager | The package manager to use. | | runScriptCommand | string | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | autoMerge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | biome | projen.javascript.Biome | *No description.* | | buildWorkflow | projen.build.BuildWorkflow | The PR build GitHub workflow. | | buildWorkflowJobId | string | The job ID of the build workflow. | | jest | projen.javascript.Jest | The Jest configuration (if enabled). | | maxNodeVersion | string | Maximum node version supported by this package. | | minNodeVersion | string | The minimum node version required by this package to function. | | npmignore | projen.IgnoreFile | The .npmignore file. | | prettier | projen.javascript.Prettier | *No description.* | | publisher | projen.release.Publisher | Package publisher. | | release | projen.release.Release | Release management. | | upgradeWorkflow | projen.javascript.UpgradeDependencies | The upgrade workflow. | | docsDirectory | string | *No description.* | | libdir | string | The directory in which compiled .js files reside. | | srcdir | string | The directory in which the .ts sources reside. | | testdir | string | The directory in which tests reside. | | tsconfigDev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watchTask | projen.Task | The "watch" task. | | docgen | boolean | *No description.* | | eslint | projen.javascript.Eslint | *No description.* | | tsconfig | projen.javascript.TypescriptConfig | *No description.* | | tsconfigEslint | projen.javascript.TypescriptConfig | *No description.* | | options | cdklabs-projen-project-types.yarn.MonorepoOptions | *No description.* | | monorepoRelease | cdklabs-projen-project-types.yarn.MonorepoRelease | The Monorepo Release component. | | repositoryUrl | string | The URL where the actual code for the package lives. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: TypeScriptWorkspace[]; ``` - *Type:* cdklabs-projen-project-types.yarn.TypeScriptWorkspace[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript 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 ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allowLibraryDependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean --- ##### `artifactsDirectory`^Required ```typescript 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 ```typescript public readonly artifactsJavascriptDirectory: string; ``` - *Type:* string The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```typescript public readonly bundler: Bundler; ``` - *Type:* projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```typescript public readonly entrypoint: string; ``` - *Type:* string --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```typescript public readonly manifest: any; ``` - *Type:* any --- ##### `npmrc`^Required ```typescript public readonly npmrc: NpmConfig; ``` - *Type:* projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```typescript public readonly package: NodePackage; ``` - *Type:* projen.javascript.NodePackage API for managing the node package. --- ##### ~~`packageManager`~~^Required - *Deprecated:* use `package.packageManager` ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager The package manager to use. --- ##### `runScriptCommand`^Required ```typescript 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 ```typescript public readonly autoMerge: AutoMerge; ``` - *Type:* projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `biome`^Optional ```typescript public readonly biome: Biome; ``` - *Type:* projen.javascript.Biome --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: BuildWorkflow; ``` - *Type:* projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `buildWorkflowJobId`^Optional ```typescript public readonly buildWorkflowJobId: string; ``` - *Type:* string The job ID of the build workflow. --- ##### `jest`^Optional ```typescript public readonly jest: Jest; ``` - *Type:* projen.javascript.Jest The Jest configuration (if enabled). --- ##### `maxNodeVersion`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly npmignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```typescript public readonly prettier: Prettier; ``` - *Type:* projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```typescript 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 ```typescript public readonly release: Release; ``` - *Type:* projen.release.Release Release management. --- ##### `upgradeWorkflow`^Optional ```typescript public readonly upgradeWorkflow: UpgradeDependencies; ``` - *Type:* projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docsDirectory`^Required ```typescript public readonly docsDirectory: string; ``` - *Type:* string --- ##### `libdir`^Required ```typescript public readonly libdir: string; ``` - *Type:* string The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```typescript public readonly srcdir: string; ``` - *Type:* string The directory in which the .ts sources reside. --- ##### `testdir`^Required ```typescript public readonly testdir: string; ``` - *Type:* string The directory in which tests reside. --- ##### `tsconfigDev`^Required ```typescript public readonly tsconfigDev: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watchTask`^Required ```typescript public readonly watchTask: Task; ``` - *Type:* projen.Task The "watch" task. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean --- ##### `eslint`^Optional ```typescript public readonly eslint: Eslint; ``` - *Type:* projen.javascript.Eslint --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `tsconfigEslint`^Optional ```typescript public readonly tsconfigEslint: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `options`^Required ```typescript public readonly options: MonorepoOptions; ``` - *Type:* cdklabs-projen-project-types.yarn.MonorepoOptions --- ##### `monorepoRelease`^Optional ```typescript public readonly monorepoRelease: MonorepoRelease; ``` - *Type:* cdklabs-projen-project-types.yarn.MonorepoRelease The Monorepo Release component. --- ##### `repositoryUrl`^Optional ```typescript public readonly repositoryUrl: string; ``` - *Type:* string The URL where the actual code for the package lives. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | | DEFAULT_TS_JEST_TRANFORM_PATTERN | string | *No description.* | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`^Required ```typescript public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string; ``` - *Type:* string --- ### CdklabsTypeScriptProject Create a Cdklabs TypeScript Project. #### Initializers ```typescript import { CdklabsTypeScriptProject } from 'cdklabs-projen-project-types' new CdklabsTypeScriptProject(options: CdklabsTypeScriptProjectOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | CdklabsTypeScriptProjectOptions | *No description.* | --- ##### `options`^Required - *Type:* CdklabsTypeScriptProjectOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `addExcludeFromCleanup` ```typescript 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` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(pattern: string): void ``` Adds patterns to be ignored by npm. ###### `pattern`^Required - *Type:* string The pattern to ignore. --- ##### `addTask` ```typescript 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`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript 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](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` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. This will typically be `pnpm projen TASK`. ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all subprojects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript 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`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript 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` ```typescript public addBins(bins: {[ key: string ]: string}): void ``` ###### `bins`^Required - *Type:* {[ key: string ]: string} --- ##### `addBundledDeps` ```typescript 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 `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### ~~`addCompileCommand`~~ ```typescript public addCompileCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### `addDeps` ```typescript public addDeps(deps: ...string[]): void ``` Defines normal dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addDevDeps` ```typescript public addDevDeps(deps: ...string[]): void ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addFields` ```typescript public addFields(fields: {[ key: string ]: any}): void ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* {[ key: string ]: any} The fields to set. --- ##### `addKeywords` ```typescript public addKeywords(keywords: ...string[]): void ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* ...string[] The keywords to add. --- ##### `addPeerDeps` ```typescript public addPeerDeps(deps: ...string[]): void ``` Defines peer dependencies. When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addScripts` ```typescript 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`~~ ```typescript public addTestCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### ~~`hasScript`~~ ```typescript 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` ```typescript public removeScript(name: string): void ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* string The name of the script. --- ##### `renderWorkflowSetup` ```typescript public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[] ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `options`^Optional - *Type:* projen.javascript.RenderWorkflowSetupOptions Options. --- ##### `setScript` ```typescript 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` ```typescript import { CdklabsTypeScriptProject } from 'cdklabs-projen-project-types' CdklabsTypeScriptProject.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `isProject` ```typescript import { CdklabsTypeScriptProject } from 'cdklabs-projen-project-types' CdklabsTypeScriptProject.isProject(x: any) ``` Test whether the given construct is a project. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { CdklabsTypeScriptProject } from 'cdklabs-projen-project-types' CdklabsTypeScriptProject.of(construct: IConstruct) ``` Find the closest ancestor project for given construct. When given a project, this it the project itself. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | allowLibraryDependencies | boolean | *No description.* | | artifactsDirectory | string | The build output directory. | | artifactsJavascriptDirectory | string | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | projen.javascript.Bundler | *No description.* | | entrypoint | string | *No description.* | | manifest | any | *No description.* | | npmrc | projen.javascript.NpmConfig | The .npmrc file. | | package | projen.javascript.NodePackage | API for managing the node package. | | packageManager | projen.javascript.NodePackageManager | The package manager to use. | | runScriptCommand | string | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | autoMerge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | biome | projen.javascript.Biome | *No description.* | | buildWorkflow | projen.build.BuildWorkflow | The PR build GitHub workflow. | | buildWorkflowJobId | string | The job ID of the build workflow. | | jest | projen.javascript.Jest | The Jest configuration (if enabled). | | maxNodeVersion | string | Maximum node version supported by this package. | | minNodeVersion | string | The minimum node version required by this package to function. | | npmignore | projen.IgnoreFile | The .npmignore file. | | prettier | projen.javascript.Prettier | *No description.* | | publisher | projen.release.Publisher | Package publisher. | | release | projen.release.Release | Release management. | | upgradeWorkflow | projen.javascript.UpgradeDependencies | The upgrade workflow. | | docsDirectory | string | *No description.* | | libdir | string | The directory in which compiled .js files reside. | | srcdir | string | The directory in which the .ts sources reside. | | testdir | string | The directory in which tests reside. | | tsconfigDev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watchTask | projen.Task | The "watch" task. | | docgen | boolean | *No description.* | | eslint | projen.javascript.Eslint | *No description.* | | tsconfig | projen.javascript.TypescriptConfig | *No description.* | | tsconfigEslint | projen.javascript.TypescriptConfig | *No description.* | | private | boolean | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript 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 ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allowLibraryDependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean --- ##### `artifactsDirectory`^Required ```typescript 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 ```typescript public readonly artifactsJavascriptDirectory: string; ``` - *Type:* string The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```typescript public readonly bundler: Bundler; ``` - *Type:* projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```typescript public readonly entrypoint: string; ``` - *Type:* string --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```typescript public readonly manifest: any; ``` - *Type:* any --- ##### `npmrc`^Required ```typescript public readonly npmrc: NpmConfig; ``` - *Type:* projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```typescript public readonly package: NodePackage; ``` - *Type:* projen.javascript.NodePackage API for managing the node package. --- ##### ~~`packageManager`~~^Required - *Deprecated:* use `package.packageManager` ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager The package manager to use. --- ##### `runScriptCommand`^Required ```typescript 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 ```typescript public readonly autoMerge: AutoMerge; ``` - *Type:* projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `biome`^Optional ```typescript public readonly biome: Biome; ``` - *Type:* projen.javascript.Biome --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: BuildWorkflow; ``` - *Type:* projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `buildWorkflowJobId`^Optional ```typescript public readonly buildWorkflowJobId: string; ``` - *Type:* string The job ID of the build workflow. --- ##### `jest`^Optional ```typescript public readonly jest: Jest; ``` - *Type:* projen.javascript.Jest The Jest configuration (if enabled). --- ##### `maxNodeVersion`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly npmignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```typescript public readonly prettier: Prettier; ``` - *Type:* projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```typescript 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 ```typescript public readonly release: Release; ``` - *Type:* projen.release.Release Release management. --- ##### `upgradeWorkflow`^Optional ```typescript public readonly upgradeWorkflow: UpgradeDependencies; ``` - *Type:* projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docsDirectory`^Required ```typescript public readonly docsDirectory: string; ``` - *Type:* string --- ##### `libdir`^Required ```typescript public readonly libdir: string; ``` - *Type:* string The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```typescript public readonly srcdir: string; ``` - *Type:* string The directory in which the .ts sources reside. --- ##### `testdir`^Required ```typescript public readonly testdir: string; ``` - *Type:* string The directory in which tests reside. --- ##### `tsconfigDev`^Required ```typescript public readonly tsconfigDev: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watchTask`^Required ```typescript public readonly watchTask: Task; ``` - *Type:* projen.Task The "watch" task. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean --- ##### `eslint`^Optional ```typescript public readonly eslint: Eslint; ``` - *Type:* projen.javascript.Eslint --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `tsconfigEslint`^Optional ```typescript public readonly tsconfigEslint: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `private`^Required ```typescript public readonly private: boolean; ``` - *Type:* boolean --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | | DEFAULT_TS_JEST_TRANFORM_PATTERN | string | *No description.* | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`^Required ```typescript public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string; ``` - *Type:* string --- ### CdkTypeScriptProject Create a Cdk TypeScript Project. #### Initializers ```typescript import { CdkTypeScriptProject } from 'cdklabs-projen-project-types' new CdkTypeScriptProject(options: CdkTypeScriptProjectOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | CdkTypeScriptProjectOptions | *No description.* | --- ##### `options`^Required - *Type:* CdkTypeScriptProjectOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to 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` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `addExcludeFromCleanup` ```typescript 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` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(pattern: string): void ``` Adds patterns to be ignored by npm. ###### `pattern`^Required - *Type:* string The pattern to ignore. --- ##### `addTask` ```typescript 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`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript 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](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` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. This will typically be `pnpm projen TASK`. ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all subprojects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript 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`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript 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` ```typescript public addBins(bins: {[ key: string ]: string}): void ``` ###### `bins`^Required - *Type:* {[ key: string ]: string} --- ##### `addBundledDeps` ```typescript 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 `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### ~~`addCompileCommand`~~ ```typescript public addCompileCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### `addDeps` ```typescript public addDeps(deps: ...string[]): void ``` Defines normal dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addDevDeps` ```typescript public addDevDeps(deps: ...string[]): void ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addFields` ```typescript public addFields(fields: {[ key: string ]: any}): void ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* {[ key: string ]: any} The fields to set. --- ##### `addKeywords` ```typescript public addKeywords(keywords: ...string[]): void ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* ...string[] The keywords to add. --- ##### `addPeerDeps` ```typescript public addPeerDeps(deps: ...string[]): void ``` Defines peer dependencies. When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addScripts` ```typescript 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`~~ ```typescript public addTestCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### ~~`hasScript`~~ ```typescript 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` ```typescript public removeScript(name: string): void ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* string The name of the script. --- ##### `renderWorkflowSetup` ```typescript public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[] ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `options`^Optional - *Type:* projen.javascript.RenderWorkflowSetupOptions Options. --- ##### `setScript` ```typescript 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` ```typescript import { CdkTypeScriptProject } from 'cdklabs-projen-project-types' CdkTypeScriptProject.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `isProject` ```typescript import { CdkTypeScriptProject } from 'cdklabs-projen-project-types' CdkTypeScriptProject.isProject(x: any) ``` Test whether the given construct is a project. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { CdkTypeScriptProject } from 'cdklabs-projen-project-types' CdkTypeScriptProject.of(construct: IConstruct) ``` Find the closest ancestor project for given construct. When given a project, this it the project itself. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | allowLibraryDependencies | boolean | *No description.* | | artifactsDirectory | string | The build output directory. | | artifactsJavascriptDirectory | string | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | projen.javascript.Bundler | *No description.* | | entrypoint | string | *No description.* | | manifest | any | *No description.* | | npmrc | projen.javascript.NpmConfig | The .npmrc file. | | package | projen.javascript.NodePackage | API for managing the node package. | | packageManager | projen.javascript.NodePackageManager | The package manager to use. | | runScriptCommand | string | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | autoMerge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | biome | projen.javascript.Biome | *No description.* | | buildWorkflow | projen.build.BuildWorkflow | The PR build GitHub workflow. | | buildWorkflowJobId | string | The job ID of the build workflow. | | jest | projen.javascript.Jest | The Jest configuration (if enabled). | | maxNodeVersion | string | Maximum node version supported by this package. | | minNodeVersion | string | The minimum node version required by this package to function. | | npmignore | projen.IgnoreFile | The .npmignore file. | | prettier | projen.javascript.Prettier | *No description.* | | publisher | projen.release.Publisher | Package publisher. | | release | projen.release.Release | Release management. | | upgradeWorkflow | projen.javascript.UpgradeDependencies | The upgrade workflow. | | docsDirectory | string | *No description.* | | libdir | string | The directory in which compiled .js files reside. | | srcdir | string | The directory in which the .ts sources reside. | | testdir | string | The directory in which tests reside. | | tsconfigDev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watchTask | projen.Task | The "watch" task. | | docgen | boolean | *No description.* | | eslint | projen.javascript.Eslint | *No description.* | | tsconfig | projen.javascript.TypescriptConfig | *No description.* | | tsconfigEslint | projen.javascript.TypescriptConfig | *No description.* | | private | boolean | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript 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 ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allowLibraryDependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean --- ##### `artifactsDirectory`^Required ```typescript 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 ```typescript public readonly artifactsJavascriptDirectory: string; ``` - *Type:* string The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```typescript public readonly bundler: Bundler; ``` - *Type:* projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```typescript public readonly entrypoint: string; ``` - *Type:* string --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```typescript public readonly manifest: any; ``` - *Type:* any --- ##### `npmrc`^Required ```typescript public readonly npmrc: NpmConfig; ``` - *Type:* projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```typescript public readonly package: NodePackage; ``` - *Type:* projen.javascript.NodePackage API for managing the node package. --- ##### ~~`packageManager`~~^Required - *Deprecated:* use `package.packageManager` ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager The package manager to use. --- ##### `runScriptCommand`^Required ```typescript 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 ```typescript public readonly autoMerge: AutoMerge; ``` - *Type:* projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `biome`^Optional ```typescript public readonly biome: Biome; ``` - *Type:* projen.javascript.Biome --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: BuildWorkflow; ``` - *Type:* projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `buildWorkflowJobId`^Optional ```typescript public readonly buildWorkflowJobId: string; ``` - *Type:* string The job ID of the build workflow. --- ##### `jest`^Optional ```typescript public readonly jest: Jest; ``` - *Type:* projen.javascript.Jest The Jest configuration (if enabled). --- ##### `maxNodeVersion`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly npmignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```typescript public readonly prettier: Prettier; ``` - *Type:* projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```typescript 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 ```typescript public readonly release: Release; ``` - *Type:* projen.release.Release Release management. --- ##### `upgradeWorkflow`^Optional ```typescript public readonly upgradeWorkflow: UpgradeDependencies; ``` - *Type:* projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docsDirectory`^Required ```typescript public readonly docsDirectory: string; ``` - *Type:* string --- ##### `libdir`^Required ```typescript public readonly libdir: string; ``` - *Type:* string The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```typescript public readonly srcdir: string; ``` - *Type:* string The directory in which the .ts sources reside. --- ##### `testdir`^Required ```typescript public readonly testdir: string; ``` - *Type:* string The directory in which tests reside. --- ##### `tsconfigDev`^Required ```typescript public readonly tsconfigDev: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watchTask`^Required ```typescript public readonly watchTask: Task; ``` - *Type:* projen.Task The "watch" task. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean --- ##### `eslint`^Optional ```typescript public readonly eslint: Eslint; ``` - *Type:* projen.javascript.Eslint --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `tsconfigEslint`^Optional ```typescript public readonly tsconfigEslint: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `private`^Required ```typescript public readonly private: boolean; ``` - *Type:* boolean --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | | DEFAULT_TS_JEST_TRANFORM_PATTERN | string | *No description.* | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`^Required ```typescript public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string; ``` - *Type:* string --- ### Constraints #### Initializers ```typescript import { yarn } from 'cdklabs-projen-project-types' new yarn.Constraints(project: Monorepo, options: ConstraintsOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | cdklabs-projen-project-types.yarn.Monorepo | *No description.* | | options | cdklabs-projen-project-types.yarn.ConstraintsOptions | *No description.* | --- ##### `project`^Required - *Type:* cdklabs-projen-project-types.yarn.Monorepo --- ##### `options`^Required - *Type:* cdklabs-projen-project-types.yarn.ConstraintsOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | synthesize | Synthesizes files to the project output directory. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `synthesize` ```typescript 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` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.Constraints.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` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.Constraints.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 | cdklabs-projen-project-types.yarn.Monorepo | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Monorepo; ``` - *Type:* cdklabs-projen-project-types.yarn.Monorepo --- ### Monorepo A monorepo using yarn workspaces. #### Initializers ```typescript import { yarn } from 'cdklabs-projen-project-types' new yarn.Monorepo(options: MonorepoOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | cdklabs-projen-project-types.yarn.MonorepoOptions | *No description.* | --- ##### `options`^Required - *Type:* cdklabs-projen-project-types.yarn.MonorepoOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to 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 | Hooks into the install dependencies cycle. | | 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. | | requestInstallDependencies | Allows a sub project to request installation of dependency at the Monorepo root They must provide a function that is executed after dependencies have been installed If this function returns true, the install command is run for a second time after all sub project requests have run. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `addExcludeFromCleanup` ```typescript 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` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(pattern: string): void ``` Adds patterns to be ignored by npm. ###### `pattern`^Required - *Type:* string The pattern to ignore. --- ##### `addTask` ```typescript 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`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript 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](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` ```typescript public postSynthesize(): void ``` Hooks into the install dependencies cycle. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. This will typically be `pnpm projen TASK`. ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all subprojects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript 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`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript 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` ```typescript public addBins(bins: {[ key: string ]: string}): void ``` ###### `bins`^Required - *Type:* {[ key: string ]: string} --- ##### `addBundledDeps` ```typescript 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 `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### ~~`addCompileCommand`~~ ```typescript public addCompileCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### `addDeps` ```typescript public addDeps(deps: ...string[]): void ``` Defines normal dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addDevDeps` ```typescript public addDevDeps(deps: ...string[]): void ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addFields` ```typescript public addFields(fields: {[ key: string ]: any}): void ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* {[ key: string ]: any} The fields to set. --- ##### `addKeywords` ```typescript public addKeywords(keywords: ...string[]): void ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* ...string[] The keywords to add. --- ##### `addPeerDeps` ```typescript public addPeerDeps(deps: ...string[]): void ``` Defines peer dependencies. When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addScripts` ```typescript 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`~~ ```typescript public addTestCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### ~~`hasScript`~~ ```typescript 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` ```typescript public removeScript(name: string): void ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* string The name of the script. --- ##### `renderWorkflowSetup` ```typescript public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[] ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `options`^Optional - *Type:* projen.javascript.RenderWorkflowSetupOptions Options. --- ##### `setScript` ```typescript 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. --- ##### `requestInstallDependencies` ```typescript public requestInstallDependencies(resolver: IDependencyResolver): void ``` Allows a sub project to request installation of dependency at the Monorepo root They must provide a function that is executed after dependencies have been installed If this function returns true, the install command is run for a second time after all sub project requests have run. This is used to resolve dependency versions from `*` to a concrete version constraint. ###### `resolver`^Required - *Type:* cdklabs-projen-project-types.yarn.IDependencyResolver --- #### 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. | | isMonorepo | *No description.* | --- ##### `isConstruct` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.Monorepo.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `isProject` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.Monorepo.isProject(x: any) ``` Test whether the given construct is a project. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.Monorepo.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 --- ##### `isMonorepo` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.Monorepo.isMonorepo(x: Project) ``` ###### `x`^Required - *Type:* projen.Project --- #### 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 | cdklabs-projen-project-types.yarn.TypeScriptWorkspace[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | allowLibraryDependencies | boolean | *No description.* | | artifactsDirectory | string | The build output directory. | | artifactsJavascriptDirectory | string | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | projen.javascript.Bundler | *No description.* | | entrypoint | string | *No description.* | | manifest | any | *No description.* | | npmrc | projen.javascript.NpmConfig | The .npmrc file. | | package | projen.javascript.NodePackage | API for managing the node package. | | packageManager | projen.javascript.NodePackageManager | The package manager to use. | | runScriptCommand | string | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | autoMerge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | biome | projen.javascript.Biome | *No description.* | | buildWorkflow | projen.build.BuildWorkflow | The PR build GitHub workflow. | | buildWorkflowJobId | string | The job ID of the build workflow. | | jest | projen.javascript.Jest | The Jest configuration (if enabled). | | maxNodeVersion | string | Maximum node version supported by this package. | | minNodeVersion | string | The minimum node version required by this package to function. | | npmignore | projen.IgnoreFile | The .npmignore file. | | prettier | projen.javascript.Prettier | *No description.* | | publisher | projen.release.Publisher | Package publisher. | | release | projen.release.Release | Release management. | | upgradeWorkflow | projen.javascript.UpgradeDependencies | The upgrade workflow. | | docsDirectory | string | *No description.* | | libdir | string | The directory in which compiled .js files reside. | | srcdir | string | The directory in which the .ts sources reside. | | testdir | string | The directory in which tests reside. | | tsconfigDev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watchTask | projen.Task | The "watch" task. | | docgen | boolean | *No description.* | | eslint | projen.javascript.Eslint | *No description.* | | tsconfig | projen.javascript.TypescriptConfig | *No description.* | | tsconfigEslint | projen.javascript.TypescriptConfig | *No description.* | | options | cdklabs-projen-project-types.yarn.MonorepoOptions | *No description.* | | monorepoRelease | cdklabs-projen-project-types.yarn.MonorepoRelease | The Monorepo Release component. | | repositoryUrl | string | The URL where the actual code for the package lives. | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: TypeScriptWorkspace[]; ``` - *Type:* cdklabs-projen-project-types.yarn.TypeScriptWorkspace[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript 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 ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allowLibraryDependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean --- ##### `artifactsDirectory`^Required ```typescript 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 ```typescript public readonly artifactsJavascriptDirectory: string; ``` - *Type:* string The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```typescript public readonly bundler: Bundler; ``` - *Type:* projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```typescript public readonly entrypoint: string; ``` - *Type:* string --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```typescript public readonly manifest: any; ``` - *Type:* any --- ##### `npmrc`^Required ```typescript public readonly npmrc: NpmConfig; ``` - *Type:* projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```typescript public readonly package: NodePackage; ``` - *Type:* projen.javascript.NodePackage API for managing the node package. --- ##### ~~`packageManager`~~^Required - *Deprecated:* use `package.packageManager` ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager The package manager to use. --- ##### `runScriptCommand`^Required ```typescript 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 ```typescript public readonly autoMerge: AutoMerge; ``` - *Type:* projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `biome`^Optional ```typescript public readonly biome: Biome; ``` - *Type:* projen.javascript.Biome --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: BuildWorkflow; ``` - *Type:* projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `buildWorkflowJobId`^Optional ```typescript public readonly buildWorkflowJobId: string; ``` - *Type:* string The job ID of the build workflow. --- ##### `jest`^Optional ```typescript public readonly jest: Jest; ``` - *Type:* projen.javascript.Jest The Jest configuration (if enabled). --- ##### `maxNodeVersion`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly npmignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```typescript public readonly prettier: Prettier; ``` - *Type:* projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```typescript 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 ```typescript public readonly release: Release; ``` - *Type:* projen.release.Release Release management. --- ##### `upgradeWorkflow`^Optional ```typescript public readonly upgradeWorkflow: UpgradeDependencies; ``` - *Type:* projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docsDirectory`^Required ```typescript public readonly docsDirectory: string; ``` - *Type:* string --- ##### `libdir`^Required ```typescript public readonly libdir: string; ``` - *Type:* string The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```typescript public readonly srcdir: string; ``` - *Type:* string The directory in which the .ts sources reside. --- ##### `testdir`^Required ```typescript public readonly testdir: string; ``` - *Type:* string The directory in which tests reside. --- ##### `tsconfigDev`^Required ```typescript public readonly tsconfigDev: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watchTask`^Required ```typescript public readonly watchTask: Task; ``` - *Type:* projen.Task The "watch" task. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean --- ##### `eslint`^Optional ```typescript public readonly eslint: Eslint; ``` - *Type:* projen.javascript.Eslint --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `tsconfigEslint`^Optional ```typescript public readonly tsconfigEslint: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `options`^Required ```typescript public readonly options: MonorepoOptions; ``` - *Type:* cdklabs-projen-project-types.yarn.MonorepoOptions --- ##### `monorepoRelease`^Optional ```typescript public readonly monorepoRelease: MonorepoRelease; ``` - *Type:* cdklabs-projen-project-types.yarn.MonorepoRelease The Monorepo Release component. --- ##### `repositoryUrl`^Optional ```typescript public readonly repositoryUrl: string; ``` - *Type:* string The URL where the actual code for the package lives. --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | | DEFAULT_TS_JEST_TRANFORM_PATTERN | string | *No description.* | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`^Required ```typescript public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string; ``` - *Type:* string --- ### MonorepoRelease #### Initializers ```typescript import { yarn } from 'cdklabs-projen-project-types' new yarn.MonorepoRelease(project: Project, options?: MonorepoReleaseOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.Project | *No description.* | | options | cdklabs-projen-project-types.yarn.MonorepoReleaseOptions | *No description.* | --- ##### `project`^Required - *Type:* projen.Project --- ##### `options`^Optional - *Type:* cdklabs-projen-project-types.yarn.MonorepoReleaseOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | synthesize | Synthesizes files to the project output directory. | | addWorkspace | *No description.* | | workspaceRelease | *No description.* | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `synthesize` ```typescript public synthesize(): void ``` Synthesizes files to the project output directory. ##### `addWorkspace` ```typescript public addWorkspace(project: TypeScriptWorkspace, options: WorkspaceReleaseOptions): void ``` ###### `project`^Required - *Type:* cdklabs-projen-project-types.yarn.TypeScriptWorkspace --- ###### `options`^Required - *Type:* cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions --- ##### `workspaceRelease` ```typescript public workspaceRelease(project: TypeScriptWorkspace): WorkspaceRelease ``` ###### `project`^Required - *Type:* cdklabs-projen-project-types.yarn.TypeScriptWorkspace --- #### Static Functions | **Name** | **Description** | | --- | --- | | isConstruct | Checks if `x` is a construct. | | isComponent | Test whether the given construct is a component. | | of | Returns the `MonorepoReleaseWorkflow` component of a project or `undefined` if the project does not have a MonorepoReleaseWorkflow component. | --- ##### `isConstruct` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.MonorepoRelease.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` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.MonorepoRelease.isComponent(x: any) ``` Test whether the given construct is a component. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.MonorepoRelease.of(project: Project) ``` Returns the `MonorepoReleaseWorkflow` component of a project or `undefined` if the project does not have a MonorepoReleaseWorkflow component. ###### `project`^Required - *Type:* projen.Project --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | project | projen.Project | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ### Rosetta The Rosetta component adds builtin rosetta support for a construct library. Since ConstructHub will run rosetta for real, this just adds a check to the build to ensure that rosetta will run successfully #### Initializers ```typescript import { Rosetta } from 'cdklabs-projen-project-types' new Rosetta(project: JsiiProject, options?: RosettaOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | projen.cdk.JsiiProject | *No description.* | | options | RosettaOptions | *No description.* | --- ##### `project`^Required - *Type:* projen.cdk.JsiiProject --- ##### `options`^Optional - *Type:* RosettaOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | synthesize | Synthesizes files to the project output directory. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `synthesize` ```typescript 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` ```typescript import { Rosetta } from 'cdklabs-projen-project-types' Rosetta.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` ```typescript import { Rosetta } from 'cdklabs-projen-project-types' Rosetta.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 ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ### TypeScriptWorkspace - *Implements:* cdklabs-projen-project-types.yarn.IWorkspaceReference A TypeScript workspace in a `yarn.Monorepo`. #### Initializers ```typescript import { yarn } from 'cdklabs-projen-project-types' new yarn.TypeScriptWorkspace(options: TypeScriptWorkspaceOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | options | cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions | *No description.* | --- ##### `options`^Required - *Type:* cdklabs-projen-project-types.yarn.TypeScriptWorkspaceOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to 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. | | customizeReference | Return a specialized reference to this workspace. | | workspaceDependencies | Return all Projects in the workspace that are also dependencies. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `addExcludeFromCleanup` ```typescript 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` ```typescript public addGitIgnore(pattern: string): void ``` Adds a .gitignore pattern. ###### `pattern`^Required - *Type:* string The glob pattern to ignore. --- ##### `addPackageIgnore` ```typescript public addPackageIgnore(pattern: string): void ``` Adds patterns to be ignored by npm. ###### `pattern`^Required - *Type:* string The pattern to ignore. --- ##### `addTask` ```typescript 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`~~ ```typescript public addTip(message: string): void ``` Prints a "tip" message during synthesis. ###### `message`^Required - *Type:* string The message. --- ##### `annotateGenerated` ```typescript 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](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` ```typescript public postSynthesize(): void ``` Called after all components are synthesized. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before all components are synthesized. ##### `removeTask` ```typescript public removeTask(name: string): Task ``` Removes a task from a project. ###### `name`^Required - *Type:* string The name of the task to remove. --- ##### `runTaskCommand` ```typescript public runTaskCommand(task: Task): string ``` Returns the shell command to execute in order to run a task. This will typically be `pnpm projen TASK`. ###### `task`^Required - *Type:* projen.Task The task for which the command is required. --- ##### `synth` ```typescript public synth(): void ``` Synthesize all project files into `outdir`. 1. Call "this.preSynthesize()" 2. Delete all generated files 3. Synthesize all subprojects 4. Synthesize all components of this project 5. Call "postSynthesize()" for all components of this project 6. Call "this.postSynthesize()" ##### `tryFindFile` ```typescript 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`~~ ```typescript public tryFindJsonFile(filePath: string): JsonFile ``` Finds a json file by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryFindObjectFile` ```typescript public tryFindObjectFile(filePath: string): ObjectFile ``` Finds an object file (like JsonFile, YamlFile, etc.) by name. ###### `filePath`^Required - *Type:* string The file path. --- ##### `tryRemoveFile` ```typescript 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` ```typescript public addBins(bins: {[ key: string ]: string}): void ``` ###### `bins`^Required - *Type:* {[ key: string ]: string} --- ##### `addBundledDeps` ```typescript 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 `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### ~~`addCompileCommand`~~ ```typescript public addCompileCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### `addDeps` ```typescript public addDeps(deps: ...string[]): void ``` Defines normal dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addDevDeps` ```typescript public addDevDeps(deps: ...string[]): void ``` Defines development/test dependencies. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addFields` ```typescript public addFields(fields: {[ key: string ]: any}): void ``` Directly set fields in `package.json`. ###### `fields`^Required - *Type:* {[ key: string ]: any} The fields to set. --- ##### `addKeywords` ```typescript public addKeywords(keywords: ...string[]): void ``` Adds keywords to package.json (deduplicated). ###### `keywords`^Required - *Type:* ...string[] The keywords to add. --- ##### `addPeerDeps` ```typescript public addPeerDeps(deps: ...string[]): void ``` Defines peer dependencies. When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers. ###### `deps`^Required - *Type:* ...string[] Names modules to install. By default, the the dependency will be installed in the next `pnpm projen` run and the version will be recorded in your `package.json` file. You can upgrade manually or using `pnpm add/update`. If you wish to specify a version range use this syntax: `module@^7`. --- ##### `addScripts` ```typescript 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`~~ ```typescript public addTestCommand(commands: ...string[]): void ``` DEPRECATED. ###### `commands`^Required - *Type:* ...string[] --- ##### ~~`hasScript`~~ ```typescript 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` ```typescript public removeScript(name: string): void ``` Removes the npm script (always successful). ###### `name`^Required - *Type:* string The name of the script. --- ##### `renderWorkflowSetup` ```typescript public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[] ``` Returns the set of workflow steps which should be executed to bootstrap a workflow. ###### `options`^Optional - *Type:* projen.javascript.RenderWorkflowSetupOptions Options. --- ##### `setScript` ```typescript 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. --- ##### `customizeReference` ```typescript public customizeReference(refOpts?: ReferenceOptions): IWorkspaceReference ``` Return a specialized reference to this workspace. ###### `refOpts`^Optional - *Type:* cdklabs-projen-project-types.yarn.ReferenceOptions --- ##### `workspaceDependencies` ```typescript public workspaceDependencies(types?: DependencyType[]): Project[] ``` Return all Projects in the workspace that are also dependencies. Optionally filter by dependency type. ###### `types`^Optional - *Type:* projen.DependencyType[] --- #### 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` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.TypeScriptWorkspace.isConstruct(x: any) ``` Checks if `x` is a construct. Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead. ###### `x`^Required - *Type:* any Any object. --- ##### `isProject` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.TypeScriptWorkspace.isProject(x: any) ``` Test whether the given construct is a project. ###### `x`^Required - *Type:* any --- ##### `of` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.TypeScriptWorkspace.of(construct: IConstruct) ``` Find the closest ancestor project for given construct. When given a project, this it the project itself. ###### `construct`^Required - *Type:* constructs.IConstruct --- #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | node | constructs.Node | The tree node. | | buildTask | projen.Task | *No description.* | | commitGenerated | boolean | Whether to commit the managed files by default. | | compileTask | projen.Task | *No description.* | | components | projen.Component[] | Returns all the components within this project. | | deps | projen.Dependencies | Project dependencies. | | ejected | boolean | Whether or not the project is being ejected. | | files | projen.FileBase[] | All files in this project. | | gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. | | gitignore | projen.IgnoreFile | .gitignore. | | logger | projen.Logger | Logging utilities. | | name | string | Project name. | | outdir | string | Absolute output directory of this project. | | packageTask | projen.Task | *No description.* | | postCompileTask | projen.Task | *No description.* | | preCompileTask | projen.Task | *No description.* | | projectBuild | projen.ProjectBuild | Manages the build process of the project. | | projenCommand | string | The command to use in order to run the projen CLI. | | root | projen.Project | The root project. | | subprojects | projen.Project[] | Returns all the subprojects within this project. | | tasks | projen.Tasks | Project tasks. | | testTask | projen.Task | *No description.* | | defaultTask | projen.Task | This is the "default" task, the one that executes "projen". | | initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. | | parent | projen.Project | A parent project. | | projectType | projen.ProjectType | *No description.* | | autoApprove | projen.github.AutoApprove | Auto approve set up for this project. | | devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). | | github | projen.github.GitHub | Access all github components. | | gitpod | projen.Gitpod | Access for Gitpod. | | vscode | projen.vscode.VsCode | Access all VSCode components. | | allowLibraryDependencies | boolean | *No description.* | | artifactsDirectory | string | The build output directory. | | artifactsJavascriptDirectory | string | The location of the npm tarball after build (`${artifactsDirectory}/js`). | | bundler | projen.javascript.Bundler | *No description.* | | entrypoint | string | *No description.* | | manifest | any | *No description.* | | npmrc | projen.javascript.NpmConfig | The .npmrc file. | | package | projen.javascript.NodePackage | API for managing the node package. | | packageManager | projen.javascript.NodePackageManager | The package manager to use. | | runScriptCommand | string | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). | | autoMerge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. | | biome | projen.javascript.Biome | *No description.* | | buildWorkflow | projen.build.BuildWorkflow | The PR build GitHub workflow. | | buildWorkflowJobId | string | The job ID of the build workflow. | | jest | projen.javascript.Jest | The Jest configuration (if enabled). | | maxNodeVersion | string | Maximum node version supported by this package. | | minNodeVersion | string | The minimum node version required by this package to function. | | npmignore | projen.IgnoreFile | The .npmignore file. | | prettier | projen.javascript.Prettier | *No description.* | | publisher | projen.release.Publisher | Package publisher. | | release | projen.release.Release | Release management. | | upgradeWorkflow | projen.javascript.UpgradeDependencies | The upgrade workflow. | | docsDirectory | string | *No description.* | | libdir | string | The directory in which compiled .js files reside. | | srcdir | string | The directory in which the .ts sources reside. | | testdir | string | The directory in which tests reside. | | tsconfigDev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). | | watchTask | projen.Task | The "watch" task. | | docgen | boolean | *No description.* | | eslint | projen.javascript.Eslint | *No description.* | | tsconfig | projen.javascript.TypescriptConfig | *No description.* | | tsconfigEslint | projen.javascript.TypescriptConfig | *No description.* | | bundledDeps | string[] | *No description.* | | isPrivatePackage | boolean | Whether the referenced workspace package is private. | | versionType | string | The semver range that should be used to reference this package when it is released. | | workspaceDirectory | string | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `buildTask`^Required ```typescript public readonly buildTask: Task; ``` - *Type:* projen.Task --- ##### `commitGenerated`^Required ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean Whether to commit the managed files by default. --- ##### `compileTask`^Required ```typescript public readonly compileTask: Task; ``` - *Type:* projen.Task --- ##### `components`^Required ```typescript public readonly components: Component[]; ``` - *Type:* projen.Component[] Returns all the components within this project. --- ##### `deps`^Required ```typescript public readonly deps: Dependencies; ``` - *Type:* projen.Dependencies Project dependencies. --- ##### `ejected`^Required ```typescript public readonly ejected: boolean; ``` - *Type:* boolean Whether or not the project is being ejected. --- ##### `files`^Required ```typescript public readonly files: FileBase[]; ``` - *Type:* projen.FileBase[] All files in this project. --- ##### `gitattributes`^Required ```typescript public readonly gitattributes: GitAttributesFile; ``` - *Type:* projen.GitAttributesFile The .gitattributes file for this repository. --- ##### `gitignore`^Required ```typescript public readonly gitignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile .gitignore. --- ##### `logger`^Required ```typescript public readonly logger: Logger; ``` - *Type:* projen.Logger Logging utilities. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string Project name. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string Absolute output directory of this project. --- ##### `packageTask`^Required ```typescript public readonly packageTask: Task; ``` - *Type:* projen.Task --- ##### `postCompileTask`^Required ```typescript public readonly postCompileTask: Task; ``` - *Type:* projen.Task --- ##### `preCompileTask`^Required ```typescript public readonly preCompileTask: Task; ``` - *Type:* projen.Task --- ##### `projectBuild`^Required ```typescript public readonly projectBuild: ProjectBuild; ``` - *Type:* projen.ProjectBuild Manages the build process of the project. --- ##### `projenCommand`^Required ```typescript public readonly projenCommand: string; ``` - *Type:* string The command to use in order to run the projen CLI. --- ##### `root`^Required ```typescript public readonly root: Project; ``` - *Type:* projen.Project The root project. --- ##### `subprojects`^Required ```typescript public readonly subprojects: Project[]; ``` - *Type:* projen.Project[] Returns all the subprojects within this project. --- ##### `tasks`^Required ```typescript public readonly tasks: Tasks; ``` - *Type:* projen.Tasks Project tasks. --- ##### `testTask`^Required ```typescript public readonly testTask: Task; ``` - *Type:* projen.Task --- ##### `defaultTask`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly parent: Project; ``` - *Type:* projen.Project A parent project. If undefined, this is the root project. --- ##### `projectType`^Required ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType --- ##### `autoApprove`^Optional ```typescript public readonly autoApprove: AutoApprove; ``` - *Type:* projen.github.AutoApprove Auto approve set up for this project. --- ##### `devContainer`^Optional ```typescript 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 ```typescript public readonly github: GitHub; ``` - *Type:* projen.github.GitHub Access all github components. This will be `undefined` for subprojects. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: Gitpod; ``` - *Type:* projen.Gitpod Access for Gitpod. This will be `undefined` if gitpod boolean is false --- ##### `vscode`^Optional ```typescript public readonly vscode: VsCode; ``` - *Type:* projen.vscode.VsCode Access all VSCode components. This will be `undefined` for subprojects. --- ##### ~~`allowLibraryDependencies`~~^Required - *Deprecated:* use `package.allowLibraryDependencies` ```typescript public readonly allowLibraryDependencies: boolean; ``` - *Type:* boolean --- ##### `artifactsDirectory`^Required ```typescript 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 ```typescript public readonly artifactsJavascriptDirectory: string; ``` - *Type:* string The location of the npm tarball after build (`${artifactsDirectory}/js`). --- ##### `bundler`^Required ```typescript public readonly bundler: Bundler; ``` - *Type:* projen.javascript.Bundler --- ##### ~~`entrypoint`~~^Required - *Deprecated:* use `package.entrypoint` ```typescript public readonly entrypoint: string; ``` - *Type:* string --- ##### ~~`manifest`~~^Required - *Deprecated:* use `package.addField(x, y)` ```typescript public readonly manifest: any; ``` - *Type:* any --- ##### `npmrc`^Required ```typescript public readonly npmrc: NpmConfig; ``` - *Type:* projen.javascript.NpmConfig The .npmrc file. --- ##### `package`^Required ```typescript public readonly package: NodePackage; ``` - *Type:* projen.javascript.NodePackage API for managing the node package. --- ##### ~~`packageManager`~~^Required - *Deprecated:* use `package.packageManager` ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager The package manager to use. --- ##### `runScriptCommand`^Required ```typescript 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 ```typescript public readonly autoMerge: AutoMerge; ``` - *Type:* projen.github.AutoMerge Component that sets up mergify for merging approved pull requests. --- ##### `biome`^Optional ```typescript public readonly biome: Biome; ``` - *Type:* projen.javascript.Biome --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: BuildWorkflow; ``` - *Type:* projen.build.BuildWorkflow The PR build GitHub workflow. `undefined` if `buildWorkflow` is disabled. --- ##### `buildWorkflowJobId`^Optional ```typescript public readonly buildWorkflowJobId: string; ``` - *Type:* string The job ID of the build workflow. --- ##### `jest`^Optional ```typescript public readonly jest: Jest; ``` - *Type:* projen.javascript.Jest The Jest configuration (if enabled). --- ##### `maxNodeVersion`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly npmignore: IgnoreFile; ``` - *Type:* projen.IgnoreFile The .npmignore file. --- ##### `prettier`^Optional ```typescript public readonly prettier: Prettier; ``` - *Type:* projen.javascript.Prettier --- ##### ~~`publisher`~~^Optional - *Deprecated:* use `release.publisher`. ```typescript 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 ```typescript public readonly release: Release; ``` - *Type:* projen.release.Release Release management. --- ##### `upgradeWorkflow`^Optional ```typescript public readonly upgradeWorkflow: UpgradeDependencies; ``` - *Type:* projen.javascript.UpgradeDependencies The upgrade workflow. --- ##### `docsDirectory`^Required ```typescript public readonly docsDirectory: string; ``` - *Type:* string --- ##### `libdir`^Required ```typescript public readonly libdir: string; ``` - *Type:* string The directory in which compiled .js files reside. --- ##### `srcdir`^Required ```typescript public readonly srcdir: string; ``` - *Type:* string The directory in which the .ts sources reside. --- ##### `testdir`^Required ```typescript public readonly testdir: string; ``` - *Type:* string The directory in which tests reside. --- ##### `tsconfigDev`^Required ```typescript public readonly tsconfigDev: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig A typescript configuration file which covers all files (sources, tests, projen). --- ##### `watchTask`^Required ```typescript public readonly watchTask: Task; ``` - *Type:* projen.Task The "watch" task. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean --- ##### `eslint`^Optional ```typescript public readonly eslint: Eslint; ``` - *Type:* projen.javascript.Eslint --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `tsconfigEslint`^Optional ```typescript public readonly tsconfigEslint: TypescriptConfig; ``` - *Type:* projen.javascript.TypescriptConfig --- ##### `bundledDeps`^Required ```typescript public readonly bundledDeps: string[]; ``` - *Type:* string[] --- ##### `isPrivatePackage`^Required ```typescript public readonly isPrivatePackage: boolean; ``` - *Type:* boolean Whether the referenced workspace package is private. --- ##### `versionType`^Required ```typescript public readonly versionType: string; ``` - *Type:* string The semver range that should be used to reference this package when it is released. --- ##### `workspaceDirectory`^Required ```typescript public readonly workspaceDirectory: string; ``` - *Type:* string --- #### Constants | **Name** | **Type** | **Description** | | --- | --- | --- | | DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). | | DEFAULT_TS_JEST_TRANFORM_PATTERN | string | *No description.* | --- ##### `DEFAULT_TASK`^Required ```typescript public readonly DEFAULT_TASK: string; ``` - *Type:* string The name of the default task (the task executed when `projen` is run without arguments). Normally this task should synthesize the project files. --- ##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`^Required ```typescript public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string; ``` - *Type:* string --- ### WorkspaceRelease #### Initializers ```typescript import { yarn } from 'cdklabs-projen-project-types' new yarn.WorkspaceRelease(project: TypeScriptWorkspace, options: WorkspaceReleaseOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | project | cdklabs-projen-project-types.yarn.TypeScriptWorkspace | *No description.* | | options | cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions | *No description.* | --- ##### `project`^Required - *Type:* cdklabs-projen-project-types.yarn.TypeScriptWorkspace --- ##### `options`^Required - *Type:* cdklabs-projen-project-types.yarn.WorkspaceReleaseOptions --- #### Methods | **Name** | **Description** | | --- | --- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to this construct. | | postSynthesize | Called after synthesis. | | preSynthesize | Called before synthesis. | | synthesize | Synthesizes files to the project output directory. | --- ##### `toString` ```typescript public toString(): string ``` Returns a string representation of this construct. ##### `with` ```typescript public with(mixins: ...IMixin[]): IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. ###### `mixins`^Required - *Type:* ...constructs.IMixin[] The mixins to apply. --- ##### `postSynthesize` ```typescript public postSynthesize(): void ``` Called after synthesis. Order is *not* guaranteed. ##### `preSynthesize` ```typescript public preSynthesize(): void ``` Called before synthesis. ##### `synthesize` ```typescript 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` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.WorkspaceRelease.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` ```typescript import { yarn } from 'cdklabs-projen-project-types' yarn.WorkspaceRelease.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.* | | workspace | cdklabs-projen-project-types.yarn.TypeScriptWorkspace | *No description.* | | publisher | projen.release.Publisher | *No description.* | | version | projen.Version | *No description.* | --- ##### `node`^Required ```typescript public readonly node: Node; ``` - *Type:* constructs.Node The tree node. --- ##### `project`^Required ```typescript public readonly project: Project; ``` - *Type:* projen.Project --- ##### `workspace`^Required ```typescript public readonly workspace: TypeScriptWorkspace; ``` - *Type:* cdklabs-projen-project-types.yarn.TypeScriptWorkspace --- ##### `publisher`^Optional ```typescript public readonly publisher: Publisher; ``` - *Type:* projen.release.Publisher --- ##### `version`^Optional ```typescript public readonly version: Version; ``` - *Type:* projen.Version --- ## Structs ### CdkCommonOptions CdkCommonOptions. #### Initializer ```typescript import { CdkCommonOptions } from 'cdklabs-projen-project-types' const cdkCommonOptions: CdkCommonOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | enablePRAutoMerge | boolean | Whether to enable the auto merge workflow for PRs. | | ghAutoMergeOptions | projen.github.AutoQueueOptions | Options for the GitHub auto merge workflow. | | private | boolean | Whether or not this package is private. | | setNodeEngineVersion | boolean | Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. | | tenancy | OrgTenancy | The organization this project is part of. | | upgradeCdklabsProjenProjectTypes | boolean | Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. | | upgradeRuntimeDepsAsFix | boolean | Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. | --- ##### `enablePRAutoMerge`^Optional ```typescript public readonly enablePRAutoMerge: boolean; ``` - *Type:* boolean - *Default:* true for private projects, false otherwise Whether to enable the auto merge workflow for PRs. This will enable the auto merge workflow as well as the merge queue --- ##### `ghAutoMergeOptions`^Optional ```typescript public readonly ghAutoMergeOptions: AutoQueueOptions; ``` - *Type:* projen.github.AutoQueueOptions - *Default:* default options Options for the GitHub auto merge workflow. That is the workflow that turns on auto merge on all PRs. --- ##### `private`^Optional ```typescript public readonly private: boolean; ``` - *Type:* boolean - *Default:* true Whether or not this package is private. Setting this variable to true means that your project is created with sane defaults for private repositories. --- ##### `setNodeEngineVersion`^Optional ```typescript public readonly setNodeEngineVersion: boolean; ``` - *Type:* boolean - *Default:* true Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. --- ##### `tenancy`^Optional ```typescript public readonly tenancy: OrgTenancy; ``` - *Type:* OrgTenancy - *Default:* Auto detected from package name The organization this project is part of. --- ##### `upgradeCdklabsProjenProjectTypes`^Optional ```typescript public readonly upgradeCdklabsProjenProjectTypes: boolean; ``` - *Type:* boolean - *Default:* true Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. --- ##### `upgradeRuntimeDepsAsFix`^Optional ```typescript public readonly upgradeRuntimeDepsAsFix: boolean; ``` - *Type:* boolean - *Default:* true Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. --- ### CdkConstructLibraryOptions CdkConstructLibraryOptions. #### Initializer ```typescript import { CdkConstructLibraryOptions } from 'cdklabs-projen-project-types' const cdkConstructLibraryOptions: CdkConstructLibraryOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | author | string | The name of the library author. | | authorAddress | string | Email or URL of the library author. | | cdkVersion | string | Minimum version of the AWS CDK to depend on. | | defaultReleaseBranch | string | The name of the main release branch. | | name | string | This is the name of your project. | | addPackageManagerToDevEngines | boolean | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | artifactsDirectory | string | A directory which will contain build artifacts. | | auditDeps | boolean | Run security audit on dependencies. | | auditDepsOptions | projen.javascript.AuditOptions | Security audit options. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). | | autoDetectBin | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | biome | boolean | Setup Biome. | | biomeOptions | projen.javascript.BiomeOptions | Biome options. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowOptions | projen.javascript.BuildWorkflowOptions | Options for PR build workflow. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bumpPackage | string | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | bunVersion | string | The version of Bun to use if using Bun as a package manager. | | catalog | projen.cdk.Catalog | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. | | cdkAssert | boolean | Warning: NodeJS only. | | cdkAssertions | boolean | Install the assertions library? | | cdkCliVersion | string | Version range of the AWS CDK CLI to depend on. | | cdkDependencies | string[] | Which AWS CDKv1 modules this project requires. | | cdkDependenciesAsDeps | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdkTestDependencies | string[] | AWS CDK modules required for testing. | | cdkVersionPinning | boolean | Use pinned version instead of caret version for CDK. | | checkLicenses | projen.javascript.LicenseCheckerOptions | Configure which licenses should be deemed acceptable for use by dependencies. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | 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. | | commitGenerated | boolean | Whether to commit the managed files by default. | | compat | boolean | Automatically run API compatibility test against the latest version published to npm after compilation. | | compatIgnore | string | Name of the ignore file for API compatibility tests. | | compressAssembly | boolean | Emit a compressed version of the assembly. | | constructsVersion | string | Minimum version of the `constructs` library to depend on. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | deleteOrphanedLockFiles | boolean | Automatically delete lockfiles from package managers that are not the active one. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | deps | string[] | Runtime dependencies of this module. | | depsUpgrade | boolean | Use tasks and github workflows to handle dependency upgrades. | | depsUpgradeOptions | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | devDeps | string[] | Build dependencies for this module. | | devEngines | projen.javascript.DevEngines | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docgenFilePath | string | File path for generated docs. | | docsDirectory | string | Docs directory. | | dotnet | projen.cdk.JsiiDotNetTarget | *No description.* | | edgeLambdaAutoDiscover | boolean | Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. | | enablePRAutoMerge | boolean | Whether to enable the auto merge workflow for PRs. | | entrypoint | string | Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | excludeTypescript | string[] | Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input. | | experimentalIntegRunner | boolean | Enable experimental support for the AWS CDK integ-runner. | | ghAutoMergeOptions | projen.github.AutoQueueOptions | Options for the GitHub auto merge workflow. | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitignore | string[] | Additional entries to .gitignore. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | gitpod | boolean | Add a Gitpod development environment. | | homepage | string | Package's Homepage / Website. | | integrationTestAutoDiscover | boolean | Automatically discovers and creates integration tests for each `.integ.ts` file under your test directory. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | jsiiVersion | string | Version of the jsii compiler to use. | | keywords | string[] | Keywords to include in `package.json`. | | lambdaAutoDiscover | boolean | Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler. | | lambdaExtensionAutoDiscover | boolean | Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. | | lambdaOptions | projen.awscdk.LambdaFunctionCommonOptions | Common options for all AWS Lambda functions. | | libdir | string | Typescript artifacts output directory. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | majorVersion | number | Major version to release from the default branch. | | maxNodeVersion | string | The maximum node version supported by this package. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | minMajorVersion | number | Minimal Major version to release. | | minNodeVersion | string | Minimum Node.js version to require via package.json `engines` (inclusive). | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | nextVersionCommand | string | A shell command to control the next version to release. | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | 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. | | 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. | | outdir | string | The root directory of the project. Relative to this directory, all files are synthesized. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | 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"). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | private | boolean | Whether or not this package is private. | | projectTree | boolean | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | 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. | | 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. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | projenVersion | string | Version of projen to install. | | 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. | | publishToGo | projen.cdk.JsiiGoTarget | Publish Go bindings to a git repository. | | publishToMaven | projen.cdk.JsiiJavaTarget | Publish to maven. | | publishToNuget | projen.cdk.JsiiDotNetTarget | Publish to NuGet. | | publishToPypi | projen.cdk.JsiiPythonTarget | Publish to pypi. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | python | projen.cdk.JsiiPythonTarget | *No description.* | | readme | projen.SampleReadmeProps | The README setup. | | releasableCommits | projen.ReleasableCommits | Find commits that should be considered releasable Used to decide if a release is required. | | release | boolean | Add release management to this project. | | 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. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | 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. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | repository | string | *No description.* | | 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. | | repositoryUrl | string | *No description.* | | rootdir | string | *No description.* | | rosettaOptions | RosettaOptions | Options for rosetta:extract task. | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | setNodeEngineVersion | boolean | Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. | | singletonLambdaAutoDiscover | boolean | Automatically adds an `awscdk.SingletonFunction` for each `.singleton-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. | | srcdir | string | Typescript sources directory. | | stability | string | Package's Stability. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | tenancy | OrgTenancy | The organization this project is part of. | | testdir | string | Jest tests directory. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | tsJestOptions | projen.typescript.TsJestOptions | Options for ts-jest. | | typescriptVersion | string | TypeScript version to use. | | upgradeCdklabsProjenProjectTypes | boolean | Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. | | upgradeRuntimeDepsAsFix | boolean | Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with commit-and-tag-version package. | | vscode | boolean | Enable VSCode integration. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version to use in GitHub workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | workflowRunsOn | string[] | Github Runner selection labels. | | workflowRunsOnGroup | projen.GroupRunnerOptions | Github Runner Group selection options. | | yarnBerryOptions | projen.javascript.YarnBerryOptions | Options for Yarn Berry. | --- ##### `author`^Required ```typescript public readonly author: string; ``` - *Type:* string - *Default:* $GIT_USER_NAME The name of the library author. --- ##### `authorAddress`^Required ```typescript public readonly authorAddress: string; ``` - *Type:* string - *Default:* $GIT_USER_EMAIL Email or URL of the library author. --- ##### `cdkVersion`^Required ```typescript public readonly cdkVersion: string; ``` - *Type:* string - *Default:* "2.189.1" Minimum version of the AWS CDK to depend on. --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `addPackageManagerToDevEngines`^Optional ```typescript public readonly addPackageManagerToDevEngines: boolean; ``` - *Type:* boolean - *Default:* true Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. --- ##### `allowLibraryDependencies`^Optional ```typescript 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. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `auditDeps`^Optional ```typescript 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 ```typescript public readonly auditDepsOptions: AuditOptions; ``` - *Type:* projen.javascript.AuditOptions - *Default:* default options Security audit options. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `autoDetectBin`^Optional ```typescript 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. --- ##### `autoMerge`^Optional ```typescript 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 ```typescript 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. --- ##### `bin`^Optional ```typescript 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. --- ##### `biome`^Optional ```typescript public readonly biome: boolean; ``` - *Type:* boolean - *Default:* false Setup Biome. --- ##### `biomeOptions`^Optional ```typescript public readonly biomeOptions: BiomeOptions; ``` - *Type:* projen.javascript.BiomeOptions - *Default:* default options Biome options. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowOptions`^Optional ```typescript public readonly buildWorkflowOptions: BuildWorkflowOptions; ``` - *Type:* projen.javascript.BuildWorkflowOptions Options for PR build workflow. --- ##### ~~`buildWorkflowTriggers`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers` ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bumpPackage`^Optional ```typescript 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`. --- ##### `bundledDeps`^Optional ```typescript 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 `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `bunVersion`^Optional ```typescript public readonly bunVersion: string; ``` - *Type:* string - *Default:* "latest" The version of Bun to use if using Bun as a package manager. --- ##### `catalog`^Optional ```typescript public readonly catalog: Catalog; ``` - *Type:* projen.cdk.Catalog - *Default:* new version will be announced Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION The catalog will also post a tweet to https://twitter.com/awscdkio with the package name, description and the above link. You can disable these tweets through `{ announce: false }`. You can also add a Twitter handle through `{ twitter: 'xx' }` which will be mentioned in the tweet. --- ##### ~~`cdkAssert`~~^Optional - *Deprecated:* The ```typescript public readonly cdkAssert: boolean; ``` - *Type:* boolean - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdkAssertions`^Optional ```typescript public readonly cdkAssertions: boolean; ``` - *Type:* boolean - *Default:* will be included by default for AWS CDK >= 1.111.0 < 2.0.0 Install the assertions library? Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib' --- ##### `cdkCliVersion`^Optional ```typescript public readonly cdkCliVersion: string; ``` - *Type:* string - *Default:* "^2" Version range of the AWS CDK CLI to depend on. Can be either a specific version, or an NPM version range. By default, the latest 2.x version will be installed; you can use this option to restrict it to a specific version or version range. --- ##### ~~`cdkDependencies`~~^Optional - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library) ```typescript public readonly cdkDependencies: string[]; ``` - *Type:* string[] Which AWS CDKv1 modules this project requires. --- ##### ~~`cdkDependenciesAsDeps`~~^Optional - *Deprecated:* Not supported in CDK v2. ```typescript public readonly cdkDependenciesAsDeps: boolean; ``` - *Type:* boolean - *Default:* true If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). This is to ensure that downstream consumers actually have your CDK dependencies installed when using npm < 7 or yarn, where peer dependencies are not automatically installed. If this is disabled, `cdkDependencies` will be added to `devDependencies` to ensure they are present during development. Note: this setting only applies to construct library projects --- ##### ~~`cdkTestDependencies`~~^Optional - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead ```typescript public readonly cdkTestDependencies: string[]; ``` - *Type:* string[] AWS CDK modules required for testing. --- ##### `cdkVersionPinning`^Optional ```typescript public readonly cdkVersionPinning: boolean; ``` - *Type:* boolean Use pinned version instead of caret version for CDK. You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes. --- ##### `checkLicenses`^Optional ```typescript public readonly checkLicenses: LicenseCheckerOptions; ``` - *Type:* projen.javascript.LicenseCheckerOptions - *Default:* no license checks are run during the build and all licenses will be accepted Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `codeCov`^Optional ```typescript 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 ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* OIDC auth is used Define the secret name for a specified https://codecov.io/ token. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `compat`^Optional ```typescript public readonly compat: boolean; ``` - *Type:* boolean - *Default:* false Automatically run API compatibility test against the latest version published to npm after compilation. You can manually run compatibility tests using `yarn compat` if this feature is disabled. - You can ignore compatibility failures by adding lines to a ".compatignore" file. --- ##### `compatIgnore`^Optional ```typescript public readonly compatIgnore: string; ``` - *Type:* string - *Default:* ".compatignore" Name of the ignore file for API compatibility tests. --- ##### `compressAssembly`^Optional ```typescript public readonly compressAssembly: boolean; ``` - *Type:* boolean - *Default:* false Emit a compressed version of the assembly. --- ##### `constructsVersion`^Optional ```typescript public readonly constructsVersion: string; ``` - *Type:* string - *Default:* for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.5.1". Minimum version of the `constructs` library to depend on. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `deleteOrphanedLockFiles`^Optional ```typescript public readonly deleteOrphanedLockFiles: boolean; ``` - *Type:* boolean - *Default:* true Automatically delete lockfiles from package managers that are not the active one. Only triggered when the lockfile for the configured package manager already exists. This is useful when migrating between package managers to avoid conflicts. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* `true` for root projects, `false` for subprojects Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `description`^Optional ```typescript 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 --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `devEngines`^Optional ```typescript public readonly devEngines: DevEngines; ``` - *Type:* projen.javascript.DevEngines Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docgenFilePath`^Optional ```typescript public readonly docgenFilePath: string; ``` - *Type:* string - *Default:* "API.md" File path for generated docs. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### ~~`dotnet`~~^Optional - *Deprecated:* use `publishToNuget` ```typescript public readonly dotnet: JsiiDotNetTarget; ``` - *Type:* projen.cdk.JsiiDotNetTarget --- ##### `edgeLambdaAutoDiscover`^Optional ```typescript public readonly edgeLambdaAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. --- ##### `enablePRAutoMerge`^Optional ```typescript public readonly enablePRAutoMerge: boolean; ``` - *Type:* boolean - *Default:* true for private projects, false otherwise Whether to enable the auto merge workflow for PRs. This will enable the auto merge workflow as well as the merge queue --- ##### `entrypoint`^Optional ```typescript 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. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true, unless biome is enabled Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `excludeTypescript`^Optional ```typescript public readonly excludeTypescript: string[]; ``` - *Type:* string[] Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input. By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input. This can be problematic for example when the package's build or test procedure generates .ts files that cannot be compiled with jsii's compiler settings. --- ##### `experimentalIntegRunner`^Optional ```typescript public readonly experimentalIntegRunner: boolean; ``` - *Type:* boolean - *Default:* false Enable experimental support for the AWS CDK integ-runner. --- ##### `ghAutoMergeOptions`^Optional ```typescript public readonly ghAutoMergeOptions: AutoQueueOptions; ``` - *Type:* projen.github.AutoQueueOptions - *Default:* default options Options for the GitHub auto merge workflow. That is the workflow that turns on auto merge on all PRs. --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `integrationTestAutoDiscover`^Optional ```typescript public readonly integrationTestAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true Automatically discovers and creates integration tests for each `.integ.ts` file under your test directory. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `jsiiVersion`^Optional ```typescript public readonly jsiiVersion: string; ``` - *Type:* string - *Default:* "~5.9.0" Version of the jsii compiler to use. Set to "*" if you want to manually manage the version of jsii in your project by managing updates to `package.json` on your own. NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~5.0.0`). --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `lambdaAutoDiscover`^Optional ```typescript public readonly lambdaAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler. --- ##### `lambdaExtensionAutoDiscover`^Optional ```typescript public readonly lambdaExtensionAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. --- ##### `lambdaOptions`^Optional ```typescript public readonly lambdaOptions: LambdaFunctionCommonOptions; ``` - *Type:* projen.awscdk.LambdaFunctionCommonOptions - *Default:* default options Common options for all AWS Lambda functions. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `license`^Optional ```typescript 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 ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `majorVersion`^Optional ```typescript 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. --- ##### `maxNodeVersion`^Optional ```typescript 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. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript 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 ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### `minMajorVersion`^Optional ```typescript 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`. --- ##### `minNodeVersion`^Optional ```typescript public readonly minNodeVersion: string; ``` - *Type:* string - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). Only set this if your package will not work properly on specific (older?) Node versions. --- ##### ~~`mutableBuild`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild` ```typescript 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. --- ##### `nextVersionCommand`^Optional ```typescript 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`. --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### `npmDistTag`^Optional ```typescript 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. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript 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 ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `npmProvenance`^Optional ```typescript 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. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript 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 ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `npmTrustedPublishing`^Optional ```typescript 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. --- ##### `outdir`^Optional ```typescript 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. --- ##### `package`^Optional ```typescript 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`). --- ##### `packageManager`^Optional ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails. The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript 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 ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "10.33.0" The version of PNPM to use if using PNPM as a package manager. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `private`^Optional ```typescript public readonly private: boolean; ``` - *Type:* boolean - *Default:* true Whether or not this package is private. Setting this variable to true means that your project is created with sane defaults for private repositories. --- ##### `projectTree`^Optional ```typescript public readonly projectTree: boolean; ``` - *Type:* boolean - *Default:* false Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCommand`^Optional ```typescript 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. --- ##### `projenCredentials`^Optional ```typescript 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. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript 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. --- ##### `projenrcJson`^Optional ```typescript 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 ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript 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. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript 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. --- ##### `publishToGo`^Optional ```typescript public readonly publishToGo: JsiiGoTarget; ``` - *Type:* projen.cdk.JsiiGoTarget - *Default:* no publishing Publish Go bindings to a git repository. --- ##### `publishToMaven`^Optional ```typescript public readonly publishToMaven: JsiiJavaTarget; ``` - *Type:* projen.cdk.JsiiJavaTarget - *Default:* no publishing Publish to maven. --- ##### `publishToNuget`^Optional ```typescript public readonly publishToNuget: JsiiDotNetTarget; ``` - *Type:* projen.cdk.JsiiDotNetTarget - *Default:* no publishing Publish to NuGet. --- ##### `publishToPypi`^Optional ```typescript public readonly publishToPypi: JsiiPythonTarget; ``` - *Type:* projen.cdk.JsiiPythonTarget - *Default:* no publishing Publish to pypi. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### ~~`python`~~^Optional - *Deprecated:* use `publishToPyPi` ```typescript public readonly python: JsiiPythonTarget; ``` - *Type:* projen.cdk.JsiiPythonTarget --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- ##### `releasableCommits`^Optional ```typescript 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. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseBranches`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript 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 ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript 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. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `releaseWorkflowEnv`^Optional ```typescript public readonly releaseWorkflowEnv: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Build environment variables for release workflows. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string - *Default:* generated from org tenancy and package name --- ##### `repositoryDirectory`^Optional ```typescript 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. --- ##### ~~`repositoryUrl`~~^Optional - *Deprecated:* use `repository` ```typescript public readonly repositoryUrl: string; ``` - *Type:* string - *Default:* generated from org tenancy and package name --- ##### `rootdir`^Optional ```typescript public readonly rootdir: string; ``` - *Type:* string - *Default:* "." --- ##### `rosettaOptions`^Optional ```typescript public readonly rosettaOptions: RosettaOptions; ``` - *Type:* RosettaOptions Options for rosetta:extract task. --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `scopedPackagesOptions`^Optional ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript 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. --- ##### `setNodeEngineVersion`^Optional ```typescript public readonly setNodeEngineVersion: boolean; ``` - *Type:* boolean - *Default:* true Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. --- ##### `singletonLambdaAutoDiscover`^Optional ```typescript public readonly singletonLambdaAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true Automatically adds an `awscdk.SingletonFunction` for each `.singleton-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript 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`. --- ##### `tenancy`^Optional ```typescript public readonly tenancy: OrgTenancy; ``` - *Type:* OrgTenancy - *Default:* Auto detected from package name The organization this project is part of. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `tsJestOptions`^Optional ```typescript public readonly tsJestOptions: TsJestOptions; ``` - *Type:* projen.typescript.TsJestOptions Options for ts-jest. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `upgradeCdklabsProjenProjectTypes`^Optional ```typescript public readonly upgradeCdklabsProjenProjectTypes: boolean; ``` - *Type:* boolean - *Default:* true Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. --- ##### `upgradeRuntimeDepsAsFix`^Optional ```typescript public readonly upgradeRuntimeDepsAsFix: boolean; ``` - *Type:* boolean - *Default:* true Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. --- ##### `versionrcOptions`^Optional ```typescript 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. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `workflowBootstrapSteps`^Optional ```typescript 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. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* default GitHub Actions user The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript public readonly workflowNodeVersion: string; ``` - *Type:* string - *Default:* 'lts/*' The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `workflowRunsOnGroup`^Optional ```typescript public readonly workflowRunsOnGroup: GroupRunnerOptions; ``` - *Type:* projen.GroupRunnerOptions Github Runner Group selection options. --- ##### `yarnBerryOptions`^Optional ```typescript public readonly yarnBerryOptions: YarnBerryOptions; ``` - *Type:* projen.javascript.YarnBerryOptions - *Default:* Yarn Berry v4 with all default options Options for Yarn Berry. --- ### CdkJsiiProjectOptions CdkJsiiProjectOptions. #### Initializer ```typescript import { CdkJsiiProjectOptions } from 'cdklabs-projen-project-types' const cdkJsiiProjectOptions: CdkJsiiProjectOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | author | string | The name of the library author. | | authorAddress | string | Email or URL of the library author. | | defaultReleaseBranch | string | The name of the main release branch. | | name | string | This is the name of your project. | | addPackageManagerToDevEngines | boolean | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | artifactsDirectory | string | A directory which will contain build artifacts. | | auditDeps | boolean | Run security audit on dependencies. | | auditDepsOptions | projen.javascript.AuditOptions | Security audit options. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). | | autoDetectBin | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | biome | boolean | Setup Biome. | | biomeOptions | projen.javascript.BiomeOptions | Biome options. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowOptions | projen.javascript.BuildWorkflowOptions | Options for PR build workflow. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bumpPackage | string | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | bunVersion | string | The version of Bun to use if using Bun as a package manager. | | checkLicenses | projen.javascript.LicenseCheckerOptions | Configure which licenses should be deemed acceptable for use by dependencies. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | 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. | | commitGenerated | boolean | Whether to commit the managed files by default. | | compat | boolean | Automatically run API compatibility test against the latest version published to npm after compilation. | | compatIgnore | string | Name of the ignore file for API compatibility tests. | | compressAssembly | boolean | Emit a compressed version of the assembly. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | deleteOrphanedLockFiles | boolean | Automatically delete lockfiles from package managers that are not the active one. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | deps | string[] | Runtime dependencies of this module. | | depsUpgrade | boolean | Use tasks and github workflows to handle dependency upgrades. | | depsUpgradeOptions | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | devDeps | string[] | Build dependencies for this module. | | devEngines | projen.javascript.DevEngines | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docgenFilePath | string | File path for generated docs. | | docsDirectory | string | Docs directory. | | dotnet | projen.cdk.JsiiDotNetTarget | *No description.* | | enablePRAutoMerge | boolean | Whether to enable the auto merge workflow for PRs. | | entrypoint | string | Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | excludeTypescript | string[] | Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input. | | ghAutoMergeOptions | projen.github.AutoQueueOptions | Options for the GitHub auto merge workflow. | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitignore | string[] | Additional entries to .gitignore. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | gitpod | boolean | Add a Gitpod development environment. | | homepage | string | Package's Homepage / Website. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | jsiiVersion | string | Version of the jsii compiler to use. | | keywords | string[] | Keywords to include in `package.json`. | | libdir | string | Typescript artifacts output directory. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | majorVersion | number | Major version to release from the default branch. | | maxNodeVersion | string | The maximum node version supported by this package. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | minMajorVersion | number | Minimal Major version to release. | | minNodeVersion | string | The minimum node version required by this package to function. | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | nextVersionCommand | string | A shell command to control the next version to release. | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | 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. | | 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. | | outdir | string | The root directory of the project. Relative to this directory, all files are synthesized. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | 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"). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | private | boolean | Whether or not this package is private. | | projectTree | boolean | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | 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. | | 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. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | projenVersion | string | Version of projen to install. | | 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. | | publishToGo | projen.cdk.JsiiGoTarget | Publish Go bindings to a git repository. | | publishToMaven | projen.cdk.JsiiJavaTarget | Publish to maven. | | publishToNuget | projen.cdk.JsiiDotNetTarget | Publish to NuGet. | | publishToPypi | projen.cdk.JsiiPythonTarget | Publish to pypi. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | python | projen.cdk.JsiiPythonTarget | *No description.* | | readme | projen.SampleReadmeProps | The README setup. | | releasableCommits | projen.ReleasableCommits | Find commits that should be considered releasable Used to decide if a release is required. | | release | boolean | Add release management to this project. | | 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. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | 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. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | repository | string | *No description.* | | 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. | | repositoryUrl | string | *No description.* | | rootdir | string | *No description.* | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | setNodeEngineVersion | boolean | Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. | | srcdir | string | Typescript sources directory. | | stability | string | Package's Stability. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | tenancy | OrgTenancy | The organization this project is part of. | | testdir | string | Jest tests directory. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | tsJestOptions | projen.typescript.TsJestOptions | Options for ts-jest. | | typescriptVersion | string | TypeScript version to use. | | upgradeCdklabsProjenProjectTypes | boolean | Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. | | upgradeRuntimeDepsAsFix | boolean | Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with commit-and-tag-version package. | | vscode | boolean | Enable VSCode integration. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | 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. | | workflowRunsOn | string[] | Github Runner selection labels. | | workflowRunsOnGroup | projen.GroupRunnerOptions | Github Runner Group selection options. | | yarnBerryOptions | projen.javascript.YarnBerryOptions | Options for Yarn Berry. | --- ##### `author`^Required ```typescript public readonly author: string; ``` - *Type:* string - *Default:* $GIT_USER_NAME The name of the library author. --- ##### `authorAddress`^Required ```typescript public readonly authorAddress: string; ``` - *Type:* string - *Default:* $GIT_USER_EMAIL Email or URL of the library author. --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `addPackageManagerToDevEngines`^Optional ```typescript public readonly addPackageManagerToDevEngines: boolean; ``` - *Type:* boolean - *Default:* true Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. --- ##### `allowLibraryDependencies`^Optional ```typescript 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. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `auditDeps`^Optional ```typescript 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 ```typescript public readonly auditDepsOptions: AuditOptions; ``` - *Type:* projen.javascript.AuditOptions - *Default:* default options Security audit options. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `autoDetectBin`^Optional ```typescript 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. --- ##### `autoMerge`^Optional ```typescript 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 ```typescript 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. --- ##### `bin`^Optional ```typescript 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. --- ##### `biome`^Optional ```typescript public readonly biome: boolean; ``` - *Type:* boolean - *Default:* false Setup Biome. --- ##### `biomeOptions`^Optional ```typescript public readonly biomeOptions: BiomeOptions; ``` - *Type:* projen.javascript.BiomeOptions - *Default:* default options Biome options. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowOptions`^Optional ```typescript public readonly buildWorkflowOptions: BuildWorkflowOptions; ``` - *Type:* projen.javascript.BuildWorkflowOptions Options for PR build workflow. --- ##### ~~`buildWorkflowTriggers`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers` ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bumpPackage`^Optional ```typescript 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`. --- ##### `bundledDeps`^Optional ```typescript 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 `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `bunVersion`^Optional ```typescript public readonly bunVersion: string; ``` - *Type:* string - *Default:* "latest" The version of Bun to use if using Bun as a package manager. --- ##### `checkLicenses`^Optional ```typescript public readonly checkLicenses: LicenseCheckerOptions; ``` - *Type:* projen.javascript.LicenseCheckerOptions - *Default:* no license checks are run during the build and all licenses will be accepted Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `codeCov`^Optional ```typescript 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 ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* OIDC auth is used Define the secret name for a specified https://codecov.io/ token. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `compat`^Optional ```typescript public readonly compat: boolean; ``` - *Type:* boolean - *Default:* false Automatically run API compatibility test against the latest version published to npm after compilation. You can manually run compatibility tests using `yarn compat` if this feature is disabled. - You can ignore compatibility failures by adding lines to a ".compatignore" file. --- ##### `compatIgnore`^Optional ```typescript public readonly compatIgnore: string; ``` - *Type:* string - *Default:* ".compatignore" Name of the ignore file for API compatibility tests. --- ##### `compressAssembly`^Optional ```typescript public readonly compressAssembly: boolean; ``` - *Type:* boolean - *Default:* false Emit a compressed version of the assembly. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `deleteOrphanedLockFiles`^Optional ```typescript public readonly deleteOrphanedLockFiles: boolean; ``` - *Type:* boolean - *Default:* true Automatically delete lockfiles from package managers that are not the active one. Only triggered when the lockfile for the configured package manager already exists. This is useful when migrating between package managers to avoid conflicts. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* `true` for root projects, `false` for subprojects Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `description`^Optional ```typescript 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 --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `devEngines`^Optional ```typescript public readonly devEngines: DevEngines; ``` - *Type:* projen.javascript.DevEngines Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docgenFilePath`^Optional ```typescript public readonly docgenFilePath: string; ``` - *Type:* string - *Default:* "API.md" File path for generated docs. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### ~~`dotnet`~~^Optional - *Deprecated:* use `publishToNuget` ```typescript public readonly dotnet: JsiiDotNetTarget; ``` - *Type:* projen.cdk.JsiiDotNetTarget --- ##### `enablePRAutoMerge`^Optional ```typescript public readonly enablePRAutoMerge: boolean; ``` - *Type:* boolean - *Default:* true for private projects, false otherwise Whether to enable the auto merge workflow for PRs. This will enable the auto merge workflow as well as the merge queue --- ##### `entrypoint`^Optional ```typescript 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. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true, unless biome is enabled Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `excludeTypescript`^Optional ```typescript public readonly excludeTypescript: string[]; ``` - *Type:* string[] Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input. By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input. This can be problematic for example when the package's build or test procedure generates .ts files that cannot be compiled with jsii's compiler settings. --- ##### `ghAutoMergeOptions`^Optional ```typescript public readonly ghAutoMergeOptions: AutoQueueOptions; ``` - *Type:* projen.github.AutoQueueOptions - *Default:* default options Options for the GitHub auto merge workflow. That is the workflow that turns on auto merge on all PRs. --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `jsiiVersion`^Optional ```typescript public readonly jsiiVersion: string; ``` - *Type:* string - *Default:* "~5.9.0" Version of the jsii compiler to use. Set to "*" if you want to manually manage the version of jsii in your project by managing updates to `package.json` on your own. NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~5.0.0`). --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `license`^Optional ```typescript 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 ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `majorVersion`^Optional ```typescript 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. --- ##### `maxNodeVersion`^Optional ```typescript 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. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript 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 ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### `minMajorVersion`^Optional ```typescript 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`. --- ##### `minNodeVersion`^Optional ```typescript 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`. --- ##### ~~`mutableBuild`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild` ```typescript 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. --- ##### `nextVersionCommand`^Optional ```typescript 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`. --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### `npmDistTag`^Optional ```typescript 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. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript 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 ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `npmProvenance`^Optional ```typescript 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. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript 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 ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `npmTrustedPublishing`^Optional ```typescript 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. --- ##### `outdir`^Optional ```typescript 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. --- ##### `package`^Optional ```typescript 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`). --- ##### `packageManager`^Optional ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails. The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript 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 ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "10.33.0" The version of PNPM to use if using PNPM as a package manager. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `private`^Optional ```typescript public readonly private: boolean; ``` - *Type:* boolean - *Default:* true Whether or not this package is private. Setting this variable to true means that your project is created with sane defaults for private repositories. --- ##### `projectTree`^Optional ```typescript public readonly projectTree: boolean; ``` - *Type:* boolean - *Default:* false Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCommand`^Optional ```typescript 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. --- ##### `projenCredentials`^Optional ```typescript 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. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript 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. --- ##### `projenrcJson`^Optional ```typescript 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 ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript 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. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript 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. --- ##### `publishToGo`^Optional ```typescript public readonly publishToGo: JsiiGoTarget; ``` - *Type:* projen.cdk.JsiiGoTarget - *Default:* no publishing Publish Go bindings to a git repository. --- ##### `publishToMaven`^Optional ```typescript public readonly publishToMaven: JsiiJavaTarget; ``` - *Type:* projen.cdk.JsiiJavaTarget - *Default:* no publishing Publish to maven. --- ##### `publishToNuget`^Optional ```typescript public readonly publishToNuget: JsiiDotNetTarget; ``` - *Type:* projen.cdk.JsiiDotNetTarget - *Default:* no publishing Publish to NuGet. --- ##### `publishToPypi`^Optional ```typescript public readonly publishToPypi: JsiiPythonTarget; ``` - *Type:* projen.cdk.JsiiPythonTarget - *Default:* no publishing Publish to pypi. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### ~~`python`~~^Optional - *Deprecated:* use `publishToPyPi` ```typescript public readonly python: JsiiPythonTarget; ``` - *Type:* projen.cdk.JsiiPythonTarget --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- ##### `releasableCommits`^Optional ```typescript 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. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseBranches`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript 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 ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript 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. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `releaseWorkflowEnv`^Optional ```typescript public readonly releaseWorkflowEnv: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Build environment variables for release workflows. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string - *Default:* generated from org tenancy and package name --- ##### `repositoryDirectory`^Optional ```typescript 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. --- ##### ~~`repositoryUrl`~~^Optional - *Deprecated:* use `repository` ```typescript public readonly repositoryUrl: string; ``` - *Type:* string - *Default:* generated from org tenancy and package name --- ##### `rootdir`^Optional ```typescript public readonly rootdir: string; ``` - *Type:* string - *Default:* "." --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `scopedPackagesOptions`^Optional ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript 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. --- ##### `setNodeEngineVersion`^Optional ```typescript public readonly setNodeEngineVersion: boolean; ``` - *Type:* boolean - *Default:* true Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript 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`. --- ##### `tenancy`^Optional ```typescript public readonly tenancy: OrgTenancy; ``` - *Type:* OrgTenancy - *Default:* Auto detected from package name The organization this project is part of. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `tsJestOptions`^Optional ```typescript public readonly tsJestOptions: TsJestOptions; ``` - *Type:* projen.typescript.TsJestOptions Options for ts-jest. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `upgradeCdklabsProjenProjectTypes`^Optional ```typescript public readonly upgradeCdklabsProjenProjectTypes: boolean; ``` - *Type:* boolean - *Default:* true Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. --- ##### `upgradeRuntimeDepsAsFix`^Optional ```typescript public readonly upgradeRuntimeDepsAsFix: boolean; ``` - *Type:* boolean - *Default:* true Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. --- ##### `versionrcOptions`^Optional ```typescript 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. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `workflowBootstrapSteps`^Optional ```typescript 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. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* default GitHub Actions user The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript 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 ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `workflowRunsOnGroup`^Optional ```typescript public readonly workflowRunsOnGroup: GroupRunnerOptions; ``` - *Type:* projen.GroupRunnerOptions Github Runner Group selection options. --- ##### `yarnBerryOptions`^Optional ```typescript public readonly yarnBerryOptions: YarnBerryOptions; ``` - *Type:* projen.javascript.YarnBerryOptions - *Default:* Yarn Berry v4 with all default options Options for Yarn Berry. --- ### CdklabsConstructLibraryOptions #### Initializer ```typescript import { CdklabsConstructLibraryOptions } from 'cdklabs-projen-project-types' const cdklabsConstructLibraryOptions: CdklabsConstructLibraryOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | author | string | The name of the library author. | | authorAddress | string | Email or URL of the library author. | | cdkVersion | string | Minimum version of the AWS CDK to depend on. | | defaultReleaseBranch | string | The name of the main release branch. | | name | string | This is the name of your project. | | addPackageManagerToDevEngines | boolean | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | artifactsDirectory | string | A directory which will contain build artifacts. | | auditDeps | boolean | Run security audit on dependencies. | | auditDepsOptions | projen.javascript.AuditOptions | Security audit options. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). | | autoDetectBin | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | biome | boolean | Setup Biome. | | biomeOptions | projen.javascript.BiomeOptions | Biome options. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowOptions | projen.javascript.BuildWorkflowOptions | Options for PR build workflow. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bumpPackage | string | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | bunVersion | string | The version of Bun to use if using Bun as a package manager. | | catalog | projen.cdk.Catalog | Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. | | cdkAssert | boolean | Warning: NodeJS only. | | cdkAssertions | boolean | Install the assertions library? | | cdkCliVersion | string | Version range of the AWS CDK CLI to depend on. | | cdkDependencies | string[] | Which AWS CDKv1 modules this project requires. | | cdkDependenciesAsDeps | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). | | cdkTestDependencies | string[] | AWS CDK modules required for testing. | | cdkVersionPinning | boolean | Use pinned version instead of caret version for CDK. | | checkLicenses | projen.javascript.LicenseCheckerOptions | Configure which licenses should be deemed acceptable for use by dependencies. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | 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. | | commitGenerated | boolean | Whether to commit the managed files by default. | | compat | boolean | Automatically run API compatibility test against the latest version published to npm after compilation. | | compatIgnore | string | Name of the ignore file for API compatibility tests. | | compressAssembly | boolean | Emit a compressed version of the assembly. | | constructsVersion | string | Minimum version of the `constructs` library to depend on. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | deleteOrphanedLockFiles | boolean | Automatically delete lockfiles from package managers that are not the active one. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | deps | string[] | Runtime dependencies of this module. | | depsUpgrade | boolean | Use tasks and github workflows to handle dependency upgrades. | | depsUpgradeOptions | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | devDeps | string[] | Build dependencies for this module. | | devEngines | projen.javascript.DevEngines | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docgenFilePath | string | File path for generated docs. | | docsDirectory | string | Docs directory. | | dotnet | projen.cdk.JsiiDotNetTarget | *No description.* | | edgeLambdaAutoDiscover | boolean | Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. | | enablePRAutoMerge | boolean | Whether to enable the auto merge workflow for PRs. | | entrypoint | string | Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | excludeTypescript | string[] | Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input. | | experimentalIntegRunner | boolean | Enable experimental support for the AWS CDK integ-runner. | | ghAutoMergeOptions | projen.github.AutoQueueOptions | Options for the GitHub auto merge workflow. | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitignore | string[] | Additional entries to .gitignore. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | gitpod | boolean | Add a Gitpod development environment. | | homepage | string | Package's Homepage / Website. | | integrationTestAutoDiscover | boolean | Automatically discovers and creates integration tests for each `.integ.ts` file under your test directory. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | jsiiVersion | string | Version of the jsii compiler to use. | | keywords | string[] | Keywords to include in `package.json`. | | lambdaAutoDiscover | boolean | Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler. | | lambdaExtensionAutoDiscover | boolean | Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. | | lambdaOptions | projen.awscdk.LambdaFunctionCommonOptions | Common options for all AWS Lambda functions. | | libdir | string | Typescript artifacts output directory. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | majorVersion | number | Major version to release from the default branch. | | maxNodeVersion | string | The maximum node version supported by this package. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | minMajorVersion | number | Minimal Major version to release. | | minNodeVersion | string | Minimum Node.js version to require via package.json `engines` (inclusive). | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | nextVersionCommand | string | A shell command to control the next version to release. | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | 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. | | 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. | | outdir | string | The root directory of the project. Relative to this directory, all files are synthesized. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | 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"). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | private | boolean | Whether or not this package is private. | | projectTree | boolean | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | 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. | | 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. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | projenVersion | string | Version of projen to install. | | 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. | | publishToGo | projen.cdk.JsiiGoTarget | Publish Go bindings to a git repository. | | publishToMaven | projen.cdk.JsiiJavaTarget | Publish to maven. | | publishToNuget | projen.cdk.JsiiDotNetTarget | Publish to NuGet. | | publishToPypi | projen.cdk.JsiiPythonTarget | Publish to pypi. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | python | projen.cdk.JsiiPythonTarget | *No description.* | | readme | projen.SampleReadmeProps | The README setup. | | releasableCommits | projen.ReleasableCommits | Find commits that should be considered releasable Used to decide if a release is required. | | release | boolean | Add release management to this project. | | 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. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | 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. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | repository | string | *No description.* | | 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. | | repositoryUrl | string | *No description.* | | rootdir | string | *No description.* | | rosettaOptions | RosettaOptions | Options for rosetta:extract task. | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | setNodeEngineVersion | boolean | Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. | | singletonLambdaAutoDiscover | boolean | Automatically adds an `awscdk.SingletonFunction` for each `.singleton-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. | | srcdir | string | Typescript sources directory. | | stability | string | Package's Stability. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | tenancy | OrgTenancy | The organization this project is part of. | | testdir | string | Jest tests directory. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | tsJestOptions | projen.typescript.TsJestOptions | Options for ts-jest. | | typescriptVersion | string | TypeScript version to use. | | upgradeCdklabsProjenProjectTypes | boolean | Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. | | upgradeRuntimeDepsAsFix | boolean | Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with commit-and-tag-version package. | | vscode | boolean | Enable VSCode integration. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version to use in GitHub workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | workflowRunsOn | string[] | Github Runner selection labels. | | workflowRunsOnGroup | projen.GroupRunnerOptions | Github Runner Group selection options. | | yarnBerryOptions | projen.javascript.YarnBerryOptions | Options for Yarn Berry. | | cdklabsPublishingDefaults | boolean | Set default publishing properties. | | jsiiTargetLanguages | JsiiLanguage[] | Specify specific languages to publish to. | --- ##### `author`^Required ```typescript public readonly author: string; ``` - *Type:* string - *Default:* $GIT_USER_NAME The name of the library author. --- ##### `authorAddress`^Required ```typescript public readonly authorAddress: string; ``` - *Type:* string - *Default:* $GIT_USER_EMAIL Email or URL of the library author. --- ##### `cdkVersion`^Required ```typescript public readonly cdkVersion: string; ``` - *Type:* string - *Default:* "2.189.1" Minimum version of the AWS CDK to depend on. --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `addPackageManagerToDevEngines`^Optional ```typescript public readonly addPackageManagerToDevEngines: boolean; ``` - *Type:* boolean - *Default:* true Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. --- ##### `allowLibraryDependencies`^Optional ```typescript 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. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `auditDeps`^Optional ```typescript 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 ```typescript public readonly auditDepsOptions: AuditOptions; ``` - *Type:* projen.javascript.AuditOptions - *Default:* default options Security audit options. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `autoDetectBin`^Optional ```typescript 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. --- ##### `autoMerge`^Optional ```typescript 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 ```typescript 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. --- ##### `bin`^Optional ```typescript 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. --- ##### `biome`^Optional ```typescript public readonly biome: boolean; ``` - *Type:* boolean - *Default:* false Setup Biome. --- ##### `biomeOptions`^Optional ```typescript public readonly biomeOptions: BiomeOptions; ``` - *Type:* projen.javascript.BiomeOptions - *Default:* default options Biome options. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowOptions`^Optional ```typescript public readonly buildWorkflowOptions: BuildWorkflowOptions; ``` - *Type:* projen.javascript.BuildWorkflowOptions Options for PR build workflow. --- ##### ~~`buildWorkflowTriggers`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers` ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bumpPackage`^Optional ```typescript 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`. --- ##### `bundledDeps`^Optional ```typescript 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 `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `bunVersion`^Optional ```typescript public readonly bunVersion: string; ``` - *Type:* string - *Default:* "latest" The version of Bun to use if using Bun as a package manager. --- ##### `catalog`^Optional ```typescript public readonly catalog: Catalog; ``` - *Type:* projen.cdk.Catalog - *Default:* new version will be announced Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION The catalog will also post a tweet to https://twitter.com/awscdkio with the package name, description and the above link. You can disable these tweets through `{ announce: false }`. You can also add a Twitter handle through `{ twitter: 'xx' }` which will be mentioned in the tweet. --- ##### ~~`cdkAssert`~~^Optional - *Deprecated:* The ```typescript public readonly cdkAssert: boolean; ``` - *Type:* boolean - *Default:* will be included by default for AWS CDK >= 1.0.0 < 2.0.0 Warning: NodeJS only. Install the --- ##### `cdkAssertions`^Optional ```typescript public readonly cdkAssertions: boolean; ``` - *Type:* boolean - *Default:* will be included by default for AWS CDK >= 1.111.0 < 2.0.0 Install the assertions library? Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib' --- ##### `cdkCliVersion`^Optional ```typescript public readonly cdkCliVersion: string; ``` - *Type:* string - *Default:* "^2" Version range of the AWS CDK CLI to depend on. Can be either a specific version, or an NPM version range. By default, the latest 2.x version will be installed; you can use this option to restrict it to a specific version or version range. --- ##### ~~`cdkDependencies`~~^Optional - *Deprecated:* For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library) ```typescript public readonly cdkDependencies: string[]; ``` - *Type:* string[] Which AWS CDKv1 modules this project requires. --- ##### ~~`cdkDependenciesAsDeps`~~^Optional - *Deprecated:* Not supported in CDK v2. ```typescript public readonly cdkDependenciesAsDeps: boolean; ``` - *Type:* boolean - *Default:* true If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). This is to ensure that downstream consumers actually have your CDK dependencies installed when using npm < 7 or yarn, where peer dependencies are not automatically installed. If this is disabled, `cdkDependencies` will be added to `devDependencies` to ensure they are present during development. Note: this setting only applies to construct library projects --- ##### ~~`cdkTestDependencies`~~^Optional - *Deprecated:* For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead ```typescript public readonly cdkTestDependencies: string[]; ``` - *Type:* string[] AWS CDK modules required for testing. --- ##### `cdkVersionPinning`^Optional ```typescript public readonly cdkVersionPinning: boolean; ``` - *Type:* boolean Use pinned version instead of caret version for CDK. You can use this to prevent mixed versions for your CDK dependencies and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes. --- ##### `checkLicenses`^Optional ```typescript public readonly checkLicenses: LicenseCheckerOptions; ``` - *Type:* projen.javascript.LicenseCheckerOptions - *Default:* no license checks are run during the build and all licenses will be accepted Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `codeCov`^Optional ```typescript 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 ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* OIDC auth is used Define the secret name for a specified https://codecov.io/ token. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `compat`^Optional ```typescript public readonly compat: boolean; ``` - *Type:* boolean - *Default:* false Automatically run API compatibility test against the latest version published to npm after compilation. You can manually run compatibility tests using `yarn compat` if this feature is disabled. - You can ignore compatibility failures by adding lines to a ".compatignore" file. --- ##### `compatIgnore`^Optional ```typescript public readonly compatIgnore: string; ``` - *Type:* string - *Default:* ".compatignore" Name of the ignore file for API compatibility tests. --- ##### `compressAssembly`^Optional ```typescript public readonly compressAssembly: boolean; ``` - *Type:* boolean - *Default:* false Emit a compressed version of the assembly. --- ##### `constructsVersion`^Optional ```typescript public readonly constructsVersion: string; ``` - *Type:* string - *Default:* for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.5.1". Minimum version of the `constructs` library to depend on. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `deleteOrphanedLockFiles`^Optional ```typescript public readonly deleteOrphanedLockFiles: boolean; ``` - *Type:* boolean - *Default:* true Automatically delete lockfiles from package managers that are not the active one. Only triggered when the lockfile for the configured package manager already exists. This is useful when migrating between package managers to avoid conflicts. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* `true` for root projects, `false` for subprojects Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `description`^Optional ```typescript 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 --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `devEngines`^Optional ```typescript public readonly devEngines: DevEngines; ``` - *Type:* projen.javascript.DevEngines Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docgenFilePath`^Optional ```typescript public readonly docgenFilePath: string; ``` - *Type:* string - *Default:* "API.md" File path for generated docs. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### ~~`dotnet`~~^Optional - *Deprecated:* use `publishToNuget` ```typescript public readonly dotnet: JsiiDotNetTarget; ``` - *Type:* projen.cdk.JsiiDotNetTarget --- ##### `edgeLambdaAutoDiscover`^Optional ```typescript public readonly edgeLambdaAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true Automatically adds an `cloudfront.experimental.EdgeFunction` for each `.edge-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. --- ##### `enablePRAutoMerge`^Optional ```typescript public readonly enablePRAutoMerge: boolean; ``` - *Type:* boolean - *Default:* true for private projects, false otherwise Whether to enable the auto merge workflow for PRs. This will enable the auto merge workflow as well as the merge queue --- ##### `entrypoint`^Optional ```typescript 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. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true, unless biome is enabled Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `excludeTypescript`^Optional ```typescript public readonly excludeTypescript: string[]; ``` - *Type:* string[] Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input. By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input. This can be problematic for example when the package's build or test procedure generates .ts files that cannot be compiled with jsii's compiler settings. --- ##### `experimentalIntegRunner`^Optional ```typescript public readonly experimentalIntegRunner: boolean; ``` - *Type:* boolean - *Default:* false Enable experimental support for the AWS CDK integ-runner. --- ##### `ghAutoMergeOptions`^Optional ```typescript public readonly ghAutoMergeOptions: AutoQueueOptions; ``` - *Type:* projen.github.AutoQueueOptions - *Default:* default options Options for the GitHub auto merge workflow. That is the workflow that turns on auto merge on all PRs. --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `integrationTestAutoDiscover`^Optional ```typescript public readonly integrationTestAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true Automatically discovers and creates integration tests for each `.integ.ts` file under your test directory. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `jsiiVersion`^Optional ```typescript public readonly jsiiVersion: string; ``` - *Type:* string - *Default:* "~5.9.0" Version of the jsii compiler to use. Set to "*" if you want to manually manage the version of jsii in your project by managing updates to `package.json` on your own. NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~5.0.0`). --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `lambdaAutoDiscover`^Optional ```typescript public readonly lambdaAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler. --- ##### `lambdaExtensionAutoDiscover`^Optional ```typescript public readonly lambdaExtensionAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. --- ##### `lambdaOptions`^Optional ```typescript public readonly lambdaOptions: LambdaFunctionCommonOptions; ``` - *Type:* projen.awscdk.LambdaFunctionCommonOptions - *Default:* default options Common options for all AWS Lambda functions. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `license`^Optional ```typescript 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 ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `majorVersion`^Optional ```typescript 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. --- ##### `maxNodeVersion`^Optional ```typescript 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. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript 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 ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### `minMajorVersion`^Optional ```typescript 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`. --- ##### `minNodeVersion`^Optional ```typescript public readonly minNodeVersion: string; ``` - *Type:* string - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). Only set this if your package will not work properly on specific (older?) Node versions. --- ##### ~~`mutableBuild`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild` ```typescript 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. --- ##### `nextVersionCommand`^Optional ```typescript 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`. --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### `npmDistTag`^Optional ```typescript 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. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript 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 ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `npmProvenance`^Optional ```typescript 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. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript 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 ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `npmTrustedPublishing`^Optional ```typescript 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. --- ##### `outdir`^Optional ```typescript 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. --- ##### `package`^Optional ```typescript 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`). --- ##### `packageManager`^Optional ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails. The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript 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 ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "10.33.0" The version of PNPM to use if using PNPM as a package manager. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `private`^Optional ```typescript public readonly private: boolean; ``` - *Type:* boolean - *Default:* true Whether or not this package is private. Setting this variable to true means that your project is created with sane defaults for private repositories. --- ##### `projectTree`^Optional ```typescript public readonly projectTree: boolean; ``` - *Type:* boolean - *Default:* false Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCommand`^Optional ```typescript 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. --- ##### `projenCredentials`^Optional ```typescript 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. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript 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. --- ##### `projenrcJson`^Optional ```typescript 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 ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript 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. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript 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. --- ##### `publishToGo`^Optional ```typescript public readonly publishToGo: JsiiGoTarget; ``` - *Type:* projen.cdk.JsiiGoTarget - *Default:* no publishing Publish Go bindings to a git repository. --- ##### `publishToMaven`^Optional ```typescript public readonly publishToMaven: JsiiJavaTarget; ``` - *Type:* projen.cdk.JsiiJavaTarget - *Default:* no publishing Publish to maven. --- ##### `publishToNuget`^Optional ```typescript public readonly publishToNuget: JsiiDotNetTarget; ``` - *Type:* projen.cdk.JsiiDotNetTarget - *Default:* no publishing Publish to NuGet. --- ##### `publishToPypi`^Optional ```typescript public readonly publishToPypi: JsiiPythonTarget; ``` - *Type:* projen.cdk.JsiiPythonTarget - *Default:* no publishing Publish to pypi. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### ~~`python`~~^Optional - *Deprecated:* use `publishToPyPi` ```typescript public readonly python: JsiiPythonTarget; ``` - *Type:* projen.cdk.JsiiPythonTarget --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- ##### `releasableCommits`^Optional ```typescript 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. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseBranches`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript 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 ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript 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. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `releaseWorkflowEnv`^Optional ```typescript public readonly releaseWorkflowEnv: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Build environment variables for release workflows. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string - *Default:* generated from org tenancy and package name --- ##### `repositoryDirectory`^Optional ```typescript 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. --- ##### ~~`repositoryUrl`~~^Optional - *Deprecated:* use `repository` ```typescript public readonly repositoryUrl: string; ``` - *Type:* string - *Default:* generated from org tenancy and package name --- ##### `rootdir`^Optional ```typescript public readonly rootdir: string; ``` - *Type:* string - *Default:* "." --- ##### `rosettaOptions`^Optional ```typescript public readonly rosettaOptions: RosettaOptions; ``` - *Type:* RosettaOptions Options for rosetta:extract task. --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `scopedPackagesOptions`^Optional ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript 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. --- ##### `setNodeEngineVersion`^Optional ```typescript public readonly setNodeEngineVersion: boolean; ``` - *Type:* boolean - *Default:* true Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. --- ##### `singletonLambdaAutoDiscover`^Optional ```typescript public readonly singletonLambdaAutoDiscover: boolean; ``` - *Type:* boolean - *Default:* true Automatically adds an `awscdk.SingletonFunction` for each `.singleton-lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript 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`. --- ##### `tenancy`^Optional ```typescript public readonly tenancy: OrgTenancy; ``` - *Type:* OrgTenancy - *Default:* Auto detected from package name The organization this project is part of. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `tsJestOptions`^Optional ```typescript public readonly tsJestOptions: TsJestOptions; ``` - *Type:* projen.typescript.TsJestOptions Options for ts-jest. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `upgradeCdklabsProjenProjectTypes`^Optional ```typescript public readonly upgradeCdklabsProjenProjectTypes: boolean; ``` - *Type:* boolean - *Default:* true Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. --- ##### `upgradeRuntimeDepsAsFix`^Optional ```typescript public readonly upgradeRuntimeDepsAsFix: boolean; ``` - *Type:* boolean - *Default:* true Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. --- ##### `versionrcOptions`^Optional ```typescript 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. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `workflowBootstrapSteps`^Optional ```typescript 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. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* default GitHub Actions user The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript public readonly workflowNodeVersion: string; ``` - *Type:* string - *Default:* 'lts/*' The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `workflowRunsOnGroup`^Optional ```typescript public readonly workflowRunsOnGroup: GroupRunnerOptions; ``` - *Type:* projen.GroupRunnerOptions Github Runner Group selection options. --- ##### `yarnBerryOptions`^Optional ```typescript public readonly yarnBerryOptions: YarnBerryOptions; ``` - *Type:* projen.javascript.YarnBerryOptions - *Default:* Yarn Berry v4 with all default options Options for Yarn Berry. --- ##### `cdklabsPublishingDefaults`^Optional ```typescript public readonly cdklabsPublishingDefaults: boolean; ``` - *Type:* boolean - *Default:* true Set default publishing properties. Setting this property guarantees that your project will have reasonable publishing names. You can choose to modify them however you wish with the traditional `publishToPypi`, `publishToMaven`, `publishToNuget`, and `publishToGo` properties, and your configuration will be respected. This should be set to false only if you do not plan on releasing the package. --- ##### `jsiiTargetLanguages`^Optional ```typescript public readonly jsiiTargetLanguages: JsiiLanguage[]; ``` - *Type:* JsiiLanguage[] - *Default:* all jsii target languages Specify specific languages to publish to. This can be used when the library is experimental only, because stable libraries must publish to all jsii languages. This should be used in conjunction with `cdklabsPublishingDefaults: true`; otherwise it is a no-op. --- ### CdklabsJsiiProjectOptions #### Initializer ```typescript import { CdklabsJsiiProjectOptions } from 'cdklabs-projen-project-types' const cdklabsJsiiProjectOptions: CdklabsJsiiProjectOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | author | string | The name of the library author. | | authorAddress | string | Email or URL of the library author. | | defaultReleaseBranch | string | The name of the main release branch. | | name | string | This is the name of your project. | | addPackageManagerToDevEngines | boolean | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | artifactsDirectory | string | A directory which will contain build artifacts. | | auditDeps | boolean | Run security audit on dependencies. | | auditDepsOptions | projen.javascript.AuditOptions | Security audit options. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). | | autoDetectBin | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | biome | boolean | Setup Biome. | | biomeOptions | projen.javascript.BiomeOptions | Biome options. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowOptions | projen.javascript.BuildWorkflowOptions | Options for PR build workflow. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bumpPackage | string | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | bunVersion | string | The version of Bun to use if using Bun as a package manager. | | checkLicenses | projen.javascript.LicenseCheckerOptions | Configure which licenses should be deemed acceptable for use by dependencies. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | 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. | | commitGenerated | boolean | Whether to commit the managed files by default. | | compat | boolean | Automatically run API compatibility test against the latest version published to npm after compilation. | | compatIgnore | string | Name of the ignore file for API compatibility tests. | | compressAssembly | boolean | Emit a compressed version of the assembly. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | deleteOrphanedLockFiles | boolean | Automatically delete lockfiles from package managers that are not the active one. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | deps | string[] | Runtime dependencies of this module. | | depsUpgrade | boolean | Use tasks and github workflows to handle dependency upgrades. | | depsUpgradeOptions | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | devDeps | string[] | Build dependencies for this module. | | devEngines | projen.javascript.DevEngines | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docgenFilePath | string | File path for generated docs. | | docsDirectory | string | Docs directory. | | dotnet | projen.cdk.JsiiDotNetTarget | *No description.* | | enablePRAutoMerge | boolean | Whether to enable the auto merge workflow for PRs. | | entrypoint | string | Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | excludeTypescript | string[] | Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input. | | ghAutoMergeOptions | projen.github.AutoQueueOptions | Options for the GitHub auto merge workflow. | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitignore | string[] | Additional entries to .gitignore. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | gitpod | boolean | Add a Gitpod development environment. | | homepage | string | Package's Homepage / Website. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | jsiiVersion | string | Version of the jsii compiler to use. | | keywords | string[] | Keywords to include in `package.json`. | | libdir | string | Typescript artifacts output directory. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | majorVersion | number | Major version to release from the default branch. | | maxNodeVersion | string | The maximum node version supported by this package. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | minMajorVersion | number | Minimal Major version to release. | | minNodeVersion | string | The minimum node version required by this package to function. | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | nextVersionCommand | string | A shell command to control the next version to release. | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | 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. | | 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. | | outdir | string | The root directory of the project. Relative to this directory, all files are synthesized. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | 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"). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | private | boolean | Whether or not this package is private. | | projectTree | boolean | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | 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. | | 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. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | projenVersion | string | Version of projen to install. | | 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. | | publishToGo | projen.cdk.JsiiGoTarget | Publish Go bindings to a git repository. | | publishToMaven | projen.cdk.JsiiJavaTarget | Publish to maven. | | publishToNuget | projen.cdk.JsiiDotNetTarget | Publish to NuGet. | | publishToPypi | projen.cdk.JsiiPythonTarget | Publish to pypi. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | python | projen.cdk.JsiiPythonTarget | *No description.* | | readme | projen.SampleReadmeProps | The README setup. | | releasableCommits | projen.ReleasableCommits | Find commits that should be considered releasable Used to decide if a release is required. | | release | boolean | Add release management to this project. | | 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. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | 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. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | repository | string | *No description.* | | 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. | | repositoryUrl | string | *No description.* | | rootdir | string | *No description.* | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | setNodeEngineVersion | boolean | Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. | | srcdir | string | Typescript sources directory. | | stability | string | Package's Stability. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | tenancy | OrgTenancy | The organization this project is part of. | | testdir | string | Jest tests directory. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | tsJestOptions | projen.typescript.TsJestOptions | Options for ts-jest. | | typescriptVersion | string | TypeScript version to use. | | upgradeCdklabsProjenProjectTypes | boolean | Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. | | upgradeRuntimeDepsAsFix | boolean | Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with commit-and-tag-version package. | | vscode | boolean | Enable VSCode integration. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | 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. | | workflowRunsOn | string[] | Github Runner selection labels. | | workflowRunsOnGroup | projen.GroupRunnerOptions | Github Runner Group selection options. | | yarnBerryOptions | projen.javascript.YarnBerryOptions | Options for Yarn Berry. | | cdklabsPublishingDefaults | boolean | Set default publishing properties. | | jsiiTargetLanguages | JsiiLanguage[] | Specify specific languages to publish to. | --- ##### `author`^Required ```typescript public readonly author: string; ``` - *Type:* string - *Default:* $GIT_USER_NAME The name of the library author. --- ##### `authorAddress`^Required ```typescript public readonly authorAddress: string; ``` - *Type:* string - *Default:* $GIT_USER_EMAIL Email or URL of the library author. --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `addPackageManagerToDevEngines`^Optional ```typescript public readonly addPackageManagerToDevEngines: boolean; ``` - *Type:* boolean - *Default:* true Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. --- ##### `allowLibraryDependencies`^Optional ```typescript 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. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `auditDeps`^Optional ```typescript 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 ```typescript public readonly auditDepsOptions: AuditOptions; ``` - *Type:* projen.javascript.AuditOptions - *Default:* default options Security audit options. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `autoDetectBin`^Optional ```typescript 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. --- ##### `autoMerge`^Optional ```typescript 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 ```typescript 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. --- ##### `bin`^Optional ```typescript 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. --- ##### `biome`^Optional ```typescript public readonly biome: boolean; ``` - *Type:* boolean - *Default:* false Setup Biome. --- ##### `biomeOptions`^Optional ```typescript public readonly biomeOptions: BiomeOptions; ``` - *Type:* projen.javascript.BiomeOptions - *Default:* default options Biome options. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowOptions`^Optional ```typescript public readonly buildWorkflowOptions: BuildWorkflowOptions; ``` - *Type:* projen.javascript.BuildWorkflowOptions Options for PR build workflow. --- ##### ~~`buildWorkflowTriggers`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers` ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bumpPackage`^Optional ```typescript 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`. --- ##### `bundledDeps`^Optional ```typescript 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 `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `bunVersion`^Optional ```typescript public readonly bunVersion: string; ``` - *Type:* string - *Default:* "latest" The version of Bun to use if using Bun as a package manager. --- ##### `checkLicenses`^Optional ```typescript public readonly checkLicenses: LicenseCheckerOptions; ``` - *Type:* projen.javascript.LicenseCheckerOptions - *Default:* no license checks are run during the build and all licenses will be accepted Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `codeCov`^Optional ```typescript 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 ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* OIDC auth is used Define the secret name for a specified https://codecov.io/ token. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `compat`^Optional ```typescript public readonly compat: boolean; ``` - *Type:* boolean - *Default:* false Automatically run API compatibility test against the latest version published to npm after compilation. You can manually run compatibility tests using `yarn compat` if this feature is disabled. - You can ignore compatibility failures by adding lines to a ".compatignore" file. --- ##### `compatIgnore`^Optional ```typescript public readonly compatIgnore: string; ``` - *Type:* string - *Default:* ".compatignore" Name of the ignore file for API compatibility tests. --- ##### `compressAssembly`^Optional ```typescript public readonly compressAssembly: boolean; ``` - *Type:* boolean - *Default:* false Emit a compressed version of the assembly. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `deleteOrphanedLockFiles`^Optional ```typescript public readonly deleteOrphanedLockFiles: boolean; ``` - *Type:* boolean - *Default:* true Automatically delete lockfiles from package managers that are not the active one. Only triggered when the lockfile for the configured package manager already exists. This is useful when migrating between package managers to avoid conflicts. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* `true` for root projects, `false` for subprojects Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `description`^Optional ```typescript 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 --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `devEngines`^Optional ```typescript public readonly devEngines: DevEngines; ``` - *Type:* projen.javascript.DevEngines Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docgenFilePath`^Optional ```typescript public readonly docgenFilePath: string; ``` - *Type:* string - *Default:* "API.md" File path for generated docs. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### ~~`dotnet`~~^Optional - *Deprecated:* use `publishToNuget` ```typescript public readonly dotnet: JsiiDotNetTarget; ``` - *Type:* projen.cdk.JsiiDotNetTarget --- ##### `enablePRAutoMerge`^Optional ```typescript public readonly enablePRAutoMerge: boolean; ``` - *Type:* boolean - *Default:* true for private projects, false otherwise Whether to enable the auto merge workflow for PRs. This will enable the auto merge workflow as well as the merge queue --- ##### `entrypoint`^Optional ```typescript 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. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true, unless biome is enabled Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `excludeTypescript`^Optional ```typescript public readonly excludeTypescript: string[]; ``` - *Type:* string[] Accepts a list of glob patterns. Files matching any of those patterns will be excluded from the TypeScript compiler input. By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input. This can be problematic for example when the package's build or test procedure generates .ts files that cannot be compiled with jsii's compiler settings. --- ##### `ghAutoMergeOptions`^Optional ```typescript public readonly ghAutoMergeOptions: AutoQueueOptions; ``` - *Type:* projen.github.AutoQueueOptions - *Default:* default options Options for the GitHub auto merge workflow. That is the workflow that turns on auto merge on all PRs. --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `jsiiVersion`^Optional ```typescript public readonly jsiiVersion: string; ``` - *Type:* string - *Default:* "~5.9.0" Version of the jsii compiler to use. Set to "*" if you want to manually manage the version of jsii in your project by managing updates to `package.json` on your own. NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~5.0.0`). --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `license`^Optional ```typescript 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 ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `majorVersion`^Optional ```typescript 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. --- ##### `maxNodeVersion`^Optional ```typescript 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. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript 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 ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### `minMajorVersion`^Optional ```typescript 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`. --- ##### `minNodeVersion`^Optional ```typescript 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`. --- ##### ~~`mutableBuild`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild` ```typescript 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. --- ##### `nextVersionCommand`^Optional ```typescript 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`. --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### `npmDistTag`^Optional ```typescript 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. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript 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 ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `npmProvenance`^Optional ```typescript 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. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript 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 ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `npmTrustedPublishing`^Optional ```typescript 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. --- ##### `outdir`^Optional ```typescript 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. --- ##### `package`^Optional ```typescript 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`). --- ##### `packageManager`^Optional ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails. The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript 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 ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "10.33.0" The version of PNPM to use if using PNPM as a package manager. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `private`^Optional ```typescript public readonly private: boolean; ``` - *Type:* boolean - *Default:* true Whether or not this package is private. Setting this variable to true means that your project is created with sane defaults for private repositories. --- ##### `projectTree`^Optional ```typescript public readonly projectTree: boolean; ``` - *Type:* boolean - *Default:* false Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCommand`^Optional ```typescript 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. --- ##### `projenCredentials`^Optional ```typescript 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. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript 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. --- ##### `projenrcJson`^Optional ```typescript 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 ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript 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. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript 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. --- ##### `publishToGo`^Optional ```typescript public readonly publishToGo: JsiiGoTarget; ``` - *Type:* projen.cdk.JsiiGoTarget - *Default:* no publishing Publish Go bindings to a git repository. --- ##### `publishToMaven`^Optional ```typescript public readonly publishToMaven: JsiiJavaTarget; ``` - *Type:* projen.cdk.JsiiJavaTarget - *Default:* no publishing Publish to maven. --- ##### `publishToNuget`^Optional ```typescript public readonly publishToNuget: JsiiDotNetTarget; ``` - *Type:* projen.cdk.JsiiDotNetTarget - *Default:* no publishing Publish to NuGet. --- ##### `publishToPypi`^Optional ```typescript public readonly publishToPypi: JsiiPythonTarget; ``` - *Type:* projen.cdk.JsiiPythonTarget - *Default:* no publishing Publish to pypi. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### ~~`python`~~^Optional - *Deprecated:* use `publishToPyPi` ```typescript public readonly python: JsiiPythonTarget; ``` - *Type:* projen.cdk.JsiiPythonTarget --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- ##### `releasableCommits`^Optional ```typescript 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. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseBranches`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript 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 ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript 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. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `releaseWorkflowEnv`^Optional ```typescript public readonly releaseWorkflowEnv: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Build environment variables for release workflows. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `repository`^Optional ```typescript public readonly repository: string; ``` - *Type:* string - *Default:* generated from org tenancy and package name --- ##### `repositoryDirectory`^Optional ```typescript 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. --- ##### ~~`repositoryUrl`~~^Optional - *Deprecated:* use `repository` ```typescript public readonly repositoryUrl: string; ``` - *Type:* string - *Default:* generated from org tenancy and package name --- ##### `rootdir`^Optional ```typescript public readonly rootdir: string; ``` - *Type:* string - *Default:* "." --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `scopedPackagesOptions`^Optional ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript 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. --- ##### `setNodeEngineVersion`^Optional ```typescript public readonly setNodeEngineVersion: boolean; ``` - *Type:* boolean - *Default:* true Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript 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`. --- ##### `tenancy`^Optional ```typescript public readonly tenancy: OrgTenancy; ``` - *Type:* OrgTenancy - *Default:* Auto detected from package name The organization this project is part of. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `tsJestOptions`^Optional ```typescript public readonly tsJestOptions: TsJestOptions; ``` - *Type:* projen.typescript.TsJestOptions Options for ts-jest. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `upgradeCdklabsProjenProjectTypes`^Optional ```typescript public readonly upgradeCdklabsProjenProjectTypes: boolean; ``` - *Type:* boolean - *Default:* true Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. --- ##### `upgradeRuntimeDepsAsFix`^Optional ```typescript public readonly upgradeRuntimeDepsAsFix: boolean; ``` - *Type:* boolean - *Default:* true Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. --- ##### `versionrcOptions`^Optional ```typescript 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. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `workflowBootstrapSteps`^Optional ```typescript 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. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* default GitHub Actions user The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript 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 ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `workflowRunsOnGroup`^Optional ```typescript public readonly workflowRunsOnGroup: GroupRunnerOptions; ``` - *Type:* projen.GroupRunnerOptions Github Runner Group selection options. --- ##### `yarnBerryOptions`^Optional ```typescript public readonly yarnBerryOptions: YarnBerryOptions; ``` - *Type:* projen.javascript.YarnBerryOptions - *Default:* Yarn Berry v4 with all default options Options for Yarn Berry. --- ##### `cdklabsPublishingDefaults`^Optional ```typescript public readonly cdklabsPublishingDefaults: boolean; ``` - *Type:* boolean - *Default:* true Set default publishing properties. Setting this property guarantees that your project will have reasonable publishing names. You can choose to modify them however you wish with the traditional `publishToPypi`, `publishToMaven`, `publishToNuget`, and `publishToGo` properties, and your configuration will be respected. This should be set to false only if you do not plan on releasing the package. --- ##### `jsiiTargetLanguages`^Optional ```typescript public readonly jsiiTargetLanguages: JsiiLanguage[]; ``` - *Type:* JsiiLanguage[] - *Default:* all jsii target languages Specify specific languages to publish to. This can be used when the library is experimental only, because stable libraries must publish to all jsii languages. This should be used in conjunction with `cdklabsPublishingDefaults: true`; otherwise it is a no-op. --- ### CdkLabsMonorepoOptions Options for CdkLabsMonorepo. #### Initializer ```typescript import { yarn } from 'cdklabs-projen-project-types' const cdkLabsMonorepoOptions: yarn.CdkLabsMonorepoOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultReleaseBranch | string | The name of the main release branch. | | name | string | This is the name of your project. | | addPackageManagerToDevEngines | boolean | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | artifactsDirectory | string | A directory which will contain build artifacts. | | auditDeps | boolean | Run security audit on dependencies. | | auditDepsOptions | projen.javascript.AuditOptions | Security audit options. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). | | autoDetectBin | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | biome | boolean | Setup Biome. | | biomeOptions | projen.javascript.BiomeOptions | Biome options. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | buildablePackages | string[] | Packages that should have their build scripts enabled during install. | | buildWithNx | boolean | When Nx is enabled, always build the monorepo using Nx Will build projects in parallel and can improve build performance. | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowOptions | projen.javascript.BuildWorkflowOptions | Options for PR build workflow. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bumpPackage | string | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | bunVersion | string | The version of Bun to use if using Bun as a package manager. | | checkLicenses | projen.javascript.LicenseCheckerOptions | Configure which licenses should be deemed acceptable for use by dependencies. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | 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. | | commitGenerated | boolean | Whether to commit the managed files by default. | | consistentVersions | string[] | Package names that must use a consistent version across all workspaces. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | deleteOrphanedLockFiles | boolean | Automatically delete lockfiles from package managers that are not the active one. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | deps | string[] | Runtime dependencies of this module. | | depsUpgrade | boolean | Use tasks and github workflows to handle dependency upgrades. | | depsUpgradeOptions | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | devDeps | string[] | Build dependencies for this module. | | devEngines | projen.javascript.DevEngines | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docsDirectory | string | Docs directory. | | entrypoint | string | Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitignore | string[] | Additional entries to .gitignore. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | gitpod | boolean | Add a Gitpod development environment. | | homepage | string | Package's Homepage / Website. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | keywords | string[] | Keywords to include in `package.json`. | | libdir | string | Typescript artifacts output directory. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | majorVersion | number | Major version to release from the default branch. | | maxNodeVersion | string | The maximum node version supported by this package. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | minMajorVersion | number | Minimal Major version to release. | | minNodeVersion | string | Minimum Node.js version to require via package.json `engines` (inclusive). | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | nextVersionCommand | string | A shell command to control the next version to release. | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | 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. | | 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. | | nx | boolean | Enable the integration with Nx in the monorepo. | | outdir | string | The root directory of the project. Relative to this directory, all files are synthesized. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | packageName | string | The "name" in package.json. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | 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"). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | projectTree | boolean | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | 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. | | 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. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | projenVersion | string | Version of projen to install. | | 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. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | readme | projen.SampleReadmeProps | The README setup. | | releasableCommits | projen.ReleasableCommits | Find commits that should be considered releasable Used to decide if a release is required. | | release | boolean | Whether or not to add release workflows for this repository. | | 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. | | releaseOptions | cdklabs-projen-project-types.yarn.MonorepoReleaseOptions | Options for the release workflows. | | releaseSchedule | string | CRON schedule to trigger new releases. | | releaseTagPrefix | string | Automatically add the given prefix to release tags. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | 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. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | repository | string | The repository is the location where the actual code for your package lives. | | repositoryDirectory | string | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | srcdir | string | Typescript sources directory. | | stability | string | Package's Stability. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | testdir | string | Jest tests directory. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | tsJestOptions | projen.typescript.TsJestOptions | Options for ts-jest. | | typescriptVersion | string | TypeScript version to use. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with commit-and-tag-version package. | | vscode | boolean | Enable VSCode integration. | | vscodeWorkspace | boolean | Create a VSCode multi-root workspace file for all monorepo workspaces. | | vscodeWorkspaceOptions | cdklabs-projen-project-types.yarn.VsCodeWorkspaceOptions | Configuration options for the VSCode multi-root workspace file. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version to use in GitHub workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | workflowRunsOn | string[] | Github Runner selection labels. | | workflowRunsOnGroup | projen.GroupRunnerOptions | Github Runner Group selection options. | | yarnBerry | boolean | Use Yarn Berry as the package manager. | | yarnBerryOptions | projen.javascript.YarnBerryOptions | Options for Yarn Berry. | --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `addPackageManagerToDevEngines`^Optional ```typescript public readonly addPackageManagerToDevEngines: boolean; ``` - *Type:* boolean - *Default:* true Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. --- ##### `allowLibraryDependencies`^Optional ```typescript 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. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `auditDeps`^Optional ```typescript 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 ```typescript public readonly auditDepsOptions: AuditOptions; ``` - *Type:* projen.javascript.AuditOptions - *Default:* default options Security audit options. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `autoDetectBin`^Optional ```typescript 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. --- ##### `autoMerge`^Optional ```typescript 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 ```typescript 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. --- ##### `bin`^Optional ```typescript 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. --- ##### `biome`^Optional ```typescript public readonly biome: boolean; ``` - *Type:* boolean - *Default:* false Setup Biome. --- ##### `biomeOptions`^Optional ```typescript public readonly biomeOptions: BiomeOptions; ``` - *Type:* projen.javascript.BiomeOptions - *Default:* default options Biome options. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `buildablePackages`^Optional ```typescript public readonly buildablePackages: string[]; ``` - *Type:* string[] Packages that should have their build scripts enabled during install. Yarn Berry disables build scripts by default (`enableScripts: false`). This option sets `dependenciesMeta..built: true` in the root `package.json` for each listed package, allowing them to run their install scripts. Only has an effect when the monorepo uses Yarn Berry. --- ##### `buildWithNx`^Optional ```typescript public readonly buildWithNx: boolean; ``` - *Type:* boolean - *Default:* false When Nx is enabled, always build the monorepo using Nx Will build projects in parallel and can improve build performance. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowOptions`^Optional ```typescript public readonly buildWorkflowOptions: BuildWorkflowOptions; ``` - *Type:* projen.javascript.BuildWorkflowOptions Options for PR build workflow. --- ##### ~~`buildWorkflowTriggers`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers` ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bumpPackage`^Optional ```typescript 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`. --- ##### `bundledDeps`^Optional ```typescript 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 `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `bunVersion`^Optional ```typescript public readonly bunVersion: string; ``` - *Type:* string - *Default:* "latest" The version of Bun to use if using Bun as a package manager. --- ##### `checkLicenses`^Optional ```typescript public readonly checkLicenses: LicenseCheckerOptions; ``` - *Type:* projen.javascript.LicenseCheckerOptions - *Default:* no license checks are run during the build and all licenses will be accepted Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `codeCov`^Optional ```typescript 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 ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* OIDC auth is used Define the secret name for a specified https://codecov.io/ token. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `consistentVersions`^Optional ```typescript public readonly consistentVersions: string[]; ``` - *Type:* string[] Package names that must use a consistent version across all workspaces. Uses Yarn Berry constraints to enforce that all workspaces use the same version of the listed packages. The version is read from the root `devDependencies`. Only has an effect when the monorepo uses Yarn Berry. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `deleteOrphanedLockFiles`^Optional ```typescript public readonly deleteOrphanedLockFiles: boolean; ``` - *Type:* boolean - *Default:* true Automatically delete lockfiles from package managers that are not the active one. Only triggered when the lockfile for the configured package manager already exists. This is useful when migrating between package managers to avoid conflicts. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* `true` for root projects, `false` for subprojects Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `description`^Optional ```typescript 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 --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `devEngines`^Optional ```typescript public readonly devEngines: DevEngines; ``` - *Type:* projen.javascript.DevEngines Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### `entrypoint`^Optional ```typescript 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. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `license`^Optional ```typescript 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 ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `majorVersion`^Optional ```typescript 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. --- ##### `maxNodeVersion`^Optional ```typescript 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. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript 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 ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### `minMajorVersion`^Optional ```typescript 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`. --- ##### `minNodeVersion`^Optional ```typescript public readonly minNodeVersion: string; ``` - *Type:* string - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). Only set this if your package will not work properly on specific (older?) Node versions. --- ##### ~~`mutableBuild`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild` ```typescript 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. --- ##### `nextVersionCommand`^Optional ```typescript 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`. --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### `npmDistTag`^Optional ```typescript 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. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript 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 ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `npmProvenance`^Optional ```typescript 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. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript 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 ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `npmTrustedPublishing`^Optional ```typescript 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. --- ##### `nx`^Optional ```typescript public readonly nx: boolean; ``` - *Type:* boolean - *Default:* false Enable the integration with Nx in the monorepo. --- ##### `outdir`^Optional ```typescript 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. --- ##### `package`^Optional ```typescript 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`). --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript 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 ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "10.33.0" The version of PNPM to use if using PNPM as a package manager. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projectTree`^Optional ```typescript public readonly projectTree: boolean; ``` - *Type:* boolean - *Default:* false Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCommand`^Optional ```typescript 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. --- ##### `projenCredentials`^Optional ```typescript 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. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript 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. --- ##### `projenrcJson`^Optional ```typescript 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 ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript 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. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript 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. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- ##### `releasableCommits`^Optional ```typescript 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. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* No release Whether or not to add release workflows for this repository. --- ##### `releaseBranches`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript public readonly releaseFailureIssueLabel: string; ``` - *Type:* string - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### `releaseOptions`^Optional ```typescript public readonly releaseOptions: MonorepoReleaseOptions; ``` - *Type:* cdklabs-projen-project-types.yarn.MonorepoReleaseOptions Options for the release workflows. --- ##### ~~`releaseSchedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript 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. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `releaseWorkflowEnv`^Optional ```typescript public readonly releaseWorkflowEnv: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Build environment variables for release workflows. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `repository`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript 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. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript 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`. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `tsJestOptions`^Optional ```typescript public readonly tsJestOptions: TsJestOptions; ``` - *Type:* projen.typescript.TsJestOptions Options for ts-jest. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `versionrcOptions`^Optional ```typescript 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. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `vscodeWorkspace`^Optional ```typescript public readonly vscodeWorkspace: boolean; ``` - *Type:* boolean - *Default:* false Create a VSCode multi-root workspace file for all monorepo workspaces. --- ##### `vscodeWorkspaceOptions`^Optional ```typescript public readonly vscodeWorkspaceOptions: VsCodeWorkspaceOptions; ``` - *Type:* cdklabs-projen-project-types.yarn.VsCodeWorkspaceOptions - *Default:* default configuration Configuration options for the VSCode multi-root workspace file. --- ##### `workflowBootstrapSteps`^Optional ```typescript 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. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* default GitHub Actions user The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript public readonly workflowNodeVersion: string; ``` - *Type:* string - *Default:* 'lts/*' The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `workflowRunsOnGroup`^Optional ```typescript public readonly workflowRunsOnGroup: GroupRunnerOptions; ``` - *Type:* projen.GroupRunnerOptions Github Runner Group selection options. --- ##### `yarnBerry`^Optional ```typescript public readonly yarnBerry: boolean; ``` - *Type:* boolean - *Default:* false Use Yarn Berry as the package manager. When enabled, the monorepo will use `YARN_BERRY` instead of `YARN_CLASSIC`. `yarnBerryOptions` can be used to further configure Yarn Berry. The `nodeLinker` defaults to `node-modules`. --- ##### `yarnBerryOptions`^Optional ```typescript public readonly yarnBerryOptions: YarnBerryOptions; ``` - *Type:* projen.javascript.YarnBerryOptions - *Default:* Yarn Berry v4 with all default options Options for Yarn Berry. --- ### CdklabsPublishingProjectOptions #### Initializer ```typescript import { CdklabsPublishingProjectOptions } from 'cdklabs-projen-project-types' const cdklabsPublishingProjectOptions: CdklabsPublishingProjectOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | cdklabsPublishingDefaults | boolean | Set default publishing properties. | | jsiiTargetLanguages | JsiiLanguage[] | Specify specific languages to publish to. | --- ##### `cdklabsPublishingDefaults`^Optional ```typescript public readonly cdklabsPublishingDefaults: boolean; ``` - *Type:* boolean - *Default:* true Set default publishing properties. Setting this property guarantees that your project will have reasonable publishing names. You can choose to modify them however you wish with the traditional `publishToPypi`, `publishToMaven`, `publishToNuget`, and `publishToGo` properties, and your configuration will be respected. This should be set to false only if you do not plan on releasing the package. --- ##### `jsiiTargetLanguages`^Optional ```typescript public readonly jsiiTargetLanguages: JsiiLanguage[]; ``` - *Type:* JsiiLanguage[] - *Default:* all jsii target languages Specify specific languages to publish to. This can be used when the library is experimental only, because stable libraries must publish to all jsii languages. This should be used in conjunction with `cdklabsPublishingDefaults: true`; otherwise it is a no-op. --- ### CdklabsTypeScriptProjectOptions #### Initializer ```typescript import { CdklabsTypeScriptProjectOptions } from 'cdklabs-projen-project-types' const cdklabsTypeScriptProjectOptions: CdklabsTypeScriptProjectOptions = { ... } ``` #### 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. | | projectTree | boolean | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. | | 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. | | addPackageManagerToDevEngines | boolean | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. | | 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 | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deleteOrphanedLockFiles | boolean | Automatically delete lockfiles from package managers that are not the active one. | | 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. | | devEngines | projen.javascript.DevEngines | Configure the `devEngines` field in `package.json`. | | entrypoint | string | Module entrypoint (`main` in `package.json`). | | homepage | string | Package's Homepage / Website. | | keywords | string[] | Keywords to include in `package.json`. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | maxNodeVersion | string | The maximum node version supported by this package. Most projects should not use this option. | | minNodeVersion | string | The minimum node version required by this package to function. Most projects should not use this option. | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmProvenance | boolean | Should provenance statements be generated when the package is published. | | npmRegistry | string | The host name of the npm registry to publish to. | | npmRegistryUrl | string | The base URL of the npm package registry. | | npmTokenSecret | string | GitHub secret which contains the NPM token to use when publishing packages. | | npmTrustedPublishing | boolean | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | repository | string | The repository is the location where the actual code for your package lives. | | repositoryDirectory | string | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | stability | string | Package's Stability. | | yarnBerryOptions | projen.javascript.YarnBerryOptions | Options for Yarn Berry. | | bumpPackage | string | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | number | Major version to release from the default branch. | | minMajorVersion | number | Minimal Major version to release. | | nextVersionCommand | string | A shell command to control the next version to release. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | projen.github.workflows.JobStep[] | Steps to execute after build as part of the release workflow. | | prerelease | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | boolean | Define publishing tasks that can be executed manually as well as workflows. | | releasableCommits | projen.ReleasableCommits | Find commits that should be considered releasable Used to decide if a release is required. | | releaseBranches | {[ key: string ]: projen.release.BranchOptions} | Defines additional release branches. | | 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 | projen.javascript.AuditOptions | Security audit options. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). | | biome | boolean | Setup Biome. | | biomeOptions | projen.javascript.BiomeOptions | Biome options. | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowOptions | projen.javascript.BuildWorkflowOptions | Options for PR build workflow. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | checkLicenses | projen.javascript.LicenseCheckerOptions | Configure which licenses should be deemed acceptable for use by dependencies. | | codeCov | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@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 | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | string[] | Additional entries to .gitignore. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | string[] | Additional entries to .npmignore. | | npmignoreEnabled | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | string | Version of projen to install. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | release | boolean | Add release management to this project. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version used in GitHub Actions workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docsDirectory | string | Docs directory. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | libdir | string | Typescript artifacts output directory. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | string | Typescript sources directory. | | testdir | string | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | tsJestOptions | projen.typescript.TsJestOptions | Options for ts-jest. | | typescriptVersion | string | TypeScript version to use. | | enablePRAutoMerge | boolean | Whether to enable the auto merge workflow for PRs. | | ghAutoMergeOptions | projen.github.AutoQueueOptions | Options for the GitHub auto merge workflow. | | private | boolean | Whether or not this package is private. | | setNodeEngineVersion | boolean | Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. | | tenancy | OrgTenancy | The organization this project is part of. | | upgradeCdklabsProjenProjectTypes | boolean | Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. | | upgradeRuntimeDepsAsFix | boolean | Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript 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 ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projectTree`^Optional ```typescript public readonly projectTree: boolean; ``` - *Type:* boolean - *Default:* false Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. --- ##### `projenCommand`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript 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 ```typescript 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 ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript 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` ```typescript 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 ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript 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 ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `addPackageManagerToDevEngines`^Optional ```typescript public readonly addPackageManagerToDevEngines: boolean; ``` - *Type:* boolean - *Default:* true Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. --- ##### `allowLibraryDependencies`^Optional ```typescript 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 ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoDetectBin`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```typescript 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 `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `bunVersion`^Optional ```typescript public readonly bunVersion: string; ``` - *Type:* string - *Default:* "latest" The version of Bun to use if using Bun as a package manager. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deleteOrphanedLockFiles`^Optional ```typescript public readonly deleteOrphanedLockFiles: boolean; ``` - *Type:* boolean - *Default:* true Automatically delete lockfiles from package managers that are not the active one. Only triggered when the lockfile for the configured package manager already exists. This is useful when migrating between package managers to avoid conflicts. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- *Example* ```typescript [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```typescript 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 ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- *Example* ```typescript [ 'typescript', '@types/express' ] ``` ##### `devEngines`^Optional ```typescript public readonly devEngines: DevEngines; ``` - *Type:* projen.javascript.DevEngines Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. > [https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines) --- ##### `entrypoint`^Optional ```typescript 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 ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `license`^Optional ```typescript 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 ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### `npmProvenance`^Optional ```typescript 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](https://docs.npmjs.com/generating-provenance-statements) --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript 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 ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `npmTrustedPublishing`^Optional ```typescript 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 ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails. The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript 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 ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "10.33.0" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript 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 ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `yarnBerryOptions`^Optional ```typescript public readonly yarnBerryOptions: YarnBerryOptions; ``` - *Type:* projen.javascript.YarnBerryOptions - *Default:* Yarn Berry v4 with all default options Options for Yarn Berry. --- ##### `bumpPackage`^Optional ```typescript 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 ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```typescript 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 ```typescript 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 ```typescript 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 ```typescript 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 ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript 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 ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript 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 ```typescript 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 ```typescript 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 ```typescript 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 ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript 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 ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript 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 ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowEnv`^Optional ```typescript public readonly releaseWorkflowEnv: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Build environment variables for release workflows. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `workflowRunsOnGroup`^Optional ```typescript public readonly workflowRunsOnGroup: GroupRunnerOptions; ``` - *Type:* projen.GroupRunnerOptions Github Runner Group selection options. --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `auditDeps`^Optional ```typescript 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 ```typescript public readonly auditDepsOptions: AuditOptions; ``` - *Type:* projen.javascript.AuditOptions - *Default:* default options Security audit options. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `biome`^Optional ```typescript public readonly biome: boolean; ``` - *Type:* boolean - *Default:* false Setup Biome. --- ##### `biomeOptions`^Optional ```typescript public readonly biomeOptions: BiomeOptions; ``` - *Type:* projen.javascript.BiomeOptions - *Default:* default options Biome options. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowOptions`^Optional ```typescript public readonly buildWorkflowOptions: BuildWorkflowOptions; ``` - *Type:* projen.javascript.BuildWorkflowOptions Options for PR build workflow. --- ##### ~~`buildWorkflowTriggers`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers` ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `checkLicenses`^Optional ```typescript public readonly checkLicenses: LicenseCheckerOptions; ``` - *Type:* projen.javascript.LicenseCheckerOptions - *Default:* no license checks are run during the build and all licenses will be accepted Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. --- ##### `codeCov`^Optional ```typescript 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 ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* OIDC auth is used Define the secret name for a specified https://codecov.io/ token. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* `true` for root projects, `false` for subprojects Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### ~~`mutableBuild`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild` ```typescript 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` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript 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 ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```typescript 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 ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript 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 ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```typescript 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 ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* default GitHub Actions user The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript 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 ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true, unless biome is enabled Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `tsJestOptions`^Optional ```typescript public readonly tsJestOptions: TsJestOptions; ``` - *Type:* projen.typescript.TsJestOptions Options for ts-jest. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `enablePRAutoMerge`^Optional ```typescript public readonly enablePRAutoMerge: boolean; ``` - *Type:* boolean - *Default:* true for private projects, false otherwise Whether to enable the auto merge workflow for PRs. This will enable the auto merge workflow as well as the merge queue --- ##### `ghAutoMergeOptions`^Optional ```typescript public readonly ghAutoMergeOptions: AutoQueueOptions; ``` - *Type:* projen.github.AutoQueueOptions - *Default:* default options Options for the GitHub auto merge workflow. That is the workflow that turns on auto merge on all PRs. --- ##### `private`^Optional ```typescript public readonly private: boolean; ``` - *Type:* boolean - *Default:* true Whether or not this package is private. Setting this variable to true means that your project is created with sane defaults for private repositories. --- ##### `setNodeEngineVersion`^Optional ```typescript public readonly setNodeEngineVersion: boolean; ``` - *Type:* boolean - *Default:* true Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. --- ##### `tenancy`^Optional ```typescript public readonly tenancy: OrgTenancy; ``` - *Type:* OrgTenancy - *Default:* Auto detected from package name The organization this project is part of. --- ##### `upgradeCdklabsProjenProjectTypes`^Optional ```typescript public readonly upgradeCdklabsProjenProjectTypes: boolean; ``` - *Type:* boolean - *Default:* true Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. --- ##### `upgradeRuntimeDepsAsFix`^Optional ```typescript public readonly upgradeRuntimeDepsAsFix: boolean; ``` - *Type:* boolean - *Default:* true Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. --- ### CdkTypeScriptProjectOptions #### Initializer ```typescript import { CdkTypeScriptProjectOptions } from 'cdklabs-projen-project-types' const cdkTypeScriptProjectOptions: CdkTypeScriptProjectOptions = { ... } ``` #### 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. | | projectTree | boolean | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. | | 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. | | addPackageManagerToDevEngines | boolean | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. | | 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 | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | deleteOrphanedLockFiles | boolean | Automatically delete lockfiles from package managers that are not the active one. | | 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. | | devEngines | projen.javascript.DevEngines | Configure the `devEngines` field in `package.json`. | | entrypoint | string | Module entrypoint (`main` in `package.json`). | | homepage | string | Package's Homepage / Website. | | keywords | string[] | Keywords to include in `package.json`. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | maxNodeVersion | string | The maximum node version supported by this package. Most projects should not use this option. | | minNodeVersion | string | The minimum node version required by this package to function. Most projects should not use this option. | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmProvenance | boolean | Should provenance statements be generated when the package is published. | | npmRegistry | string | The host name of the npm registry to publish to. | | npmRegistryUrl | string | The base URL of the npm package registry. | | npmTokenSecret | string | GitHub secret which contains the NPM token to use when publishing packages. | | npmTrustedPublishing | boolean | Use trusted publishing for publishing to npmjs.com Needs to be pre-configured on npm.js to work. | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | repository | string | The repository is the location where the actual code for your package lives. | | repositoryDirectory | string | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | stability | string | Package's Stability. | | yarnBerryOptions | projen.javascript.YarnBerryOptions | Options for Yarn Berry. | | bumpPackage | string | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | majorVersion | number | Major version to release from the default branch. | | minMajorVersion | number | Minimal Major version to release. | | nextVersionCommand | string | A shell command to control the next version to release. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | postBuildSteps | projen.github.workflows.JobStep[] | Steps to execute after build as part of the release workflow. | | prerelease | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). | | publishDryRun | boolean | Instead of actually publishing to package managers, just print the publishing command. | | publishTasks | boolean | Define publishing tasks that can be executed manually as well as workflows. | | releasableCommits | projen.ReleasableCommits | Find commits that should be considered releasable Used to decide if a release is required. | | releaseBranches | {[ key: string ]: projen.release.BranchOptions} | Defines additional release branches. | | 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 | projen.javascript.AuditOptions | Security audit options. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). | | biome | boolean | Setup Biome. | | biomeOptions | projen.javascript.BiomeOptions | Biome options. | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowOptions | projen.javascript.BuildWorkflowOptions | Options for PR build workflow. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | checkLicenses | projen.javascript.LicenseCheckerOptions | Configure which licenses should be deemed acceptable for use by dependencies. | | codeCov | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@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 | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | gitignore | string[] | Additional entries to .gitignore. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | npmignore | string[] | Additional entries to .npmignore. | | npmignoreEnabled | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. | | npmIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .npmignore file. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | projenDevDependency | boolean | Indicates of "projen" should be installed as a devDependency. | | projenrcJs | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenVersion | string | Version of projen to install. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | release | boolean | Add release management to this project. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version used in GitHub Actions workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docsDirectory | string | Docs directory. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | libdir | string | Typescript artifacts output directory. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | srcdir | string | Typescript sources directory. | | testdir | string | Jest tests directory. Tests files should be named `xxx.test.ts`. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | tsJestOptions | projen.typescript.TsJestOptions | Options for ts-jest. | | typescriptVersion | string | TypeScript version to use. | | enablePRAutoMerge | boolean | Whether to enable the auto merge workflow for PRs. | | ghAutoMergeOptions | projen.github.AutoQueueOptions | Options for the GitHub auto merge workflow. | | private | boolean | Whether or not this package is private. | | setNodeEngineVersion | boolean | Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. | | tenancy | OrgTenancy | The organization this project is part of. | | upgradeCdklabsProjenProjectTypes | boolean | Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. | | upgradeRuntimeDepsAsFix | boolean | Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `outdir`^Optional ```typescript 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 ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `projectTree`^Optional ```typescript public readonly projectTree: boolean; ``` - *Type:* boolean - *Default:* false Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. --- ##### `projenCommand`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoMerge`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript 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 ```typescript 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 ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCredentials`^Optional ```typescript 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` ```typescript 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 ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- *Example* ```typescript "{ filename: 'readme.md', contents: '# title' }" ``` ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript 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 ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `addPackageManagerToDevEngines`^Optional ```typescript public readonly addPackageManagerToDevEngines: boolean; ``` - *Type:* boolean - *Default:* true Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. --- ##### `allowLibraryDependencies`^Optional ```typescript 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 ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoDetectBin`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `bundledDeps`^Optional ```typescript 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 `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `bunVersion`^Optional ```typescript public readonly bunVersion: string; ``` - *Type:* string - *Default:* "latest" The version of Bun to use if using Bun as a package manager. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `deleteOrphanedLockFiles`^Optional ```typescript public readonly deleteOrphanedLockFiles: boolean; ``` - *Type:* boolean - *Default:* true Automatically delete lockfiles from package managers that are not the active one. Only triggered when the lockfile for the configured package manager already exists. This is useful when migrating between package managers to avoid conflicts. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- *Example* ```typescript [ 'express', 'lodash', 'foo@^2' ] ``` ##### `description`^Optional ```typescript 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 ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- *Example* ```typescript [ 'typescript', '@types/express' ] ``` ##### `devEngines`^Optional ```typescript public readonly devEngines: DevEngines; ``` - *Type:* projen.javascript.DevEngines Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. > [https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines) --- ##### `entrypoint`^Optional ```typescript 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 ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `license`^Optional ```typescript 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 ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `maxNodeVersion`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### `npmProvenance`^Optional ```typescript 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](https://docs.npmjs.com/generating-provenance-statements) --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript 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 ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `npmTrustedPublishing`^Optional ```typescript 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 ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails. The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript 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 ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "10.33.0" The version of PNPM to use if using PNPM as a package manager. --- ##### `repository`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript 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 ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `yarnBerryOptions`^Optional ```typescript public readonly yarnBerryOptions: YarnBerryOptions; ``` - *Type:* projen.javascript.YarnBerryOptions - *Default:* Yarn Berry v4 with all default options Options for Yarn Berry. --- ##### `bumpPackage`^Optional ```typescript 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 ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```typescript 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 ```typescript 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 ```typescript 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 ```typescript 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 ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript 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 ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript 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 ```typescript 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 ```typescript 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 ```typescript 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 ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript 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 ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript 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 ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowEnv`^Optional ```typescript public readonly releaseWorkflowEnv: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Build environment variables for release workflows. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `workflowRunsOnGroup`^Optional ```typescript public readonly workflowRunsOnGroup: GroupRunnerOptions; ``` - *Type:* projen.GroupRunnerOptions Github Runner Group selection options. --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `auditDeps`^Optional ```typescript 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 ```typescript public readonly auditDepsOptions: AuditOptions; ``` - *Type:* projen.javascript.AuditOptions - *Default:* default options Security audit options. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `biome`^Optional ```typescript public readonly biome: boolean; ``` - *Type:* boolean - *Default:* false Setup Biome. --- ##### `biomeOptions`^Optional ```typescript public readonly biomeOptions: BiomeOptions; ``` - *Type:* projen.javascript.BiomeOptions - *Default:* default options Biome options. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowOptions`^Optional ```typescript public readonly buildWorkflowOptions: BuildWorkflowOptions; ``` - *Type:* projen.javascript.BuildWorkflowOptions Options for PR build workflow. --- ##### ~~`buildWorkflowTriggers`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers` ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `checkLicenses`^Optional ```typescript public readonly checkLicenses: LicenseCheckerOptions; ``` - *Type:* projen.javascript.LicenseCheckerOptions - *Default:* no license checks are run during the build and all licenses will be accepted Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. --- ##### `codeCov`^Optional ```typescript 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 ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* OIDC auth is used Define the secret name for a specified https://codecov.io/ token. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* `true` for root projects, `false` for subprojects Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### ~~`mutableBuild`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild` ```typescript 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` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript 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 ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `package`^Optional ```typescript 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 ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript 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 ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* true (false for subprojects) Add release management to this project. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `workflowBootstrapSteps`^Optional ```typescript 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 ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* default GitHub Actions user The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript 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 ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true, unless biome is enabled Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `tsJestOptions`^Optional ```typescript public readonly tsJestOptions: TsJestOptions; ``` - *Type:* projen.typescript.TsJestOptions Options for ts-jest. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `enablePRAutoMerge`^Optional ```typescript public readonly enablePRAutoMerge: boolean; ``` - *Type:* boolean - *Default:* true for private projects, false otherwise Whether to enable the auto merge workflow for PRs. This will enable the auto merge workflow as well as the merge queue --- ##### `ghAutoMergeOptions`^Optional ```typescript public readonly ghAutoMergeOptions: AutoQueueOptions; ``` - *Type:* projen.github.AutoQueueOptions - *Default:* default options Options for the GitHub auto merge workflow. That is the workflow that turns on auto merge on all PRs. --- ##### `private`^Optional ```typescript public readonly private: boolean; ``` - *Type:* boolean - *Default:* true Whether or not this package is private. Setting this variable to true means that your project is created with sane defaults for private repositories. --- ##### `setNodeEngineVersion`^Optional ```typescript public readonly setNodeEngineVersion: boolean; ``` - *Type:* boolean - *Default:* true Set a minimal node version via the engines field Set this to `false` if a package did not enforce this previously and we don't want to change this for now. --- ##### `tenancy`^Optional ```typescript public readonly tenancy: OrgTenancy; ``` - *Type:* OrgTenancy - *Default:* Auto detected from package name The organization this project is part of. --- ##### `upgradeCdklabsProjenProjectTypes`^Optional ```typescript public readonly upgradeCdklabsProjenProjectTypes: boolean; ``` - *Type:* boolean - *Default:* true Whether to enable the separate workflow to upgrade the cdklabs-projen-project-types dependencies. --- ##### `upgradeRuntimeDepsAsFix`^Optional ```typescript public readonly upgradeRuntimeDepsAsFix: boolean; ``` - *Type:* boolean - *Default:* true Whether to have a separate workflow to upgrade runtime deps and mark this PR as fix. --- ### ConstraintsOptions #### Initializer ```typescript import { yarn } from 'cdklabs-projen-project-types' const constraintsOptions: yarn.ConstraintsOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | consistentVersions | string[] | Package names that must use a consistent version across all workspaces. | --- ##### `consistentVersions`^Required ```typescript public readonly consistentVersions: string[]; ``` - *Type:* string[] Package names that must use a consistent version across all workspaces. Each package must already be declared as a dev dependency on the monorepo root. The version is enforced across all workspaces using Yarn Berry constraints. --- ### MonorepoOptions MonorepoOptions. #### Initializer ```typescript import { yarn } from 'cdklabs-projen-project-types' const monorepoOptions: yarn.MonorepoOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | defaultReleaseBranch | string | The name of the main release branch. | | name | string | This is the name of your project. | | addPackageManagerToDevEngines | boolean | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | artifactsDirectory | string | A directory which will contain build artifacts. | | auditDeps | boolean | Run security audit on dependencies. | | auditDepsOptions | projen.javascript.AuditOptions | Security audit options. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). | | autoDetectBin | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | biome | boolean | Setup Biome. | | biomeOptions | projen.javascript.BiomeOptions | Biome options. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | buildablePackages | string[] | Packages that should have their build scripts enabled during install. | | buildWithNx | boolean | When Nx is enabled, always build the monorepo using Nx Will build projects in parallel and can improve build performance. | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowOptions | projen.javascript.BuildWorkflowOptions | Options for PR build workflow. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bumpPackage | string | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | bunVersion | string | The version of Bun to use if using Bun as a package manager. | | checkLicenses | projen.javascript.LicenseCheckerOptions | Configure which licenses should be deemed acceptable for use by dependencies. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | 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. | | commitGenerated | boolean | Whether to commit the managed files by default. | | consistentVersions | string[] | Package names that must use a consistent version across all workspaces. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | deleteOrphanedLockFiles | boolean | Automatically delete lockfiles from package managers that are not the active one. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | deps | string[] | Runtime dependencies of this module. | | depsUpgrade | boolean | Use tasks and github workflows to handle dependency upgrades. | | depsUpgradeOptions | projen.javascript.UpgradeDependenciesOptions | Options for `UpgradeDependencies`. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | devDeps | string[] | Build dependencies for this module. | | devEngines | projen.javascript.DevEngines | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docsDirectory | string | Docs directory. | | entrypoint | string | Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitignore | string[] | Additional entries to .gitignore. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | gitpod | boolean | Add a Gitpod development environment. | | homepage | string | Package's Homepage / Website. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | keywords | string[] | Keywords to include in `package.json`. | | libdir | string | Typescript artifacts output directory. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | majorVersion | number | Major version to release from the default branch. | | maxNodeVersion | string | The maximum node version supported by this package. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | minMajorVersion | number | Minimal Major version to release. | | minNodeVersion | string | Minimum Node.js version to require via package.json `engines` (inclusive). | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | nextVersionCommand | string | A shell command to control the next version to release. | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | 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. | | 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. | | nx | boolean | Enable the integration with Nx in the monorepo. | | outdir | string | The root directory of the project. Relative to this directory, all files are synthesized. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | packageName | string | The "name" in package.json. | | parent | projen.Project | The parent project, if this project is part of a bigger project. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | 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"). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | projectTree | boolean | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | 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. | | 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. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | projenVersion | string | Version of projen to install. | | 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. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | readme | projen.SampleReadmeProps | The README setup. | | releasableCommits | projen.ReleasableCommits | Find commits that should be considered releasable Used to decide if a release is required. | | release | boolean | Whether or not to add release workflows for this repository. | | 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. | | releaseOptions | cdklabs-projen-project-types.yarn.MonorepoReleaseOptions | Options for the release workflows. | | releaseSchedule | string | CRON schedule to trigger new releases. | | releaseTagPrefix | string | Automatically add the given prefix to release tags. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | 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. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | repository | string | The repository is the location where the actual code for your package lives. | | repositoryDirectory | string | If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | srcdir | string | Typescript sources directory. | | stability | string | Package's Stability. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | testdir | string | Jest tests directory. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | tsJestOptions | projen.typescript.TsJestOptions | Options for ts-jest. | | typescriptVersion | string | TypeScript version to use. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with commit-and-tag-version package. | | vscode | boolean | Enable VSCode integration. | | vscodeWorkspace | boolean | Create a VSCode multi-root workspace file for all monorepo workspaces. | | vscodeWorkspaceOptions | cdklabs-projen-project-types.yarn.VsCodeWorkspaceOptions | Configuration options for the VSCode multi-root workspace file. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version to use in GitHub workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | workflowRunsOn | string[] | Github Runner selection labels. | | workflowRunsOnGroup | projen.GroupRunnerOptions | Github Runner Group selection options. | | yarnBerry | boolean | Use Yarn Berry as the package manager. | | yarnBerryOptions | projen.javascript.YarnBerryOptions | Options for Yarn Berry. | --- ##### `defaultReleaseBranch`^Required ```typescript public readonly defaultReleaseBranch: string; ``` - *Type:* string - *Default:* "main" The name of the main release branch. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `addPackageManagerToDevEngines`^Optional ```typescript public readonly addPackageManagerToDevEngines: boolean; ``` - *Type:* boolean - *Default:* true Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. --- ##### `allowLibraryDependencies`^Optional ```typescript 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. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `auditDeps`^Optional ```typescript 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 ```typescript public readonly auditDepsOptions: AuditOptions; ``` - *Type:* projen.javascript.AuditOptions - *Default:* default options Security audit options. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `autoDetectBin`^Optional ```typescript 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. --- ##### `autoMerge`^Optional ```typescript 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 ```typescript 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. --- ##### `bin`^Optional ```typescript 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. --- ##### `biome`^Optional ```typescript public readonly biome: boolean; ``` - *Type:* boolean - *Default:* false Setup Biome. --- ##### `biomeOptions`^Optional ```typescript public readonly biomeOptions: BiomeOptions; ``` - *Type:* projen.javascript.BiomeOptions - *Default:* default options Biome options. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `buildablePackages`^Optional ```typescript public readonly buildablePackages: string[]; ``` - *Type:* string[] Packages that should have their build scripts enabled during install. Yarn Berry disables build scripts by default (`enableScripts: false`). This option sets `dependenciesMeta..built: true` in the root `package.json` for each listed package, allowing them to run their install scripts. Only has an effect when the monorepo uses Yarn Berry. --- ##### `buildWithNx`^Optional ```typescript public readonly buildWithNx: boolean; ``` - *Type:* boolean - *Default:* false When Nx is enabled, always build the monorepo using Nx Will build projects in parallel and can improve build performance. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowOptions`^Optional ```typescript public readonly buildWorkflowOptions: BuildWorkflowOptions; ``` - *Type:* projen.javascript.BuildWorkflowOptions Options for PR build workflow. --- ##### ~~`buildWorkflowTriggers`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers` ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bumpPackage`^Optional ```typescript 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`. --- ##### `bundledDeps`^Optional ```typescript 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 `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `bunVersion`^Optional ```typescript public readonly bunVersion: string; ``` - *Type:* string - *Default:* "latest" The version of Bun to use if using Bun as a package manager. --- ##### `checkLicenses`^Optional ```typescript public readonly checkLicenses: LicenseCheckerOptions; ``` - *Type:* projen.javascript.LicenseCheckerOptions - *Default:* no license checks are run during the build and all licenses will be accepted Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `codeCov`^Optional ```typescript 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 ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* OIDC auth is used Define the secret name for a specified https://codecov.io/ token. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `consistentVersions`^Optional ```typescript public readonly consistentVersions: string[]; ``` - *Type:* string[] Package names that must use a consistent version across all workspaces. Uses Yarn Berry constraints to enforce that all workspaces use the same version of the listed packages. The version is read from the root `devDependencies`. Only has an effect when the monorepo uses Yarn Berry. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `deleteOrphanedLockFiles`^Optional ```typescript public readonly deleteOrphanedLockFiles: boolean; ``` - *Type:* boolean - *Default:* true Automatically delete lockfiles from package managers that are not the active one. Only triggered when the lockfile for the configured package manager already exists. This is useful when migrating between package managers to avoid conflicts. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `deps`^Optional ```typescript public readonly deps: string[]; ``` - *Type:* string[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* `true` for root projects, `false` for subprojects Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `depsUpgradeOptions`^Optional ```typescript public readonly depsUpgradeOptions: UpgradeDependenciesOptions; ``` - *Type:* projen.javascript.UpgradeDependenciesOptions - *Default:* default options Options for `UpgradeDependencies`. --- ##### `description`^Optional ```typescript 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 --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `devDeps`^Optional ```typescript public readonly devDeps: string[]; ``` - *Type:* string[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `devEngines`^Optional ```typescript public readonly devEngines: DevEngines; ``` - *Type:* projen.javascript.DevEngines Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### `entrypoint`^Optional ```typescript 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. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `license`^Optional ```typescript 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 ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `majorVersion`^Optional ```typescript 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. --- ##### `maxNodeVersion`^Optional ```typescript 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. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript 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 ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### `minMajorVersion`^Optional ```typescript 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`. --- ##### `minNodeVersion`^Optional ```typescript public readonly minNodeVersion: string; ``` - *Type:* string - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). Only set this if your package will not work properly on specific (older?) Node versions. --- ##### ~~`mutableBuild`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild` ```typescript 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. --- ##### `nextVersionCommand`^Optional ```typescript 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`. --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### `npmDistTag`^Optional ```typescript 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. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript 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 ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `npmProvenance`^Optional ```typescript 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. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript 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 ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `npmTrustedPublishing`^Optional ```typescript 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. --- ##### `nx`^Optional ```typescript public readonly nx: boolean; ``` - *Type:* boolean - *Default:* false Enable the integration with Nx in the monorepo. --- ##### `outdir`^Optional ```typescript 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. --- ##### `package`^Optional ```typescript 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`). --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `parent`^Optional ```typescript public readonly parent: Project; ``` - *Type:* projen.Project The parent project, if this project is part of a bigger project. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript 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 ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "10.33.0" The version of PNPM to use if using PNPM as a package manager. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `projectTree`^Optional ```typescript public readonly projectTree: boolean; ``` - *Type:* boolean - *Default:* false Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCommand`^Optional ```typescript 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. --- ##### `projenCredentials`^Optional ```typescript 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. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript 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. --- ##### `projenrcJson`^Optional ```typescript 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 ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript 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. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript 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. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- ##### `releasableCommits`^Optional ```typescript 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. --- ##### `release`^Optional ```typescript public readonly release: boolean; ``` - *Type:* boolean - *Default:* No release Whether or not to add release workflows for this repository. --- ##### `releaseBranches`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript public readonly releaseFailureIssueLabel: string; ``` - *Type:* string - *Default:* "failed-release" The label to apply to issues indicating publish failures. Only applies if `releaseFailureIssue` is true. --- ##### `releaseOptions`^Optional ```typescript public readonly releaseOptions: MonorepoReleaseOptions; ``` - *Type:* cdklabs-projen-project-types.yarn.MonorepoReleaseOptions Options for the release workflows. --- ##### ~~`releaseSchedule`~~^Optional - *Deprecated:* Use `releaseTrigger: ReleaseTrigger.scheduled()` instead ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript 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. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `releaseWorkflowEnv`^Optional ```typescript public readonly releaseWorkflowEnv: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Build environment variables for release workflows. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `repository`^Optional ```typescript 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 ```typescript 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 ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript 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. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript 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`. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `tsJestOptions`^Optional ```typescript public readonly tsJestOptions: TsJestOptions; ``` - *Type:* projen.typescript.TsJestOptions Options for ts-jest. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `versionrcOptions`^Optional ```typescript 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. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `vscodeWorkspace`^Optional ```typescript public readonly vscodeWorkspace: boolean; ``` - *Type:* boolean - *Default:* false Create a VSCode multi-root workspace file for all monorepo workspaces. --- ##### `vscodeWorkspaceOptions`^Optional ```typescript public readonly vscodeWorkspaceOptions: VsCodeWorkspaceOptions; ``` - *Type:* cdklabs-projen-project-types.yarn.VsCodeWorkspaceOptions - *Default:* default configuration Configuration options for the VSCode multi-root workspace file. --- ##### `workflowBootstrapSteps`^Optional ```typescript 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. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* default GitHub Actions user The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript public readonly workflowNodeVersion: string; ``` - *Type:* string - *Default:* 'lts/*' The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `workflowRunsOnGroup`^Optional ```typescript public readonly workflowRunsOnGroup: GroupRunnerOptions; ``` - *Type:* projen.GroupRunnerOptions Github Runner Group selection options. --- ##### `yarnBerry`^Optional ```typescript public readonly yarnBerry: boolean; ``` - *Type:* boolean - *Default:* false Use Yarn Berry as the package manager. When enabled, the monorepo will use `YARN_BERRY` instead of `YARN_CLASSIC`. `yarnBerryOptions` can be used to further configure Yarn Berry. The `nodeLinker` defaults to `node-modules`. --- ##### `yarnBerryOptions`^Optional ```typescript public readonly yarnBerryOptions: YarnBerryOptions; ``` - *Type:* projen.javascript.YarnBerryOptions - *Default:* Yarn Berry v4 with all default options Options for Yarn Berry. --- ### MonorepoReleaseOptions MonorepoReleaseOptions. #### Initializer ```typescript import { yarn } from 'cdklabs-projen-project-types' const monorepoReleaseOptions: yarn.MonorepoReleaseOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | branchName | string | Branch name to release from. | | buildWithNx | boolean | Build the monorepo using Nx during the release. | | 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. | | nodeVersion | string | Node version to use in the release workflow. | | 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. | | publishToNpm | boolean | Publish packages to npm. | | releasableCommits | projen.ReleasableCommits | Find commits that should be considered releasable Used to decide if a release is required. | | releaseEnvironment | string | The GitHub Actions environment used for the release. | | 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. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | workflowRunsOn | string[] | Github Runner selection labels. | | workflowRunsOnGroup | projen.GroupRunnerOptions | Github Runner Group selection options. | | yarnBerry | boolean | Whether the monorepo uses Yarn Berry. | --- ##### `branchName`^Optional ```typescript public readonly branchName: string; ``` - *Type:* string - *Default:* "main" Branch name to release from. --- ##### `buildWithNx`^Optional ```typescript public readonly buildWithNx: boolean; ``` - *Type:* boolean - *Default:* false Build the monorepo using Nx during the release. Will build projects in parallel and can improve build performance --- ##### `bumpPackage`^Optional ```typescript 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 ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `majorVersion`^Optional ```typescript 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 ```typescript 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 ```typescript 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`. --- ##### `nodeVersion`^Optional ```typescript public readonly nodeVersion: string; ``` - *Type:* string - *Default:* "lts/*" Node version to use in the release workflow. --- ##### `npmDistTag`^Optional ```typescript 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 ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript 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 ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishToNpm`^Optional ```typescript public readonly publishToNpm: boolean; ``` - *Type:* boolean - *Default:* true Publish packages to npm. --- ##### `releasableCommits`^Optional ```typescript 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. --- ##### `releaseEnvironment`^Optional ```typescript 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. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### `releaseWorkflowEnv`^Optional ```typescript public readonly releaseWorkflowEnv: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Build environment variables for release workflows. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `workflowRunsOnGroup`^Optional ```typescript public readonly workflowRunsOnGroup: GroupRunnerOptions; ``` - *Type:* projen.GroupRunnerOptions Github Runner Group selection options. --- ##### `yarnBerry`^Optional ```typescript public readonly yarnBerry: boolean; ``` - *Type:* boolean - *Default:* false Whether the monorepo uses Yarn Berry. When enabled, release tasks use Yarn Berry compatible commands. --- ### ReferenceOptions Options for the `workspace.customizeReference()` method. #### Initializer ```typescript import { yarn } from 'cdklabs-projen-project-types' const referenceOptions: yarn.ReferenceOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | versionType | string | What type of dependency to take on this package. | --- ##### `versionType`^Optional ```typescript public readonly versionType: string; ``` - *Type:* string - *Default:* 'future-minor' What type of dependency to take on this package. By default, dependencies will be referenced with a `^`, which means that come install time a newer version may be installed. Choose a different range type to take, for example, an `exact` dependency. --- ### RosettaOptions #### Initializer ```typescript import { RosettaOptions } from 'cdklabs-projen-project-types' const rosettaOptions: RosettaOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | strict | boolean | Enable or disable strict mode. | | version | string | Set an explicit version of rosetta. | --- ##### `strict`^Optional ```typescript public readonly strict: boolean; ``` - *Type:* boolean - *Default:* true Enable or disable strict mode. --- ##### `version`^Optional ```typescript public readonly version: string; ``` - *Type:* string - *Default:* no version is set, use automatic detection Set an explicit version of rosetta. --- ### TypeScriptWorkspaceOptions TypeScriptWorkspaceOptions. #### Initializer ```typescript import { yarn } from 'cdklabs-projen-project-types' const typeScriptWorkspaceOptions: yarn.TypeScriptWorkspaceOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | name | string | This is the name of your project. | | parent | cdklabs-projen-project-types.yarn.Monorepo | The parent `yarn.Monorepo` project. | | addPackageManagerToDevEngines | boolean | Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. | | allowLibraryDependencies | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`. | | allowPrivateDeps | boolean | Allow private workspace dependencies in the 'deps' parameter. | | artifactsDirectory | string | A directory which will contain build artifacts. | | auditDeps | boolean | Run security audit on dependencies. | | auditDepsOptions | projen.javascript.AuditOptions | Security audit options. | | authorEmail | string | Author's e-mail. | | authorName | string | Author's name. | | authorOrganization | boolean | Is the author an organization. | | authorUrl | string | Author's URL / Website. | | autoApproveOptions | projen.github.AutoApproveOptions | Enable and configure the 'auto approve' workflow. | | autoApproveUpgrades | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). | | autoMerge | boolean | Enable automatic merging on GitHub. | | autoMergeOptions | projen.github.AutoMergeOptions | Configure options for automatic merging on GitHub. | | bin | {[ key: string ]: string} | Binary programs vended with your module. | | biome | boolean | Setup Biome. | | biomeOptions | projen.javascript.BiomeOptions | Biome options. | | bugsEmail | string | The email address to which issues should be reported. | | bugsUrl | string | The url to your project's issue tracker. | | buildWorkflow | boolean | Define a GitHub workflow for building PRs. | | buildWorkflowOptions | projen.javascript.BuildWorkflowOptions | Options for PR build workflow. | | buildWorkflowTriggers | projen.github.workflows.Triggers | Build workflow triggers. | | bumpPackage | string | The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string. | | bundledDeps | string[] | List of dependencies to bundle into this module. | | bundlerOptions | projen.javascript.BundlerOptions | Options for `Bundler`. | | bunVersion | string | The version of Bun to use if using Bun as a package manager. | | checkLicenses | projen.javascript.LicenseCheckerOptions | Configure which licenses should be deemed acceptable for use by dependencies. | | clobber | boolean | Add a `clobber` task which resets the repo to origin. | | codeArtifactOptions | projen.javascript.CodeArtifactOptions | Options for npm packages using AWS CodeArtifact. | | 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. | | commitGenerated | boolean | Whether to commit the managed files by default. | | copyrightOwner | string | License copyright owner. | | copyrightPeriod | string | The copyright years to put in the LICENSE file. | | deleteOrphanedLockFiles | boolean | Automatically delete lockfiles from package managers that are not the active one. | | dependabot | boolean | Use dependabot to handle dependency upgrades. | | dependabotOptions | projen.github.DependabotOptions | Options for dependabot. | | deps | string \| cdklabs-projen-project-types.yarn.IWorkspaceReference[] | Runtime dependencies of this module. | | depsUpgrade | boolean | Use tasks and github workflows to handle dependency upgrades. | | description | string | The description is just a string that helps people understand the purpose of the package. | | devContainer | boolean | Add a VSCode development environment (used for GitHub Codespaces). | | devDeps | string \| cdklabs-projen-project-types.yarn.IWorkspaceReference[] | Build dependencies for this module. | | devEngines | projen.javascript.DevEngines | Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. | | disableTsconfig | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). | | disableTsconfigDev | boolean | Do not generate a `tsconfig.dev.json` file. | | docgen | boolean | Docgen by Typedoc. | | docsDirectory | string | Docs directory. | | entrypoint | string | Module entrypoint (`main` in `package.json`). Set to an empty string to not include `main` in your package.json. | | entrypointTypes | string | The .d.ts file that includes the type declarations for this module. | | eslint | boolean | Setup eslint. | | eslintOptions | projen.javascript.EslintOptions | Eslint options. | | excludeDepsFromUpgrade | string[] | Dependencies that should be excluded from upgrades. | | github | boolean | Enable GitHub integration. | | githubOptions | projen.github.GitHubOptions | Options for GitHub integration. | | gitignore | string[] | Additional entries to .gitignore. | | gitIgnoreOptions | projen.IgnoreFileOptions | Configuration options for .gitignore file. | | gitOptions | projen.GitOptions | Configuration options for git. | | gitpod | boolean | Add a Gitpod development environment. | | hoistingLimits | string | Configure Yarn Berry's `installConfig.hoistingLimits` for this workspace. Sets the `installConfig.hoistingLimits` field in the workspace `package.json`. Accepted values are `workspaces`, `dependencies`, or `none`. Only has an effect when the parent monorepo uses Yarn Berry. | | homepage | string | Package's Homepage / Website. | | jest | boolean | Setup jest unit tests. | | jestOptions | projen.javascript.JestOptions | Jest options. | | jsiiReleaseVersion | string | Version requirement of `publib` which is used to publish modules to npm. | | keywords | string[] | Keywords to include in `package.json`. | | libdir | string | Typescript artifacts output directory. | | license | string | License's SPDX identifier. | | licensed | boolean | Indicates if a license should be added. | | logging | projen.LoggerOptions | Configure logging options such as verbosity. | | majorVersion | number | Major version to release from the default branch. | | maxNodeVersion | string | The maximum node version supported by this package. | | mergify | boolean | Whether mergify should be enabled on this repository or not. | | mergifyOptions | projen.github.MergifyOptions | Options for mergify. | | minMajorVersion | number | Minimal Major version to release. | | minNodeVersion | string | Minimum Node.js version to require via package.json `engines` (inclusive). | | mutableBuild | boolean | Automatically update files modified during builds to pull-request branches. | | nextVersionCommand | string | A shell command to control the next version to release. | | npmAccess | projen.javascript.NpmAccess | Access level of the npm package. | | npmDistTag | string | The npmDistTag to use when publishing from the default branch. | | 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. | | 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. | | package | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). | | packageManager | projen.javascript.NodePackageManager | The Node Package Manager used to execute scripts. | | packageName | string | The "name" in package.json. | | peerDependencyOptions | projen.javascript.PeerDependencyOptions | Options for `peerDeps`. | | peerDeps | string \| cdklabs-projen-project-types.yarn.IWorkspaceReference[] | Peer dependencies for this module. | | pnpmVersion | string | The version of PNPM to use if using PNPM as a package manager. | | 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"). | | prettier | boolean | Setup prettier. | | prettierOptions | projen.javascript.PrettierOptions | Prettier options. | | private | boolean | Make this a private package. | | projectTree | boolean | Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. | | projectType | projen.ProjectType | Which type of project this is (library/app). | | projenCommand | string | The shell command to use in order to run the projen CLI. | | projenCredentials | projen.github.GithubCredentials | Choose a method of providing GitHub API access for projen workflows. | | 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. | | 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. | | projenrcJsOptions | projen.javascript.ProjenrcOptions | Options for .projenrc.js. | | projenrcTs | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`). | | projenrcTsOptions | projen.typescript.ProjenrcOptions | Options for .projenrc.ts. | | projenTokenSecret | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. | | projenVersion | string | Version of projen to install. | | 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. | | pullRequestTemplate | boolean | Include a GitHub pull request template. | | pullRequestTemplateContents | string[] | The contents of the pull request template. | | readme | projen.SampleReadmeProps | The README setup. | | 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. | | releaseToNpm | boolean | Automatically release to npm when new versions are introduced. | | releaseTrigger | projen.release.ReleaseTrigger | The release trigger to use. | | releaseWorkflow | boolean | DEPRECATED: renamed to `release`. | | 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. | | renovatebot | boolean | Use renovatebot to handle dependency upgrades. | | renovatebotOptions | projen.RenovatebotOptions | Options for renovatebot. | | repository | string | The repository is the location where the actual code for your package lives. | | sampleCode | boolean | Generate one-time sample in `src/` and `test/` if there are no files there. | | scopedPackagesOptions | projen.javascript.ScopedPackagesOptions[] | Options for privately hosted scoped packages. | | scripts | {[ key: string ]: string} | npm scripts to include. | | srcdir | string | Typescript sources directory. | | stability | string | Package's Stability. | | stale | boolean | Auto-close of stale issues and pull request. | | staleOptions | projen.github.StaleOptions | Auto-close stale issues and pull requests. | | testdir | string | Jest tests directory. | | tsconfig | projen.javascript.TypescriptConfigOptions | Custom TSConfig. | | tsconfigDev | projen.javascript.TypescriptConfigOptions | Custom tsconfig options for the development tsconfig.json file (used for testing). | | tsconfigDevFile | string | The name of the development tsconfig.json file. | | tsJestOptions | projen.typescript.TsJestOptions | Options for ts-jest. | | typescriptVersion | string | TypeScript version to use. | | versionrcOptions | {[ key: string ]: any} | Custom configuration used when creating changelog with commit-and-tag-version package. | | vscode | boolean | Enable VSCode integration. | | workflowBootstrapSteps | projen.github.workflows.JobStep[] | Workflow steps to use in order to bootstrap this repo. | | workflowContainerImage | string | Container image to use for GitHub workflows. | | workflowGitIdentity | projen.github.GitIdentity | The git identity to use in workflows. | | workflowNodeVersion | string | The node version to use in GitHub workflows. | | workflowPackageCache | boolean | Enable Node.js package cache in GitHub workflows. | | workflowRunsOn | string[] | Github Runner selection labels. | | workflowRunsOnGroup | projen.GroupRunnerOptions | Github Runner Group selection options. | | workspaceScope | string | The workspace scope the package is located in. | | yarnBerryOptions | projen.javascript.YarnBerryOptions | Options for Yarn Berry. | --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string - *Default:* $BASEDIR This is the name of your project. --- ##### `parent`^Required ```typescript public readonly parent: Monorepo; ``` - *Type:* cdklabs-projen-project-types.yarn.Monorepo The parent `yarn.Monorepo` project. --- ##### `addPackageManagerToDevEngines`^Optional ```typescript public readonly addPackageManagerToDevEngines: boolean; ``` - *Type:* boolean - *Default:* true Automatically add the resolved `packageManager` to `devEngines.packageManager` in `package.json`, setting `onFail` to `ignore`. --- ##### `allowLibraryDependencies`^Optional ```typescript 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. --- ##### `allowPrivateDeps`^Optional ```typescript public readonly allowPrivateDeps: boolean; ``` - *Type:* boolean - *Default:* false Allow private workspace dependencies in the 'deps' parameter. By default, private dependencies are not allowed as users will not be able to install your package. It makes sense to relax this check *only* if you are bundling your package. --- ##### `artifactsDirectory`^Optional ```typescript public readonly artifactsDirectory: string; ``` - *Type:* string - *Default:* "dist" A directory which will contain build artifacts. --- ##### `auditDeps`^Optional ```typescript 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 ```typescript public readonly auditDepsOptions: AuditOptions; ``` - *Type:* projen.javascript.AuditOptions - *Default:* default options Security audit options. --- ##### `authorEmail`^Optional ```typescript public readonly authorEmail: string; ``` - *Type:* string Author's e-mail. --- ##### `authorName`^Optional ```typescript public readonly authorName: string; ``` - *Type:* string Author's name. --- ##### `authorOrganization`^Optional ```typescript public readonly authorOrganization: boolean; ``` - *Type:* boolean Is the author an organization. --- ##### `authorUrl`^Optional ```typescript public readonly authorUrl: string; ``` - *Type:* string Author's URL / Website. --- ##### `autoApproveOptions`^Optional ```typescript public readonly autoApproveOptions: AutoApproveOptions; ``` - *Type:* projen.github.AutoApproveOptions - *Default:* auto approve is disabled Enable and configure the 'auto approve' workflow. --- ##### `autoApproveUpgrades`^Optional ```typescript public readonly autoApproveUpgrades: boolean; ``` - *Type:* boolean - *Default:* true Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured). Throw if set to true but `autoApproveOptions` are not defined. --- ##### `autoMerge`^Optional ```typescript 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 ```typescript 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. --- ##### `bin`^Optional ```typescript 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. --- ##### `biome`^Optional ```typescript public readonly biome: boolean; ``` - *Type:* boolean - *Default:* false Setup Biome. --- ##### `biomeOptions`^Optional ```typescript public readonly biomeOptions: BiomeOptions; ``` - *Type:* projen.javascript.BiomeOptions - *Default:* default options Biome options. --- ##### `bugsEmail`^Optional ```typescript public readonly bugsEmail: string; ``` - *Type:* string The email address to which issues should be reported. --- ##### `bugsUrl`^Optional ```typescript public readonly bugsUrl: string; ``` - *Type:* string The url to your project's issue tracker. --- ##### `buildWorkflow`^Optional ```typescript public readonly buildWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Define a GitHub workflow for building PRs. --- ##### `buildWorkflowOptions`^Optional ```typescript public readonly buildWorkflowOptions: BuildWorkflowOptions; ``` - *Type:* projen.javascript.BuildWorkflowOptions Options for PR build workflow. --- ##### ~~`buildWorkflowTriggers`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.workflowTriggers` ```typescript public readonly buildWorkflowTriggers: Triggers; ``` - *Type:* projen.github.workflows.Triggers - *Default:* "{ pullRequest: {}, workflowDispatch: {} }" Build workflow triggers. --- ##### `bumpPackage`^Optional ```typescript 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`. --- ##### `bundledDeps`^Optional ```typescript 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 `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `bundlerOptions`^Optional ```typescript public readonly bundlerOptions: BundlerOptions; ``` - *Type:* projen.javascript.BundlerOptions Options for `Bundler`. --- ##### `bunVersion`^Optional ```typescript public readonly bunVersion: string; ``` - *Type:* string - *Default:* "latest" The version of Bun to use if using Bun as a package manager. --- ##### `checkLicenses`^Optional ```typescript public readonly checkLicenses: LicenseCheckerOptions; ``` - *Type:* projen.javascript.LicenseCheckerOptions - *Default:* no license checks are run during the build and all licenses will be accepted Configure which licenses should be deemed acceptable for use by dependencies. This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered. --- ##### `clobber`^Optional ```typescript public readonly clobber: boolean; ``` - *Type:* boolean - *Default:* true, but false for subprojects Add a `clobber` task which resets the repo to origin. --- ##### `codeArtifactOptions`^Optional ```typescript public readonly codeArtifactOptions: CodeArtifactOptions; ``` - *Type:* projen.javascript.CodeArtifactOptions - *Default:* undefined Options for npm packages using AWS CodeArtifact. This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact --- ##### `codeCov`^Optional ```typescript 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 ```typescript public readonly codeCovTokenSecret: string; ``` - *Type:* string - *Default:* OIDC auth is used Define the secret name for a specified https://codecov.io/ token. --- ##### `commitGenerated`^Optional ```typescript public readonly commitGenerated: boolean; ``` - *Type:* boolean - *Default:* true Whether to commit the managed files by default. --- ##### `copyrightOwner`^Optional ```typescript public readonly copyrightOwner: string; ``` - *Type:* string - *Default:* defaults to the value of authorName or "" if `authorName` is undefined. License copyright owner. --- ##### `copyrightPeriod`^Optional ```typescript public readonly copyrightPeriod: string; ``` - *Type:* string - *Default:* current year The copyright years to put in the LICENSE file. --- ##### `deleteOrphanedLockFiles`^Optional ```typescript public readonly deleteOrphanedLockFiles: boolean; ``` - *Type:* boolean - *Default:* true Automatically delete lockfiles from package managers that are not the active one. Only triggered when the lockfile for the configured package manager already exists. This is useful when migrating between package managers to avoid conflicts. --- ##### `dependabot`^Optional ```typescript public readonly dependabot: boolean; ``` - *Type:* boolean - *Default:* false Use dependabot to handle dependency upgrades. Cannot be used in conjunction with `depsUpgrade`. --- ##### `dependabotOptions`^Optional ```typescript public readonly dependabotOptions: DependabotOptions; ``` - *Type:* projen.github.DependabotOptions - *Default:* default options Options for dependabot. --- ##### `deps`^Optional ```typescript public readonly deps: (string | IWorkspaceReference)[]; ``` - *Type:* string | cdklabs-projen-project-types.yarn.IWorkspaceReference[] - *Default:* [] Runtime dependencies of this module. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `depsUpgrade`^Optional ```typescript public readonly depsUpgrade: boolean; ``` - *Type:* boolean - *Default:* `true` for root projects, `false` for subprojects Use tasks and github workflows to handle dependency upgrades. Cannot be used in conjunction with `dependabot`. --- ##### `description`^Optional ```typescript 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 --- ##### `devContainer`^Optional ```typescript public readonly devContainer: boolean; ``` - *Type:* boolean - *Default:* false Add a VSCode development environment (used for GitHub Codespaces). --- ##### `devDeps`^Optional ```typescript public readonly devDeps: (string | IWorkspaceReference)[]; ``` - *Type:* string | cdklabs-projen-project-types.yarn.IWorkspaceReference[] - *Default:* [] Build dependencies for this module. These dependencies will only be available in your build environment but will not be fetched when this module is consumed. The recommendation is to only specify the module name here (e.g. `express`). This will behave similar to `pnpm 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 `pnpm add` or `npm i` (e.g. `express@^2`) and this will be what your `package.json` will eventually include. --- ##### `devEngines`^Optional ```typescript public readonly devEngines: DevEngines; ``` - *Type:* projen.javascript.DevEngines Configure the `devEngines` field in `package.json`. The `devEngines.packageManager` field is automatically populated based on the resolved `packageManager` value. Any fields provided here are merged with the auto-populated `packageManager` entry. --- ##### `disableTsconfig`^Optional ```typescript public readonly disableTsconfig: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). --- ##### `disableTsconfigDev`^Optional ```typescript public readonly disableTsconfigDev: boolean; ``` - *Type:* boolean - *Default:* false Do not generate a `tsconfig.dev.json` file. --- ##### `docgen`^Optional ```typescript public readonly docgen: boolean; ``` - *Type:* boolean - *Default:* false Docgen by Typedoc. --- ##### `docsDirectory`^Optional ```typescript public readonly docsDirectory: string; ``` - *Type:* string - *Default:* "docs" Docs directory. --- ##### `entrypoint`^Optional ```typescript 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. --- ##### `entrypointTypes`^Optional ```typescript public readonly entrypointTypes: string; ``` - *Type:* string - *Default:* .d.ts file derived from the project's entrypoint (usually lib/index.d.ts) The .d.ts file that includes the type declarations for this module. --- ##### `eslint`^Optional ```typescript public readonly eslint: boolean; ``` - *Type:* boolean - *Default:* true, unless biome is enabled Setup eslint. --- ##### `eslintOptions`^Optional ```typescript public readonly eslintOptions: EslintOptions; ``` - *Type:* projen.javascript.EslintOptions - *Default:* opinionated default options Eslint options. --- ##### `excludeDepsFromUpgrade`^Optional ```typescript public readonly excludeDepsFromUpgrade: string[]; ``` - *Type:* string[] - *Default:* [] Dependencies that should be excluded from upgrades. --- ##### `github`^Optional ```typescript public readonly github: boolean; ``` - *Type:* boolean - *Default:* true Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `githubOptions`^Optional ```typescript public readonly githubOptions: GitHubOptions; ``` - *Type:* projen.github.GitHubOptions - *Default:* see GitHubOptions Options for GitHub integration. --- ##### `gitignore`^Optional ```typescript public readonly gitignore: string[]; ``` - *Type:* string[] Additional entries to .gitignore. --- ##### `gitIgnoreOptions`^Optional ```typescript public readonly gitIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .gitignore file. --- ##### `gitOptions`^Optional ```typescript public readonly gitOptions: GitOptions; ``` - *Type:* projen.GitOptions Configuration options for git. --- ##### `gitpod`^Optional ```typescript public readonly gitpod: boolean; ``` - *Type:* boolean - *Default:* false Add a Gitpod development environment. --- ##### `hoistingLimits`^Optional ```typescript public readonly hoistingLimits: string; ``` - *Type:* string Configure Yarn Berry's `installConfig.hoistingLimits` for this workspace. Sets the `installConfig.hoistingLimits` field in the workspace `package.json`. Accepted values are `workspaces`, `dependencies`, or `none`. Only has an effect when the parent monorepo uses Yarn Berry. --- ##### `homepage`^Optional ```typescript public readonly homepage: string; ``` - *Type:* string Package's Homepage / Website. --- ##### `jest`^Optional ```typescript public readonly jest: boolean; ``` - *Type:* boolean - *Default:* true Setup jest unit tests. --- ##### `jestOptions`^Optional ```typescript public readonly jestOptions: JestOptions; ``` - *Type:* projen.javascript.JestOptions - *Default:* default options Jest options. --- ##### `jsiiReleaseVersion`^Optional ```typescript public readonly jsiiReleaseVersion: string; ``` - *Type:* string - *Default:* "latest" Version requirement of `publib` which is used to publish modules to npm. --- ##### `keywords`^Optional ```typescript public readonly keywords: string[]; ``` - *Type:* string[] Keywords to include in `package.json`. --- ##### `libdir`^Optional ```typescript public readonly libdir: string; ``` - *Type:* string - *Default:* "lib" Typescript artifacts output directory. --- ##### `license`^Optional ```typescript 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 ```typescript public readonly licensed: boolean; ``` - *Type:* boolean - *Default:* true Indicates if a license should be added. --- ##### `logging`^Optional ```typescript public readonly logging: LoggerOptions; ``` - *Type:* projen.LoggerOptions - *Default:* {} Configure logging options such as verbosity. --- ##### `majorVersion`^Optional ```typescript 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. --- ##### `maxNodeVersion`^Optional ```typescript 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. --- ##### ~~`mergify`~~^Optional - *Deprecated:* use `githubOptions.mergify` instead ```typescript 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 ```typescript public readonly mergifyOptions: MergifyOptions; ``` - *Type:* projen.github.MergifyOptions - *Default:* default options Options for mergify. --- ##### `minMajorVersion`^Optional ```typescript 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`. --- ##### `minNodeVersion`^Optional ```typescript public readonly minNodeVersion: string; ``` - *Type:* string - *Default:* no "engines" specified Minimum Node.js version to require via package.json `engines` (inclusive). Only set this if your package will not work properly on specific (older?) Node versions. --- ##### ~~`mutableBuild`~~^Optional - *Deprecated:* - Use `buildWorkflowOptions.mutableBuild` ```typescript 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. --- ##### `nextVersionCommand`^Optional ```typescript 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`. --- ##### `npmAccess`^Optional ```typescript public readonly npmAccess: NpmAccess; ``` - *Type:* projen.javascript.NpmAccess - *Default:* for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`. Access level of the npm package. --- ##### `npmDistTag`^Optional ```typescript 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. --- ##### ~~`npmignore`~~^Optional - *Deprecated:* - use `project.addPackageIgnore` ```typescript public readonly npmignore: string[]; ``` - *Type:* string[] Additional entries to .npmignore. --- ##### `npmignoreEnabled`^Optional ```typescript 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 ```typescript public readonly npmIgnoreOptions: IgnoreFileOptions; ``` - *Type:* projen.IgnoreFileOptions Configuration options for .npmignore file. --- ##### `npmProvenance`^Optional ```typescript 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. --- ##### ~~`npmRegistry`~~^Optional - *Deprecated:* use `npmRegistryUrl` instead ```typescript public readonly npmRegistry: string; ``` - *Type:* string The host name of the npm registry to publish to. Cannot be set together with `npmRegistryUrl`. --- ##### `npmRegistryUrl`^Optional ```typescript 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 ```typescript public readonly npmTokenSecret: string; ``` - *Type:* string - *Default:* "NPM_TOKEN" GitHub secret which contains the NPM token to use when publishing packages. --- ##### `npmTrustedPublishing`^Optional ```typescript 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. --- ##### `package`^Optional ```typescript 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`). --- ##### `packageManager`^Optional ```typescript public readonly packageManager: NodePackageManager; ``` - *Type:* projen.javascript.NodePackageManager - *Default:* Detected from the calling process or `YARN_CLASSIC` if detection fails. The Node Package Manager used to execute scripts. --- ##### `packageName`^Optional ```typescript public readonly packageName: string; ``` - *Type:* string - *Default:* defaults to project name The "name" in package.json. --- ##### `peerDependencyOptions`^Optional ```typescript public readonly peerDependencyOptions: PeerDependencyOptions; ``` - *Type:* projen.javascript.PeerDependencyOptions Options for `peerDeps`. --- ##### `peerDeps`^Optional ```typescript public readonly peerDeps: (string | IWorkspaceReference)[]; ``` - *Type:* string | cdklabs-projen-project-types.yarn.IWorkspaceReference[] - *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 ```typescript public readonly pnpmVersion: string; ``` - *Type:* string - *Default:* "10.33.0" The version of PNPM to use if using PNPM as a package manager. --- ##### `postBuildSteps`^Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] - *Default:* [] Steps to execute after build as part of the release workflow. --- ##### `prerelease`^Optional ```typescript public readonly prerelease: string; ``` - *Type:* string - *Default:* normal semantic versions Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). --- ##### `prettier`^Optional ```typescript public readonly prettier: boolean; ``` - *Type:* boolean - *Default:* false Setup prettier. --- ##### `prettierOptions`^Optional ```typescript public readonly prettierOptions: PrettierOptions; ``` - *Type:* projen.javascript.PrettierOptions - *Default:* default options Prettier options. --- ##### `private`^Optional ```typescript public readonly private: boolean; ``` - *Type:* boolean - *Default:* false Make this a private package. --- ##### `projectTree`^Optional ```typescript public readonly projectTree: boolean; ``` - *Type:* boolean - *Default:* false Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging. --- ##### ~~`projectType`~~^Optional - *Deprecated:* no longer supported at the base project level ```typescript public readonly projectType: ProjectType; ``` - *Type:* projen.ProjectType - *Default:* ProjectType.UNKNOWN Which type of project this is (library/app). --- ##### `projenCommand`^Optional ```typescript 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. --- ##### `projenCredentials`^Optional ```typescript 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. --- ##### `projenDevDependency`^Optional ```typescript public readonly projenDevDependency: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject Indicates of "projen" should be installed as a devDependency. --- ##### `projenrcJs`^Optional ```typescript 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. --- ##### `projenrcJson`^Optional ```typescript 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 ```typescript public readonly projenrcJsonOptions: ProjenrcJsonOptions; ``` - *Type:* projen.ProjenrcJsonOptions - *Default:* default options Options for .projenrc.json. --- ##### `projenrcJsOptions`^Optional ```typescript public readonly projenrcJsOptions: ProjenrcOptions; ``` - *Type:* projen.javascript.ProjenrcOptions - *Default:* default options Options for .projenrc.js. --- ##### `projenrcTs`^Optional ```typescript public readonly projenrcTs: boolean; ``` - *Type:* boolean - *Default:* false Use TypeScript for your projenrc file (`.projenrc.ts`). --- ##### `projenrcTsOptions`^Optional ```typescript public readonly projenrcTsOptions: ProjenrcOptions; ``` - *Type:* projen.typescript.ProjenrcOptions Options for .projenrc.ts. --- ##### ~~`projenTokenSecret`~~^Optional - *Deprecated:* use `projenCredentials` ```typescript 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. --- ##### `projenVersion`^Optional ```typescript public readonly projenVersion: string; ``` - *Type:* string - *Default:* Defaults to the latest version. Version of projen to install. --- ##### `publishDryRun`^Optional ```typescript public readonly publishDryRun: boolean; ``` - *Type:* boolean - *Default:* false Instead of actually publishing to package managers, just print the publishing command. --- ##### `publishTasks`^Optional ```typescript 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. --- ##### `pullRequestTemplate`^Optional ```typescript public readonly pullRequestTemplate: boolean; ``` - *Type:* boolean - *Default:* true Include a GitHub pull request template. --- ##### `pullRequestTemplateContents`^Optional ```typescript public readonly pullRequestTemplateContents: string[]; ``` - *Type:* string[] - *Default:* default content The contents of the pull request template. --- ##### `readme`^Optional ```typescript public readonly readme: SampleReadmeProps; ``` - *Type:* projen.SampleReadmeProps - *Default:* { filename: 'README.md', contents: '# replace this' } The README setup. --- ##### `releasableCommits`^Optional ```typescript 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 ```typescript 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 ```typescript 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 ```typescript public readonly releaseEveryCommit: boolean; ``` - *Type:* boolean - *Default:* true Automatically release new versions every commit to one of branches in `releaseBranches`. --- ##### `releaseFailureIssue`^Optional ```typescript public readonly releaseFailureIssue: boolean; ``` - *Type:* boolean - *Default:* false Create a github issue on every failed publishing task. --- ##### `releaseFailureIssueLabel`^Optional ```typescript 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 ```typescript public readonly releaseSchedule: string; ``` - *Type:* string - *Default:* no scheduled releases CRON schedule to trigger new releases. --- ##### `releaseTagPrefix`^Optional ```typescript 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. --- ##### `releaseToNpm`^Optional ```typescript public readonly releaseToNpm: boolean; ``` - *Type:* boolean - *Default:* false Automatically release to npm when new versions are introduced. --- ##### `releaseTrigger`^Optional ```typescript public readonly releaseTrigger: ReleaseTrigger; ``` - *Type:* projen.release.ReleaseTrigger - *Default:* Continuous releases (`ReleaseTrigger.continuous()`) The release trigger to use. --- ##### ~~`releaseWorkflow`~~^Optional - *Deprecated:* see `release`. ```typescript public readonly releaseWorkflow: boolean; ``` - *Type:* boolean - *Default:* true if not a subproject DEPRECATED: renamed to `release`. --- ##### `releaseWorkflowEnv`^Optional ```typescript public readonly releaseWorkflowEnv: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} - *Default:* {} Build environment variables for release workflows. --- ##### `releaseWorkflowName`^Optional ```typescript public readonly releaseWorkflowName: string; ``` - *Type:* string - *Default:* "release" The name of the default release workflow. --- ##### `releaseWorkflowSetupSteps`^Optional ```typescript public readonly releaseWorkflowSetupSteps: JobStep[]; ``` - *Type:* projen.github.workflows.JobStep[] A set of workflow steps to execute in order to setup the workflow container. --- ##### `renovatebot`^Optional ```typescript public readonly renovatebot: boolean; ``` - *Type:* boolean - *Default:* false Use renovatebot to handle dependency upgrades. --- ##### `renovatebotOptions`^Optional ```typescript public readonly renovatebotOptions: RenovatebotOptions; ``` - *Type:* projen.RenovatebotOptions - *Default:* default options Options for renovatebot. --- ##### `repository`^Optional ```typescript 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 --- ##### `sampleCode`^Optional ```typescript public readonly sampleCode: boolean; ``` - *Type:* boolean - *Default:* true Generate one-time sample in `src/` and `test/` if there are no files there. --- ##### `scopedPackagesOptions`^Optional ```typescript public readonly scopedPackagesOptions: ScopedPackagesOptions[]; ``` - *Type:* projen.javascript.ScopedPackagesOptions[] - *Default:* fetch all scoped packages from the public npm registry Options for privately hosted scoped packages. --- ##### ~~`scripts`~~^Optional - *Deprecated:* use `project.addTask()` or `package.setScript()` ```typescript 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. --- ##### `srcdir`^Optional ```typescript public readonly srcdir: string; ``` - *Type:* string - *Default:* "src" Typescript sources directory. --- ##### `stability`^Optional ```typescript public readonly stability: string; ``` - *Type:* string Package's Stability. --- ##### `stale`^Optional ```typescript public readonly stale: boolean; ``` - *Type:* boolean - *Default:* false Auto-close of stale issues and pull request. See `staleOptions` for options. --- ##### `staleOptions`^Optional ```typescript 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`. --- ##### `testdir`^Optional ```typescript public readonly testdir: string; ``` - *Type:* string - *Default:* "test" Jest tests directory. Tests files should be named `xxx.test.ts`. If this directory is under `srcdir` (e.g. `src/test`, `src/__tests__`), then tests are going to be compiled into `lib/` and executed as javascript. If the test directory is outside of `src`, then we configure jest to compile the code in-memory. --- ##### `tsconfig`^Optional ```typescript public readonly tsconfig: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* default options Custom TSConfig. --- ##### `tsconfigDev`^Optional ```typescript public readonly tsconfigDev: TypescriptConfigOptions; ``` - *Type:* projen.javascript.TypescriptConfigOptions - *Default:* use the production tsconfig options Custom tsconfig options for the development tsconfig.json file (used for testing). --- ##### `tsconfigDevFile`^Optional ```typescript public readonly tsconfigDevFile: string; ``` - *Type:* string - *Default:* "tsconfig.dev.json" The name of the development tsconfig.json file. --- ##### `tsJestOptions`^Optional ```typescript public readonly tsJestOptions: TsJestOptions; ``` - *Type:* projen.typescript.TsJestOptions Options for ts-jest. --- ##### `typescriptVersion`^Optional ```typescript public readonly typescriptVersion: string; ``` - *Type:* string - *Default:* "latest" TypeScript version to use. NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a `~` dependency (e.g. `~1.2.3`). --- ##### `versionrcOptions`^Optional ```typescript 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. --- ##### `vscode`^Optional ```typescript public readonly vscode: boolean; ``` - *Type:* boolean - *Default:* true Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects. --- ##### `workflowBootstrapSteps`^Optional ```typescript 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. --- ##### `workflowContainerImage`^Optional ```typescript public readonly workflowContainerImage: string; ``` - *Type:* string - *Default:* default image Container image to use for GitHub workflows. --- ##### `workflowGitIdentity`^Optional ```typescript public readonly workflowGitIdentity: GitIdentity; ``` - *Type:* projen.github.GitIdentity - *Default:* default GitHub Actions user The git identity to use in workflows. --- ##### `workflowNodeVersion`^Optional ```typescript public readonly workflowNodeVersion: string; ``` - *Type:* string - *Default:* 'lts/*' The node version to use in GitHub workflows. --- ##### `workflowPackageCache`^Optional ```typescript public readonly workflowPackageCache: boolean; ``` - *Type:* boolean - *Default:* false Enable Node.js package cache in GitHub workflows. --- ##### `workflowRunsOn`^Optional ```typescript public readonly workflowRunsOn: string[]; ``` - *Type:* string[] - *Default:* ["ubuntu-latest"] Github Runner selection labels. --- ##### `workflowRunsOnGroup`^Optional ```typescript public readonly workflowRunsOnGroup: GroupRunnerOptions; ``` - *Type:* projen.GroupRunnerOptions Github Runner Group selection options. --- ##### `workspaceScope`^Optional ```typescript public readonly workspaceScope: string; ``` - *Type:* string - *Default:* "packages" The workspace scope the package is located in. --- ##### `yarnBerryOptions`^Optional ```typescript public readonly yarnBerryOptions: YarnBerryOptions; ``` - *Type:* projen.javascript.YarnBerryOptions - *Default:* Yarn Berry v4 with all default options Options for Yarn Berry. --- ### VsCodeWorkspaceOptions VsCodeWorkspaceOptions. #### Initializer ```typescript import { yarn } from 'cdklabs-projen-project-types' const vsCodeWorkspaceOptions: yarn.VsCodeWorkspaceOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | includeRootWorkspace | boolean | Adds a workspace for the repository root. | | rootWorkspaceName | string | The name of the root workspace if included. | --- ##### `includeRootWorkspace`^Optional ```typescript public readonly includeRootWorkspace: boolean; ``` - *Type:* boolean - *Default:* false Adds a workspace for the repository root. This can be useful to manage the repository configuration. --- ##### `rootWorkspaceName`^Optional ```typescript public readonly rootWorkspaceName: string; ``` - *Type:* string - *Default:* The name of the root workspace if included. --- ### WorkspaceReleaseOptions #### Initializer ```typescript import { yarn } from 'cdklabs-projen-project-types' const workspaceReleaseOptions: yarn.WorkspaceReleaseOptions = { ... } ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | private | boolean | *No description.* | | versionBranchOptions | projen.VersionBranchOptions | *No description.* | | environment | string | *No description.* | | nextVersionCommand | string | *No description.* | | npmDistTag | string | *No description.* | | npmTrustedPublishing | boolean | *No description.* | | publishToNpm | boolean | *No description.* | | releasableCommits | projen.ReleasableCommits | *No description.* | | repoRuntimeDependencies | {[ key: string ]: string} | For runtime and peer dependencies, the type of dependency we take on each package. | | workflowNodeVersion | string | *No description.* | --- ##### `private`^Required ```typescript public readonly private: boolean; ``` - *Type:* boolean --- ##### `versionBranchOptions`^Required ```typescript public readonly versionBranchOptions: VersionBranchOptions; ``` - *Type:* projen.VersionBranchOptions --- ##### `environment`^Optional ```typescript public readonly environment: string; ``` - *Type:* string --- ##### `nextVersionCommand`^Optional ```typescript public readonly nextVersionCommand: string; ``` - *Type:* string --- ##### `npmDistTag`^Optional ```typescript public readonly npmDistTag: string; ``` - *Type:* string --- ##### `npmTrustedPublishing`^Optional ```typescript public readonly npmTrustedPublishing: boolean; ``` - *Type:* boolean --- ##### `publishToNpm`^Optional ```typescript public readonly publishToNpm: boolean; ``` - *Type:* boolean --- ##### `releasableCommits`^Optional ```typescript public readonly releasableCommits: ReleasableCommits; ``` - *Type:* projen.ReleasableCommits --- ##### `repoRuntimeDependencies`^Optional ```typescript public readonly repoRuntimeDependencies: {[ key: string ]: string}; ``` - *Type:* {[ key: string ]: string} For runtime and peer dependencies, the type of dependency we take on each package. --- ##### `workflowNodeVersion`^Optional ```typescript public readonly workflowNodeVersion: string; ``` - *Type:* string - *Default:* 'lts/*' --- ## Protocols ### IDependencyResolver - *Implemented By:* cdklabs-projen-project-types.yarn.IDependencyResolver #### Methods | **Name** | **Description** | | --- | --- | | resolveDepsAndWritePackageJson | *No description.* | --- ##### `resolveDepsAndWritePackageJson` ```typescript public resolveDepsAndWritePackageJson(): string[] ``` ### IWorkspaceReference - *Implemented By:* cdklabs-projen-project-types.yarn.TypeScriptWorkspace, cdklabs-projen-project-types.yarn.IWorkspaceReference A reference to a workspace in the same monorepo. This can be used to reference packages in the same monorepo when declaring `deps` and `devDeps`. By default, all `TypeScriptWorkspace`s implement this interface, representing themselves with a `^` dependency and a restriction that public packages must have public dependencies. The method `.customizeReference({ ... })` can be used to create a workspace reference with different behavior. #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | isPrivatePackage | boolean | Whether the referenced workspace package is private. | | name | string | The dependency name of the package. | | outdir | string | The directory that holds this package in the monorepo. | | versionType | string | The semver range that should be used to reference this package when it is released. | --- ##### `isPrivatePackage`^Required ```typescript public readonly isPrivatePackage: boolean; ``` - *Type:* boolean Whether the referenced workspace package is private. --- ##### `name`^Required ```typescript public readonly name: string; ``` - *Type:* string The dependency name of the package. --- ##### `outdir`^Required ```typescript public readonly outdir: string; ``` - *Type:* string The directory that holds this package in the monorepo. --- ##### `versionType`^Required ```typescript public readonly versionType: string; ``` - *Type:* string The semver range that should be used to reference this package when it is released. --- ## Enums ### JsiiLanguage #### Members | **Name** | **Description** | | --- | --- | | PYTHON | *No description.* | | JAVA | *No description.* | | DOTNET | *No description.* | | GO | *No description.* | --- ##### `PYTHON` --- ##### `JAVA` --- ##### `DOTNET` --- ##### `GO` --- ### OrgTenancy #### Members | **Name** | **Description** | | --- | --- | | CDKLABS | *No description.* | | AWS | *No description.* | --- ##### `CDKLABS` --- ##### `AWS` ---