# API Reference
**Classes**
Name|Description
----|-----------
[Component](#projen-component)|Represents a project component.
[Dependencies](#projen-dependencies)|The `Dependencies` component is responsible to track the list of dependencies a project has, and then used by project types as the model for rendering project-specific dependency manifests such as the dependencies section `package.json` files.
[DevEnvironmentDockerImage](#projen-devenvironmentdockerimage)|Options for specifying the Docker image of the container.
[DockerCompose](#projen-dockercompose)|Create a docker-compose YAML file.
[DockerComposeService](#projen-dockercomposeservice)|A docker-compose service.
[FileBase](#projen-filebase)|*No description*
[GitAttributesFile](#projen-gitattributesfile)|Assign attributes to file names in a git repository.
[Gitpod](#projen-gitpod)|The Gitpod component which emits .gitpod.yml.
[IgnoreFile](#projen-ignorefile)|*No description*
[IniFile](#projen-inifile)|Represents an INI file.
[JsonFile](#projen-jsonfile)|Represents a JSON file.
[JsonPatch](#projen-jsonpatch)|Utility for applying RFC-6902 JSON-Patch to a document.
[License](#projen-license)|*No description*
[Logger](#projen-logger)|Project-level logging utilities.
[Makefile](#projen-makefile)|Minimal Makefile.
[ObjectFile](#projen-objectfile)|Represents an Object file.
[Project](#projen-project)|Base project.
[ProjectBuild](#projen-projectbuild)|Manages a standard build process for all projects.
[Projects](#projen-projects)|Programmatic API for projen.
[Projenrc](#projen-projenrc)|*No description*
[ProjenrcFile](#projen-projenrcfile)|A component representing the projen runtime configuration.
[ProjenrcJson](#projen-projenrcjson)|Sets up a project to use JSON for projenrc.
[Renovatebot](#projen-renovatebot)|Defines renovatebot configuration for projen project.
[SampleDir](#projen-sampledir)|Renders the given files into the directory if the directory does not exist.
[SampleFile](#projen-samplefile)|Produces a file with the given contents but only once, if the file doesn't already exist.
[SampleReadme](#projen-samplereadme)|Represents a README.md sample file. You are expected to manage this file after creation.
[Semver](#projen-semver)|*No description*
[SourceCode](#projen-sourcecode)|Represents a source file.
[Task](#projen-task)|A task that can be performed on the project.
[TaskRuntime](#projen-taskruntime)|The runtime component of the tasks engine.
[Tasks](#projen-tasks)|Defines project tasks.
[Testing](#projen-testing)|A Testing static class with a .synth helper for getting a snapshots of construct outputs. Useful for snapshot testing with Jest.
[TextFile](#projen-textfile)|A text file.
[TomlFile](#projen-tomlfile)|Represents a TOML file.
[Version](#projen-version)|*No description*
[XmlFile](#projen-xmlfile)|Represents an XML file.
[YamlFile](#projen-yamlfile)|Represents a YAML file.
[awscdk.AutoDiscover](#projen-awscdk-autodiscover)|Discovers and creates integration tests and lambdas from code in the project's source and test trees.
[awscdk.AwsCdkConstructLibrary](#projen-awscdk-awscdkconstructlibrary)|AWS CDK construct library project.
[awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)|Manages dependencies on the AWS CDK.
[awscdk.AwsCdkDepsJava](#projen-awscdk-awscdkdepsjava)|Manages dependencies on the AWS CDK for Java projects.
[awscdk.AwsCdkDepsJs](#projen-awscdk-awscdkdepsjs)|Manages dependencies on the AWS CDK for Node.js projects.
[awscdk.AwsCdkDepsPy](#projen-awscdk-awscdkdepspy)|Manages dependencies on the AWS CDK for Python projects.
[awscdk.AwsCdkJavaApp](#projen-awscdk-awscdkjavaapp)|AWS CDK app in Java.
[awscdk.AwsCdkPythonApp](#projen-awscdk-awscdkpythonapp)|AWS CDK app in Python.
[awscdk.AwsCdkTypeScriptApp](#projen-awscdk-awscdktypescriptapp)|AWS CDK app in TypeScript.
[awscdk.CdkConfig](#projen-awscdk-cdkconfig)|Represents cdk.json file.
[awscdk.CdkTasks](#projen-awscdk-cdktasks)|Adds standard AWS CDK tasks to your project.
[awscdk.ConstructLibraryAws](#projen-awscdk-constructlibraryaws)|*No description*
[awscdk.EdgeLambdaAutoDiscover](#projen-awscdk-edgelambdaautodiscover)|Creates edge lambdas from entry points discovered in the project's source tree.
[awscdk.IntegrationTest](#projen-awscdk-integrationtest)|Cloud integration tests.
[awscdk.IntegrationTestAutoDiscover](#projen-awscdk-integrationtestautodiscover)|Creates integration tests from entry points discovered in the test tree.
[awscdk.LambdaAutoDiscover](#projen-awscdk-lambdaautodiscover)|Creates lambdas from entry points discovered in the project's source tree.
[awscdk.LambdaExtension](#projen-awscdk-lambdaextension)|Create a Lambda Extension.
[awscdk.LambdaExtensionAutoDiscover](#projen-awscdk-lambdaextensionautodiscover)|Creates Lambda Extensions from entrypoints discovered in the project's source tree.
[awscdk.LambdaFunction](#projen-awscdk-lambdafunction)|Generates a pre-bundled AWS Lambda function construct from handler code.
[awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime)|The runtime for the AWS Lambda function.
[build.BuildWorkflow](#projen-build-buildworkflow)|*No description*
[cdk.AutoDiscoverBase](#projen-cdk-autodiscoverbase)|Base class for auto-discovering and creating project subcomponents.
[cdk.ConstructLibrary](#projen-cdk-constructlibrary)|A multi-language library for CDK constructs.
[cdk.IntegrationTestAutoDiscoverBase](#projen-cdk-integrationtestautodiscoverbase)|Base class for locating integration tests in the project's test tree.
[cdk.IntegrationTestBase](#projen-cdk-integrationtestbase)|*No description*
[cdk.JsiiDocgen](#projen-cdk-jsiidocgen)|Creates a markdown file based on the jsii manifest: - Adds a `docgen` script to package.json - Runs `jsii-docgen` after compilation - Enforces that markdown file is checked in.
[cdk.JsiiProject](#projen-cdk-jsiiproject)|Multi-language jsii library project.
[cdk8s.AutoDiscover](#projen-cdk8s-autodiscover)|Automatically discovers and creates `IntegrationTest`s from entry points found in the test tree.
[cdk8s.Cdk8sDeps](#projen-cdk8s-cdk8sdeps)|Manages dependencies on the CDK8s.
[cdk8s.Cdk8sDepsPy](#projen-cdk8s-cdk8sdepspy)|*No description*
[cdk8s.Cdk8sPythonApp](#projen-cdk8s-cdk8spythonapp)|CDK8s app in Python.
[cdk8s.Cdk8sTypeScriptApp](#projen-cdk8s-cdk8stypescriptapp)|CDK8s app in TypeScript.
[cdk8s.ConstructLibraryCdk8s](#projen-cdk8s-constructlibrarycdk8s)|CDK8s construct library project.
[cdk8s.IntegrationTest](#projen-cdk8s-integrationtest)|CDK8S integration test.
[cdk8s.IntegrationTestAutoDiscover](#projen-cdk8s-integrationtestautodiscover)|Discovers and creates integration tests from files in the test root.
[cdktf.ConstructLibraryCdktf](#projen-cdktf-constructlibrarycdktf)|CDKTF construct library project.
[circleci.Circleci](#projen-circleci-circleci)|Circleci Class to manage `.circleci/config.yml`. Check projen's docs for more information.
[github.AutoApprove](#projen-github-autoapprove)|Auto approve pull requests that meet a criteria.
[github.AutoMerge](#projen-github-automerge)|Sets up mergify to merging approved pull requests.
[github.Dependabot](#projen-github-dependabot)|Defines dependabot configuration for node projects.
[github.GitHub](#projen-github-github)|*No description*
[github.GitHubActionsProvider](#projen-github-githubactionsprovider)|Manage the versions used for GitHub Actions used in steps.
[github.GitHubProject](#projen-github-githubproject)|GitHub-based project.
[github.GithubCredentials](#projen-github-githubcredentials)|Represents a method of providing GitHub API access for projen workflows.
[github.GithubWorkflow](#projen-github-githubworkflow)|Workflow for GitHub.
[github.Mergify](#projen-github-mergify)|*No description*
[github.PullRequestLint](#projen-github-pullrequestlint)|Configure validations to run on GitHub pull requests.
[github.PullRequestTemplate](#projen-github-pullrequesttemplate)|Template for GitHub pull requests.
[github.Stale](#projen-github-stale)|Warns and then closes issues and PRs that have had no activity for a specified amount of time.
[github.TaskWorkflow](#projen-github-taskworkflow)|A GitHub workflow for common build tasks within a project.
[github.WorkflowActions](#projen-github-workflowactions)|A set of utility functions for creating GitHub actions in workflows.
[github.WorkflowJobs](#projen-github-workflowjobs)|A set of utility functions for creating jobs in GitHub Workflows.
[gitlab.CiConfiguration](#projen-gitlab-ciconfiguration)|CI for GitLab.
[gitlab.GitlabConfiguration](#projen-gitlab-gitlabconfiguration)|A GitLab CI for the main `.gitlab-ci.yml` file.
[gitlab.NestedConfiguration](#projen-gitlab-nestedconfiguration)|A GitLab CI for templates that are created and included in the `.gitlab-ci.yml` file.
[java.JavaProject](#projen-java-javaproject)|Java project.
[java.Junit](#projen-java-junit)|Implements JUnit-based testing.
[java.MavenCompile](#projen-java-mavencompile)|Adds the maven-compiler plugin to a POM file and the `compile` task.
[java.MavenPackaging](#projen-java-mavenpackaging)|Configures a maven project to produce a .jar archive with sources and javadocs.
[java.MavenSample](#projen-java-mavensample)|Java code sample.
[java.Pom](#projen-java-pom)|A Project Object Model or POM is the fundamental unit of work in Maven.
[java.Projenrc](#projen-java-projenrc)|Allows writing projenrc files in java.
[javascript.Bundler](#projen-javascript-bundler)|Adds support for bundling JavaScript applications and dependencies into a single file.
[javascript.Eslint](#projen-javascript-eslint)|Represents eslint configuration.
[javascript.Jest](#projen-javascript-jest)|Installs the following npm scripts:.
[javascript.JestReporter](#projen-javascript-jestreporter)|*No description*
[javascript.NodePackage](#projen-javascript-nodepackage)|Represents the npm `package.json` file.
[javascript.NodeProject](#projen-javascript-nodeproject)|Node.js project.
[javascript.NpmConfig](#projen-javascript-npmconfig)|File representing the local NPM config in .npmrc.
[javascript.Prettier](#projen-javascript-prettier)|Represents prettier configuration.
[javascript.Projenrc](#projen-javascript-projenrc)|Sets up a javascript project to use TypeScript for projenrc.
[javascript.Transform](#projen-javascript-transform)|*No description*
[javascript.TypescriptConfig](#projen-javascript-typescriptconfig)|*No description*
[javascript.TypescriptConfigExtends](#projen-javascript-typescriptconfigextends)|Container for `TypescriptConfig` `tsconfig.json` base configuration(s). Extending from more than one base config file requires TypeScript 5.0+.
[javascript.UpgradeDependencies](#projen-javascript-upgradedependencies)|Upgrade node project dependencies.
[javascript.UpgradeDependenciesSchedule](#projen-javascript-upgradedependenciesschedule)|How often to check for new versions and raise pull requests for version upgrades.
[javascript.WatchPlugin](#projen-javascript-watchplugin)|*No description*
[python.Pip](#projen-python-pip)|Manages dependencies using a requirements.txt file and the pip CLI tool.
[python.Poetry](#projen-python-poetry)|Manage project dependencies, virtual environments, and packaging through the poetry CLI tool.
[python.PoetryPyproject](#projen-python-poetrypyproject)|Represents configuration of a pyproject.toml file for a Poetry project.
[python.Projenrc](#projen-python-projenrc)|Allows writing projenrc files in python.
[python.Pytest](#projen-python-pytest)|*No description*
[python.PytestSample](#projen-python-pytestsample)|Python test code sample.
[python.PythonProject](#projen-python-pythonproject)|Python project.
[python.PythonSample](#projen-python-pythonsample)|Python code sample.
[python.RequirementsFile](#projen-python-requirementsfile)|Specifies a list of packages to be installed using pip.
[python.SetupPy](#projen-python-setuppy)|Python packaging script where package metadata can be placed.
[python.Setuptools](#projen-python-setuptools)|Manages packaging through setuptools with a setup.py script.
[python.Venv](#projen-python-venv)|Manages a virtual environment through the Python venv module.
[release.Publisher](#projen-release-publisher)|Implements GitHub jobs for publishing modules to package managers.
[release.Release](#projen-release-release)|Manages releases (currently through GitHub workflows).
[release.ReleaseTrigger](#projen-release-releasetrigger)|Used to manage release strategies.
[typescript.Projenrc](#projen-typescript-projenrc)|Sets up a typescript project to use TypeScript for projenrc.
[typescript.ProjenrcTs](#projen-typescript-projenrcts)|A projenrc file written in TypeScript.
[typescript.TypeScriptAppProject](#projen-typescript-typescriptappproject)|TypeScript app.
[typescript.TypeScriptLibraryProject](#projen-typescript-typescriptlibraryproject)|*No description*
[typescript.TypeScriptProject](#projen-typescript-typescriptproject)|TypeScript project.
[typescript.TypedocDocgen](#projen-typescript-typedocdocgen)|Adds a simple Typescript documentation generator.
[vscode.DevContainer](#projen-vscode-devcontainer)|A development environment running VSCode in a container;
[vscode.VsCode](#projen-vscode-vscode)|*No description*
[vscode.VsCodeLaunchConfig](#projen-vscode-vscodelaunchconfig)|VSCode launch configuration file (launch.json), useful for enabling in-editor debugger.
[vscode.VsCodeRecommendedExtensions](#projen-vscode-vscoderecommendedextensions)|VS Code Workspace recommended extensions Source: https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions.
[vscode.VsCodeSettings](#projen-vscode-vscodesettings)|VS Code Workspace settings Source: https://code.visualstudio.com/docs/getstarted/settings#_workspace-settings.
[web.NextComponent](#projen-web-nextcomponent)|*No description*
[web.NextJsProject](#projen-web-nextjsproject)|Next.js project without TypeScript.
[web.NextJsTypeScriptProject](#projen-web-nextjstypescriptproject)|Next.js project with TypeScript.
[web.PostCss](#projen-web-postcss)|Declares a PostCSS dependency with a default config file.
[web.ReactComponent](#projen-web-reactcomponent)|*No description*
[web.ReactProject](#projen-web-reactproject)|React project without TypeScript.
[web.ReactTypeDef](#projen-web-reacttypedef)|*No description*
[web.ReactTypeScriptProject](#projen-web-reacttypescriptproject)|React project with TypeScript.
[web.TailwindConfig](#projen-web-tailwindconfig)|Declares a Tailwind CSS configuration file.
**Structs**
Name|Description
----|-----------
[CreateProjectOptions](#projen-createprojectoptions)|*No description*
[Dependency](#projen-dependency)|Represents a project dependency.
[DependencyCoordinates](#projen-dependencycoordinates)|Coordinates of the dependency (name and version).
[DepsManifest](#projen-depsmanifest)|*No description*
[DevEnvironmentOptions](#projen-devenvironmentoptions)|Base options for configuring a container-based development environment.
[DockerComposeBuild](#projen-dockercomposebuild)|Build arguments for creating a docker image.
[DockerComposeNetworkConfig](#projen-dockercomposenetworkconfig)|Network configuration.
[DockerComposeNetworkIpamConfig](#projen-dockercomposenetworkipamconfig)|IPAM configuration.
[DockerComposeNetworkIpamSubnetConfig](#projen-dockercomposenetworkipamsubnetconfig)|IPAM subnet configuration.
[DockerComposePortMappingOptions](#projen-dockercomposeportmappingoptions)|Options for port mappings.
[DockerComposeProps](#projen-dockercomposeprops)|Props for DockerCompose.
[DockerComposeServiceDescription](#projen-dockercomposeservicedescription)|Description of a docker-compose.yml service.
[DockerComposeServicePort](#projen-dockercomposeserviceport)|A service port mapping.
[DockerComposeVolumeConfig](#projen-dockercomposevolumeconfig)|Volume configuration.
[DockerComposeVolumeMount](#projen-dockercomposevolumemount)|Service volume mounting information.
[FileBaseOptions](#projen-filebaseoptions)|*No description*
[GitOptions](#projen-gitoptions)|Git configuration options.
[GitpodOptions](#projen-gitpodoptions)|Constructor options for the Gitpod component.
[GitpodPort](#projen-gitpodport)|Options for an exposed port on Gitpod.
[GitpodPrebuilds](#projen-gitpodprebuilds)|Configure the Gitpod App for prebuilds.
[GitpodTask](#projen-gitpodtask)|Configure options for a task to be run when opening a Gitpod workspace (e.g. running tests, or starting a dev server).
[IgnoreFileOptions](#projen-ignorefileoptions)|*No description*
[IniFileOptions](#projen-inifileoptions)|Options for `IniFile`.
[InitProject](#projen-initproject)|Information passed from `projen new` to the project object when the project is first created.
[JsonFileOptions](#projen-jsonfileoptions)|Options for `JsonFile`.
[LicenseOptions](#projen-licenseoptions)|*No description*
[LoggerOptions](#projen-loggeroptions)|Options for logging utilities.
[MakefileOptions](#projen-makefileoptions)|Options for Makefiles.
[ObjectFileOptions](#projen-objectfileoptions)|Options for `ObjectFile`.
[ProjectOptions](#projen-projectoptions)|Options for `Project`.
[ProjenrcJsonOptions](#projen-projenrcjsonoptions)|*No description*
[ProjenrcOptions](#projen-projenrcoptions)|*No description*
[RenovatebotOptions](#projen-renovatebotoptions)|Options for Renovatebot.
[ResolveOptions](#projen-resolveoptions)|Resolve options.
[Rule](#projen-rule)|A Make rule.
[SampleDirOptions](#projen-samplediroptions)|SampleDir options.
[SampleFileOptions](#projen-samplefileoptions)|Options for the SampleFile object.
[SampleReadmeProps](#projen-samplereadmeprops)|SampleReadme Properties.
[SnapshotOptions](#projen-snapshotoptions)|Options for the Snapshot synthesis.
[SourceCodeOptions](#projen-sourcecodeoptions)|Options for `SourceCodeFile`.
[TaskCommonOptions](#projen-taskcommonoptions)|*No description*
[TaskOptions](#projen-taskoptions)|*No description*
[TaskSpec](#projen-taskspec)|Specification of a single task.
[TaskStep](#projen-taskstep)|A single step within a task.
[TaskStepOptions](#projen-taskstepoptions)|Options for task steps.
[TasksManifest](#projen-tasksmanifest)|Schema for `tasks.json`.
[TextFileOptions](#projen-textfileoptions)|Options for `TextFile`.
[TomlFileOptions](#projen-tomlfileoptions)|Options for `TomlFile`.
[VersionOptions](#projen-versionoptions)|Options for `Version`.
[XmlFileOptions](#projen-xmlfileoptions)|Options for `XmlFile`.
[YamlFileOptions](#projen-yamlfileoptions)|Options for `JsonFile`.
[awscdk.AutoDiscoverCommonOptions](#projen-awscdk-autodiscovercommonoptions)|Common options for auto discovering project subcomponents.
[awscdk.AutoDiscoverOptions](#projen-awscdk-autodiscoveroptions)|Options for `AutoDiscover`.
[awscdk.AwsCdkConstructLibraryOptions](#projen-awscdk-awscdkconstructlibraryoptions)|Options for `AwsCdkConstructLibrary`.
[awscdk.AwsCdkDepsCommonOptions](#projen-awscdk-awscdkdepscommonoptions)|Options for `AwsCdkDeps`.
[awscdk.AwsCdkDepsOptions](#projen-awscdk-awscdkdepsoptions)|*No description*
[awscdk.AwsCdkJavaAppOptions](#projen-awscdk-awscdkjavaappoptions)|*No description*
[awscdk.AwsCdkPackageNames](#projen-awscdk-awscdkpackagenames)|Language-specific AWS CDK package names.
[awscdk.AwsCdkPythonAppOptions](#projen-awscdk-awscdkpythonappoptions)|Options for `AwsCdkPythonApp`.
[awscdk.AwsCdkTypeScriptAppOptions](#projen-awscdk-awscdktypescriptappoptions)|*No description*
[awscdk.CdkConfigCommonOptions](#projen-awscdk-cdkconfigcommonoptions)|Common options for `cdk.json`.
[awscdk.CdkConfigOptions](#projen-awscdk-cdkconfigoptions)|Options for `CdkJson`.
[awscdk.ConstructLibraryAwsOptions](#projen-awscdk-constructlibraryawsoptions)|*No description*
[awscdk.EdgeLambdaAutoDiscoverOptions](#projen-awscdk-edgelambdaautodiscoveroptions)|Options for `EdgeLambdaAutoDiscover`.
[awscdk.IntegrationTestAutoDiscoverOptions](#projen-awscdk-integrationtestautodiscoveroptions)|Options for `IntegrationTestAutoDiscover`.
[awscdk.IntegrationTestCommonOptions](#projen-awscdk-integrationtestcommonoptions)|*No description*
[awscdk.IntegrationTestOptions](#projen-awscdk-integrationtestoptions)|Options for `IntegrationTest`.
[awscdk.LambdaAutoDiscoverOptions](#projen-awscdk-lambdaautodiscoveroptions)|Options for `LambdaAutoDiscover`.
[awscdk.LambdaExtensionAutoDiscoverOptions](#projen-awscdk-lambdaextensionautodiscoveroptions)|Options for `LambdaExtensionAutoDiscover`.
[awscdk.LambdaExtensionCommonOptions](#projen-awscdk-lambdaextensioncommonoptions)|Common options for creating lambda extensions.
[awscdk.LambdaExtensionOptions](#projen-awscdk-lambdaextensionoptions)|Options for creating lambda extensions.
[awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)|Common options for `LambdaFunction`.
[awscdk.LambdaFunctionOptions](#projen-awscdk-lambdafunctionoptions)|Options for `Function`.
[awscdk.LambdaRuntimeOptions](#projen-awscdk-lambdaruntimeoptions)|Options for the AWS Lambda function runtime.
[build.AddPostBuildJobCommandsOptions](#projen-build-addpostbuildjobcommandsoptions)|Options for `BuildWorkflow.addPostBuildJobCommands`.
[build.AddPostBuildJobTaskOptions](#projen-build-addpostbuildjobtaskoptions)|Options for `BuildWorkflow.addPostBuildJobTask`.
[build.BuildWorkflowOptions](#projen-build-buildworkflowoptions)|*No description*
[cdk.AutoDiscoverBaseOptions](#projen-cdk-autodiscoverbaseoptions)|Options for `AutoDiscoverBase`.
[cdk.Catalog](#projen-cdk-catalog)|*No description*
[cdk.ConstructLibraryOptions](#projen-cdk-constructlibraryoptions)|*No description*
[cdk.IntegrationTestAutoDiscoverBaseOptions](#projen-cdk-integrationtestautodiscoverbaseoptions)|Options for `IntegrationTestAutoDiscoverBase`.
[cdk.IntegrationTestBaseOptions](#projen-cdk-integrationtestbaseoptions)|Options for IntegrationTest.
[cdk.JsiiDocgenOptions](#projen-cdk-jsiidocgenoptions)|Options for `JsiiDocgen`.
[cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)|*No description*
[cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)|Go target configuration.
[cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)|*No description*
[cdk.JsiiProjectOptions](#projen-cdk-jsiiprojectoptions)|*No description*
[cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)|*No description*
[cdk8s.AutoDiscoverOptions](#projen-cdk8s-autodiscoveroptions)|Options for `AutoDiscover`.
[cdk8s.Cdk8sDepsCommonOptions](#projen-cdk8s-cdk8sdepscommonoptions)|Options for `Cdk8sDeps`.
[cdk8s.Cdk8sDepsOptions](#projen-cdk8s-cdk8sdepsoptions)|*No description*
[cdk8s.Cdk8sPackageNames](#projen-cdk8s-cdk8spackagenames)|*No description*
[cdk8s.Cdk8sPythonOptions](#projen-cdk8s-cdk8spythonoptions)|Options for `Cdk8sPythonApp`.
[cdk8s.Cdk8sTypeScriptAppOptions](#projen-cdk8s-cdk8stypescriptappoptions)|*No description*
[cdk8s.ConstructLibraryCdk8sOptions](#projen-cdk8s-constructlibrarycdk8soptions)|*No description*
[cdk8s.IntegrationTestAutoDiscoverOptions](#projen-cdk8s-integrationtestautodiscoveroptions)|*No description*
[cdk8s.IntegrationTestOptions](#projen-cdk8s-integrationtestoptions)|Options for IntegrationTest.
[cdktf.ConstructLibraryCdktfOptions](#projen-cdktf-constructlibrarycdktfoptions)|*No description*
[circleci.CircleCiProps](#projen-circleci-circleciprops)|Options for class {@link Circleci}.
[circleci.Docker](#projen-circleci-docker)|Options for docker executor.
[circleci.Filter](#projen-circleci-filter)|The branches key controls whether the current branch should have a schedule trigger created for it, where current branch is the branch containing the config.yml file with the trigger stanza. That is, a push on the main branch will only schedule a workflow for the main branch.
[circleci.FilterConfig](#projen-circleci-filterconfig)|set an inclusive or exclusive filter.
[circleci.Job](#projen-circleci-job)|A Workflow is comprised of one or more uniquely named jobs.
[circleci.Machine](#projen-circleci-machine)|*No description*
[circleci.Macos](#projen-circleci-macos)|CircleCI supports running jobs on macOS, to allow you to build, test, and deploy apps for macOS, iOS, tvOS and watchOS.
[circleci.Matrix](#projen-circleci-matrix)|The matrix stanza allows you to run a parameterized job multiple times with different arguments.
[circleci.PipelineParameter](#projen-circleci-pipelineparameter)|Parameters are declared by name under a job, command, or executor.
[circleci.Run](#projen-circleci-run)|Used for invoking all command-line programs, taking either a map of configuration values, or, when called in its short-form, a string that will be used as both the command and name.
[circleci.Schedule](#projen-circleci-schedule)|A workflow may have a schedule indicating it runs at a certain time.
[circleci.StepRun](#projen-circleci-steprun)|Execution steps for Job.
[circleci.Triggers](#projen-circleci-triggers)|Specifies which triggers will cause this workflow to be executed.
[circleci.Workflow](#projen-circleci-workflow)|Used for orchestrating all jobs.
[circleci.WorkflowJob](#projen-circleci-workflowjob)|A Job is part of Workflow.
[github.AutoApproveOptions](#projen-github-autoapproveoptions)|Options for 'AutoApprove'.
[github.AutoMergeOptions](#projen-github-automergeoptions)|*No description*
[github.CheckoutWithPatchOptions](#projen-github-checkoutwithpatchoptions)|Options for `checkoutWithPatch`.
[github.CreatePullRequestOptions](#projen-github-createpullrequestoptions)|*No description*
[github.DependabotIgnore](#projen-github-dependabotignore)|You can use the `ignore` option to customize which dependencies are updated.
[github.DependabotOptions](#projen-github-dependabotoptions)|*No description*
[github.DependabotRegistry](#projen-github-dependabotregistry)|Use to add private registry support for dependabot.
[github.GitHubOptions](#projen-github-githuboptions)|*No description*
[github.GitHubProjectOptions](#projen-github-githubprojectoptions)|Options for `GitHubProject`.
[github.GitIdentity](#projen-github-gitidentity)|Represents the git identity.
[github.GithubCredentialsAppOptions](#projen-github-githubcredentialsappoptions)|Options for `GithubCredentials.fromApp`.
[github.GithubCredentialsPersonalAccessTokenOptions](#projen-github-githubcredentialspersonalaccesstokenoptions)|Options for `GithubCredentials.fromPersonalAccessToken`.
[github.GithubWorkflowOptions](#projen-github-githubworkflowoptions)|Options for `GithubWorkflow`.
[github.MergifyConditionalOperator](#projen-github-mergifyconditionaloperator)|The Mergify conditional operators that can be used are: `or` and `and`.
[github.MergifyOptions](#projen-github-mergifyoptions)|*No description*
[github.MergifyQueue](#projen-github-mergifyqueue)|*No description*
[github.MergifyRule](#projen-github-mergifyrule)|*No description*
[github.PullRequestFromPatchOptions](#projen-github-pullrequestfrompatchoptions)|*No description*
[github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)|Options for PullRequestLint.
[github.PullRequestPatchSource](#projen-github-pullrequestpatchsource)|*No description*
[github.PullRequestTemplateOptions](#projen-github-pullrequesttemplateoptions)|Options for `PullRequestTemplate`.
[github.SemanticTitleOptions](#projen-github-semantictitleoptions)|Options for linting that PR titles follow Conventional Commits.
[github.StaleBehavior](#projen-github-stalebehavior)|Stale behavior.
[github.StaleOptions](#projen-github-staleoptions)|Options for `Stale`.
[github.TaskWorkflowOptions](#projen-github-taskworkflowoptions)|*No description*
[github.UploadGitPatchOptions](#projen-github-uploadgitpatchoptions)|Options for `uploadGitPatch`.
[gitlab.AllowFailure](#projen-gitlab-allowfailure)|Exit code that are not considered failure.
[gitlab.Artifacts](#projen-gitlab-artifacts)|Used to specify a list of files and directories that should be attached to the job if it succeeds.
[gitlab.Assets](#projen-gitlab-assets)|Asset configuration for a release.
[gitlab.Cache](#projen-gitlab-cache)|Cache Definition.
[gitlab.CacheKeyFiles](#projen-gitlab-cachekeyfiles)|Use this construct to generate a new key when one or two specific files change.
[gitlab.CiConfigurationOptions](#projen-gitlab-ciconfigurationoptions)|Options for `CiConfiguration`.
[gitlab.CoverageReport](#projen-gitlab-coveragereport)|Code coverage report interface.
[gitlab.Default](#projen-gitlab-default)|Default settings for the CI Configuration.
[gitlab.Engine](#projen-gitlab-engine)|The engine configuration for a secret.
[gitlab.Environment](#projen-gitlab-environment)|The environment that a job deploys to.
[gitlab.Filter](#projen-gitlab-filter)|Filtering options for when a job will run.
[gitlab.Image](#projen-gitlab-image)|Specifies the docker image to use for the job or globally for all jobs.
[gitlab.Include](#projen-gitlab-include)|An included YAML file.
[gitlab.IncludeRule](#projen-gitlab-includerule)|Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job.
[gitlab.Inherit](#projen-gitlab-inherit)|Controls inheritance of globally-defined defaults and variables.
[gitlab.Job](#projen-gitlab-job)|Jobs are the most fundamental element of a .gitlab-ci.yml file.
[gitlab.KubernetesConfig](#projen-gitlab-kubernetesconfig)|Used to configure the kubernetes deployment for this environment.
[gitlab.Link](#projen-gitlab-link)|Link configuration for an asset.
[gitlab.Need](#projen-gitlab-need)|A jobs in a previous stage whose sole completion is needed to start the current job.
[gitlab.Parallel](#projen-gitlab-parallel)|Used to run a job multiple times in parallel in a single pipeline.
[gitlab.Release](#projen-gitlab-release)|Indicates that the job creates a Release.
[gitlab.Reports](#projen-gitlab-reports)|Reports will be uploaded as artifacts, and often displayed in the Gitlab UI, such as in Merge Requests.
[gitlab.Retry](#projen-gitlab-retry)|How many times a job is retried if it fails.
[gitlab.Secret](#projen-gitlab-secret)|A CI/CD secret.
[gitlab.Service](#projen-gitlab-service)|Used to specify an additional Docker image to run scripts in.
[gitlab.Trigger](#projen-gitlab-trigger)|Trigger a multi-project or a child pipeline.
[gitlab.TriggerInclude](#projen-gitlab-triggerinclude)|References a local file or an artifact from another job to define the pipeline configuration.
[gitlab.VariableConfig](#projen-gitlab-variableconfig)|Explains what the global variable is used for, what the acceptable values are.
[gitlab.VaultConfig](#projen-gitlab-vaultconfig)|Specification for a secret provided by a HashiCorp Vault.
[gitlab.Workflow](#projen-gitlab-workflow)|Used to control pipeline behavior.
[gitlab.WorkflowRule](#projen-gitlab-workflowrule)|Used to control whether or not a whole pipeline is created.
[java.JavaProjectCommonOptions](#projen-java-javaprojectcommonoptions)|Options for `JavaProject`.
[java.JavaProjectOptions](#projen-java-javaprojectoptions)|Options for `JavaProject`.
[java.JunitOptions](#projen-java-junitoptions)|Options for `Junit`.
[java.MavenCompileOptions](#projen-java-mavencompileoptions)|Options for `MavenCompile`.
[java.MavenPackagingOptions](#projen-java-mavenpackagingoptions)|Options for `MavenPackage`.
[java.MavenRepository](#projen-java-mavenrepository)|Represents a Maven repository.
[java.MavenSampleOptions](#projen-java-mavensampleoptions)|*No description*
[java.PluginExecution](#projen-java-pluginexecution)|Plugin execution definition.
[java.PluginOptions](#projen-java-pluginoptions)|Options for Maven plugins.
[java.PomOptions](#projen-java-pomoptions)|Options for `Pom`.
[java.ProjenrcOptions](#projen-java-projenrcoptions)|Options for `Projenrc`.
[javascript.AddBundleOptions](#projen-javascript-addbundleoptions)|Options for `addBundle()`.
[javascript.Bundle](#projen-javascript-bundle)|*No description*
[javascript.BundlerOptions](#projen-javascript-bundleroptions)|Options for `Bundler`.
[javascript.BundlingOptions](#projen-javascript-bundlingoptions)|Options for bundling.
[javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)|Options for publishing npm packages to AWS CodeArtifact.
[javascript.CoverageThreshold](#projen-javascript-coveragethreshold)|*No description*
[javascript.EslintOptions](#projen-javascript-eslintoptions)|*No description*
[javascript.EslintOverride](#projen-javascript-eslintoverride)|eslint rules override.
[javascript.HasteConfig](#projen-javascript-hasteconfig)|*No description*
[javascript.JestConfigOptions](#projen-javascript-jestconfigoptions)|*No description*
[javascript.JestOptions](#projen-javascript-jestoptions)|*No description*
[javascript.NodePackageOptions](#projen-javascript-nodepackageoptions)|*No description*
[javascript.NodeProjectOptions](#projen-javascript-nodeprojectoptions)|*No description*
[javascript.NpmConfigOptions](#projen-javascript-npmconfigoptions)|Options to configure the local NPM config.
[javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)|*No description*
[javascript.PrettierOptions](#projen-javascript-prettieroptions)|Options for Prettier.
[javascript.PrettierOverride](#projen-javascript-prettieroverride)|*No description*
[javascript.PrettierSettings](#projen-javascript-prettiersettings)|Options to set in Prettier directly or through overrides.
[javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)|*No description*
[javascript.RenderWorkflowSetupOptions](#projen-javascript-renderworkflowsetupoptions)|Options for `renderInstallSteps()`.
[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)|Options for scoped packages.
[javascript.TypeScriptCompilerOptions](#projen-javascript-typescriptcompileroptions)|*No description*
[javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)|*No description*
[javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)|Options for `UpgradeDependencies`.
[javascript.UpgradeDependenciesWorkflowOptions](#projen-javascript-upgradedependenciesworkflowoptions)|Options for `UpgradeDependencies.workflowOptions`.
[python.PipOptions](#projen-python-pipoptions)|Options for pip.
[python.PoetryPyprojectOptions](#projen-python-poetrypyprojectoptions)|Poetry-specific options.
[python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)|Poetry-specific options.
[python.ProjenrcOptions](#projen-python-projenrcoptions)|Options for `Projenrc`.
[python.PytestOptions](#projen-python-pytestoptions)|*No description*
[python.PytestSampleOptions](#projen-python-pytestsampleoptions)|Options for python test code sample.
[python.PythonPackagingOptions](#projen-python-pythonpackagingoptions)|*No description*
[python.PythonProjectOptions](#projen-python-pythonprojectoptions)|Options for `PythonProject`.
[python.PythonSampleOptions](#projen-python-pythonsampleoptions)|Options for python sample code.
[python.RequirementsFileOptions](#projen-python-requirementsfileoptions)|*No description*
[python.SetupPyOptions](#projen-python-setuppyoptions)|Fields to pass in the setup() function of setup.py.
[python.VenvOptions](#projen-python-venvoptions)|Options for venv.
[release.BranchOptions](#projen-release-branchoptions)|Options for a release branch.
[release.CodeArtifactOptions](#projen-release-codeartifactoptions)|Options for publishing packages to AWS CodeArtifact.
[release.CommonPublishOptions](#projen-release-commonpublishoptions)|Common publishing options.
[release.GitHubReleasesPublishOptions](#projen-release-githubreleasespublishoptions)|Publishing options for GitHub releases.
[release.GitPublishOptions](#projen-release-gitpublishoptions)|Publishing options for Git releases.
[release.GoPublishOptions](#projen-release-gopublishoptions)|Options for Go releases.
[release.JsiiReleaseGo](#projen-release-jsiireleasego)|*No description*
[release.JsiiReleaseMaven](#projen-release-jsiireleasemaven)|*No description*
[release.JsiiReleaseNpm](#projen-release-jsiireleasenpm)|*No description*
[release.JsiiReleaseNuget](#projen-release-jsiireleasenuget)|*No description*
[release.JsiiReleasePyPi](#projen-release-jsiireleasepypi)|*No description*
[release.ManualReleaseOptions](#projen-release-manualreleaseoptions)|*No description*
[release.MavenPublishOptions](#projen-release-mavenpublishoptions)|Options for Maven releases.
[release.NpmPublishOptions](#projen-release-npmpublishoptions)|Options for npm release.
[release.NugetPublishOptions](#projen-release-nugetpublishoptions)|Options for NuGet releases.
[release.PublisherOptions](#projen-release-publisheroptions)|Options for `Publisher`.
[release.PyPiPublishOptions](#projen-release-pypipublishoptions)|Options for PyPI release.
[release.ReleaseOptions](#projen-release-releaseoptions)|Options for `Release`.
[release.ReleaseProjectOptions](#projen-release-releaseprojectoptions)|Project options for release.
[release.ScheduledReleaseOptions](#projen-release-scheduledreleaseoptions)|*No description*
[typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)|*No description*
[typescript.ProjenrcTsOptions](#projen-typescript-projenrctsoptions)|*No description*
[typescript.TypeScriptLibraryProjectOptions](#projen-typescript-typescriptlibraryprojectoptions)|*No description*
[typescript.TypeScriptProjectOptions](#projen-typescript-typescriptprojectoptions)|*No description*
[vscode.DevContainerFeature](#projen-vscode-devcontainerfeature)|devcontainer features options.
[vscode.DevContainerOptions](#projen-vscode-devcontaineroptions)|Constructor options for the DevContainer component.
[vscode.Presentation](#projen-vscode-presentation)|VSCode launch configuration Presentation interface "using the order, group, and hidden attributes in the presentation object you can sort, group, and hide configurations and compounds in the Debug configuration dropdown and in the Debug quick pick." Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
[vscode.ServerReadyAction](#projen-vscode-serverreadyaction)|VSCode launch configuration ServerReadyAction interface "if you want to open a URL in a web browser whenever the program under debugging outputs a specific message to the debug console or integrated terminal." Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
[vscode.VsCodeLaunchConfigurationEntry](#projen-vscode-vscodelaunchconfigurationentry)|Options for a 'VsCodeLaunchConfigurationEntry' Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
[web.NextComponentOptions](#projen-web-nextcomponentoptions)|*No description*
[web.NextJsCommonProjectOptions](#projen-web-nextjscommonprojectoptions)|*No description*
[web.NextJsProjectOptions](#projen-web-nextjsprojectoptions)|*No description*
[web.NextJsTypeScriptProjectOptions](#projen-web-nextjstypescriptprojectoptions)|*No description*
[web.PostCssOptions](#projen-web-postcssoptions)|*No description*
[web.ReactComponentOptions](#projen-web-reactcomponentoptions)|*No description*
[web.ReactProjectOptions](#projen-web-reactprojectoptions)|*No description*
[web.ReactRewireOptions](#projen-web-reactrewireoptions)|*No description*
[web.ReactTypeDefOptions](#projen-web-reacttypedefoptions)|*No description*
[web.ReactTypeScriptProjectOptions](#projen-web-reacttypescriptprojectoptions)|*No description*
[web.TailwindConfigOptions](#projen-web-tailwindconfigoptions)|*No description*
**Interfaces**
Name|Description
----|-----------
[IDevEnvironment](#projen-idevenvironment)|Abstract interface for container-based development environments, such as Gitpod and GitHub Codespaces.
[IDockerComposeNetworkBinding](#projen-idockercomposenetworkbinding)|Network binding information.
[IDockerComposeNetworkConfig](#projen-idockercomposenetworkconfig)|Storage for network configuration.
[IDockerComposeServiceName](#projen-idockercomposeservicename)|An interface providing the name of a docker compose service.
[IDockerComposeVolumeBinding](#projen-idockercomposevolumebinding)|Volume binding information.
[IDockerComposeVolumeConfig](#projen-idockercomposevolumeconfig)|Storage for volume configuration.
[IResolvable](#projen-iresolvable)|*No description*
[IResolver](#projen-iresolver)|API for resolving tokens when synthesizing file content.
[github.IAddConditionsLater](#projen-github-iaddconditionslater)|*No description*
[python.IPackageProvider](#projen-python-ipackageprovider)|*No description*
[python.IPythonDeps](#projen-python-ipythondeps)|*No description*
[python.IPythonEnv](#projen-python-ipythonenv)|*No description*
[python.IPythonPackaging](#projen-python-ipythonpackaging)|*No description*
[vscode.IDevContainerEnvironment](#projen-vscode-idevcontainerenvironment)|*No description*
**Enums**
Name|Description
----|-----------
[DependencyType](#projen-dependencytype)|Type of dependency.
[DockerComposeProtocol](#projen-dockercomposeprotocol)|Network protocol for port mapping.
[GitpodOnOpen](#projen-gitpodonopen)|What to do when a service on a port is detected.
[GitpodOpenIn](#projen-gitpodopenin)|Configure where in the IDE the terminal should be opened.
[GitpodOpenMode](#projen-gitpodopenmode)|Configure how the terminal should be opened relative to the previous task.
[GitpodPortVisibility](#projen-gitpodportvisibility)|Whether the port visibility should be private or public.
[InitProjectOptionHints](#projen-initprojectoptionhints)|Choices for how to display commented out options in projenrc files.
[LogLevel](#projen-loglevel)|Logging verbosity.
[ProjectType](#projen-projecttype)|Which type of project this is.
[RenovatebotScheduleInterval](#projen-renovatebotscheduleinterval)|How often to check for new versions and raise pull requests for version updates.
[awscdk.ApprovalLevel](#projen-awscdk-approvallevel)|Which approval is required when deploying CDK apps.
[cdk.Stability](#projen-cdk-stability)|*No description*
[circleci.JobType](#projen-circleci-jobtype)|A job may have a type of approval indicating it must be manually approved before downstream jobs may proceed.
[circleci.JobWhen](#projen-circleci-jobwhen)|Specify when to enable or disable the step.
[circleci.PipelineParameterType](#projen-circleci-pipelineparametertype)|Pipeline parameter types.
[circleci.ResourceClass](#projen-circleci-resourceclass)|The resource_class feature allows configuring CPU and RAM resources for each job.
[github.DependabotRegistryType](#projen-github-dependabotregistrytype)|Each configuration type requires you to provide particular settings.
[github.DependabotScheduleInterval](#projen-github-dependabotscheduleinterval)|How often to check for new versions and raise pull requests for version updates.
[github.VersioningStrategy](#projen-github-versioningstrategy)|The strategy to use when edits manifest and lock files.
[gitlab.Action](#projen-gitlab-action)|Specifies what this job will do.
[gitlab.CachePolicy](#projen-gitlab-cachepolicy)|Configure the upload and download behaviour of a cache.
[gitlab.CacheWhen](#projen-gitlab-cachewhen)|Configure when artifacts are uploaded depended on job status.
[gitlab.DefaultElement](#projen-gitlab-defaultelement)|*No description*
[gitlab.DeploymentTier](#projen-gitlab-deploymenttier)|Explicitly specifies the tier of the deployment environment if non-standard environment name is used.
[gitlab.JobWhen](#projen-gitlab-jobwhen)|Describes the conditions for when to run the job.
[gitlab.KubernetesEnum](#projen-gitlab-kubernetesenum)|Filter job based on if Kubernetes integration is active.
[gitlab.LinkType](#projen-gitlab-linktype)|The content kind of what users can download via url.
[gitlab.Strategy](#projen-gitlab-strategy)|You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend.
[gitlab.WorkflowWhen](#projen-gitlab-workflowwhen)|Describes the conditions for when to run the job.
[javascript.ArrowParens](#projen-javascript-arrowparens)|*No description*
[javascript.AutoRelease](#projen-javascript-autorelease)|Automatic bump modes.
[javascript.CodeArtifactAuthProvider](#projen-javascript-codeartifactauthprovider)|Options for authorizing requests to a AWS CodeArtifact npm repository.
[javascript.EmbeddedLanguageFormatting](#projen-javascript-embeddedlanguageformatting)|*No description*
[javascript.EndOfLine](#projen-javascript-endofline)|*No description*
[javascript.HTMLWhitespaceSensitivity](#projen-javascript-htmlwhitespacesensitivity)|*No description*
[javascript.NodePackageManager](#projen-javascript-nodepackagemanager)|The node package manager to use.
[javascript.NpmAccess](#projen-javascript-npmaccess)|Npm package access level.
[javascript.ProseWrap](#projen-javascript-prosewrap)|*No description*
[javascript.QuoteProps](#projen-javascript-quoteprops)|*No description*
[javascript.TrailingComma](#projen-javascript-trailingcomma)|*No description*
[javascript.TypeScriptImportsNotUsedAsValues](#projen-javascript-typescriptimportsnotusedasvalues)|This flag controls how `import` works, there are 3 different options.
[javascript.TypeScriptJsxMode](#projen-javascript-typescriptjsxmode)|Determines how JSX should get transformed into valid JavaScript.
[javascript.TypeScriptModuleResolution](#projen-javascript-typescriptmoduleresolution)|Determines how modules get resolved.
[javascript.UpdateSnapshot](#projen-javascript-updatesnapshot)|*No description*
[release.CodeArtifactAuthProvider](#projen-release-codeartifactauthprovider)|Options for authorizing requests to a AWS CodeArtifact npm repository.
[vscode.Console](#projen-vscode-console)|Controls where to launch the debug target Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
[vscode.InternalConsoleOptions](#projen-vscode-internalconsoleoptions)|Controls the visibility of the VSCode Debug Console panel during a debugging session Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
## class Component ð¹
Represents a project component.
### Initializer
```ts
new Component(project: Project)
```
* **project** ([Project](#projen-project)) *No description*
### Properties
Name | Type | Description
-----|------|-------------
**project**ð¹ | [Project](#projen-project) |
### Methods
#### postSynthesize()ð¹
Called after synthesis.
Order is *not* guaranteed.
```ts
postSynthesize(): void
```
#### preSynthesize()ð¹
Called before synthesis.
```ts
preSynthesize(): void
```
#### synthesize()ð¹
Synthesizes files to the project output directory.
```ts
synthesize(): void
```
## class Dependencies ð¹
The `Dependencies` component is responsible to track the list of dependencies a project has, and then used by project types as the model for rendering project-specific dependency manifests such as the dependencies section `package.json` files.
To add a dependency you can use a project-type specific API such as
`nodeProject.addDeps()` or use the generic API of `project.deps`:
__Extends__: [Component](#projen-component)
### Initializer
Adds a dependencies component to the project.
```ts
new Dependencies(project: Project)
```
* **project** ([Project](#projen-project)) The parent project.
### Properties
Name | Type | Description
-----|------|-------------
**all**ð¹ | Array<[Dependency](#projen-dependency)> | A copy of all dependencies recorded for this project.
*static* **MANIFEST_FILE**ð¹ | string | The project-relative path of the deps manifest file.
### Methods
#### addDependency(spec, type, metadata?)ð¹
Adds a dependency to this project.
```ts
addDependency(spec: string, type: DependencyType, metadata?: Map): Dependency
```
* **spec** (string) The dependency spec in the format `MODULE[@VERSION]` where `MODULE` is the package-manager-specific module name and `VERSION` is an optional semantic version requirement (e.g. `^3.4.0`).
* **type** ([DependencyType](#projen-dependencytype)) The type of the dependency.
* **metadata** (Map) *No description*
__Returns__:
* [Dependency](#projen-dependency)
#### getDependency(name, type?)ð¹
Returns a dependency by name.
Fails if there is no dependency defined by that name or if `type` is not
provided and there is more then one dependency type for this dependency.
```ts
getDependency(name: string, type?: DependencyType): Dependency
```
* **name** (string) The name of the dependency.
* **type** ([DependencyType](#projen-dependencytype)) The dependency type.
__Returns__:
* [Dependency](#projen-dependency)
#### removeDependency(name, type?)ð¹
Removes a dependency.
```ts
removeDependency(name: string, type?: DependencyType): void
```
* **name** (string) The name of the module to remove (without the version).
* **type** ([DependencyType](#projen-dependencytype)) The dependency type.
#### tryGetDependency(name, type?)ð¹
Returns a dependency by name.
Returns `undefined` if there is no dependency defined by that name or if
`type` is not provided and there is more then one dependency type for this
dependency.
```ts
tryGetDependency(name: string, type?: DependencyType): Dependency
```
* **name** (string) The name of the dependency.
* **type** ([DependencyType](#projen-dependencytype)) The dependency type.
__Returns__:
* [Dependency](#projen-dependency)
#### *static* parseDependency(spec)ð¹
Returns the coordinates of a dependency spec.
Given `foo@^3.4.0` returns `{ name: "foo", version: "^3.4.0" }`.
Given `bar@npm:@bar/legacy` returns `{ name: "bar", version: "npm:@bar/legacy" }`.
```ts
static parseDependency(spec: string): DependencyCoordinates
```
* **spec** (string) *No description*
__Returns__:
* [DependencyCoordinates](#projen-dependencycoordinates)
## class DevEnvironmentDockerImage ð¹
Options for specifying the Docker image of the container.
### Properties
Name | Type | Description
-----|------|-------------
**dockerFile**?ð¹ | string | The relative path of a Dockerfile that defines the container contents.
__*Optional*__
**image**?ð¹ | string | A publicly available Docker image.
__*Optional*__
### Methods
#### *static* fromFile(dockerFile)ð¹
The relative path of a Dockerfile that defines the container contents.
```ts
static fromFile(dockerFile: string): DevEnvironmentDockerImage
```
* **dockerFile** (string) a relative path.
__Returns__:
* [DevEnvironmentDockerImage](#projen-devenvironmentdockerimage)
#### *static* fromImage(image)ð¹
A publicly available Docker image.
```ts
static fromImage(image: string): DevEnvironmentDockerImage
```
* **image** (string) a Docker image.
__Returns__:
* [DevEnvironmentDockerImage](#projen-devenvironmentdockerimage)
## class DockerCompose ð¹
Create a docker-compose YAML file.
__Extends__: [Component](#projen-component)
### Initializer
```ts
new DockerCompose(project: Project, props?: DockerComposeProps)
```
* **project** ([Project](#projen-project)) *No description*
* **props** ([DockerComposeProps](#projen-dockercomposeprops)) *No description*
* **nameSuffix** (string) A name to add to the docker-compose.yml filename. __*Default*__: no name is added
* **schemaVersion** (string) Docker Compose schema version do be used. __*Default*__: 3.3
* **services** (Map) Service descriptions. __*Optional*__
### Methods
#### addService(serviceName, description)ð¹
Add a service to the docker-compose file.
```ts
addService(serviceName: string, description: DockerComposeServiceDescription): DockerComposeService
```
* **serviceName** (string) name of the service.
* **description** ([DockerComposeServiceDescription](#projen-dockercomposeservicedescription)) a service description.
* **command** (Array) Provide a command to the docker container. __*Default*__: use the container's default command
* **dependsOn** (Array<[IDockerComposeServiceName](#projen-idockercomposeservicename)>) Names of other services this service depends on. __*Default*__: no dependencies
* **entrypoint** (Array) Entrypoint to run in the container. __*Optional*__
* **environment** (Map) Add environment variables. __*Default*__: no environment variables are provided
* **image** (string) Use a docker image. __*Optional*__
* **imageBuild** ([DockerComposeBuild](#projen-dockercomposebuild)) Build a docker image. __*Optional*__
* **labels** (Map) Add labels. __*Default*__: no labels are provided
* **networks** (Array<[IDockerComposeNetworkBinding](#projen-idockercomposenetworkbinding)>) Add some networks to the service. __*Optional*__
* **ports** (Array<[DockerComposeServicePort](#projen-dockercomposeserviceport)>) Map some ports. __*Default*__: no ports are mapped
* **volumes** (Array<[IDockerComposeVolumeBinding](#projen-idockercomposevolumebinding)>) Mount some volumes into the service. __*Optional*__
__Returns__:
* [DockerComposeService](#projen-dockercomposeservice)
#### *static* bindVolume(sourcePath, targetPath)ð¹
Create a bind volume that binds a host path to the target path in the container.
```ts
static bindVolume(sourcePath: string, targetPath: string): IDockerComposeVolumeBinding
```
* **sourcePath** (string) Host path name.
* **targetPath** (string) Target path name.
__Returns__:
* [IDockerComposeVolumeBinding](#projen-idockercomposevolumebinding)
#### *static* namedVolume(volumeName, targetPath, options?)ð¹
Create a named volume and mount it to the target path.
If you use this
named volume in several services, the volume will be shared. In this
case, the volume configuration of the first-provided options are used.
```ts
static namedVolume(volumeName: string, targetPath: string, options?: DockerComposeVolumeConfig): IDockerComposeVolumeBinding
```
* **volumeName** (string) Name of the volume.
* **targetPath** (string) Target path.
* **options** ([DockerComposeVolumeConfig](#projen-dockercomposevolumeconfig)) volume configuration (default: docker compose defaults).
* **driver** (string) Driver to use for the volume. __*Default*__: value is not provided
* **driverOpts** (Map) Options to provide to the driver. __*Optional*__
* **external** (boolean) Set to true to indicate that the volume is externally created. __*Default*__: unset, indicating that docker-compose creates the volume
* **name** (string) Name of the volume for when the volume name isn't going to work in YAML. __*Default*__: unset, indicating that docker-compose creates volumes as usual
__Returns__:
* [IDockerComposeVolumeBinding](#projen-idockercomposevolumebinding)
#### *static* network(networkName, options?)ð¹
Create a named network and mount it to the target path.
If you use this
named network in several services, the network will be shared. In this
case, the network configuration of the first-provided options are used.
```ts
static network(networkName: string, options?: DockerComposeNetworkConfig): IDockerComposeNetworkBinding
```
* **networkName** (string) Name of the network.
* **options** ([DockerComposeNetworkConfig](#projen-dockercomposenetworkconfig)) network configuration.
* **attachable** (boolean) Set to true to indicate that standalone containers can attach to this network, in addition to services. __*Default*__: unset
* **bridge** (boolean) Set to true to indicate that the network is a bridge network. __*Default*__: unset
* **driver** (string) Driver to use for the network. __*Default*__: value is not provided
* **driverOpts** (json) Options for the configured driver. __*Default*__: value is not provided
* **external** (boolean) Set to true to indicate that the network is externally created. __*Default*__: unset, indicating that docker-compose creates the network
* **internal** (boolean) Set to true to indicate that you want to create an externally isolated overlay network. __*Default*__: unset
* **ipam** ([DockerComposeNetworkIpamConfig](#projen-dockercomposenetworkipamconfig)) Specify custom IPAM config. __*Default*__: unset
* **labels** (Array) Attach labels to the network. __*Default*__: unset
* **name** (string) Name of the network for when the network name isn't going to work in YAML. __*Default*__: unset, indicating that docker-compose creates networks as usual
* **overlay** (boolean) Set to true to indicate that the network is an overlay network. __*Default*__: unset
__Returns__:
* [IDockerComposeNetworkBinding](#projen-idockercomposenetworkbinding)
#### *static* portMapping(publishedPort, targetPort, options?)ð¹
Create a port mapping.
```ts
static portMapping(publishedPort: number, targetPort: number, options?: DockerComposePortMappingOptions): DockerComposeServicePort
```
* **publishedPort** (number) Published port number.
* **targetPort** (number) Container's port number.
* **options** ([DockerComposePortMappingOptions](#projen-dockercomposeportmappingoptions)) Port mapping options.
* **protocol** ([DockerComposeProtocol](#projen-dockercomposeprotocol)) Port mapping protocol. __*Default*__: DockerComposeProtocol.TCP
__Returns__:
* [DockerComposeServicePort](#projen-dockercomposeserviceport)
#### *static* serviceName(serviceName)ð¹
Depends on a service name.
```ts
static serviceName(serviceName: string): IDockerComposeServiceName
```
* **serviceName** (string) *No description*
__Returns__:
* [IDockerComposeServiceName](#projen-idockercomposeservicename)
## class DockerComposeService ð¹
A docker-compose service.
__Implements__: [IDockerComposeServiceName](#projen-idockercomposeservicename)
### Initializer
```ts
new DockerComposeService(serviceName: string, serviceDescription: DockerComposeServiceDescription)
```
* **serviceName** (string) The name of the docker compose service.
* **serviceDescription** ([DockerComposeServiceDescription](#projen-dockercomposeservicedescription)) *No description*
* **command** (Array) Provide a command to the docker container. __*Default*__: use the container's default command
* **dependsOn** (Array<[IDockerComposeServiceName](#projen-idockercomposeservicename)>) Names of other services this service depends on. __*Default*__: no dependencies
* **entrypoint** (Array) Entrypoint to run in the container. __*Optional*__
* **environment** (Map) Add environment variables. __*Default*__: no environment variables are provided
* **image** (string) Use a docker image. __*Optional*__
* **imageBuild** ([DockerComposeBuild](#projen-dockercomposebuild)) Build a docker image. __*Optional*__
* **labels** (Map) Add labels. __*Default*__: no labels are provided
* **networks** (Array<[IDockerComposeNetworkBinding](#projen-idockercomposenetworkbinding)>) Add some networks to the service. __*Optional*__
* **ports** (Array<[DockerComposeServicePort](#projen-dockercomposeserviceport)>) Map some ports. __*Default*__: no ports are mapped
* **volumes** (Array<[IDockerComposeVolumeBinding](#projen-idockercomposevolumebinding)>) Mount some volumes into the service. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**dependsOn**ð¹ | Array<[IDockerComposeServiceName](#projen-idockercomposeservicename)> | Other services that this service depends on.
**environment**ð¹ | Map | Environment variables.
**labels**ð¹ | Map | Attached labels.
**networks**ð¹ | Array<[IDockerComposeNetworkBinding](#projen-idockercomposenetworkbinding)> | Networks mounted in the container.
**ports**ð¹ | Array<[DockerComposeServicePort](#projen-dockercomposeserviceport)> | Published ports.
**serviceName**ð¹ | string | Name of the service.
**volumes**ð¹ | Array<[IDockerComposeVolumeBinding](#projen-idockercomposevolumebinding)> | Volumes mounted in the container.
**command**?ð¹ | Array | Command to run in the container.
__*Optional*__
**entrypoint**?ð¹ | Array | Entrypoint to run in the container.
__*Optional*__
**image**?ð¹ | string | Docker image.
__*Optional*__
**imageBuild**?ð¹ | [DockerComposeBuild](#projen-dockercomposebuild) | Docker image build instructions.
__*Optional*__
### Methods
#### addDependsOn(serviceName)ð¹
Make the service depend on another service.
```ts
addDependsOn(serviceName: IDockerComposeServiceName): void
```
* **serviceName** ([IDockerComposeServiceName](#projen-idockercomposeservicename)) *No description*
#### addEnvironment(name, value)ð¹
Add an environment variable.
```ts
addEnvironment(name: string, value: string): void
```
* **name** (string) environment variable name.
* **value** (string) value of the environment variable.
#### addLabel(name, value)ð¹
Add a label.
```ts
addLabel(name: string, value: string): void
```
* **name** (string) environment variable name.
* **value** (string) value of the environment variable.
#### addNetwork(network)ð¹
Add a network to the service.
```ts
addNetwork(network: IDockerComposeNetworkBinding): void
```
* **network** ([IDockerComposeNetworkBinding](#projen-idockercomposenetworkbinding)) *No description*
#### addPort(publishedPort, targetPort, options?)ð¹
Add a port mapping.
```ts
addPort(publishedPort: number, targetPort: number, options?: DockerComposePortMappingOptions): void
```
* **publishedPort** (number) Published port number.
* **targetPort** (number) Container's port number.
* **options** ([DockerComposePortMappingOptions](#projen-dockercomposeportmappingoptions)) Port mapping options.
* **protocol** ([DockerComposeProtocol](#projen-dockercomposeprotocol)) Port mapping protocol. __*Default*__: DockerComposeProtocol.TCP
#### addVolume(volume)ð¹
Add a volume to the service.
```ts
addVolume(volume: IDockerComposeVolumeBinding): void
```
* **volume** ([IDockerComposeVolumeBinding](#projen-idockercomposevolumebinding)) *No description*
## class FileBase ð¹
__Extends__: [Component](#projen-component)
__Implemented by__: [github.PullRequestTemplate](#projen-github-pullrequesttemplate), [python.RequirementsFile](#projen-python-requirementsfile), [python.SetupPy](#projen-python-setuppy), [web.ReactTypeDef](#projen-web-reacttypedef), [GitAttributesFile](#projen-gitattributesfile), [IgnoreFile](#projen-ignorefile), [IniFile](#projen-inifile), [JsonFile](#projen-jsonfile), [License](#projen-license), [Makefile](#projen-makefile), [TextFile](#projen-textfile), [TomlFile](#projen-tomlfile), [XmlFile](#projen-xmlfile), [YamlFile](#projen-yamlfile)
__Obtainable from__: [Project](#projen-project).[tryFindFile](#projen-project#projen-project-tryfindfile)(), [Project](#projen-project).[tryRemoveFile](#projen-project#projen-project-tryremovefile)()
### Initializer
```ts
new FileBase(project: Project, filePath: string, options?: FileBaseOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **filePath** (string) *No description*
* **options** ([FileBaseOptions](#projen-filebaseoptions)) *No description*
* **committed** (boolean) Indicates whether this file should be committed to git or ignored. __*Default*__: true
* **editGitignore** (boolean) Update the project's .gitignore file. __*Default*__: true
* **executable** (boolean) Whether the generated file should be marked as executable. __*Default*__: false
* **marker** (boolean) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
* **readonly** (boolean) Whether the generated file should be readonly. __*Default*__: true
### Properties
Name | Type | Description
-----|------|-------------
**absolutePath**ð¹ | string | The absolute path of this file.
**executable**ð¹ | boolean | Indicates if the file should be marked as executable.
**path**ð¹ | string | The file path, relative to the project root.
**readonly**ð¹ | boolean | Indicates if the file should be read-only or read-write.
**changed**?ð¹ | boolean | Indicates if the file has been changed during synthesis.
__*Optional*__
**marker**?ð¹ | string | The projen marker, used to identify files as projen-generated.
__*Optional*__
### Methods
#### synthesize()ð¹
Writes the file to the project's output directory.
```ts
synthesize(): void
```
#### protected synthesizeContent(resolver)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(resolver: IResolver): string
```
* **resolver** ([IResolver](#projen-iresolver)) Call `resolver.resolve(obj)` on any objects in order to resolve token functions.
__Returns__:
* string
## class GitAttributesFile ð¹
Assign attributes to file names in a git repository.
__Extends__: [FileBase](#projen-filebase)
### Initializer
```ts
new GitAttributesFile(project: Project)
```
* **project** ([Project](#projen-project)) *No description*
### Properties
Name | Type | Description
-----|------|-------------
**hasLfsPatterns**ð¹ | boolean | Whether the current gitattributes file has any LFS patterns.
### Methods
#### addAttributes(glob, ...attributes)ð¹
Maps a set of attributes to a set of files.
```ts
addAttributes(glob: string, ...attributes: string[]): void
```
* **glob** (string) Glob pattern to match files in the repo.
* **attributes** (string) Attributes to assign to these files.
#### addLfsPattern(glob)ð¹
Add attributes necessary to mark these files as stored in LFS.
```ts
addLfsPattern(glob: string): void
```
* **glob** (string) *No description*
#### protected synthesizeContent(_)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(_: IResolver): string
```
* **_** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class Gitpod ð¹
The Gitpod component which emits .gitpod.yml.
__Implements__: [IDevEnvironment](#projen-idevenvironment)
__Extends__: [Component](#projen-component)
### Initializer
```ts
new Gitpod(project: Project, options?: GitpodOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([GitpodOptions](#projen-gitpodoptions)) *No description*
* **dockerImage** ([DevEnvironmentDockerImage](#projen-devenvironmentdockerimage)) A Docker image or Dockerfile for the container. __*Optional*__
* **ports** (Array) An array of ports that should be exposed from the container. __*Optional*__
* **tasks** (Array<[Task](#projen-task)>) An array of tasks that should be run when the container starts. __*Optional*__
* **vscodeExtensions** (Array) An array of extension IDs that specify the extensions that should be installed inside the container when it is created. __*Optional*__
* **prebuilds** ([GitpodPrebuilds](#projen-gitpodprebuilds)) Optional Gitpod's Github App integration for prebuilds If this is not set and Gitpod's Github App is installed, then Gitpod will apply these defaults: https://www.gitpod.io/docs/prebuilds/#configure-the-github-app. __*Default*__: undefined
### Properties
Name | Type | Description
-----|------|-------------
**config**ð¹ | any | Direct access to the gitpod configuration (escape hatch).
### Methods
#### addCustomTask(options)ð¹
Add a task with more granular options.
By default, all tasks will be run in parallel. To run tasks in sequence,
create a new `Task` and set the other tasks as subtasks.
```ts
addCustomTask(options: GitpodTask): void
```
* **options** ([GitpodTask](#projen-gitpodtask)) The task parameters.
* **command** (string) Required.
* **before** (string) In case you need to run something even before init, that is a requirement for both init and command, you can use the before property. __*Optional*__
* **init** (string) The init property can be used to specify shell commands that should only be executed after a workspace was freshly cloned and needs to be initialized somehow. __*Optional*__
* **name** (string) A name for this task. __*Default*__: task names are omitted when blank
* **openIn** ([GitpodOpenIn](#projen-gitpodopenin)) You can configure where in the IDE the terminal should be opened. __*Default*__: GitpodOpenIn.BOTTOM
* **openMode** ([GitpodOpenMode](#projen-gitpodopenmode)) You can configure how the terminal should be opened relative to the previous task. __*Default*__: GitpodOpenMode.TAB_AFTER
* **prebuild** (string) The optional prebuild command will be executed during prebuilds. __*Optional*__
#### addDockerImage(image)ð¹
Add a custom Docker image or Dockerfile for the container.
```ts
addDockerImage(image: DevEnvironmentDockerImage): void
```
* **image** ([DevEnvironmentDockerImage](#projen-devenvironmentdockerimage)) The Docker image.
#### addPorts(...ports)ð¹
Add ports that should be exposed (forwarded) from the container.
```ts
addPorts(...ports: string[]): void
```
* **ports** (string) The new ports.
#### addPrebuilds(config)ð¹
Add a prebuilds configuration for the Gitpod App.
```ts
addPrebuilds(config: GitpodPrebuilds): void
```
* **config** ([GitpodPrebuilds](#projen-gitpodprebuilds)) The configuration.
* **addBadge** (boolean) Add a "Review in Gitpod" button to the pull request's description. __*Default*__: false
* **addCheck** (boolean) Add a check to pull requests. __*Default*__: true
* **addComment** (boolean) Add a "Review in Gitpod" button as a comment to pull requests. __*Default*__: false
* **addLabel** (boolean) Add a label once the prebuild is ready to pull requests. __*Default*__: false
* **branches** (boolean) Enable for all branches in this repo. __*Default*__: false
* **master** (boolean) Enable for the master/default branch. __*Default*__: true
* **pullRequests** (boolean) Enable for pull requests coming from this repo. __*Default*__: true
* **pullRequestsFromForks** (boolean) Enable for pull requests coming from forks. __*Default*__: false
#### addTasks(...tasks)ð¹
Add tasks to run when gitpod starts.
By default, all tasks will be run in parallel. To run tasks in sequence,
create a new `Task` and specify the other tasks as subtasks.
```ts
addTasks(...tasks: Task[]): void
```
* **tasks** ([Task](#projen-task)) The new tasks.
#### addVscodeExtensions(...extensions)ð¹
Add a list of VSCode extensions that should be automatically installed in the container.
These must be in the format defined in the Open VSX registry.
```ts
addVscodeExtensions(...extensions: string[]): void
```
* **extensions** (string) The extension IDs.
## class IgnoreFile ð¹
__Extends__: [FileBase](#projen-filebase)
### Initializer
```ts
new IgnoreFile(project: Project, filePath: string, options?: IgnoreFileOptions)
```
* **project** ([Project](#projen-project)) The project to tie this file to.
* **filePath** (string) - the relative path in the project to put the file.
* **options** ([IgnoreFileOptions](#projen-ignorefileoptions)) *No description*
* **filterCommentLines** (boolean) Filter out comment lines? __*Default*__: true
* **filterEmptyLines** (boolean) Filter out blank/empty lines? __*Default*__: true
### Properties
Name | Type | Description
-----|------|-------------
**filterCommentLines**ð¹ | boolean |
**filterEmptyLines**ð¹ | boolean |
### Methods
#### addPatterns(...patterns)ð¹
Add ignore patterns.
Files that match this pattern will be ignored. If the
pattern starts with a negation mark `!`, files that match will _not_ be
ignored.
Comment lines (start with `#`) and blank lines ("") are filtered by default
but can be included using options specified when instantiating the component.
```ts
addPatterns(...patterns: string[]): void
```
* **patterns** (string) Ignore patterns.
#### exclude(...patterns)ð¹
Ignore the files that match these patterns.
```ts
exclude(...patterns: string[]): void
```
* **patterns** (string) The patterns to match.
#### include(...patterns)ð¹
Always include the specified file patterns.
```ts
include(...patterns: string[]): void
```
* **patterns** (string) Patterns to include in git commits.
#### removePatterns(...patterns)ð¹
Removes patterns previously added from the ignore file.
If `addPattern()` is called after this, the pattern will be added again.
```ts
removePatterns(...patterns: string[]): void
```
* **patterns** (string) patters to remove.
#### protected synthesizeContent(resolver)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(resolver: IResolver): string
```
* **resolver** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class IniFile ð¹
Represents an INI file.
__Extends__: [ObjectFile](#projen-objectfile)
### Initializer
```ts
new IniFile(project: Project, filePath: string, options: IniFileOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **filePath** (string) *No description*
* **options** ([IniFileOptions](#projen-inifileoptions)) *No description*
* **committed** (boolean) Indicates whether this file should be committed to git or ignored. __*Default*__: true
* **editGitignore** (boolean) Update the project's .gitignore file. __*Default*__: true
* **executable** (boolean) Whether the generated file should be marked as executable. __*Default*__: false
* **marker** (boolean) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
* **readonly** (boolean) Whether the generated file should be readonly. __*Default*__: true
* **obj** (any) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
* **omitEmpty** (boolean) Omits empty objects and arrays. __*Default*__: false
### Methods
#### protected synthesizeContent(resolver)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(resolver: IResolver): string
```
* **resolver** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class JsonFile ð¹
Represents a JSON file.
__Extends__: [ObjectFile](#projen-objectfile)
### Initializer
```ts
new JsonFile(project: Project, filePath: string, options: JsonFileOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **filePath** (string) *No description*
* **options** ([JsonFileOptions](#projen-jsonfileoptions)) *No description*
* **committed** (boolean) Indicates whether this file should be committed to git or ignored. __*Default*__: true
* **editGitignore** (boolean) Update the project's .gitignore file. __*Default*__: true
* **executable** (boolean) Whether the generated file should be marked as executable. __*Default*__: false
* **marker** (boolean) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
* **readonly** (boolean) Whether the generated file should be readonly. __*Default*__: true
* **obj** (any) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
* **omitEmpty** (boolean) Omits empty objects and arrays. __*Default*__: false
* **allowComments** (boolean) Allow the use of comments in this file. __*Default*__: false for .json files, true for .json5 and .jsonc files
* **newline** (boolean) Adds a newline at the end of the file. __*Default*__: true
### Properties
Name | Type | Description
-----|------|-------------
**supportsComments**ð¹ | boolean |
### Methods
#### protected synthesizeContent(resolver)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(resolver: IResolver): string
```
* **resolver** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class JsonPatch ð¹
Utility for applying RFC-6902 JSON-Patch to a document.
Use the the `JsonPatch.apply(doc, ...ops)` function to apply a set of
operations to a JSON document and return the result.
Operations can be created using the factory methods `JsonPatch.add()`,
`JsonPatch.remove()`, etc.
### Methods
#### *static* add(path, value)ð¹
Adds a value to an object or inserts it into an array.
In the case of an
array, the value is inserted before the given index. The - character can be
used instead of an index to insert at the end of an array.
```ts
static add(path: string, value: any): JsonPatch
```
* **path** (string) *No description*
* **value** (any) *No description*
__Returns__:
* [JsonPatch](#projen-jsonpatch)
#### *static* apply(document, ...ops)ð¹
Applies a set of JSON-Patch (RFC-6902) operations to `document` and returns the result.
```ts
static apply(document: any, ...ops: JsonPatch[]): any
```
* **document** (any) The document to patch.
* **ops** ([JsonPatch](#projen-jsonpatch)) The operations to apply.
__Returns__:
* any
#### *static* copy(from, path)ð¹
Copies a value from one location to another within the JSON document.
Both
from and path are JSON Pointers.
```ts
static copy(from: string, path: string): JsonPatch
```
* **from** (string) *No description*
* **path** (string) *No description*
__Returns__:
* [JsonPatch](#projen-jsonpatch)
#### *static* move(from, path)ð¹
Moves a value from one location to the other.
Both from and path are JSON Pointers.
```ts
static move(from: string, path: string): JsonPatch
```
* **from** (string) *No description*
* **path** (string) *No description*
__Returns__:
* [JsonPatch](#projen-jsonpatch)
#### *static* remove(path)ð¹
Removes a value from an object or array.
```ts
static remove(path: string): JsonPatch
```
* **path** (string) *No description*
__Returns__:
* [JsonPatch](#projen-jsonpatch)
#### *static* replace(path, value)ð¹
Replaces a value.
Equivalent to a âremoveâ followed by an âaddâ.
```ts
static replace(path: string, value: any): JsonPatch
```
* **path** (string) *No description*
* **value** (any) *No description*
__Returns__:
* [JsonPatch](#projen-jsonpatch)
#### *static* test(path, value)ð¹
Tests that the specified value is set in the document.
If the test fails,
then the patch as a whole should not apply.
```ts
static test(path: string, value: any): JsonPatch
```
* **path** (string) *No description*
* **value** (any) *No description*
__Returns__:
* [JsonPatch](#projen-jsonpatch)
## class License ð¹
__Extends__: [FileBase](#projen-filebase)
### Initializer
```ts
new License(project: Project, options: LicenseOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([LicenseOptions](#projen-licenseoptions)) *No description*
* **spdx** (string) License type (SPDX).
* **copyrightOwner** (string) Copyright owner. __*Default*__: -
* **copyrightPeriod** (string) Period of license (e.g. "1998-2023"). __*Default*__: current year (e.g. "2020")
### Methods
#### protected synthesizeContent(_)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(_: IResolver): string
```
* **_** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class Logger ð¹
Project-level logging utilities.
__Extends__: [Component](#projen-component)
### Initializer
```ts
new Logger(project: Project, options?: LoggerOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([LoggerOptions](#projen-loggeroptions)) *No description*
* **level** ([LogLevel](#projen-loglevel)) The logging verbosity. __*Default*__: LogLevel.INFO
* **usePrefix** (boolean) Include a prefix for all logging messages with the project name. __*Default*__: false
### Methods
#### debug(...text)ð¹
Log a message to stderr with DEBUG severity.
```ts
debug(...text: any[]): void
```
* **text** (any) strings or objects to print.
#### error(...text)ð¹
Log a message to stderr with ERROR severity.
```ts
error(...text: any[]): void
```
* **text** (any) strings or objects to print.
#### info(...text)ð¹
Log a message to stderr with INFO severity.
```ts
info(...text: any[]): void
```
* **text** (any) strings or objects to print.
#### log(level, ...text)ð¹
Log a message to stderr with a given logging level.
The message will be
printed as long as `logger.level` is set to the message's severity or higher.
```ts
log(level: LogLevel, ...text: any[]): void
```
* **level** ([LogLevel](#projen-loglevel)) Logging verbosity.
* **text** (any) strings or objects to print.
#### verbose(...text)ð¹
Log a message to stderr with VERBOSE severity.
```ts
verbose(...text: any[]): void
```
* **text** (any) strings or objects to print.
#### warn(...text)ð¹
Log a message to stderr with WARN severity.
```ts
warn(...text: any[]): void
```
* **text** (any) strings or objects to print.
## class Makefile ð¹
Minimal Makefile.
__Extends__: [FileBase](#projen-filebase)
### Initializer
```ts
new Makefile(project: Project, filePath: string, options?: MakefileOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **filePath** (string) *No description*
* **options** ([MakefileOptions](#projen-makefileoptions)) *No description*
* **committed** (boolean) Indicates whether this file should be committed to git or ignored. __*Default*__: true
* **editGitignore** (boolean) Update the project's .gitignore file. __*Default*__: true
* **executable** (boolean) Whether the generated file should be marked as executable. __*Default*__: false
* **marker** (boolean) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
* **readonly** (boolean) Whether the generated file should be readonly. __*Default*__: true
* **all** (Array) List of targets to build when Make is invoked without specifying any targets. __*Default*__: []
* **rules** (Array<[Rule](#projen-rule)>) Rules to include in the Makefile. __*Default*__: []
### Properties
Name | Type | Description
-----|------|-------------
**rules**ð¹ | Array<[Rule](#projen-rule)> | List of rule definitions.
### Methods
#### addAll(target)ð¹
Add a target to all.
```ts
addAll(target: string): Makefile
```
* **target** (string) *No description*
__Returns__:
* [Makefile](#projen-makefile)
#### addAlls(...targets)ð¹
Add multiple targets to all.
```ts
addAlls(...targets: string[]): Makefile
```
* **targets** (string) *No description*
__Returns__:
* [Makefile](#projen-makefile)
#### addRule(rule)ð¹
Add a rule to the Makefile.
```ts
addRule(rule: Rule): Makefile
```
* **rule** ([Rule](#projen-rule)) *No description*
* **targets** (Array) Files to be created or updated by this rule.
* **phony** (boolean) Marks whether the target is phony. __*Default*__: false
* **prerequisites** (Array) Files that are used as inputs to create a target. __*Default*__: []
* **recipe** (Array) Commands that are run (using prerequisites as inputs) to create a target. __*Default*__: []
__Returns__:
* [Makefile](#projen-makefile)
#### addRules(...rules)ð¹
Add multiple rules to the Makefile.
```ts
addRules(...rules: Rule[]): Makefile
```
* **rules** ([Rule](#projen-rule)) *No description*
* **targets** (Array) Files to be created or updated by this rule.
* **phony** (boolean) Marks whether the target is phony. __*Default*__: false
* **prerequisites** (Array) Files that are used as inputs to create a target. __*Default*__: []
* **recipe** (Array) Commands that are run (using prerequisites as inputs) to create a target. __*Default*__: []
__Returns__:
* [Makefile](#projen-makefile)
#### protected synthesizeContent(resolver)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(resolver: IResolver): string
```
* **resolver** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class ObjectFile ð¹
Represents an Object file.
__Extends__: [FileBase](#projen-filebase)
__Implemented by__: [IniFile](#projen-inifile), [JsonFile](#projen-jsonfile), [TomlFile](#projen-tomlfile), [XmlFile](#projen-xmlfile), [YamlFile](#projen-yamlfile)
__Obtainable from__: [Project](#projen-project).[tryFindObjectFile](#projen-project#projen-project-tryfindobjectfile)()
### Initializer
```ts
new ObjectFile(project: Project, filePath: string, options: ObjectFileOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **filePath** (string) *No description*
* **options** ([ObjectFileOptions](#projen-objectfileoptions)) *No description*
* **committed** (boolean) Indicates whether this file should be committed to git or ignored. __*Default*__: true
* **editGitignore** (boolean) Update the project's .gitignore file. __*Default*__: true
* **executable** (boolean) Whether the generated file should be marked as executable. __*Default*__: false
* **marker** (boolean) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
* **readonly** (boolean) Whether the generated file should be readonly. __*Default*__: true
* **obj** (any) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
* **omitEmpty** (boolean) Omits empty objects and arrays. __*Default*__: false
### Properties
Name | Type | Description
-----|------|-------------
**omitEmpty**ð¹ | boolean | Indicates if empty objects and arrays are omitted from the output object.
### Methods
#### addDeletionOverride(path)ð¹
Syntactic sugar for `addOverride(path, undefined)`.
```ts
addDeletionOverride(path: string): void
```
* **path** (string) The path of the value to delete.
#### addOverride(path, value)ð¹
Adds an override to the synthesized object file.
If the override is nested, separate each nested level using a dot (.) in the path parameter.
If there is an array as part of the nesting, specify the index in the path.
To include a literal `.` in the property name, prefix with a `\`. In most
programming languages you will need to write this as `"\\."` because the
`\` itself will need to be escaped.
For example,
```typescript
project.tsconfig.file.addOverride('compilerOptions.alwaysStrict', true);
project.tsconfig.file.addOverride('compilerOptions.lib', ['dom', 'dom.iterable', 'esnext']);
```
would add the overrides
```json
"compilerOptions": {
"alwaysStrict": true,
"lib": [
"dom",
"dom.iterable",
"esnext"
]
...
}
...
```
```ts
addOverride(path: string, value: any): void
```
* **path** (string) - The path of the property, you can use dot notation to override values in complex types.
* **value** (any) - The value.
#### addToArray(path, ...values)ð¹
Adds to an array in the synthesized object file.
If the array is nested, separate each nested level using a dot (.) in the path parameter.
If there is an array as part of the nesting, specify the index in the path.
To include a literal `.` in the property name, prefix with a `\`. In most
programming languages you will need to write this as `"\\."` because the
`\` itself will need to be escaped.
For example, with the following object file
```json
"compilerOptions": {
"exclude": ["node_modules"],
"lib": ["es2019"]
...
}
...
```
```typescript
project.tsconfig.file.addToArray('compilerOptions.exclude', 'coverage');
project.tsconfig.file.addToArray('compilerOptions.lib', 'dom', 'dom.iterable', 'esnext');
```
would result in the following object file
```json
"compilerOptions": {
"exclude": ["node_modules", "coverage"],
"lib": ["es2019", "dom", "dom.iterable", "esnext"]
...
}
...
```
```ts
addToArray(path: string, ...values: any[]): void
```
* **path** (string) - The path of the property, you can use dot notation to att to arrays in complex types.
* **values** (any) - The values to add.
#### patch(...patches)ð¹
Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information.
For example, with the following object file
```json
"compilerOptions": {
"exclude": ["node_modules"],
"lib": ["es2019"]
...
}
...
```
```typescript
project.tsconfig.file.patch(JsonPatch.add("/compilerOptions/exclude/-", "coverage"));
project.tsconfig.file.patch(JsonPatch.replace("/compilerOptions/lib", ["dom", "dom.iterable", "esnext"]));
```
would result in the following object file
```json
"compilerOptions": {
"exclude": ["node_modules", "coverage"],
"lib": ["dom", "dom.iterable", "esnext"]
...
}
...
```
```ts
patch(...patches: JsonPatch[]): void
```
* **patches** ([JsonPatch](#projen-jsonpatch)) - The patch operations to apply.
#### protected synthesizeContent(resolver)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(resolver: IResolver): string
```
* **resolver** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class Project ð¹
Base project.
### Initializer
```ts
new Project(options: ProjectOptions)
```
* **options** ([ProjectOptions](#projen-projectoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
### Properties
Name | Type | Description
-----|------|-------------
**buildTask**ð¹ | [Task](#projen-task) |
**commitGenerated**ð¹ | boolean | Whether to commit the managed files by default.
**compileTask**ð¹ | [Task](#projen-task) |
**components**ð¹ | Array<[Component](#projen-component)> | Returns all the components within this project.
**deps**ð¹ | [Dependencies](#projen-dependencies) | Project dependencies.
**ejected**ð¹ | boolean | Whether or not the project is being ejected.
**files**ð¹ | Array<[FileBase](#projen-filebase)> | All files in this project.
**gitattributes**ð¹ | [GitAttributesFile](#projen-gitattributesfile) | The .gitattributes file for this repository.
**gitignore**ð¹ | [IgnoreFile](#projen-ignorefile) | .gitignore.
**logger**ð¹ | [Logger](#projen-logger) | Logging utilities.
**name**ð¹ | string | Project name.
**outdir**ð¹ | string | Absolute output directory of this project.
**packageTask**ð¹ | [Task](#projen-task) |
**postCompileTask**ð¹ | [Task](#projen-task) |
**preCompileTask**ð¹ | [Task](#projen-task) |
**projectBuild**ð¹ | [ProjectBuild](#projen-projectbuild) | Manages the build process of the project.
**projenCommand**ð¹ | string | The command to use in order to run the projen CLI.
**root**ð¹ | [Project](#projen-project) | The root project.
**subprojects**ð¹ | Array<[Project](#projen-project)> | Returns all the subprojects within this project.
**tasks**ð¹ | [Tasks](#projen-tasks) | Project tasks.
**testTask**ð¹ | [Task](#projen-task) |
**defaultTask**?ð¹ | [Task](#projen-task) | This is the "default" task, the one that executes "projen".
__*Optional*__
**initProject**?ð¹ | [InitProject](#projen-initproject) | The options used when this project is bootstrapped via `projen new`.
__*Optional*__
**parent**?ð¹ | [Project](#projen-project) | A parent project.
__*Optional*__
*static* **DEFAULT_TASK**ð¹ | string | The name of the default task (the task executed when `projen` is run without arguments).
### Methods
#### addExcludeFromCleanup(...globs)ð¹
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.
```ts
addExcludeFromCleanup(...globs: string[]): void
```
* **globs** (string) The glob patterns to match.
#### addGitIgnore(pattern)ð¹
Adds a .gitignore pattern.
```ts
addGitIgnore(pattern: string): void
```
* **pattern** (string) The glob pattern to ignore.
#### addPackageIgnore(_pattern)ð¹
Exclude these files from the bundled package.
Implemented by project types based on the
packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
```ts
addPackageIgnore(_pattern: string): void
```
* **_pattern** (string) The glob pattern to exclude.
#### addTask(name, props?)ð¹
Adds a new task to this project.
This will fail if the project already has
a task with this name.
```ts
addTask(name: string, props?: TaskOptions): Task
```
* **name** (string) The task name to add.
* **props** ([TaskOptions](#projen-taskoptions)) Task properties.
* **condition** (string) A shell command which determines if the this task should be executed. __*Optional*__
* **cwd** (string) The working directory for all steps in this task (unless overridden by the step). __*Default*__: process.cwd()
* **description** (string) The description of this build command. __*Default*__: the task name
* **env** (Map) Defines environment variables for the execution of this task. __*Default*__: {}
* **requiredEnv** (Array) A set of environment variables that must be defined in order to execute this task. __*Optional*__
* **args** (Array) Should the provided `exec` shell command receive fixed args. __*Default*__: no arguments are passed to the step
* **exec** (string) Shell command to execute as the first command of the task. __*Default*__: add steps using `task.exec(command)` or `task.spawn(subtask)`
* **receiveArgs** (boolean) Should the provided `exec` shell command receive args passed to the task. __*Default*__: false
* **steps** (Array<[TaskStep](#projen-taskstep)>) List of task steps to run. __*Optional*__
__Returns__:
* [Task](#projen-task)
#### addTip(message)â ïž
Prints a "tip" message during synthesis.
```ts
addTip(message: string): void
```
* **message** (string) The message.
#### annotateGenerated(_glob)ð¹
Consider a set of files as "generated".
This method is implemented by
derived classes and used for example, to add git attributes to tell GitHub
that certain files are generated.
```ts
annotateGenerated(_glob: string): void
```
* **_glob** (string) the glob pattern to match (could be a file path).
#### postSynthesize()ð¹
Called after all components are synthesized.
Order is *not* guaranteed.
```ts
postSynthesize(): void
```
#### preSynthesize()ð¹
Called before all components are synthesized.
```ts
preSynthesize(): void
```
#### removeTask(name)ð¹
Removes a task from a project.
```ts
removeTask(name: string): Task
```
* **name** (string) The name of the task to remove.
__Returns__:
* [Task](#projen-task)
#### runTaskCommand(task)ð¹
Returns the shell command to execute in order to run a task.
By default, this is `npx projen@ `
```ts
runTaskCommand(task: Task): string
```
* **task** ([Task](#projen-task)) The task for which the command is required.
__Returns__:
* string
#### synth()ð¹
Synthesize all project files into `outdir`.
1. Call "this.preSynthesize()"
2. Delete all generated files
3. Synthesize all sub-projects
4. Synthesize all components of this project
5. Call "postSynthesize()" for all components of this project
6. Call "this.postSynthesize()"
```ts
synth(): void
```
#### tryFindFile(filePath)ð¹
Finds a file at the specified relative path within this project and all its subprojects.
```ts
tryFindFile(filePath: string): FileBase
```
* **filePath** (string) The file path.
__Returns__:
* [FileBase](#projen-filebase)
#### tryFindJsonFile(filePath)â ïž
Finds a json file by name.
```ts
tryFindJsonFile(filePath: string): JsonFile
```
* **filePath** (string) The file path.
__Returns__:
* [JsonFile](#projen-jsonfile)
#### tryFindObjectFile(filePath)ð¹
Finds an object file (like JsonFile, YamlFile, etc.) by name.
```ts
tryFindObjectFile(filePath: string): ObjectFile
```
* **filePath** (string) The file path.
__Returns__:
* [ObjectFile](#projen-objectfile)
#### tryRemoveFile(filePath)ð¹
Finds a file at the specified relative path within this project and removes it.
```ts
tryRemoveFile(filePath: string): FileBase
```
* **filePath** (string) The file path.
__Returns__:
* [FileBase](#projen-filebase)
## class ProjectBuild ð¹
Manages a standard build process for all projects.
Build spawns these tasks in order:
1. default
2. pre-compile
3. compile
4. post-compile
5. test
6. package
__Extends__: [Component](#projen-component)
### Initializer
```ts
new ProjectBuild(project: Project)
```
* **project** ([Project](#projen-project)) *No description*
### Properties
Name | Type | Description
-----|------|-------------
**buildTask**ð¹ | [Task](#projen-task) | The task responsible for a full release build.
**compileTask**ð¹ | [Task](#projen-task) | Compiles the code.
**packageTask**ð¹ | [Task](#projen-task) | The "package" task.
**postCompileTask**ð¹ | [Task](#projen-task) | Post-compile task.
**preCompileTask**ð¹ | [Task](#projen-task) | Pre-compile task.
**testTask**ð¹ | [Task](#projen-task) | Tests the code.
## class Projects ð¹
Programmatic API for projen.
### Methods
#### *static* createProject(options)ð¹
Creates a new project with defaults.
This function creates the project type in-process (with in VM) and calls
`.synth()` on it (if `options.synth` is not `false`).
At the moment, it also generates a `.projenrc.js` file with the same code
that was just executed. In the future, this will also be done by the project
type, so we can easily support multiple languages of projenrc.
An environment variable (PROJEN_CREATE_PROJECT=true) is set within the VM
so that custom project types can detect whether the current synthesis is the
result of a new project creation (and take additional steps accordingly)
```ts
static createProject(options: CreateProjectOptions): void
```
* **options** ([CreateProjectOptions](#projen-createprojectoptions)) *No description*
* **dir** (string) Directory that the project will be generated in.
* **projectFqn** (string) Fully-qualified name of the project type (usually formatted as `projen.module.ProjectType`).
* **projectOptions** (Map) Project options.
* **optionHints** ([InitProjectOptionHints](#projen-initprojectoptionhints)) Should we render commented-out default options in the projenrc file? __*Default*__: InitProjectOptionHints.FEATURED
* **post** (boolean) Should we execute post synthesis hooks? __*Default*__: true
* **synth** (boolean) Should we call `project.synth()` or instantiate the project (could still have side-effects) and render the .projenrc file. __*Default*__: true
## class Projenrc â ïž
__Extends__: [ProjenrcJson](#projen-projenrcjson)
### Initializer
```ts
new Projenrc(project: Project, options?: ProjenrcJsonOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) *No description*
* **filename** (string) The name of the projenrc file. __*Default*__: ".projenrc.json"
## class ProjenrcFile ð¹
A component representing the projen runtime configuration.
__Extends__: [Component](#projen-component)
__Implemented by__: [java.Projenrc](#projen-java-projenrc), [javascript.Projenrc](#projen-javascript-projenrc), [python.Projenrc](#projen-python-projenrc), [typescript.Projenrc](#projen-typescript-projenrc), [typescript.ProjenrcTs](#projen-typescript-projenrcts), [Projenrc](#projen-projenrc), [ProjenrcJson](#projen-projenrcjson)
### Initializer
```ts
new ProjenrcFile(project: Project)
```
* **project** ([Project](#projen-project)) *No description*
### Properties
Name | Type | Description
-----|------|-------------
**filePath**ð¹ | string | The path of the projenrc file.
### Methods
#### *static* of(project)ð¹
Returns the `Projenrc` instance associated with a project or `undefined` if there is no Projenrc.
```ts
static of(project: Project): ProjenrcFile
```
* **project** ([Project](#projen-project)) The project.
__Returns__:
* [ProjenrcFile](#projen-projenrcfile)
## class ProjenrcJson ð¹
Sets up a project to use JSON for projenrc.
__Extends__: [ProjenrcFile](#projen-projenrcfile)
### Initializer
```ts
new ProjenrcJson(project: Project, options?: ProjenrcJsonOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) *No description*
* **filename** (string) The name of the projenrc file. __*Default*__: ".projenrc.json"
### Properties
Name | Type | Description
-----|------|-------------
**filePath**ð¹ | string | The path of the projenrc file.
## class Renovatebot ð¹
Defines renovatebot configuration for projen project.
Ignores the versions controlled by Projen.
__Extends__: [Component](#projen-component)
### Initializer
```ts
new Renovatebot(project: Project, options?: RenovatebotOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([RenovatebotOptions](#projen-renovatebotoptions)) *No description*
* **ignore** (Array) You can use the `ignore` option to customize which dependencies are updated. __*Default*__: []
* **ignoreProjen** (boolean) Ignores updates to `projen`. __*Default*__: true
* **labels** (Array) List of labels to apply to the created PR's. __*Optional*__
* **marker** (boolean) *No description* __*Optional*__
* **overrideConfig** (any) *No description* __*Optional*__
* **scheduleInterval** (Array) How often to check for new versions and raise pull requests. __*Default*__: ["at any time"]
### Methods
#### preSynthesize()ð¹
Called before synthesis.
```ts
preSynthesize(): void
```
## class SampleDir ð¹
Renders the given files into the directory if the directory does not exist.
Use this to create sample code files
__Extends__: [Component](#projen-component)
### Initializer
Create sample files in the given directory if the given directory does not exist.
```ts
new SampleDir(project: Project, dir: string, options: SampleDirOptions)
```
* **project** ([Project](#projen-project)) Parent project to add files to.
* **dir** (string) directory to add files to.
* **options** ([SampleDirOptions](#projen-samplediroptions)) options for which files to create.
* **files** (Map) The files to render into the directory. __*Optional*__
* **sourceDir** (string) Absolute path to a directory to copy files from (does not need to be text files). __*Optional*__
### Methods
#### synthesize()ð¹
Synthesizes files to the project output directory.
```ts
synthesize(): void
```
## class SampleFile ð¹
Produces a file with the given contents but only once, if the file doesn't already exist.
Use this for creating example code files or other resources.
__Extends__: [Component](#projen-component)
### Initializer
Creates a new SampleFile object.
```ts
new SampleFile(project: Project, filePath: string, options: SampleFileOptions)
```
* **project** ([Project](#projen-project)) - the project to tie this file to.
* **filePath** (string) - the relative path in the project to put the file.
* **options** ([SampleFileOptions](#projen-samplefileoptions)) - the options for the file.
* **contents** (string) The contents of the file to write. __*Optional*__
* **sourcePath** (string) Absolute path to a file to copy the contents from (does not need to be a text file). __*Optional*__
### Methods
#### synthesize()ð¹
Synthesizes files to the project output directory.
```ts
synthesize(): void
```
## class SampleReadme ð¹
Represents a README.md sample file. You are expected to manage this file after creation.
__Extends__: [SampleFile](#projen-samplefile)
### Initializer
```ts
new SampleReadme(project: Project, props?: SampleReadmeProps)
```
* **project** ([Project](#projen-project)) *No description*
* **props** ([SampleReadmeProps](#projen-samplereadmeprops)) *No description*
* **contents** (string) The contents. __*Default*__: "# replace this"
* **filename** (string) The name of the README.md file. __*Default*__: "README.md"
## class Semver â ïž
### Properties
Name | Type | Description
-----|------|-------------
**spec**â ïž | string |
**mode**?â ïž | string | __*Optional*__
**version**?â ïž | string | __*Optional*__
### Methods
#### *static* caret(version)â ïž
Accept any minor version.
>= version
< next major version
```ts
static caret(version: string): Semver
```
* **version** (string) *No description*
__Returns__:
* [Semver](#projen-semver)
#### *static* latest()â ïž
Latest version.
```ts
static latest(): Semver
```
__Returns__:
* [Semver](#projen-semver)
#### *static* of(spec)â ïž
```ts
static of(spec: string): Semver
```
* **spec** (string) *No description*
__Returns__:
* [Semver](#projen-semver)
#### *static* pinned(version)â ïž
Accept only an exact version.
```ts
static pinned(version: string): Semver
```
* **version** (string) *No description*
__Returns__:
* [Semver](#projen-semver)
#### *static* tilde(version)â ïž
Accept patches.
>= version
< next minor version
```ts
static tilde(version: string): Semver
```
* **version** (string) *No description*
__Returns__:
* [Semver](#projen-semver)
## class SourceCode ð¹
Represents a source file.
__Extends__: [Component](#projen-component)
### Initializer
```ts
new SourceCode(project: Project, filePath: string, options?: SourceCodeOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **filePath** (string) *No description*
* **options** ([SourceCodeOptions](#projen-sourcecodeoptions)) *No description*
* **indent** (number) Indentation size. __*Default*__: 2
* **readonly** (boolean) Whether the generated file should be readonly. __*Default*__: true
### Properties
Name | Type | Description
-----|------|-------------
**filePath**ð¹ | string |
**marker**?ð¹ | string | __*Optional*__
### Methods
#### close(code?)ð¹
Decreases the indentation level and closes a code block.
```ts
close(code?: string): void
```
* **code** (string) The code after the block is closed (e.g. `}`).
#### line(code?)ð¹
Emit a line of code.
```ts
line(code?: string): void
```
* **code** (string) The contents, if not specified, just adds a newline.
#### open(code?)ð¹
Opens a code block and increases the indentation level.
```ts
open(code?: string): void
```
* **code** (string) The code before the block starts (e.g. `export class {`).
## class Task ð¹
A task that can be performed on the project.
Modeled as a series of shell
commands and subtasks.
### Initializer
```ts
new Task(name: string, props?: TaskOptions)
```
* **name** (string) *No description*
* **props** ([TaskOptions](#projen-taskoptions)) *No description*
* **condition** (string) A shell command which determines if the this task should be executed. __*Optional*__
* **cwd** (string) The working directory for all steps in this task (unless overridden by the step). __*Default*__: process.cwd()
* **description** (string) The description of this build command. __*Default*__: the task name
* **env** (Map) Defines environment variables for the execution of this task. __*Default*__: {}
* **requiredEnv** (Array) A set of environment variables that must be defined in order to execute this task. __*Optional*__
* **args** (Array) Should the provided `exec` shell command receive fixed args. __*Default*__: no arguments are passed to the step
* **exec** (string) Shell command to execute as the first command of the task. __*Default*__: add steps using `task.exec(command)` or `task.spawn(subtask)`
* **receiveArgs** (boolean) Should the provided `exec` shell command receive args passed to the task. __*Default*__: false
* **steps** (Array<[TaskStep](#projen-taskstep)>) List of task steps to run. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | Task name.
**steps**ð¹ | Array<[TaskStep](#projen-taskstep)> | Returns an immutable copy of all the step specifications of the task.
**condition**?ð¹ | string | A command to execute which determines if the task should be skipped.
__*Optional*__
**description**?ð¹ | string | Returns the description of this task.
__*Optional*__
### Methods
#### addCondition(...condition)ð¹
Add a command to execute which determines if the task should be skipped.
If a condition already exists, the new condition will be appended with ` && ` delimiter.
```ts
addCondition(...condition: string[]): void
```
* **condition** (string) The command to execute.
#### builtin(name)ð¹
Execute a builtin task.
Builtin tasks are programs bundled as part of projen itself and used as
helpers for various components.
In the future we should support built-in tasks from external modules.
```ts
builtin(name: string): void
```
* **name** (string) The name of the builtin task to execute (e.g. `release/resolve-version`).
#### env(name, value)ð¹
Adds an environment variable to this task.
```ts
env(name: string, value: string): void
```
* **name** (string) The name of the variable.
* **value** (string) The value.
#### exec(command, options?)ð¹
Executes a shell command.
```ts
exec(command: string, options?: TaskStepOptions): void
```
* **command** (string) Shell command.
* **options** ([TaskStepOptions](#projen-taskstepoptions)) Options.
* **args** (Array) A list of fixed arguments always passed to the step. __*Default*__: no arguments are passed to the step
* **condition** (string) A shell command which determines if the this step should be executed. __*Optional*__
* **cwd** (string) The working directory for this step. __*Default*__: determined by the task
* **env** (Map) Defines environment variables for the execution of this step (`exec` and `builtin` only). __*Default*__: no environment variables defined in step
* **name** (string) Step name. __*Default*__: no name
* **receiveArgs** (boolean) Should this step receive args passed to the task. __*Default*__: false
#### lock()ð¹
Forbid additional changes to this task.
```ts
lock(): void
```
#### prepend(shell, options?)â ïž
Adds a command at the beginning of the task.
```ts
prepend(shell: string, options?: TaskStepOptions): void
```
* **shell** (string) The command to add.
* **options** ([TaskStepOptions](#projen-taskstepoptions)) *No description*
* **args** (Array) A list of fixed arguments always passed to the step. __*Default*__: no arguments are passed to the step
* **condition** (string) A shell command which determines if the this step should be executed. __*Optional*__
* **cwd** (string) The working directory for this step. __*Default*__: determined by the task
* **env** (Map) Defines environment variables for the execution of this step (`exec` and `builtin` only). __*Default*__: no environment variables defined in step
* **name** (string) Step name. __*Default*__: no name
* **receiveArgs** (boolean) Should this step receive args passed to the task. __*Default*__: false
#### prependExec(shell, options?)ð¹
Adds a command at the beginning of the task.
```ts
prependExec(shell: string, options?: TaskStepOptions): void
```
* **shell** (string) The command to add.
* **options** ([TaskStepOptions](#projen-taskstepoptions)) *No description*
* **args** (Array) A list of fixed arguments always passed to the step. __*Default*__: no arguments are passed to the step
* **condition** (string) A shell command which determines if the this step should be executed. __*Optional*__
* **cwd** (string) The working directory for this step. __*Default*__: determined by the task
* **env** (Map) Defines environment variables for the execution of this step (`exec` and `builtin` only). __*Default*__: no environment variables defined in step
* **name** (string) Step name. __*Default*__: no name
* **receiveArgs** (boolean) Should this step receive args passed to the task. __*Default*__: false
#### prependSay(message, options?)ð¹
Says something at the beginning of the task.
```ts
prependSay(message: string, options?: TaskStepOptions): void
```
* **message** (string) Your message.
* **options** ([TaskStepOptions](#projen-taskstepoptions)) *No description*
* **args** (Array) A list of fixed arguments always passed to the step. __*Default*__: no arguments are passed to the step
* **condition** (string) A shell command which determines if the this step should be executed. __*Optional*__
* **cwd** (string) The working directory for this step. __*Default*__: determined by the task
* **env** (Map) Defines environment variables for the execution of this step (`exec` and `builtin` only). __*Default*__: no environment variables defined in step
* **name** (string) Step name. __*Default*__: no name
* **receiveArgs** (boolean) Should this step receive args passed to the task. __*Default*__: false
#### prependSpawn(subtask, options?)ð¹
Adds a spawn instruction at the beginning of the task.
```ts
prependSpawn(subtask: Task, options?: TaskStepOptions): void
```
* **subtask** ([Task](#projen-task)) The subtask to execute.
* **options** ([TaskStepOptions](#projen-taskstepoptions)) *No description*
* **args** (Array) A list of fixed arguments always passed to the step. __*Default*__: no arguments are passed to the step
* **condition** (string) A shell command which determines if the this step should be executed. __*Optional*__
* **cwd** (string) The working directory for this step. __*Default*__: determined by the task
* **env** (Map) Defines environment variables for the execution of this step (`exec` and `builtin` only). __*Default*__: no environment variables defined in step
* **name** (string) Step name. __*Default*__: no name
* **receiveArgs** (boolean) Should this step receive args passed to the task. __*Default*__: false
#### reset(command?, options?)ð¹
Reset the task so it no longer has any commands.
```ts
reset(command?: string, options?: TaskStepOptions): void
```
* **command** (string) the first command to add to the task after it was cleared.
* **options** ([TaskStepOptions](#projen-taskstepoptions)) *No description*
* **args** (Array) A list of fixed arguments always passed to the step. __*Default*__: no arguments are passed to the step
* **condition** (string) A shell command which determines if the this step should be executed. __*Optional*__
* **cwd** (string) The working directory for this step. __*Default*__: determined by the task
* **env** (Map) Defines environment variables for the execution of this step (`exec` and `builtin` only). __*Default*__: no environment variables defined in step
* **name** (string) Step name. __*Default*__: no name
* **receiveArgs** (boolean) Should this step receive args passed to the task. __*Default*__: false
#### say(message, options?)ð¹
Say something.
```ts
say(message: string, options?: TaskStepOptions): void
```
* **message** (string) Your message.
* **options** ([TaskStepOptions](#projen-taskstepoptions)) Options.
* **args** (Array) A list of fixed arguments always passed to the step. __*Default*__: no arguments are passed to the step
* **condition** (string) A shell command which determines if the this step should be executed. __*Optional*__
* **cwd** (string) The working directory for this step. __*Default*__: determined by the task
* **env** (Map) Defines environment variables for the execution of this step (`exec` and `builtin` only). __*Default*__: no environment variables defined in step
* **name** (string) Step name. __*Default*__: no name
* **receiveArgs** (boolean) Should this step receive args passed to the task. __*Default*__: false
#### spawn(subtask, options?)ð¹
Spawns a sub-task.
```ts
spawn(subtask: Task, options?: TaskStepOptions): void
```
* **subtask** ([Task](#projen-task)) The subtask to execute.
* **options** ([TaskStepOptions](#projen-taskstepoptions)) *No description*
* **args** (Array) A list of fixed arguments always passed to the step. __*Default*__: no arguments are passed to the step
* **condition** (string) A shell command which determines if the this step should be executed. __*Optional*__
* **cwd** (string) The working directory for this step. __*Default*__: determined by the task
* **env** (Map) Defines environment variables for the execution of this step (`exec` and `builtin` only). __*Default*__: no environment variables defined in step
* **name** (string) Step name. __*Default*__: no name
* **receiveArgs** (boolean) Should this step receive args passed to the task. __*Default*__: false
## class TaskRuntime ð¹
The runtime component of the tasks engine.
### Initializer
```ts
new TaskRuntime(workdir: string)
```
* **workdir** (string) *No description*
### Properties
Name | Type | Description
-----|------|-------------
**manifest**ð¹ | [TasksManifest](#projen-tasksmanifest) | The contents of tasks.json.
**tasks**ð¹ | Array<[TaskSpec](#projen-taskspec)> | The tasks in this project.
**workdir**ð¹ | string | The root directory of the project and the cwd for executing tasks.
*static* **MANIFEST_FILE**ð¹ | string | The project-relative path of the tasks manifest file.
### Methods
#### runTask(name, parents?, args?)ð¹
Runs the task.
```ts
runTask(name: string, parents?: Array, args?: Array): void
```
* **name** (string) The task name.
* **parents** (Array) *No description*
* **args** (Array) *No description*
#### tryFindTask(name)ð¹
Find a task by name, or `undefined` if not found.
```ts
tryFindTask(name: string): TaskSpec
```
* **name** (string) *No description*
__Returns__:
* [TaskSpec](#projen-taskspec)
## class Tasks ð¹
Defines project tasks.
Tasks extend the projen CLI by adding subcommands to it. Task definitions are
synthesized into `.projen/tasks.json`.
__Extends__: [Component](#projen-component)
### Initializer
```ts
new Tasks(project: Project)
```
* **project** ([Project](#projen-project)) *No description*
### Properties
Name | Type | Description
-----|------|-------------
**all**ð¹ | Array<[Task](#projen-task)> | All tasks.
**env**ð¹ | Map | Returns a copy of the currently global environment for this project.
### Methods
#### addEnvironment(name, value)ð¹
Adds global environment.
```ts
addEnvironment(name: string, value: string): void
```
* **name** (string) Environment variable name.
* **value** (string) Value.
#### addTask(name, options?)ð¹
Adds a task to a project.
```ts
addTask(name: string, options?: TaskOptions): Task
```
* **name** (string) The name of the task.
* **options** ([TaskOptions](#projen-taskoptions)) Task options.
* **condition** (string) A shell command which determines if the this task should be executed. __*Optional*__
* **cwd** (string) The working directory for all steps in this task (unless overridden by the step). __*Default*__: process.cwd()
* **description** (string) The description of this build command. __*Default*__: the task name
* **env** (Map) Defines environment variables for the execution of this task. __*Default*__: {}
* **requiredEnv** (Array) A set of environment variables that must be defined in order to execute this task. __*Optional*__
* **args** (Array) Should the provided `exec` shell command receive fixed args. __*Default*__: no arguments are passed to the step
* **exec** (string) Shell command to execute as the first command of the task. __*Default*__: add steps using `task.exec(command)` or `task.spawn(subtask)`
* **receiveArgs** (boolean) Should the provided `exec` shell command receive args passed to the task. __*Default*__: false
* **steps** (Array<[TaskStep](#projen-taskstep)>) List of task steps to run. __*Optional*__
__Returns__:
* [Task](#projen-task)
#### removeTask(name)ð¹
Removes a task from a project.
```ts
removeTask(name: string): Task
```
* **name** (string) The name of the task to remove.
__Returns__:
* [Task](#projen-task)
#### synthesize()ð¹
Synthesizes files to the project output directory.
```ts
synthesize(): void
```
#### tryFind(name)ð¹
Finds a task by name.
Returns `undefined` if the task cannot be found.
```ts
tryFind(name: string): Task
```
* **name** (string) The name of the task.
__Returns__:
* [Task](#projen-task)
## class Testing ð¹
A Testing static class with a .synth helper for getting a snapshots of construct outputs. Useful for snapshot testing with Jest.
### Methods
#### *static* synth(project, options?)ð¹
Produces a simple JS object that represents the contents of the projects with field names being file paths.
```ts
static synth(project: Project, options?: SnapshotOptions): Map
```
* **project** ([Project](#projen-project)) the project to produce a snapshot for.
* **options** ([SnapshotOptions](#projen-snapshotoptions)) *No description*
* **parseJson** (boolean) Parse .json files as a JS object for improved inspection. This will fail if the contents are invalid JSON. __*Default*__: true parse .json files into an object
__Returns__:
* Map
## class TextFile ð¹
A text file.
__Extends__: [FileBase](#projen-filebase)
### Initializer
Defines a text file.
```ts
new TextFile(project: Project, filePath: string, options?: TextFileOptions)
```
* **project** ([Project](#projen-project)) The project.
* **filePath** (string) File path.
* **options** ([TextFileOptions](#projen-textfileoptions)) Options.
* **committed** (boolean) Indicates whether this file should be committed to git or ignored. __*Default*__: true
* **editGitignore** (boolean) Update the project's .gitignore file. __*Default*__: true
* **executable** (boolean) Whether the generated file should be marked as executable. __*Default*__: false
* **marker** (boolean) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
* **readonly** (boolean) Whether the generated file should be readonly. __*Default*__: true
* **lines** (Array) The contents of the text file. __*Default*__: [] empty file
### Methods
#### addLine(line)ð¹
Adds a line to the text file.
```ts
addLine(line: string): void
```
* **line** (string) the line to add (can use tokens).
#### protected synthesizeContent(_)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(_: IResolver): string
```
* **_** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class TomlFile ð¹
Represents a TOML file.
__Extends__: [ObjectFile](#projen-objectfile)
### Initializer
```ts
new TomlFile(project: Project, filePath: string, options: TomlFileOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **filePath** (string) *No description*
* **options** ([TomlFileOptions](#projen-tomlfileoptions)) *No description*
* **committed** (boolean) Indicates whether this file should be committed to git or ignored. __*Default*__: true
* **editGitignore** (boolean) Update the project's .gitignore file. __*Default*__: true
* **executable** (boolean) Whether the generated file should be marked as executable. __*Default*__: false
* **marker** (boolean) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
* **readonly** (boolean) Whether the generated file should be readonly. __*Default*__: true
* **obj** (any) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
* **omitEmpty** (boolean) Omits empty objects and arrays. __*Default*__: false
### Methods
#### protected synthesizeContent(resolver)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(resolver: IResolver): string
```
* **resolver** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class Version ð¹
__Extends__: [Component](#projen-component)
### Initializer
```ts
new Version(project: Project, options: VersionOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([VersionOptions](#projen-versionoptions)) *No description*
* **artifactsDirectory** (string) The name of the directory into which `changelog.md` and `version.txt` files are emitted.
* **versionInputFile** (string) A name of a .json file to set the `version` field in after a bump.
* **tagPrefix** (string) The tag prefix corresponding to this version. __*Optional*__
* **versionrcOptions** (Map) Custom configuration for versionrc file used by standard-release. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**bumpTask**ð¹ | [Task](#projen-task) |
**changelogFileName**ð¹ | string | The name of the changelog file (under `artifactsDirectory`).
**releaseTagFileName**ð¹ | string | The name of the file that contains the release tag (under `artifactsDirectory`).
**unbumpTask**ð¹ | [Task](#projen-task) |
**versionFileName**ð¹ | string | The name of the file that contains the version (under `artifactsDirectory`).
*static* **STANDARD_VERSION**ð¹ | string |
## class XmlFile ð¹
Represents an XML file.
Objects passed in will be synthesized using the npm "xml" library.
__Extends__: [ObjectFile](#projen-objectfile)
### Initializer
```ts
new XmlFile(project: Project, filePath: string, options?: XmlFileOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **filePath** (string) *No description*
* **options** ([XmlFileOptions](#projen-xmlfileoptions)) *No description*
* **committed** (boolean) Indicates whether this file should be committed to git or ignored. __*Default*__: true
* **editGitignore** (boolean) Update the project's .gitignore file. __*Default*__: true
* **executable** (boolean) Whether the generated file should be marked as executable. __*Default*__: false
* **marker** (boolean) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
* **readonly** (boolean) Whether the generated file should be readonly. __*Default*__: true
* **obj** (any) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
* **omitEmpty** (boolean) Omits empty objects and arrays. __*Default*__: false
### Methods
#### protected synthesizeContent(resolver)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(resolver: IResolver): string
```
* **resolver** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class YamlFile ð¹
Represents a YAML file.
__Extends__: [ObjectFile](#projen-objectfile)
### Initializer
```ts
new YamlFile(project: Project, filePath: string, options: YamlFileOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **filePath** (string) *No description*
* **options** ([YamlFileOptions](#projen-yamlfileoptions)) *No description*
* **committed** (boolean) Indicates whether this file should be committed to git or ignored. __*Default*__: true
* **editGitignore** (boolean) Update the project's .gitignore file. __*Default*__: true
* **executable** (boolean) Whether the generated file should be marked as executable. __*Default*__: false
* **marker** (boolean) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
* **readonly** (boolean) Whether the generated file should be readonly. __*Default*__: true
* **obj** (any) The object that will be serialized. __*Default*__: {} an empty object (use `file.obj` to mutate).
* **omitEmpty** (boolean) Omits empty objects and arrays. __*Default*__: false
* **lineWidth** (number) Maximum line width (set to 0 to disable folding). __*Default*__: 0
### Properties
Name | Type | Description
-----|------|-------------
**lineWidth**ð¹ | number | Maximum line width (set to 0 to disable folding).
### Methods
#### protected synthesizeContent(resolver)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(resolver: IResolver): string
```
* **resolver** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class AutoDiscover ð¹
Discovers and creates integration tests and lambdas from code in the project's source and test trees.
__Submodule__: awscdk
__Extends__: [Component](#projen-component)
### Initializer
```ts
new awscdk.AutoDiscover(project: Project, options: AutoDiscoverOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.AutoDiscoverOptions](#projen-awscdk-autodiscoveroptions)) *No description*
* **cdkDeps** ([awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)) AWS CDK dependency manager.
* **tsconfigPath** (string) Path to the tsconfig file to use for integration tests.
* **srcdir** (string) Project source tree (relative to project output directory).
* **lambdaOptions** ([awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)) Options for AWS Lambda functions. __*Optional*__
* **lambdaExtensionOptions** ([awscdk.LambdaExtensionCommonOptions](#projen-awscdk-lambdaextensioncommonoptions)) Options for lambda extensions. __*Optional*__
* **testdir** (string) Test source tree.
* **integrationTestOptions** ([awscdk.IntegrationTestCommonOptions](#projen-awscdk-integrationtestcommonoptions)) Options for integration tests. __*Optional*__
* **edgeLambdaAutoDiscover** (boolean) Auto-discover edge lambda functions. __*Default*__: true
* **integrationTestAutoDiscover** (boolean) Auto-discover integration tests. __*Default*__: true
* **lambdaAutoDiscover** (boolean) Auto-discover lambda functions. __*Default*__: true
* **lambdaExtensionAutoDiscover** (boolean) Auto-discover lambda extensions. __*Default*__: true
## class AwsCdkConstructLibrary ð¹
AWS CDK construct library project.
A multi-language (jsii) construct library which vends constructs designed to
use within the AWS CDK with a friendly workflow and automatic publishing to
the construct catalog.
__Submodule__: awscdk
__Extends__: [cdk.ConstructLibrary](#projen-cdk-constructlibrary)
### Initializer
```ts
new awscdk.AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
```
* **options** ([awscdk.AwsCdkConstructLibraryOptions](#projen-awscdk-awscdkconstructlibraryoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
* **author** (string) The name of the library author.
* **authorAddress** (string) Email or URL of the library author.
* **repositoryUrl** (string) Git repository URL.
* **compat** (boolean) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
* **compatIgnore** (string) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
* **compressAssembly** (boolean) Emit a compressed version of the assembly. __*Default*__: false
* **docgenFilePath** (string) File path for generated docs. __*Default*__: "API.md"
* **dotnet** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) *No description* __*Optional*__
* **excludeTypescript** (Array) Accepts a list of glob patterns. __*Optional*__
* **jsiiVersion** (string) Version of the jsii compiler to use. __*Default*__: "1.x"
* **publishToGo** ([cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)) Publish Go bindings to a git repository. __*Default*__: no publishing
* **publishToMaven** ([cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)) Publish to maven. __*Default*__: no publishing
* **publishToNuget** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) Publish to NuGet. __*Default*__: no publishing
* **publishToPypi** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) Publish to pypi. __*Default*__: no publishing
* **python** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) *No description* __*Optional*__
* **rootdir** (string) *No description* __*Default*__: "."
* **catalog** ([cdk.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:. __*Default*__: new version will be announced
* **cdkVersion** (string) Minimum version of the AWS CDK to depend on.
* **cdkAssert** (boolean) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
* **cdkAssertions** (boolean) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
* **cdkDependencies** (Array) Which AWS CDKv1 modules this project requires. __*Optional*__
* **cdkDependenciesAsDeps** (boolean) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
* **cdkTestDependencies** (Array) AWS CDK modules required for testing. __*Optional*__
* **cdkVersionPinning** (boolean) Use pinned version instead of caret version for CDK. __*Optional*__
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
* **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. __*Default*__: true
* **integrationTestAutoDiscover** (boolean) Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. __*Default*__: true
* **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. __*Default*__: true
* **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. __*Default*__: true
* **lambdaOptions** ([awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)) Common options for all AWS Lambda functions. __*Default*__: default options
### Properties
Name | Type | Description
-----|------|-------------
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) |
**cdkVersion**ð¹ | string | The target CDK version for this library.
**version**â ïž | string |
### Methods
#### addCdkDependencies(...deps)â ïž
Adds dependencies to AWS CDK modules.
Since this is a library project, dependencies will be added as peer dependencies.
```ts
addCdkDependencies(...deps: string[]): void
```
* **deps** (string) names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
#### addCdkTestDependencies(...deps)â ïž
Adds AWS CDK modules as dev dependencies.
```ts
addCdkTestDependencies(...deps: string[]): void
```
* **deps** (string) names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
## class AwsCdkDeps ð¹
Manages dependencies on the AWS CDK.
__Submodule__: awscdk
__Extends__: [Component](#projen-component)
__Implemented by__: [awscdk.AwsCdkDepsJava](#projen-awscdk-awscdkdepsjava), [awscdk.AwsCdkDepsJs](#projen-awscdk-awscdkdepsjs), [awscdk.AwsCdkDepsPy](#projen-awscdk-awscdkdepspy)
### Initializer
```ts
new awscdk.AwsCdkDeps(project: Project, options: AwsCdkDepsOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.AwsCdkDepsOptions](#projen-awscdk-awscdkdepsoptions)) *No description*
* **cdkVersion** (string) Minimum version of the AWS CDK to depend on.
* **cdkAssert** (boolean) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
* **cdkAssertions** (boolean) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
* **cdkDependencies** (Array) Which AWS CDKv1 modules this project requires. __*Optional*__
* **cdkDependenciesAsDeps** (boolean) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
* **cdkTestDependencies** (Array) AWS CDK modules required for testing. __*Optional*__
* **cdkVersionPinning** (boolean) Use pinned version instead of caret version for CDK. __*Optional*__
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
* **dependencyType** ([DependencyType](#projen-dependencytype)) The type of dependency to use for runtime AWS CDK and `constructs` modules.
### Properties
Name | Type | Description
-----|------|-------------
**cdkDependenciesAsDeps**â ïž | boolean | Whether CDK dependencies are added as normal dependencies (and peer dependencies).
**cdkMajorVersion**ð¹ | number | The major version of the AWS CDK (e.g. 1, 2, ...).
**cdkMinimumVersion**ð¹ | string | The minimum version of the AWS CDK (e.g. `2.0.0`).
**cdkVersion**ð¹ | string | The dependency requirement for AWS CDK (e.g. `^2.0.0`).
### Methods
#### addV1Dependencies(...deps)ð¹
Adds dependencies to AWS CDK modules.
The type of dependency is determined by the `dependencyType` option.
This method is not supported in CDK v2. Use `project.addPeerDeps()` or
`project.addDeps()` as appropriate.
```ts
addV1Dependencies(...deps: string[]): void
```
* **deps** (string) names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
#### addV1DevDependencies(...deps)ð¹
Adds AWS CDK modules as dev dependencies.
This method is not supported in CDK v2. Use `project.addPeerDeps()` or
`project.addDeps()` as appropriate.
```ts
addV1DevDependencies(...deps: string[]): void
```
* **deps** (string) fully qualified names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
#### preSynthesize()ð¹
Called before synthesis.
```ts
preSynthesize(): void
```
#### protected packageNames()ð¹
Return a configuration object with information about package naming in various languages.
```ts
protected packageNames(): AwsCdkPackageNames
```
__Returns__:
* [awscdk.AwsCdkPackageNames](#projen-awscdk-awscdkpackagenames)
## class AwsCdkDepsJava ð¹
Manages dependencies on the AWS CDK for Java projects.
__Submodule__: awscdk
__Extends__: [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)
### Initializer
```ts
new awscdk.AwsCdkDepsJava(project: Project, options: AwsCdkDepsOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.AwsCdkDepsOptions](#projen-awscdk-awscdkdepsoptions)) *No description*
* **cdkVersion** (string) Minimum version of the AWS CDK to depend on.
* **cdkAssert** (boolean) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
* **cdkAssertions** (boolean) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
* **cdkDependencies** (Array) Which AWS CDKv1 modules this project requires. __*Optional*__
* **cdkDependenciesAsDeps** (boolean) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
* **cdkTestDependencies** (Array) AWS CDK modules required for testing. __*Optional*__
* **cdkVersionPinning** (boolean) Use pinned version instead of caret version for CDK. __*Optional*__
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
* **dependencyType** ([DependencyType](#projen-dependencytype)) The type of dependency to use for runtime AWS CDK and `constructs` modules.
### Methods
#### protected packageNames()ð¹
Return a configuration object with information about package naming in various languages.
```ts
protected packageNames(): AwsCdkPackageNames
```
__Returns__:
* [awscdk.AwsCdkPackageNames](#projen-awscdk-awscdkpackagenames)
## class AwsCdkDepsJs ð¹
Manages dependencies on the AWS CDK for Node.js projects.
__Submodule__: awscdk
__Extends__: [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)
### Initializer
```ts
new awscdk.AwsCdkDepsJs(project: Project, options: AwsCdkDepsOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.AwsCdkDepsOptions](#projen-awscdk-awscdkdepsoptions)) *No description*
* **cdkVersion** (string) Minimum version of the AWS CDK to depend on.
* **cdkAssert** (boolean) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
* **cdkAssertions** (boolean) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
* **cdkDependencies** (Array) Which AWS CDKv1 modules this project requires. __*Optional*__
* **cdkDependenciesAsDeps** (boolean) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
* **cdkTestDependencies** (Array) AWS CDK modules required for testing. __*Optional*__
* **cdkVersionPinning** (boolean) Use pinned version instead of caret version for CDK. __*Optional*__
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
* **dependencyType** ([DependencyType](#projen-dependencytype)) The type of dependency to use for runtime AWS CDK and `constructs` modules.
### Methods
#### protected packageNames()ð¹
Return a configuration object with information about package naming in various languages.
```ts
protected packageNames(): AwsCdkPackageNames
```
__Returns__:
* [awscdk.AwsCdkPackageNames](#projen-awscdk-awscdkpackagenames)
## class AwsCdkDepsPy ð¹
Manages dependencies on the AWS CDK for Python projects.
__Submodule__: awscdk
__Extends__: [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)
### Initializer
```ts
new awscdk.AwsCdkDepsPy(project: Project, options: AwsCdkDepsOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.AwsCdkDepsOptions](#projen-awscdk-awscdkdepsoptions)) *No description*
* **cdkVersion** (string) Minimum version of the AWS CDK to depend on.
* **cdkAssert** (boolean) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
* **cdkAssertions** (boolean) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
* **cdkDependencies** (Array) Which AWS CDKv1 modules this project requires. __*Optional*__
* **cdkDependenciesAsDeps** (boolean) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
* **cdkTestDependencies** (Array) AWS CDK modules required for testing. __*Optional*__
* **cdkVersionPinning** (boolean) Use pinned version instead of caret version for CDK. __*Optional*__
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
* **dependencyType** ([DependencyType](#projen-dependencytype)) The type of dependency to use for runtime AWS CDK and `constructs` modules.
### Methods
#### protected packageNames()ð¹
Return a configuration object with information about package naming in various languages.
```ts
protected packageNames(): AwsCdkPackageNames
```
__Returns__:
* [awscdk.AwsCdkPackageNames](#projen-awscdk-awscdkpackagenames)
## class AwsCdkJavaApp ð¹
AWS CDK app in Java.
__Submodule__: awscdk
__Extends__: [java.JavaProject](#projen-java-javaproject)
### Initializer
```ts
new awscdk.AwsCdkJavaApp(options: AwsCdkJavaAppOptions)
```
* **options** ([awscdk.AwsCdkJavaAppOptions](#projen-awscdk-awscdkjavaappoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **artifactId** (string) The artifactId is generally the name that the project is known by.
* **groupId** (string) This is generally unique amongst an organization or a project.
* **version** (string) This is the last piece of the naming puzzle.
* **description** (string) Description of a project is always good. __*Default*__: undefined
* **packaging** (string) Project packaging format. __*Default*__: "jar"
* **url** (string) The URL, like the name, is not required. __*Default*__: undefined
* **compileOptions** ([java.MavenCompileOptions](#projen-java-mavencompileoptions)) Compile options. __*Default*__: defaults
* **deps** (Array) List of runtime dependencies for this project. __*Default*__: []
* **distdir** (string) Final artifact output directory. __*Default*__: "dist/java"
* **junit** (boolean) Include junit tests. __*Default*__: true
* **junitOptions** ([java.JunitOptions](#projen-java-junitoptions)) junit options. __*Default*__: defaults
* **packagingOptions** ([java.MavenPackagingOptions](#projen-java-mavenpackagingoptions)) Packaging options. __*Default*__: defaults
* **projenrcJava** (boolean) Use projenrc in java. __*Default*__: true
* **projenrcJavaOptions** ([java.ProjenrcOptions](#projen-java-projenrcoptions)) Options related to projenrc in java. __*Default*__: default options
* **testDeps** (Array) List of test dependencies for this project. __*Default*__: []
* **sample** (boolean) Include sample code and test if the relevant directories don't exist. __*Default*__: true
* **sampleJavaPackage** (string) The java package to use for the code sample. __*Default*__: "org.acme"
* **buildCommand** (string) A command to execute before synthesis. __*Default*__: no build command
* **cdkout** (string) cdk.out directory. __*Default*__: "cdk.out"
* **context** (Map) Additional context to include in `cdk.json`. __*Default*__: no additional context
* **featureFlags** (boolean) Include all feature flags in cdk.json. __*Default*__: true
* **requireApproval** ([awscdk.ApprovalLevel](#projen-awscdk-approvallevel)) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. __*Default*__: ApprovalLevel.BROADENING
* **watchExcludes** (Array) Glob patterns to exclude from `cdk watch`. __*Default*__: []
* **watchIncludes** (Array) Glob patterns to include in `cdk watch`. __*Default*__: []
* **cdkVersion** (string) Minimum version of the AWS CDK to depend on.
* **cdkAssert** (boolean) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
* **cdkAssertions** (boolean) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
* **cdkDependencies** (Array) Which AWS CDKv1 modules this project requires. __*Optional*__
* **cdkDependenciesAsDeps** (boolean) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
* **cdkTestDependencies** (Array) AWS CDK modules required for testing. __*Optional*__
* **cdkVersionPinning** (boolean) Use pinned version instead of caret version for CDK. __*Optional*__
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
* **mainClass** (string) The name of the Java class with the static `main()` method.
### Properties
Name | Type | Description
-----|------|-------------
**cdkConfig**ð¹ | [awscdk.CdkConfig](#projen-awscdk-cdkconfig) | The `cdk.json` file.
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) | CDK dependency management helper class.
**cdkTasks**ð¹ | [awscdk.CdkTasks](#projen-awscdk-cdktasks) | CDK tasks.
**mainClass**ð¹ | string | The full name of the main class of the java app (package.Class).
**mainClassName**ð¹ | string | The name of the Java class with the static `main()` method.
**mainPackage**ð¹ | string | The name of the Java package that includes the main class.
### Methods
#### addCdkDependency(...modules)â ïž
Adds an AWS CDK module dependencies.
```ts
addCdkDependency(...modules: string[]): void
```
* **modules** (string) The list of modules to depend on (e.g. "software.amazon.awscdk/aws-lambda", "software.amazon.awscdk/aws-iam", etc).
## class AwsCdkPythonApp ð¹
AWS CDK app in Python.
__Submodule__: awscdk
__Extends__: [python.PythonProject](#projen-python-pythonproject)
### Initializer
```ts
new awscdk.AwsCdkPythonApp(options: AwsCdkPythonAppOptions)
```
* **options** ([awscdk.AwsCdkPythonAppOptions](#projen-awscdk-awscdkpythonappoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **authorEmail** (string) Author's e-mail.
* **authorName** (string) Author's name.
* **version** (string) Version of the package.
* **classifiers** (Array) A list of PyPI trove classifiers that describe the project. __*Optional*__
* **description** (string) A short description of the package. __*Optional*__
* **homepage** (string) A URL to the website of the project. __*Optional*__
* **license** (string) License of this package as an SPDX identifier. __*Optional*__
* **packageName** (string) Package name. __*Optional*__
* **poetryOptions** ([python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)) Additional options to set for poetry if using poetry. __*Optional*__
* **setupConfig** (Map) Additional fields to pass in the setup() function if using setuptools. __*Optional*__
* **moduleName** (string) Name of the python package as used in imports and filenames.
* **deps** (Array) List of runtime dependencies for this project. __*Default*__: []
* **devDeps** (Array) List of dev dependencies for this project. __*Default*__: []
* **pip** (boolean) Use pip with a requirements.txt file to track project dependencies. __*Default*__: true, unless poetry is true, then false
* **poetry** (boolean) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. __*Default*__: false
* **projenrcJs** (boolean) Use projenrc in javascript. __*Default*__: false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options related to projenrc in JavaScript. __*Default*__: default options
* **projenrcPython** (boolean) Use projenrc in Python. __*Default*__: true
* **projenrcPythonOptions** ([python.ProjenrcOptions](#projen-python-projenrcoptions)) Options related to projenrc in python. __*Default*__: default options
* **projenrcTs** (boolean) Use projenrc in TypeScript. __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcTsOptions](#projen-typescript-projenrctsoptions)) Options related to projenrc in TypeScript. __*Default*__: default options
* **pytest** (boolean) Include pytest tests. __*Default*__: true
* **pytestOptions** ([python.PytestOptions](#projen-python-pytestoptions)) pytest options. __*Default*__: defaults
* **pythonExec** (string) Path to the python executable to use. __*Default*__: "python"
* **sample** (boolean) Include sample code and test if the relevant directories don't exist. __*Default*__: true
* **setuptools** (boolean) Use setuptools with a setup.py script for packaging and publishing. __*Default*__: true, unless poetry is true, then false
* **venv** (boolean) Use venv to manage a virtual environment for installing dependencies inside. __*Default*__: true, unless poetry is true, then false
* **venvOptions** ([python.VenvOptions](#projen-python-venvoptions)) Venv options. __*Default*__: defaults
* **buildCommand** (string) A command to execute before synthesis. __*Default*__: no build command
* **cdkout** (string) cdk.out directory. __*Default*__: "cdk.out"
* **context** (Map) Additional context to include in `cdk.json`. __*Default*__: no additional context
* **featureFlags** (boolean) Include all feature flags in cdk.json. __*Default*__: true
* **requireApproval** ([awscdk.ApprovalLevel](#projen-awscdk-approvallevel)) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. __*Default*__: ApprovalLevel.BROADENING
* **watchExcludes** (Array) Glob patterns to exclude from `cdk watch`. __*Default*__: []
* **watchIncludes** (Array) Glob patterns to include in `cdk watch`. __*Default*__: []
* **cdkVersion** (string) Minimum version of the AWS CDK to depend on.
* **cdkAssert** (boolean) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
* **cdkAssertions** (boolean) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
* **cdkDependencies** (Array) Which AWS CDKv1 modules this project requires. __*Optional*__
* **cdkDependenciesAsDeps** (boolean) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
* **cdkTestDependencies** (Array) AWS CDK modules required for testing. __*Optional*__
* **cdkVersionPinning** (boolean) Use pinned version instead of caret version for CDK. __*Optional*__
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
* **appEntrypoint** (string) The CDK app's entrypoint (relative to the source directory, which is "src" by default). __*Default*__: "app.py"
* **testdir** (string) Python sources directory. __*Default*__: "tests"
### Properties
Name | Type | Description
-----|------|-------------
**appEntrypoint**ð¹ | string | The CDK app entrypoint.
**cdkConfig**ð¹ | [awscdk.CdkConfig](#projen-awscdk-cdkconfig) | cdk.json configuration.
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) |
**cdkTasks**ð¹ | [awscdk.CdkTasks](#projen-awscdk-cdktasks) | Common CDK tasks.
**cdkVersion**ð¹ | string | The CDK version this app is using.
**testdir**ð¹ | string | The directory in which the python tests reside.
## class AwsCdkTypeScriptApp ð¹
AWS CDK app in TypeScript.
__Submodule__: awscdk
__Extends__: [typescript.TypeScriptAppProject](#projen-typescript-typescriptappproject)
### Initializer
```ts
new awscdk.AwsCdkTypeScriptApp(options: AwsCdkTypeScriptAppOptions)
```
* **options** ([awscdk.AwsCdkTypeScriptAppOptions](#projen-awscdk-awscdktypescriptappoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
* **buildCommand** (string) A command to execute before synthesis. __*Default*__: no build command
* **cdkout** (string) cdk.out directory. __*Default*__: "cdk.out"
* **context** (Map) Additional context to include in `cdk.json`. __*Default*__: no additional context
* **featureFlags** (boolean) Include all feature flags in cdk.json. __*Default*__: true
* **requireApproval** ([awscdk.ApprovalLevel](#projen-awscdk-approvallevel)) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. __*Default*__: ApprovalLevel.BROADENING
* **watchExcludes** (Array) Glob patterns to exclude from `cdk watch`. __*Default*__: []
* **watchIncludes** (Array) Glob patterns to include in `cdk watch`. __*Default*__: []
* **cdkVersion** (string) Minimum version of the AWS CDK to depend on.
* **cdkAssert** (boolean) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
* **cdkAssertions** (boolean) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
* **cdkDependencies** (Array) Which AWS CDKv1 modules this project requires. __*Optional*__
* **cdkDependenciesAsDeps** (boolean) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
* **cdkTestDependencies** (Array) AWS CDK modules required for testing. __*Optional*__
* **cdkVersionPinning** (boolean) Use pinned version instead of caret version for CDK. __*Optional*__
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
* **appEntrypoint** (string) The CDK app's entrypoint (relative to the source directory, which is "src" by default). __*Default*__: "main.ts"
* **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. __*Default*__: true
* **integrationTestAutoDiscover** (boolean) Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. __*Default*__: true
* **lambdaAutoDiscover** (boolean) Automatically adds an `awscdk.LambdaFunction` for each `.lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. __*Default*__: true
* **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. __*Default*__: true
* **lambdaOptions** ([awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)) Common options for all AWS Lambda functions. __*Default*__: default options
### Properties
Name | Type | Description
-----|------|-------------
**appEntrypoint**ð¹ | string | The CDK app entrypoint.
**cdkConfig**ð¹ | [awscdk.CdkConfig](#projen-awscdk-cdkconfig) | cdk.json configuration.
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) |
**cdkTasks**ð¹ | [awscdk.CdkTasks](#projen-awscdk-cdktasks) | Common CDK tasks.
**cdkVersion**ð¹ | string | The CDK version this app is using.
### Methods
#### addCdkDependency(...modules)ð¹
Adds an AWS CDK module dependencies.
```ts
addCdkDependency(...modules: string[]): void
```
* **modules** (string) The list of modules to depend on.
## class CdkConfig ð¹
Represents cdk.json file.
__Submodule__: awscdk
__Extends__: [Component](#projen-component)
### Initializer
```ts
new awscdk.CdkConfig(project: Project, options: CdkConfigOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.CdkConfigOptions](#projen-awscdk-cdkconfigoptions)) *No description*
* **buildCommand** (string) A command to execute before synthesis. __*Default*__: no build command
* **cdkout** (string) cdk.out directory. __*Default*__: "cdk.out"
* **context** (Map) Additional context to include in `cdk.json`. __*Default*__: no additional context
* **featureFlags** (boolean) Include all feature flags in cdk.json. __*Default*__: true
* **requireApproval** ([awscdk.ApprovalLevel](#projen-awscdk-approvallevel)) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. __*Default*__: ApprovalLevel.BROADENING
* **watchExcludes** (Array) Glob patterns to exclude from `cdk watch`. __*Default*__: []
* **watchIncludes** (Array) Glob patterns to include in `cdk watch`. __*Default*__: []
* **app** (string) The command line to execute in order to synthesize the CDK application (language specific).
### Properties
Name | Type | Description
-----|------|-------------
**cdkout**ð¹ | string | Name of the cdk.out directory.
**exclude**ð¹ | Array | List of glob patterns to be excluded by CDK.
**include**ð¹ | Array | List of glob patterns to be included by CDK.
**json**ð¹ | [JsonFile](#projen-jsonfile) | Represents the JSON file.
### Methods
#### addExcludes(...patterns)ð¹
Add excludes to `cdk.json`.
```ts
addExcludes(...patterns: string[]): void
```
* **patterns** (string) The excludes to add.
#### addIncludes(...patterns)ð¹
Add includes to `cdk.json`.
```ts
addIncludes(...patterns: string[]): void
```
* **patterns** (string) The includes to add.
## class CdkTasks ð¹
Adds standard AWS CDK tasks to your project.
__Submodule__: awscdk
__Extends__: [Component](#projen-component)
### Initializer
```ts
new awscdk.CdkTasks(project: Project)
```
* **project** ([Project](#projen-project)) *No description*
### Properties
Name | Type | Description
-----|------|-------------
**deploy**ð¹ | [Task](#projen-task) | Deploys your app.
**destroy**ð¹ | [Task](#projen-task) | Destroys all the stacks.
**diff**ð¹ | [Task](#projen-task) | Diff against production.
**synth**ð¹ | [Task](#projen-task) | Synthesizes your app.
**synthSilent**ð¹ | [Task](#projen-task) | Synthesizes your app and suppresses stdout.
**watch**ð¹ | [Task](#projen-task) | Watch task.
## class ConstructLibraryAws â ïž
__Submodule__: awscdk
__Extends__: [awscdk.AwsCdkConstructLibrary](#projen-awscdk-awscdkconstructlibrary)
### Initializer
```ts
new awscdk.ConstructLibraryAws(options: AwsCdkConstructLibraryOptions)
```
* **options** ([awscdk.AwsCdkConstructLibraryOptions](#projen-awscdk-awscdkconstructlibraryoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
* **author** (string) The name of the library author.
* **authorAddress** (string) Email or URL of the library author.
* **repositoryUrl** (string) Git repository URL.
* **compat** (boolean) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
* **compatIgnore** (string) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
* **compressAssembly** (boolean) Emit a compressed version of the assembly. __*Default*__: false
* **docgenFilePath** (string) File path for generated docs. __*Default*__: "API.md"
* **dotnet** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) *No description* __*Optional*__
* **excludeTypescript** (Array) Accepts a list of glob patterns. __*Optional*__
* **jsiiVersion** (string) Version of the jsii compiler to use. __*Default*__: "1.x"
* **publishToGo** ([cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)) Publish Go bindings to a git repository. __*Default*__: no publishing
* **publishToMaven** ([cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)) Publish to maven. __*Default*__: no publishing
* **publishToNuget** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) Publish to NuGet. __*Default*__: no publishing
* **publishToPypi** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) Publish to pypi. __*Default*__: no publishing
* **python** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) *No description* __*Optional*__
* **rootdir** (string) *No description* __*Default*__: "."
* **catalog** ([cdk.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:. __*Default*__: new version will be announced
* **cdkVersion** (string) Minimum version of the AWS CDK to depend on.
* **cdkAssert** (boolean) Warning: NodeJS only. __*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
* **cdkAssertions** (boolean) Install the assertions library? __*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
* **cdkDependencies** (Array) Which AWS CDKv1 modules this project requires. __*Optional*__
* **cdkDependenciesAsDeps** (boolean) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). __*Default*__: true
* **cdkTestDependencies** (Array) AWS CDK modules required for testing. __*Optional*__
* **cdkVersionPinning** (boolean) Use pinned version instead of caret version for CDK. __*Optional*__
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
* **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. __*Default*__: true
* **integrationTestAutoDiscover** (boolean) Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. __*Default*__: true
* **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. __*Default*__: true
* **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. __*Default*__: true
* **lambdaOptions** ([awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)) Common options for all AWS Lambda functions. __*Default*__: default options
## class EdgeLambdaAutoDiscover ð¹
Creates edge lambdas from entry points discovered in the project's source tree.
__Submodule__: awscdk
__Extends__: [cdk.AutoDiscoverBase](#projen-cdk-autodiscoverbase)
### Initializer
```ts
new awscdk.EdgeLambdaAutoDiscover(project: Project, options: EdgeLambdaAutoDiscoverOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.EdgeLambdaAutoDiscoverOptions](#projen-awscdk-edgelambdaautodiscoveroptions)) *No description*
* **cdkDeps** ([awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)) AWS CDK dependency manager.
* **tsconfigPath** (string) Path to the tsconfig file to use for integration tests.
* **srcdir** (string) Project source tree (relative to project output directory).
* **lambdaOptions** ([awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)) Options for AWS Lambda functions. __*Optional*__
## class IntegrationTest ð¹
Cloud integration tests.
__Submodule__: awscdk
__Extends__: [cdk.IntegrationTestBase](#projen-cdk-integrationtestbase)
### Initializer
```ts
new awscdk.IntegrationTest(project: Project, options: IntegrationTestOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.IntegrationTestOptions](#projen-awscdk-integrationtestoptions)) *No description*
* **destroyAfterDeploy** (boolean) Destroy the test app after a successful deployment. __*Default*__: true
* **pathMetadata** (boolean) Enables path metadata, adding `aws:cdk:path`, with the defining construct's path, to the CloudFormation metadata for each synthesized resource. __*Default*__: false
* **entrypoint** (string) A path from the project root directory to a TypeScript file which contains the integration test app.
* **tsconfigPath** (string) The path of the tsconfig.json file to use when running integration test cdk apps.
* **name** (string) Name of the integration test. __*Default*__: Derived from the entrypoint filename.
* **cdkDeps** ([awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)) AWS CDK dependency manager.
* **stacks** (Array) A list of stacks within the integration test to deploy/destroy. __*Default*__: ["**"]
### Properties
Name | Type | Description
-----|------|-------------
**destroyTask**ð¹ | [Task](#projen-task) | Destroy the integration test resources.
**watchTask**ð¹ | [Task](#projen-task) | The watch task.
## class IntegrationTestAutoDiscover ð¹
Creates integration tests from entry points discovered in the test tree.
__Submodule__: awscdk
__Extends__: [cdk.IntegrationTestAutoDiscoverBase](#projen-cdk-integrationtestautodiscoverbase)
### Initializer
```ts
new awscdk.IntegrationTestAutoDiscover(project: Project, options: IntegrationTestAutoDiscoverOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.IntegrationTestAutoDiscoverOptions](#projen-awscdk-integrationtestautodiscoveroptions)) *No description*
* **cdkDeps** ([awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)) AWS CDK dependency manager.
* **tsconfigPath** (string) Path to the tsconfig file to use for integration tests.
* **testdir** (string) Test source tree.
* **integrationTestOptions** ([awscdk.IntegrationTestCommonOptions](#projen-awscdk-integrationtestcommonoptions)) Options for integration tests. __*Optional*__
## class LambdaAutoDiscover ð¹
Creates lambdas from entry points discovered in the project's source tree.
__Submodule__: awscdk
__Extends__: [cdk.AutoDiscoverBase](#projen-cdk-autodiscoverbase)
### Initializer
```ts
new awscdk.LambdaAutoDiscover(project: Project, options: LambdaAutoDiscoverOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.LambdaAutoDiscoverOptions](#projen-awscdk-lambdaautodiscoveroptions)) *No description*
* **cdkDeps** ([awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)) AWS CDK dependency manager.
* **tsconfigPath** (string) Path to the tsconfig file to use for integration tests.
* **srcdir** (string) Project source tree (relative to project output directory).
* **lambdaOptions** ([awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions)) Options for AWS Lambda functions. __*Optional*__
## class LambdaExtension ð¹
Create a Lambda Extension.
__Submodule__: awscdk
__Extends__: [Component](#projen-component)
### Initializer
```ts
new awscdk.LambdaExtension(project: Project, options: LambdaExtensionOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.LambdaExtensionOptions](#projen-awscdk-lambdaextensionoptions)) *No description*
* **bundlingOptions** ([javascript.BundlingOptions](#projen-javascript-bundlingoptions)) Bundling options for this AWS Lambda extension. __*Default*__: defaults
* **compatibleRuntimes** (Array<[awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime)>) The extension's compatible runtimes. __*Optional*__
* **cdkDeps** ([awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)) AWS CDK dependency manager.
* **entrypoint** (string) A path from the project root directory to a TypeScript file which contains the AWS Lambda extension entrypoint (stand-alone script).
* **constructFile** (string) The name of the generated TypeScript source file. __*Default*__: The name of the entrypoint file, with the `-layer-version.ts` suffix instead of `.lambda-extension.ts`.
* **constructName** (string) The name of the generated `lambda.LayerVersion` subclass. __*Default*__: A pascal cased version of the name of the entrypoint file, with the extension `LayerVersion` (e.g. `AppConfigLayerVersion`).
* **name** (string) Name of the extension. __*Default*__: Derived from the entrypoint filename.
## class LambdaExtensionAutoDiscover ð¹
Creates Lambda Extensions from entrypoints discovered in the project's source tree.
__Submodule__: awscdk
__Extends__: [cdk.AutoDiscoverBase](#projen-cdk-autodiscoverbase)
### Initializer
```ts
new awscdk.LambdaExtensionAutoDiscover(project: Project, options: LambdaExtensionAutoDiscoverOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([awscdk.LambdaExtensionAutoDiscoverOptions](#projen-awscdk-lambdaextensionautodiscoveroptions)) *No description*
* **cdkDeps** ([awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)) AWS CDK dependency manager.
* **tsconfigPath** (string) Path to the tsconfig file to use for integration tests.
* **srcdir** (string) Project source tree (relative to project output directory).
* **lambdaExtensionOptions** ([awscdk.LambdaExtensionCommonOptions](#projen-awscdk-lambdaextensioncommonoptions)) Options for lambda extensions. __*Optional*__
## class LambdaFunction ð¹
Generates a pre-bundled AWS Lambda function construct from handler code.
To use this, create an AWS Lambda handler file under your source tree with
the `.lambda.ts` extension and add a `LambdaFunction` component to your
typescript project pointing to this entrypoint.
This will add a task to your "compile" step which will use `esbuild` to
bundle the handler code into the build directory. It will also generate a
file `src/foo-function.ts` with a custom AWS construct called `FooFunction`
which extends `@aws-cdk/aws-lambda.Function` which is bound to the bundled
handle through an asset.
__Submodule__: awscdk
__Extends__: [Component](#projen-component)
### Initializer
Defines a pre-bundled AWS Lambda function construct from handler code.
```ts
new awscdk.LambdaFunction(project: Project, options: LambdaFunctionOptions)
```
* **project** ([Project](#projen-project)) The project to use.
* **options** ([awscdk.LambdaFunctionOptions](#projen-awscdk-lambdafunctionoptions)) Options.
* **awsSdkConnectionReuse** (boolean) Whether to automatically reuse TCP connections when working with the AWS SDK for JavaScript. __*Default*__: true
* **bundlingOptions** ([javascript.BundlingOptions](#projen-javascript-bundlingoptions)) Bundling options for this AWS Lambda function. __*Default*__: defaults
* **edgeLambda** (boolean) Whether to create a `cloudfront.experimental.EdgeFunction` instead of a `lambda.Function`. __*Default*__: false
* **runtime** ([awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime)) The node.js version to target. __*Default*__: Runtime.NODEJS_16_X
* **cdkDeps** ([awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps)) AWS CDK dependency manager.
* **entrypoint** (string) A path from the project root directory to a TypeScript file which contains the AWS Lambda handler entrypoint (exports a `handler` function).
* **constructFile** (string) The name of the generated TypeScript source file. __*Default*__: The name of the entrypoint file, with the `-function.ts` suffix instead of `.lambda.ts`.
* **constructName** (string) The name of the generated `lambda.Function` subclass. __*Default*__: A pascal cased version of the name of the entrypoint file, with the extension `Function` (e.g. `ResizeImageFunction`).
## class LambdaRuntime ð¹
The runtime for the AWS Lambda function.
__Submodule__: awscdk
### Initializer
```ts
new awscdk.LambdaRuntime(functionRuntime: string, esbuildTarget: string, options?: LambdaRuntimeOptions)
```
* **functionRuntime** (string) The Node.js runtime to use.
* **esbuildTarget** (string) The esbuild setting to use.
* **options** ([awscdk.LambdaRuntimeOptions](#projen-awscdk-lambdaruntimeoptions)) Options for this runtime.
* **defaultExternals** (Array) Packages that are considered externals by default when bundling. __*Default*__: ['@aws-sdk/*']
### Properties
Name | Type | Description
-----|------|-------------
**defaultExternals**ð¹ | Array |
**esbuildPlatform**ð¹ | string |
**esbuildTarget**ð¹ | string | The esbuild setting to use.
**functionRuntime**ð¹ | string | The Node.js runtime to use.
*static* **NODEJS_10_X**â ïž | [awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime) | Node.js 10.x.
*static* **NODEJS_12_X**â ïž | [awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime) | Node.js 12.x.
*static* **NODEJS_14_X**â ïž | [awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime) | Node.js 14.x.
*static* **NODEJS_16_X**ð¹ | [awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime) | Node.js 16.x.
*static* **NODEJS_18_X**ð¹ | [awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime) | Node.js 18.x.
## class BuildWorkflow ð¹
__Submodule__: build
__Extends__: [Component](#projen-component)
### Initializer
```ts
new build.BuildWorkflow(project: Project, options: BuildWorkflowOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([build.BuildWorkflowOptions](#projen-build-buildworkflowoptions)) *No description*
* **artifactsDirectory** (string) A name of a directory that includes build artifacts.
* **buildTask** ([Task](#projen-task)) The task to execute in order to build the project.
* **containerImage** (string) The container image to use for builds. __*Default*__: the default workflow container
* **env** (Map) Build environment variables. __*Default*__: {}
* **gitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) Git identity to use for the workflow. __*Default*__: default identity
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **name** (string) Name of the buildfile (e.g. "build" becomes "build.yml"). __*Default*__: "build"
* **permissions** ([github.workflows.JobPermissions](#projen-github-workflows-jobpermissions)) Permissions granted to the build job To limit job permissions for `contents`, the desired permissions have to be explicitly set, e.g.: `{ contents: JobPermission.NONE }`. __*Default*__: `{ contents: JobPermission.WRITE }`
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build. __*Default*__: []
* **preBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute before the build. __*Default*__: []
* **runsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **workflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
### Properties
Name | Type | Description
-----|------|-------------
**buildJobIds**ð¹ | Array | Returns a list of job IDs that are part of the build.
### Methods
#### addPostBuildJob(id, job)ð¹
Adds another job to the build workflow which is executed after the build job succeeded.
Jobs are executed _only_ if the build did NOT self mutate. If the build
self-mutate, the branch will either be updated or the build will fail (in
forks), so there is no point in executing the post-build job.
```ts
addPostBuildJob(id: string, job: Job): void
```
* **id** (string) The id of the new job.
* **job** ([github.workflows.Job](#projen-github-workflows-job)) The job specification.
* **permissions** ([github.workflows.JobPermissions](#projen-github-workflows-jobpermissions)) You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access.
* **concurrency** (any) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. __*Optional*__
* **if** (string) You can use the if conditional to prevent a job from running unless a condition is met. __*Optional*__
* **name** (string) The name of the job displayed on GitHub. __*Optional*__
* **needs** (Array) Identifies any jobs that must complete successfully before this job will run. __*Optional*__
* **strategy** ([github.workflows.JobStrategy](#projen-github-workflows-jobstrategy)) A strategy creates a build matrix for your jobs. __*Optional*__
* **runsOn** (Array) The type of machine to run the job on.
* **steps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A job contains a sequence of tasks called steps.
* **container** ([github.workflows.ContainerOptions](#projen-github-workflows-containeroptions)) A container to run any steps in a job that don't already specify a container. __*Optional*__
* **continueOnError** (boolean) Prevents a workflow run from failing when a job fails. __*Optional*__
* **defaults** ([github.workflows.JobDefaults](#projen-github-workflows-jobdefaults)) A map of default settings that will apply to all steps in the job. __*Optional*__
* **env** (Map) A map of environment variables that are available to all steps in the job. __*Optional*__
* **environment** (any) The environment that the job references. __*Optional*__
* **outputs** (Map) A map of outputs for a job. __*Optional*__
* **services** (Map) Used to host service containers for a job in a workflow. __*Optional*__
* **timeoutMinutes** (number) The maximum number of minutes to let a job run before GitHub automatically cancels it. __*Default*__: 360
* **tools** ([github.workflows.Tools](#projen-github-workflows-tools)) Tools required for this job. __*Optional*__
#### addPostBuildJobCommands(id, commands, options?)ð¹
Run a sequence of commands as a job within the build workflow which is executed after the build job succeeded.
Jobs are executed _only_ if the build did NOT self mutate. If the build
self-mutate, the branch will either be updated or the build will fail (in
forks), so there is no point in executing the post-build job.
```ts
addPostBuildJobCommands(id: string, commands: Array, options?: AddPostBuildJobCommandsOptions): void
```
* **id** (string) *No description*
* **commands** (Array) *No description*
* **options** ([build.AddPostBuildJobCommandsOptions](#projen-build-addpostbuildjobcommandsoptions)) Specify tools and other options.
* **checkoutRepo** (boolean) Check out the repository at the pull request branch before commands are run. __*Default*__: false
* **installDeps** (boolean) Install project dependencies before running commands. `checkoutRepo` must also be set to true. __*Default*__: false
* **runsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **tools** ([github.workflows.Tools](#projen-github-workflows-tools)) Tools that should be installed before the commands are run. __*Optional*__
#### addPostBuildJobTask(task, options?)ð¹
Run a task as a job within the build workflow which is executed after the build job succeeded.
The job will have access to build artifacts and will install project
dependencies in order to be able to run any commands used in the tasks.
Jobs are executed _only_ if the build did NOT self mutate. If the build
self-mutate, the branch will either be updated or the build will fail (in
forks), so there is no point in executing the post-build job.
```ts
addPostBuildJobTask(task: Task, options?: AddPostBuildJobTaskOptions): void
```
* **task** ([Task](#projen-task)) *No description*
* **options** ([build.AddPostBuildJobTaskOptions](#projen-build-addpostbuildjobtaskoptions)) Specify tools and other options.
* **runsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **tools** ([github.workflows.Tools](#projen-github-workflows-tools)) Tools that should be installed before the task is run. __*Optional*__
#### addPostBuildSteps(...steps)ð¹
Adds steps that are executed after the build.
```ts
addPostBuildSteps(...steps: JobStep[]): void
```
* **steps** ([github.workflows.JobStep](#projen-github-workflows-jobstep)) The job steps.
* **env** (Map) Sets environment variables for steps to use in the runner environment. __*Optional*__
* **id** (string) A unique identifier for the step. __*Optional*__
* **if** (string) You can use the if conditional to prevent a job from running unless a condition is met. __*Optional*__
* **name** (string) A name for your step to display on GitHub. __*Optional*__
* **run** (string) Runs command-line programs using the operating system's shell. __*Optional*__
* **uses** (string) Selects an action to run as part of a step in your job. __*Optional*__
* **with** (Map) A map of the input parameters defined by the action. __*Optional*__
* **workingDirectory** (string) Specifies a working directory for a step. __*Optional*__
* **continueOnError** (boolean) Prevents a job from failing when a step fails. __*Optional*__
* **timeoutMinutes** (number) The maximum number of minutes to run the step before killing the process. __*Optional*__
## class AutoDiscoverBase ð¹
Base class for auto-discovering and creating project subcomponents.
__Submodule__: cdk
__Extends__: [Component](#projen-component)
__Implemented by__: [awscdk.EdgeLambdaAutoDiscover](#projen-awscdk-edgelambdaautodiscover), [awscdk.IntegrationTestAutoDiscover](#projen-awscdk-integrationtestautodiscover), [awscdk.LambdaAutoDiscover](#projen-awscdk-lambdaautodiscover), [awscdk.LambdaExtensionAutoDiscover](#projen-awscdk-lambdaextensionautodiscover), [cdk.IntegrationTestAutoDiscoverBase](#projen-cdk-integrationtestautodiscoverbase), [cdk8s.IntegrationTestAutoDiscover](#projen-cdk8s-integrationtestautodiscover)
### Initializer
```ts
new cdk.AutoDiscoverBase(project: Project, options: AutoDiscoverBaseOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([cdk.AutoDiscoverBaseOptions](#projen-cdk-autodiscoverbaseoptions)) *No description*
* **extension** (string) Locate files with the given extension.
* **projectdir** (string) Locate entrypoints in the given project directory.
### Properties
Name | Type | Description
-----|------|-------------
**entrypoints**ð¹ | Array | Auto-discovered entry points with paths relative to the project directory.
## class ConstructLibrary ð¹
A multi-language library for CDK constructs.
__Submodule__: cdk
__Extends__: [cdk.JsiiProject](#projen-cdk-jsiiproject)
__Implemented by__: [awscdk.AwsCdkConstructLibrary](#projen-awscdk-awscdkconstructlibrary), [awscdk.ConstructLibraryAws](#projen-awscdk-constructlibraryaws), [cdk8s.ConstructLibraryCdk8s](#projen-cdk8s-constructlibrarycdk8s), [cdktf.ConstructLibraryCdktf](#projen-cdktf-constructlibrarycdktf)
### Initializer
```ts
new cdk.ConstructLibrary(options: ConstructLibraryOptions)
```
* **options** ([cdk.ConstructLibraryOptions](#projen-cdk-constructlibraryoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
* **author** (string) The name of the library author.
* **authorAddress** (string) Email or URL of the library author.
* **repositoryUrl** (string) Git repository URL.
* **compat** (boolean) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
* **compatIgnore** (string) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
* **compressAssembly** (boolean) Emit a compressed version of the assembly. __*Default*__: false
* **docgenFilePath** (string) File path for generated docs. __*Default*__: "API.md"
* **dotnet** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) *No description* __*Optional*__
* **excludeTypescript** (Array) Accepts a list of glob patterns. __*Optional*__
* **jsiiVersion** (string) Version of the jsii compiler to use. __*Default*__: "1.x"
* **publishToGo** ([cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)) Publish Go bindings to a git repository. __*Default*__: no publishing
* **publishToMaven** ([cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)) Publish to maven. __*Default*__: no publishing
* **publishToNuget** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) Publish to NuGet. __*Default*__: no publishing
* **publishToPypi** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) Publish to pypi. __*Default*__: no publishing
* **python** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) *No description* __*Optional*__
* **rootdir** (string) *No description* __*Default*__: "."
* **catalog** ([cdk.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:. __*Default*__: new version will be announced
## class IntegrationTestAutoDiscoverBase ð¹
Base class for locating integration tests in the project's test tree.
__Submodule__: cdk
__Extends__: [cdk.AutoDiscoverBase](#projen-cdk-autodiscoverbase)
### Initializer
```ts
new cdk.IntegrationTestAutoDiscoverBase(project: Project, options: IntegrationTestAutoDiscoverBaseOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([cdk.IntegrationTestAutoDiscoverBaseOptions](#projen-cdk-integrationtestautodiscoverbaseoptions)) *No description*
* **testdir** (string) Test source tree.
## class IntegrationTestBase ð¹
__Submodule__: cdk
__Extends__: [Component](#projen-component)
__Implemented by__: [awscdk.IntegrationTest](#projen-awscdk-integrationtest), [cdk8s.IntegrationTest](#projen-cdk8s-integrationtest)
### Initializer
```ts
new cdk.IntegrationTestBase(project: Project, options: IntegrationTestBaseOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([cdk.IntegrationTestBaseOptions](#projen-cdk-integrationtestbaseoptions)) *No description*
* **entrypoint** (string) A path from the project root directory to a TypeScript file which contains the integration test app.
* **tsconfigPath** (string) The path of the tsconfig.json file to use when running integration test cdk apps.
* **name** (string) Name of the integration test. __*Default*__: Derived from the entrypoint filename.
### Properties
Name | Type | Description
-----|------|-------------
**assertTask**ð¹ | [Task](#projen-task) | Synthesizes the integration test and compares against a local copy (runs during build).
**deployTask**ð¹ | [Task](#projen-task) | Deploy the integration test and update the snapshot upon success.
**name**ð¹ | string | Integration test name.
**snapshotDir**ð¹ | string | Snapshot output directory.
**snapshotTask**ð¹ | [Task](#projen-task) | Just update snapshot (without deployment).
**tmpDir**ð¹ | string | Temporary directory for each integration test.
## class JsiiDocgen ð¹
Creates a markdown file based on the jsii manifest: - Adds a `docgen` script to package.json - Runs `jsii-docgen` after compilation - Enforces that markdown file is checked in.
__Submodule__: cdk
### Initializer
```ts
new cdk.JsiiDocgen(project: JsiiProject, options?: JsiiDocgenOptions)
```
* **project** ([cdk.JsiiProject](#projen-cdk-jsiiproject)) *No description*
* **options** ([cdk.JsiiDocgenOptions](#projen-cdk-jsiidocgenoptions)) *No description*
* **filePath** (string) File path for generated docs. __*Default*__: "API.md"
## class JsiiProject ð¹
Multi-language jsii library project.
__Submodule__: cdk
__Extends__: [typescript.TypeScriptProject](#projen-typescript-typescriptproject)
### Initializer
```ts
new cdk.JsiiProject(options: JsiiProjectOptions)
```
* **options** ([cdk.JsiiProjectOptions](#projen-cdk-jsiiprojectoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
* **author** (string) The name of the library author.
* **authorAddress** (string) Email or URL of the library author.
* **repositoryUrl** (string) Git repository URL.
* **compat** (boolean) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
* **compatIgnore** (string) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
* **compressAssembly** (boolean) Emit a compressed version of the assembly. __*Default*__: false
* **docgenFilePath** (string) File path for generated docs. __*Default*__: "API.md"
* **dotnet** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) *No description* __*Optional*__
* **excludeTypescript** (Array) Accepts a list of glob patterns. __*Optional*__
* **jsiiVersion** (string) Version of the jsii compiler to use. __*Default*__: "1.x"
* **publishToGo** ([cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)) Publish Go bindings to a git repository. __*Default*__: no publishing
* **publishToMaven** ([cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)) Publish to maven. __*Default*__: no publishing
* **publishToNuget** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) Publish to NuGet. __*Default*__: no publishing
* **publishToPypi** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) Publish to pypi. __*Default*__: no publishing
* **python** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) *No description* __*Optional*__
* **rootdir** (string) *No description* __*Default*__: "."
### Properties
Name | Type | Description
-----|------|-------------
**eslint**?ð¹ | [javascript.Eslint](#projen-javascript-eslint) | __*Optional*__
## class AutoDiscover ð¹
Automatically discovers and creates `IntegrationTest`s from entry points found in the test tree.
__Submodule__: cdk8s
__Extends__: [Component](#projen-component)
### Initializer
```ts
new cdk8s.AutoDiscover(project: Project, options: AutoDiscoverOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([cdk8s.AutoDiscoverOptions](#projen-cdk8s-autodiscoveroptions)) *No description*
* **testdir** (string) Test source tree.
* **tsconfigPath** (string) Path to the tsconfig file to use for integration tests.
* **integrationTestAutoDiscover** (boolean) Automatically discover integration tests. __*Default*__: true
## class Cdk8sDeps ð¹
Manages dependencies on the CDK8s.
__Submodule__: cdk8s
__Extends__: [Component](#projen-component)
__Implemented by__: [cdk8s.Cdk8sDepsPy](#projen-cdk8s-cdk8sdepspy)
### Initializer
```ts
new cdk8s.Cdk8sDeps(project: Project, options: Cdk8sDepsOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([cdk8s.Cdk8sDepsOptions](#projen-cdk8s-cdk8sdepsoptions)) *No description*
* **cdk8sVersion** (string) Minumum version of the cdk8s to depend on.
* **cdk8sCliVersion** (string) Minumum version of the cdk8s-cli to depend on. __*Default*__: "2.0.28"
* **cdk8sCliVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s-cli. __*Default*__: false
* **cdk8sPlus** (boolean) Include cdk8s-plus. __*Default*__: true
* **cdk8sPlusVersion** (string) Minumum version of the cdk8s-plus-XX to depend on. __*Default*__: "2.0.0-rc.26"
* **cdk8sPlusVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s-plus-17. __*Default*__: false
* **cdk8sVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s. __*Default*__: false
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: "10.1.42"
* **constructsVersionPinning** (boolean) Use pinned version instead of caret version for constructs. __*Default*__: false
* **k8sMinorVersion** (number) The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0. __*Default*__: 22
* **cdk8sCliDependency** (boolean) Add cdk8s-cli only to Node projects.
* **dependencyType** ([DependencyType](#projen-dependencytype)) The type of dependency to use for runtime CDK8s and `constructs` modules.
### Properties
Name | Type | Description
-----|------|-------------
**cdk8sMajorVersion**ð¹ | number | The major version of the CDK8s (e.g. 1, 2, ...).
**cdk8sMinimumVersion**ð¹ | string | The minimum version of the CDK8s (e.g. `2.0.0`).
**cdk8sVersion**ð¹ | string | The dependency requirement for CDK8s.
### Methods
#### protected packageNames()ð¹
Return a configuration object with information about package naming in various languages.
```ts
protected packageNames(): Cdk8sPackageNames
```
__Returns__:
* [cdk8s.Cdk8sPackageNames](#projen-cdk8s-cdk8spackagenames)
## class Cdk8sDepsPy ð¹
__Submodule__: cdk8s
__Extends__: [cdk8s.Cdk8sDeps](#projen-cdk8s-cdk8sdeps)
### Initializer
```ts
new cdk8s.Cdk8sDepsPy(project: Project, options: Cdk8sDepsOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([cdk8s.Cdk8sDepsOptions](#projen-cdk8s-cdk8sdepsoptions)) *No description*
* **cdk8sVersion** (string) Minumum version of the cdk8s to depend on.
* **cdk8sCliVersion** (string) Minumum version of the cdk8s-cli to depend on. __*Default*__: "2.0.28"
* **cdk8sCliVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s-cli. __*Default*__: false
* **cdk8sPlus** (boolean) Include cdk8s-plus. __*Default*__: true
* **cdk8sPlusVersion** (string) Minumum version of the cdk8s-plus-XX to depend on. __*Default*__: "2.0.0-rc.26"
* **cdk8sPlusVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s-plus-17. __*Default*__: false
* **cdk8sVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s. __*Default*__: false
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: "10.1.42"
* **constructsVersionPinning** (boolean) Use pinned version instead of caret version for constructs. __*Default*__: false
* **k8sMinorVersion** (number) The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0. __*Default*__: 22
* **cdk8sCliDependency** (boolean) Add cdk8s-cli only to Node projects.
* **dependencyType** ([DependencyType](#projen-dependencytype)) The type of dependency to use for runtime CDK8s and `constructs` modules.
### Methods
#### protected packageNames()ð¹
Return a configuration object with information about package naming in various languages.
```ts
protected packageNames(): Cdk8sPackageNames
```
__Returns__:
* [cdk8s.Cdk8sPackageNames](#projen-cdk8s-cdk8spackagenames)
## class Cdk8sPythonApp ð¹
CDK8s app in Python.
__Submodule__: cdk8s
__Extends__: [python.PythonProject](#projen-python-pythonproject)
### Initializer
```ts
new cdk8s.Cdk8sPythonApp(options: Cdk8sPythonOptions)
```
* **options** ([cdk8s.Cdk8sPythonOptions](#projen-cdk8s-cdk8spythonoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **authorEmail** (string) Author's e-mail.
* **authorName** (string) Author's name.
* **version** (string) Version of the package.
* **classifiers** (Array) A list of PyPI trove classifiers that describe the project. __*Optional*__
* **description** (string) A short description of the package. __*Optional*__
* **homepage** (string) A URL to the website of the project. __*Optional*__
* **license** (string) License of this package as an SPDX identifier. __*Optional*__
* **packageName** (string) Package name. __*Optional*__
* **poetryOptions** ([python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)) Additional options to set for poetry if using poetry. __*Optional*__
* **setupConfig** (Map) Additional fields to pass in the setup() function if using setuptools. __*Optional*__
* **moduleName** (string) Name of the python package as used in imports and filenames.
* **deps** (Array) List of runtime dependencies for this project. __*Default*__: []
* **devDeps** (Array) List of dev dependencies for this project. __*Default*__: []
* **pip** (boolean) Use pip with a requirements.txt file to track project dependencies. __*Default*__: true, unless poetry is true, then false
* **poetry** (boolean) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. __*Default*__: false
* **projenrcJs** (boolean) Use projenrc in javascript. __*Default*__: false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options related to projenrc in JavaScript. __*Default*__: default options
* **projenrcPython** (boolean) Use projenrc in Python. __*Default*__: true
* **projenrcPythonOptions** ([python.ProjenrcOptions](#projen-python-projenrcoptions)) Options related to projenrc in python. __*Default*__: default options
* **projenrcTs** (boolean) Use projenrc in TypeScript. __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcTsOptions](#projen-typescript-projenrctsoptions)) Options related to projenrc in TypeScript. __*Default*__: default options
* **pytest** (boolean) Include pytest tests. __*Default*__: true
* **pytestOptions** ([python.PytestOptions](#projen-python-pytestoptions)) pytest options. __*Default*__: defaults
* **pythonExec** (string) Path to the python executable to use. __*Default*__: "python"
* **sample** (boolean) Include sample code and test if the relevant directories don't exist. __*Default*__: true
* **setuptools** (boolean) Use setuptools with a setup.py script for packaging and publishing. __*Default*__: true, unless poetry is true, then false
* **venv** (boolean) Use venv to manage a virtual environment for installing dependencies inside. __*Default*__: true, unless poetry is true, then false
* **venvOptions** ([python.VenvOptions](#projen-python-venvoptions)) Venv options. __*Default*__: defaults
* **cdk8sVersion** (string) Minumum version of the cdk8s to depend on.
* **cdk8sCliVersion** (string) Minumum version of the cdk8s-cli to depend on. __*Default*__: "2.0.28"
* **cdk8sCliVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s-cli. __*Default*__: false
* **cdk8sPlus** (boolean) Include cdk8s-plus. __*Default*__: true
* **cdk8sPlusVersion** (string) Minumum version of the cdk8s-plus-XX to depend on. __*Default*__: "2.0.0-rc.26"
* **cdk8sPlusVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s-plus-17. __*Default*__: false
* **cdk8sVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s. __*Default*__: false
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: "10.1.42"
* **constructsVersionPinning** (boolean) Use pinned version instead of caret version for constructs. __*Default*__: false
* **k8sMinorVersion** (number) The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0. __*Default*__: 22
* **appEntrypoint** (string) The CDK8s app's entrypoint. __*Default*__: "app.py"
* **cdk8sImports** (Array) Import additional specs. __*Default*__: no additional specs imported
* **k8sSpecVersion** (string) Import a specific Kubernetes spec version. __*Default*__: Use the cdk8s default
### Properties
Name | Type | Description
-----|------|-------------
**appEntrypoint**ð¹ | string | The CDK8s app entrypoint.
**cdk8sDeps**ð¹ | [cdk8s.Cdk8sDeps](#projen-cdk8s-cdk8sdeps) |
## class Cdk8sTypeScriptApp ð¹
CDK8s app in TypeScript.
__Submodule__: cdk8s
__Extends__: [typescript.TypeScriptAppProject](#projen-typescript-typescriptappproject)
### Initializer
```ts
new cdk8s.Cdk8sTypeScriptApp(options: Cdk8sTypeScriptAppOptions)
```
* **options** ([cdk8s.Cdk8sTypeScriptAppOptions](#projen-cdk8s-cdk8stypescriptappoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
* **cdk8sVersion** (string) Minumum version of the cdk8s to depend on.
* **cdk8sCliVersion** (string) Minumum version of the cdk8s-cli to depend on. __*Default*__: "2.0.28"
* **cdk8sCliVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s-cli. __*Default*__: false
* **cdk8sPlus** (boolean) Include cdk8s-plus. __*Default*__: true
* **cdk8sPlusVersion** (string) Minumum version of the cdk8s-plus-XX to depend on. __*Default*__: "2.0.0-rc.26"
* **cdk8sPlusVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s-plus-17. __*Default*__: false
* **cdk8sVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s. __*Default*__: false
* **constructsVersion** (string) Minimum version of the `constructs` library to depend on. __*Default*__: "10.1.42"
* **constructsVersionPinning** (boolean) Use pinned version instead of caret version for constructs. __*Default*__: false
* **k8sMinorVersion** (number) The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0. __*Default*__: 22
* **appEntrypoint** (string) The CDK8s app's entrypoint (relative to the source directory, which is "src" by default). __*Default*__: "main.ts"
* **cdk8sImports** (Array) Import additional specs. __*Default*__: no additional specs imported
* **integrationTestAutoDiscover** (boolean) Automatically adds an `cdk8s.IntegrationTest` for each `.integ.ts` app in your test directory. If this is disabled, you can manually add an `cdk8s.AutoDiscover` component to your project. __*Default*__: true
* **k8sSpecVersion** (string) Import a specific Kubernetes spec version. __*Default*__: Use the cdk8s default
### Properties
Name | Type | Description
-----|------|-------------
**appEntrypoint**ð¹ | string | The CDK8s app entrypoint.
**cdk8sDeps**ð¹ | [cdk8s.Cdk8sDeps](#projen-cdk8s-cdk8sdeps) |
## class ConstructLibraryCdk8s ð¹
CDK8s construct library project.
A multi-language (jsii) construct library which vends constructs designed to
use within the CDK for Kubernetes (CDK8s), with a friendly workflow and
automatic publishing to the construct catalog.
__Submodule__: cdk8s
__Extends__: [cdk.ConstructLibrary](#projen-cdk-constructlibrary)
### Initializer
```ts
new cdk8s.ConstructLibraryCdk8s(options: ConstructLibraryCdk8sOptions)
```
* **options** ([cdk8s.ConstructLibraryCdk8sOptions](#projen-cdk8s-constructlibrarycdk8soptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
* **author** (string) The name of the library author.
* **authorAddress** (string) Email or URL of the library author.
* **repositoryUrl** (string) Git repository URL.
* **compat** (boolean) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
* **compatIgnore** (string) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
* **compressAssembly** (boolean) Emit a compressed version of the assembly. __*Default*__: false
* **docgenFilePath** (string) File path for generated docs. __*Default*__: "API.md"
* **dotnet** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) *No description* __*Optional*__
* **excludeTypescript** (Array) Accepts a list of glob patterns. __*Optional*__
* **jsiiVersion** (string) Version of the jsii compiler to use. __*Default*__: "1.x"
* **publishToGo** ([cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)) Publish Go bindings to a git repository. __*Default*__: no publishing
* **publishToMaven** ([cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)) Publish to maven. __*Default*__: no publishing
* **publishToNuget** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) Publish to NuGet. __*Default*__: no publishing
* **publishToPypi** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) Publish to pypi. __*Default*__: no publishing
* **python** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) *No description* __*Optional*__
* **rootdir** (string) *No description* __*Default*__: "."
* **catalog** ([cdk.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:. __*Default*__: new version will be announced
* **cdk8sVersion** (string) Minimum target version this library is tested against.
* **cdk8sPlusVersionPinning** (boolean) Use pinned version instead of caret version for cdk8s-plus-17. __*Default*__: false
* **cdk8sVersionPinning** (boolean) Use pinned version instead of caret version for CDK8s. __*Default*__: false
* **constructsVersion** (string) constructs verion. __*Default*__: "3.3.196"
* **constructsVersionPinning** (boolean) Use pinned version instead of caret version for constructs. __*Default*__: false
* **integrationTestAutoDiscover** (boolean) Automatically adds an `cdk8s.IntegrationTest` for each `.integ.ts` app in your test directory. If this is disabled, you can manually add an `cdk8s.AutoDiscover` component to your project. __*Default*__: true
### Properties
Name | Type | Description
-----|------|-------------
**cdk8sVersion**ð¹ | string | The CDK8s version this app is using.
**constructsVersion**ð¹ | string | The constructs version this app is using.
## class IntegrationTest ð¹
CDK8S integration test.
__Submodule__: cdk8s
__Extends__: [cdk.IntegrationTestBase](#projen-cdk-integrationtestbase)
### Initializer
```ts
new cdk8s.IntegrationTest(project: Project, options: IntegrationTestOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([cdk8s.IntegrationTestOptions](#projen-cdk8s-integrationtestoptions)) *No description*
* **entrypoint** (string) A path from the project root directory to a TypeScript file which contains the integration test app.
* **tsconfigPath** (string) The path of the tsconfig.json file to use when running integration test cdk apps.
* **name** (string) Name of the integration test. __*Default*__: Derived from the entrypoint filename.
## class IntegrationTestAutoDiscover ð¹
Discovers and creates integration tests from files in the test root.
__Submodule__: cdk8s
__Extends__: [cdk.IntegrationTestAutoDiscoverBase](#projen-cdk-integrationtestautodiscoverbase)
### Initializer
```ts
new cdk8s.IntegrationTestAutoDiscover(project: Project, options: IntegrationTestAutoDiscoverOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([cdk8s.IntegrationTestAutoDiscoverOptions](#projen-cdk8s-integrationtestautodiscoveroptions)) *No description*
* **testdir** (string) Test source tree.
* **tsconfigPath** (string) Path to the tsconfig file to use for integration tests.
## class ConstructLibraryCdktf ð¹
CDKTF construct library project.
A multi-language (jsii) construct library which vends constructs designed to
use within the CDK for Terraform (CDKTF), with a friendly workflow and
automatic publishing to the construct catalog.
__Submodule__: cdktf
__Extends__: [cdk.ConstructLibrary](#projen-cdk-constructlibrary)
### Initializer
```ts
new cdktf.ConstructLibraryCdktf(options: ConstructLibraryCdktfOptions)
```
* **options** ([cdktf.ConstructLibraryCdktfOptions](#projen-cdktf-constructlibrarycdktfoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
* **author** (string) The name of the library author.
* **authorAddress** (string) Email or URL of the library author.
* **repositoryUrl** (string) Git repository URL.
* **compat** (boolean) Automatically run API compatibility test against the latest version published to npm after compilation. __*Default*__: false
* **compatIgnore** (string) Name of the ignore file for API compatibility tests. __*Default*__: ".compatignore"
* **compressAssembly** (boolean) Emit a compressed version of the assembly. __*Default*__: false
* **docgenFilePath** (string) File path for generated docs. __*Default*__: "API.md"
* **dotnet** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) *No description* __*Optional*__
* **excludeTypescript** (Array) Accepts a list of glob patterns. __*Optional*__
* **jsiiVersion** (string) Version of the jsii compiler to use. __*Default*__: "1.x"
* **publishToGo** ([cdk.JsiiGoTarget](#projen-cdk-jsiigotarget)) Publish Go bindings to a git repository. __*Default*__: no publishing
* **publishToMaven** ([cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget)) Publish to maven. __*Default*__: no publishing
* **publishToNuget** ([cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget)) Publish to NuGet. __*Default*__: no publishing
* **publishToPypi** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) Publish to pypi. __*Default*__: no publishing
* **python** ([cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget)) *No description* __*Optional*__
* **rootdir** (string) *No description* __*Default*__: "."
* **catalog** ([cdk.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:. __*Default*__: new version will be announced
* **cdktfVersion** (string) Minimum target version this library is tested against.
* **constructsVersion** (string) Construct version to use. __*Default*__: "^10.0.12"
## class Circleci ð¹
Circleci Class to manage `.circleci/config.yml`. Check projen's docs for more information.
__Submodule__: circleci
__Extends__: [Component](#projen-component)
### Initializer
```ts
new circleci.Circleci(project: Project, options?: CircleCiProps)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([circleci.CircleCiProps](#projen-circleci-circleciprops)) *No description*
* **jobs** (Array<[circleci.Job](#projen-circleci-job)>) List of Jobs to create unique steps per pipeline, e.g. ```json jobs: [{ identifier: "compile", docker: { image: "golang:alpine" } steps: ["checkout", run: {command: "go build ."}] }] ```. __*Optional*__
* **orbs** (Map) Contains a map of CirclCi Orbs ```json orbs: { node: "circleci/node@5.0.1" slack: "circleci/slack@4.8.3" } ```. __*Optional*__
* **setup** (boolean) The setup field enables you to conditionally trigger configurations from outside the primary .circleci parent directory, update pipeline parameters, or generate customized configurations. __*Optional*__
* **version** (number) pipeline version. __*Default*__: 2.1
* **workflows** (Array<[circleci.Workflow](#projen-circleci-workflow)>) List of Workflows of pipeline, e.g. ```json workflows: { { identifier: "build", jobs: [{ identifier: "node/install", context: ["npm"], }] } } ```. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**file**ð¹ | [YamlFile](#projen-yamlfile) | The yaml file for the Circleci pipeline.
### Methods
#### addOrb(name, orb)ð¹
Add a Circleci Orb to pipeline.
Will throw error if the orb already exists
```ts
addOrb(name: string, orb: string): void
```
* **name** (string) *No description*
* **orb** (string) *No description*
#### addWorkflow(workflow)ð¹
add new workflow to existing pipeline.
```ts
addWorkflow(workflow: Workflow): void
```
* **workflow** ([circleci.Workflow](#projen-circleci-workflow)) *No description*
* **identifier** (string) name of dynamic key *.
* **jobs** (Array<[circleci.WorkflowJob](#projen-circleci-workflowjob)>) *No description* __*Optional*__
* **triggers** (Array<[circleci.Triggers](#projen-circleci-triggers)>) *No description* __*Optional*__
* **when** (any) when is too dynamic to be casted to interfaces. __*Optional*__
## class AutoApprove ð¹
Auto approve pull requests that meet a criteria.
__Submodule__: github
__Extends__: [Component](#projen-component)
### Initializer
```ts
new github.AutoApprove(github: GitHub, options?: AutoApproveOptions)
```
* **github** ([github.GitHub](#projen-github-github)) *No description*
* **options** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) *No description*
* **allowedUsernames** (Array) Only pull requests authored by these Github usernames will be auto-approved. __*Default*__: ['github-bot']
* **label** (string) Only pull requests with this label will be auto-approved. __*Default*__: 'auto-approve'
* **runsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **secret** (string) A GitHub secret name which contains a GitHub Access Token with write permissions for the `pull_request` scope. __*Default*__: "GITHUB_TOKEN"
### Properties
Name | Type | Description
-----|------|-------------
**label**ð¹ | string |
## class AutoMerge ð¹
Sets up mergify to merging approved pull requests.
If `buildJob` is specified, the specified GitHub workflow job ID is required
to succeed in order for the PR to be merged.
`approvedReviews` specified the number of code review approvals required for
the PR to be merged.
__Submodule__: github
__Extends__: [Component](#projen-component)
### Initializer
```ts
new github.AutoMerge(github: GitHub, options?: AutoMergeOptions)
```
* **github** ([github.GitHub](#projen-github-github)) *No description*
* **options** ([github.AutoMergeOptions](#projen-github-automergeoptions)) *No description*
* **approvedReviews** (number) Number of approved code reviews. __*Default*__: 1
* **blockingLabels** (Array) List of labels that will prevent auto-merging. __*Default*__: ['do-not-merge']
### Methods
#### addConditions(...conditions)ð¹
Adds conditions to the auto merge rule.
```ts
addConditions(...conditions: string[]): void
```
* **conditions** (string) The conditions to add (mergify syntax).
#### addConditionsLater(later)ð¹
Adds conditions that will be rendered only during synthesis.
```ts
addConditionsLater(later: IAddConditionsLater): void
```
* **later** ([github.IAddConditionsLater](#projen-github-iaddconditionslater)) The later.
## class Dependabot ð¹
Defines dependabot configuration for node projects.
Since module versions are managed in projen, the versioning strategy will be
configured to "lockfile-only" which means that only updates that can be done
on the lockfile itself will be proposed.
__Submodule__: github
__Extends__: [Component](#projen-component)
### Initializer
```ts
new github.Dependabot(github: GitHub, options?: DependabotOptions)
```
* **github** ([github.GitHub](#projen-github-github)) *No description*
* **options** ([github.DependabotOptions](#projen-github-dependabotoptions)) *No description*
* **ignore** (Array<[github.DependabotIgnore](#projen-github-dependabotignore)>) You can use the `ignore` option to customize which dependencies are updated. __*Default*__: []
* **ignoreProjen** (boolean) Ignores updates to `projen`. __*Default*__: true
* **labels** (Array) List of labels to apply to the created PR's. __*Optional*__
* **registries** (Map) Map of package registries to use. __*Default*__: use public registries
* **scheduleInterval** ([github.DependabotScheduleInterval](#projen-github-dependabotscheduleinterval)) How often to check for new versions and raise pull requests. __*Default*__: ScheduleInterval.DAILY
* **versioningStrategy** ([github.VersioningStrategy](#projen-github-versioningstrategy)) The strategy to use when edits manifest and lock files. __*Default*__: VersioningStrategy.LOCKFILE_ONLY The default is to only update the lock file because package.json is controlled by projen and any outside updates will fail the build.
### Properties
Name | Type | Description
-----|------|-------------
**config**ð¹ | any | The raw dependabot configuration.
**ignoresProjen**ð¹ | boolean | Whether or not projen is also upgraded in this config,.
### Methods
#### addIgnore(dependencyName, ...versions)ð¹
Ignores a dependency from automatic updates.
```ts
addIgnore(dependencyName: string, ...versions: string[]): void
```
* **dependencyName** (string) Use to ignore updates for dependencies with matching names, optionally using `*` to match zero or more characters.
* **versions** (string) Use to ignore specific versions or ranges of versions.
## class GitHub ð¹
__Submodule__: github
__Extends__: [Component](#projen-component)
### Initializer
```ts
new github.GitHub(project: Project, options?: GitHubOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([github.GitHubOptions](#projen-github-githuboptions)) *No description*
* **downloadLfs** (boolean) Download files in LFS in workflows. __*Default*__: true if the associated project has `lfsPatterns`, `false` otherwise
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for Mergify. __*Default*__: default options
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **pullRequestLint** (boolean) Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits. __*Default*__: true
* **pullRequestLintOptions** ([github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)) Options for configuring a pull request linter. __*Default*__: see defaults in `PullRequestLintOptions`
* **workflows** (boolean) Enables GitHub workflows. __*Default*__: true
### Properties
Name | Type | Description
-----|------|-------------
**actions**ð¹ | [github.GitHubActionsProvider](#projen-github-githubactionsprovider) |
**downloadLfs**ð¹ | boolean | Whether downloading from LFS is enabled for this GitHub project.
**projenCredentials**ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | GitHub API authentication method used by projen workflows.
**workflows**ð¹ | Array<[github.GithubWorkflow](#projen-github-githubworkflow)> | All workflows.
**workflowsEnabled**ð¹ | boolean | Are workflows enabled?
**mergify**?ð¹ | [github.Mergify](#projen-github-mergify) | The `Mergify` configured on this repository.
__*Optional*__
### Methods
#### addDependabot(options?)ð¹
```ts
addDependabot(options?: DependabotOptions): Dependabot
```
* **options** ([github.DependabotOptions](#projen-github-dependabotoptions)) *No description*
* **ignore** (Array<[github.DependabotIgnore](#projen-github-dependabotignore)>) You can use the `ignore` option to customize which dependencies are updated. __*Default*__: []
* **ignoreProjen** (boolean) Ignores updates to `projen`. __*Default*__: true
* **labels** (Array) List of labels to apply to the created PR's. __*Optional*__
* **registries** (Map) Map of package registries to use. __*Default*__: use public registries
* **scheduleInterval** ([github.DependabotScheduleInterval](#projen-github-dependabotscheduleinterval)) How often to check for new versions and raise pull requests. __*Default*__: ScheduleInterval.DAILY
* **versioningStrategy** ([github.VersioningStrategy](#projen-github-versioningstrategy)) The strategy to use when edits manifest and lock files. __*Default*__: VersioningStrategy.LOCKFILE_ONLY The default is to only update the lock file because package.json is controlled by projen and any outside updates will fail the build.
__Returns__:
* [github.Dependabot](#projen-github-dependabot)
#### addPullRequestTemplate(...content)ð¹
```ts
addPullRequestTemplate(...content: string[]): PullRequestTemplate
```
* **content** (string) *No description*
__Returns__:
* [github.PullRequestTemplate](#projen-github-pullrequesttemplate)
#### addWorkflow(name)ð¹
Adds a workflow to the project.
```ts
addWorkflow(name: string): GithubWorkflow
```
* **name** (string) Name of the workflow.
__Returns__:
* [github.GithubWorkflow](#projen-github-githubworkflow)
#### tryFindWorkflow(name)ð¹
Finds a GitHub workflow by name.
Returns `undefined` if the workflow cannot be found.
```ts
tryFindWorkflow(name: string): GithubWorkflow
```
* **name** (string) The name of the GitHub workflow.
__Returns__:
* [github.GithubWorkflow](#projen-github-githubworkflow)
#### *static* of(project)ð¹
Returns the `GitHub` component of a project or `undefined` if the project does not have a GitHub component.
```ts
static of(project: Project): GitHub
```
* **project** ([Project](#projen-project)) *No description*
__Returns__:
* [github.GitHub](#projen-github-github)
## class GitHubActionsProvider ð¹
Manage the versions used for GitHub Actions used in steps.
__Submodule__: github
### Initializer
```ts
new github.GitHubActionsProvider()
```
### Methods
#### get(action)ð¹
Resolve an action name to the version that should be used, taking into account any overrides.
```ts
get(action: string): string
```
* **action** (string) *No description*
__Returns__:
* string
#### set(action, override)ð¹
Define an override for a given action.
Specify the action name without a version to override all usages of the action.
You can also override a specific action version, by providing the version string.
Specific overrides take precedence over overrides without a version.
If an override for the same action name is set multiple times, the last override is used.
```ts
set(action: string, override: string): void
```
* **action** (string) *No description*
* **override** (string) *No description*
## class GitHubProject â ïž
GitHub-based project.
__Submodule__: github
__Extends__: [Project](#projen-project)
### Initializer
```ts
new github.GitHubProject(options: GitHubProjectOptions)
```
* **options** ([github.GitHubProjectOptions](#projen-github-githubprojectoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
### Properties
Name | Type | Description
-----|------|-------------
**projectType**â ïž | [ProjectType](#projen-projecttype) |
**autoApprove**?â ïž | [github.AutoApprove](#projen-github-autoapprove) | Auto approve set up for this project.
__*Optional*__
**devContainer**?â ïž | [vscode.DevContainer](#projen-vscode-devcontainer) | Access for .devcontainer.json (used for GitHub Codespaces).
__*Optional*__
**github**?â ïž | [github.GitHub](#projen-github-github) | Access all github components.
__*Optional*__
**gitpod**?â ïž | [Gitpod](#projen-gitpod) | Access for Gitpod.
__*Optional*__
**vscode**?â ïž | [vscode.VsCode](#projen-vscode-vscode) | Access all VSCode components.
__*Optional*__
### Methods
#### annotateGenerated(glob)â ïž
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.
```ts
annotateGenerated(glob: string): void
```
* **glob** (string) the glob pattern to match (could be a file path).
## class GithubCredentials ð¹
Represents a method of providing GitHub API access for projen workflows.
__Submodule__: github
### Properties
Name | Type | Description
-----|------|-------------
**setupSteps**ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Setup steps to obtain GitHub credentials.
**tokenRef**ð¹ | string | The value to use in a workflow when a GitHub token is expected.
### Methods
#### *static* fromApp(options?)ð¹
Provide API access through a GitHub App.
The GitHub App must be installed on the GitHub repo, its App ID and a
private key must be added as secrets to the repo. The name of the secrets
can be specified here.
```ts
static fromApp(options?: GithubCredentialsAppOptions): GithubCredentials
```
* **options** ([github.GithubCredentialsAppOptions](#projen-github-githubcredentialsappoptions)) *No description*
* **appIdSecret** (string) *No description* __*Optional*__
* **permissions** ([github.workflows.AppPermissions](#projen-github-workflows-apppermissions)) The permissions granted to the token. __*Default*__: all permissions granted to the app
* **privateKeySecret** (string) *No description* __*Optional*__
__Returns__:
* [github.GithubCredentials](#projen-github-githubcredentials)
#### *static* fromPersonalAccessToken(options?)ð¹
Provide API access through a GitHub personal access token.
The token must be added as a secret to the GitHub repo, and the name of the
secret can be specified here.
```ts
static fromPersonalAccessToken(options?: GithubCredentialsPersonalAccessTokenOptions): GithubCredentials
```
* **options** ([github.GithubCredentialsPersonalAccessTokenOptions](#projen-github-githubcredentialspersonalaccesstokenoptions)) *No description*
* **secret** (string) *No description* __*Optional*__
__Returns__:
* [github.GithubCredentials](#projen-github-githubcredentials)
## class GithubWorkflow ð¹
Workflow for GitHub.
A workflow is a configurable automated process made up of one or more jobs.
__Submodule__: github
__Extends__: [Component](#projen-component)
### Initializer
```ts
new github.GithubWorkflow(github: GitHub, name: string, options?: GithubWorkflowOptions)
```
* **github** ([github.GitHub](#projen-github-github)) *No description*
* **name** (string) *No description*
* **options** ([github.GithubWorkflowOptions](#projen-github-githubworkflowoptions)) *No description*
* **concurrency** (string) Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. __*Default*__: disabled
* **force** (boolean) Force the creation of the workflow even if `workflows` is disabled in `GitHub`. __*Default*__: false
### Properties
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | The name of the workflow.
**projenCredentials**ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | GitHub API authentication method used by projen workflows.
**concurrency**?ð¹ | string | Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.
__*Default*__: disabled
**file**?ð¹ | [YamlFile](#projen-yamlfile) | The workflow YAML file.
__*Optional*__
**runName**?ð¹ | string | The name for workflow runs generated from the workflow.
__*Optional*__
### Methods
#### addJob(id, job)ð¹
Adds a single job to the workflow.
```ts
addJob(id: string, job: JobCallingReusableWorkflow | Job): void
```
* **id** (string) The job name (unique within the workflow).
* **job** ([github.workflows.JobCallingReusableWorkflow](#projen-github-workflows-jobcallingreusableworkflow) | [github.workflows.Job](#projen-github-workflows-job)) The job specification.
#### addJobs(jobs)ð¹
Add jobs to the workflow.
```ts
addJobs(jobs: Map): void
```
* **jobs** (Map) Jobs to add.
#### getJob(id)ð¹
Get a single job from the workflow.
```ts
getJob(id: string): JobCallingReusableWorkflow | Job
```
* **id** (string) The job name (unique within the workflow).
__Returns__:
* [github.workflows.JobCallingReusableWorkflow](#projen-github-workflows-jobcallingreusableworkflow) | [github.workflows.Job](#projen-github-workflows-job)
#### on(events)ð¹
Add events to triggers the workflow.
```ts
on(events: Triggers): void
```
* **events** ([github.workflows.Triggers](#projen-github-workflows-triggers)) The event(s) to trigger the workflow.
* **branchProtectionRule** ([github.workflows.BranchProtectionRuleOptions](#projen-github-workflows-branchprotectionruleoptions)) Runs your workflow anytime the branch_protection_rule event occurs. __*Optional*__
* **checkRun** ([github.workflows.CheckRunOptions](#projen-github-workflows-checkrunoptions)) Runs your workflow anytime the check_run event occurs. __*Optional*__
* **checkSuite** ([github.workflows.CheckSuiteOptions](#projen-github-workflows-checksuiteoptions)) Runs your workflow anytime the check_suite event occurs. __*Optional*__
* **create** ([github.workflows.CreateOptions](#projen-github-workflows-createoptions)) Runs your workflow anytime someone creates a branch or tag, which triggers the create event. __*Optional*__
* **delete** ([github.workflows.DeleteOptions](#projen-github-workflows-deleteoptions)) Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. __*Optional*__
* **deployment** ([github.workflows.DeploymentOptions](#projen-github-workflows-deploymentoptions)) Runs your workflow anytime someone creates a deployment, which triggers the deployment event. __*Optional*__
* **deploymentStatus** ([github.workflows.DeploymentStatusOptions](#projen-github-workflows-deploymentstatusoptions)) Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. __*Optional*__
* **discussion** ([github.workflows.DiscussionOptions](#projen-github-workflows-discussionoptions)) Runs your workflow anytime the discussion event occurs. __*Optional*__
* **discussionComment** ([github.workflows.DiscussionCommentOptions](#projen-github-workflows-discussioncommentoptions)) Runs your workflow anytime the discussion_comment event occurs. __*Optional*__
* **fork** ([github.workflows.ForkOptions](#projen-github-workflows-forkoptions)) Runs your workflow anytime when someone forks a repository, which triggers the fork event. __*Optional*__
* **gollum** ([github.workflows.GollumOptions](#projen-github-workflows-gollumoptions)) Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. __*Optional*__
* **issueComment** ([github.workflows.IssueCommentOptions](#projen-github-workflows-issuecommentoptions)) Runs your workflow anytime the issue_comment event occurs. __*Optional*__
* **issues** ([github.workflows.IssuesOptions](#projen-github-workflows-issuesoptions)) Runs your workflow anytime the issues event occurs. __*Optional*__
* **label** ([github.workflows.LabelOptions](#projen-github-workflows-labeloptions)) Runs your workflow anytime the label event occurs. __*Optional*__
* **mergeGroup** ([github.workflows.MergeGroupOptions](#projen-github-workflows-mergegroupoptions)) Runs your workflow when a pull request is added to a merge queue, which adds the pull request to a merge group. __*Optional*__
* **milestone** ([github.workflows.MilestoneOptions](#projen-github-workflows-milestoneoptions)) Runs your workflow anytime the milestone event occurs. __*Optional*__
* **pageBuild** ([github.workflows.PageBuildOptions](#projen-github-workflows-pagebuildoptions)) Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event. __*Optional*__
* **project** ([github.workflows.ProjectOptions](#projen-github-workflows-projectoptions)) Runs your workflow anytime the project event occurs. __*Optional*__
* **projectCard** ([github.workflows.ProjectCardOptions](#projen-github-workflows-projectcardoptions)) Runs your workflow anytime the project_card event occurs. __*Optional*__
* **projectColumn** ([github.workflows.ProjectColumnOptions](#projen-github-workflows-projectcolumnoptions)) Runs your workflow anytime the project_column event occurs. __*Optional*__
* **public** ([github.workflows.PublicOptions](#projen-github-workflows-publicoptions)) Runs your workflow anytime someone makes a private repository public, which triggers the public event. __*Optional*__
* **pullRequest** ([github.workflows.PullRequestOptions](#projen-github-workflows-pullrequestoptions)) Runs your workflow anytime the pull_request event occurs. __*Optional*__
* **pullRequestReview** ([github.workflows.PullRequestReviewOptions](#projen-github-workflows-pullrequestreviewoptions)) Runs your workflow anytime the pull_request_review event occurs. __*Optional*__
* **pullRequestReviewComment** ([github.workflows.PullRequestReviewCommentOptions](#projen-github-workflows-pullrequestreviewcommentoptions)) Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event. __*Optional*__
* **pullRequestTarget** ([github.workflows.PullRequestTargetOptions](#projen-github-workflows-pullrequesttargetoptions)) This event runs in the context of the base of the pull request, rather than in the merge commit as the pull_request event does. __*Optional*__
* **push** ([github.workflows.PushOptions](#projen-github-workflows-pushoptions)) Runs your workflow when someone pushes to a repository branch, which triggers the push event. __*Optional*__
* **registryPackage** ([github.workflows.RegistryPackageOptions](#projen-github-workflows-registrypackageoptions)) Runs your workflow anytime a package is published or updated. __*Optional*__
* **release** ([github.workflows.ReleaseOptions](#projen-github-workflows-releaseoptions)) Runs your workflow anytime the release event occurs. __*Optional*__
* **repositoryDispatch** ([github.workflows.RepositoryDispatchOptions](#projen-github-workflows-repositorydispatchoptions)) You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. __*Optional*__
* **schedule** (Array<[github.workflows.CronScheduleOptions](#projen-github-workflows-cronscheduleoptions)>) You can schedule a workflow to run at specific UTC times using POSIX cron syntax. __*Optional*__
* **status** ([github.workflows.StatusOptions](#projen-github-workflows-statusoptions)) Runs your workflow anytime the status of a Git commit changes, which triggers the status event. __*Optional*__
* **watch** ([github.workflows.WatchOptions](#projen-github-workflows-watchoptions)) Runs your workflow anytime the watch event occurs. __*Optional*__
* **workflowCall** ([github.workflows.WorkflowCallOptions](#projen-github-workflows-workflowcalloptions)) Can be called from another workflow. __*Optional*__
* **workflowDispatch** ([github.workflows.WorkflowDispatchOptions](#projen-github-workflows-workflowdispatchoptions)) You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow. __*Optional*__
* **workflowRun** ([github.workflows.WorkflowRunOptions](#projen-github-workflows-workflowrunoptions)) This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. __*Optional*__
#### removeJob(id)ð¹
Removes a single job to the workflow.
```ts
removeJob(id: string): void
```
* **id** (string) The job name (unique within the workflow).
#### updateJob(id, job)ð¹
Updates a single job to the workflow.
```ts
updateJob(id: string, job: JobCallingReusableWorkflow | Job): void
```
* **id** (string) The job name (unique within the workflow).
* **job** ([github.workflows.JobCallingReusableWorkflow](#projen-github-workflows-jobcallingreusableworkflow) | [github.workflows.Job](#projen-github-workflows-job)) *No description*
#### updateJobs(jobs)ð¹
Updates jobs for this worklow Does a complete replace, it does not try to merge the jobs.
```ts
updateJobs(jobs: Map): void
```
* **jobs** (Map) Jobs to update.
## class Mergify ð¹
__Submodule__: github
__Extends__: [Component](#projen-component)
### Initializer
```ts
new github.Mergify(github: GitHub, options?: MergifyOptions)
```
* **github** ([github.GitHub](#projen-github-github)) *No description*
* **options** ([github.MergifyOptions](#projen-github-mergifyoptions)) *No description*
* **queues** (Array<[github.MergifyQueue](#projen-github-mergifyqueue)>) *No description* __*Optional*__
* **rules** (Array<[github.MergifyRule](#projen-github-mergifyrule)>) *No description* __*Optional*__
### Methods
#### addQueue(queue)ð¹
```ts
addQueue(queue: MergifyQueue): void
```
* **queue** ([github.MergifyQueue](#projen-github-mergifyqueue)) *No description*
* **conditions** (Array) A list of Conditions string that must match against the pull request for the pull request to be added to the queue.
* **name** (string) The name of the queue.
* **mergeMethod** (string) Merge method to use. __*Default*__: "merge"
* **updateMethod** (string) Method to use to update the pull request with its base branch when the speculative check is done in-place. __*Default*__: `merge` for all merge methods except `fast-forward` where `rebase` is used
#### addRule(rule)ð¹
```ts
addRule(rule: MergifyRule): void
```
* **rule** ([github.MergifyRule](#projen-github-mergifyrule)) *No description*
* **actions** (Map) A dictionary made of Actions that will be executed on the matching pull requests.
* **conditions** (Array) A list of Conditions string that must match against the pull request for the rule to be applied.
* **name** (string) The name of the rule.
## class PullRequestLint ð¹
Configure validations to run on GitHub pull requests.
Only generates a file if at least one linter is configured.
__Submodule__: github
__Extends__: [Component](#projen-component)
### Initializer
```ts
new github.PullRequestLint(github: GitHub, options?: PullRequestLintOptions)
```
* **github** ([github.GitHub](#projen-github-github)) *No description*
* **options** ([github.PullRequestLintOptions](#projen-github-pullrequestlintoptions)) *No description*
* **runsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **semanticTitle** (boolean) Validate that pull request titles follow Conventional Commits. __*Default*__: true
* **semanticTitleOptions** ([github.SemanticTitleOptions](#projen-github-semantictitleoptions)) Options for validating the conventional commit title linter. __*Default*__: title must start with "feat", "fix", or "chore"
## class PullRequestTemplate ð¹
Template for GitHub pull requests.
__Submodule__: github
__Extends__: [TextFile](#projen-textfile)
### Initializer
```ts
new github.PullRequestTemplate(github: GitHub, options?: PullRequestTemplateOptions)
```
* **github** ([github.GitHub](#projen-github-github)) *No description*
* **options** ([github.PullRequestTemplateOptions](#projen-github-pullrequesttemplateoptions)) *No description*
* **lines** (Array) The contents of the template. __*Default*__: a standard default template will be created.
## class Stale ð¹
Warns and then closes issues and PRs that have had no activity for a specified amount of time.
The default configuration will:
* Add a "Stale" label to pull requests after 14 days and closed after 2 days
* Add a "Stale" label to issues after 60 days and closed after 7 days
* If a comment is added, the label will be removed and timer is restarted.
__Submodule__: github
__Extends__: [Component](#projen-component)
### Initializer
```ts
new github.Stale(github: GitHub, options?: StaleOptions)
```
* **github** ([github.GitHub](#projen-github-github)) *No description*
* **options** ([github.StaleOptions](#projen-github-staleoptions)) *No description*
* **issues** ([github.StaleBehavior](#projen-github-stalebehavior)) How to handle stale issues. __*Default*__: By default, stale issues with no activity will be marked as stale after 60 days and closed within 7 days.
* **pullRequest** ([github.StaleBehavior](#projen-github-stalebehavior)) How to handle stale pull requests. __*Default*__: By default, pull requests with no activity will be marked as stale after 14 days and closed within 2 days with relevant comments.
* **runsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
## class TaskWorkflow ð¹
A GitHub workflow for common build tasks within a project.
__Submodule__: github
__Extends__: [github.GithubWorkflow](#projen-github-githubworkflow)
### Initializer
```ts
new github.TaskWorkflow(github: GitHub, options: TaskWorkflowOptions)
```
* **github** ([github.GitHub](#projen-github-github)) *No description*
* **options** ([github.TaskWorkflowOptions](#projen-github-taskworkflowoptions)) *No description*
* **name** (string) The workflow name.
* **permissions** ([github.workflows.JobPermissions](#projen-github-workflows-jobpermissions)) Permissions for the build job.
* **task** ([Task](#projen-task)) The main task to be executed.
* **artifactsDirectory** (string) A directory name which contains artifacts to be uploaded (e.g. `dist`). If this is set, the contents of this directory will be uploaded as an artifact at the end of the workflow run, even if other steps fail. __*Default*__: not set
* **checkoutWith** (Map) Override for the `with` property of the source code checkout step. __*Default*__: not set
* **condition** (string) Adds an 'if' condition to the workflow. __*Optional*__
* **container** ([github.workflows.ContainerOptions](#projen-github-workflows-containeroptions)) *No description* __*Default*__: default image
* **downloadLfs** (boolean) Whether to download files from Git LFS for this workflow. __*Default*__: Use the setting on the corresponding GitHub project
* **env** (Map) Workflow environment variables. __*Default*__: {}
* **gitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in this workflow. __*Optional*__
* **jobId** (string) The primary job id. __*Default*__: "build"
* **outputs** (Map) Mapping of job output names to values/expressions. __*Default*__: {}
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Actions to run after the main build step. __*Default*__: not set
* **preBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to run before the main build step. __*Default*__: not set
* **preCheckoutSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Initial steps to run before the source code checkout. __*Default*__: not set
* **runsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **triggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) The triggers for the workflow. __*Default*__: by default workflows can only be triggered by manually.
### Properties
Name | Type | Description
-----|------|-------------
**jobId**ð¹ | string |
**artifactsDirectory**?ð¹ | string | __*Optional*__
## class WorkflowActions ð¹
A set of utility functions for creating GitHub actions in workflows.
__Submodule__: github
### Initializer
```ts
new github.WorkflowActions()
```
### Methods
#### *static* checkoutWithPatch(options?)ð¹
Checks out a repository and applies a git patch that was created using `uploadGitPatch`.
```ts
static checkoutWithPatch(options?: CheckoutWithPatchOptions): Array
```
* **options** ([github.CheckoutWithPatchOptions](#projen-github-checkoutwithpatchoptions)) Options.
* **lfs** (boolean) Whether LFS is enabled for the GitHub repository. __*Default*__: false
* **patchFile** (string) The name of the artifact the patch is stored as. __*Default*__: ".repo.patch"
* **ref** (string) Branch or tag name. __*Default*__: the default branch is implicitly used
* **repository** (string) The repository (owner/repo) to use. __*Default*__: the default repository is implicitly used
* **token** (string) A GitHub token to use when checking out the repository. __*Default*__: the default GITHUB_TOKEN is implicitly used
__Returns__:
* Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>
#### *static* createPullRequest(options)ð¹
A step that creates a pull request based on the current repo state.
```ts
static createPullRequest(options: CreatePullRequestOptions): Array
```
* **options** ([github.CreatePullRequestOptions](#projen-github-createpullrequestoptions)) Options.
* **pullRequestDescription** (string) Description added to the pull request.
* **pullRequestTitle** (string) The full title used to create the pull request.
* **workflowName** (string) The name of the workflow that will create the PR.
* **assignees** (Array) Assignees to add on the PR. __*Default*__: no assignees
* **baseBranch** (string) Sets the pull request base branch. __*Default*__: The branch checked out in the workflow.
* **branchName** (string) The pull request branch name. __*Default*__: `github-actions/${options.workflowName}`
* **credentials** ([github.GithubCredentials](#projen-github-githubcredentials)) The job credentials used to create the pull request. __*Optional*__
* **gitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity used to create the commit. __*Default*__: the default github-actions user
* **labels** (Array) Labels to apply on the PR. __*Default*__: no labels.
* **signoff** (boolean) Add Signed-off-by line by the committer at the end of the commit log message. __*Default*__: true
* **stepId** (string) The step ID which produces the output which indicates if a patch was created. __*Default*__: "create_pr"
* **stepName** (string) The name of the step displayed on GitHub. __*Default*__: "Create Pull Request"
__Returns__:
* Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>
#### *static* setupGitIdentity(id)ð¹
Configures the git identity (user name and email).
```ts
static setupGitIdentity(id: GitIdentity): Array
```
* **id** ([github.GitIdentity](#projen-github-gitidentity)) The identity to use.
* **email** (string) The email address of the git user.
* **name** (string) The name of the user.
__Returns__:
* Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>
#### *static* uploadGitPatch(options)ð¹
Creates a .patch file from the current git diff and uploads it as an artifact. Use `checkoutWithPatch` to download and apply in another job.
If a patch was uploaded, the action can optionally fail the job.
```ts
static uploadGitPatch(options: UploadGitPatchOptions): Array
```
* **options** ([github.UploadGitPatchOptions](#projen-github-uploadgitpatchoptions)) Options.
* **outputName** (string) The name of the output to emit.
* **stepId** (string) The step ID which produces the output which indicates if a patch was created.
* **mutationError** (string) Fail if a mutation was found and print this error message. __*Default*__: do not fail upon mutation
* **patchFile** (string) The name of the artifact the patch is stored as. __*Default*__: ".repo.patch"
* **stepName** (string) The name of the step. __*Default*__: "Find mutations"
__Returns__:
* Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>
## class WorkflowJobs ð¹
A set of utility functions for creating jobs in GitHub Workflows.
__Submodule__: github
### Initializer
```ts
new github.WorkflowJobs()
```
### Methods
#### *static* pullRequestFromPatch(options)ð¹
Creates a pull request with the changes of a patch file.
```ts
static pullRequestFromPatch(options: PullRequestFromPatchOptions): Job
```
* **options** ([github.PullRequestFromPatchOptions](#projen-github-pullrequestfrompatchoptions)) *No description*
* **pullRequestDescription** (string) Description added to the pull request.
* **pullRequestTitle** (string) The full title used to create the pull request.
* **workflowName** (string) The name of the workflow that will create the PR.
* **assignees** (Array) Assignees to add on the PR. __*Default*__: no assignees
* **baseBranch** (string) Sets the pull request base branch. __*Default*__: The branch checked out in the workflow.
* **branchName** (string) The pull request branch name. __*Default*__: `github-actions/${options.workflowName}`
* **credentials** ([github.GithubCredentials](#projen-github-githubcredentials)) The job credentials used to create the pull request. __*Optional*__
* **gitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity used to create the commit. __*Default*__: the default github-actions user
* **labels** (Array) Labels to apply on the PR. __*Default*__: no labels.
* **signoff** (boolean) Add Signed-off-by line by the committer at the end of the commit log message. __*Default*__: true
* **stepId** (string) The step ID which produces the output which indicates if a patch was created. __*Default*__: "create_pr"
* **stepName** (string) The name of the step displayed on GitHub. __*Default*__: "Create Pull Request"
* **patch** ([github.PullRequestPatchSource](#projen-github-pullrequestpatchsource)) Information about the patch that is used to create the pull request.
* **jobName** (string) The name of the job displayed on GitHub. __*Default*__: "Create Pull Request"
* **runsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
__Returns__:
* [github.workflows.Job](#projen-github-workflows-job)
## class CiConfiguration ð¹
CI for GitLab.
A CI is a configurable automated process made up of one or more stages/jobs.
__Submodule__: gitlab
__Extends__: [Component](#projen-component)
### Initializer
```ts
new gitlab.CiConfiguration(project: Project, name: string, options?: CiConfigurationOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **name** (string) *No description*
* **options** ([gitlab.CiConfigurationOptions](#projen-gitlab-ciconfigurationoptions)) *No description*
* **default** ([gitlab.Default](#projen-gitlab-default)) Default settings for the CI Configuration. __*Optional*__
* **jobs** (Map) An initial set of jobs to add to the configuration. __*Optional*__
* **pages** ([gitlab.Job](#projen-gitlab-job)) A special job used to upload static sites to Gitlab pages. __*Optional*__
* **stages** (Array) Groups jobs into stages. __*Optional*__
* **variables** (Map) Global variables that are passed to jobs. __*Optional*__
* **workflow** ([gitlab.Workflow](#projen-gitlab-workflow)) Used to control pipeline behavior. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**defaultAfterScript**ð¹ | Array | Defines default scripts that should run *after* all jobs.
**defaultBeforeScript**ð¹ | Array | Defines default scripts that should run *before* all jobs.
**defaultTags**ð¹ | Array | Used to select a specific runner from the list of all runners that are available for the project.
**file**ð¹ | [YamlFile](#projen-yamlfile) | The workflow YAML file.
**jobs**ð¹ | Map | The jobs in the CI configuration.
**name**ð¹ | string | The name of the configuration.
**path**ð¹ | string | Path to CI file generated by the configuration.
**project**ð¹ | [Project](#projen-project) | The project the configuration belongs to.
**stages**ð¹ | Array | Groups jobs into stages.
**variables**ð¹ | Map | Global variables that are passed to jobs.
**defaultArtifacts**?ð¹ | [gitlab.Artifacts](#projen-gitlab-artifacts) | Default list of files and directories that should be attached to the job if it succeeds.
__*Optional*__
**defaultCache**?ð¹ | [gitlab.Cache](#projen-gitlab-cache) | A default list of files and directories to cache between jobs.
__*Optional*__
**defaultImage**?ð¹ | [gitlab.Image](#projen-gitlab-image) | Specifies the default docker image to use globally for all jobs.
__*Optional*__
**defaultInterruptible**?ð¹ | boolean | The default behavior for whether a job should be canceled when a newer pipeline starts before the job completes (Default: false).
__*Optional*__
**defaultRetry**?ð¹ | [gitlab.Retry](#projen-gitlab-retry) | How many times a job is retried if it fails.
__*Optional*__
**defaultTimeout**?ð¹ | string | A default timeout job written in natural language (Ex.
__*Optional*__
**pages**?ð¹ | [gitlab.Job](#projen-gitlab-job) | A special job used to upload static sites to Gitlab pages.
__*Optional*__
**workflow**?ð¹ | [gitlab.Workflow](#projen-gitlab-workflow) | Used to control pipeline behavior.
__*Optional*__
### Methods
#### addGlobalVariables(variables)ð¹
Add a globally defined variable to the CI configuration.
```ts
addGlobalVariables(variables: Map): void
```
* **variables** (Map) The variables to add.
#### addIncludes(...includes)ð¹
Add additional yml/yaml files to the CI includes.
```ts
addIncludes(...includes: Include[]): void
```
* **includes** ([gitlab.Include](#projen-gitlab-include)) The includes to add.
* **file** (Array) Files from another private project on the same GitLab instance. __*Optional*__
* **local** (string) Relative path from local repository root (`/`) to the `yaml`/`yml` file template. __*Optional*__
* **project** (string) Path to the project, e.g. `group/project`, or `group/sub-group/project`. __*Optional*__
* **ref** (string) Branch/Tag/Commit-hash for the target project. __*Optional*__
* **remote** (string) URL to a `yaml`/`yml` template file using HTTP/HTTPS. __*Optional*__
* **rules** (Array<[gitlab.IncludeRule](#projen-gitlab-includerule)>) Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job. __*Optional*__
* **template** (string) Use a `.gitlab-ci.yml` template as a base, e.g. `Nodejs.gitlab-ci.yml`. __*Optional*__
#### addJobs(jobs)ð¹
Add jobs and their stages to the CI configuration.
```ts
addJobs(jobs: Map): void
```
* **jobs** (Map) Jobs to add.
#### addServices(...services)ð¹
Add additional services.
```ts
addServices(...services: Service[]): void
```
* **services** ([gitlab.Service](#projen-gitlab-service)) The services to add.
* **name** (string) Full name of the image that should be used.
* **alias** (string) Additional alias that can be used to access the service from the job's container. __*Optional*__
* **command** (Array) Command or script that should be used as the container's command. __*Optional*__
* **entrypoint** (Array) Command or script that should be executed as the container's entrypoint. __*Optional*__
#### addStages(...stages)ð¹
Add stages to the CI configuration if not already present.
```ts
addStages(...stages: string[]): void
```
* **stages** (string) stages to add.
## class GitlabConfiguration ð¹
A GitLab CI for the main `.gitlab-ci.yml` file.
__Submodule__: gitlab
__Extends__: [gitlab.CiConfiguration](#projen-gitlab-ciconfiguration)
### Initializer
```ts
new gitlab.GitlabConfiguration(project: Project, options?: CiConfigurationOptions)
```
* **project** ([Project](#projen-project)) The project the configuration belongs to.
* **options** ([gitlab.CiConfigurationOptions](#projen-gitlab-ciconfigurationoptions)) *No description*
* **default** ([gitlab.Default](#projen-gitlab-default)) Default settings for the CI Configuration. __*Optional*__
* **jobs** (Map) An initial set of jobs to add to the configuration. __*Optional*__
* **pages** ([gitlab.Job](#projen-gitlab-job)) A special job used to upload static sites to Gitlab pages. __*Optional*__
* **stages** (Array) Groups jobs into stages. __*Optional*__
* **variables** (Map) Global variables that are passed to jobs. __*Optional*__
* **workflow** ([gitlab.Workflow](#projen-gitlab-workflow)) Used to control pipeline behavior. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**nestedTemplates**ð¹ | Map |
### Methods
#### createNestedTemplates(config)ð¹
Creates and adds nested templates to the includes of the main CI.
Additionally adds their stages to the main CI if they are not already present.
You can futher customize nested templates through the `nestedTemplates` property.
E.g. gitlabConfig.nestedTemplates['templateName']?.addStages('stageName')
```ts
createNestedTemplates(config: Map): void
```
* **config** (Map) a record the names and configuraitons of the templates.
## class NestedConfiguration ð¹
A GitLab CI for templates that are created and included in the `.gitlab-ci.yml` file.
__Submodule__: gitlab
__Extends__: [gitlab.CiConfiguration](#projen-gitlab-ciconfiguration)
### Initializer
```ts
new gitlab.NestedConfiguration(project: Project, parent: GitlabConfiguration, name: string, options?: CiConfigurationOptions)
```
* **project** ([Project](#projen-project)) The project the configuration belongs to.
* **parent** ([gitlab.GitlabConfiguration](#projen-gitlab-gitlabconfiguration)) *No description*
* **name** (string) The name of the configuration.
* **options** ([gitlab.CiConfigurationOptions](#projen-gitlab-ciconfigurationoptions)) *No description*
* **default** ([gitlab.Default](#projen-gitlab-default)) Default settings for the CI Configuration. __*Optional*__
* **jobs** (Map) An initial set of jobs to add to the configuration. __*Optional*__
* **pages** ([gitlab.Job](#projen-gitlab-job)) A special job used to upload static sites to Gitlab pages. __*Optional*__
* **stages** (Array) Groups jobs into stages. __*Optional*__
* **variables** (Map) Global variables that are passed to jobs. __*Optional*__
* **workflow** ([gitlab.Workflow](#projen-gitlab-workflow)) Used to control pipeline behavior. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**parent**ð¹ | [gitlab.GitlabConfiguration](#projen-gitlab-gitlabconfiguration) |
## class JavaProject ð¹
Java project.
__Submodule__: java
__Extends__: [github.GitHubProject](#projen-github-githubproject)
### Initializer
```ts
new java.JavaProject(options: JavaProjectOptions)
```
* **options** ([java.JavaProjectOptions](#projen-java-javaprojectoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **artifactId** (string) The artifactId is generally the name that the project is known by.
* **groupId** (string) This is generally unique amongst an organization or a project.
* **version** (string) This is the last piece of the naming puzzle.
* **description** (string) Description of a project is always good. __*Default*__: undefined
* **packaging** (string) Project packaging format. __*Default*__: "jar"
* **url** (string) The URL, like the name, is not required. __*Default*__: undefined
* **compileOptions** ([java.MavenCompileOptions](#projen-java-mavencompileoptions)) Compile options. __*Default*__: defaults
* **deps** (Array) List of runtime dependencies for this project. __*Default*__: []
* **distdir** (string) Final artifact output directory. __*Default*__: "dist/java"
* **junit** (boolean) Include junit tests. __*Default*__: true
* **junitOptions** ([java.JunitOptions](#projen-java-junitoptions)) junit options. __*Default*__: defaults
* **packagingOptions** ([java.MavenPackagingOptions](#projen-java-mavenpackagingoptions)) Packaging options. __*Default*__: defaults
* **projenrcJava** (boolean) Use projenrc in java. __*Default*__: true
* **projenrcJavaOptions** ([java.ProjenrcOptions](#projen-java-projenrcoptions)) Options related to projenrc in java. __*Default*__: default options
* **testDeps** (Array) List of test dependencies for this project. __*Default*__: []
* **sample** (boolean) Include sample code and test if the relevant directories don't exist. __*Default*__: true
* **sampleJavaPackage** (string) The java package to use for the code sample. __*Default*__: "org.acme"
### Properties
Name | Type | Description
-----|------|-------------
**compile**ð¹ | [java.MavenCompile](#projen-java-mavencompile) | Compile component.
**distdir**ð¹ | string | Maven artifact output directory.
**packaging**ð¹ | [java.MavenPackaging](#projen-java-mavenpackaging) | Packaging component.
**pom**ð¹ | [java.Pom](#projen-java-pom) | API for managing `pom.xml`.
**junit**?ð¹ | [java.Junit](#projen-java-junit) | JUnit component.
__*Optional*__
**projenrc**?ð¹ | [java.Projenrc](#projen-java-projenrc) | Projenrc component.
__*Optional*__
### Methods
#### addDependency(spec)ð¹
Adds a runtime dependency.
```ts
addDependency(spec: string): void
```
* **spec** (string) Format `/@`.
#### addPlugin(spec, options?)ð¹
Adds a build plugin to the pom.
The plug in is also added as a BUILD dep to the project.
```ts
addPlugin(spec: string, options?: PluginOptions): Dependency
```
* **spec** (string) dependency spec (`group/artifact@version`).
* **options** ([java.PluginOptions](#projen-java-pluginoptions)) plugin options.
* **configuration** (Map) Plugin key/value configuration. __*Default*__: {}
* **dependencies** (Array) You could configure the dependencies for the plugin. __*Default*__: []
* **executions** (Array<[java.PluginExecution](#projen-java-pluginexecution)>) Plugin executions. __*Default*__: []
__Returns__:
* [Dependency](#projen-dependency)
#### addTestDependency(spec)ð¹
Adds a test dependency.
```ts
addTestDependency(spec: string): void
```
* **spec** (string) Format `/@`.
## class Junit ð¹
Implements JUnit-based testing.
__Submodule__: java
__Extends__: [Component](#projen-component)
### Initializer
```ts
new java.Junit(project: Project, options: JunitOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([java.JunitOptions](#projen-java-junitoptions)) *No description*
* **pom** ([java.Pom](#projen-java-pom)) Java pom.
* **sampleJavaPackage** (string) Java package for test sample. __*Default*__: "org.acme"
* **version** (string) Junit version. __*Default*__: "5.7.0"
## class MavenCompile ð¹
Adds the maven-compiler plugin to a POM file and the `compile` task.
__Submodule__: java
__Extends__: [Component](#projen-component)
### Initializer
```ts
new java.MavenCompile(project: Project, pom: Pom, options?: MavenCompileOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **pom** ([java.Pom](#projen-java-pom)) *No description*
* **options** ([java.MavenCompileOptions](#projen-java-mavencompileoptions)) *No description*
* **source** (string) Source language version. __*Default*__: "1.8"
* **target** (string) Target JVM version. __*Default*__: "1.8"
## class MavenPackaging ð¹
Configures a maven project to produce a .jar archive with sources and javadocs.
__Submodule__: java
__Extends__: [Component](#projen-component)
### Initializer
```ts
new java.MavenPackaging(project: Project, pom: Pom, options?: MavenPackagingOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **pom** ([java.Pom](#projen-java-pom)) *No description*
* **options** ([java.MavenPackagingOptions](#projen-java-mavenpackagingoptions)) *No description*
* **distdir** (string) Where to place the package output? __*Default*__: "dist/java"
* **javadocs** (boolean) Include javadocs jar in package. __*Default*__: true
* **javadocsExclude** (Array) Exclude source files from docs. __*Default*__: []
* **sources** (boolean) Include sources jar in package. __*Default*__: true
### Properties
Name | Type | Description
-----|------|-------------
**distdir**ð¹ | string | The directory containing the package output, relative to the project outdir.
## class MavenSample ð¹
Java code sample.
__Submodule__: java
__Extends__: [Component](#projen-component)
### Initializer
```ts
new java.MavenSample(project: Project, options: MavenSampleOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([java.MavenSampleOptions](#projen-java-mavensampleoptions)) *No description*
* **package** (string) Project root java package.
## class Pom ð¹
A Project Object Model or POM is the fundamental unit of work in Maven.
It is
an XML file that contains information about the project and configuration
details used by Maven to build the project.
__Submodule__: java
__Extends__: [Component](#projen-component)
### Initializer
```ts
new java.Pom(project: Project, options: PomOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([java.PomOptions](#projen-java-pomoptions)) *No description*
* **artifactId** (string) The artifactId is generally the name that the project is known by.
* **groupId** (string) This is generally unique amongst an organization or a project.
* **version** (string) This is the last piece of the naming puzzle.
* **description** (string) Description of a project is always good. __*Default*__: undefined
* **packaging** (string) Project packaging format. __*Default*__: "jar"
* **url** (string) The URL, like the name, is not required. __*Default*__: undefined
### Properties
Name | Type | Description
-----|------|-------------
**artifactId**ð¹ | string | Maven artifact ID.
**fileName**ð¹ | string | The name of the pom file.
**groupId**ð¹ | string | Maven group ID.
**packaging**ð¹ | string | Maven packaging format.
**version**ð¹ | string | Project version.
**description**?ð¹ | string | Project description.
__*Optional*__
**name**?ð¹ | string | Project display name.
__*Optional*__
**url**?ð¹ | string | Project URL.
__*Optional*__
### Methods
#### addDependency(spec)ð¹
Adds a runtime dependency.
```ts
addDependency(spec: string): void
```
* **spec** (string) Format `/@`.
#### addPlugin(spec, options?)ð¹
Adds a build plugin to the pom.
The plug in is also added as a BUILD dep to the project.
```ts
addPlugin(spec: string, options?: PluginOptions): Dependency
```
* **spec** (string) dependency spec (`group/artifact@version`).
* **options** ([java.PluginOptions](#projen-java-pluginoptions)) plugin options.
* **configuration** (Map) Plugin key/value configuration. __*Default*__: {}
* **dependencies** (Array) You could configure the dependencies for the plugin. __*Default*__: []
* **executions** (Array<[java.PluginExecution](#projen-java-pluginexecution)>) Plugin executions. __*Default*__: []
__Returns__:
* [Dependency](#projen-dependency)
#### addProperty(key, value)ð¹
Adds a key/value property to the pom.
```ts
addProperty(key: string, value: string): void
```
* **key** (string) the key.
* **value** (string) the value.
#### addRepository(repository)ð¹
Adds a repository to the pom.
```ts
addRepository(repository: MavenRepository): void
```
* **repository** ([java.MavenRepository](#projen-java-mavenrepository)) the repository to add.
* **id** (string) The identifier for the repository.
* **url** (string) The url of the repository.
* **layout** (string) The layout of the repository. __*Optional*__
* **name** (string) The name of the repository. __*Optional*__
#### addTestDependency(spec)ð¹
Adds a test dependency.
```ts
addTestDependency(spec: string): void
```
* **spec** (string) Format `/@`.
## class Projenrc ð¹
Allows writing projenrc files in java.
This will install `org.projen/projen` as a Maven dependency and will add a
`synth` task which will compile & execute `main()` from
`src/main/java/projenrc.java`.
__Submodule__: java
__Extends__: [ProjenrcFile](#projen-projenrcfile)
### Initializer
```ts
new java.Projenrc(project: Project, pom: Pom, options?: ProjenrcOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **pom** ([java.Pom](#projen-java-pom)) *No description*
* **options** ([java.ProjenrcOptions](#projen-java-projenrcoptions)) *No description*
* **className** (string) The name of the Java class which contains the `main()` method for projen. __*Default*__: "projenrc"
* **projenVersion** (string) The projen version to use. __*Default*__: current version
* **testScope** (boolean) Defines projenrc under the test scope instead of the main scope, which is reserved to the app. __*Default*__: true
### Properties
Name | Type | Description
-----|------|-------------
**className**ð¹ | string | The name of the java class that includes the projen entrypoint.
**filePath**ð¹ | string | The path of the projenrc file.
## class Bundler ð¹
Adds support for bundling JavaScript applications and dependencies into a single file.
In the future, this will also supports bundling websites.
__Submodule__: javascript
__Extends__: [Component](#projen-component)
### Initializer
Creates a `Bundler`.
```ts
new javascript.Bundler(project: Project, options?: BundlerOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) *No description*
* **addToPreCompile** (boolean) Install the `bundle` command as a pre-compile phase. __*Default*__: true
* **assetsDir** (string) Output directory for all bundles. __*Default*__: "assets"
* **esbuildVersion** (string) The semantic version requirement for `esbuild`. __*Default*__: no specific version (implies latest)
* **loaders** (Map) Map of file extensions (without dot) and loaders to use for this file type. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**bundleTask**ð¹ | [Task](#projen-task) | Gets or creates the singleton "bundle" task of the project.
**bundledir**ð¹ | string | Root bundle directory.
**esbuildVersion**?ð¹ | string | The semantic version requirement for `esbuild` (if defined).
__*Optional*__
### Methods
#### addBundle(entrypoint, options)ð¹
Adds a task to the project which bundles a specific entrypoint and all of its dependencies into a single javascript output file.
```ts
addBundle(entrypoint: string, options: AddBundleOptions): Bundle
```
* **entrypoint** (string) The relative path of the artifact within the project.
* **options** ([javascript.AddBundleOptions](#projen-javascript-addbundleoptions)) Bundling options.
* **externals** (Array) You can mark a file or a package as external to exclude it from your build. __*Default*__: []
* **sourcemap** (boolean) Include a source map in the bundle. __*Default*__: false
* **watchTask** (boolean) In addition to the `bundle:xyz` task, creates `bundle:xyz:watch` task which will invoke the same esbuild command with the `--watch` flag. __*Default*__: true
* **platform** (string) esbuild platform.
* **target** (string) esbuild target.
* **executable** (boolean) Mark the output file as executable. __*Default*__: false
* **loaders** (Map) Map of file extensions (without dot) and loaders to use for this file type. __*Optional*__
* **outfile** (string) Bundler output path relative to the asset's output directory. __*Default*__: "index.js"
* **tsconfigPath** (string) The path of the tsconfig.json file to use for bundling. __*Default*__: "tsconfig.json"
__Returns__:
* [javascript.Bundle](#projen-javascript-bundle)
#### *static* of(project)ð¹
Returns the `Bundler` instance associated with a project or `undefined` if there is no Bundler.
```ts
static of(project: Project): Bundler
```
* **project** ([Project](#projen-project)) The project.
__Returns__:
* [javascript.Bundler](#projen-javascript-bundler)
## class Eslint ð¹
Represents eslint configuration.
__Submodule__: javascript
__Extends__: [Component](#projen-component)
### Initializer
```ts
new javascript.Eslint(project: NodeProject, options: EslintOptions)
```
* **project** ([javascript.NodeProject](#projen-javascript-nodeproject)) *No description*
* **options** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) *No description*
* **dirs** (Array) Files or glob patterns or directories with source files to lint (e.g. [ "src" ]).
* **aliasExtensions** (Array) Enable import alias for module paths. __*Default*__: undefined
* **aliasMap** (Map) Enable import alias for module paths. __*Default*__: undefined
* **devdirs** (Array) Files or glob patterns or directories with source files that include tests and build tools. __*Default*__: []
* **fileExtensions** (Array) File types that should be linted (e.g. [ ".js", ".ts" ]). __*Default*__: [".ts"]
* **ignorePatterns** (Array) List of file patterns that should not be linted, using the same syntax as .gitignore patterns. __*Default*__: [ '*.js', '*.d.ts', 'node_modules/', '*.generated.ts', 'coverage' ]
* **lintProjenRc** (boolean) Should we lint .projenrc.js. __*Default*__: true
* **lintProjenRcFile** (string) Projenrc file to lint. __*Default*__: PROJEN_RC
* **prettier** (boolean) Enable prettier for code formatting. __*Default*__: false
* **tsAlwaysTryTypes** (boolean) Always try to resolve types under `@types` directory even it doesn't contain any source code. __*Default*__: true
* **tsconfigPath** (string) Path to `tsconfig.json` which should be used by eslint. __*Default*__: "./tsconfig.json"
* **yaml** (boolean) Write eslint configuration as YAML instead of JSON. __*Default*__: false
### Properties
Name | Type | Description
-----|------|-------------
**config**ð¹ | any | Direct access to the eslint configuration (escape hatch).
**eslintTask**ð¹ | [Task](#projen-task) | eslint task.
**ignorePatterns**ð¹ | Array | File patterns that should not be linted.
**overrides**ð¹ | Array<[javascript.EslintOverride](#projen-javascript-eslintoverride)> | eslint overrides.
**rules**ð¹ | Map> | eslint rules.
### Methods
#### addExtends(...extendList)ð¹
Adds an `extends` item to the eslint configuration.
```ts
addExtends(...extendList: string[]): void
```
* **extendList** (string) The list of "extends" to add.
#### addIgnorePattern(pattern)ð¹
Do not lint these files.
```ts
addIgnorePattern(pattern: string): void
```
* **pattern** (string) *No description*
#### addLintPattern(pattern)ð¹
Add a file, glob pattern or directory with source files to lint (e.g. [ "src" ]).
```ts
addLintPattern(pattern: string): void
```
* **pattern** (string) *No description*
#### addOverride(override)ð¹
Add an eslint override.
```ts
addOverride(override: EslintOverride): void
```
* **override** ([javascript.EslintOverride](#projen-javascript-eslintoverride)) *No description*
* **files** (Array) Files or file patterns on which to apply the override.
* **parser** (string) The overridden parser. __*Optional*__
* **rules** (Map) The overriden rules. __*Optional*__
#### addPlugins(...plugins)ð¹
Adds an eslint plugin.
```ts
addPlugins(...plugins: string[]): void
```
* **plugins** (string) The names of plugins to add.
#### addRules(rules)ð¹
Add an eslint rule.
```ts
addRules(rules: Map): void
```
* **rules** (Map) *No description*
#### allowDevDeps(pattern)ð¹
Add a glob file pattern which allows importing dev dependencies.
```ts
allowDevDeps(pattern: string): void
```
* **pattern** (string) glob pattern.
#### *static* of(project)ð¹
Returns the singletone Eslint component of a project or undefined if there is none.
```ts
static of(project: Project): Eslint
```
* **project** ([Project](#projen-project)) *No description*
__Returns__:
* [javascript.Eslint](#projen-javascript-eslint)
## class Jest ð¹
Installs the following npm scripts:.
- `test`, intended for testing locally and in CI. Will update snapshots unless `updateSnapshot: UpdateSnapshot: NEVER` is set.
- `test:watch`, intended for automatically rerunning tests when files change.
- `test:update`, intended for testing locally and updating snapshots to match the latest unit under test. Only available when `updateSnapshot: UpdateSnapshot: NEVER`.
__Submodule__: javascript
__Extends__: [Component](#projen-component)
### Initializer
```ts
new javascript.Jest(project: NodeProject, options?: JestOptions)
```
* **project** ([javascript.NodeProject](#projen-javascript-nodeproject)) *No description*
* **options** ([javascript.JestOptions](#projen-javascript-jestoptions)) *No description*
* **configFilePath** (string) Path to JSON config file for Jest. __*Default*__: No separate config file, jest settings are stored in package.json
* **coverage** (boolean) Collect coverage. __*Default*__: true
* **coverageText** (boolean) Include the `text` coverage reporter, which means that coverage summary is printed at the end of the jest execution. __*Default*__: true
* **extraCliOptions** (Array) Additional options to pass to the Jest CLI invocation. __*Default*__: no extra options
* **ignorePatterns** (Array) Defines `testPathIgnorePatterns` and `coveragePathIgnorePatterns`. __*Default*__: ["/node_modules/"]
* **jestConfig** ([javascript.JestConfigOptions](#projen-javascript-jestconfigoptions)) Jest configuration. __*Default*__: default jest configuration
* **jestVersion** (string) The version of jest to use. __*Default*__: installs the latest jest version
* **junitReporting** (boolean) Result processing with jest-junit. __*Default*__: true
* **preserveDefaultReporters** (boolean) Preserve the default Jest reporter when additional reporters are added. __*Default*__: true
* **updateSnapshot** ([javascript.UpdateSnapshot](#projen-javascript-updatesnapshot)) Whether to update snapshots in task "test" (which is executed in task "build" and build workflows), or create a separate task "test:update" for updating snapshots. __*Default*__: ALWAYS
### Properties
Name | Type | Description
-----|------|-------------
**config**ð¹ | any | Escape hatch.
**jestVersion**ð¹ | string | Jest version, including `@` symbol, like `@^29`.
**file**?ð¹ | [JsonFile](#projen-jsonfile) | Jest config file.
__*Optional*__
### Methods
#### addIgnorePattern(pattern)ð¹
```ts
addIgnorePattern(pattern: string): void
```
* **pattern** (string) *No description*
#### addReporter(reporter)ð¹
```ts
addReporter(reporter: JestReporter): void
```
* **reporter** ([javascript.JestReporter](#projen-javascript-jestreporter)) *No description*
#### addSetupFile(file)ð¹
Adds a a setup file to Jest's setupFiles configuration.
```ts
addSetupFile(file: string): void
```
* **file** (string) File path to setup file.
#### addSetupFileAfterEnv(file)ð¹
Adds a a setup file to Jest's setupFilesAfterEnv configuration.
```ts
addSetupFileAfterEnv(file: string): void
```
* **file** (string) File path to setup file.
#### addSnapshotResolver(file)ð¹
```ts
addSnapshotResolver(file: string): void
```
* **file** (string) *No description*
#### addTestMatch(pattern)ð¹
Adds a test match pattern.
```ts
addTestMatch(pattern: string): void
```
* **pattern** (string) glob pattern to match for tests.
#### addWatchIgnorePattern(pattern)ð¹
Adds a watch ignore pattern.
```ts
addWatchIgnorePattern(pattern: string): void
```
* **pattern** (string) The pattern (regular expression).
#### *static* of(project)ð¹
Returns the singletone Jest component of a project or undefined if there is none.
```ts
static of(project: Project): Jest
```
* **project** ([Project](#projen-project)) *No description*
__Returns__:
* [javascript.Jest](#projen-javascript-jest)
## class JestReporter ð¹
__Submodule__: javascript
### Initializer
```ts
new javascript.JestReporter(name: string, options?: Map)
```
* **name** (string) *No description*
* **options** (Map) *No description*
## class NodePackage ð¹
Represents the npm `package.json` file.
__Submodule__: javascript
__Extends__: [Component](#projen-component)
### Initializer
```ts
new javascript.NodePackage(project: Project, options?: NodePackageOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([javascript.NodePackageOptions](#projen-javascript-nodepackageoptions)) *No description*
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**allowLibraryDependencies**ð¹ | boolean | Allow project to take library dependencies.
**entrypoint**ð¹ | string | The module's entrypoint (e.g. `lib/index.js`).
**file**ð¹ | [JsonFile](#projen-jsonfile) | The package.json file.
**installAndUpdateLockfileCommand**ð¹ | string | Renders `yarn install` or `npm install` with lockfile update (not frozen).
**installCiTask**ð¹ | [Task](#projen-task) | The task for installing project dependencies (frozen).
**installCommand**ð¹ | string | Returns the command to execute in order to install all dependencies (always frozen).
**installTask**ð¹ | [Task](#projen-task) | The task for installing project dependencies (non-frozen).
**lockFile**ð¹ | string | The name of the lock file.
**manifest**â ïž | any |
**npmAccess**ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | npm package access level.
**npmRegistry**ð¹ | string | The npm registry host (e.g. `registry.npmjs.org`).
**npmRegistryUrl**ð¹ | string | npm registry (e.g. `https://registry.npmjs.org`). Use `npmRegistryHost` to get just the host name.
**packageManager**ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The package manager to use.
**packageName**ð¹ | string | The name of the npm package.
**projenCommand**ð¹ | string | The command which executes "projen".
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**license**?ð¹ | string | The SPDX license of this module.
__*Optional*__
**maxNodeVersion**?ð¹ | string | Maximum node version required by this package.
__*Default*__: no maximum.
**minNodeVersion**?ð¹ | string | Minimum node.js version required by this package.
__*Default*__: no minimum
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Optional*__
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: undefined
### Methods
#### addBin(bins)ð¹
```ts
addBin(bins: Map): void
```
* **bins** (Map) *No description*
#### addBundledDeps(...deps)ð¹
Defines bundled dependencies.
Bundled dependencies will be added as normal dependencies as well as to the
`bundledDependencies` section of your `package.json`.
```ts
addBundledDeps(...deps: string[]): void
```
* **deps** (string) Names modules to install.
#### addDeps(...deps)ð¹
Defines normal dependencies.
```ts
addDeps(...deps: string[]): void
```
* **deps** (string) Names modules to install.
#### addDevDeps(...deps)ð¹
Defines development/test dependencies.
```ts
addDevDeps(...deps: string[]): void
```
* **deps** (string) Names modules to install.
#### addEngine(engine, version)ð¹
Adds an `engines` requirement to your package.
```ts
addEngine(engine: string, version: string): void
```
* **engine** (string) The engine (e.g. `node`).
* **version** (string) The semantic version requirement (e.g. `^10`).
#### addField(name, value)ð¹
Directly set fields in `package.json`.
```ts
addField(name: string, value: any): void
```
* **name** (string) field name.
* **value** (any) field value.
#### addKeywords(...keywords)ð¹
Adds keywords to package.json (deduplicated).
```ts
addKeywords(...keywords: string[]): void
```
* **keywords** (string) The keywords to add.
#### addPackageResolutions(...resolutions)ð¹
Defines resolutions for dependencies to change the normally resolved version of a dependency to something else.
```ts
addPackageResolutions(...resolutions: string[]): void
```
* **resolutions** (string) Names resolutions to be added.
#### addPeerDeps(...deps)ð¹
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.
```ts
addPeerDeps(...deps: string[]): void
```
* **deps** (string) Names modules to install.
#### addVersion(version)ð¹
Sets the package version.
```ts
addVersion(version: string): void
```
* **version** (string) Package version.
#### hasScript(name)â ïž
Indicates if a script by the given name is defined.
```ts
hasScript(name: string): boolean
```
* **name** (string) The name of the script.
__Returns__:
* boolean
#### postSynthesize()ð¹
Called after synthesis.
Order is *not* guaranteed.
```ts
postSynthesize(): void
```
#### preSynthesize()ð¹
Called before synthesis.
```ts
preSynthesize(): void
```
#### removeScript(name)ð¹
Removes an npm script (always successful).
```ts
removeScript(name: string): void
```
* **name** (string) The name of the script.
#### renderUpgradePackagesCommand(exclude, include?)ð¹
Render a package manager specific command to upgrade all requested dependencies.
```ts
renderUpgradePackagesCommand(exclude: Array, include?: Array): string
```
* **exclude** (Array) *No description*
* **include** (Array) *No description*
__Returns__:
* string
#### setScript(name, command)ð¹
Add a npm package.json script.
```ts
setScript(name: string, command: string): void
```
* **name** (string) The script name.
* **command** (string) The command to execute.
#### tryResolveDependencyVersion(dependencyName)ð¹
Attempt to resolve the currently installed version for a given dependency.
```ts
tryResolveDependencyVersion(dependencyName: string): string
```
* **dependencyName** (string) Dependency to resolve for.
__Returns__:
* string
## class NodeProject ð¹
Node.js project.
__Submodule__: javascript
__Extends__: [github.GitHubProject](#projen-github-githubproject)
### Initializer
```ts
new javascript.NodeProject(options: NodeProjectOptions)
```
* **options** ([javascript.NodeProjectOptions](#projen-javascript-nodeprojectoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
### Properties
Name | Type | Description
-----|------|-------------
**allowLibraryDependencies**â ïž | boolean |
**artifactsDirectory**ð¹ | string | The build output directory.
**artifactsJavascriptDirectory**ð¹ | string | The location of the npm tarball after build (`${artifactsDirectory}/js`).
**bundler**ð¹ | [javascript.Bundler](#projen-javascript-bundler) |
**entrypoint**â ïž | string |
**manifest**â ïž | any |
**npmrc**ð¹ | [javascript.NpmConfig](#projen-javascript-npmconfig) | The .npmrc file.
**package**ð¹ | [javascript.NodePackage](#projen-javascript-nodepackage) | API for managing the node package.
**packageManager**â ïž | [javascript.NodePackageManager](#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).
**workflowBootstrapSteps**ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> |
**workflowPackageCache**ð¹ | boolean |
**autoMerge**?ð¹ | [github.AutoMerge](#projen-github-automerge) | Component that sets up mergify for merging approved pull requests.
__*Optional*__
**buildWorkflow**?ð¹ | [build.BuildWorkflow](#projen-build-buildworkflow) | The PR build GitHub workflow.
__*Optional*__
**buildWorkflowJobId**?ð¹ | string | The job ID of the build workflow.
__*Optional*__
**jest**?ð¹ | [javascript.Jest](#projen-javascript-jest) | The Jest configuration (if enabled).
__*Optional*__
**maxNodeVersion**?ð¹ | string | Maximum node version required by this package.
__*Optional*__
**minNodeVersion**?ð¹ | string | Minimum node.js version required by this package.
__*Optional*__
**nodeVersion**?ð¹ | string | __*Optional*__
**npmignore**?ð¹ | [IgnoreFile](#projen-ignorefile) | The .npmignore file.
__*Optional*__
**prettier**?ð¹ | [javascript.Prettier](#projen-javascript-prettier) | __*Optional*__
**publisher**?â ïž | [release.Publisher](#projen-release-publisher) | Package publisher.
__*Optional*__
**release**?ð¹ | [release.Release](#projen-release-release) | Release management.
__*Optional*__
**upgradeWorkflow**?ð¹ | [javascript.UpgradeDependencies](#projen-javascript-upgradedependencies) | The upgrade workflow.
__*Optional*__
### Methods
#### addBins(bins)ð¹
```ts
addBins(bins: Map): void
```
* **bins** (Map) *No description*
#### addBundledDeps(...deps)ð¹
Defines bundled dependencies.
Bundled dependencies will be added as normal dependencies as well as to the
`bundledDependencies` section of your `package.json`.
```ts
addBundledDeps(...deps: string[]): void
```
* **deps** (string) Names modules to install.
#### addCompileCommand(...commands)â ïž
DEPRECATED.
```ts
addCompileCommand(...commands: string[]): void
```
* **commands** (string) *No description*
#### addDeps(...deps)ð¹
Defines normal dependencies.
```ts
addDeps(...deps: string[]): void
```
* **deps** (string) Names modules to install.
#### addDevDeps(...deps)ð¹
Defines development/test dependencies.
```ts
addDevDeps(...deps: string[]): void
```
* **deps** (string) Names modules to install.
#### addFields(fields)ð¹
Directly set fields in `package.json`.
```ts
addFields(fields: Map): void
```
* **fields** (Map) The fields to set.
#### addKeywords(...keywords)ð¹
Adds keywords to package.json (deduplicated).
```ts
addKeywords(...keywords: string[]): void
```
* **keywords** (string) The keywords to add.
#### addPackageIgnore(pattern)ð¹
Exclude these files from the bundled package.
Implemented by project types based on the
packaging mechanism. For example, `NodeProject` delegates this to `.npmignore`.
```ts
addPackageIgnore(pattern: string): void
```
* **pattern** (string) *No description*
#### addPeerDeps(...deps)ð¹
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.
```ts
addPeerDeps(...deps: string[]): void
```
* **deps** (string) Names modules to install.
#### addScripts(scripts)ð¹
Replaces the contents of multiple npm package.json scripts.
```ts
addScripts(scripts: Map): void
```
* **scripts** (Map) The scripts to set.
#### addTestCommand(...commands)â ïž
DEPRECATED.
```ts
addTestCommand(...commands: string[]): void
```
* **commands** (string) *No description*
#### hasScript(name)â ïž
Indicates if a script by the name name is defined.
```ts
hasScript(name: string): boolean
```
* **name** (string) The name of the script.
__Returns__:
* boolean
#### removeScript(name)ð¹
Removes the npm script (always successful).
```ts
removeScript(name: string): void
```
* **name** (string) The name of the script.
#### renderWorkflowSetup(options?)ð¹
Returns the set of workflow steps which should be executed to bootstrap a workflow.
```ts
renderWorkflowSetup(options?: RenderWorkflowSetupOptions): Array
```
* **options** ([javascript.RenderWorkflowSetupOptions](#projen-javascript-renderworkflowsetupoptions)) Options.
* **mutable** (boolean) Should the pacakge lockfile be updated? __*Default*__: false
__Returns__:
* Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>
#### runTaskCommand(task)ð¹
Returns the shell command to execute in order to run a task.
This will
typically be `npx projen TASK`.
```ts
runTaskCommand(task: Task): string
```
* **task** ([Task](#projen-task)) The task for which the command is required.
__Returns__:
* string
#### setScript(name, command)ð¹
Replaces the contents of an npm package.json script.
```ts
setScript(name: string, command: string): void
```
* **name** (string) The script name.
* **command** (string) The command to execute.
## class NpmConfig ð¹
File representing the local NPM config in .npmrc.
__Submodule__: javascript
__Extends__: [Component](#projen-component)
### Initializer
```ts
new javascript.NpmConfig(project: NodeProject, options?: NpmConfigOptions)
```
* **project** ([javascript.NodeProject](#projen-javascript-nodeproject)) *No description*
* **options** ([javascript.NpmConfigOptions](#projen-javascript-npmconfigoptions)) *No description*
* **omitEmpty** (boolean) Omits empty objects and arrays. __*Default*__: false
* **registry** (string) URL of the registry mirror to use. __*Default*__: use npmjs default registry
### Methods
#### addConfig(name, value)ð¹
configure a generic property.
```ts
addConfig(name: string, value: string): void
```
* **name** (string) the name of the property.
* **value** (string) the value of the property.
#### addRegistry(url, scope?)ð¹
configure a scoped registry.
```ts
addRegistry(url: string, scope?: string): void
```
* **url** (string) the URL of the registry to use.
* **scope** (string) the scope the registry is used for;
## class Prettier ð¹
Represents prettier configuration.
__Submodule__: javascript
__Extends__: [Component](#projen-component)
### Initializer
```ts
new javascript.Prettier(project: NodeProject, options: PrettierOptions)
```
* **project** ([javascript.NodeProject](#projen-javascript-nodeproject)) *No description*
* **options** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) *No description*
* **ignoreFile** (boolean) Defines an .prettierIgnore file. __*Default*__: true
* **ignoreFileOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .prettierignore file. __*Optional*__
* **overrides** (Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)>) Provide a list of patterns to override prettier configuration. __*Default*__: []
* **settings** ([javascript.PrettierSettings](#projen-javascript-prettiersettings)) Prettier settings. __*Default*__: default settings
* **yaml** (boolean) Write prettier configuration as YAML instead of JSON. __*Default*__: false
### Properties
Name | Type | Description
-----|------|-------------
**overrides**ð¹ | Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)> | Returns all Prettier overrides.
**settings**ð¹ | [javascript.PrettierSettings](#projen-javascript-prettiersettings) | Direct access to the prettier settings.
**ignoreFile**?ð¹ | [IgnoreFile](#projen-ignorefile) | The .prettierIgnore file.
__*Optional*__
### Methods
#### addIgnorePattern(pattern)ð¹
Defines Prettier ignore Patterns these patterns will be added to the file .prettierignore.
```ts
addIgnorePattern(pattern: string): void
```
* **pattern** (string) filepatterns so exclude from prettier formatting.
#### addOverride(override)ð¹
Add a prettier override.
```ts
addOverride(override: PrettierOverride): void
```
* **override** ([javascript.PrettierOverride](#projen-javascript-prettieroverride)) *No description*
* **files** (string | Array) Include these files in this override.
* **options** ([javascript.PrettierSettings](#projen-javascript-prettiersettings)) The options to apply for this override.
* **excludeFiles** (string | Array) Exclude these files from this override. __*Optional*__
#### preSynthesize()ð¹
Called before synthesis.
```ts
preSynthesize(): void
```
#### *static* of(project)ð¹
```ts
static of(project: Project): Prettier
```
* **project** ([Project](#projen-project)) *No description*
__Returns__:
* [javascript.Prettier](#projen-javascript-prettier)
## class Projenrc ð¹
Sets up a javascript project to use TypeScript for projenrc.
__Submodule__: javascript
__Extends__: [ProjenrcFile](#projen-projenrcfile)
### Initializer
```ts
new javascript.Projenrc(project: Project, options?: ProjenrcOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) *No description*
* **filename** (string) The name of the projenrc file. __*Default*__: ".projenrc.js"
### Properties
Name | Type | Description
-----|------|-------------
**filePath**ð¹ | string | The path of the projenrc file.
### Methods
#### preSynthesize()ð¹
Called before synthesis.
```ts
preSynthesize(): void
```
## class Transform ð¹
__Submodule__: javascript
### Initializer
```ts
new javascript.Transform(name: string, options?: any)
```
* **name** (string) *No description*
* **options** (any) *No description*
## class TypescriptConfig ð¹
__Submodule__: javascript
__Extends__: [Component](#projen-component)
### Initializer
```ts
new javascript.TypescriptConfig(project: Project, options: TypescriptConfigOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) *No description*
* **compilerOptions** ([javascript.TypeScriptCompilerOptions](#projen-javascript-typescriptcompileroptions)) Compiler options to use.
* **exclude** (Array) Filters results from the "include" option. __*Default*__: node_modules is excluded by default
* **extends** ([javascript.TypescriptConfigExtends](#projen-javascript-typescriptconfigextends)) Base `tsconfig.json` configuration(s) to inherit from. __*Optional*__
* **fileName** (string) *No description* __*Default*__: "tsconfig.json"
* **include** (Array) Specifies a list of glob patterns that match TypeScript files to be included in compilation. __*Default*__: all .ts files recursively
### Properties
Name | Type | Description
-----|------|-------------
**compilerOptions**ð¹ | [javascript.TypeScriptCompilerOptions](#projen-javascript-typescriptcompileroptions) |
**exclude**ð¹ | Array |
**extends**ð¹ | Array | Array of base `tsconfig.json` paths. Any absolute paths are resolved relative to this instance, while any relative paths are used as is.
**file**ð¹ | [JsonFile](#projen-jsonfile) |
**fileName**ð¹ | string |
**include**ð¹ | Array |
### Methods
#### addExclude(pattern)ð¹
```ts
addExclude(pattern: string): void
```
* **pattern** (string) *No description*
#### addExtends(value)ð¹
Extend from base `TypescriptConfig` instance.
```ts
addExtends(value: TypescriptConfig): void
```
* **value** ([javascript.TypescriptConfig](#projen-javascript-typescriptconfig)) Base `TypescriptConfig` instance.
#### addInclude(pattern)ð¹
```ts
addInclude(pattern: string): void
```
* **pattern** (string) *No description*
#### preSynthesize()ð¹
Called before synthesis.
```ts
preSynthesize(): void
```
#### resolveExtendsPath(configPath)ð¹
Resolve valid TypeScript extends paths relative to this config.
```ts
resolveExtendsPath(configPath: string): string
```
* **configPath** (string) Path to resolve against.
__Returns__:
* string
## class TypescriptConfigExtends ð¹
Container for `TypescriptConfig` `tsconfig.json` base configuration(s). Extending from more than one base config file requires TypeScript 5.0+.
__Submodule__: javascript
### Methods
#### toJSON()ð¹
```ts
toJSON(): Array
```
__Returns__:
* Array
#### *static* fromPaths(paths)ð¹
Factory for creation from array of file paths.
```ts
static fromPaths(paths: Array): TypescriptConfigExtends
```
* **paths** (Array) Absolute or relative paths to base `tsconfig.json` files.
__Returns__:
* [javascript.TypescriptConfigExtends](#projen-javascript-typescriptconfigextends)
#### *static* fromTypescriptConfigs(configs)ð¹
Factory for creation from array of other `TypescriptConfig` instances.
```ts
static fromTypescriptConfigs(configs: Array): TypescriptConfigExtends
```
* **configs** (Array<[javascript.TypescriptConfig](#projen-javascript-typescriptconfig)>) Base `TypescriptConfig` instances.
__Returns__:
* [javascript.TypescriptConfigExtends](#projen-javascript-typescriptconfigextends)
## class UpgradeDependencies ð¹
Upgrade node project dependencies.
__Submodule__: javascript
__Extends__: [Component](#projen-component)
### Initializer
```ts
new javascript.UpgradeDependencies(project: NodeProject, options?: UpgradeDependenciesOptions)
```
* **project** ([javascript.NodeProject](#projen-javascript-nodeproject)) *No description*
* **options** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) *No description*
* **exclude** (Array) List of package names to exclude during the upgrade. __*Default*__: Nothing is excluded.
* **include** (Array) List of package names to include during the upgrade. __*Default*__: Everything is included.
* **pullRequestTitle** (string) Title of the pull request to use (should be all lower-case). __*Default*__: "upgrade dependencies"
* **signoff** (boolean) Add Signed-off-by line by the committer at the end of the commit log message. __*Default*__: true
* **taskName** (string) The name of the task that will be created. __*Default*__: "upgrade".
* **workflow** (boolean) Include a github workflow for creating PR's that upgrades the required dependencies, either by manual dispatch, or by a schedule. __*Default*__: true for root projects, false for sub-projects.
* **workflowOptions** ([javascript.UpgradeDependenciesWorkflowOptions](#projen-javascript-upgradedependenciesworkflowoptions)) Options for the github workflow. __*Default*__: default options.
### Properties
Name | Type | Description
-----|------|-------------
**postUpgradeTask**ð¹ | [Task](#projen-task) | A task run after the upgrade task.
**upgradeTask**ð¹ | [Task](#projen-task) | The upgrade task.
**workflows**ð¹ | Array<[github.GithubWorkflow](#projen-github-githubworkflow)> | The workflows that execute the upgrades.
**containerOptions**?ð¹ | [github.workflows.ContainerOptions](#projen-github-workflows-containeroptions) | Container definitions for the upgrade workflow.
__*Optional*__
### Methods
#### addPostBuildSteps(...steps)ð¹
Add steps to execute a successful build.
```ts
addPostBuildSteps(...steps: JobStep[]): void
```
* **steps** ([github.workflows.JobStep](#projen-github-workflows-jobstep)) workflow steps.
* **env** (Map) Sets environment variables for steps to use in the runner environment. __*Optional*__
* **id** (string) A unique identifier for the step. __*Optional*__
* **if** (string) You can use the if conditional to prevent a job from running unless a condition is met. __*Optional*__
* **name** (string) A name for your step to display on GitHub. __*Optional*__
* **run** (string) Runs command-line programs using the operating system's shell. __*Optional*__
* **uses** (string) Selects an action to run as part of a step in your job. __*Optional*__
* **with** (Map) A map of the input parameters defined by the action. __*Optional*__
* **workingDirectory** (string) Specifies a working directory for a step. __*Optional*__
* **continueOnError** (boolean) Prevents a job from failing when a step fails. __*Optional*__
* **timeoutMinutes** (number) The maximum number of minutes to run the step before killing the process. __*Optional*__
## class UpgradeDependenciesSchedule ð¹
How often to check for new versions and raise pull requests for version upgrades.
__Submodule__: javascript
### Properties
Name | Type | Description
-----|------|-------------
**cron**ð¹ | Array |
*static* **DAILY**ð¹ | [javascript.UpgradeDependenciesSchedule](#projen-javascript-upgradedependenciesschedule) | At 00:00.
*static* **MONTHLY**ð¹ | [javascript.UpgradeDependenciesSchedule](#projen-javascript-upgradedependenciesschedule) | At 00:00 on day-of-month 1.
*static* **NEVER**ð¹ | [javascript.UpgradeDependenciesSchedule](#projen-javascript-upgradedependenciesschedule) | Disables automatic upgrades.
*static* **WEEKDAY**ð¹ | [javascript.UpgradeDependenciesSchedule](#projen-javascript-upgradedependenciesschedule) | At 00:00 on every day-of-week from Monday through Friday.
*static* **WEEKLY**ð¹ | [javascript.UpgradeDependenciesSchedule](#projen-javascript-upgradedependenciesschedule) | At 00:00 on Monday.
### Methods
#### *static* expressions(cron)ð¹
Create a schedule from a raw cron expression.
```ts
static expressions(cron: Array): UpgradeDependenciesSchedule
```
* **cron** (Array) *No description*
__Returns__:
* [javascript.UpgradeDependenciesSchedule](#projen-javascript-upgradedependenciesschedule)
## class WatchPlugin ð¹
__Submodule__: javascript
### Initializer
```ts
new javascript.WatchPlugin(name: string, options?: any)
```
* **name** (string) *No description*
* **options** (any) *No description*
## class Pip ð¹
Manages dependencies using a requirements.txt file and the pip CLI tool.
__Implements__: [python.IPythonDeps](#projen-python-ipythondeps)
__Submodule__: python
__Extends__: [Component](#projen-component)
### Initializer
```ts
new python.Pip(project: Project, _options?: PipOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **_options** ([python.PipOptions](#projen-python-pipoptions)) *No description*
### Properties
Name | Type | Description
-----|------|-------------
**installTask**ð¹ | [Task](#projen-task) | A task that installs and updates dependencies.
### Methods
#### addDependency(spec)ð¹
Adds a runtime dependency.
```ts
addDependency(spec: string): void
```
* **spec** (string) Format `@`.
#### addDevDependency(spec)ð¹
Adds a dev dependency.
```ts
addDevDependency(spec: string): void
```
* **spec** (string) Format `@`.
#### installDependencies()ð¹
Installs dependencies (called during post-synthesis).
```ts
installDependencies(): void
```
## class Poetry ð¹
Manage project dependencies, virtual environments, and packaging through the poetry CLI tool.
__Implements__: [python.IPythonDeps](#projen-python-ipythondeps), [python.IPythonEnv](#projen-python-ipythonenv), [python.IPythonPackaging](#projen-python-ipythonpackaging)
__Submodule__: python
__Extends__: [Component](#projen-component)
### Initializer
```ts
new python.Poetry(project: Project, options: PythonPackagingOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([python.PythonPackagingOptions](#projen-python-pythonpackagingoptions)) *No description*
* **authorEmail** (string) Author's e-mail.
* **authorName** (string) Author's name.
* **version** (string) Version of the package.
* **classifiers** (Array) A list of PyPI trove classifiers that describe the project. __*Optional*__
* **description** (string) A short description of the package. __*Optional*__
* **homepage** (string) A URL to the website of the project. __*Optional*__
* **license** (string) License of this package as an SPDX identifier. __*Optional*__
* **packageName** (string) Package name. __*Optional*__
* **poetryOptions** ([python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)) Additional options to set for poetry if using poetry. __*Optional*__
* **setupConfig** (Map) Additional fields to pass in the setup() function if using setuptools. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**installTask**ð¹ | [Task](#projen-task) | A task that installs and updates dependencies.
**publishTask**ð¹ | [Task](#projen-task) | A task that uploads the package to a package repository.
**publishTestTask**ð¹ | [Task](#projen-task) | A task that uploads the package to the Test PyPI repository.
### Methods
#### addDependency(spec)ð¹
Adds a runtime dependency.
```ts
addDependency(spec: string): void
```
* **spec** (string) Format `@`.
#### addDevDependency(spec)ð¹
Adds a dev dependency.
```ts
addDevDependency(spec: string): void
```
* **spec** (string) Format `@`.
#### installDependencies()ð¹
Installs dependencies (called during post-synthesis).
```ts
installDependencies(): void
```
#### setupEnvironment()ð¹
Initializes the virtual environment if it doesn't exist (called during post-synthesis).
```ts
setupEnvironment(): void
```
## class PoetryPyproject ð¹
Represents configuration of a pyproject.toml file for a Poetry project.
__Submodule__: python
__Extends__: [Component](#projen-component)
### Initializer
```ts
new python.PoetryPyproject(project: Project, options: PoetryPyprojectOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([python.PoetryPyprojectOptions](#projen-python-poetrypyprojectoptions)) *No description*
* **authors** (Array) The authors of the package. __*Optional*__
* **classifiers** (Array) A list of PyPI trove classifiers that describe the project. __*Optional*__
* **description** (string) A short description of the package (required). __*Optional*__
* **documentation** (string) A URL to the documentation of the project. __*Optional*__
* **exclude** (Array) A list of patterns that will be excluded in the final package. __*Optional*__
* **extras** (Map>) Package extras. __*Optional*__
* **homepage** (string) A URL to the website of the project. __*Optional*__
* **include** (Array) A list of patterns that will be included in the final package. __*Optional*__
* **keywords** (Array) A list of keywords (max: 5) that the package is related to. __*Optional*__
* **license** (string) License of this package as an SPDX identifier. __*Optional*__
* **maintainers** (Array) the maintainers of the package. __*Optional*__
* **name** (string) Name of the package (required). __*Optional*__
* **packages** (Array) A list of packages and modules to include in the final distribution. __*Optional*__
* **plugins** (any) Plugins. __*Optional*__
* **readme** (string) The name of the readme file of the package. __*Optional*__
* **repository** (string) A URL to the repository of the project. __*Optional*__
* **scripts** (Map) The scripts or executables that will be installed when installing the package. __*Optional*__
* **source** (Array) Source registries from which packages are retrieved. __*Optional*__
* **urls** (Map) Project custom URLs, in addition to homepage, repository and documentation. __*Optional*__
* **version** (string) Version of the package (required). __*Optional*__
* **dependencies** (Map) A list of dependencies for the project. __*Optional*__
* **devDependencies** (Map) A list of development dependencies for the project. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**file**ð¹ | [TomlFile](#projen-tomlfile) |
## class Projenrc ð¹
Allows writing projenrc files in python.
This will install `projen` as a Python dependency and will add a
`synth` task which will run `.projenrc.py`.
__Submodule__: python
__Extends__: [ProjenrcFile](#projen-projenrcfile)
### Initializer
```ts
new python.Projenrc(project: Project, options?: ProjenrcOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([python.ProjenrcOptions](#projen-python-projenrcoptions)) *No description*
* **filename** (string) The name of the projenrc file. __*Default*__: ".projenrc.py"
* **projenVersion** (string) The projen version to use. __*Default*__: current version
* **pythonExec** (string) Path to the python executable to use. __*Default*__: "python"
### Properties
Name | Type | Description
-----|------|-------------
**filePath**ð¹ | string | The name of the projenrc file.
**pythonExec**ð¹ | string | Path to the python executable to use.
## class Pytest ð¹
__Submodule__: python
__Extends__: [Component](#projen-component)
### Initializer
```ts
new python.Pytest(project: Project, options?: PytestOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([python.PytestOptions](#projen-python-pytestoptions)) *No description*
* **maxFailures** (number) Stop the testing process after the first N failures. __*Optional*__
* **testdir** (string) Directory with tests. __*Default*__: 'tests'
* **version** (string) Pytest version. __*Default*__: "6.2.1"
### Properties
Name | Type | Description
-----|------|-------------
**testdir**ð¹ | string |
## class PytestSample ð¹
Python test code sample.
__Submodule__: python
__Extends__: [Component](#projen-component)
### Initializer
```ts
new python.PytestSample(project: Project, options: PytestSampleOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([python.PytestSampleOptions](#projen-python-pytestsampleoptions)) *No description*
* **moduleName** (string) Name of the python package as used in imports and filenames.
* **testdir** (string) Test directory.
## class PythonProject ð¹
Python project.
__Submodule__: python
__Extends__: [github.GitHubProject](#projen-github-githubproject)
### Initializer
```ts
new python.PythonProject(options: PythonProjectOptions)
```
* **options** ([python.PythonProjectOptions](#projen-python-pythonprojectoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **authorEmail** (string) Author's e-mail.
* **authorName** (string) Author's name.
* **version** (string) Version of the package.
* **classifiers** (Array) A list of PyPI trove classifiers that describe the project. __*Optional*__
* **description** (string) A short description of the package. __*Optional*__
* **homepage** (string) A URL to the website of the project. __*Optional*__
* **license** (string) License of this package as an SPDX identifier. __*Optional*__
* **packageName** (string) Package name. __*Optional*__
* **poetryOptions** ([python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)) Additional options to set for poetry if using poetry. __*Optional*__
* **setupConfig** (Map) Additional fields to pass in the setup() function if using setuptools. __*Optional*__
* **moduleName** (string) Name of the python package as used in imports and filenames.
* **deps** (Array) List of runtime dependencies for this project. __*Default*__: []
* **devDeps** (Array) List of dev dependencies for this project. __*Default*__: []
* **pip** (boolean) Use pip with a requirements.txt file to track project dependencies. __*Default*__: true, unless poetry is true, then false
* **poetry** (boolean) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing. __*Default*__: false
* **projenrcJs** (boolean) Use projenrc in javascript. __*Default*__: false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options related to projenrc in JavaScript. __*Default*__: default options
* **projenrcPython** (boolean) Use projenrc in Python. __*Default*__: true
* **projenrcPythonOptions** ([python.ProjenrcOptions](#projen-python-projenrcoptions)) Options related to projenrc in python. __*Default*__: default options
* **projenrcTs** (boolean) Use projenrc in TypeScript. __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcTsOptions](#projen-typescript-projenrctsoptions)) Options related to projenrc in TypeScript. __*Default*__: default options
* **pytest** (boolean) Include pytest tests. __*Default*__: true
* **pytestOptions** ([python.PytestOptions](#projen-python-pytestoptions)) pytest options. __*Default*__: defaults
* **pythonExec** (string) Path to the python executable to use. __*Default*__: "python"
* **sample** (boolean) Include sample code and test if the relevant directories don't exist. __*Default*__: true
* **setuptools** (boolean) Use setuptools with a setup.py script for packaging and publishing. __*Default*__: true, unless poetry is true, then false
* **venv** (boolean) Use venv to manage a virtual environment for installing dependencies inside. __*Default*__: true, unless poetry is true, then false
* **venvOptions** ([python.VenvOptions](#projen-python-venvoptions)) Venv options. __*Default*__: defaults
### Properties
Name | Type | Description
-----|------|-------------
**depsManager**ð¹ | [python.IPythonDeps](#projen-python-ipythondeps) | API for managing dependencies.
**envManager**ð¹ | [python.IPythonEnv](#projen-python-ipythonenv) | API for mangaging the Python runtime environment.
**moduleName**ð¹ | string | Python module name (the project name, with any hyphens or periods replaced with underscores).
**version**ð¹ | string | Version of the package for distribution (should follow semver).
**packagingManager**?ð¹ | [python.IPythonPackaging](#projen-python-ipythonpackaging) | API for managing packaging the project as a library.
__*Optional*__
**pytest**?ð¹ | [python.Pytest](#projen-python-pytest) | Pytest component.
__*Optional*__
### Methods
#### addDependency(spec)ð¹
Adds a runtime dependency.
```ts
addDependency(spec: string): void
```
* **spec** (string) Format `@`.
#### addDevDependency(spec)ð¹
Adds a dev dependency.
```ts
addDevDependency(spec: string): void
```
* **spec** (string) Format `@`.
#### postSynthesize()ð¹
Called after all components are synthesized.
Order is *not* guaranteed.
```ts
postSynthesize(): void
```
## class PythonSample ð¹
Python code sample.
__Submodule__: python
__Extends__: [Component](#projen-component)
### Initializer
```ts
new python.PythonSample(project: Project, options: PythonSampleOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([python.PythonSampleOptions](#projen-python-pythonsampleoptions)) *No description*
* **dir** (string) Sample code directory.
## class RequirementsFile ð¹
Specifies a list of packages to be installed using pip.
__Submodule__: python
__Extends__: [FileBase](#projen-filebase)
### Initializer
```ts
new python.RequirementsFile(project: Project, filePath: string, options: RequirementsFileOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **filePath** (string) *No description*
* **options** ([python.RequirementsFileOptions](#projen-python-requirementsfileoptions)) *No description*
* **packageProvider** ([python.IPackageProvider](#projen-python-ipackageprovider)) Provide a list of packages that can be dynamically updated. __*Optional*__
### Methods
#### addPackages(...packages)ð¹
Adds the specified packages provided in semver format.
Comment lines (start with `#`) are ignored.
```ts
addPackages(...packages: string[]): void
```
* **packages** (string) Package version in format `@`.
#### protected synthesizeContent(resolver)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(resolver: IResolver): string
```
* **resolver** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class SetupPy ð¹
Python packaging script where package metadata can be placed.
__Submodule__: python
__Extends__: [FileBase](#projen-filebase)
### Initializer
```ts
new python.SetupPy(project: Project, options: SetupPyOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([python.SetupPyOptions](#projen-python-setuppyoptions)) *No description*
* **additionalOptions** (Map) Escape hatch to allow any value. __*Optional*__
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **classifiers** (Array) A list of PyPI trove classifiers that describe the project. __*Optional*__
* **description** (string) A short project description. __*Optional*__
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **license** (string) The project license. __*Optional*__
* **name** (string) Name of the package. __*Optional*__
* **packages** (Array) List of submodules to be packaged. __*Optional*__
* **version** (string) Manually specify package version. __*Optional*__
### Methods
#### protected synthesizeContent(resolver)ð¹
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(resolver: IResolver): string
```
* **resolver** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class Setuptools ð¹
Manages packaging through setuptools with a setup.py script.
__Implements__: [python.IPythonPackaging](#projen-python-ipythonpackaging)
__Submodule__: python
__Extends__: [Component](#projen-component)
### Initializer
```ts
new python.Setuptools(project: Project, options: PythonPackagingOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([python.PythonPackagingOptions](#projen-python-pythonpackagingoptions)) *No description*
* **authorEmail** (string) Author's e-mail.
* **authorName** (string) Author's name.
* **version** (string) Version of the package.
* **classifiers** (Array) A list of PyPI trove classifiers that describe the project. __*Optional*__
* **description** (string) A short description of the package. __*Optional*__
* **homepage** (string) A URL to the website of the project. __*Optional*__
* **license** (string) License of this package as an SPDX identifier. __*Optional*__
* **packageName** (string) Package name. __*Optional*__
* **poetryOptions** ([python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps)) Additional options to set for poetry if using poetry. __*Optional*__
* **setupConfig** (Map) Additional fields to pass in the setup() function if using setuptools. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**publishTask**ð¹ | [Task](#projen-task) | A task that uploads the package to a package repository.
**publishTestTask**ð¹ | [Task](#projen-task) | A task that uploads the package to the Test PyPI repository.
## class Venv ð¹
Manages a virtual environment through the Python venv module.
__Implements__: [python.IPythonEnv](#projen-python-ipythonenv)
__Submodule__: python
__Extends__: [Component](#projen-component)
### Initializer
```ts
new python.Venv(project: Project, options?: VenvOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([python.VenvOptions](#projen-python-venvoptions)) *No description*
* **envdir** (string) Name of directory to store the environment in. __*Default*__: ".env"
* **pythonExec** (string) Path to the python executable to use. __*Default*__: "python"
### Methods
#### setupEnvironment()ð¹
Initializes the virtual environment if it doesn't exist (called during post-synthesis).
```ts
setupEnvironment(): void
```
## class Publisher ð¹
Implements GitHub jobs for publishing modules to package managers.
Under the hood, it uses https://github.com/aws/publib
__Submodule__: release
__Extends__: [Component](#projen-component)
### Initializer
```ts
new release.Publisher(project: Project, options: PublisherOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([release.PublisherOptions](#projen-release-publisheroptions)) *No description*
* **artifactName** (string) The name of the artifact to download (e.g. `dist`).
* **buildJobId** (string) The job ID that produces the build artifacts.
* **condition** (string) A GitHub workflow expression used as a condition for publishers. __*Default*__: no condition
* **dryRun** (boolean) Do not actually publish, only print the commands that would be executed instead. __*Optional*__
* **failureIssue** (boolean) Create an issue when a publish task fails. __*Default*__: false
* **failureIssueLabel** (string) The label to apply to the issue marking failed publish tasks. __*Default*__: "failed-release"
* **jsiiReleaseVersion** (string) *No description* __*Optional*__
* **publibVersion** (string) Version requirement for `publib`. __*Default*__: "latest"
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowNodeVersion** (string) Node version to setup in GitHub workflows if any node-based CLI utilities are needed. __*Default*__: 16.x
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
### Properties
Name | Type | Description
-----|------|-------------
**artifactName**ð¹ | string |
**buildJobId**ð¹ | string |
**jsiiReleaseVersion**â ïž | string |
**publibVersion**ð¹ | string |
**condition**?ð¹ | string | __*Optional*__
*static* **PUBLISH_GIT_TASK_NAME**ð¹ | string |
### Methods
#### addGitHubPrePublishingSteps(...steps)ð¹
Adds pre publishing steps for the GitHub release job.
```ts
addGitHubPrePublishingSteps(...steps: JobStep[]): void
```
* **steps** ([github.workflows.JobStep](#projen-github-workflows-jobstep)) The steps.
* **env** (Map) Sets environment variables for steps to use in the runner environment. __*Optional*__
* **id** (string) A unique identifier for the step. __*Optional*__
* **if** (string) You can use the if conditional to prevent a job from running unless a condition is met. __*Optional*__
* **name** (string) A name for your step to display on GitHub. __*Optional*__
* **run** (string) Runs command-line programs using the operating system's shell. __*Optional*__
* **uses** (string) Selects an action to run as part of a step in your job. __*Optional*__
* **with** (Map) A map of the input parameters defined by the action. __*Optional*__
* **workingDirectory** (string) Specifies a working directory for a step. __*Optional*__
* **continueOnError** (boolean) Prevents a job from failing when a step fails. __*Optional*__
* **timeoutMinutes** (number) The maximum number of minutes to run the step before killing the process. __*Optional*__
#### publishToGit(options)ð¹
Publish to git.
This includes generating a project-level changelog and release tags.
```ts
publishToGit(options: GitPublishOptions): Task
```
* **options** ([release.GitPublishOptions](#projen-release-gitpublishoptions)) Options.
* **changelogFile** (string) The location of an .md file (relative to `dist/`) that includes the changelog for the release.
* **releaseTagFile** (string) The location of a text file (relative to `dist/`) that contains the release tag.
* **versionFile** (string) The location of a text file (relative to `dist/`) that contains the version number.
* **gitBranch** (string) Branch to push to. __*Default*__: "main"
* **gitPushCommand** (string) Override git-push command. __*Optional*__
* **projectChangelogFile** (string) The location of an .md file that includes the project-level changelog. __*Optional*__
__Returns__:
* [Task](#projen-task)
#### publishToGitHubReleases(options)ð¹
Creates a GitHub Release.
```ts
publishToGitHubReleases(options: GitHubReleasesPublishOptions): void
```
* **options** ([release.GitHubReleasesPublishOptions](#projen-release-githubreleasespublishoptions)) Options.
* **prePublishSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
* **publishTools** ([github.workflows.Tools](#projen-github-workflows-tools)) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
* **changelogFile** (string) The location of an .md file (relative to `dist/`) that includes the changelog for the release.
* **releaseTagFile** (string) The location of a text file (relative to `dist/`) that contains the release tag.
* **versionFile** (string) The location of a text file (relative to `dist/`) that contains the version number.
#### publishToGo(options?)ð¹
Adds a go publishing job.
```ts
publishToGo(options?: GoPublishOptions): void
```
* **options** ([release.GoPublishOptions](#projen-release-gopublishoptions)) Options.
* **prePublishSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
* **publishTools** ([github.workflows.Tools](#projen-github-workflows-tools)) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
* **gitBranch** (string) Branch to push to. __*Default*__: "main"
* **gitCommitMessage** (string) The commit message. __*Default*__: "chore(release): $VERSION"
* **githubDeployKeySecret** (string) The name of the secret that includes a GitHub deploy key used to push to the GitHub repository. __*Default*__: "GO_GITHUB_DEPLOY_KEY"
* **githubRepo** (string) GitHub repository to push to. __*Default*__: derived from `moduleName`
* **githubTokenSecret** (string) The name of the secret that includes a personal GitHub access token used to push to the GitHub repository. __*Default*__: "GO_GITHUB_TOKEN"
* **githubUseSsh** (boolean) Use SSH to push to GitHub instead of a personal accses token. __*Default*__: false
* **gitUserEmail** (string) The email to use in the release git commit. __*Default*__: "github-actions@github.com"
* **gitUserName** (string) The user name to use for the release git commit. __*Default*__: "github-actions"
#### publishToMaven(options?)ð¹
Publishes artifacts from `java/**` to Maven.
```ts
publishToMaven(options?: MavenPublishOptions): void
```
* **options** ([release.MavenPublishOptions](#projen-release-mavenpublishoptions)) Options.
* **prePublishSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
* **publishTools** ([github.workflows.Tools](#projen-github-workflows-tools)) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
* **mavenEndpoint** (string) URL of Nexus repository. __*Default*__: "https://oss.sonatype.org"
* **mavenGpgPrivateKeyPassphrase** (string) GitHub secret name which contains the GPG private key or file that includes it. __*Default*__: "MAVEN_GPG_PRIVATE_KEY_PASSPHRASE" or not set when using GitHub Packages
* **mavenGpgPrivateKeySecret** (string) GitHub secret name which contains the GPG private key or file that includes it. __*Default*__: "MAVEN_GPG_PRIVATE_KEY" or not set when using GitHub Packages
* **mavenPassword** (string) GitHub secret name which contains the Password for maven repository. __*Default*__: "MAVEN_PASSWORD" or "GITHUB_TOKEN" when using GitHub Packages
* **mavenRepositoryUrl** (string) Deployment repository when not deploying to Maven Central. __*Default*__: not set
* **mavenServerId** (string) Used in maven settings for credential lookup (e.g. use github when publishing to GitHub). __*Default*__: "ossrh" (Maven Central) or "github" when using GitHub Packages
* **mavenStagingProfileId** (string) GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org (e.g. https://oss.sonatype.org/#stagingProfiles;11a33451234521). __*Default*__: "MAVEN_STAGING_PROFILE_ID" or not set when using GitHub Packages
* **mavenUsername** (string) GitHub secret name which contains the Username for maven repository. __*Default*__: "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages
#### publishToNpm(options?)ð¹
Publishes artifacts from `js/**` to npm.
```ts
publishToNpm(options?: NpmPublishOptions): void
```
* **options** ([release.NpmPublishOptions](#projen-release-npmpublishoptions)) Options.
* **prePublishSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
* **publishTools** ([github.workflows.Tools](#projen-github-workflows-tools)) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
* **codeArtifactOptions** ([release.CodeArtifactOptions](#projen-release-codeartifactoptions)) Options for publishing npm package to AWS CodeArtifact. __*Default*__: undefined
* **distTag** (string) Tags can be used to provide an alias instead of version numbers. __*Default*__: "latest"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN" or "GITHUB_TOKEN" if `registry` is set to `npm.pkg.github.com`.
* **registry** (string) The domain name of the npm package registry. __*Default*__: "registry.npmjs.org"
#### publishToNuget(options?)ð¹
Publishes artifacts from `dotnet/**` to NuGet Gallery.
```ts
publishToNuget(options?: NugetPublishOptions): void
```
* **options** ([release.NugetPublishOptions](#projen-release-nugetpublishoptions)) Options.
* **prePublishSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
* **publishTools** ([github.workflows.Tools](#projen-github-workflows-tools)) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
* **nugetApiKeySecret** (string) GitHub secret which contains the API key for NuGet. __*Default*__: "NUGET_API_KEY"
* **nugetServer** (string) NuGet Server URL (defaults to nuget.org). __*Optional*__
#### publishToPyPi(options?)ð¹
Publishes wheel artifacts from `python` to PyPI.
```ts
publishToPyPi(options?: PyPiPublishOptions): void
```
* **options** ([release.PyPiPublishOptions](#projen-release-pypipublishoptions)) Options.
* **prePublishSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede. __*Optional*__
* **publishTools** ([github.workflows.Tools](#projen-github-workflows-tools)) Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
* **twinePasswordSecret** (string) The GitHub secret which contains PyPI password. __*Default*__: "TWINE_PASSWORD"
* **twineRegistryUrl** (string) The registry url to use when releasing packages. __*Default*__: twine default
* **twineUsernameSecret** (string) The GitHub secret which contains PyPI user name. __*Default*__: "TWINE_USERNAME"
## class Release ð¹
Manages releases (currently through GitHub workflows).
By default, no branches are released. To add branches, call `addBranch()`.
__Submodule__: release
__Extends__: [Component](#projen-component)
### Initializer
```ts
new release.Release(project: GitHubProject, options: ReleaseOptions)
```
* **project** ([github.GitHubProject](#projen-github-githubproject)) *No description*
* **options** ([release.ReleaseOptions](#projen-release-releaseoptions)) *No description*
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **artifactsDirectory** (string) A directory which will contain build artifacts.
* **branch** (string) The default branch name to release from.
* **task** ([Task](#projen-task)) The task to execute in order to create the release artifacts.
* **versionFile** (string) A name of a .json file to set the `version` field in after a bump.
* **githubRelease** (boolean) Create a GitHub release for each release. __*Default*__: true
* **workflowNodeVersion** (string) Node version to setup in GitHub workflows if any node-based CLI utilities are needed. __*Default*__: 16.x
* **workflowPermissions** ([github.workflows.JobPermissions](#projen-github-workflows-jobpermissions)) Permissions granted to the release workflow job. __*Default*__: `{ contents: JobPermission.WRITE }`
### Properties
Name | Type | Description
-----|------|-------------
**artifactsDirectory**ð¹ | string | Location of build artifacts.
**branches**ð¹ | Array | Retrieve all release branch names.
**publisher**ð¹ | [release.Publisher](#projen-release-publisher) | Package publisher.
*static* **ANTI_TAMPER_CMD**ð¹ | string |
### Methods
#### addBranch(branch, options)ð¹
Adds a release branch.
It is a git branch from which releases are published. If a project has more than one release
branch, we require that `majorVersion` is also specified for the primary branch in order to
ensure branches always release the correct version.
```ts
addBranch(branch: string, options: BranchOptions): void
```
* **branch** (string) The branch to monitor (e.g. `main`, `v2.x`).
* **options** ([release.BranchOptions](#projen-release-branchoptions)) Branch definition.
* **majorVersion** (number) The major versions released from this branch.
* **minMajorVersion** (number) The minimum major version to release. __*Optional*__
* **npmDistTag** (string) The npm distribution tag to use for this branch. __*Default*__: "latest"
* **prerelease** (string) Bump the version as a pre-release tag. __*Default*__: normal releases
* **tagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: no prefix
* **workflowName** (string) The name of the release workflow. __*Default*__: "release-BRANCH"
#### addJobs(jobs)ð¹
Adds jobs to all release workflows.
```ts
addJobs(jobs: Map): void
```
* **jobs** (Map) The jobs to add (name => job).
#### preSynthesize()ð¹
Called before synthesis.
```ts
preSynthesize(): void
```
#### *static* of(project)ð¹
Returns the `Release` component of a project or `undefined` if the project does not have a Release component.
```ts
static of(project: GitHubProject): Release
```
* **project** ([github.GitHubProject](#projen-github-githubproject)) *No description*
__Returns__:
* [release.Release](#projen-release-release)
## class ReleaseTrigger ð¹
Used to manage release strategies.
This includes release
and release artifact automation
__Submodule__: release
### Properties
Name | Type | Description
-----|------|-------------
**isContinuous**ð¹ | boolean | Whether or not this is a continuous release.
**isManual**ð¹ | boolean | Whether or not this is a manual release trigger.
**changelogPath**?ð¹ | string | Project-level changelog file path.
__*Optional*__
**gitPushCommand**?ð¹ | string | Override git-push command used when releasing manually.
__*Optional*__
**schedule**?ð¹ | string | Cron schedule for releases.
__*Optional*__
### Methods
#### *static* continuous()ð¹
Creates a continuous release trigger.
Automated releases will occur on every commit.
```ts
static continuous(): ReleaseTrigger
```
__Returns__:
* [release.ReleaseTrigger](#projen-release-releasetrigger)
#### *static* manual(options?)ð¹
Creates a manual release trigger.
Use this option if you want totally manual releases.
This will give you a release task that, in addition to the normal
release activities will trigger a `publish:git` task. This task will
handle project-level changelog management, release tagging, and pushing
these artifacts to origin.
The command used for pushing can be customised by specifying
`gitPushCommand`. Set to an empty string to disable pushing entirely.
Simply run `yarn release` to trigger a manual release.
```ts
static manual(options?: ManualReleaseOptions): ReleaseTrigger
```
* **options** ([release.ManualReleaseOptions](#projen-release-manualreleaseoptions)) release options.
* **changelog** (boolean) Maintain a project-level changelog. __*Default*__: true
* **changelogPath** (string) Project-level changelog file path. __*Default*__: 'CHANGELOG.md'
* **gitPushCommand** (string) Override git-push command. __*Optional*__
__Returns__:
* [release.ReleaseTrigger](#projen-release-releasetrigger)
#### *static* scheduled(options)ð¹
Creates a scheduled release trigger.
Automated releases will occur based on the provided cron schedule.
```ts
static scheduled(options: ScheduledReleaseOptions): ReleaseTrigger
```
* **options** ([release.ScheduledReleaseOptions](#projen-release-scheduledreleaseoptions)) release options.
* **schedule** (string) Cron schedule for releases.
__Returns__:
* [release.ReleaseTrigger](#projen-release-releasetrigger)
## class Projenrc ð¹
Sets up a typescript project to use TypeScript for projenrc.
__Submodule__: typescript
__Extends__: [ProjenrcFile](#projen-projenrcfile)
### Initializer
```ts
new typescript.Projenrc(project: TypeScriptProject, options?: ProjenrcOptions)
```
* **project** ([typescript.TypeScriptProject](#projen-typescript-typescriptproject)) *No description*
* **options** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) *No description*
* **filename** (string) The name of the projenrc file. __*Default*__: ".projenrc.ts"
* **projenCodeDir** (string) A directory tree that may contain *.ts files that can be referenced from your projenrc typescript file. __*Default*__: "projenrc"
* **swc** (boolean) Whether to use `SWC` for ts-node. __*Default*__: false
### Properties
Name | Type | Description
-----|------|-------------
**filePath**ð¹ | string | The path of the projenrc file.
### Methods
#### preSynthesize()ð¹
Called before synthesis.
```ts
preSynthesize(): void
```
## class ProjenrcTs ð¹
A projenrc file written in TypeScript.
This component can be instantiated in any type of project
and has no expectations around the project's main language.
Requires that `npx` is available.
__Submodule__: typescript
__Extends__: [ProjenrcFile](#projen-projenrcfile)
### Initializer
```ts
new typescript.ProjenrcTs(project: Project, options?: ProjenrcTsOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([typescript.ProjenrcTsOptions](#projen-typescript-projenrctsoptions)) *No description*
* **filename** (string) The name of the projenrc file. __*Default*__: ".projenrc.ts"
* **projenCodeDir** (string) A directory tree that may contain *.ts files that can be referenced from your projenrc typescript file. __*Default*__: "projenrc"
* **tsconfigFileName** (string) The name of the tsconfig file that will be used by ts-node when compiling projen source files. __*Default*__: "tsconfig.projen.json"
### Properties
Name | Type | Description
-----|------|-------------
**filePath**ð¹ | string | The path of the projenrc file.
**tsconfig**ð¹ | [javascript.TypescriptConfig](#projen-javascript-typescriptconfig) | TypeScript configuration file used to compile projen source files.
### Methods
#### preSynthesize()ð¹
Called before synthesis.
```ts
preSynthesize(): void
```
## class TypeScriptAppProject ð¹
TypeScript app.
__Submodule__: typescript
__Extends__: [typescript.TypeScriptProject](#projen-typescript-typescriptproject)
### Initializer
```ts
new typescript.TypeScriptAppProject(options: TypeScriptProjectOptions)
```
* **options** ([typescript.TypeScriptProjectOptions](#projen-typescript-typescriptprojectoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
## class TypeScriptLibraryProject â ïž
__Submodule__: typescript
__Extends__: [typescript.TypeScriptProject](#projen-typescript-typescriptproject)
### Initializer
```ts
new typescript.TypeScriptLibraryProject(options: TypeScriptProjectOptions)
```
* **options** ([typescript.TypeScriptProjectOptions](#projen-typescript-typescriptprojectoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
## class TypeScriptProject ð¹
TypeScript project.
__Submodule__: typescript
__Extends__: [javascript.NodeProject](#projen-javascript-nodeproject)
### Initializer
```ts
new typescript.TypeScriptProject(options: TypeScriptProjectOptions)
```
* **options** ([typescript.TypeScriptProjectOptions](#projen-typescript-typescriptprojectoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
### Properties
Name | Type | Description
-----|------|-------------
**docsDirectory**ð¹ | string |
**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**ð¹ | [javascript.TypescriptConfig](#projen-javascript-typescriptconfig) | A typescript configuration file which covers all files (sources, tests, projen).
**watchTask**ð¹ | [Task](#projen-task) | The "watch" task.
**docgen**?ð¹ | boolean | __*Optional*__
**eslint**?ð¹ | [javascript.Eslint](#projen-javascript-eslint) | __*Optional*__
**tsconfig**?ð¹ | [javascript.TypescriptConfig](#projen-javascript-typescriptconfig) | __*Optional*__
**tsconfigEslint**?ð¹ | [javascript.TypescriptConfig](#projen-javascript-typescriptconfig) | __*Optional*__
## class TypedocDocgen ð¹
Adds a simple Typescript documentation generator.
__Submodule__: typescript
### Initializer
```ts
new typescript.TypedocDocgen(project: TypeScriptProject)
```
* **project** ([typescript.TypeScriptProject](#projen-typescript-typescriptproject)) *No description*
## class DevContainer ð¹
A development environment running VSCode in a container;
used by GitHub
codespaces.
__Implements__: [vscode.IDevContainerEnvironment](#projen-vscode-idevcontainerenvironment), [IDevEnvironment](#projen-idevenvironment)
__Submodule__: vscode
__Extends__: [Component](#projen-component)
### Initializer
```ts
new vscode.DevContainer(project: Project, options?: DevContainerOptions)
```
* **project** ([Project](#projen-project)) *No description*
* **options** ([vscode.DevContainerOptions](#projen-vscode-devcontaineroptions)) *No description*
* **dockerImage** ([DevEnvironmentDockerImage](#projen-devenvironmentdockerimage)) A Docker image or Dockerfile for the container. __*Optional*__
* **ports** (Array) An array of ports that should be exposed from the container. __*Optional*__
* **tasks** (Array<[Task](#projen-task)>) An array of tasks that should be run when the container starts. __*Optional*__
* **vscodeExtensions** (Array) An array of extension IDs that specify the extensions that should be installed inside the container when it is created. __*Optional*__
* **features** (Array<[vscode.DevContainerFeature](#projen-vscode-devcontainerfeature)>) An array of VSCode features that specify the features that should be installed inside the container when it is created. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**config**ð¹ | any | Direct access to the devcontainer configuration (escape hatch).
### Methods
#### addDockerImage(image)ð¹
Add a custom Docker image or Dockerfile for the container.
```ts
addDockerImage(image: DevEnvironmentDockerImage): void
```
* **image** ([DevEnvironmentDockerImage](#projen-devenvironmentdockerimage)) *No description*
#### addFeatures(...features)ð¹
Adds a list of VSCode features that should be automatically installed in the container.
```ts
addFeatures(...features: DevContainerFeature[]): void
```
* **features** ([vscode.DevContainerFeature](#projen-vscode-devcontainerfeature)) featureName and version(optional default: latest).
* **name** (string) feature name.
* **version** (string) feature version. __*Default*__: latest
#### addPorts(...ports)ð¹
Adds ports that should be exposed (forwarded) from the container.
```ts
addPorts(...ports: string[]): void
```
* **ports** (string) The new ports.
#### addTasks(...tasks)ð¹
Adds tasks to run when the container starts.
Tasks will be run in sequence.
```ts
addTasks(...tasks: Task[]): void
```
* **tasks** ([Task](#projen-task)) The new tasks.
#### addVscodeExtensions(...extensions)ð¹
Adds a list of VSCode extensions that should be automatically installed in the container.
```ts
addVscodeExtensions(...extensions: string[]): void
```
* **extensions** (string) The extension IDs.
## class VsCode ð¹
__Submodule__: vscode
__Extends__: [Component](#projen-component)
### Initializer
```ts
new vscode.VsCode(project: Project)
```
* **project** ([Project](#projen-project)) *No description*
### Properties
Name | Type | Description
-----|------|-------------
**extensions**ð¹ | [vscode.VsCodeRecommendedExtensions](#projen-vscode-vscoderecommendedextensions) |
**launchConfiguration**ð¹ | [vscode.VsCodeLaunchConfig](#projen-vscode-vscodelaunchconfig) |
**settings**ð¹ | [vscode.VsCodeSettings](#projen-vscode-vscodesettings) |
## class VsCodeLaunchConfig ð¹
VSCode launch configuration file (launch.json), useful for enabling in-editor debugger.
__Submodule__: vscode
__Extends__: [Component](#projen-component)
### Initializer
```ts
new vscode.VsCodeLaunchConfig(vscode: VsCode)
```
* **vscode** ([vscode.VsCode](#projen-vscode-vscode)) *No description*
### Methods
#### addConfiguration(cfg)ð¹
Adds a VsCodeLaunchConfigurationEntry (e.g. a node.js debugger) to `.vscode/launch.json. Each configuration entry has following mandatory fields: type, request and name. See https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes for details.
```ts
addConfiguration(cfg: VsCodeLaunchConfigurationEntry): void
```
* **cfg** ([vscode.VsCodeLaunchConfigurationEntry](#projen-vscode-vscodelaunchconfigurationentry)) VsCodeLaunchConfigurationEntry.
* **name** (string) *No description*
* **request** (string) *No description*
* **type** (string) *No description*
* **args** (Array) *No description* __*Optional*__
* **console** ([vscode.Console](#projen-vscode-console)) *No description* __*Optional*__
* **cwd** (string) *No description* __*Optional*__
* **debugServer** (number) *No description* __*Optional*__
* **disableOptimisticBPs** (boolean) *No description* __*Optional*__
* **env** (Map) Set value to `false` to unset an existing environment variable. __*Optional*__
* **envFile** (string) *No description* __*Optional*__
* **internalConsoleOptions** ([vscode.InternalConsoleOptions](#projen-vscode-internalconsoleoptions)) *No description* __*Optional*__
* **outFiles** (Array) *No description* __*Optional*__
* **port** (number) *No description* __*Optional*__
* **postDebugTask** (string) *No description* __*Optional*__
* **preLaunchTask** (string) *No description* __*Optional*__
* **presentation** ([vscode.Presentation](#projen-vscode-presentation)) *No description* __*Optional*__
* **program** (string) *No description* __*Optional*__
* **runtimeArgs** (Array) *No description* __*Optional*__
* **serverReadyAction** ([vscode.ServerReadyAction](#projen-vscode-serverreadyaction)) *No description* __*Optional*__
* **skipFiles** (Array) *No description* __*Optional*__
* **stopOnEntry** (boolean) *No description* __*Optional*__
* **url** (string) *No description* __*Optional*__
* **webRoot** (string) *No description* __*Optional*__
## class VsCodeRecommendedExtensions ð¹
VS Code Workspace recommended extensions Source: https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions.
__Submodule__: vscode
__Extends__: [Component](#projen-component)
### Initializer
```ts
new vscode.VsCodeRecommendedExtensions(vscode: VsCode)
```
* **vscode** ([vscode.VsCode](#projen-vscode-vscode)) *No description*
### Methods
#### addRecommendations(...extensions)ð¹
Adds a list of VS Code extensions as recommendations for this workspace.
```ts
addRecommendations(...extensions: string[]): void
```
* **extensions** (string) The extension IDs.
#### addUnwantedRecommendations(...extensions)ð¹
Marks a list of VS Code extensions as unwanted recommendations for this workspace.
VS Code should not be recommend these extensions for users of this workspace.
```ts
addUnwantedRecommendations(...extensions: string[]): void
```
* **extensions** (string) The extension IDs.
## class VsCodeSettings ð¹
VS Code Workspace settings Source: https://code.visualstudio.com/docs/getstarted/settings#_workspace-settings.
__Submodule__: vscode
__Extends__: [Component](#projen-component)
### Initializer
```ts
new vscode.VsCodeSettings(vscode: VsCode)
```
* **vscode** ([vscode.VsCode](#projen-vscode-vscode)) *No description*
### Methods
#### addSetting(setting, value, language?)ð¹
Adds a workspace setting.
```ts
addSetting(setting: string, value: any, language?: string): void
```
* **setting** (string) The setting ID.
* **value** (any) The value of the setting.
* **language** (string) Scope the setting to a specific language.
#### addSettings(settings, languages?)ð¹
Adds a workspace setting.
```ts
addSettings(settings: Map, languages?: string | Array): void
```
* **settings** (Map) Array structure: [setting: string, value: any, languages?: string[]].
* **languages** (string | Array) *No description*
## class NextComponent ð¹
__Submodule__: web
__Extends__: [Component](#projen-component)
### Initializer
```ts
new web.NextComponent(project: NodeProject, options: NextComponentOptions)
```
* **project** ([javascript.NodeProject](#projen-javascript-nodeproject)) *No description*
* **options** ([web.NextComponentOptions](#projen-web-nextcomponentoptions)) *No description*
* **tailwind** (boolean) Setup Tailwind as a PostCSS plugin. __*Default*__: true
* **typescript** (boolean) Whether to apply options specific for TypeScript Next.js projects. __*Default*__: false
## class NextJsProject ð¹
Next.js project without TypeScript.
__Submodule__: web
__Extends__: [javascript.NodeProject](#projen-javascript-nodeproject)
### Initializer
```ts
new web.NextJsProject(options: NextJsProjectOptions)
```
* **options** ([web.NextJsProjectOptions](#projen-web-nextjsprojectoptions)) *No description*
* **assetsdir** (string) Assets directory. __*Default*__: "public"
* **tailwind** (boolean) Setup Tailwind CSS as a PostCSS plugin. __*Default*__: true
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **sampleCode** (boolean) Generate one-time sample in `pages/` and `public/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
### Properties
Name | Type | Description
-----|------|-------------
**assetsdir**ð¹ | string | The directory in which app assets reside.
**srcdir**ð¹ | string | The directory in which source files reside.
**tailwind**ð¹ | boolean | Setup Tailwind as a PostCSS plugin.
## class NextJsTypeScriptProject ð¹
Next.js project with TypeScript.
__Submodule__: web
__Extends__: [typescript.TypeScriptAppProject](#projen-typescript-typescriptappproject)
### Initializer
```ts
new web.NextJsTypeScriptProject(options: NextJsTypeScriptProjectOptions)
```
* **options** ([web.NextJsTypeScriptProjectOptions](#projen-web-nextjstypescriptprojectoptions)) *No description*
* **assetsdir** (string) Assets directory. __*Default*__: "public"
* **tailwind** (boolean) Setup Tailwind CSS as a PostCSS plugin. __*Default*__: true
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
### Properties
Name | Type | Description
-----|------|-------------
**assetsdir**ð¹ | string | The directory in which app assets reside.
**srcdir**ð¹ | string | The directory in which source files reside.
**tailwind**ð¹ | boolean | Setup Tailwind as a PostCSS plugin.
## class PostCss ð¹
Declares a PostCSS dependency with a default config file.
__Submodule__: web
### Initializer
```ts
new web.PostCss(project: NodeProject, options?: PostCssOptions)
```
* **project** ([javascript.NodeProject](#projen-javascript-nodeproject)) *No description*
* **options** ([web.PostCssOptions](#projen-web-postcssoptions)) *No description*
* **fileName** (string) *No description* __*Default*__: "postcss.config.json"
* **tailwind** (boolean) Install Tailwind CSS as a PostCSS plugin. __*Default*__: true
* **tailwindOptions** ([web.TailwindConfigOptions](#projen-web-tailwindconfigoptions)) Tailwind CSS options. __*Optional*__
### Properties
Name | Type | Description
-----|------|-------------
**file**ð¹ | [JsonFile](#projen-jsonfile) |
**fileName**ð¹ | string |
**tailwind**?ð¹ | [web.TailwindConfig](#projen-web-tailwindconfig) | __*Optional*__
## class ReactComponent ð¹
__Submodule__: web
__Extends__: [Component](#projen-component)
### Initializer
```ts
new web.ReactComponent(project: NodeProject, options: ReactComponentOptions)
```
* **project** ([javascript.NodeProject](#projen-javascript-nodeproject)) *No description*
* **options** ([web.ReactComponentOptions](#projen-web-reactcomponentoptions)) *No description*
* **rewire** (Map) Rewire webpack configuration. __*Default*__: No rewired config.
* **typescript** (boolean) Whether to apply options specific for TypeScript React projects. __*Default*__: false
## class ReactProject ð¹
React project without TypeScript.
__Submodule__: web
__Extends__: [javascript.NodeProject](#projen-javascript-nodeproject)
### Initializer
```ts
new web.ReactProject(options: ReactProjectOptions)
```
* **options** ([web.ReactProjectOptions](#projen-web-reactprojectoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **rewire** (Map) Rewire webpack configuration. __*Default*__: No rewired config.
* **sampleCode** (boolean) Generate one-time sample in `src/` and `public/` if there are no files there. __*Default*__: true
* **srcdir** (string) Source directory. __*Default*__: "src"
### Properties
Name | Type | Description
-----|------|-------------
**srcdir**ð¹ | string | The directory in which source files reside.
## class ReactTypeDef â ïž
__Submodule__: web
__Extends__: [FileBase](#projen-filebase)
### Initializer
```ts
new web.ReactTypeDef(project: ReactTypeScriptProject, filePath: string, options?: ReactTypeDefOptions)
```
* **project** ([web.ReactTypeScriptProject](#projen-web-reacttypescriptproject)) *No description*
* **filePath** (string) *No description*
* **options** ([web.ReactTypeDefOptions](#projen-web-reacttypedefoptions)) *No description*
* **committed** (boolean) Indicates whether this file should be committed to git or ignored. __*Default*__: true
* **editGitignore** (boolean) Update the project's .gitignore file. __*Default*__: true
* **executable** (boolean) Whether the generated file should be marked as executable. __*Default*__: false
* **marker** (boolean) Adds the projen marker to the file. __*Default*__: marker will be included as long as the project is not ejected
* **readonly** (boolean) Whether the generated file should be readonly. __*Default*__: true
### Methods
#### protected synthesizeContent(_)â ïž
Implemented by derived classes and returns the contents of the file to emit.
```ts
protected synthesizeContent(_: IResolver): string
```
* **_** ([IResolver](#projen-iresolver)) *No description*
__Returns__:
* string
## class ReactTypeScriptProject ð¹
React project with TypeScript.
__Submodule__: web
__Extends__: [typescript.TypeScriptAppProject](#projen-typescript-typescriptappproject)
### Initializer
```ts
new web.ReactTypeScriptProject(options: ReactTypeScriptProjectOptions)
```
* **options** ([web.ReactTypeScriptProjectOptions](#projen-web-reacttypescriptprojectoptions)) *No description*
* **name** (string) This is the name of your project.
* **commitGenerated** (boolean) Whether to commit the managed files by default. __*Default*__: true
* **gitIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .gitignore file. __*Optional*__
* **gitOptions** ([GitOptions](#projen-gitoptions)) Configuration options for git. __*Optional*__
* **logging** ([LoggerOptions](#projen-loggeroptions)) Configure logging options such as verbosity. __*Default*__: {}
* **outdir** (string) The root directory of the project. __*Default*__: "."
* **parent** ([Project](#projen-project)) The parent project, if this project is part of a bigger project. __*Optional*__
* **projenCommand** (string) The shell command to use in order to run the projen CLI. __*Default*__: "npx projen"
* **projenrcJson** (boolean) Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. __*Default*__: false
* **projenrcJsonOptions** ([ProjenrcJsonOptions](#projen-projenrcjsonoptions)) Options for .projenrc.json. __*Default*__: default options
* **renovatebot** (boolean) Use renovatebot to handle dependency upgrades. __*Default*__: false
* **renovatebotOptions** ([RenovatebotOptions](#projen-renovatebotoptions)) Options for renovatebot. __*Default*__: default options
* **autoApproveOptions** ([github.AutoApproveOptions](#projen-github-autoapproveoptions)) Enable and configure the 'auto approve' workflow. __*Default*__: auto approve is disabled
* **autoMerge** (boolean) Enable automatic merging on GitHub. __*Default*__: true
* **autoMergeOptions** ([github.AutoMergeOptions](#projen-github-automergeoptions)) Configure options for automatic merging on GitHub. __*Default*__: see defaults in `AutoMergeOptions`
* **clobber** (boolean) Add a `clobber` task which resets the repo to origin. __*Default*__: true, but false for subprojects
* **devContainer** (boolean) Add a VSCode development environment (used for GitHub Codespaces). __*Default*__: false
* **github** (boolean) Enable GitHub integration. __*Default*__: true
* **githubOptions** ([github.GitHubOptions](#projen-github-githuboptions)) Options for GitHub integration. __*Default*__: see GitHubOptions
* **gitpod** (boolean) Add a Gitpod development environment. __*Default*__: false
* **mergify** (boolean) Whether mergify should be enabled on this repository or not. __*Default*__: true
* **mergifyOptions** ([github.MergifyOptions](#projen-github-mergifyoptions)) Options for mergify. __*Default*__: default options
* **projectType** ([ProjectType](#projen-projecttype)) Which type of project this is (library/app). __*Default*__: ProjectType.UNKNOWN
* **projenCredentials** ([github.GithubCredentials](#projen-github-githubcredentials)) Choose a method of providing GitHub API access for projen workflows. __*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
* **projenTokenSecret** (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. __*Default*__: "PROJEN_GITHUB_TOKEN"
* **readme** ([SampleReadmeProps](#projen-samplereadmeprops)) The README setup. __*Default*__: { filename: 'README.md', contents: '# replace this' }
* **stale** (boolean) Auto-close of stale issues and pull request. __*Default*__: false
* **staleOptions** ([github.StaleOptions](#projen-github-staleoptions)) Auto-close stale issues and pull requests. __*Default*__: see defaults in `StaleOptions`
* **vscode** (boolean) Enable VSCode integration. __*Default*__: true
* **allowLibraryDependencies** (boolean) Allow the project to include `peerDependencies` and `bundledDependencies`. __*Default*__: true
* **authorEmail** (string) Author's e-mail. __*Optional*__
* **authorName** (string) Author's name. __*Optional*__
* **authorOrganization** (boolean) Is the author an organization. __*Optional*__
* **authorUrl** (string) Author's URL / Website. __*Optional*__
* **autoDetectBin** (boolean) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. __*Default*__: true
* **bin** (Map) Binary programs vended with your module. __*Optional*__
* **bugsEmail** (string) The email address to which issues should be reported. __*Optional*__
* **bugsUrl** (string) The url to your project's issue tracker. __*Optional*__
* **bundledDeps** (Array) List of dependencies to bundle into this module. __*Optional*__
* **codeArtifactOptions** ([javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions)) Options for npm packages using AWS CodeArtifact. __*Default*__: undefined
* **deps** (Array) Runtime dependencies of this module. __*Default*__: []
* **description** (string) The description is just a string that helps people understand the purpose of the package. __*Optional*__
* **devDeps** (Array) Build dependencies for this module. __*Default*__: []
* **entrypoint** (string) Module entrypoint (`main` in `package.json`). __*Default*__: "lib/index.js"
* **homepage** (string) Package's Homepage / Website. __*Optional*__
* **keywords** (Array) Keywords to include in `package.json`. __*Optional*__
* **license** (string) License's SPDX identifier. __*Default*__: "Apache-2.0"
* **licensed** (boolean) Indicates if a license should be added. __*Default*__: true
* **maxNodeVersion** (string) Minimum node.js version to require via `engines` (inclusive). __*Default*__: no max
* **minNodeVersion** (string) Minimum Node.js version to require via package.json `engines` (inclusive). __*Default*__: no "engines" specified
* **npmAccess** ([javascript.NpmAccess](#projen-javascript-npmaccess)) Access level of the npm package. __*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
* **npmRegistry** (string) The host name of the npm registry to publish to. __*Optional*__
* **npmRegistryUrl** (string) The base URL of the npm package registry. __*Default*__: "https://registry.npmjs.org"
* **npmTokenSecret** (string) GitHub secret which contains the NPM token to use when publishing packages. __*Default*__: "NPM_TOKEN"
* **packageManager** ([javascript.NodePackageManager](#projen-javascript-nodepackagemanager)) The Node Package Manager used to execute scripts. __*Default*__: NodePackageManager.YARN
* **packageName** (string) The "name" in package.json. __*Default*__: defaults to project name
* **peerDependencyOptions** ([javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions)) Options for `peerDeps`. __*Optional*__
* **peerDeps** (Array) Peer dependencies for this module. __*Default*__: []
* **pnpmVersion** (string) The version of PNPM to use if using PNPM as a package manager. __*Default*__: "7"
* **repository** (string) The repository is the location where the actual code for your package lives. __*Optional*__
* **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. __*Optional*__
* **scopedPackagesOptions** (Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)>) Options for privately hosted scoped packages. __*Default*__: fetch all scoped packages from the public npm registry
* **scripts** (Map) npm scripts to include. __*Default*__: {}
* **stability** (string) Package's Stability. __*Optional*__
* **jsiiReleaseVersion** (string) Version requirement of `publib` which is used to publish modules to npm. __*Default*__: "latest"
* **majorVersion** (number) Major version to release from the default branch. __*Default*__: Major version is not enforced.
* **minMajorVersion** (number) Minimal Major version to release. __*Default*__: No minimum version is being enforced
* **npmDistTag** (string) The npmDistTag to use when publishing from the default branch. __*Default*__: "latest"
* **postBuildSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Steps to execute after build as part of the release workflow. __*Default*__: []
* **prerelease** (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). __*Default*__: normal semantic versions
* **publishDryRun** (boolean) Instead of actually publishing to package managers, just print the publishing command. __*Default*__: false
* **publishTasks** (boolean) Define publishing tasks that can be executed manually as well as workflows. __*Default*__: false
* **releaseBranches** (Map) Defines additional release branches. __*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
* **releaseEveryCommit** (boolean) Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
* **releaseFailureIssue** (boolean) Create a github issue on every failed publishing task. __*Default*__: false
* **releaseFailureIssueLabel** (string) The label to apply to issues indicating publish failures. __*Default*__: "failed-release"
* **releaseSchedule** (string) CRON schedule to trigger new releases. __*Default*__: no scheduled releases
* **releaseTagPrefix** (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. __*Default*__: "v"
* **releaseTrigger** ([release.ReleaseTrigger](#projen-release-releasetrigger)) The release trigger to use. __*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
* **releaseWorkflowName** (string) The name of the default release workflow. __*Default*__: "Release"
* **releaseWorkflowSetupSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) A set of workflow steps to execute in order to setup the workflow container. __*Optional*__
* **versionrcOptions** (Map) Custom configuration used when creating changelog with standard-version package. __*Default*__: standard configuration applicable for GitHub repositories
* **workflowContainerImage** (string) Container image to use for GitHub workflows. __*Default*__: default image
* **workflowRunsOn** (Array) Github Runner selection labels. __*Default*__: ["ubuntu-latest"]
* **defaultReleaseBranch** (string) The name of the main release branch.
* **artifactsDirectory** (string) A directory which will contain build artifacts. __*Default*__: "dist"
* **autoApproveUpgrades** (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). __*Default*__: true
* **buildWorkflow** (boolean) Define a GitHub workflow for building PRs. __*Default*__: true if not a subproject
* **buildWorkflowTriggers** ([github.workflows.Triggers](#projen-github-workflows-triggers)) Build workflow triggers. __*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
* **bundlerOptions** ([javascript.BundlerOptions](#projen-javascript-bundleroptions)) Options for `Bundler`. __*Optional*__
* **codeCov** (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`. __*Default*__: false
* **codeCovTokenSecret** (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. __*Default*__: if this option is not specified, only public repositories are supported
* **copyrightOwner** (string) License copyright owner. __*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
* **copyrightPeriod** (string) The copyright years to put in the LICENSE file. __*Default*__: current year
* **dependabot** (boolean) Use dependabot to handle dependency upgrades. __*Default*__: false
* **dependabotOptions** ([github.DependabotOptions](#projen-github-dependabotoptions)) Options for dependabot. __*Default*__: default options
* **depsUpgrade** (boolean) Use github workflows to handle dependency upgrades. __*Default*__: true
* **depsUpgradeOptions** ([javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions)) Options for `UpgradeDependencies`. __*Default*__: default options
* **gitignore** (Array) Additional entries to .gitignore. __*Optional*__
* **jest** (boolean) Setup jest unit tests. __*Default*__: true
* **jestOptions** ([javascript.JestOptions](#projen-javascript-jestoptions)) Jest options. __*Default*__: default options
* **mutableBuild** (boolean) Automatically update files modified during builds to pull-request branches. __*Default*__: true
* **npmignore** (Array) Additional entries to .npmignore. __*Optional*__
* **npmignoreEnabled** (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. __*Default*__: true
* **npmIgnoreOptions** ([IgnoreFileOptions](#projen-ignorefileoptions)) Configuration options for .npmignore file. __*Optional*__
* **package** (boolean) Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). __*Default*__: true
* **prettier** (boolean) Setup prettier. __*Default*__: false
* **prettierOptions** ([javascript.PrettierOptions](#projen-javascript-prettieroptions)) Prettier options. __*Default*__: default options
* **projenDevDependency** (boolean) Indicates of "projen" should be installed as a devDependency. __*Default*__: true
* **projenrcJs** (boolean) Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. __*Default*__: true if projenrcJson is false
* **projenrcJsOptions** ([javascript.ProjenrcOptions](#projen-javascript-projenrcoptions)) Options for .projenrc.js. __*Default*__: default options
* **projenVersion** (string) Version of projen to install. __*Default*__: Defaults to the latest version.
* **pullRequestTemplate** (boolean) Include a GitHub pull request template. __*Default*__: true
* **pullRequestTemplateContents** (Array) The contents of the pull request template. __*Default*__: default content
* **release** (boolean) Add release management to this project. __*Default*__: true (false for subprojects)
* **releaseToNpm** (boolean) Automatically release to npm when new versions are introduced. __*Default*__: false
* **releaseWorkflow** (boolean) DEPRECATED: renamed to `release`. __*Default*__: true if not a subproject
* **workflowBootstrapSteps** (Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)>) Workflow steps to use in order to bootstrap this repo. __*Default*__: "yarn install --frozen-lockfile && yarn projen"
* **workflowGitIdentity** ([github.GitIdentity](#projen-github-gitidentity)) The git identity to use in workflows. __*Default*__: GitHub Actions
* **workflowNodeVersion** (string) The node version to use in GitHub workflows. __*Default*__: same as `minNodeVersion`
* **workflowPackageCache** (boolean) Enable Node.js package cache in GitHub workflows. __*Default*__: false
* **disableTsconfig** (boolean) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). __*Default*__: false
* **disableTsconfigDev** (boolean) Do not generate a `tsconfig.dev.json` file. __*Default*__: false
* **docgen** (boolean) Docgen by Typedoc. __*Default*__: false
* **docsDirectory** (string) Docs directory. __*Default*__: "docs"
* **entrypointTypes** (string) The .d.ts file that includes the type declarations for this module. __*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
* **eslint** (boolean) Setup eslint. __*Default*__: true
* **eslintOptions** ([javascript.EslintOptions](#projen-javascript-eslintoptions)) Eslint options. __*Default*__: opinionated default options
* **libdir** (string) Typescript artifacts output directory. __*Default*__: "lib"
* **projenrcTs** (boolean) Use TypeScript for your projenrc file (`.projenrc.ts`). __*Default*__: false
* **projenrcTsOptions** ([typescript.ProjenrcOptions](#projen-typescript-projenrcoptions)) Options for .projenrc.ts. __*Optional*__
* **sampleCode** (boolean) Generate one-time sample in `src/` and `test/` if there are no files there. __*Default*__: true
* **srcdir** (string) Typescript sources directory. __*Default*__: "src"
* **testdir** (string) Jest tests directory. Tests files should be named `xxx.test.ts`. __*Default*__: "test"
* **tsconfig** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom TSConfig. __*Default*__: default options
* **tsconfigDev** ([javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions)) Custom tsconfig options for the development tsconfig.json file (used for testing). __*Default*__: use the production tsconfig options
* **tsconfigDevFile** (string) The name of the development tsconfig.json file. __*Default*__: "tsconfig.dev.json"
* **typescriptVersion** (string) TypeScript version to use. __*Default*__: "latest"
* **rewire** (Map) Rewire webpack configuration. __*Default*__: No rewired config.
### Properties
Name | Type | Description
-----|------|-------------
**srcdir**ð¹ | string | The directory in which source files reside.
## class TailwindConfig ð¹
Declares a Tailwind CSS configuration file.
There are multiple ways to add Tailwind CSS in your node project - see:
https://tailwindcss.com/docs/installation
__Submodule__: web
### Initializer
```ts
new web.TailwindConfig(project: NodeProject, options?: TailwindConfigOptions)
```
* **project** ([javascript.NodeProject](#projen-javascript-nodeproject)) *No description*
* **options** ([web.TailwindConfigOptions](#projen-web-tailwindconfigoptions)) *No description*
* **fileName** (string) *No description* __*Default*__: "tailwind.config.json"
### Properties
Name | Type | Description
-----|------|-------------
**file**ð¹ | [JsonFile](#projen-jsonfile) |
**fileName**ð¹ | string |
## struct CreateProjectOptions ð¹
Name | Type | Description
-----|------|-------------
**dir**ð¹ | string | Directory that the project will be generated in.
**projectFqn**ð¹ | string | Fully-qualified name of the project type (usually formatted as `projen.module.ProjectType`).
**projectOptions**ð¹ | Map | Project options.
**optionHints**?ð¹ | [InitProjectOptionHints](#projen-initprojectoptionhints) | Should we render commented-out default options in the projenrc file?
__*Default*__: InitProjectOptionHints.FEATURED
**post**?ð¹ | boolean | Should we execute post synthesis hooks?
__*Default*__: true
**synth**?ð¹ | boolean | Should we call `project.synth()` or instantiate the project (could still have side-effects) and render the .projenrc file.
__*Default*__: true
## struct Dependency ð¹
__Obtainable from__: [JavaProject](#projen-java-javaproject).[addPlugin](#projen-java-javaproject#projen-java-javaproject-addplugin)(), [Pom](#projen-java-pom).[addPlugin](#projen-java-pom#projen-java-pom-addplugin)(), [Dependencies](#projen-dependencies).[addDependency](#projen-dependencies#projen-dependencies-adddependency)(), [Dependencies](#projen-dependencies).[getDependency](#projen-dependencies#projen-dependencies-getdependency)(), [Dependencies](#projen-dependencies).[tryGetDependency](#projen-dependencies#projen-dependencies-trygetdependency)()
Represents a project dependency.
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | The package manager name of the dependency (e.g. `leftpad` for npm).
**type**ð¹ | [DependencyType](#projen-dependencytype) | Which type of dependency this is (runtime, build-time, etc).
**metadata**?ð¹ | Map | Additional JSON metadata associated with the dependency (package manager specific).
__*Default*__: {}
**version**?ð¹ | string | Semantic version version requirement.
__*Default*__: requirement is managed by the package manager (e.g. npm/yarn).
## struct DependencyCoordinates ð¹
__Obtainable from__: [Dependencies](#projen-dependencies).[parseDependency](#projen-dependencies#projen-dependencies-parsedependency)()
Coordinates of the dependency (name and version).
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | The package manager name of the dependency (e.g. `leftpad` for npm).
**version**?ð¹ | string | Semantic version version requirement.
__*Default*__: requirement is managed by the package manager (e.g. npm/yarn).
## struct DepsManifest ð¹
Name | Type | Description
-----|------|-------------
**dependencies**ð¹ | Array<[Dependency](#projen-dependency)> | All dependencies of this module.
## struct DevEnvironmentOptions ð¹
Base options for configuring a container-based development environment.
Name | Type | Description
-----|------|-------------
**dockerImage**?ð¹ | [DevEnvironmentDockerImage](#projen-devenvironmentdockerimage) | A Docker image or Dockerfile for the container.
__*Optional*__
**ports**?ð¹ | Array | An array of ports that should be exposed from the container.
__*Optional*__
**tasks**?ð¹ | Array<[Task](#projen-task)> | An array of tasks that should be run when the container starts.
__*Optional*__
**vscodeExtensions**?ð¹ | Array | An array of extension IDs that specify the extensions that should be installed inside the container when it is created.
__*Optional*__
## struct DockerComposeBuild ð¹
Build arguments for creating a docker image.
Name | Type | Description
-----|------|-------------
**context**ð¹ | string | Docker build context directory.
**args**?ð¹ | Map | Build args.
__*Default*__: none are provided
**dockerfile**?ð¹ | string | A dockerfile to build from.
__*Default*__: "Dockerfile"
## struct DockerComposeNetworkConfig ð¹
Network configuration.
Name | Type | Description
-----|------|-------------
**attachable**?ð¹ | boolean | Set to true to indicate that standalone containers can attach to this network, in addition to services.
__*Default*__: unset
**bridge**?ð¹ | boolean | Set to true to indicate that the network is a bridge network.
__*Default*__: unset
**driver**?ð¹ | string | Driver to use for the network.
__*Default*__: value is not provided
**driverOpts**?ð¹ | json | Options for the configured driver.
__*Default*__: value is not provided
**external**?ð¹ | boolean | Set to true to indicate that the network is externally created.
__*Default*__: unset, indicating that docker-compose creates the network
**internal**?ð¹ | boolean | Set to true to indicate that you want to create an externally isolated overlay network.
__*Default*__: unset
**ipam**?ð¹ | [DockerComposeNetworkIpamConfig](#projen-dockercomposenetworkipamconfig) | Specify custom IPAM config.
__*Default*__: unset
**labels**?ð¹ | Array | Attach labels to the network.
__*Default*__: unset
**name**?ð¹ | string | Name of the network for when the network name isn't going to work in YAML.
__*Default*__: unset, indicating that docker-compose creates networks as usual
**overlay**?ð¹ | boolean | Set to true to indicate that the network is an overlay network.
__*Default*__: unset
## struct DockerComposeNetworkIpamConfig ð¹
IPAM configuration.
Name | Type | Description
-----|------|-------------
**config**?ð¹ | Array<[DockerComposeNetworkIpamSubnetConfig](#projen-dockercomposenetworkipamsubnetconfig)> | A list with zero or more config blocks specifying custom IPAM configuration.
__*Default*__: value is not provided
**driver**?ð¹ | string | Driver to use for custom IPAM config.
__*Default*__: value is not provided
## struct DockerComposeNetworkIpamSubnetConfig ð¹
IPAM subnet configuration.
Name | Type | Description
-----|------|-------------
**subnet**?ð¹ | string | Subnet in CIDR format that represents a network segment.
__*Default*__: value is not provided
## struct DockerComposePortMappingOptions ð¹
Options for port mappings.
Name | Type | Description
-----|------|-------------
**protocol**?ð¹ | [DockerComposeProtocol](#projen-dockercomposeprotocol) | Port mapping protocol.
__*Default*__: DockerComposeProtocol.TCP
## struct DockerComposeProps ð¹
Props for DockerCompose.
Name | Type | Description
-----|------|-------------
**nameSuffix**?ð¹ | string | A name to add to the docker-compose.yml filename.
__*Default*__: no name is added
**schemaVersion**?ð¹ | string | Docker Compose schema version do be used.
__*Default*__: 3.3
**services**?ð¹ | Map | Service descriptions.
__*Optional*__
## struct DockerComposeServiceDescription ð¹
Description of a docker-compose.yml service.
Name | Type | Description
-----|------|-------------
**command**?ð¹ | Array | Provide a command to the docker container.
__*Default*__: use the container's default command
**dependsOn**?ð¹ | Array<[IDockerComposeServiceName](#projen-idockercomposeservicename)> | Names of other services this service depends on.
__*Default*__: no dependencies
**entrypoint**?ð¹ | Array | Entrypoint to run in the container.
__*Optional*__
**environment**?ð¹ | Map | Add environment variables.
__*Default*__: no environment variables are provided
**image**?ð¹ | string | Use a docker image.
__*Optional*__
**imageBuild**?ð¹ | [DockerComposeBuild](#projen-dockercomposebuild) | Build a docker image.
__*Optional*__
**labels**?ð¹ | Map | Add labels.
__*Default*__: no labels are provided
**networks**?ð¹ | Array<[IDockerComposeNetworkBinding](#projen-idockercomposenetworkbinding)> | Add some networks to the service.
__*Optional*__
**ports**?ð¹ | Array<[DockerComposeServicePort](#projen-dockercomposeserviceport)> | Map some ports.
__*Default*__: no ports are mapped
**volumes**?ð¹ | Array<[IDockerComposeVolumeBinding](#projen-idockercomposevolumebinding)> | Mount some volumes into the service.
__*Optional*__
## struct DockerComposeServicePort ð¹
__Obtainable from__: [DockerCompose](#projen-dockercompose).[portMapping](#projen-dockercompose#projen-dockercompose-portmapping)()
A service port mapping.
Name | Type | Description
-----|------|-------------
**mode**ð¹ | string | Port mapping mode.
**protocol**ð¹ | [DockerComposeProtocol](#projen-dockercomposeprotocol) | Network protocol.
**published**ð¹ | number | Published port number.
**target**ð¹ | number | Target port number.
## struct DockerComposeVolumeConfig ð¹
Volume configuration.
Name | Type | Description
-----|------|-------------
**driver**?ð¹ | string | Driver to use for the volume.
__*Default*__: value is not provided
**driverOpts**?ð¹ | Map | Options to provide to the driver.
__*Optional*__
**external**?ð¹ | boolean | Set to true to indicate that the volume is externally created.
__*Default*__: unset, indicating that docker-compose creates the volume
**name**?ð¹ | string | Name of the volume for when the volume name isn't going to work in YAML.
__*Default*__: unset, indicating that docker-compose creates volumes as usual
## struct DockerComposeVolumeMount ð¹
Service volume mounting information.
Name | Type | Description
-----|------|-------------
**source**ð¹ | string | Volume source.
**target**ð¹ | string | Volume target.
**type**ð¹ | string | Type of volume.
## struct FileBaseOptions ð¹
Name | Type | Description
-----|------|-------------
**committed**?ð¹ | boolean | Indicates whether this file should be committed to git or ignored.
__*Default*__: true
**editGitignore**?ð¹ | boolean | Update the project's .gitignore file.
__*Default*__: true
**executable**?ð¹ | boolean | Whether the generated file should be marked as executable.
__*Default*__: false
**marker**?ð¹ | boolean | Adds the projen marker to the file.
__*Default*__: marker will be included as long as the project is not ejected
**readonly**?ð¹ | boolean | Whether the generated file should be readonly.
__*Default*__: true
## struct GitOptions ð¹
Git configuration options.
Name | Type | Description
-----|------|-------------
**lfsPatterns**?ð¹ | Array | File patterns to mark as stored in Git LFS.
__*Default*__: No files stored in LFS
## struct GitpodOptions ð¹
Constructor options for the Gitpod component.
By default, Gitpod uses the 'gitpod/workspace-full' docker image.
Name | Type | Description
-----|------|-------------
**dockerImage**?ð¹ | [DevEnvironmentDockerImage](#projen-devenvironmentdockerimage) | A Docker image or Dockerfile for the container.
__*Optional*__
**ports**?ð¹ | Array | An array of ports that should be exposed from the container.
__*Optional*__
**prebuilds**?ð¹ | [GitpodPrebuilds](#projen-gitpodprebuilds) | Optional Gitpod's Github App integration for prebuilds If this is not set and Gitpod's Github App is installed, then Gitpod will apply these defaults: https://www.gitpod.io/docs/prebuilds/#configure-the-github-app.
__*Default*__: undefined
**tasks**?ð¹ | Array<[Task](#projen-task)> | An array of tasks that should be run when the container starts.
__*Optional*__
**vscodeExtensions**?ð¹ | Array | An array of extension IDs that specify the extensions that should be installed inside the container when it is created.
__*Optional*__
## struct GitpodPort ð¹
Options for an exposed port on Gitpod.
Name | Type | Description
-----|------|-------------
**onOpen**?ð¹ | [GitpodOnOpen](#projen-gitpodonopen) | What to do when a service on a port is detected.
__*Default*__: GitpodOnOpen.NOTIFY
**port**?ð¹ | string | A port that should be exposed (forwarded) from the container.
__*Optional*__
**visibility**?ð¹ | [GitpodPortVisibility](#projen-gitpodportvisibility) | Whether the port visibility should be private or public.
__*Default*__: GitpodPortVisibility.PUBLIC
## struct GitpodPrebuilds ð¹
Configure the Gitpod App for prebuilds.
Currently only GitHub is supported.
Name | Type | Description
-----|------|-------------
**addBadge**?ð¹ | boolean | Add a "Review in Gitpod" button to the pull request's description.
__*Default*__: false
**addCheck**?ð¹ | boolean | Add a check to pull requests.
__*Default*__: true
**addComment**?ð¹ | boolean | Add a "Review in Gitpod" button as a comment to pull requests.
__*Default*__: false
**addLabel**?ð¹ | boolean | Add a label once the prebuild is ready to pull requests.
__*Default*__: false
**branches**?ð¹ | boolean | Enable for all branches in this repo.
__*Default*__: false
**master**?ð¹ | boolean | Enable for the master/default branch.
__*Default*__: true
**pullRequests**?ð¹ | boolean | Enable for pull requests coming from this repo.
__*Default*__: true
**pullRequestsFromForks**?ð¹ | boolean | Enable for pull requests coming from forks.
__*Default*__: false
## struct GitpodTask ð¹
Configure options for a task to be run when opening a Gitpod workspace (e.g. running tests, or starting a dev server).
Start Mode | Execution
Fresh Workspace | before && init && command
Restart Workspace | before && command
Snapshot | before && command
Prebuild | before && init && prebuild
Name | Type | Description
-----|------|-------------
**command**ð¹ | string | Required.
**before**?ð¹ | string | In case you need to run something even before init, that is a requirement for both init and command, you can use the before property.
__*Optional*__
**init**?ð¹ | string | The init property can be used to specify shell commands that should only be executed after a workspace was freshly cloned and needs to be initialized somehow.
__*Optional*__
**name**?ð¹ | string | A name for this task.
__*Default*__: task names are omitted when blank
**openIn**?ð¹ | [GitpodOpenIn](#projen-gitpodopenin) | You can configure where in the IDE the terminal should be opened.
__*Default*__: GitpodOpenIn.BOTTOM
**openMode**?ð¹ | [GitpodOpenMode](#projen-gitpodopenmode) | You can configure how the terminal should be opened relative to the previous task.
__*Default*__: GitpodOpenMode.TAB_AFTER
**prebuild**?ð¹ | string | The optional prebuild command will be executed during prebuilds.
__*Optional*__
## interface IDevEnvironment ð¹
__Implemented by__: [vscode.DevContainer](#projen-vscode-devcontainer), [Gitpod](#projen-gitpod)
Abstract interface for container-based development environments, such as Gitpod and GitHub Codespaces.
### Methods
#### addDockerImage(image)ð¹
Add a custom Docker image or Dockerfile for the container.
```ts
addDockerImage(image: DevEnvironmentDockerImage): void
```
* **image** ([DevEnvironmentDockerImage](#projen-devenvironmentdockerimage)) The Docker image.
#### addPorts(...ports)ð¹
Adds ports that should be exposed (forwarded) from the container.
```ts
addPorts(...ports: string[]): void
```
* **ports** (string) The new ports.
#### addTasks(...tasks)ð¹
Adds tasks to run when the container starts.
```ts
addTasks(...tasks: Task[]): void
```
* **tasks** ([Task](#projen-task)) The new tasks.
#### addVscodeExtensions(...extensions)ð¹
Adds a list of VSCode extensions that should be automatically installed in the container.
```ts
addVscodeExtensions(...extensions: string[]): void
```
* **extensions** (string) The extension IDs.
## interface IDockerComposeNetworkBinding ð¹
__Obtainable from__: [DockerCompose](#projen-dockercompose).[network](#projen-dockercompose#projen-dockercompose-network)()
Network binding information.
### Methods
#### bind(networkConfig)ð¹
Binds the requested network to the docker-compose network configuration and provide mounting instructions for synthesis.
```ts
bind(networkConfig: IDockerComposeNetworkConfig): string
```
* **networkConfig** ([IDockerComposeNetworkConfig](#projen-idockercomposenetworkconfig)) the network configuration.
__Returns__:
* string
## interface IDockerComposeNetworkConfig ð¹
Storage for network configuration.
### Methods
#### addNetworkConfiguration(networkName, configuration)ð¹
Add network configuration to the repository.
```ts
addNetworkConfiguration(networkName: string, configuration: DockerComposeNetworkConfig): void
```
* **networkName** (string) *No description*
* **configuration** ([DockerComposeNetworkConfig](#projen-dockercomposenetworkconfig)) *No description*
* **attachable** (boolean) Set to true to indicate that standalone containers can attach to this network, in addition to services. __*Default*__: unset
* **bridge** (boolean) Set to true to indicate that the network is a bridge network. __*Default*__: unset
* **driver** (string) Driver to use for the network. __*Default*__: value is not provided
* **driverOpts** (json) Options for the configured driver. __*Default*__: value is not provided
* **external** (boolean) Set to true to indicate that the network is externally created. __*Default*__: unset, indicating that docker-compose creates the network
* **internal** (boolean) Set to true to indicate that you want to create an externally isolated overlay network. __*Default*__: unset
* **ipam** ([DockerComposeNetworkIpamConfig](#projen-dockercomposenetworkipamconfig)) Specify custom IPAM config. __*Default*__: unset
* **labels** (Array) Attach labels to the network. __*Default*__: unset
* **name** (string) Name of the network for when the network name isn't going to work in YAML. __*Default*__: unset, indicating that docker-compose creates networks as usual
* **overlay** (boolean) Set to true to indicate that the network is an overlay network. __*Default*__: unset
## interface IDockerComposeServiceName ð¹
__Implemented by__: [DockerComposeService](#projen-dockercomposeservice)
__Obtainable from__: [DockerCompose](#projen-dockercompose).[serviceName](#projen-dockercompose#projen-dockercompose-servicename)()
An interface providing the name of a docker compose service.
### Properties
Name | Type | Description
-----|------|-------------
**serviceName**ð¹ | string | The name of the docker compose service.
## interface IDockerComposeVolumeBinding ð¹
__Obtainable from__: [DockerCompose](#projen-dockercompose).[bindVolume](#projen-dockercompose#projen-dockercompose-bindvolume)(), [DockerCompose](#projen-dockercompose).[namedVolume](#projen-dockercompose#projen-dockercompose-namedvolume)()
Volume binding information.
### Methods
#### bind(volumeConfig)ð¹
Binds the requested volume to the docker-compose volume configuration and provide mounting instructions for synthesis.
```ts
bind(volumeConfig: IDockerComposeVolumeConfig): DockerComposeVolumeMount
```
* **volumeConfig** ([IDockerComposeVolumeConfig](#projen-idockercomposevolumeconfig)) the volume configuration.
__Returns__:
* [DockerComposeVolumeMount](#projen-dockercomposevolumemount)
## interface IDockerComposeVolumeConfig ð¹
Storage for volume configuration.
### Methods
#### addVolumeConfiguration(volumeName, configuration)ð¹
Add volume configuration to the repository.
```ts
addVolumeConfiguration(volumeName: string, configuration: DockerComposeVolumeConfig): void
```
* **volumeName** (string) *No description*
* **configuration** ([DockerComposeVolumeConfig](#projen-dockercomposevolumeconfig)) *No description*
* **driver** (string) Driver to use for the volume. __*Default*__: value is not provided
* **driverOpts** (Map) Options to provide to the driver. __*Optional*__
* **external** (boolean) Set to true to indicate that the volume is externally created. __*Default*__: unset, indicating that docker-compose creates the volume
* **name** (string) Name of the volume for when the volume name isn't going to work in YAML. __*Default*__: unset, indicating that docker-compose creates volumes as usual
## interface IResolvable ð¹
### Methods
#### toJSON()ð¹
Resolves and returns content.
```ts
toJSON(): any
```
__Returns__:
* any
## interface IResolver ð¹
API for resolving tokens when synthesizing file content.
### Methods
#### resolve(value, options?)ð¹
Given a value (object/string/array/whatever, looks up any functions inside the object and returns an object where all functions are called.
```ts
resolve(value: any, options?: ResolveOptions): any
```
* **value** (any) The value to resolve.
* **options** ([ResolveOptions](#projen-resolveoptions)) *No description*
* **args** (Array) Context arguments. __*Default*__: []
* **omitEmpty** (boolean) Omits empty arrays and objects. __*Default*__: false
__Returns__:
* any
## struct IgnoreFileOptions ð¹
Name | Type | Description
-----|------|-------------
**filterCommentLines**?ð¹ | boolean | Filter out comment lines?
__*Default*__: true
**filterEmptyLines**?ð¹ | boolean | Filter out blank/empty lines?
__*Default*__: true
## struct IniFileOptions ð¹
Options for `IniFile`.
Name | Type | Description
-----|------|-------------
**committed**?ð¹ | boolean | Indicates whether this file should be committed to git or ignored.
__*Default*__: true
**editGitignore**?ð¹ | boolean | Update the project's .gitignore file.
__*Default*__: true
**executable**?ð¹ | boolean | Whether the generated file should be marked as executable.
__*Default*__: false
**marker**?ð¹ | boolean | Adds the projen marker to the file.
__*Default*__: marker will be included as long as the project is not ejected
**obj**?ð¹ | any | The object that will be serialized.
__*Default*__: {} an empty object (use `file.obj` to mutate).
**omitEmpty**?ð¹ | boolean | Omits empty objects and arrays.
__*Default*__: false
**readonly**?ð¹ | boolean | Whether the generated file should be readonly.
__*Default*__: true
## struct InitProject ð¹
Information passed from `projen new` to the project object when the project is first created.
It is used to generate projenrc files in various languages.
Name | Type | Description
-----|------|-------------
**args**ð¹ | Map | Initial arguments passed to `projen new`.
**comments**ð¹ | [InitProjectOptionHints](#projen-initprojectoptionhints) | Include commented out options.
**fqn**ð¹ | string | The JSII FQN of the project type.
**type**ð¹ | [ProjectType](#projen-projecttype) | Project metadata.
## struct JsonFileOptions ð¹
Options for `JsonFile`.
Name | Type | Description
-----|------|-------------
**allowComments**?ð¹ | boolean | Allow the use of comments in this file.
__*Default*__: false for .json files, true for .json5 and .jsonc files
**committed**?ð¹ | boolean | Indicates whether this file should be committed to git or ignored.
__*Default*__: true
**editGitignore**?ð¹ | boolean | Update the project's .gitignore file.
__*Default*__: true
**executable**?ð¹ | boolean | Whether the generated file should be marked as executable.
__*Default*__: false
**marker**?ð¹ | boolean | Adds the projen marker to the file.
__*Default*__: marker will be included as long as the project is not ejected
**newline**?ð¹ | boolean | Adds a newline at the end of the file.
__*Default*__: true
**obj**?ð¹ | any | The object that will be serialized.
__*Default*__: {} an empty object (use `file.obj` to mutate).
**omitEmpty**?ð¹ | boolean | Omits empty objects and arrays.
__*Default*__: false
**readonly**?ð¹ | boolean | Whether the generated file should be readonly.
__*Default*__: true
## struct LicenseOptions ð¹
Name | Type | Description
-----|------|-------------
**spdx**ð¹ | string | License type (SPDX).
**copyrightOwner**?ð¹ | string | Copyright owner.
__*Default*__: -
**copyrightPeriod**?ð¹ | string | Period of license (e.g. "1998-2023").
__*Default*__: current year (e.g. "2020")
## struct LoggerOptions ð¹
Options for logging utilities.
Name | Type | Description
-----|------|-------------
**level**?ð¹ | [LogLevel](#projen-loglevel) | The logging verbosity.
__*Default*__: LogLevel.INFO
**usePrefix**?ð¹ | boolean | Include a prefix for all logging messages with the project name.
__*Default*__: false
## struct MakefileOptions ð¹
Options for Makefiles.
Name | Type | Description
-----|------|-------------
**all**?ð¹ | Array | List of targets to build when Make is invoked without specifying any targets.
__*Default*__: []
**committed**?ð¹ | boolean | Indicates whether this file should be committed to git or ignored.
__*Default*__: true
**editGitignore**?ð¹ | boolean | Update the project's .gitignore file.
__*Default*__: true
**executable**?ð¹ | boolean | Whether the generated file should be marked as executable.
__*Default*__: false
**marker**?ð¹ | boolean | Adds the projen marker to the file.
__*Default*__: marker will be included as long as the project is not ejected
**readonly**?ð¹ | boolean | Whether the generated file should be readonly.
__*Default*__: true
**rules**?ð¹ | Array<[Rule](#projen-rule)> | Rules to include in the Makefile.
__*Default*__: []
## struct ObjectFileOptions ð¹
Options for `ObjectFile`.
Name | Type | Description
-----|------|-------------
**committed**?ð¹ | boolean | Indicates whether this file should be committed to git or ignored.
__*Default*__: true
**editGitignore**?ð¹ | boolean | Update the project's .gitignore file.
__*Default*__: true
**executable**?ð¹ | boolean | Whether the generated file should be marked as executable.
__*Default*__: false
**marker**?ð¹ | boolean | Adds the projen marker to the file.
__*Default*__: marker will be included as long as the project is not ejected
**obj**?ð¹ | any | The object that will be serialized.
__*Default*__: {} an empty object (use `file.obj` to mutate).
**omitEmpty**?ð¹ | boolean | Omits empty objects and arrays.
__*Default*__: false
**readonly**?ð¹ | boolean | Whether the generated file should be readonly.
__*Default*__: true
## struct ProjectOptions ð¹
Options for `Project`.
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | This is the name of your project.
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
## struct ProjenrcJsonOptions ð¹
Name | Type | Description
-----|------|-------------
**filename**?ð¹ | string | The name of the projenrc file.
__*Default*__: ".projenrc.json"
## struct ProjenrcOptions â ïž
Name | Type | Description
-----|------|-------------
**filename**?â ïž | string | The name of the projenrc file.
__*Default*__: ".projenrc.json"
## struct RenovatebotOptions ð¹
Options for Renovatebot.
Name | Type | Description
-----|------|-------------
**ignore**?ð¹ | Array | You can use the `ignore` option to customize which dependencies are updated.
__*Default*__: []
**ignoreProjen**?ð¹ | boolean | Ignores updates to `projen`.
__*Default*__: true
**labels**?ð¹ | Array | List of labels to apply to the created PR's.
__*Optional*__
**marker**?ð¹ | boolean | __*Optional*__
**overrideConfig**?ð¹ | any | __*Optional*__
**scheduleInterval**?ð¹ | Array | How often to check for new versions and raise pull requests.
__*Default*__: ["at any time"]
## struct ResolveOptions ð¹
Resolve options.
Name | Type | Description
-----|------|-------------
**args**?ð¹ | Array | Context arguments.
__*Default*__: []
**omitEmpty**?ð¹ | boolean | Omits empty arrays and objects.
__*Default*__: false
## struct Rule ð¹
A Make rule.
Name | Type | Description
-----|------|-------------
**targets**ð¹ | Array | Files to be created or updated by this rule.
**phony**?ð¹ | boolean | Marks whether the target is phony.
__*Default*__: false
**prerequisites**?ð¹ | Array | Files that are used as inputs to create a target.
__*Default*__: []
**recipe**?ð¹ | Array | Commands that are run (using prerequisites as inputs) to create a target.
__*Default*__: []
## struct SampleDirOptions ð¹
SampleDir options.
Name | Type | Description
-----|------|-------------
**files**?ð¹ | Map | The files to render into the directory.
__*Optional*__
**sourceDir**?ð¹ | string | Absolute path to a directory to copy files from (does not need to be text files).
__*Optional*__
## struct SampleFileOptions ð¹
Options for the SampleFile object.
Name | Type | Description
-----|------|-------------
**contents**?ð¹ | string | The contents of the file to write.
__*Optional*__
**sourcePath**?ð¹ | string | Absolute path to a file to copy the contents from (does not need to be a text file).
__*Optional*__
## struct SampleReadmeProps ð¹
SampleReadme Properties.
Name | Type | Description
-----|------|-------------
**contents**?ð¹ | string | The contents.
__*Default*__: "# replace this"
**filename**?ð¹ | string | The name of the README.md file.
__*Default*__: "README.md"
## struct SnapshotOptions ð¹
Options for the Snapshot synthesis.
Name | Type | Description
-----|------|-------------
**parseJson**?ð¹ | boolean | Parse .json files as a JS object for improved inspection. This will fail if the contents are invalid JSON.
__*Default*__: true parse .json files into an object
## struct SourceCodeOptions ð¹
Options for `SourceCodeFile`.
Name | Type | Description
-----|------|-------------
**indent**?ð¹ | number | Indentation size.
__*Default*__: 2
**readonly**?ð¹ | boolean | Whether the generated file should be readonly.
__*Default*__: true
## struct TaskCommonOptions ð¹
Name | Type | Description
-----|------|-------------
**condition**?ð¹ | string | A shell command which determines if the this task should be executed.
__*Optional*__
**cwd**?ð¹ | string | The working directory for all steps in this task (unless overridden by the step).
__*Default*__: process.cwd()
**description**?ð¹ | string | The description of this build command.
__*Default*__: the task name
**env**?ð¹ | Map | Defines environment variables for the execution of this task.
__*Default*__: {}
**requiredEnv**?ð¹ | Array | A set of environment variables that must be defined in order to execute this task.
__*Optional*__
## struct TaskOptions ð¹
Name | Type | Description
-----|------|-------------
**args**?ð¹ | Array | Should the provided `exec` shell command receive fixed args.
__*Default*__: no arguments are passed to the step
**condition**?ð¹ | string | A shell command which determines if the this task should be executed.
__*Optional*__
**cwd**?ð¹ | string | The working directory for all steps in this task (unless overridden by the step).
__*Default*__: process.cwd()
**description**?ð¹ | string | The description of this build command.
__*Default*__: the task name
**env**?ð¹ | Map | Defines environment variables for the execution of this task.
__*Default*__: {}
**exec**?ð¹ | string | Shell command to execute as the first command of the task.
__*Default*__: add steps using `task.exec(command)` or `task.spawn(subtask)`
**receiveArgs**?ð¹ | boolean | Should the provided `exec` shell command receive args passed to the task.
__*Default*__: false
**requiredEnv**?ð¹ | Array | A set of environment variables that must be defined in order to execute this task.
__*Optional*__
**steps**?ð¹ | Array<[TaskStep](#projen-taskstep)> | List of task steps to run.
__*Optional*__
## struct TaskSpec ð¹
__Obtainable from__: [TaskRuntime](#projen-taskruntime).[tryFindTask](#projen-taskruntime#projen-taskruntime-tryfindtask)()
Specification of a single task.
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | Task name.
**condition**?ð¹ | string | A shell command which determines if the this task should be executed.
__*Optional*__
**cwd**?ð¹ | string | The working directory for all steps in this task (unless overridden by the step).
__*Default*__: process.cwd()
**description**?ð¹ | string | The description of this build command.
__*Default*__: the task name
**env**?ð¹ | Map | Defines environment variables for the execution of this task.
__*Default*__: {}
**requiredEnv**?ð¹ | Array | A set of environment variables that must be defined in order to execute this task.
__*Optional*__
**steps**?ð¹ | Array<[TaskStep](#projen-taskstep)> | Task steps.
__*Optional*__
## struct TaskStep ð¹
A single step within a task.
The step could either be the execution of a
shell command or execution of a sub-task, by name.
Name | Type | Description
-----|------|-------------
**args**?ð¹ | Array | A list of fixed arguments always passed to the step.
__*Default*__: no arguments are passed to the step
**builtin**?ð¹ | string | The name of a built-in task to execute.
__*Default*__: do not execute a builtin task
**condition**?ð¹ | string | A shell command which determines if the this step should be executed.
__*Optional*__
**cwd**?ð¹ | string | The working directory for this step.
__*Default*__: determined by the task
**env**?ð¹ | Map | Defines environment variables for the execution of this step (`exec` and `builtin` only).
__*Default*__: no environment variables defined in step
**exec**?ð¹ | string | Shell command to execute.
__*Default*__: don't execute a shell command
**name**?ð¹ | string | Step name.
__*Default*__: no name
**receiveArgs**?ð¹ | boolean | Should this step receive args passed to the task.
__*Default*__: false
**say**?ð¹ | string | Print a message.
__*Default*__: don't say anything
**spawn**?ð¹ | string | Subtask to execute.
__*Default*__: don't spawn a subtask
## struct TaskStepOptions ð¹
Options for task steps.
Name | Type | Description
-----|------|-------------
**args**?ð¹ | Array | A list of fixed arguments always passed to the step.
__*Default*__: no arguments are passed to the step
**condition**?ð¹ | string | A shell command which determines if the this step should be executed.
__*Optional*__
**cwd**?ð¹ | string | The working directory for this step.
__*Default*__: determined by the task
**env**?ð¹ | Map | Defines environment variables for the execution of this step (`exec` and `builtin` only).
__*Default*__: no environment variables defined in step
**name**?ð¹ | string | Step name.
__*Default*__: no name
**receiveArgs**?ð¹ | boolean | Should this step receive args passed to the task.
__*Default*__: false
## struct TasksManifest ð¹
Schema for `tasks.json`.
Name | Type | Description
-----|------|-------------
**env**?ð¹ | Map | Environment for all tasks.
__*Optional*__
**tasks**?ð¹ | Map | All tasks available for this project.
__*Optional*__
## struct TextFileOptions ð¹
Options for `TextFile`.
Name | Type | Description
-----|------|-------------
**committed**?ð¹ | boolean | Indicates whether this file should be committed to git or ignored.
__*Default*__: true
**editGitignore**?ð¹ | boolean | Update the project's .gitignore file.
__*Default*__: true
**executable**?ð¹ | boolean | Whether the generated file should be marked as executable.
__*Default*__: false
**lines**?ð¹ | Array | The contents of the text file.
__*Default*__: [] empty file
**marker**?ð¹ | boolean | Adds the projen marker to the file.
__*Default*__: marker will be included as long as the project is not ejected
**readonly**?ð¹ | boolean | Whether the generated file should be readonly.
__*Default*__: true
## struct TomlFileOptions ð¹
Options for `TomlFile`.
Name | Type | Description
-----|------|-------------
**committed**?ð¹ | boolean | Indicates whether this file should be committed to git or ignored.
__*Default*__: true
**editGitignore**?ð¹ | boolean | Update the project's .gitignore file.
__*Default*__: true
**executable**?ð¹ | boolean | Whether the generated file should be marked as executable.
__*Default*__: false
**marker**?ð¹ | boolean | Adds the projen marker to the file.
__*Default*__: marker will be included as long as the project is not ejected
**obj**?ð¹ | any | The object that will be serialized.
__*Default*__: {} an empty object (use `file.obj` to mutate).
**omitEmpty**?ð¹ | boolean | Omits empty objects and arrays.
__*Default*__: false
**readonly**?ð¹ | boolean | Whether the generated file should be readonly.
__*Default*__: true
## struct VersionOptions ð¹
Options for `Version`.
Name | Type | Description
-----|------|-------------
**artifactsDirectory**ð¹ | string | The name of the directory into which `changelog.md` and `version.txt` files are emitted.
**versionInputFile**ð¹ | string | A name of a .json file to set the `version` field in after a bump.
**tagPrefix**?ð¹ | string | The tag prefix corresponding to this version.
__*Optional*__
**versionrcOptions**?ð¹ | Map | Custom configuration for versionrc file used by standard-release.
__*Optional*__
## struct XmlFileOptions ð¹
Options for `XmlFile`.
Name | Type | Description
-----|------|-------------
**committed**?ð¹ | boolean | Indicates whether this file should be committed to git or ignored.
__*Default*__: true
**editGitignore**?ð¹ | boolean | Update the project's .gitignore file.
__*Default*__: true
**executable**?ð¹ | boolean | Whether the generated file should be marked as executable.
__*Default*__: false
**marker**?ð¹ | boolean | Adds the projen marker to the file.
__*Default*__: marker will be included as long as the project is not ejected
**obj**?ð¹ | any | The object that will be serialized.
__*Default*__: {} an empty object (use `file.obj` to mutate).
**omitEmpty**?ð¹ | boolean | Omits empty objects and arrays.
__*Default*__: false
**readonly**?ð¹ | boolean | Whether the generated file should be readonly.
__*Default*__: true
## struct YamlFileOptions ð¹
Options for `JsonFile`.
Name | Type | Description
-----|------|-------------
**committed**?ð¹ | boolean | Indicates whether this file should be committed to git or ignored.
__*Default*__: true
**editGitignore**?ð¹ | boolean | Update the project's .gitignore file.
__*Default*__: true
**executable**?ð¹ | boolean | Whether the generated file should be marked as executable.
__*Default*__: false
**lineWidth**?ð¹ | number | Maximum line width (set to 0 to disable folding).
__*Default*__: 0
**marker**?ð¹ | boolean | Adds the projen marker to the file.
__*Default*__: marker will be included as long as the project is not ejected
**obj**?ð¹ | any | The object that will be serialized.
__*Default*__: {} an empty object (use `file.obj` to mutate).
**omitEmpty**?ð¹ | boolean | Omits empty objects and arrays.
__*Default*__: false
**readonly**?ð¹ | boolean | Whether the generated file should be readonly.
__*Default*__: true
## struct AutoDiscoverCommonOptions ð¹
Common options for auto discovering project subcomponents.
Name | Type | Description
-----|------|-------------
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) | AWS CDK dependency manager.
**tsconfigPath**ð¹ | string | Path to the tsconfig file to use for integration tests.
## struct AutoDiscoverOptions ð¹
Options for `AutoDiscover`.
Name | Type | Description
-----|------|-------------
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) | AWS CDK dependency manager.
**srcdir**ð¹ | string | Project source tree (relative to project output directory).
**testdir**ð¹ | string | Test source tree.
**tsconfigPath**ð¹ | string | Path to the tsconfig file to use for integration tests.
**edgeLambdaAutoDiscover**?ð¹ | boolean | Auto-discover edge lambda functions.
__*Default*__: true
**integrationTestAutoDiscover**?ð¹ | boolean | Auto-discover integration tests.
__*Default*__: true
**integrationTestOptions**?ð¹ | [awscdk.IntegrationTestCommonOptions](#projen-awscdk-integrationtestcommonoptions) | Options for integration tests.
__*Optional*__
**lambdaAutoDiscover**?ð¹ | boolean | Auto-discover lambda functions.
__*Default*__: true
**lambdaExtensionAutoDiscover**?ð¹ | boolean | Auto-discover lambda extensions.
__*Default*__: true
**lambdaExtensionOptions**?ð¹ | [awscdk.LambdaExtensionCommonOptions](#projen-awscdk-lambdaextensioncommonoptions) | Options for lambda extensions.
__*Optional*__
**lambdaOptions**?ð¹ | [awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions) | Options for AWS Lambda functions.
__*Optional*__
## struct AwsCdkConstructLibraryOptions ð¹
Options for `AwsCdkConstructLibrary`.
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.
**repositoryUrl**ð¹ | string | Git repository URL.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**catalog**?ð¹ | [cdk.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:.
__*Default*__: new version will be announced
**cdkAssert**?â ïž | boolean | Warning: NodeJS only.
__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
**cdkAssertions**?ð¹ | boolean | Install the assertions library?
__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
**cdkDependencies**?â ïž | Array | Which AWS CDKv1 modules this project requires.
__*Optional*__
**cdkDependenciesAsDeps**?â ïž | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).
__*Default*__: true
**cdkTestDependencies**?â ïž | Array | AWS CDK modules required for testing.
__*Optional*__
**cdkVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for CDK.
__*Optional*__
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**compat**?ð¹ | boolean | Automatically run API compatibility test against the latest version published to npm after compilation.
__*Default*__: false
**compatIgnore**?ð¹ | string | Name of the ignore file for API compatibility tests.
__*Default*__: ".compatignore"
**compressAssembly**?ð¹ | boolean | Emit a compressed version of the assembly.
__*Default*__: false
**constructsVersion**?ð¹ | string | Minimum version of the `constructs` library to depend on.
__*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?ð¹ | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?ð¹ | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?ð¹ | boolean | Docgen by Typedoc.
__*Default*__: false
**docgenFilePath**?ð¹ | string | File path for generated docs.
__*Default*__: "API.md"
**docsDirectory**?ð¹ | string | Docs directory.
__*Default*__: "docs"
**dotnet**?â ïž | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | __*Optional*__
**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.
__*Default*__: true
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?ð¹ | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?ð¹ | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?ð¹ | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**excludeTypescript**?ð¹ | Array | Accepts a list of glob patterns.
__*Optional*__
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**integrationTestAutoDiscover**?ð¹ | boolean | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory.
__*Default*__: true
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**jsiiVersion**?ð¹ | string | Version of the jsii compiler to use.
__*Default*__: "1.x"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**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.
__*Default*__: true
**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.
__*Default*__: true
**lambdaOptions**?ð¹ | [awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions) | Common options for all AWS Lambda functions.
__*Default*__: default options
**libdir**?ð¹ | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**publishToGo**?ð¹ | [cdk.JsiiGoTarget](#projen-cdk-jsiigotarget) | Publish Go bindings to a git repository.
__*Default*__: no publishing
**publishToMaven**?ð¹ | [cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget) | Publish to maven.
__*Default*__: no publishing
**publishToNuget**?ð¹ | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | Publish to NuGet.
__*Default*__: no publishing
**publishToPypi**?ð¹ | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | Publish to pypi.
__*Default*__: no publishing
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**python**?â ïž | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | __*Optional*__
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**rootdir**?ð¹ | string | __*Default*__: "."
**sampleCode**?ð¹ | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Typescript sources directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?ð¹ | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?ð¹ | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?ð¹ | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct AwsCdkDepsCommonOptions ð¹
Options for `AwsCdkDeps`.
Name | Type | Description
-----|------|-------------
**cdkVersion**ð¹ | string | Minimum version of the AWS CDK to depend on.
**cdkAssert**?â ïž | boolean | Warning: NodeJS only.
__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
**cdkAssertions**?ð¹ | boolean | Install the assertions library?
__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
**cdkDependencies**?â ïž | Array | Which AWS CDKv1 modules this project requires.
__*Optional*__
**cdkDependenciesAsDeps**?â ïž | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).
__*Default*__: true
**cdkTestDependencies**?â ïž | Array | AWS CDK modules required for testing.
__*Optional*__
**cdkVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for CDK.
__*Optional*__
**constructsVersion**?ð¹ | string | Minimum version of the `constructs` library to depend on.
__*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
## struct AwsCdkDepsOptions ð¹
Name | Type | Description
-----|------|-------------
**cdkVersion**ð¹ | string | Minimum version of the AWS CDK to depend on.
**dependencyType**ð¹ | [DependencyType](#projen-dependencytype) | The type of dependency to use for runtime AWS CDK and `constructs` modules.
**cdkAssert**?â ïž | boolean | Warning: NodeJS only.
__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
**cdkAssertions**?ð¹ | boolean | Install the assertions library?
__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
**cdkDependencies**?â ïž | Array | Which AWS CDKv1 modules this project requires.
__*Optional*__
**cdkDependenciesAsDeps**?â ïž | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).
__*Default*__: true
**cdkTestDependencies**?â ïž | Array | AWS CDK modules required for testing.
__*Optional*__
**cdkVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for CDK.
__*Optional*__
**constructsVersion**?ð¹ | string | Minimum version of the `constructs` library to depend on.
__*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
## struct AwsCdkJavaAppOptions ð¹
Name | Type | Description
-----|------|-------------
**artifactId**ð¹ | string | The artifactId is generally the name that the project is known by.
**cdkVersion**ð¹ | string | Minimum version of the AWS CDK to depend on.
**groupId**ð¹ | string | This is generally unique amongst an organization or a project.
**mainClass**ð¹ | string | The name of the Java class with the static `main()` method.
**name**ð¹ | string | This is the name of your project.
**version**ð¹ | string | This is the last piece of the naming puzzle.
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**buildCommand**?ð¹ | string | A command to execute before synthesis.
__*Default*__: no build command
**cdkAssert**?â ïž | boolean | Warning: NodeJS only.
__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
**cdkAssertions**?ð¹ | boolean | Install the assertions library?
__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
**cdkDependencies**?â ïž | Array | Which AWS CDKv1 modules this project requires.
__*Optional*__
**cdkDependenciesAsDeps**?â ïž | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).
__*Default*__: true
**cdkTestDependencies**?â ïž | Array | AWS CDK modules required for testing.
__*Optional*__
**cdkVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for CDK.
__*Optional*__
**cdkout**?ð¹ | string | cdk.out directory.
__*Default*__: "cdk.out"
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**compileOptions**?ð¹ | [java.MavenCompileOptions](#projen-java-mavencompileoptions) | Compile options.
__*Default*__: defaults
**constructsVersion**?ð¹ | string | Minimum version of the `constructs` library to depend on.
__*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
**context**?ð¹ | Map | Additional context to include in `cdk.json`.
__*Default*__: no additional context
**deps**?ð¹ | Array | List of runtime dependencies for this project.
__*Default*__: []
**description**?ð¹ | string | Description of a project is always good.
__*Default*__: undefined
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**distdir**?ð¹ | string | Final artifact output directory.
__*Default*__: "dist/java"
**featureFlags**?ð¹ | boolean | Include all feature flags in cdk.json.
__*Default*__: true
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**junit**?ð¹ | boolean | Include junit tests.
__*Default*__: true
**junitOptions**?ð¹ | [java.JunitOptions](#projen-java-junitoptions) | junit options.
__*Default*__: defaults
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**packaging**?ð¹ | string | Project packaging format.
__*Default*__: "jar"
**packagingOptions**?ð¹ | [java.MavenPackagingOptions](#projen-java-mavenpackagingoptions) | Packaging options.
__*Default*__: defaults
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenrcJava**?ð¹ | boolean | Use projenrc in java.
__*Default*__: true
**projenrcJavaOptions**?ð¹ | [java.ProjenrcOptions](#projen-java-projenrcoptions) | Options related to projenrc in java.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**requireApproval**?ð¹ | [awscdk.ApprovalLevel](#projen-awscdk-approvallevel) | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.
__*Default*__: ApprovalLevel.BROADENING
**sample**?ð¹ | boolean | Include sample code and test if the relevant directories don't exist.
__*Default*__: true
**sampleJavaPackage**?ð¹ | string | The java package to use for the code sample.
__*Default*__: "org.acme"
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testDeps**?ð¹ | Array | List of test dependencies for this project.
__*Default*__: []
**url**?ð¹ | string | The URL, like the name, is not required.
__*Default*__: undefined
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**watchExcludes**?ð¹ | Array | Glob patterns to exclude from `cdk watch`.
__*Default*__: []
**watchIncludes**?ð¹ | Array | Glob patterns to include in `cdk watch`.
__*Default*__: []
## struct AwsCdkPackageNames ð¹
__Obtainable from__: [AwsCdkDeps](#projen-awscdk-awscdkdeps).[packageNames](#projen-awscdk-awscdkdeps#projen-awscdk-awscdkdeps-packagenames)(), [AwsCdkDepsJava](#projen-awscdk-awscdkdepsjava).[packageNames](#projen-awscdk-awscdkdepsjava#projen-awscdk-awscdkdepsjava-packagenames)(), [AwsCdkDepsJs](#projen-awscdk-awscdkdepsjs).[packageNames](#projen-awscdk-awscdkdepsjs#projen-awscdk-awscdkdepsjs-packagenames)(), [AwsCdkDepsPy](#projen-awscdk-awscdkdepspy).[packageNames](#projen-awscdk-awscdkdepspy#projen-awscdk-awscdkdepspy-packagenames)()
Language-specific AWS CDK package names.
Name | Type | Description
-----|------|-------------
**assertions**ð¹ | string | Fully qualified name of the assertions library package.
**constructs**ð¹ | string | Fully qualified name of the constructs library package.
**coreV1**ð¹ | string | Fully qualified name of the core framework package for CDKv1.
**coreV2**ð¹ | string | Fully qualified name of the core framework package for CDKv2.
**assert**?ð¹ | string | Fully qualified name of the assert library package Can be empty as it's only really available for javascript projects.
__*Optional*__
## struct AwsCdkPythonAppOptions ð¹
Options for `AwsCdkPythonApp`.
Name | Type | Description
-----|------|-------------
**authorEmail**ð¹ | string | Author's e-mail.
**authorName**ð¹ | string | Author's name.
**cdkVersion**ð¹ | string | Minimum version of the AWS CDK to depend on.
**moduleName**ð¹ | string | Name of the python package as used in imports and filenames.
**name**ð¹ | string | This is the name of your project.
**version**ð¹ | string | Version of the package.
**appEntrypoint**?ð¹ | string | The CDK app's entrypoint (relative to the source directory, which is "src" by default).
__*Default*__: "app.py"
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**buildCommand**?ð¹ | string | A command to execute before synthesis.
__*Default*__: no build command
**cdkAssert**?â ïž | boolean | Warning: NodeJS only.
__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
**cdkAssertions**?ð¹ | boolean | Install the assertions library?
__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
**cdkDependencies**?â ïž | Array | Which AWS CDKv1 modules this project requires.
__*Optional*__
**cdkDependenciesAsDeps**?â ïž | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).
__*Default*__: true
**cdkTestDependencies**?â ïž | Array | AWS CDK modules required for testing.
__*Optional*__
**cdkVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for CDK.
__*Optional*__
**cdkout**?ð¹ | string | cdk.out directory.
__*Default*__: "cdk.out"
**classifiers**?ð¹ | Array | A list of PyPI trove classifiers that describe the project.
__*Optional*__
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**constructsVersion**?ð¹ | string | Minimum version of the `constructs` library to depend on.
__*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
**context**?ð¹ | Map | Additional context to include in `cdk.json`.
__*Default*__: no additional context
**deps**?ð¹ | Array | List of runtime dependencies for this project.
__*Default*__: []
**description**?ð¹ | string | A short description of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | List of dev dependencies for this project.
__*Default*__: []
**featureFlags**?ð¹ | boolean | Include all feature flags in cdk.json.
__*Default*__: true
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | A URL to the website of the project.
__*Optional*__
**license**?ð¹ | string | License of this package as an SPDX identifier.
__*Optional*__
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**packageName**?ð¹ | string | Package name.
__*Optional*__
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**pip**?ð¹ | boolean | Use pip with a requirements.txt file to track project dependencies.
__*Default*__: true, unless poetry is true, then false
**poetry**?ð¹ | boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
__*Default*__: false
**poetryOptions**?ð¹ | [python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps) | Additional options to set for poetry if using poetry.
__*Optional*__
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenrcJs**?ð¹ | boolean | Use projenrc in javascript.
__*Default*__: false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options related to projenrc in JavaScript.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcPython**?ð¹ | boolean | Use projenrc in Python.
__*Default*__: true
**projenrcPythonOptions**?ð¹ | [python.ProjenrcOptions](#projen-python-projenrcoptions) | Options related to projenrc in python.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use projenrc in TypeScript.
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcTsOptions](#projen-typescript-projenrctsoptions) | Options related to projenrc in TypeScript.
__*Default*__: default options
**pytest**?ð¹ | boolean | Include pytest tests.
__*Default*__: true
**pytestOptions**?ð¹ | [python.PytestOptions](#projen-python-pytestoptions) | pytest options.
__*Default*__: defaults
**pythonExec**?ð¹ | string | Path to the python executable to use.
__*Default*__: "python"
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**requireApproval**?ð¹ | [awscdk.ApprovalLevel](#projen-awscdk-approvallevel) | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.
__*Default*__: ApprovalLevel.BROADENING
**sample**?ð¹ | boolean | Include sample code and test if the relevant directories don't exist.
__*Default*__: true
**setupConfig**?ð¹ | Map | Additional fields to pass in the setup() function if using setuptools.
__*Optional*__
**setuptools**?ð¹ | boolean | Use setuptools with a setup.py script for packaging and publishing.
__*Default*__: true, unless poetry is true, then false
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?ð¹ | string | Python sources directory.
__*Default*__: "tests"
**venv**?ð¹ | boolean | Use venv to manage a virtual environment for installing dependencies inside.
__*Default*__: true, unless poetry is true, then false
**venvOptions**?ð¹ | [python.VenvOptions](#projen-python-venvoptions) | Venv options.
__*Default*__: defaults
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**watchExcludes**?ð¹ | Array | Glob patterns to exclude from `cdk watch`.
__*Default*__: []
**watchIncludes**?ð¹ | Array | Glob patterns to include in `cdk watch`.
__*Default*__: []
## struct AwsCdkTypeScriptAppOptions ð¹
Name | Type | Description
-----|------|-------------
**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.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**appEntrypoint**?ð¹ | string | The CDK app's entrypoint (relative to the source directory, which is "src" by default).
__*Default*__: "main.ts"
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildCommand**?ð¹ | string | A command to execute before synthesis.
__*Default*__: no build command
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**cdkAssert**?â ïž | boolean | Warning: NodeJS only.
__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
**cdkAssertions**?ð¹ | boolean | Install the assertions library?
__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
**cdkDependencies**?â ïž | Array | Which AWS CDKv1 modules this project requires.
__*Optional*__
**cdkDependenciesAsDeps**?â ïž | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).
__*Default*__: true
**cdkTestDependencies**?â ïž | Array | AWS CDK modules required for testing.
__*Optional*__
**cdkVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for CDK.
__*Optional*__
**cdkout**?ð¹ | string | cdk.out directory.
__*Default*__: "cdk.out"
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**constructsVersion**?ð¹ | string | Minimum version of the `constructs` library to depend on.
__*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
**context**?ð¹ | Map | Additional context to include in `cdk.json`.
__*Default*__: no additional context
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?ð¹ | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?ð¹ | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?ð¹ | boolean | Docgen by Typedoc.
__*Default*__: false
**docsDirectory**?ð¹ | string | Docs directory.
__*Default*__: "docs"
**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.
__*Default*__: true
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?ð¹ | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?ð¹ | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?ð¹ | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**featureFlags**?ð¹ | boolean | Include all feature flags in cdk.json.
__*Default*__: true
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**integrationTestAutoDiscover**?ð¹ | boolean | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory.
__*Default*__: true
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**lambdaAutoDiscover**?ð¹ | boolean | Automatically adds an `awscdk.LambdaFunction` for each `.lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project.
__*Default*__: true
**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.
__*Default*__: true
**lambdaOptions**?ð¹ | [awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions) | Common options for all AWS Lambda functions.
__*Default*__: default options
**libdir**?ð¹ | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**requireApproval**?ð¹ | [awscdk.ApprovalLevel](#projen-awscdk-approvallevel) | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.
__*Default*__: ApprovalLevel.BROADENING
**sampleCode**?ð¹ | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Typescript sources directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?ð¹ | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?ð¹ | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?ð¹ | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**watchExcludes**?ð¹ | Array | Glob patterns to exclude from `cdk watch`.
__*Default*__: []
**watchIncludes**?ð¹ | Array | Glob patterns to include in `cdk watch`.
__*Default*__: []
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct CdkConfigCommonOptions ð¹
Common options for `cdk.json`.
Name | Type | Description
-----|------|-------------
**buildCommand**?ð¹ | string | A command to execute before synthesis.
__*Default*__: no build command
**cdkout**?ð¹ | string | cdk.out directory.
__*Default*__: "cdk.out"
**context**?ð¹ | Map | Additional context to include in `cdk.json`.
__*Default*__: no additional context
**featureFlags**?ð¹ | boolean | Include all feature flags in cdk.json.
__*Default*__: true
**requireApproval**?ð¹ | [awscdk.ApprovalLevel](#projen-awscdk-approvallevel) | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.
__*Default*__: ApprovalLevel.BROADENING
**watchExcludes**?ð¹ | Array | Glob patterns to exclude from `cdk watch`.
__*Default*__: []
**watchIncludes**?ð¹ | Array | Glob patterns to include in `cdk watch`.
__*Default*__: []
## struct CdkConfigOptions ð¹
Options for `CdkJson`.
Name | Type | Description
-----|------|-------------
**app**ð¹ | string | The command line to execute in order to synthesize the CDK application (language specific).
**buildCommand**?ð¹ | string | A command to execute before synthesis.
__*Default*__: no build command
**cdkout**?ð¹ | string | cdk.out directory.
__*Default*__: "cdk.out"
**context**?ð¹ | Map | Additional context to include in `cdk.json`.
__*Default*__: no additional context
**featureFlags**?ð¹ | boolean | Include all feature flags in cdk.json.
__*Default*__: true
**requireApproval**?ð¹ | [awscdk.ApprovalLevel](#projen-awscdk-approvallevel) | To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.
__*Default*__: ApprovalLevel.BROADENING
**watchExcludes**?ð¹ | Array | Glob patterns to exclude from `cdk watch`.
__*Default*__: []
**watchIncludes**?ð¹ | Array | Glob patterns to include in `cdk watch`.
__*Default*__: []
## struct ConstructLibraryAwsOptions â ïž
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.
**repositoryUrl**â ïž | string | Git repository URL.
**allowLibraryDependencies**?â ïž | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?â ïž | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?â ïž | string | Author's e-mail.
__*Optional*__
**authorName**?â ïž | string | Author's name.
__*Optional*__
**authorOrganization**?â ïž | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?â ïž | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?â ïž | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?â ïž | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?â ïž | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?â ïž | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?â ïž | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?â ïž | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?â ïž | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?â ïž | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?â ïž | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?â ïž | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?â ïž | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?â ïž | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**catalog**?â ïž | [cdk.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:.
__*Default*__: new version will be announced
**cdkAssert**?â ïž | boolean | Warning: NodeJS only.
__*Default*__: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
**cdkAssertions**?â ïž | boolean | Install the assertions library?
__*Default*__: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
**cdkDependencies**?â ïž | Array | Which AWS CDKv1 modules this project requires.
__*Optional*__
**cdkDependenciesAsDeps**?â ïž | boolean | If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).
__*Default*__: true
**cdkTestDependencies**?â ïž | Array | AWS CDK modules required for testing.
__*Optional*__
**cdkVersionPinning**?â ïž | boolean | Use pinned version instead of caret version for CDK.
__*Optional*__
**clobber**?â ïž | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?â ïž | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?â ïž | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?â ïž | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?â ïž | boolean | Whether to commit the managed files by default.
__*Default*__: true
**compat**?â ïž | boolean | Automatically run API compatibility test against the latest version published to npm after compilation.
__*Default*__: false
**compatIgnore**?â ïž | string | Name of the ignore file for API compatibility tests.
__*Default*__: ".compatignore"
**compressAssembly**?â ïž | boolean | Emit a compressed version of the assembly.
__*Default*__: false
**constructsVersion**?â ïž | string | Minimum version of the `constructs` library to depend on.
__*Default*__: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
**copyrightOwner**?â ïž | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?â ïž | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?â ïž | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?â ïž | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?â ïž | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?â ïž | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?â ïž | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?â ïž | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?â ïž | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?â ïž | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?â ïž | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?â ïž | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?â ïž | boolean | Docgen by Typedoc.
__*Default*__: false
**docgenFilePath**?â ïž | string | File path for generated docs.
__*Default*__: "API.md"
**docsDirectory**?â ïž | string | Docs directory.
__*Default*__: "docs"
**dotnet**?â ïž | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | __*Optional*__
**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.
__*Default*__: true
**entrypoint**?â ïž | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?â ïž | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?â ïž | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?â ïž | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**excludeTypescript**?â ïž | Array | Accepts a list of glob patterns.
__*Optional*__
**gitIgnoreOptions**?â ïž | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?â ïž | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?â ïž | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?â ïž | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?â ïž | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?â ïž | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?â ïž | string | Package's Homepage / Website.
__*Optional*__
**integrationTestAutoDiscover**?â ïž | boolean | Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory.
__*Default*__: true
**jest**?â ïž | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?â ïž | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?â ïž | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**jsiiVersion**?â ïž | string | Version of the jsii compiler to use.
__*Default*__: "1.x"
**keywords**?â ïž | Array | Keywords to include in `package.json`.
__*Optional*__
**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.
__*Default*__: true
**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.
__*Default*__: true
**lambdaOptions**?â ïž | [awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions) | Common options for all AWS Lambda functions.
__*Default*__: default options
**libdir**?â ïž | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?â ïž | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?â ïž | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?â ïž | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?â ïž | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?â ïž | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?â ïž | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?â ïž | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?â ïž | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?â ïž | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?â ïž | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?â ïž | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?â ïž | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?â ïž | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?â ïž | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?â ïž | string | The root directory of the project.
__*Default*__: "."
**package**?â ïž | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?â ïž | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?â ïž | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?â ïž | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?â ïž | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?â ïž | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?â ïž | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?â ïž | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?â ïž | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?â ïž | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?â ïž | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?â ïž | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?â ïž | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?â ïž | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?â ïž | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?â ïž | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?â ïž | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?â ïž | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?â ïž | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?â ïž | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?â ïž | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?â ïž | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?â ïž | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**publishToGo**?â ïž | [cdk.JsiiGoTarget](#projen-cdk-jsiigotarget) | Publish Go bindings to a git repository.
__*Default*__: no publishing
**publishToMaven**?â ïž | [cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget) | Publish to maven.
__*Default*__: no publishing
**publishToNuget**?â ïž | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | Publish to NuGet.
__*Default*__: no publishing
**publishToPypi**?â ïž | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | Publish to pypi.
__*Default*__: no publishing
**pullRequestTemplate**?â ïž | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?â ïž | Array | The contents of the pull request template.
__*Default*__: default content
**python**?â ïž | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | __*Optional*__
**readme**?â ïž | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?â ïž | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?â ïž | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?â ïž | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?â ïž | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?â ïž | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?â ïž | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?â ïž | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?â ïž | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?â ïž | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?â ïž | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?â ïž | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?â ïž | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**rootdir**?â ïž | string | __*Default*__: "."
**sampleCode**?â ïž | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?â ïž | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?â ïž | string | Typescript sources directory.
__*Default*__: "src"
**stability**?â ïž | string | Package's Stability.
__*Optional*__
**stale**?â ïž | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?â ïž | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?â ïž | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?â ïž | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?â ïž | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?â ïž | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?â ïž | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?â ïž | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?â ïž | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?â ïž | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?â ïž | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?â ïž | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?â ïž | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?â ïž | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?â ïž | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct EdgeLambdaAutoDiscoverOptions ð¹
Options for `EdgeLambdaAutoDiscover`.
Name | Type | Description
-----|------|-------------
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) | AWS CDK dependency manager.
**srcdir**ð¹ | string | Project source tree (relative to project output directory).
**tsconfigPath**ð¹ | string | Path to the tsconfig file to use for integration tests.
**lambdaOptions**?ð¹ | [awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions) | Options for AWS Lambda functions.
__*Optional*__
## struct IntegrationTestAutoDiscoverOptions ð¹
Options for `IntegrationTestAutoDiscover`.
Name | Type | Description
-----|------|-------------
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) | AWS CDK dependency manager.
**testdir**ð¹ | string | Test source tree.
**tsconfigPath**ð¹ | string | Path to the tsconfig file to use for integration tests.
**integrationTestOptions**?ð¹ | [awscdk.IntegrationTestCommonOptions](#projen-awscdk-integrationtestcommonoptions) | Options for integration tests.
__*Optional*__
## struct IntegrationTestCommonOptions ð¹
Name | Type | Description
-----|------|-------------
**destroyAfterDeploy**?ð¹ | boolean | Destroy the test app after a successful deployment.
__*Default*__: true
**pathMetadata**?ð¹ | boolean | Enables path metadata, adding `aws:cdk:path`, with the defining construct's path, to the CloudFormation metadata for each synthesized resource.
__*Default*__: false
## struct IntegrationTestOptions ð¹
Options for `IntegrationTest`.
Name | Type | Description
-----|------|-------------
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) | AWS CDK dependency manager.
**entrypoint**ð¹ | string | A path from the project root directory to a TypeScript file which contains the integration test app.
**tsconfigPath**ð¹ | string | The path of the tsconfig.json file to use when running integration test cdk apps.
**destroyAfterDeploy**?ð¹ | boolean | Destroy the test app after a successful deployment.
__*Default*__: true
**name**?ð¹ | string | Name of the integration test.
__*Default*__: Derived from the entrypoint filename.
**pathMetadata**?ð¹ | boolean | Enables path metadata, adding `aws:cdk:path`, with the defining construct's path, to the CloudFormation metadata for each synthesized resource.
__*Default*__: false
**stacks**?ð¹ | Array | A list of stacks within the integration test to deploy/destroy.
__*Default*__: ["**"]
## struct LambdaAutoDiscoverOptions ð¹
Options for `LambdaAutoDiscover`.
Name | Type | Description
-----|------|-------------
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) | AWS CDK dependency manager.
**srcdir**ð¹ | string | Project source tree (relative to project output directory).
**tsconfigPath**ð¹ | string | Path to the tsconfig file to use for integration tests.
**lambdaOptions**?ð¹ | [awscdk.LambdaFunctionCommonOptions](#projen-awscdk-lambdafunctioncommonoptions) | Options for AWS Lambda functions.
__*Optional*__
## struct LambdaExtensionAutoDiscoverOptions ð¹
Options for `LambdaExtensionAutoDiscover`.
Name | Type | Description
-----|------|-------------
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) | AWS CDK dependency manager.
**srcdir**ð¹ | string | Project source tree (relative to project output directory).
**tsconfigPath**ð¹ | string | Path to the tsconfig file to use for integration tests.
**lambdaExtensionOptions**?ð¹ | [awscdk.LambdaExtensionCommonOptions](#projen-awscdk-lambdaextensioncommonoptions) | Options for lambda extensions.
__*Optional*__
## struct LambdaExtensionCommonOptions ð¹
Common options for creating lambda extensions.
Name | Type | Description
-----|------|-------------
**bundlingOptions**?ð¹ | [javascript.BundlingOptions](#projen-javascript-bundlingoptions) | Bundling options for this AWS Lambda extension.
__*Default*__: defaults
**compatibleRuntimes**?ð¹ | Array<[awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime)> | The extension's compatible runtimes.
__*Optional*__
## struct LambdaExtensionOptions ð¹
Options for creating lambda extensions.
Name | Type | Description
-----|------|-------------
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) | AWS CDK dependency manager.
**entrypoint**ð¹ | string | A path from the project root directory to a TypeScript file which contains the AWS Lambda extension entrypoint (stand-alone script).
**bundlingOptions**?ð¹ | [javascript.BundlingOptions](#projen-javascript-bundlingoptions) | Bundling options for this AWS Lambda extension.
__*Default*__: defaults
**compatibleRuntimes**?ð¹ | Array<[awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime)> | The extension's compatible runtimes.
__*Optional*__
**constructFile**?ð¹ | string | The name of the generated TypeScript source file.
__*Default*__: The name of the entrypoint file, with the `-layer-version.ts` suffix instead of `.lambda-extension.ts`.
**constructName**?ð¹ | string | The name of the generated `lambda.LayerVersion` subclass.
__*Default*__: A pascal cased version of the name of the entrypoint file, with the extension `LayerVersion` (e.g. `AppConfigLayerVersion`).
**name**?ð¹ | string | Name of the extension.
__*Default*__: Derived from the entrypoint filename.
## struct LambdaFunctionCommonOptions ð¹
Common options for `LambdaFunction`.
Applies to all functions in
auto-discovery.
Name | Type | Description
-----|------|-------------
**awsSdkConnectionReuse**?ð¹ | boolean | Whether to automatically reuse TCP connections when working with the AWS SDK for JavaScript.
__*Default*__: true
**bundlingOptions**?ð¹ | [javascript.BundlingOptions](#projen-javascript-bundlingoptions) | Bundling options for this AWS Lambda function.
__*Default*__: defaults
**edgeLambda**?ð¹ | boolean | Whether to create a `cloudfront.experimental.EdgeFunction` instead of a `lambda.Function`.
__*Default*__: false
**runtime**?ð¹ | [awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime) | The node.js version to target.
__*Default*__: Runtime.NODEJS_16_X
## struct LambdaFunctionOptions ð¹
Options for `Function`.
Name | Type | Description
-----|------|-------------
**cdkDeps**ð¹ | [awscdk.AwsCdkDeps](#projen-awscdk-awscdkdeps) | AWS CDK dependency manager.
**entrypoint**ð¹ | string | A path from the project root directory to a TypeScript file which contains the AWS Lambda handler entrypoint (exports a `handler` function).
**awsSdkConnectionReuse**?ð¹ | boolean | Whether to automatically reuse TCP connections when working with the AWS SDK for JavaScript.
__*Default*__: true
**bundlingOptions**?ð¹ | [javascript.BundlingOptions](#projen-javascript-bundlingoptions) | Bundling options for this AWS Lambda function.
__*Default*__: defaults
**constructFile**?ð¹ | string | The name of the generated TypeScript source file.
__*Default*__: The name of the entrypoint file, with the `-function.ts` suffix instead of `.lambda.ts`.
**constructName**?ð¹ | string | The name of the generated `lambda.Function` subclass.
__*Default*__: A pascal cased version of the name of the entrypoint file, with the extension `Function` (e.g. `ResizeImageFunction`).
**edgeLambda**?ð¹ | boolean | Whether to create a `cloudfront.experimental.EdgeFunction` instead of a `lambda.Function`.
__*Default*__: false
**runtime**?ð¹ | [awscdk.LambdaRuntime](#projen-awscdk-lambdaruntime) | The node.js version to target.
__*Default*__: Runtime.NODEJS_16_X
## struct LambdaRuntimeOptions ð¹
Options for the AWS Lambda function runtime.
Name | Type | Description
-----|------|-------------
**defaultExternals**?ð¹ | Array | Packages that are considered externals by default when bundling.
__*Default*__: ['@aws-sdk/*']
## struct AddPostBuildJobCommandsOptions ð¹
Options for `BuildWorkflow.addPostBuildJobCommands`.
Name | Type | Description
-----|------|-------------
**checkoutRepo**?ð¹ | boolean | Check out the repository at the pull request branch before commands are run.
__*Default*__: false
**installDeps**?ð¹ | boolean | Install project dependencies before running commands. `checkoutRepo` must also be set to true.
__*Default*__: false
**runsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
**tools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Tools that should be installed before the commands are run.
__*Optional*__
## struct AddPostBuildJobTaskOptions ð¹
Options for `BuildWorkflow.addPostBuildJobTask`.
Name | Type | Description
-----|------|-------------
**runsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
**tools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Tools that should be installed before the task is run.
__*Optional*__
## struct BuildWorkflowOptions ð¹
Name | Type | Description
-----|------|-------------
**artifactsDirectory**ð¹ | string | A name of a directory that includes build artifacts.
**buildTask**ð¹ | [Task](#projen-task) | The task to execute in order to build the project.
**containerImage**?ð¹ | string | The container image to use for builds.
__*Default*__: the default workflow container
**env**?ð¹ | Map | Build environment variables.
__*Default*__: {}
**gitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | Git identity to use for the workflow.
__*Default*__: default identity
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**name**?ð¹ | string | Name of the buildfile (e.g. "build" becomes "build.yml").
__*Default*__: "build"
**permissions**?ð¹ | [github.workflows.JobPermissions](#projen-github-workflows-jobpermissions) | Permissions granted to the build job To limit job permissions for `contents`, the desired permissions have to be explicitly set, e.g.: `{ contents: JobPermission.NONE }`.
__*Default*__: `{ contents: JobPermission.WRITE }`
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build.
__*Default*__: []
**preBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before the build.
__*Default*__: []
**runsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
**workflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
## struct AutoDiscoverBaseOptions ð¹
Options for `AutoDiscoverBase`.
Name | Type | Description
-----|------|-------------
**extension**ð¹ | string | Locate files with the given extension.
**projectdir**ð¹ | string | Locate entrypoints in the given project directory.
## struct Catalog ð¹
Name | Type | Description
-----|------|-------------
**announce**?ð¹ | boolean | Should we announce new versions?
__*Default*__: true
**twitter**?ð¹ | string | Twitter account to.
__*Optional*__
## struct ConstructLibraryOptions ð¹
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.
**repositoryUrl**ð¹ | string | Git repository URL.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**catalog**?ð¹ | [cdk.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:.
__*Default*__: new version will be announced
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**compat**?ð¹ | boolean | Automatically run API compatibility test against the latest version published to npm after compilation.
__*Default*__: false
**compatIgnore**?ð¹ | string | Name of the ignore file for API compatibility tests.
__*Default*__: ".compatignore"
**compressAssembly**?ð¹ | boolean | Emit a compressed version of the assembly.
__*Default*__: false
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?ð¹ | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?ð¹ | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?ð¹ | boolean | Docgen by Typedoc.
__*Default*__: false
**docgenFilePath**?ð¹ | string | File path for generated docs.
__*Default*__: "API.md"
**docsDirectory**?ð¹ | string | Docs directory.
__*Default*__: "docs"
**dotnet**?â ïž | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | __*Optional*__
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?ð¹ | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?ð¹ | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?ð¹ | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**excludeTypescript**?ð¹ | Array | Accepts a list of glob patterns.
__*Optional*__
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**jsiiVersion**?ð¹ | string | Version of the jsii compiler to use.
__*Default*__: "1.x"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**libdir**?ð¹ | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**publishToGo**?ð¹ | [cdk.JsiiGoTarget](#projen-cdk-jsiigotarget) | Publish Go bindings to a git repository.
__*Default*__: no publishing
**publishToMaven**?ð¹ | [cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget) | Publish to maven.
__*Default*__: no publishing
**publishToNuget**?ð¹ | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | Publish to NuGet.
__*Default*__: no publishing
**publishToPypi**?ð¹ | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | Publish to pypi.
__*Default*__: no publishing
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**python**?â ïž | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | __*Optional*__
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**rootdir**?ð¹ | string | __*Default*__: "."
**sampleCode**?ð¹ | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Typescript sources directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?ð¹ | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?ð¹ | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?ð¹ | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct IntegrationTestAutoDiscoverBaseOptions ð¹
Options for `IntegrationTestAutoDiscoverBase`.
Name | Type | Description
-----|------|-------------
**testdir**ð¹ | string | Test source tree.
## struct IntegrationTestBaseOptions ð¹
Options for IntegrationTest.
Name | Type | Description
-----|------|-------------
**entrypoint**ð¹ | string | A path from the project root directory to a TypeScript file which contains the integration test app.
**tsconfigPath**ð¹ | string | The path of the tsconfig.json file to use when running integration test cdk apps.
**name**?ð¹ | string | Name of the integration test.
__*Default*__: Derived from the entrypoint filename.
## struct JsiiDocgenOptions ð¹
Options for `JsiiDocgen`.
Name | Type | Description
-----|------|-------------
**filePath**?ð¹ | string | File path for generated docs.
__*Default*__: "API.md"
## struct JsiiDotNetTarget ð¹
Name | Type | Description
-----|------|-------------
**dotNetNamespace**ð¹ | string |
**packageId**ð¹ | string |
**iconUrl**?ð¹ | string | __*Optional*__
**nugetApiKeySecret**?ð¹ | string | GitHub secret which contains the API key for NuGet.
__*Default*__: "NUGET_API_KEY"
**nugetServer**?ð¹ | string | NuGet Server URL (defaults to nuget.org).
__*Optional*__
**prePublishSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
## struct JsiiGoTarget ð¹
Go target configuration.
Name | Type | Description
-----|------|-------------
**moduleName**ð¹ | string | The name of the target go module.
**gitBranch**?ð¹ | string | Branch to push to.
__*Default*__: "main"
**gitCommitMessage**?ð¹ | string | The commit message.
__*Default*__: "chore(release): $VERSION"
**gitUserEmail**?ð¹ | string | The email to use in the release git commit.
__*Default*__: "github-actions@github.com"
**gitUserName**?ð¹ | string | The user name to use for the release git commit.
__*Default*__: "github-actions"
**githubDeployKeySecret**?ð¹ | string | The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.
__*Default*__: "GO_GITHUB_DEPLOY_KEY"
**githubRepo**?ð¹ | string | GitHub repository to push to.
__*Default*__: derived from `moduleName`
**githubTokenSecret**?ð¹ | string | The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.
__*Default*__: "GO_GITHUB_TOKEN"
**githubUseSsh**?ð¹ | boolean | Use SSH to push to GitHub instead of a personal accses token.
__*Default*__: false
**packageName**?ð¹ | string | The name of the go package.
__*Default*__: derived from the module name
**prePublishSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
## struct JsiiJavaTarget ð¹
Name | Type | Description
-----|------|-------------
**javaPackage**ð¹ | string |
**mavenArtifactId**ð¹ | string |
**mavenGroupId**ð¹ | string |
**mavenEndpoint**?ð¹ | string | URL of Nexus repository.
__*Default*__: "https://oss.sonatype.org"
**mavenGpgPrivateKeyPassphrase**?ð¹ | string | GitHub secret name which contains the GPG private key or file that includes it.
__*Default*__: "MAVEN_GPG_PRIVATE_KEY_PASSPHRASE" or not set when using GitHub Packages
**mavenGpgPrivateKeySecret**?ð¹ | string | GitHub secret name which contains the GPG private key or file that includes it.
__*Default*__: "MAVEN_GPG_PRIVATE_KEY" or not set when using GitHub Packages
**mavenPassword**?ð¹ | string | GitHub secret name which contains the Password for maven repository.
__*Default*__: "MAVEN_PASSWORD" or "GITHUB_TOKEN" when using GitHub Packages
**mavenRepositoryUrl**?ð¹ | string | Deployment repository when not deploying to Maven Central.
__*Default*__: not set
**mavenServerId**?ð¹ | string | Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).
__*Default*__: "ossrh" (Maven Central) or "github" when using GitHub Packages
**mavenStagingProfileId**?ð¹ | string | GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org (e.g. https://oss.sonatype.org/#stagingProfiles;11a33451234521).
__*Default*__: "MAVEN_STAGING_PROFILE_ID" or not set when using GitHub Packages
**mavenUsername**?ð¹ | string | GitHub secret name which contains the Username for maven repository.
__*Default*__: "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages
**prePublishSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
## struct JsiiProjectOptions ð¹
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.
**repositoryUrl**ð¹ | string | Git repository URL.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**compat**?ð¹ | boolean | Automatically run API compatibility test against the latest version published to npm after compilation.
__*Default*__: false
**compatIgnore**?ð¹ | string | Name of the ignore file for API compatibility tests.
__*Default*__: ".compatignore"
**compressAssembly**?ð¹ | boolean | Emit a compressed version of the assembly.
__*Default*__: false
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?ð¹ | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?ð¹ | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?ð¹ | boolean | Docgen by Typedoc.
__*Default*__: false
**docgenFilePath**?ð¹ | string | File path for generated docs.
__*Default*__: "API.md"
**docsDirectory**?ð¹ | string | Docs directory.
__*Default*__: "docs"
**dotnet**?â ïž | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | __*Optional*__
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?ð¹ | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?ð¹ | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?ð¹ | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**excludeTypescript**?ð¹ | Array | Accepts a list of glob patterns.
__*Optional*__
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**jsiiVersion**?ð¹ | string | Version of the jsii compiler to use.
__*Default*__: "1.x"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**libdir**?ð¹ | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**publishToGo**?ð¹ | [cdk.JsiiGoTarget](#projen-cdk-jsiigotarget) | Publish Go bindings to a git repository.
__*Default*__: no publishing
**publishToMaven**?ð¹ | [cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget) | Publish to maven.
__*Default*__: no publishing
**publishToNuget**?ð¹ | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | Publish to NuGet.
__*Default*__: no publishing
**publishToPypi**?ð¹ | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | Publish to pypi.
__*Default*__: no publishing
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**python**?â ïž | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | __*Optional*__
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**rootdir**?ð¹ | string | __*Default*__: "."
**sampleCode**?ð¹ | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Typescript sources directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?ð¹ | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?ð¹ | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?ð¹ | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct JsiiPythonTarget ð¹
Name | Type | Description
-----|------|-------------
**distName**ð¹ | string |
**module**ð¹ | string |
**prePublishSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
**twinePasswordSecret**?ð¹ | string | The GitHub secret which contains PyPI password.
__*Default*__: "TWINE_PASSWORD"
**twineRegistryUrl**?ð¹ | string | The registry url to use when releasing packages.
__*Default*__: twine default
**twineUsernameSecret**?ð¹ | string | The GitHub secret which contains PyPI user name.
__*Default*__: "TWINE_USERNAME"
## struct AutoDiscoverOptions ð¹
Options for `AutoDiscover`.
Name | Type | Description
-----|------|-------------
**testdir**ð¹ | string | Test source tree.
**tsconfigPath**ð¹ | string | Path to the tsconfig file to use for integration tests.
**integrationTestAutoDiscover**?ð¹ | boolean | Automatically discover integration tests.
__*Default*__: true
## struct Cdk8sDepsCommonOptions ð¹
Options for `Cdk8sDeps`.
Name | Type | Description
-----|------|-------------
**cdk8sVersion**ð¹ | string | Minumum version of the cdk8s to depend on.
**cdk8sCliVersion**?ð¹ | string | Minumum version of the cdk8s-cli to depend on.
__*Default*__: "2.0.28"
**cdk8sCliVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s-cli.
__*Default*__: false
**cdk8sPlus**?ð¹ | boolean | Include cdk8s-plus.
__*Default*__: true
**cdk8sPlusVersion**?ð¹ | string | Minumum version of the cdk8s-plus-XX to depend on.
__*Default*__: "2.0.0-rc.26"
**cdk8sPlusVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s-plus-17.
__*Default*__: false
**cdk8sVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s.
__*Default*__: false
**constructsVersion**?ð¹ | string | Minimum version of the `constructs` library to depend on.
__*Default*__: "10.1.42"
**constructsVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for constructs.
__*Default*__: false
**k8sMinorVersion**?ð¹ | number | The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.
__*Default*__: 22
## struct Cdk8sDepsOptions ð¹
Name | Type | Description
-----|------|-------------
**cdk8sCliDependency**ð¹ | boolean | Add cdk8s-cli only to Node projects.
**cdk8sVersion**ð¹ | string | Minumum version of the cdk8s to depend on.
**dependencyType**ð¹ | [DependencyType](#projen-dependencytype) | The type of dependency to use for runtime CDK8s and `constructs` modules.
**cdk8sCliVersion**?ð¹ | string | Minumum version of the cdk8s-cli to depend on.
__*Default*__: "2.0.28"
**cdk8sCliVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s-cli.
__*Default*__: false
**cdk8sPlus**?ð¹ | boolean | Include cdk8s-plus.
__*Default*__: true
**cdk8sPlusVersion**?ð¹ | string | Minumum version of the cdk8s-plus-XX to depend on.
__*Default*__: "2.0.0-rc.26"
**cdk8sPlusVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s-plus-17.
__*Default*__: false
**cdk8sVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s.
__*Default*__: false
**constructsVersion**?ð¹ | string | Minimum version of the `constructs` library to depend on.
__*Default*__: "10.1.42"
**constructsVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for constructs.
__*Default*__: false
**k8sMinorVersion**?ð¹ | number | The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.
__*Default*__: 22
## struct Cdk8sPackageNames ð¹
__Obtainable from__: [Cdk8sDeps](#projen-cdk8s-cdk8sdeps).[packageNames](#projen-cdk8s-cdk8sdeps#projen-cdk8s-cdk8sdeps-packagenames)(), [Cdk8sDepsPy](#projen-cdk8s-cdk8sdepspy).[packageNames](#projen-cdk8s-cdk8sdepspy#projen-cdk8s-cdk8sdepspy-packagenames)()
Name | Type | Description
-----|------|-------------
**cdk8s**ð¹ | string | Fully qualified name of the core framework package.
**cdk8sPlus**ð¹ | string | Fully qualified name of the cdk9s-plus-XX library package.
**constructs**ð¹ | string | Fully qualified name of the constructs library package.
**cdk8sClient**?ð¹ | string | Fully qualified name of the client package.
__*Optional*__
## struct Cdk8sPythonOptions ð¹
Options for `Cdk8sPythonApp`.
Name | Type | Description
-----|------|-------------
**authorEmail**ð¹ | string | Author's e-mail.
**authorName**ð¹ | string | Author's name.
**cdk8sVersion**ð¹ | string | Minumum version of the cdk8s to depend on.
**moduleName**ð¹ | string | Name of the python package as used in imports and filenames.
**name**ð¹ | string | This is the name of your project.
**version**ð¹ | string | Version of the package.
**appEntrypoint**?ð¹ | string | The CDK8s app's entrypoint.
__*Default*__: "app.py"
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**cdk8sCliVersion**?ð¹ | string | Minumum version of the cdk8s-cli to depend on.
__*Default*__: "2.0.28"
**cdk8sCliVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s-cli.
__*Default*__: false
**cdk8sImports**?ð¹ | Array | Import additional specs.
__*Default*__: no additional specs imported
**cdk8sPlus**?ð¹ | boolean | Include cdk8s-plus.
__*Default*__: true
**cdk8sPlusVersion**?ð¹ | string | Minumum version of the cdk8s-plus-XX to depend on.
__*Default*__: "2.0.0-rc.26"
**cdk8sPlusVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s-plus-17.
__*Default*__: false
**cdk8sVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s.
__*Default*__: false
**classifiers**?ð¹ | Array | A list of PyPI trove classifiers that describe the project.
__*Optional*__
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**constructsVersion**?ð¹ | string | Minimum version of the `constructs` library to depend on.
__*Default*__: "10.1.42"
**constructsVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for constructs.
__*Default*__: false
**deps**?ð¹ | Array | List of runtime dependencies for this project.
__*Default*__: []
**description**?ð¹ | string | A short description of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | List of dev dependencies for this project.
__*Default*__: []
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | A URL to the website of the project.
__*Optional*__
**k8sMinorVersion**?ð¹ | number | The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.
__*Default*__: 22
**k8sSpecVersion**?ð¹ | string | Import a specific Kubernetes spec version.
__*Default*__: Use the cdk8s default
**license**?ð¹ | string | License of this package as an SPDX identifier.
__*Optional*__
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**packageName**?ð¹ | string | Package name.
__*Optional*__
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**pip**?ð¹ | boolean | Use pip with a requirements.txt file to track project dependencies.
__*Default*__: true, unless poetry is true, then false
**poetry**?ð¹ | boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
__*Default*__: false
**poetryOptions**?ð¹ | [python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps) | Additional options to set for poetry if using poetry.
__*Optional*__
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenrcJs**?ð¹ | boolean | Use projenrc in javascript.
__*Default*__: false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options related to projenrc in JavaScript.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcPython**?ð¹ | boolean | Use projenrc in Python.
__*Default*__: true
**projenrcPythonOptions**?ð¹ | [python.ProjenrcOptions](#projen-python-projenrcoptions) | Options related to projenrc in python.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use projenrc in TypeScript.
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcTsOptions](#projen-typescript-projenrctsoptions) | Options related to projenrc in TypeScript.
__*Default*__: default options
**pytest**?ð¹ | boolean | Include pytest tests.
__*Default*__: true
**pytestOptions**?ð¹ | [python.PytestOptions](#projen-python-pytestoptions) | pytest options.
__*Default*__: defaults
**pythonExec**?ð¹ | string | Path to the python executable to use.
__*Default*__: "python"
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**sample**?ð¹ | boolean | Include sample code and test if the relevant directories don't exist.
__*Default*__: true
**setupConfig**?ð¹ | Map | Additional fields to pass in the setup() function if using setuptools.
__*Optional*__
**setuptools**?ð¹ | boolean | Use setuptools with a setup.py script for packaging and publishing.
__*Default*__: true, unless poetry is true, then false
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**venv**?ð¹ | boolean | Use venv to manage a virtual environment for installing dependencies inside.
__*Default*__: true, unless poetry is true, then false
**venvOptions**?ð¹ | [python.VenvOptions](#projen-python-venvoptions) | Venv options.
__*Default*__: defaults
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
## struct Cdk8sTypeScriptAppOptions ð¹
Name | Type | Description
-----|------|-------------
**cdk8sVersion**ð¹ | string | Minumum version of the cdk8s to depend on.
**defaultReleaseBranch**ð¹ | string | The name of the main release branch.
**name**ð¹ | string | This is the name of your project.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**appEntrypoint**?ð¹ | string | The CDK8s app's entrypoint (relative to the source directory, which is "src" by default).
__*Default*__: "main.ts"
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**cdk8sCliVersion**?ð¹ | string | Minumum version of the cdk8s-cli to depend on.
__*Default*__: "2.0.28"
**cdk8sCliVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s-cli.
__*Default*__: false
**cdk8sImports**?ð¹ | Array | Import additional specs.
__*Default*__: no additional specs imported
**cdk8sPlus**?ð¹ | boolean | Include cdk8s-plus.
__*Default*__: true
**cdk8sPlusVersion**?ð¹ | string | Minumum version of the cdk8s-plus-XX to depend on.
__*Default*__: "2.0.0-rc.26"
**cdk8sPlusVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s-plus-17.
__*Default*__: false
**cdk8sVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s.
__*Default*__: false
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**constructsVersion**?ð¹ | string | Minimum version of the `constructs` library to depend on.
__*Default*__: "10.1.42"
**constructsVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for constructs.
__*Default*__: false
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?ð¹ | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?ð¹ | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?ð¹ | boolean | Docgen by Typedoc.
__*Default*__: false
**docsDirectory**?ð¹ | string | Docs directory.
__*Default*__: "docs"
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?ð¹ | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?ð¹ | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?ð¹ | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**integrationTestAutoDiscover**?ð¹ | boolean | Automatically adds an `cdk8s.IntegrationTest` for each `.integ.ts` app in your test directory. If this is disabled, you can manually add an `cdk8s.AutoDiscover` component to your project.
__*Default*__: true
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**k8sMinorVersion**?ð¹ | number | The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.
__*Default*__: 22
**k8sSpecVersion**?ð¹ | string | Import a specific Kubernetes spec version.
__*Default*__: Use the cdk8s default
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**libdir**?ð¹ | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**sampleCode**?ð¹ | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Typescript sources directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?ð¹ | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?ð¹ | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?ð¹ | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct ConstructLibraryCdk8sOptions ð¹
Name | Type | Description
-----|------|-------------
**author**ð¹ | string | The name of the library author.
**authorAddress**ð¹ | string | Email or URL of the library author.
**cdk8sVersion**ð¹ | string | Minimum target version this library is tested against.
**defaultReleaseBranch**ð¹ | string | The name of the main release branch.
**name**ð¹ | string | This is the name of your project.
**repositoryUrl**ð¹ | string | Git repository URL.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**catalog**?ð¹ | [cdk.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:.
__*Default*__: new version will be announced
**cdk8sPlusVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for cdk8s-plus-17.
__*Default*__: false
**cdk8sVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for CDK8s.
__*Default*__: false
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**compat**?ð¹ | boolean | Automatically run API compatibility test against the latest version published to npm after compilation.
__*Default*__: false
**compatIgnore**?ð¹ | string | Name of the ignore file for API compatibility tests.
__*Default*__: ".compatignore"
**compressAssembly**?ð¹ | boolean | Emit a compressed version of the assembly.
__*Default*__: false
**constructsVersion**?ð¹ | string | constructs verion.
__*Default*__: "3.3.196"
**constructsVersionPinning**?ð¹ | boolean | Use pinned version instead of caret version for constructs.
__*Default*__: false
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?ð¹ | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?ð¹ | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?ð¹ | boolean | Docgen by Typedoc.
__*Default*__: false
**docgenFilePath**?ð¹ | string | File path for generated docs.
__*Default*__: "API.md"
**docsDirectory**?ð¹ | string | Docs directory.
__*Default*__: "docs"
**dotnet**?â ïž | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | __*Optional*__
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?ð¹ | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?ð¹ | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?ð¹ | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**excludeTypescript**?ð¹ | Array | Accepts a list of glob patterns.
__*Optional*__
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**integrationTestAutoDiscover**?ð¹ | boolean | Automatically adds an `cdk8s.IntegrationTest` for each `.integ.ts` app in your test directory. If this is disabled, you can manually add an `cdk8s.AutoDiscover` component to your project.
__*Default*__: true
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**jsiiVersion**?ð¹ | string | Version of the jsii compiler to use.
__*Default*__: "1.x"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**libdir**?ð¹ | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**publishToGo**?ð¹ | [cdk.JsiiGoTarget](#projen-cdk-jsiigotarget) | Publish Go bindings to a git repository.
__*Default*__: no publishing
**publishToMaven**?ð¹ | [cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget) | Publish to maven.
__*Default*__: no publishing
**publishToNuget**?ð¹ | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | Publish to NuGet.
__*Default*__: no publishing
**publishToPypi**?ð¹ | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | Publish to pypi.
__*Default*__: no publishing
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**python**?â ïž | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | __*Optional*__
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**rootdir**?ð¹ | string | __*Default*__: "."
**sampleCode**?ð¹ | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Typescript sources directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?ð¹ | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?ð¹ | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?ð¹ | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct IntegrationTestAutoDiscoverOptions ð¹
Name | Type | Description
-----|------|-------------
**testdir**ð¹ | string | Test source tree.
**tsconfigPath**ð¹ | string | Path to the tsconfig file to use for integration tests.
## struct IntegrationTestOptions ð¹
Options for IntegrationTest.
Name | Type | Description
-----|------|-------------
**entrypoint**ð¹ | string | A path from the project root directory to a TypeScript file which contains the integration test app.
**tsconfigPath**ð¹ | string | The path of the tsconfig.json file to use when running integration test cdk apps.
**name**?ð¹ | string | Name of the integration test.
__*Default*__: Derived from the entrypoint filename.
## struct ConstructLibraryCdktfOptions ð¹
Name | Type | Description
-----|------|-------------
**author**ð¹ | string | The name of the library author.
**authorAddress**ð¹ | string | Email or URL of the library author.
**cdktfVersion**ð¹ | string | Minimum target version this library is tested against.
**defaultReleaseBranch**ð¹ | string | The name of the main release branch.
**name**ð¹ | string | This is the name of your project.
**repositoryUrl**ð¹ | string | Git repository URL.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**catalog**?ð¹ | [cdk.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:.
__*Default*__: new version will be announced
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**compat**?ð¹ | boolean | Automatically run API compatibility test against the latest version published to npm after compilation.
__*Default*__: false
**compatIgnore**?ð¹ | string | Name of the ignore file for API compatibility tests.
__*Default*__: ".compatignore"
**compressAssembly**?ð¹ | boolean | Emit a compressed version of the assembly.
__*Default*__: false
**constructsVersion**?ð¹ | string | Construct version to use.
__*Default*__: "^10.0.12"
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?ð¹ | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?ð¹ | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?ð¹ | boolean | Docgen by Typedoc.
__*Default*__: false
**docgenFilePath**?ð¹ | string | File path for generated docs.
__*Default*__: "API.md"
**docsDirectory**?ð¹ | string | Docs directory.
__*Default*__: "docs"
**dotnet**?â ïž | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | __*Optional*__
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?ð¹ | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?ð¹ | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?ð¹ | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**excludeTypescript**?ð¹ | Array | Accepts a list of glob patterns.
__*Optional*__
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**jsiiVersion**?ð¹ | string | Version of the jsii compiler to use.
__*Default*__: "1.x"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**libdir**?ð¹ | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**publishToGo**?ð¹ | [cdk.JsiiGoTarget](#projen-cdk-jsiigotarget) | Publish Go bindings to a git repository.
__*Default*__: no publishing
**publishToMaven**?ð¹ | [cdk.JsiiJavaTarget](#projen-cdk-jsiijavatarget) | Publish to maven.
__*Default*__: no publishing
**publishToNuget**?ð¹ | [cdk.JsiiDotNetTarget](#projen-cdk-jsiidotnettarget) | Publish to NuGet.
__*Default*__: no publishing
**publishToPypi**?ð¹ | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | Publish to pypi.
__*Default*__: no publishing
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**python**?â ïž | [cdk.JsiiPythonTarget](#projen-cdk-jsiipythontarget) | __*Optional*__
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**rootdir**?ð¹ | string | __*Default*__: "."
**sampleCode**?ð¹ | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Typescript sources directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?ð¹ | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?ð¹ | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?ð¹ | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct CircleCiProps ð¹
Options for class {@link Circleci}.
Name | Type | Description
-----|------|-------------
**jobs**?ð¹ | Array<[circleci.Job](#projen-circleci-job)> | List of Jobs to create unique steps per pipeline, e.g. ```json jobs: [{ identifier: "compile", docker: { image: "golang:alpine" } steps: ["checkout", run: {command: "go build ."}] }] ```.
__*Optional*__
**orbs**?ð¹ | Map | Contains a map of CirclCi Orbs ```json orbs: { node: "circleci/node@5.0.1" slack: "circleci/slack@4.8.3" } ```.
__*Optional*__
**setup**?ð¹ | boolean | The setup field enables you to conditionally trigger configurations from outside the primary .circleci parent directory, update pipeline parameters, or generate customized configurations.
__*Optional*__
**version**?ð¹ | number | pipeline version.
__*Default*__: 2.1
**workflows**?ð¹ | Array<[circleci.Workflow](#projen-circleci-workflow)> | List of Workflows of pipeline, e.g. ```json workflows: { { identifier: "build", jobs: [{ identifier: "node/install", context: ["npm"], }] } } ```.
__*Optional*__
## struct Docker ð¹
Options for docker executor.
Name | Type | Description
-----|------|-------------
**image**ð¹ | string | The name of a custom docker image to use.
**auth**?ð¹ | Map | Authentication for registries using standard docker login credentials.
__*Optional*__
**awsAuth**?ð¹ | Map | Authentication for AWS Elastic Container Registry (ECR).
__*Optional*__
**command**?ð¹ | Array | The command used as pid 1 (or args for entrypoint) when launching the container.
__*Optional*__
**entrypoint**?ð¹ | Array | The command used as executable when launching the container.
__*Optional*__
**environment**?ð¹ | Map | A map of environment variable names and values.
__*Optional*__
**name**?ð¹ | string | The name the container is reachable by.
__*Optional*__
**user**?ð¹ | string | Which user to run commands as within the Docker container.
__*Optional*__
## struct Filter ð¹
The branches key controls whether the current branch should have a schedule trigger created for it, where current branch is the branch containing the config.yml file with the trigger stanza. That is, a push on the main branch will only schedule a workflow for the main branch.
Branches can have the keys only and ignore which either map to a single string naming a branch.
You may also use regular expressions to match against branches by enclosing them with /âs, or map to a list of such strings.
Regular expressions must match the entire string.
Any branches that match only will run the job.
Any branches that match ignore will not run the job.
If neither only nor ignore are specified then all branches will run the job.
If both only and ignore are specified the only is considered before ignore.
Name | Type | Description
-----|------|-------------
**branches**?ð¹ | [circleci.FilterConfig](#projen-circleci-filterconfig) | __*Optional*__
**tags**?ð¹ | [circleci.FilterConfig](#projen-circleci-filterconfig) | __*Optional*__
## struct FilterConfig ð¹
set an inclusive or exclusive filter.
Name | Type | Description
-----|------|-------------
**ignore**?ð¹ | Array | Either a single branch specifier, or a list of branch specifiers.
__*Optional*__
**only**?ð¹ | Array | Either a single branch specifier, or a list of branch specifiers.
__*Optional*__
## struct Job ð¹
A Workflow is comprised of one or more uniquely named jobs.
Jobs are specified in the jobs map,
see Sample 2.0 config.yml for two examples of a job map.
The name of the job is the key in the map, and the value is a map describing the job.
Each job consists of the jobâs name as a key and a map as a value. A name should be case insensitive unique within a current jobs list.
Name | Type | Description
-----|------|-------------
**identifier**ð¹ | string | name of dynamic key *.
**docker**?ð¹ | Array<[circleci.Docker](#projen-circleci-docker)> | __*Optional*__
**environment**?ð¹ | Map | A map of environment variable names and values.
__*Optional*__
**machine**?ð¹ | [circleci.Machine](#projen-circleci-machine) | __*Optional*__
**macos**?ð¹ | [circleci.Macos](#projen-circleci-macos) | __*Optional*__
**parallelism**?ð¹ | number | Number of parallel instances of this job to run (default: 1).
__*Optional*__
**parameters**?ð¹ | Map | Parameters for making a job explicitly configurable in a workflow.
__*Optional*__
**resourceClass**?ð¹ | string | {@link ResourceClass}.
__*Optional*__
**shell**?ð¹ | string | Shell to use for execution command in all steps.
__*Optional*__
**steps**?ð¹ | Array | no type support here, for syntax {@see https://circleci.com/docs/2.0/configuration-reference/#steps}.
__*Optional*__
**workingDirectory**?ð¹ | string | In which directory to run the steps.
__*Optional*__
## struct Machine ð¹
Name | Type | Description
-----|------|-------------
**image**ð¹ | string | The VM image to use.
**dockerLayerCaching**?ð¹ | string | enable docker layer caching.
__*Optional*__
## struct Macos ð¹
CircleCI supports running jobs on macOS, to allow you to build, test, and deploy apps for macOS, iOS, tvOS and watchOS.
To run a job in a macOS virtual machine,
you must add the macos key to the top-level configuration for the job and specify
the version of Xcode you would like to use.
Name | Type | Description
-----|------|-------------
**xcode**ð¹ | string | The version of Xcode that is installed on the virtual machine.
## struct Matrix ð¹
The matrix stanza allows you to run a parameterized job multiple times with different arguments.
Name | Type | Description
-----|------|-------------
**alias**?ð¹ | string | An alias for the matrix, usable from another jobâs requires stanza.
__*Optional*__
**parameters**?ð¹ | Map | Array> | A map of parameter names to every value the job should be called with.
__*Optional*__
## struct PipelineParameter ð¹
Parameters are declared by name under a job, command, or executor.
Name | Type | Description
-----|------|-------------
**type**ð¹ | [circleci.PipelineParameterType](#projen-circleci-pipelineparametertype) | The parameter type, required.
**default**?ð¹ | string | number | boolean | The default value for the parameter.
__*Optional*__
**description**?ð¹ | string | Used to generate documentation for your orb.
__*Optional*__
## struct Run ð¹
Used for invoking all command-line programs, taking either a map of configuration values, or, when called in its short-form, a string that will be used as both the command and name.
Run commands are executed using non-login shells by default,
so you must explicitly source any dotfiles as part of the command.
Not used because type incompatible types in steps array
Name | Type | Description
-----|------|-------------
**command**ð¹ | string | Command to run via the shell.
**background**?ð¹ | string | Whether this step should run in the background (default: false).
__*Optional*__
**environment**?ð¹ | string | Additional environmental variables, locally scoped to command.
__*Optional*__
**name**?ð¹ | string | Title of the step to be shown in the CircleCI UI (default: full command).
__*Optional*__
**noOutputTimeout**?ð¹ | string | Elapsed time the command can run without output such as â20mâ, â1.25hâ, â5sâ. The default is 10 minutes.
__*Optional*__
**shell**?ð¹ | string | Shell to use for execution command.
__*Optional*__
**when**?ð¹ | string | Specify when to enable or disable the step.
__*Optional*__
**workingDirectory**?ð¹ | string | In which directory to run this step.
__*Optional*__
## struct Schedule ð¹
A workflow may have a schedule indicating it runs at a certain time.
Name | Type | Description
-----|------|-------------
**filters**ð¹ | [circleci.Filter](#projen-circleci-filter) |
**cron**?ð¹ | string | The cron key is defined using POSIX crontab syntax.
__*Optional*__
## struct StepRun ð¹
Execution steps for Job.
Name | Type | Description
-----|------|-------------
**run**?ð¹ | [circleci.Run](#projen-circleci-run) | __*Optional*__
## struct Triggers ð¹
Specifies which triggers will cause this workflow to be executed.
Default behavior is to trigger the workflow when pushing to a branch.
Name | Type | Description
-----|------|-------------
**schedule**?ð¹ | [circleci.Schedule](#projen-circleci-schedule) | __*Optional*__
## struct Workflow ð¹
Used for orchestrating all jobs.
Each workflow consists of the workflow name as a key and a map as a value.
A name should be unique within the current config.yml.
The top-level keys for the Workflows configuration are version and jobs.
Name | Type | Description
-----|------|-------------
**identifier**ð¹ | string | name of dynamic key *.
**jobs**?ð¹ | Array<[circleci.WorkflowJob](#projen-circleci-workflowjob)> | __*Optional*__
**triggers**?ð¹ | Array<[circleci.Triggers](#projen-circleci-triggers)> | __*Optional*__
**when**?ð¹ | any | when is too dynamic to be casted to interfaces.
__*Optional*__
## struct WorkflowJob ð¹
A Job is part of Workflow.
A Job can be created with {@link Job} or it can be provided by the orb
Name | Type | Description
-----|------|-------------
**identifier**ð¹ | string | name of dynamic key *.
**context**?ð¹ | Array | The name of the context(s).
__*Optional*__
**filters**?ð¹ | [circleci.Filter](#projen-circleci-filter) | Job Filters can have the key branches or tags.
__*Optional*__
**matrix**?ð¹ | [circleci.Matrix](#projen-circleci-matrix) | __*Optional*__
**name**?ð¹ | string | A replacement for the job name.
__*Optional*__
**orbParameters**?ð¹ | Map | Parameters passed to job when referencing a job from orb.
__*Optional*__
**requires**?ð¹ | Array | A list of jobs that must succeed for the job to start.
__*Optional*__
**type**?ð¹ | [circleci.JobType](#projen-circleci-jobtype) | A job may have a type of approval indicating it must be manually approved before downstream jobs may proceed.
__*Optional*__
## struct AutoApproveOptions ð¹
Options for 'AutoApprove'.
Name | Type | Description
-----|------|-------------
**allowedUsernames**?ð¹ | Array | Only pull requests authored by these Github usernames will be auto-approved.
__*Default*__: ['github-bot']
**label**?ð¹ | string | Only pull requests with this label will be auto-approved.
__*Default*__: 'auto-approve'
**runsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
**secret**?ð¹ | string | A GitHub secret name which contains a GitHub Access Token with write permissions for the `pull_request` scope.
__*Default*__: "GITHUB_TOKEN"
## struct AutoMergeOptions ð¹
Name | Type | Description
-----|------|-------------
**approvedReviews**?ð¹ | number | Number of approved code reviews.
__*Default*__: 1
**blockingLabels**?ð¹ | Array | List of labels that will prevent auto-merging.
__*Default*__: ['do-not-merge']
## struct CheckoutWithPatchOptions ð¹
Options for `checkoutWithPatch`.
Name | Type | Description
-----|------|-------------
**lfs**?ð¹ | boolean | Whether LFS is enabled for the GitHub repository.
__*Default*__: false
**patchFile**?ð¹ | string | The name of the artifact the patch is stored as.
__*Default*__: ".repo.patch"
**ref**?ð¹ | string | Branch or tag name.
__*Default*__: the default branch is implicitly used
**repository**?ð¹ | string | The repository (owner/repo) to use.
__*Default*__: the default repository is implicitly used
**token**?ð¹ | string | A GitHub token to use when checking out the repository.
__*Default*__: the default GITHUB_TOKEN is implicitly used
## struct CreatePullRequestOptions ð¹
Name | Type | Description
-----|------|-------------
**pullRequestDescription**ð¹ | string | Description added to the pull request.
**pullRequestTitle**ð¹ | string | The full title used to create the pull request.
**workflowName**ð¹ | string | The name of the workflow that will create the PR.
**assignees**?ð¹ | Array | Assignees to add on the PR.
__*Default*__: no assignees
**baseBranch**?ð¹ | string | Sets the pull request base branch.
__*Default*__: The branch checked out in the workflow.
**branchName**?ð¹ | string | The pull request branch name.
__*Default*__: `github-actions/${options.workflowName}`
**credentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | The job credentials used to create the pull request.
__*Optional*__
**gitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity used to create the commit.
__*Default*__: the default github-actions user
**labels**?ð¹ | Array | Labels to apply on the PR.
__*Default*__: no labels.
**signoff**?ð¹ | boolean | Add Signed-off-by line by the committer at the end of the commit log message.
__*Default*__: true
**stepId**?ð¹ | string | The step ID which produces the output which indicates if a patch was created.
__*Default*__: "create_pr"
**stepName**?ð¹ | string | The name of the step displayed on GitHub.
__*Default*__: "Create Pull Request"
## struct DependabotIgnore ð¹
You can use the `ignore` option to customize which dependencies are updated.
The ignore option supports the following options.
Name | Type | Description
-----|------|-------------
**dependencyName**ð¹ | string | Use to ignore updates for dependencies with matching names, optionally using `*` to match zero or more characters.
**versions**?ð¹ | Array | Use to ignore specific versions or ranges of versions.
__*Optional*__
## struct DependabotOptions ð¹
Name | Type | Description
-----|------|-------------
**ignore**?ð¹ | Array<[github.DependabotIgnore](#projen-github-dependabotignore)> | You can use the `ignore` option to customize which dependencies are updated.
__*Default*__: []
**ignoreProjen**?ð¹ | boolean | Ignores updates to `projen`.
__*Default*__: true
**labels**?ð¹ | Array | List of labels to apply to the created PR's.
__*Optional*__
**registries**?ð¹ | Map | Map of package registries to use.
__*Default*__: use public registries
**scheduleInterval**?ð¹ | [github.DependabotScheduleInterval](#projen-github-dependabotscheduleinterval) | How often to check for new versions and raise pull requests.
__*Default*__: ScheduleInterval.DAILY
**versioningStrategy**?ð¹ | [github.VersioningStrategy](#projen-github-versioningstrategy) | The strategy to use when edits manifest and lock files.
__*Default*__: VersioningStrategy.LOCKFILE_ONLY The default is to only update the lock file because package.json is controlled by projen and any outside updates will fail the build.
## struct DependabotRegistry ð¹
Use to add private registry support for dependabot.
Name | Type | Description
-----|------|-------------
**type**ð¹ | [github.DependabotRegistryType](#projen-github-dependabotregistrytype) | Registry type e.g. 'npm-registry' or 'docker-registry'.
**url**ð¹ | string | Url for the registry e.g. 'https://npm.pkg.github.com' or 'registry.hub.docker.com'.
**key**?ð¹ | string | A reference to a Dependabot secret containing an access key for this registry.
__*Default*__: undefined
**organization**?ð¹ | string | Used with the hex-organization registry type.
__*Default*__: undefined
**password**?ð¹ | string | A reference to a Dependabot secret containing the password for the specified user.
__*Default*__: undefined
**replacesBase**?ð¹ | boolean | For registries with type: python-index, if the boolean value is true, pip esolves dependencies by using the specified URL rather than the base URL of the Python Package Index (by default https://pypi.org/simple).
__*Default*__: undefined
**token**?ð¹ | string | Secret token for dependabot access e.g. '${{ secrets.DEPENDABOT_PACKAGE_TOKEN }}'.
__*Default*__: undefined
**username**?ð¹ | string | The username that Dependabot uses to access the registry.
__*Default*__: do not authenticate
## struct GitHubOptions ð¹
Name | Type | Description
-----|------|-------------
**downloadLfs**?ð¹ | boolean | Download files in LFS in workflows.
__*Default*__: true if the associated project has `lfsPatterns`, `false` otherwise
**mergify**?ð¹ | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?ð¹ | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for Mergify.
__*Default*__: default options
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**pullRequestLint**?ð¹ | boolean | Add a workflow that performs basic checks for pull requests, like validating that PRs follow Conventional Commits.
__*Default*__: true
**pullRequestLintOptions**?ð¹ | [github.PullRequestLintOptions](#projen-github-pullrequestlintoptions) | Options for configuring a pull request linter.
__*Default*__: see defaults in `PullRequestLintOptions`
**workflows**?ð¹ | boolean | Enables GitHub workflows.
__*Default*__: true
## struct GitHubProjectOptions ð¹
Options for `GitHubProject`.
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | This is the name of your project.
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
## struct GitIdentity ð¹
Represents the git identity.
Name | Type | Description
-----|------|-------------
**email**ð¹ | string | The email address of the git user.
**name**ð¹ | string | The name of the user.
## struct GithubCredentialsAppOptions ð¹
Options for `GithubCredentials.fromApp`.
Name | Type | Description
-----|------|-------------
**appIdSecret**?ð¹ | string | __*Optional*__
**permissions**?ð¹ | [github.workflows.AppPermissions](#projen-github-workflows-apppermissions) | The permissions granted to the token.
__*Default*__: all permissions granted to the app
**privateKeySecret**?ð¹ | string | __*Optional*__
## struct GithubCredentialsPersonalAccessTokenOptions ð¹
Options for `GithubCredentials.fromPersonalAccessToken`.
Name | Type | Description
-----|------|-------------
**secret**?ð¹ | string | __*Optional*__
## struct GithubWorkflowOptions ð¹
Options for `GithubWorkflow`.
Name | Type | Description
-----|------|-------------
**concurrency**?ð¹ | string | Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time.
__*Default*__: disabled
**force**?ð¹ | boolean | Force the creation of the workflow even if `workflows` is disabled in `GitHub`.
__*Default*__: false
## interface IAddConditionsLater ð¹
### Methods
#### render()ð¹
```ts
render(): Array
```
__Returns__:
* Array
## struct MergifyConditionalOperator ð¹
The Mergify conditional operators that can be used are: `or` and `and`.
Note: The number of nested conditions is limited to 3.
Name | Type | Description
-----|------|-------------
**and**?ð¹ | Array | __*Optional*__
**or**?ð¹ | Array | __*Optional*__
## struct MergifyOptions ð¹
Name | Type | Description
-----|------|-------------
**queues**?ð¹ | Array<[github.MergifyQueue](#projen-github-mergifyqueue)> | __*Optional*__
**rules**?ð¹ | Array<[github.MergifyRule](#projen-github-mergifyrule)> | __*Optional*__
## struct MergifyQueue ð¹
Name | Type | Description
-----|------|-------------
**conditions**ð¹ | Array | A list of Conditions string that must match against the pull request for the pull request to be added to the queue.
**name**ð¹ | string | The name of the queue.
**mergeMethod**?ð¹ | string | Merge method to use.
__*Default*__: "merge"
**updateMethod**?ð¹ | string | Method to use to update the pull request with its base branch when the speculative check is done in-place.
__*Default*__: `merge` for all merge methods except `fast-forward` where `rebase` is used
## struct MergifyRule ð¹
Name | Type | Description
-----|------|-------------
**actions**ð¹ | Map | A dictionary made of Actions that will be executed on the matching pull requests.
**conditions**ð¹ | Array | A list of Conditions string that must match against the pull request for the rule to be applied.
**name**ð¹ | string | The name of the rule.
## struct PullRequestFromPatchOptions ð¹
Name | Type | Description
-----|------|-------------
**patch**ð¹ | [github.PullRequestPatchSource](#projen-github-pullrequestpatchsource) | Information about the patch that is used to create the pull request.
**pullRequestDescription**ð¹ | string | Description added to the pull request.
**pullRequestTitle**ð¹ | string | The full title used to create the pull request.
**workflowName**ð¹ | string | The name of the workflow that will create the PR.
**assignees**?ð¹ | Array | Assignees to add on the PR.
__*Default*__: no assignees
**baseBranch**?ð¹ | string | Sets the pull request base branch.
__*Default*__: The branch checked out in the workflow.
**branchName**?ð¹ | string | The pull request branch name.
__*Default*__: `github-actions/${options.workflowName}`
**credentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | The job credentials used to create the pull request.
__*Optional*__
**gitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity used to create the commit.
__*Default*__: the default github-actions user
**jobName**?ð¹ | string | The name of the job displayed on GitHub.
__*Default*__: "Create Pull Request"
**labels**?ð¹ | Array | Labels to apply on the PR.
__*Default*__: no labels.
**runsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
**signoff**?ð¹ | boolean | Add Signed-off-by line by the committer at the end of the commit log message.
__*Default*__: true
**stepId**?ð¹ | string | The step ID which produces the output which indicates if a patch was created.
__*Default*__: "create_pr"
**stepName**?ð¹ | string | The name of the step displayed on GitHub.
__*Default*__: "Create Pull Request"
## struct PullRequestLintOptions ð¹
Options for PullRequestLint.
Name | Type | Description
-----|------|-------------
**runsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
**semanticTitle**?ð¹ | boolean | Validate that pull request titles follow Conventional Commits.
__*Default*__: true
**semanticTitleOptions**?ð¹ | [github.SemanticTitleOptions](#projen-github-semantictitleoptions) | Options for validating the conventional commit title linter.
__*Default*__: title must start with "feat", "fix", or "chore"
## struct PullRequestPatchSource ð¹
Name | Type | Description
-----|------|-------------
**jobId**ð¹ | string | The id of the job that created the patch file.
**outputName**ð¹ | string | The name of the output that indicates if a patch has been created.
**lfs**?ð¹ | boolean | Whether LFS is enabled for the GitHub repository.
__*Default*__: false
**patchFile**?ð¹ | string | The name of the artifact the patch is stored as.
__*Default*__: ".repo.patch"
**ref**?ð¹ | string | Branch or tag name.
__*Default*__: the default branch is implicitly used
**repository**?ð¹ | string | The repository (owner/repo) to use.
__*Default*__: the default repository is implicitly used
**token**?ð¹ | string | A GitHub token to use when checking out the repository.
__*Default*__: the default GITHUB_TOKEN is implicitly used
## struct PullRequestTemplateOptions ð¹
Options for `PullRequestTemplate`.
Name | Type | Description
-----|------|-------------
**lines**?ð¹ | Array | The contents of the template.
__*Default*__: a standard default template will be created.
## struct SemanticTitleOptions ð¹
Options for linting that PR titles follow Conventional Commits.
Name | Type | Description
-----|------|-------------
**requireScope**?ð¹ | boolean | Configure that a scope must always be provided.
__*Default*__: false
**types**?ð¹ | Array | Configure a list of commit types that are allowed.
__*Default*__: ["feat", "fix", "chore"]
## struct StaleBehavior ð¹
Stale behavior.
Name | Type | Description
-----|------|-------------
**closeMessage**?ð¹ | string | The comment to add to the issue/PR when it's closed.
__*Default*__: "Closing this pull request as it hasn\'t seen activity for a while. Please add a comment
**daysBeforeClose**?ð¹ | number | Days until the issue/PR is closed after it is marked as "Stale".
__*Default*__: -
**daysBeforeStale**?ð¹ | number | How many days until the issue or pull request is marked as "Stale".
__*Default*__: -
**enabled**?ð¹ | boolean | Determines if this behavior is enabled.
__*Default*__: true
**exemptLabels**?ð¹ | Array | Label which exempt an issue/PR from becoming stale.
__*Default*__: ["backlog"]
**staleLabel**?ð¹ | string | The label to apply to the issue/PR when it becomes stale.
__*Default*__: "stale"
**staleMessage**?ð¹ | string | The comment to add to the issue/PR when it becomes stale.
__*Default*__: "This pull request is now marked as stale because hasn\'t seen activity for a while. Add a comment or it will be closed soon."
## struct StaleOptions ð¹
Options for `Stale`.
Name | Type | Description
-----|------|-------------
**issues**?ð¹ | [github.StaleBehavior](#projen-github-stalebehavior) | How to handle stale issues.
__*Default*__: By default, stale issues with no activity will be marked as stale after 60 days and closed within 7 days.
**pullRequest**?ð¹ | [github.StaleBehavior](#projen-github-stalebehavior) | How to handle stale pull requests.
__*Default*__: By default, pull requests with no activity will be marked as stale after 14 days and closed within 2 days with relevant comments.
**runsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct TaskWorkflowOptions ð¹
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | The workflow name.
**permissions**ð¹ | [github.workflows.JobPermissions](#projen-github-workflows-jobpermissions) | Permissions for the build job.
**task**ð¹ | [Task](#projen-task) | The main task to be executed.
**artifactsDirectory**?ð¹ | string | A directory name which contains artifacts to be uploaded (e.g. `dist`). If this is set, the contents of this directory will be uploaded as an artifact at the end of the workflow run, even if other steps fail.
__*Default*__: not set
**checkoutWith**?ð¹ | Map | Override for the `with` property of the source code checkout step.
__*Default*__: not set
**condition**?ð¹ | string | Adds an 'if' condition to the workflow.
__*Optional*__
**container**?ð¹ | [github.workflows.ContainerOptions](#projen-github-workflows-containeroptions) | __*Default*__: default image
**downloadLfs**?ð¹ | boolean | Whether to download files from Git LFS for this workflow.
__*Default*__: Use the setting on the corresponding GitHub project
**env**?ð¹ | Map | Workflow environment variables.
__*Default*__: {}
**gitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in this workflow.
__*Optional*__
**jobId**?ð¹ | string | The primary job id.
__*Default*__: "build"
**outputs**?ð¹ | Map | Mapping of job output names to values/expressions.
__*Default*__: {}
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Actions to run after the main build step.
__*Default*__: not set
**preBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to run before the main build step.
__*Default*__: not set
**preCheckoutSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Initial steps to run before the source code checkout.
__*Default*__: not set
**runsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
**triggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | The triggers for the workflow.
__*Default*__: by default workflows can only be triggered by manually.
## struct UploadGitPatchOptions ð¹
Options for `uploadGitPatch`.
Name | Type | Description
-----|------|-------------
**outputName**ð¹ | string | The name of the output to emit.
**stepId**ð¹ | string | The step ID which produces the output which indicates if a patch was created.
**mutationError**?ð¹ | string | Fail if a mutation was found and print this error message.
__*Default*__: do not fail upon mutation
**patchFile**?ð¹ | string | The name of the artifact the patch is stored as.
__*Default*__: ".repo.patch"
**stepName**?ð¹ | string | The name of the step.
__*Default*__: "Find mutations"
## struct AllowFailure ð¹
Exit code that are not considered failure.
The job fails for any other exit code.
You can list which exit codes are not considered failures. The job fails for any other
exit code.
Name | Type | Description
-----|------|-------------
**exitCodes**ð¹ | number | Array |
## struct Artifacts ð¹
Used to specify a list of files and directories that should be attached to the job if it succeeds.
Artifacts are sent to Gitlab where they can be downloaded.
Name | Type | Description
-----|------|-------------
**exclude**?ð¹ | Array | A list of paths to files/folders that should be excluded in the artifact.
__*Optional*__
**expireIn**?ð¹ | string | How long artifacts should be kept.
__*Optional*__
**exposeAs**?ð¹ | string | Can be used to expose job artifacts in the merge request UI.
__*Optional*__
**name**?ð¹ | string | Name for the archive created on job success.
__*Optional*__
**paths**?ð¹ | Array | A list of paths to files/folders that should be included in the artifact.
__*Optional*__
**reports**?ð¹ | [gitlab.Reports](#projen-gitlab-reports) | Reports will be uploaded as artifacts, and often displayed in the Gitlab UI, such as in Merge Requests.
__*Optional*__
**untracked**?ð¹ | boolean | Whether to add all untracked files (along with 'artifacts.paths') to the artifact.
__*Optional*__
**when**?ð¹ | [gitlab.CacheWhen](#projen-gitlab-cachewhen) | Configure when artifacts are uploaded depended on job status.
__*Optional*__
## struct Assets ð¹
Asset configuration for a release.
Name | Type | Description
-----|------|-------------
**links**ð¹ | Array<[gitlab.Link](#projen-gitlab-link)> | Include asset links in the release.
## struct Cache ð¹
Cache Definition.
Name | Type | Description
-----|------|-------------
**key**?ð¹ | string | [gitlab.CacheKeyFiles](#projen-gitlab-cachekeyfiles) | Used the to give each cache a unique identifying key.
__*Optional*__
**paths**?ð¹ | Array | Defines which files or directories to cache.
__*Optional*__
**policy**?ð¹ | [gitlab.CachePolicy](#projen-gitlab-cachepolicy) | Defines the upload and download behaviour of the cache.
__*Optional*__
**untracked**?ð¹ | boolean | If set to true all files that are untracked in your Git repository will be cached.
__*Optional*__
**when**?ð¹ | [gitlab.CacheWhen](#projen-gitlab-cachewhen) | Defines when to save the cache, based on the status of the job (Default: Job Success).
__*Optional*__
## struct CacheKeyFiles ð¹
Use this construct to generate a new key when one or two specific files change.
Name | Type | Description
-----|------|-------------
**files**ð¹ | Array | The files that are checked against.
**prefix**?ð¹ | string | Adds a custom prefix to the checksums computed.
__*Optional*__
## struct CiConfigurationOptions ð¹
Options for `CiConfiguration`.
Name | Type | Description
-----|------|-------------
**default**?ð¹ | [gitlab.Default](#projen-gitlab-default) | Default settings for the CI Configuration.
__*Optional*__
**jobs**?ð¹ | Map | An initial set of jobs to add to the configuration.
__*Optional*__
**pages**?ð¹ | [gitlab.Job](#projen-gitlab-job) | A special job used to upload static sites to Gitlab pages.
__*Optional*__
**stages**?ð¹ | Array | Groups jobs into stages.
__*Optional*__
**variables**?ð¹ | Map | Global variables that are passed to jobs.
__*Optional*__
**workflow**?ð¹ | [gitlab.Workflow](#projen-gitlab-workflow) | Used to control pipeline behavior.
__*Optional*__
## struct CoverageReport ð¹
Code coverage report interface.
Name | Type | Description
-----|------|-------------
**coverageFormat**ð¹ | string |
**path**ð¹ | string |
## struct Default ð¹
Default settings for the CI Configuration.
Jobs that do not define one or more of the listed keywords use the value defined in the default section.
Name | Type | Description
-----|------|-------------
**afterScript**?ð¹ | Array | __*Optional*__
**artifacts**?ð¹ | [gitlab.Artifacts](#projen-gitlab-artifacts) | __*Optional*__
**beforeScript**?ð¹ | Array | __*Optional*__
**cache**?ð¹ | [gitlab.Cache](#projen-gitlab-cache) | __*Optional*__
**image**?ð¹ | [gitlab.Image](#projen-gitlab-image) | __*Optional*__
**interruptible**?ð¹ | boolean | __*Optional*__
**retry**?ð¹ | [gitlab.Retry](#projen-gitlab-retry) | __*Optional*__
**services**?ð¹ | Array<[gitlab.Service](#projen-gitlab-service)> | __*Optional*__
**tags**?ð¹ | Array | __*Optional*__
**timeout**?ð¹ | string | __*Optional*__
## struct Engine ð¹
The engine configuration for a secret.
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | Name of the secrets engine.
**path**ð¹ | string | Path to the secrets engine.
## struct Environment ð¹
The environment that a job deploys to.
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | The name of the environment, e.g. 'qa', 'staging', 'production'.
**action**?ð¹ | [gitlab.Action](#projen-gitlab-action) | Specifies what this job will do.
__*Optional*__
**autoStopIn**?ð¹ | string | The amount of time it should take before Gitlab will automatically stop the environment.
__*Optional*__
**deploymentTier**?ð¹ | [gitlab.DeploymentTier](#projen-gitlab-deploymenttier) | Explicitly specifies the tier of the deployment environment if non-standard environment name is used.
__*Optional*__
**kubernetes**?ð¹ | [gitlab.KubernetesConfig](#projen-gitlab-kubernetesconfig) | Used to configure the kubernetes deployment for this environment.
__*Optional*__
**onStop**?ð¹ | string | The name of a job to execute when the environment is about to be stopped.
__*Optional*__
**url**?ð¹ | string | When set, this will expose buttons in various places for the current environment in Gitlab, that will take you to the defined URL.
__*Optional*__
## struct Filter ð¹
Filtering options for when a job will run.
Name | Type | Description
-----|------|-------------
**changes**?ð¹ | Array | Filter job creation based on files that were modified in a git push.
__*Optional*__
**kubernetes**?ð¹ | [gitlab.KubernetesEnum](#projen-gitlab-kubernetesenum) | Filter job based on if Kubernetes integration is active.
__*Optional*__
**refs**?ð¹ | Array | Control when to add jobs to a pipeline based on branch names or pipeline types.
__*Optional*__
**variables**?ð¹ | Array | Filter job by checking comparing values of environment variables.
__*Optional*__
## struct Image ð¹
Specifies the docker image to use for the job or globally for all jobs.
Job configuration
takes precedence over global setting. Requires a certain kind of Gitlab runner executor.
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | Full name of the image that should be used.
**entrypoint**?ð¹ | Array | Command or script that should be executed as the container's entrypoint.
__*Optional*__
## struct Include ð¹
An included YAML file.
Name | Type | Description
-----|------|-------------
**file**?ð¹ | Array | Files from another private project on the same GitLab instance.
__*Optional*__
**local**?ð¹ | string | Relative path from local repository root (`/`) to the `yaml`/`yml` file template.
__*Optional*__
**project**?ð¹ | string | Path to the project, e.g. `group/project`, or `group/sub-group/project`.
__*Optional*__
**ref**?ð¹ | string | Branch/Tag/Commit-hash for the target project.
__*Optional*__
**remote**?ð¹ | string | URL to a `yaml`/`yml` template file using HTTP/HTTPS.
__*Optional*__
**rules**?ð¹ | Array<[gitlab.IncludeRule](#projen-gitlab-includerule)> | Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job.
__*Optional*__
**template**?ð¹ | string | Use a `.gitlab-ci.yml` template as a base, e.g. `Nodejs.gitlab-ci.yml`.
__*Optional*__
## struct IncludeRule ð¹
Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job.
Name | Type | Description
-----|------|-------------
**allowFailure**?ð¹ | boolean | [gitlab.AllowFailure](#projen-gitlab-allowfailure) | __*Optional*__
**changes**?ð¹ | Array | __*Optional*__
**exists**?ð¹ | Array | __*Optional*__
**if**?ð¹ | string | __*Optional*__
**startIn**?ð¹ | string | __*Optional*__
**variables**?ð¹ | Map | __*Optional*__
**when**?ð¹ | [gitlab.JobWhen](#projen-gitlab-jobwhen) | __*Optional*__
## struct Inherit ð¹
Controls inheritance of globally-defined defaults and variables.
Boolean values control
inheritance of all default: or variables: keywords. To inherit only a subset of default:
or variables: keywords, specify what you wish to inherit. Anything not listed is not
inherited.
Name | Type | Description
-----|------|-------------
**default**?ð¹ | boolean | Array<[gitlab.DefaultElement](#projen-gitlab-defaultelement)> | Whether to inherit all globally-defined defaults or not.
__*Optional*__
**variables**?ð¹ | boolean | Array | Whether to inherit all globally-defined variables or not.
__*Optional*__
## struct Job ð¹
Jobs are the most fundamental element of a .gitlab-ci.yml file.
Name | Type | Description
-----|------|-------------
**afterScript**?ð¹ | Array | __*Optional*__
**allowFailure**?ð¹ | boolean | [gitlab.AllowFailure](#projen-gitlab-allowfailure) | Whether to allow the pipeline to continue running on job failure (Default: false).
__*Optional*__
**artifacts**?ð¹ | [gitlab.Artifacts](#projen-gitlab-artifacts) | __*Optional*__
**beforeScript**?ð¹ | Array | __*Optional*__
**cache**?ð¹ | [gitlab.Cache](#projen-gitlab-cache) | __*Optional*__
**coverage**?ð¹ | string | Must be a regular expression, optionally but recommended to be quoted, and must be surrounded with '/'.
__*Optional*__
**dependencies**?ð¹ | Array | Specify a list of job names from earlier stages from which artifacts should be loaded.
__*Optional*__
**environment**?ð¹ | string | [gitlab.Environment](#projen-gitlab-environment) | Used to associate environment metadata with a deploy.
__*Optional*__
**except**?ð¹ | Array | [gitlab.Filter](#projen-gitlab-filter) | Job will run *except* for when these filtering options match.
__*Optional*__
**extends**?ð¹ | Array | The name of one or more jobs to inherit configuration from.
__*Optional*__
**image**?ð¹ | [gitlab.Image](#projen-gitlab-image) | __*Optional*__
**inherit**?ð¹ | [gitlab.Inherit](#projen-gitlab-inherit) | Controls inheritance of globally-defined defaults and variables.
__*Optional*__
**interruptible**?ð¹ | boolean | __*Optional*__
**needs**?ð¹ | Array | The list of jobs in previous stages whose sole completion is needed to start the current job.
__*Optional*__
**only**?ð¹ | Array | [gitlab.Filter](#projen-gitlab-filter) | Job will run *only* when these filtering options match.
__*Optional*__
**parallel**?ð¹ | number | [gitlab.Parallel](#projen-gitlab-parallel) | Parallel will split up a single job into several, and provide `CI_NODE_INDEX` and `CI_NODE_TOTAL` environment variables for the running jobs.
__*Optional*__
**release**?ð¹ | [gitlab.Release](#projen-gitlab-release) | Indicates that the job creates a Release.
__*Optional*__
**resourceGroup**?ð¹ | string | Limit job concurrency.
__*Optional*__
**retry**?ð¹ | [gitlab.Retry](#projen-gitlab-retry) | __*Optional*__
**rules**?ð¹ | Array<[gitlab.IncludeRule](#projen-gitlab-includerule)> | Rules allows for an array of individual rule objects to be evaluated in order, until one matches and dynamically provides attributes to the job.
__*Optional*__
**script**?ð¹ | Array | Shell scripts executed by the Runner.
__*Optional*__
**secrets**?ð¹ | Map> | CI/CD secrets.
__*Optional*__
**services**?ð¹ | Array<[gitlab.Service](#projen-gitlab-service)> | __*Optional*__
**stage**?ð¹ | string | Define what stage the job will run in.
__*Optional*__
**startIn**?ð¹ | string | __*Optional*__
**tags**?ð¹ | Array | __*Optional*__
**timeout**?ð¹ | string | __*Optional*__
**trigger**?ð¹ | string | [gitlab.Trigger](#projen-gitlab-trigger) | Trigger allows you to define downstream pipeline trigger.
__*Optional*__
**variables**?ð¹ | Map | Configurable values that are passed to the Job.
__*Optional*__
**when**?ð¹ | [gitlab.JobWhen](#projen-gitlab-jobwhen) | Describes the conditions for when to run the job.
__*Optional*__
## struct KubernetesConfig ð¹
Used to configure the kubernetes deployment for this environment.
This is currently not
supported for kubernetes clusters that are managed by Gitlab.
Name | Type | Description
-----|------|-------------
**namespace**?ð¹ | string | The kubernetes namespace where this environment should be deployed to.
__*Optional*__
## struct Link ð¹
Link configuration for an asset.
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | The name of the link.
**url**ð¹ | string | The URL to download a file.
**filepath**?ð¹ | string | The redirect link to the url.
__*Optional*__
**linkType**?ð¹ | [gitlab.LinkType](#projen-gitlab-linktype) | The content kind of what users can download via url.
__*Optional*__
## struct Need ð¹
A jobs in a previous stage whose sole completion is needed to start the current job.
Name | Type | Description
-----|------|-------------
**job**ð¹ | string |
**artifacts**?ð¹ | boolean | __*Optional*__
**optional**?ð¹ | boolean | __*Optional*__
**pipeline**?ð¹ | string | __*Optional*__
**project**?ð¹ | string | __*Optional*__
**ref**?ð¹ | string | __*Optional*__
## struct Parallel ð¹
Used to run a job multiple times in parallel in a single pipeline.
Name | Type | Description
-----|------|-------------
**matrix**ð¹ | Array>> | Defines different variables for jobs that are running in parallel.
## struct Release ð¹
Indicates that the job creates a Release.
Name | Type | Description
-----|------|-------------
**description**ð¹ | string | Specifies the longer description of the Release.
**tagName**ð¹ | string | The tag_name must be specified.
**assets**?ð¹ | [gitlab.Assets](#projen-gitlab-assets) | __*Optional*__
**milestones**?ð¹ | Array | The title of each milestone the release is associated with.
__*Optional*__
**name**?ð¹ | string | The Release name.
__*Optional*__
**ref**?ð¹ | string | If the release: tag_name doesnât exist yet, the release is created from ref.
__*Optional*__
**releasedAt**?ð¹ | string | The date and time when the release is ready.
__*Optional*__
## struct Reports ð¹
Reports will be uploaded as artifacts, and often displayed in the Gitlab UI, such as in Merge Requests.
Name | Type | Description
-----|------|-------------
**cobertura**?â ïž | Array | Path for file(s) that should be parsed as Cobertura XML coverage report.
__*Optional*__
**codequality**?ð¹ | Array | Path to file or list of files with code quality report(s) (such as Code Climate).
__*Optional*__
**containerScanning**?ð¹ | Array | Path to file or list of files with Container scanning vulnerabilities report(s).
__*Optional*__
**coverageReport**?ð¹ | [gitlab.CoverageReport](#projen-gitlab-coveragereport) | Code coverage report information.
__*Optional*__
**dast**?ð¹ | Array | Path to file or list of files with DAST vulnerabilities report(s).
__*Optional*__
**dependencyScanning**?ð¹ | Array | Path to file or list of files with Dependency scanning vulnerabilities report(s).
__*Optional*__
**dotenv**?ð¹ | Array | Path to file or list of files containing runtime-created variables for this job.
__*Optional*__
**junit**?ð¹ | Array | Path for file(s) that should be parsed as JUnit XML result.
__*Optional*__
**licenseManagement**?ð¹ | Array | Deprecated in 12.8: Path to file or list of files with license report(s).
__*Optional*__
**licenseScanning**?ð¹ | Array | Path to file or list of files with license report(s).
__*Optional*__
**lsif**?ð¹ | Array | Path to file or list of files containing code intelligence (Language Server Index Format).
__*Optional*__
**metrics**?ð¹ | Array | Path to file or list of files with custom metrics report(s).
__*Optional*__
**performance**?ð¹ | Array | Path to file or list of files with performance metrics report(s).
__*Optional*__
**requirements**?ð¹ | Array | Path to file or list of files with requirements report(s).
__*Optional*__
**sast**?ð¹ | Array | Path to file or list of files with SAST vulnerabilities report(s).
__*Optional*__
**secretDetection**?ð¹ | Array | Path to file or list of files with secret detection report(s).
__*Optional*__
**terraform**?ð¹ | Array | Path to file or list of files with terraform plan(s).
__*Optional*__
## struct Retry ð¹
How many times a job is retried if it fails.
If not defined, defaults to 0 and jobs do not retry.
Name | Type | Description
-----|------|-------------
**max**?ð¹ | number | 0 (default), 1, or 2.
__*Optional*__
**when**?ð¹ | any | Either a single or array of error types to trigger job retry.
__*Optional*__
## struct Secret ð¹
A CI/CD secret.
Name | Type | Description
-----|------|-------------
**vault**ð¹ | [gitlab.VaultConfig](#projen-gitlab-vaultconfig) |
## struct Service ð¹
Used to specify an additional Docker image to run scripts in.
The service image is linked to the image specified in the
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | Full name of the image that should be used.
**alias**?ð¹ | string | Additional alias that can be used to access the service from the job's container.
__*Optional*__
**command**?ð¹ | Array | Command or script that should be used as the container's command.
__*Optional*__
**entrypoint**?ð¹ | Array | Command or script that should be executed as the container's entrypoint.
__*Optional*__
## struct Trigger ð¹
Trigger a multi-project or a child pipeline.
Read more:
Name | Type | Description
-----|------|-------------
**branch**?ð¹ | string | The branch name that a downstream pipeline will use.
__*Optional*__
**include**?ð¹ | Array<[gitlab.TriggerInclude](#projen-gitlab-triggerinclude)> | A list of local files or artifacts from other jobs to define the pipeline.
__*Optional*__
**project**?ð¹ | string | Path to the project, e.g. `group/project`, or `group/sub-group/project`.
__*Optional*__
**strategy**?ð¹ | [gitlab.Strategy](#projen-gitlab-strategy) | You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend.
__*Optional*__
## struct TriggerInclude ð¹
References a local file or an artifact from another job to define the pipeline configuration.
Name | Type | Description
-----|------|-------------
**artifact**?ð¹ | string | Relative path to the generated YAML file which is extracted from the artifacts and used as the configuration for triggering the child pipeline.
__*Optional*__
**file**?ð¹ | string | Relative path from repository root (`/`) to the pipeline configuration YAML file.
__*Optional*__
**job**?ð¹ | string | Job name which generates the artifact.
__*Optional*__
**local**?ð¹ | string | Relative path from local repository root (`/`) to the local YAML file to define the pipeline configuration.
__*Optional*__
**project**?ð¹ | string | Path to another private project under the same GitLab instance, like `group/project` or `group/sub-group/project`.
__*Optional*__
**ref**?ð¹ | string | Branch/Tag/Commit hash for the target project.
__*Optional*__
**template**?ð¹ | string | Name of the template YAML file to use in the pipeline configuration.
__*Optional*__
## struct VariableConfig ð¹
Explains what the global variable is used for, what the acceptable values are.
Name | Type | Description
-----|------|-------------
**description**?ð¹ | string | Define a global variable that is prefilled when running a pipeline manually.
__*Optional*__
**value**?ð¹ | string | The variable value.
__*Optional*__
## struct VaultConfig ð¹
Specification for a secret provided by a HashiCorp Vault.
Name | Type | Description
-----|------|-------------
**engine**ð¹ | [gitlab.Engine](#projen-gitlab-engine) |
**field**ð¹ | string |
**path**ð¹ | string | Path to the secret.
## struct Workflow ð¹
Used to control pipeline behavior.
Name | Type | Description
-----|------|-------------
**rules**?ð¹ | Array<[gitlab.WorkflowRule](#projen-gitlab-workflowrule)> | Used to control whether or not a whole pipeline is created.
__*Optional*__
## struct WorkflowRule ð¹
Used to control whether or not a whole pipeline is created.
Name | Type | Description
-----|------|-------------
**changes**?ð¹ | Array | __*Optional*__
**exists**?ð¹ | Array | __*Optional*__
**if**?ð¹ | string | __*Optional*__
**variables**?ð¹ | Map | __*Optional*__
**when**?ð¹ | [gitlab.JobWhen](#projen-gitlab-jobwhen) | __*Optional*__
## struct JavaProjectCommonOptions ð¹
Options for `JavaProject`.
Name | Type | Description
-----|------|-------------
**artifactId**ð¹ | string | The artifactId is generally the name that the project is known by.
**groupId**ð¹ | string | This is generally unique amongst an organization or a project.
**name**ð¹ | string | This is the name of your project.
**version**ð¹ | string | This is the last piece of the naming puzzle.
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**compileOptions**?ð¹ | [java.MavenCompileOptions](#projen-java-mavencompileoptions) | Compile options.
__*Default*__: defaults
**deps**?ð¹ | Array | List of runtime dependencies for this project.
__*Default*__: []
**description**?ð¹ | string | Description of a project is always good.
__*Default*__: undefined
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**distdir**?ð¹ | string | Final artifact output directory.
__*Default*__: "dist/java"
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**junit**?ð¹ | boolean | Include junit tests.
__*Default*__: true
**junitOptions**?ð¹ | [java.JunitOptions](#projen-java-junitoptions) | junit options.
__*Default*__: defaults
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**packaging**?ð¹ | string | Project packaging format.
__*Default*__: "jar"
**packagingOptions**?ð¹ | [java.MavenPackagingOptions](#projen-java-mavenpackagingoptions) | Packaging options.
__*Default*__: defaults
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenrcJava**?ð¹ | boolean | Use projenrc in java.
__*Default*__: true
**projenrcJavaOptions**?ð¹ | [java.ProjenrcOptions](#projen-java-projenrcoptions) | Options related to projenrc in java.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testDeps**?ð¹ | Array | List of test dependencies for this project.
__*Default*__: []
**url**?ð¹ | string | The URL, like the name, is not required.
__*Default*__: undefined
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
## struct JavaProjectOptions ð¹
Options for `JavaProject`.
Name | Type | Description
-----|------|-------------
**artifactId**ð¹ | string | The artifactId is generally the name that the project is known by.
**groupId**ð¹ | string | This is generally unique amongst an organization or a project.
**name**ð¹ | string | This is the name of your project.
**version**ð¹ | string | This is the last piece of the naming puzzle.
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**compileOptions**?ð¹ | [java.MavenCompileOptions](#projen-java-mavencompileoptions) | Compile options.
__*Default*__: defaults
**deps**?ð¹ | Array | List of runtime dependencies for this project.
__*Default*__: []
**description**?ð¹ | string | Description of a project is always good.
__*Default*__: undefined
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**distdir**?ð¹ | string | Final artifact output directory.
__*Default*__: "dist/java"
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**junit**?ð¹ | boolean | Include junit tests.
__*Default*__: true
**junitOptions**?ð¹ | [java.JunitOptions](#projen-java-junitoptions) | junit options.
__*Default*__: defaults
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**packaging**?ð¹ | string | Project packaging format.
__*Default*__: "jar"
**packagingOptions**?ð¹ | [java.MavenPackagingOptions](#projen-java-mavenpackagingoptions) | Packaging options.
__*Default*__: defaults
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenrcJava**?ð¹ | boolean | Use projenrc in java.
__*Default*__: true
**projenrcJavaOptions**?ð¹ | [java.ProjenrcOptions](#projen-java-projenrcoptions) | Options related to projenrc in java.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**sample**?ð¹ | boolean | Include sample code and test if the relevant directories don't exist.
__*Default*__: true
**sampleJavaPackage**?ð¹ | string | The java package to use for the code sample.
__*Default*__: "org.acme"
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testDeps**?ð¹ | Array | List of test dependencies for this project.
__*Default*__: []
**url**?ð¹ | string | The URL, like the name, is not required.
__*Default*__: undefined
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
## struct JunitOptions ð¹
Options for `Junit`.
Name | Type | Description
-----|------|-------------
**pom**ð¹ | [java.Pom](#projen-java-pom) | Java pom.
**sampleJavaPackage**?ð¹ | string | Java package for test sample.
__*Default*__: "org.acme"
**version**?ð¹ | string | Junit version.
__*Default*__: "5.7.0"
## struct MavenCompileOptions ð¹
Options for `MavenCompile`.
Name | Type | Description
-----|------|-------------
**source**?ð¹ | string | Source language version.
__*Default*__: "1.8"
**target**?ð¹ | string | Target JVM version.
__*Default*__: "1.8"
## struct MavenPackagingOptions ð¹
Options for `MavenPackage`.
Name | Type | Description
-----|------|-------------
**distdir**?ð¹ | string | Where to place the package output?
__*Default*__: "dist/java"
**javadocs**?ð¹ | boolean | Include javadocs jar in package.
__*Default*__: true
**javadocsExclude**?ð¹ | Array | Exclude source files from docs.
__*Default*__: []
**sources**?ð¹ | boolean | Include sources jar in package.
__*Default*__: true
## struct MavenRepository ð¹
Represents a Maven repository.
Name | Type | Description
-----|------|-------------
**id**ð¹ | string | The identifier for the repository.
**url**ð¹ | string | The url of the repository.
**layout**?ð¹ | string | The layout of the repository.
__*Optional*__
**name**?ð¹ | string | The name of the repository.
__*Optional*__
## struct MavenSampleOptions ð¹
Name | Type | Description
-----|------|-------------
**package**ð¹ | string | Project root java package.
## struct PluginExecution ð¹
Plugin execution definition.
Name | Type | Description
-----|------|-------------
**goals**ð¹ | Array | Which Maven goals this plugin should be associated with.
**id**ð¹ | string | The ID.
**phase**?ð¹ | string | The phase in which the plugin should execute.
__*Optional*__
## struct PluginOptions ð¹
Options for Maven plugins.
Name | Type | Description
-----|------|-------------
**configuration**?ð¹ | Map | Plugin key/value configuration.
__*Default*__: {}
**dependencies**?ð¹ | Array | You could configure the dependencies for the plugin.
__*Default*__: []
**executions**?ð¹ | Array<[java.PluginExecution](#projen-java-pluginexecution)> | Plugin executions.
__*Default*__: []
## struct PomOptions ð¹
Options for `Pom`.
Name | Type | Description
-----|------|-------------
**artifactId**ð¹ | string | The artifactId is generally the name that the project is known by.
**groupId**ð¹ | string | This is generally unique amongst an organization or a project.
**version**ð¹ | string | This is the last piece of the naming puzzle.
**description**?ð¹ | string | Description of a project is always good.
__*Default*__: undefined
**packaging**?ð¹ | string | Project packaging format.
__*Default*__: "jar"
**url**?ð¹ | string | The URL, like the name, is not required.
__*Default*__: undefined
## struct ProjenrcOptions ð¹
Options for `Projenrc`.
Name | Type | Description
-----|------|-------------
**className**?ð¹ | string | The name of the Java class which contains the `main()` method for projen.
__*Default*__: "projenrc"
**projenVersion**?ð¹ | string | The projen version to use.
__*Default*__: current version
**testScope**?ð¹ | boolean | Defines projenrc under the test scope instead of the main scope, which is reserved to the app.
__*Default*__: true
## struct AddBundleOptions ð¹
Options for `addBundle()`.
Name | Type | Description
-----|------|-------------
**platform**ð¹ | string | esbuild platform.
**target**ð¹ | string | esbuild target.
**executable**?ð¹ | boolean | Mark the output file as executable.
__*Default*__: false
**externals**?ð¹ | Array | You can mark a file or a package as external to exclude it from your build.
__*Default*__: []
**loaders**?ð¹ | Map | Map of file extensions (without dot) and loaders to use for this file type.
__*Optional*__
**outfile**?ð¹ | string | Bundler output path relative to the asset's output directory.
__*Default*__: "index.js"
**sourcemap**?ð¹ | boolean | Include a source map in the bundle.
__*Default*__: false
**tsconfigPath**?ð¹ | string | The path of the tsconfig.json file to use for bundling.
__*Default*__: "tsconfig.json"
**watchTask**?ð¹ | boolean | In addition to the `bundle:xyz` task, creates `bundle:xyz:watch` task which will invoke the same esbuild command with the `--watch` flag.
__*Default*__: true
## struct Bundle ð¹
__Obtainable from__: [Bundler](#projen-javascript-bundler).[addBundle](#projen-javascript-bundler#projen-javascript-bundler-addbundle)()
Name | Type | Description
-----|------|-------------
**bundleTask**ð¹ | [Task](#projen-task) | The task that produces this bundle.
**outdir**ð¹ | string | Base directory containing the output file (relative to project root).
**outfile**ð¹ | string | Location of the output file (relative to project root).
**watchTask**?ð¹ | [Task](#projen-task) | The "watch" task for this bundle.
__*Optional*__
## struct BundlerOptions ð¹
Options for `Bundler`.
Name | Type | Description
-----|------|-------------
**addToPreCompile**?ð¹ | boolean | Install the `bundle` command as a pre-compile phase.
__*Default*__: true
**assetsDir**?ð¹ | string | Output directory for all bundles.
__*Default*__: "assets"
**esbuildVersion**?ð¹ | string | The semantic version requirement for `esbuild`.
__*Default*__: no specific version (implies latest)
**loaders**?ð¹ | Map | Map of file extensions (without dot) and loaders to use for this file type.
__*Optional*__
## struct BundlingOptions ð¹
Options for bundling.
Name | Type | Description
-----|------|-------------
**externals**?ð¹ | Array | You can mark a file or a package as external to exclude it from your build.
__*Default*__: []
**sourcemap**?ð¹ | boolean | Include a source map in the bundle.
__*Default*__: false
**watchTask**?ð¹ | boolean | In addition to the `bundle:xyz` task, creates `bundle:xyz:watch` task which will invoke the same esbuild command with the `--watch` flag.
__*Default*__: true
## struct CodeArtifactOptions ð¹
Options for publishing npm packages to AWS CodeArtifact.
Name | Type | Description
-----|------|-------------
**accessKeyIdSecret**?ð¹ | string | GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.
__*Default*__: When the `authProvider` value is set to `CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR`, the default is "AWS_ACCESS_KEY_ID". For `CodeArtifactAuthProvider.GITHUB_OIDC`, this value must be left undefined.
**authProvider**?ð¹ | [javascript.CodeArtifactAuthProvider](#projen-javascript-codeartifactauthprovider) | Provider to use for authorizing requests to AWS CodeArtifact.
__*Default*__: CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR
**roleToAssume**?ð¹ | string | ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (`registry` contains AWS CodeArtifact URL).
__*Default*__: undefined
**secretAccessKeySecret**?ð¹ | string | GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.
__*Default*__: When the `authProvider` value is set to `CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR`, the default is "AWS_SECRET_ACCESS_KEY". For `CodeArtifactAuthProvider.GITHUB_OIDC`, this value must be left undefined.
## struct CoverageThreshold ð¹
Name | Type | Description
-----|------|-------------
**branches**?ð¹ | number | __*Optional*__
**functions**?ð¹ | number | __*Optional*__
**lines**?ð¹ | number | __*Optional*__
**statements**?ð¹ | number | __*Optional*__
## struct EslintOptions ð¹
Name | Type | Description
-----|------|-------------
**dirs**ð¹ | Array | Files or glob patterns or directories with source files to lint (e.g. [ "src" ]).
**aliasExtensions**?ð¹ | Array | Enable import alias for module paths.
__*Default*__: undefined
**aliasMap**?ð¹ | Map | Enable import alias for module paths.
__*Default*__: undefined
**devdirs**?ð¹ | Array | Files or glob patterns or directories with source files that include tests and build tools.
__*Default*__: []
**fileExtensions**?ð¹ | Array | File types that should be linted (e.g. [ ".js", ".ts" ]).
__*Default*__: [".ts"]
**ignorePatterns**?ð¹ | Array | List of file patterns that should not be linted, using the same syntax as .gitignore patterns.
__*Default*__: [ '*.js', '*.d.ts', 'node_modules/', '*.generated.ts', 'coverage' ]
**lintProjenRc**?â ïž | boolean | Should we lint .projenrc.js.
__*Default*__: true
**lintProjenRcFile**?â ïž | string | Projenrc file to lint.
__*Default*__: PROJEN_RC
**prettier**?ð¹ | boolean | Enable prettier for code formatting.
__*Default*__: false
**tsAlwaysTryTypes**?ð¹ | boolean | Always try to resolve types under `@types` directory even it doesn't contain any source code.
__*Default*__: true
**tsconfigPath**?ð¹ | string | Path to `tsconfig.json` which should be used by eslint.
__*Default*__: "./tsconfig.json"
**yaml**?ð¹ | boolean | Write eslint configuration as YAML instead of JSON.
__*Default*__: false
## struct EslintOverride ð¹
eslint rules override.
Name | Type | Description
-----|------|-------------
**files**ð¹ | Array | Files or file patterns on which to apply the override.
**parser**?ð¹ | string | The overridden parser.
__*Optional*__
**rules**?ð¹ | Map | The overriden rules.
__*Optional*__
## struct HasteConfig ð¹
Name | Type | Description
-----|------|-------------
**computeSha1**?ð¹ | boolean | __*Optional*__
**defaultPlatform**?ð¹ | string | __*Optional*__
**hasteImplModulePath**?ð¹ | string | __*Optional*__
**platforms**?ð¹ | Array | __*Optional*__
**throwOnModuleCollision**?ð¹ | boolean | __*Optional*__
## struct JestConfigOptions ð¹
Name | Type | Description
-----|------|-------------
**additionalOptions**?ð¹ | Map | Escape hatch to allow any value.
__*Optional*__
**automock**?ð¹ | boolean | This option tells Jest that all imported modules in your tests should be mocked automatically.
__*Default*__: false
**bail**?ð¹ | number | boolean | By default, Jest runs all tests and produces all errors into the console upon completion.
__*Default*__: 0
**cacheDirectory**?ð¹ | string | The directory where Jest should store its cached dependency information.
__*Default*__: "/tmp/"
**clearMocks**?ð¹ | boolean | Automatically clear mock calls and instances before every test.
__*Default*__: true
**collectCoverage**?ð¹ | boolean | Indicates whether the coverage information should be collected while executing the test.
__*Default*__: true
**collectCoverageFrom**?ð¹ | Array | An array of glob patterns indicating a set of files for which coverage information should be collected.
__*Default*__: undefined
**coverageDirectory**?ð¹ | string | The directory where Jest should output its coverage files.
__*Default*__: "coverage"
**coveragePathIgnorePatterns**?ð¹ | Array | An array of regexp pattern strings that are matched against all file paths before executing the test.
__*Default*__: "/node_modules/"
**coverageProvider**?ð¹ | string | Indicates which provider should be used to instrument code for coverage.
__*Default*__: "babel"
**coverageReporters**?ð¹ | Array | A list of reporter names that Jest uses when writing coverage reports.
__*Default*__: ["json", "lcov", "text", "clover", "cobertura"]
**coverageThreshold**?ð¹ | [javascript.CoverageThreshold](#projen-javascript-coveragethreshold) | Specify the global coverage thresholds.
__*Default*__: undefined
**dependencyExtractor**?ð¹ | string | This option allows the use of a custom dependency extractor.
__*Default*__: undefined
**displayName**?ð¹ | any | Allows for a label to be printed alongside a test while it is running.
__*Default*__: undefined
**errorOnDeprecated**?ð¹ | boolean | Make calling deprecated APIs throw helpful error messages.
__*Default*__: false
**extraGlobals**?ð¹ | Array | Test files run inside a vm, which slows calls to global context properties (e.g. Math). With this option you can specify extra properties to be defined inside the vm for faster lookups.
__*Default*__: undefined
**forceCoverageMatch**?ð¹ | Array | Test files are normally ignored from collecting code coverage.
__*Default*__: ['']
**globalSetup**?ð¹ | string | This option allows the use of a custom global setup module which exports an async function that is triggered once before all test suites.
__*Default*__: undefined
**globalTeardown**?ð¹ | string | This option allows the use of a custom global teardown module which exports an async function that is triggered once after all test suites.
__*Default*__: undefined
**globals**?ð¹ | any | A set of global variables that need to be available in all test environments.
__*Default*__: {}
**haste**?ð¹ | [javascript.HasteConfig](#projen-javascript-hasteconfig) | This will be used to configure the behavior of jest-haste-map, Jest's internal file crawler/cache system.
__*Default*__: {}
**injectGlobals**?ð¹ | boolean | Insert Jest's globals (expect, test, describe, beforeEach etc.) into the global environment. If you set this to false, you should import from.
__*Default*__: true
**maxConcurrency**?ð¹ | number | A number limiting the number of tests that are allowed to run at the same time when using test.concurrent. Any test above this limit will be queued and executed once a slot is released.
__*Default*__: 5
**maxWorkers**?ð¹ | string | number | Specifies the maximum number of workers the worker-pool will spawn for running tests.
__*Default*__: the number of the cores available on your machine minus one for the main thread
**moduleDirectories**?ð¹ | Array | An array of directory names to be searched recursively up from the requiring module's location.
__*Default*__: ["node_modules"]
**moduleFileExtensions**?ð¹ | Array | An array of file extensions your modules use.
__*Default*__: ["js", "json", "jsx", "ts", "tsx", "node"]
**moduleNameMapper**?ð¹ | Map> | A map from regular expressions to module names or to arrays of module names that allow to stub out resources, like images or styles with a single module.
__*Default*__: null
**modulePathIgnorePatterns**?ð¹ | Array | An array of regexp pattern strings that are matched against all module paths before those paths are to be considered 'visible' to the module loader.
__*Default*__: []
**modulePaths**?ð¹ | Array | An alternative API to setting the NODE_PATH env variable, modulePaths is an array of absolute paths to additional locations to search when resolving modules.
__*Default*__: []
**notify**?ð¹ | boolean | Activates notifications for test results.
__*Default*__: false
**notifyMode**?ð¹ | string | Specifies notification mode.
__*Default*__: failure-change
**preset**?ð¹ | string | A preset that is used as a base for Jest's configuration.
__*Default*__: undefined
**prettierPath**?ð¹ | string | Sets the path to the prettier node module used to update inline snapshots.
__*Default*__: "prettier"
**projects**?ð¹ | Array> | When the projects configuration is provided with an array of paths or glob patterns, Jest will run tests in all of the specified projects at the same time.
__*Default*__: undefined
**reporters**?ð¹ | Array<[javascript.JestReporter](#projen-javascript-jestreporter)> | Use this configuration option to add custom reporters to Jest.
__*Default*__: undefined
**resetMocks**?ð¹ | boolean | Automatically reset mock state before every test.
__*Default*__: false
**resetModules**?ð¹ | boolean | By default, each test file gets its own independent module registry.
__*Default*__: false
**resolver**?ð¹ | string | This option allows the use of a custom resolver.
__*Default*__: undefined
**restoreMocks**?ð¹ | boolean | Automatically restore mock state before every test.
__*Default*__: false
**rootDir**?ð¹ | string | The root directory that Jest should scan for tests and modules within.
__*Default*__: directory of the package.json
**roots**?ð¹ | Array | A list of paths to directories that Jest should use to search for files in.
__*Default*__: [""]
**runner**?ð¹ | string | This option allows you to use a custom runner instead of Jest's default test runner.
__*Default*__: "jest-runner"
**setupFiles**?ð¹ | Array | A list of paths to modules that run some code to configure or set up the testing environment.
__*Default*__: []
**setupFilesAfterEnv**?ð¹ | Array | A list of paths to modules that run some code to configure or set up the testing framework before each test file in the suite is executed.
__*Default*__: []
**slowTestThreshold**?ð¹ | number | The number of seconds after which a test is considered as slow and reported as such in the results.
__*Default*__: 5
**snapshotResolver**?ð¹ | string | The path to a module that can resolve test<->snapshot path.
__*Default*__: undefined
**snapshotSerializers**?ð¹ | Array | A list of paths to snapshot serializer modules Jest should use for snapshot testing.
__*Default*__: = []
**testEnvironment**?ð¹ | string | The test environment that will be used for testing.
__*Default*__: "jsdom"
**testEnvironmentOptions**?ð¹ | any | Test environment options that will be passed to the testEnvironment.
__*Default*__: {}
**testFailureExitCode**?ð¹ | number | The exit code Jest returns on test failure.
__*Default*__: 1
**testMatch**?ð¹ | Array | The glob patterns Jest uses to detect test files.
__*Default*__: ['**\/__tests__/**\/*.[jt]s?(x)', '**\/?(*.)+(spec|test).[tj]s?(x)']
**testPathIgnorePatterns**?ð¹ | Array | An array of regexp pattern strings that are matched against all test paths before executing the test.
__*Default*__: ["/node_modules/"]
**testRegex**?ð¹ | string | Array | The pattern or patterns Jest uses to detect test files.
__*Default*__: (/__tests__/.*|(\\.|/)(test|spec))\\.[jt]sx?$
**testResultsProcessor**?ð¹ | string | This option allows the use of a custom results processor.
__*Default*__: undefined
**testRunner**?ð¹ | string | This option allows the use of a custom test runner.
__*Default*__: "jasmine2"
**testSequencer**?ð¹ | string | This option allows you to use a custom sequencer instead of Jest's default.
__*Default*__: "@jest/test-sequencer"
**testTimeout**?ð¹ | number | Default timeout of a test in milliseconds.
__*Default*__: 5000
**testURL**?ð¹ | string | This option sets the URL for the jsdom environment.
__*Default*__: "http://localhost"
**timers**?ð¹ | string | Setting this value to legacy or fake allows the use of fake timers for functions such as setTimeout.
__*Default*__: "real"
**transform**?ð¹ | Map | A map from regular expressions to paths to transformers.
__*Default*__: {"\\.[jt]sx?$": "babel-jest"}
**transformIgnorePatterns**?ð¹ | Array | An array of regexp pattern strings that are matched against all source file paths before transformation.
__*Default*__: ["/node_modules/", "\\.pnp\\.[^\\\/]+$"]
**unmockedModulePathPatterns**?ð¹ | Array | An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them.
__*Default*__: []
**verbose**?ð¹ | boolean | Indicates whether each individual test should be reported during the run.
__*Default*__: false
**watchPathIgnorePatterns**?ð¹ | Array | An array of RegExp patterns that are matched against all source file paths before re-running tests in watch mode.
__*Default*__: []
**watchPlugins**?ð¹ | Array<[javascript.WatchPlugin](#projen-javascript-watchplugin)> | __*Default*__: -
**watchman**?ð¹ | boolean | Whether to use watchman for file crawling.
__*Default*__: true
## struct JestOptions ð¹
Name | Type | Description
-----|------|-------------
**configFilePath**?ð¹ | string | Path to JSON config file for Jest.
__*Default*__: No separate config file, jest settings are stored in package.json
**coverage**?â ïž | boolean | Collect coverage.
__*Default*__: true
**coverageText**?ð¹ | boolean | Include the `text` coverage reporter, which means that coverage summary is printed at the end of the jest execution.
__*Default*__: true
**extraCliOptions**?ð¹ | Array | Additional options to pass to the Jest CLI invocation.
__*Default*__: no extra options
**ignorePatterns**?â ïž | Array | Defines `testPathIgnorePatterns` and `coveragePathIgnorePatterns`.
__*Default*__: ["/node_modules/"]
**jestConfig**?ð¹ | [javascript.JestConfigOptions](#projen-javascript-jestconfigoptions) | Jest configuration.
__*Default*__: default jest configuration
**jestVersion**?ð¹ | string | The version of jest to use.
__*Default*__: installs the latest jest version
**junitReporting**?ð¹ | boolean | Result processing with jest-junit.
__*Default*__: true
**preserveDefaultReporters**?ð¹ | boolean | Preserve the default Jest reporter when additional reporters are added.
__*Default*__: true
**updateSnapshot**?ð¹ | [javascript.UpdateSnapshot](#projen-javascript-updatesnapshot) | Whether to update snapshots in task "test" (which is executed in task "build" and build workflows), or create a separate task "test:update" for updating snapshots.
__*Default*__: ALWAYS
## struct NodePackageOptions ð¹
Name | Type | Description
-----|------|-------------
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
## struct NodeProjectOptions ð¹
Name | Type | Description
-----|------|-------------
**defaultReleaseBranch**ð¹ | string | The name of the main release branch.
**name**ð¹ | string | This is the name of your project.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct NpmConfigOptions ð¹
Options to configure the local NPM config.
Name | Type | Description
-----|------|-------------
**omitEmpty**?ð¹ | boolean | Omits empty objects and arrays.
__*Default*__: false
**registry**?ð¹ | string | URL of the registry mirror to use.
__*Default*__: use npmjs default registry
## struct PeerDependencyOptions ð¹
Name | Type | Description
-----|------|-------------
**pinnedDevDependency**?ð¹ | boolean | Automatically add a pinned dev dependency.
__*Default*__: true
## struct PrettierOptions ð¹
Options for Prettier.
Name | Type | Description
-----|------|-------------
**ignoreFile**?ð¹ | boolean | Defines an .prettierIgnore file.
__*Default*__: true
**ignoreFileOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .prettierignore file.
__*Optional*__
**overrides**?ð¹ | Array<[javascript.PrettierOverride](#projen-javascript-prettieroverride)> | Provide a list of patterns to override prettier configuration.
__*Default*__: []
**settings**?ð¹ | [javascript.PrettierSettings](#projen-javascript-prettiersettings) | Prettier settings.
__*Default*__: default settings
**yaml**?ð¹ | boolean | Write prettier configuration as YAML instead of JSON.
__*Default*__: false
## struct PrettierOverride ð¹
Name | Type | Description
-----|------|-------------
**files**ð¹ | string | Array | Include these files in this override.
**options**ð¹ | [javascript.PrettierSettings](#projen-javascript-prettiersettings) | The options to apply for this override.
**excludeFiles**?ð¹ | string | Array | Exclude these files from this override.
__*Optional*__
## struct PrettierSettings ð¹
Options to set in Prettier directly or through overrides.
Name | Type | Description
-----|------|-------------
**arrowParens**?ð¹ | [javascript.ArrowParens](#projen-javascript-arrowparens) | Include parentheses around a sole arrow function parameter.
__*Default*__: ArrowParens.ALWAYS
**bracketSameLine**?ð¹ | boolean | Put > of opening tags on the last line instead of on a new line.
__*Default*__: false
**bracketSpacing**?ð¹ | boolean | Print spaces between brackets.
__*Default*__: true
**cursorOffset**?ð¹ | number | Print (to stderr) where a cursor at the given position would move to after formatting.
__*Default*__: -1
**embeddedLanguageFormatting**?ð¹ | [javascript.EmbeddedLanguageFormatting](#projen-javascript-embeddedlanguageformatting) | Control how Prettier formats quoted code embedded in the file.
__*Default*__: EmbeddedLanguageFormatting.AUTO
**endOfLine**?ð¹ | [javascript.EndOfLine](#projen-javascript-endofline) | Which end of line characters to apply.
__*Default*__: EndOfLine.LF
**filepath**?ð¹ | string | Specify the input filepath.
__*Default*__: none
**htmlWhitespaceSensitivity**?ð¹ | [javascript.HTMLWhitespaceSensitivity](#projen-javascript-htmlwhitespacesensitivity) | How to handle whitespaces in HTML.
__*Default*__: HTMLWhitespaceSensitivity.CSS
**insertPragma**?ð¹ | boolean | Insert.
__*Default*__: false
**jsxSingleQuote**?ð¹ | boolean | Use single quotes in JSX.
__*Default*__: false
**parser**?ð¹ | string | Which parser to use.
__*Default*__: Prettier automatically infers the parser from the input file path, so you shouldnât have to change this setting.
**pluginSearchDirs**?ð¹ | Array | Custom directory that contains prettier plugins in node_modules subdirectory.
__*Default*__: []
**plugins**?ð¹ | Array | Add a plugin.
__*Default*__: []
**printWidth**?ð¹ | number | The line length where Prettier will try wrap.
__*Default*__: 80
**proseWrap**?ð¹ | [javascript.ProseWrap](#projen-javascript-prosewrap) | How to wrap prose.
__*Default*__: ProseWrap.PRESERVE
**quoteProps**?ð¹ | [javascript.QuoteProps](#projen-javascript-quoteprops) | Change when properties in objects are quoted.
__*Default*__: QuoteProps.ASNEEDED
**rangeEnd**?ð¹ | number | Format code ending at a given character offset (exclusive).
__*Default*__: null
**rangeStart**?ð¹ | number | Format code starting at a given character offset.
__*Default*__: 0
**requirePragma**?ð¹ | boolean | Require either '@prettier' or '@format' to be present in the file's first docblock comment in order for it to be formatted.
__*Default*__: false
**semi**?ð¹ | boolean | Print semicolons.
__*Default*__: true
**singleQuote**?ð¹ | boolean | Use single quotes instead of double quotes.
__*Default*__: false
**tabWidth**?ð¹ | number | Number of spaces per indentation level.
__*Default*__: 2
**trailingComma**?ð¹ | [javascript.TrailingComma](#projen-javascript-trailingcomma) | Print trailing commas wherever possible when multi-line.
__*Default*__: TrailingComma.ES5
**useTabs**?ð¹ | boolean | Indent with tabs instead of spaces.
__*Default*__: false
**vueIndentScriptAndStyle**?ð¹ | boolean | Indent script and style tags in Vue files.
__*Default*__: false
## struct ProjenrcOptions ð¹
Name | Type | Description
-----|------|-------------
**filename**?ð¹ | string | The name of the projenrc file.
__*Default*__: ".projenrc.js"
## struct RenderWorkflowSetupOptions ð¹
Options for `renderInstallSteps()`.
Name | Type | Description
-----|------|-------------
**mutable**?ð¹ | boolean | Should the pacakge lockfile be updated?
__*Default*__: false
## struct ScopedPackagesOptions ð¹
Options for scoped packages.
Name | Type | Description
-----|------|-------------
**registryUrl**ð¹ | string | URL of the registry for scoped packages.
**scope**ð¹ | string | Scope of the packages.
## struct TypeScriptCompilerOptions ð¹
Name | Type | Description
-----|------|-------------
**allowArbitraryExtensions**?ð¹ | boolean | Suppress arbitrary extension import errors with the assumption that a bundler will be handling it.
__*Default*__: undefined
**allowImportingTsExtensions**?ð¹ | boolean | Allows TypeScript files to import each other with TypeScript-specific extensions (`.ts`, `.mts`, `.tsx`). Requires `noEmit` or `emitDeclarationOnly`.
__*Default*__: undefined
**allowJs**?ð¹ | boolean | Allow JavaScript files to be compiled.
__*Default*__: false
**allowSyntheticDefaultImports**?ð¹ | boolean | Allow default imports from modules with no default export.
__*Optional*__
**alwaysStrict**?ð¹ | boolean | Ensures that your files are parsed in the ECMAScript strict mode, and emit âuse strictâ for each source file.
__*Default*__: true
**baseUrl**?ð¹ | string | Lets you set a base directory to resolve non-absolute module names.
__*Optional*__
**customConditions**?ð¹ | Array | List of additional conditions that should succeed when TypeScript resolves from an `exports` or `imports` field of a `package.json`.
__*Default*__: undefined
**declaration**?ð¹ | boolean | To be specified along with the above.
__*Optional*__
**declarationDir**?ð¹ | string | Offers a way to configure the root directory for where declaration files are emitted.
__*Optional*__
**emitDeclarationOnly**?ð¹ | boolean | Only emit .d.ts files; do not emit .js files.
__*Default*__: false
**emitDecoratorMetadata**?ð¹ | boolean | Enables experimental support for decorators, which is in stage 2 of the TC39 standardization process.
__*Default*__: undefined
**esModuleInterop**?ð¹ | boolean | Emit __importStar and __importDefault helpers for runtime babel ecosystem compatibility and enable --allowSyntheticDefaultImports for typesystem compatibility.
__*Default*__: false
**experimentalDecorators**?ð¹ | boolean | Enables experimental support for decorators, which is in stage 2 of the TC39 standardization process.
__*Default*__: true
**forceConsistentCasingInFileNames**?ð¹ | boolean | Disallow inconsistently-cased references to the same file.
__*Default*__: false
**importsNotUsedAsValues**?ð¹ | [javascript.TypeScriptImportsNotUsedAsValues](#projen-javascript-typescriptimportsnotusedasvalues) | This flag works because you can use `import type` to explicitly create an `import` statement which should never be emitted into JavaScript.
__*Default*__: "remove"
**inlineSourceMap**?ð¹ | boolean | When set, instead of writing out a .js.map file to provide source maps, TypeScript will embed the source map content in the .js files.
__*Default*__: true
**inlineSources**?ð¹ | boolean | When set, TypeScript will include the original content of the .ts file as an embedded string in the source map. This is often useful in the same cases as inlineSourceMap.
__*Default*__: true
**isolatedModules**?ð¹ | boolean | Perform additional checks to ensure that separate compilation (such as with transpileModule or.
__*Default*__: false
**jsx**?ð¹ | [javascript.TypeScriptJsxMode](#projen-javascript-typescriptjsxmode) | Support JSX in .tsx files: "react", "preserve", "react-native" etc.
__*Default*__: undefined
**jsxImportSource**?ð¹ | string | Declares the module specifier to be used for importing the jsx and jsxs factory functions when using jsx.
__*Default*__: undefined
**lib**?ð¹ | Array | Reference for type definitions / libraries to use (eg.
__*Default*__: [ "es2018" ]
**module**?ð¹ | string | Sets the module system for the program.
__*Default*__: "CommonJS"
**moduleResolution**?ð¹ | [javascript.TypeScriptModuleResolution](#projen-javascript-typescriptmoduleresolution) | Determine how modules get resolved.
__*Default*__: "node"
**noEmit**?ð¹ | boolean | Do not emit outputs.
__*Default*__: false
**noEmitOnError**?ð¹ | boolean | Do not emit compiler output files like JavaScript source code, source-maps or declarations if any errors were reported.
__*Default*__: true
**noFallthroughCasesInSwitch**?ð¹ | boolean | Report errors for fallthrough cases in switch statements.
__*Default*__: true
**noImplicitAny**?ð¹ | boolean | In some cases where no type annotations are present, TypeScript will fall back to a type of any for a variable when it cannot infer the type.
__*Default*__: true
**noImplicitOverride**?ð¹ | boolean | Using `noImplicitOverride`, you can ensure that sub-classes never go out of sync as they are required to explicitly declare that they are overriding a member using the `override` keyword.
__*Default*__: false
**noImplicitReturns**?ð¹ | boolean | When enabled, TypeScript will check all code paths in a function to ensure they return a value.
__*Default*__: true
**noImplicitThis**?ð¹ | boolean | Raise error on âthisâ expressions with an implied âanyâ type.
__*Default*__: true
**noPropertyAccessFromIndexSignature**?ð¹ | boolean | Raise error on use of the dot syntax to access fields which are not defined.
__*Default*__: true
**noUncheckedIndexedAccess**?ð¹ | boolean | Raise error when accessing indexes on objects with unknown keys defined in index signatures.
__*Default*__: true
**noUnusedLocals**?ð¹ | boolean | Report errors on unused local variables.
__*Default*__: true
**noUnusedParameters**?ð¹ | boolean | Report errors on unused parameters in functions.
__*Default*__: true
**outDir**?ð¹ | string | Output directory for the compiled files.
__*Optional*__
**paths**?ð¹ | Map> | A series of entries which re-map imports to lookup locations relative to the baseUrl, there is a larger coverage of paths in the handbook.
__*Optional*__
**resolveJsonModule**?ð¹ | boolean | Allows importing modules with a â.jsonâ extension, which is a common practice in node projects. This includes generating a type for the import based on the static JSON shape.
__*Default*__: true
**resolvePackageJsonExports**?ð¹ | boolean | Forces TypeScript to consult the `exports` field of `package.json` files if it ever reads from a package in `node_modules`.
__*Default*__: true
**resolvePackageJsonImports**?ð¹ | boolean | Forces TypeScript to consult the `imports` field of `package.json` when performing a lookup that begins with `#` from a file that has a `package.json` as an ancestor.
__*Default*__: undefined
**rootDir**?ð¹ | string | Specifies the root directory of input files.
__*Optional*__
**skipLibCheck**?ð¹ | boolean | Skip type checking of all declaration files (*.d.ts).
__*Default*__: false
**sourceMap**?ð¹ | boolean | Enables the generation of sourcemap files.
__*Default*__: undefined
**sourceRoot**?ð¹ | string | Specify the location where a debugger should locate TypeScript files instead of relative source locations.
__*Default*__: undefined
**strict**?ð¹ | boolean | The strict flag enables a wide range of type checking behavior that results in stronger guarantees of program correctness.
__*Default*__: true
**strictNullChecks**?ð¹ | boolean | When strictNullChecks is false, null and undefined are effectively ignored by the language.
__*Default*__: true
**strictPropertyInitialization**?ð¹ | boolean | When set to true, TypeScript will raise an error when a class property was declared but not set in the constructor.
__*Default*__: true
**stripInternal**?ð¹ | boolean | Do not emit declarations for code that has an `@internal` annotation in itâs JSDoc comment.
__*Default*__: true
**target**?ð¹ | string | Modern browsers support all ES6 features, so ES6 is a good choice.
__*Default*__: "ES2018"
**verbatimModuleSyntax**?ð¹ | boolean | Simplifies TypeScript's handling of import/export `type` modifiers.
__*Default*__: undefined
## struct TypescriptConfigOptions ð¹
Name | Type | Description
-----|------|-------------
**compilerOptions**ð¹ | [javascript.TypeScriptCompilerOptions](#projen-javascript-typescriptcompileroptions) | Compiler options to use.
**exclude**?ð¹ | Array | Filters results from the "include" option.
__*Default*__: node_modules is excluded by default
**extends**?ð¹ | [javascript.TypescriptConfigExtends](#projen-javascript-typescriptconfigextends) | Base `tsconfig.json` configuration(s) to inherit from.
__*Optional*__
**fileName**?ð¹ | string | __*Default*__: "tsconfig.json"
**include**?ð¹ | Array | Specifies a list of glob patterns that match TypeScript files to be included in compilation.
__*Default*__: all .ts files recursively
## struct UpgradeDependenciesOptions ð¹
Options for `UpgradeDependencies`.
Name | Type | Description
-----|------|-------------
**exclude**?ð¹ | Array | List of package names to exclude during the upgrade.
__*Default*__: Nothing is excluded.
**include**?ð¹ | Array | List of package names to include during the upgrade.
__*Default*__: Everything is included.
**pullRequestTitle**?ð¹ | string | Title of the pull request to use (should be all lower-case).
__*Default*__: "upgrade dependencies"
**signoff**?ð¹ | boolean | Add Signed-off-by line by the committer at the end of the commit log message.
__*Default*__: true
**taskName**?ð¹ | string | The name of the task that will be created.
__*Default*__: "upgrade".
**workflow**?ð¹ | boolean | Include a github workflow for creating PR's that upgrades the required dependencies, either by manual dispatch, or by a schedule.
__*Default*__: true for root projects, false for sub-projects.
**workflowOptions**?ð¹ | [javascript.UpgradeDependenciesWorkflowOptions](#projen-javascript-upgradedependenciesworkflowoptions) | Options for the github workflow.
__*Default*__: default options.
## struct UpgradeDependenciesWorkflowOptions ð¹
Options for `UpgradeDependencies.workflowOptions`.
Name | Type | Description
-----|------|-------------
**assignees**?ð¹ | Array | Assignees to add on the PR.
__*Default*__: no assignees
**branches**?ð¹ | Array | List of branches to create PR's for.
__*Default*__: All release branches configured for the project.
**container**?ð¹ | [github.workflows.ContainerOptions](#projen-github-workflows-containeroptions) | Job container options.
__*Default*__: defaults
**gitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use for commits.
__*Default*__: "github-actions@github.com"
**labels**?ð¹ | Array | Labels to apply on the PR.
__*Default*__: no labels.
**permissions**?ð¹ | [github.workflows.JobPermissions](#projen-github-workflows-jobpermissions) | Permissions granted to the upgrade job To limit job permissions for `contents`, the desired permissions have to be explicitly set, e.g.: `{ contents: JobPermission.NONE }`.
__*Default*__: `{ contents: JobPermission.READ }`
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method for authenticating with GitHub for creating the PR.
__*Default*__: personal access token named PROJEN_GITHUB_TOKEN
**runsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
**schedule**?ð¹ | [javascript.UpgradeDependenciesSchedule](#projen-javascript-upgradedependenciesschedule) | Schedule to run on.
__*Default*__: UpgradeDependenciesSchedule.DAILY
## interface IPackageProvider ð¹
### Properties
Name | Type | Description
-----|------|-------------
**packages**ð¹ | Array<[Dependency](#projen-dependency)> | An array of packages (may be dynamically generated).
## interface IPythonDeps ð¹
__Implemented by__: [python.Pip](#projen-python-pip), [python.Poetry](#projen-python-poetry)
### Properties
Name | Type | Description
-----|------|-------------
**installTask**ð¹ | [Task](#projen-task) | A task that installs and updates dependencies.
### Methods
#### addDependency(spec)ð¹
Adds a runtime dependency.
```ts
addDependency(spec: string): void
```
* **spec** (string) Format `@`.
#### addDevDependency(spec)ð¹
Adds a dev dependency.
```ts
addDevDependency(spec: string): void
```
* **spec** (string) Format `@`.
#### installDependencies()ð¹
Installs dependencies (called during post-synthesis).
```ts
installDependencies(): void
```
## interface IPythonEnv ð¹
__Implemented by__: [python.Poetry](#projen-python-poetry), [python.Venv](#projen-python-venv)
### Methods
#### setupEnvironment()ð¹
Initializes the virtual environment if it doesn't exist (called during post-synthesis).
```ts
setupEnvironment(): void
```
## interface IPythonPackaging ð¹
__Implemented by__: [python.Poetry](#projen-python-poetry), [python.Setuptools](#projen-python-setuptools)
### Properties
Name | Type | Description
-----|------|-------------
**publishTask**ð¹ | [Task](#projen-task) | A task that uploads the package to a package repository.
## struct PipOptions ð¹
Options for pip.
## struct PoetryPyprojectOptions ð¹
Poetry-specific options.
Name | Type | Description
-----|------|-------------
**authors**?ð¹ | Array | The authors of the package.
__*Optional*__
**classifiers**?ð¹ | Array | A list of PyPI trove classifiers that describe the project.
__*Optional*__
**dependencies**?ð¹ | Map | A list of dependencies for the project.
__*Optional*__
**description**?ð¹ | string | A short description of the package (required).
__*Optional*__
**devDependencies**?ð¹ | Map | A list of development dependencies for the project.
__*Optional*__
**documentation**?ð¹ | string | A URL to the documentation of the project.
__*Optional*__
**exclude**?ð¹ | Array | A list of patterns that will be excluded in the final package.
__*Optional*__
**extras**?ð¹ | Map> | Package extras.
__*Optional*__
**homepage**?ð¹ | string | A URL to the website of the project.
__*Optional*__
**include**?ð¹ | Array | A list of patterns that will be included in the final package.
__*Optional*__
**keywords**?ð¹ | Array | A list of keywords (max: 5) that the package is related to.
__*Optional*__
**license**?ð¹ | string | License of this package as an SPDX identifier.
__*Optional*__
**maintainers**?ð¹ | Array | the maintainers of the package.
__*Optional*__
**name**?ð¹ | string | Name of the package (required).
__*Optional*__
**packages**?ð¹ | Array | A list of packages and modules to include in the final distribution.
__*Optional*__
**plugins**?ð¹ | any | Plugins.
__*Optional*__
**readme**?ð¹ | string | The name of the readme file of the package.
__*Optional*__
**repository**?ð¹ | string | A URL to the repository of the project.
__*Optional*__
**scripts**?ð¹ | Map | The scripts or executables that will be installed when installing the package.
__*Optional*__
**source**?ð¹ | Array | Source registries from which packages are retrieved.
__*Optional*__
**urls**?ð¹ | Map | Project custom URLs, in addition to homepage, repository and documentation.
__*Optional*__
**version**?ð¹ | string | Version of the package (required).
__*Optional*__
## struct PoetryPyprojectOptionsWithoutDeps ð¹
Poetry-specific options.
Name | Type | Description
-----|------|-------------
**authors**?ð¹ | Array | The authors of the package.
__*Optional*__
**classifiers**?ð¹ | Array | A list of PyPI trove classifiers that describe the project.
__*Optional*__
**description**?ð¹ | string | A short description of the package (required).
__*Optional*__
**documentation**?ð¹ | string | A URL to the documentation of the project.
__*Optional*__
**exclude**?ð¹ | Array | A list of patterns that will be excluded in the final package.
__*Optional*__
**extras**?ð¹ | Map> | Package extras.
__*Optional*__
**homepage**?ð¹ | string | A URL to the website of the project.
__*Optional*__
**include**?ð¹ | Array | A list of patterns that will be included in the final package.
__*Optional*__
**keywords**?ð¹ | Array | A list of keywords (max: 5) that the package is related to.
__*Optional*__
**license**?ð¹ | string | License of this package as an SPDX identifier.
__*Optional*__
**maintainers**?ð¹ | Array | the maintainers of the package.
__*Optional*__
**name**?ð¹ | string | Name of the package (required).
__*Optional*__
**packages**?ð¹ | Array | A list of packages and modules to include in the final distribution.
__*Optional*__
**plugins**?ð¹ | any | Plugins.
__*Optional*__
**readme**?ð¹ | string | The name of the readme file of the package.
__*Optional*__
**repository**?ð¹ | string | A URL to the repository of the project.
__*Optional*__
**scripts**?ð¹ | Map | The scripts or executables that will be installed when installing the package.
__*Optional*__
**source**?ð¹ | Array | Source registries from which packages are retrieved.
__*Optional*__
**urls**?ð¹ | Map | Project custom URLs, in addition to homepage, repository and documentation.
__*Optional*__
**version**?ð¹ | string | Version of the package (required).
__*Optional*__
## struct ProjenrcOptions ð¹
Options for `Projenrc`.
Name | Type | Description
-----|------|-------------
**filename**?ð¹ | string | The name of the projenrc file.
__*Default*__: ".projenrc.py"
**projenVersion**?ð¹ | string | The projen version to use.
__*Default*__: current version
**pythonExec**?ð¹ | string | Path to the python executable to use.
__*Default*__: "python"
## struct PytestOptions ð¹
Name | Type | Description
-----|------|-------------
**maxFailures**?ð¹ | number | Stop the testing process after the first N failures.
__*Optional*__
**testdir**?ð¹ | string | Directory with tests.
__*Default*__: 'tests'
**version**?ð¹ | string | Pytest version.
__*Default*__: "6.2.1"
## struct PytestSampleOptions ð¹
Options for python test code sample.
Name | Type | Description
-----|------|-------------
**moduleName**ð¹ | string | Name of the python package as used in imports and filenames.
**testdir**ð¹ | string | Test directory.
## struct PythonPackagingOptions ð¹
Name | Type | Description
-----|------|-------------
**authorEmail**ð¹ | string | Author's e-mail.
**authorName**ð¹ | string | Author's name.
**version**ð¹ | string | Version of the package.
**classifiers**?ð¹ | Array | A list of PyPI trove classifiers that describe the project.
__*Optional*__
**description**?ð¹ | string | A short description of the package.
__*Optional*__
**homepage**?ð¹ | string | A URL to the website of the project.
__*Optional*__
**license**?ð¹ | string | License of this package as an SPDX identifier.
__*Optional*__
**packageName**?ð¹ | string | Package name.
__*Optional*__
**poetryOptions**?ð¹ | [python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps) | Additional options to set for poetry if using poetry.
__*Optional*__
**setupConfig**?ð¹ | Map | Additional fields to pass in the setup() function if using setuptools.
__*Optional*__
## struct PythonProjectOptions ð¹
Options for `PythonProject`.
Name | Type | Description
-----|------|-------------
**authorEmail**ð¹ | string | Author's e-mail.
**authorName**ð¹ | string | Author's name.
**moduleName**ð¹ | string | Name of the python package as used in imports and filenames.
**name**ð¹ | string | This is the name of your project.
**version**ð¹ | string | Version of the package.
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**classifiers**?ð¹ | Array | A list of PyPI trove classifiers that describe the project.
__*Optional*__
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**deps**?ð¹ | Array | List of runtime dependencies for this project.
__*Default*__: []
**description**?ð¹ | string | A short description of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | List of dev dependencies for this project.
__*Default*__: []
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | A URL to the website of the project.
__*Optional*__
**license**?ð¹ | string | License of this package as an SPDX identifier.
__*Optional*__
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**packageName**?ð¹ | string | Package name.
__*Optional*__
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**pip**?ð¹ | boolean | Use pip with a requirements.txt file to track project dependencies.
__*Default*__: true, unless poetry is true, then false
**poetry**?ð¹ | boolean | Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
__*Default*__: false
**poetryOptions**?ð¹ | [python.PoetryPyprojectOptionsWithoutDeps](#projen-python-poetrypyprojectoptionswithoutdeps) | Additional options to set for poetry if using poetry.
__*Optional*__
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenrcJs**?ð¹ | boolean | Use projenrc in javascript.
__*Default*__: false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options related to projenrc in JavaScript.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcPython**?ð¹ | boolean | Use projenrc in Python.
__*Default*__: true
**projenrcPythonOptions**?ð¹ | [python.ProjenrcOptions](#projen-python-projenrcoptions) | Options related to projenrc in python.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use projenrc in TypeScript.
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcTsOptions](#projen-typescript-projenrctsoptions) | Options related to projenrc in TypeScript.
__*Default*__: default options
**pytest**?ð¹ | boolean | Include pytest tests.
__*Default*__: true
**pytestOptions**?ð¹ | [python.PytestOptions](#projen-python-pytestoptions) | pytest options.
__*Default*__: defaults
**pythonExec**?ð¹ | string | Path to the python executable to use.
__*Default*__: "python"
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**sample**?ð¹ | boolean | Include sample code and test if the relevant directories don't exist.
__*Default*__: true
**setupConfig**?ð¹ | Map | Additional fields to pass in the setup() function if using setuptools.
__*Optional*__
**setuptools**?ð¹ | boolean | Use setuptools with a setup.py script for packaging and publishing.
__*Default*__: true, unless poetry is true, then false
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**venv**?ð¹ | boolean | Use venv to manage a virtual environment for installing dependencies inside.
__*Default*__: true, unless poetry is true, then false
**venvOptions**?ð¹ | [python.VenvOptions](#projen-python-venvoptions) | Venv options.
__*Default*__: defaults
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
## struct PythonSampleOptions ð¹
Options for python sample code.
Name | Type | Description
-----|------|-------------
**dir**ð¹ | string | Sample code directory.
## struct RequirementsFileOptions ð¹
Name | Type | Description
-----|------|-------------
**packageProvider**?ð¹ | [python.IPackageProvider](#projen-python-ipackageprovider) | Provide a list of packages that can be dynamically updated.
__*Optional*__
## struct SetupPyOptions ð¹
Fields to pass in the setup() function of setup.py.
Name | Type | Description
-----|------|-------------
**additionalOptions**?ð¹ | Map | Escape hatch to allow any value.
__*Optional*__
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**classifiers**?ð¹ | Array | A list of PyPI trove classifiers that describe the project.
__*Optional*__
**description**?ð¹ | string | A short project description.
__*Optional*__
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**license**?ð¹ | string | The project license.
__*Optional*__
**name**?ð¹ | string | Name of the package.
__*Optional*__
**packages**?ð¹ | Array | List of submodules to be packaged.
__*Optional*__
**version**?ð¹ | string | Manually specify package version.
__*Optional*__
## struct VenvOptions ð¹
Options for venv.
Name | Type | Description
-----|------|-------------
**envdir**?ð¹ | string | Name of directory to store the environment in.
__*Default*__: ".env"
**pythonExec**?ð¹ | string | Path to the python executable to use.
__*Default*__: "python"
## struct BranchOptions ð¹
Options for a release branch.
Name | Type | Description
-----|------|-------------
**majorVersion**ð¹ | number | The major versions released from this branch.
**minMajorVersion**?ð¹ | number | The minimum major version to release.
__*Optional*__
**npmDistTag**?ð¹ | string | The npm distribution tag to use for this branch.
__*Default*__: "latest"
**prerelease**?ð¹ | string | Bump the version as a pre-release tag.
__*Default*__: normal releases
**tagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: no prefix
**workflowName**?ð¹ | string | The name of the release workflow.
__*Default*__: "release-BRANCH"
## struct CodeArtifactOptions ð¹
Options for publishing packages to AWS CodeArtifact.
Name | Type | Description
-----|------|-------------
**accessKeyIdSecret**?ð¹ | string | GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.
__*Default*__: When the `authProvider` value is set to `CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR`, the default is "AWS_ACCESS_KEY_ID". For `CodeArtifactAuthProvider.GITHUB_OIDC`, this value must be left undefined.
**authProvider**?ð¹ | [release.CodeArtifactAuthProvider](#projen-release-codeartifactauthprovider) | Provider to use for authorizing requests to AWS CodeArtifact.
__*Default*__: CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR
**roleToAssume**?ð¹ | string | ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (`registry` contains AWS CodeArtifact URL).
__*Default*__: undefined
**secretAccessKeySecret**?ð¹ | string | GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.
__*Default*__: When the `authProvider` value is set to `CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR`, the default is "AWS_SECRET_ACCESS_KEY". For `CodeArtifactAuthProvider.GITHUB_OIDC`, this value must be left undefined.
## struct CommonPublishOptions ð¹
Common publishing options.
Name | Type | Description
-----|------|-------------
**prePublishSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
## struct GitHubReleasesPublishOptions ð¹
Publishing options for GitHub releases.
Name | Type | Description
-----|------|-------------
**changelogFile**ð¹ | string | The location of an .md file (relative to `dist/`) that includes the changelog for the release.
**releaseTagFile**ð¹ | string | The location of a text file (relative to `dist/`) that contains the release tag.
**versionFile**ð¹ | string | The location of a text file (relative to `dist/`) that contains the version number.
**prePublishSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
## struct GitPublishOptions ð¹
Publishing options for Git releases.
Name | Type | Description
-----|------|-------------
**changelogFile**ð¹ | string | The location of an .md file (relative to `dist/`) that includes the changelog for the release.
**releaseTagFile**ð¹ | string | The location of a text file (relative to `dist/`) that contains the release tag.
**versionFile**ð¹ | string | The location of a text file (relative to `dist/`) that contains the version number.
**gitBranch**?ð¹ | string | Branch to push to.
__*Default*__: "main"
**gitPushCommand**?ð¹ | string | Override git-push command.
__*Optional*__
**projectChangelogFile**?ð¹ | string | The location of an .md file that includes the project-level changelog.
__*Optional*__
## struct GoPublishOptions ð¹
Options for Go releases.
Name | Type | Description
-----|------|-------------
**gitBranch**?ð¹ | string | Branch to push to.
__*Default*__: "main"
**gitCommitMessage**?ð¹ | string | The commit message.
__*Default*__: "chore(release): $VERSION"
**gitUserEmail**?ð¹ | string | The email to use in the release git commit.
__*Default*__: "github-actions@github.com"
**gitUserName**?ð¹ | string | The user name to use for the release git commit.
__*Default*__: "github-actions"
**githubDeployKeySecret**?ð¹ | string | The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.
__*Default*__: "GO_GITHUB_DEPLOY_KEY"
**githubRepo**?ð¹ | string | GitHub repository to push to.
__*Default*__: derived from `moduleName`
**githubTokenSecret**?ð¹ | string | The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.
__*Default*__: "GO_GITHUB_TOKEN"
**githubUseSsh**?ð¹ | boolean | Use SSH to push to GitHub instead of a personal accses token.
__*Default*__: false
**prePublishSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
## struct JsiiReleaseGo â ïž
Name | Type | Description
-----|------|-------------
**gitBranch**?â ïž | string | Branch to push to.
__*Default*__: "main"
**gitCommitMessage**?â ïž | string | The commit message.
__*Default*__: "chore(release): $VERSION"
**gitUserEmail**?â ïž | string | The email to use in the release git commit.
__*Default*__: "github-actions@github.com"
**gitUserName**?â ïž | string | The user name to use for the release git commit.
__*Default*__: "github-actions"
**githubDeployKeySecret**?â ïž | string | The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.
__*Default*__: "GO_GITHUB_DEPLOY_KEY"
**githubRepo**?â ïž | string | GitHub repository to push to.
__*Default*__: derived from `moduleName`
**githubTokenSecret**?â ïž | string | The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.
__*Default*__: "GO_GITHUB_TOKEN"
**githubUseSsh**?â ïž | boolean | Use SSH to push to GitHub instead of a personal accses token.
__*Default*__: false
**prePublishSteps**?â ïž | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?â ïž | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
## struct JsiiReleaseMaven â ïž
Name | Type | Description
-----|------|-------------
**mavenEndpoint**?â ïž | string | URL of Nexus repository.
__*Default*__: "https://oss.sonatype.org"
**mavenGpgPrivateKeyPassphrase**?â ïž | string | GitHub secret name which contains the GPG private key or file that includes it.
__*Default*__: "MAVEN_GPG_PRIVATE_KEY_PASSPHRASE" or not set when using GitHub Packages
**mavenGpgPrivateKeySecret**?â ïž | string | GitHub secret name which contains the GPG private key or file that includes it.
__*Default*__: "MAVEN_GPG_PRIVATE_KEY" or not set when using GitHub Packages
**mavenPassword**?â ïž | string | GitHub secret name which contains the Password for maven repository.
__*Default*__: "MAVEN_PASSWORD" or "GITHUB_TOKEN" when using GitHub Packages
**mavenRepositoryUrl**?â ïž | string | Deployment repository when not deploying to Maven Central.
__*Default*__: not set
**mavenServerId**?â ïž | string | Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).
__*Default*__: "ossrh" (Maven Central) or "github" when using GitHub Packages
**mavenStagingProfileId**?â ïž | string | GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org (e.g. https://oss.sonatype.org/#stagingProfiles;11a33451234521).
__*Default*__: "MAVEN_STAGING_PROFILE_ID" or not set when using GitHub Packages
**mavenUsername**?â ïž | string | GitHub secret name which contains the Username for maven repository.
__*Default*__: "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages
**prePublishSteps**?â ïž | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?â ïž | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
## struct JsiiReleaseNpm â ïž
Name | Type | Description
-----|------|-------------
**codeArtifactOptions**?â ïž | [release.CodeArtifactOptions](#projen-release-codeartifactoptions) | Options for publishing npm package to AWS CodeArtifact.
__*Default*__: undefined
**distTag**?â ïž | string | Tags can be used to provide an alias instead of version numbers.
__*Default*__: "latest"
**npmTokenSecret**?â ïž | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN" or "GITHUB_TOKEN" if `registry` is set to `npm.pkg.github.com`.
**prePublishSteps**?â ïž | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?â ïž | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
**registry**?â ïž | string | The domain name of the npm package registry.
__*Default*__: "registry.npmjs.org"
## struct JsiiReleaseNuget â ïž
Name | Type | Description
-----|------|-------------
**nugetApiKeySecret**?â ïž | string | GitHub secret which contains the API key for NuGet.
__*Default*__: "NUGET_API_KEY"
**nugetServer**?â ïž | string | NuGet Server URL (defaults to nuget.org).
__*Optional*__
**prePublishSteps**?â ïž | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?â ïž | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
## struct JsiiReleasePyPi â ïž
Name | Type | Description
-----|------|-------------
**prePublishSteps**?â ïž | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?â ïž | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
**twinePasswordSecret**?â ïž | string | The GitHub secret which contains PyPI password.
__*Default*__: "TWINE_PASSWORD"
**twineRegistryUrl**?â ïž | string | The registry url to use when releasing packages.
__*Default*__: twine default
**twineUsernameSecret**?â ïž | string | The GitHub secret which contains PyPI user name.
__*Default*__: "TWINE_USERNAME"
## struct ManualReleaseOptions ð¹
Name | Type | Description
-----|------|-------------
**changelog**?ð¹ | boolean | Maintain a project-level changelog.
__*Default*__: true
**changelogPath**?ð¹ | string | Project-level changelog file path.
__*Default*__: 'CHANGELOG.md'
**gitPushCommand**?ð¹ | string | Override git-push command.
__*Optional*__
## struct MavenPublishOptions ð¹
Options for Maven releases.
Name | Type | Description
-----|------|-------------
**mavenEndpoint**?ð¹ | string | URL of Nexus repository.
__*Default*__: "https://oss.sonatype.org"
**mavenGpgPrivateKeyPassphrase**?ð¹ | string | GitHub secret name which contains the GPG private key or file that includes it.
__*Default*__: "MAVEN_GPG_PRIVATE_KEY_PASSPHRASE" or not set when using GitHub Packages
**mavenGpgPrivateKeySecret**?ð¹ | string | GitHub secret name which contains the GPG private key or file that includes it.
__*Default*__: "MAVEN_GPG_PRIVATE_KEY" or not set when using GitHub Packages
**mavenPassword**?ð¹ | string | GitHub secret name which contains the Password for maven repository.
__*Default*__: "MAVEN_PASSWORD" or "GITHUB_TOKEN" when using GitHub Packages
**mavenRepositoryUrl**?ð¹ | string | Deployment repository when not deploying to Maven Central.
__*Default*__: not set
**mavenServerId**?ð¹ | string | Used in maven settings for credential lookup (e.g. use github when publishing to GitHub).
__*Default*__: "ossrh" (Maven Central) or "github" when using GitHub Packages
**mavenStagingProfileId**?ð¹ | string | GitHub secret name which contains the Maven Central (sonatype) staging profile ID (e.g. 68a05363083174). Staging profile ID can be found in the URL of the "Releases" staging profile under "Staging Profiles" in https://oss.sonatype.org (e.g. https://oss.sonatype.org/#stagingProfiles;11a33451234521).
__*Default*__: "MAVEN_STAGING_PROFILE_ID" or not set when using GitHub Packages
**mavenUsername**?ð¹ | string | GitHub secret name which contains the Username for maven repository.
__*Default*__: "MAVEN_USERNAME" or the GitHub Actor when using GitHub Packages
**prePublishSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
## struct NpmPublishOptions ð¹
Options for npm release.
Name | Type | Description
-----|------|-------------
**codeArtifactOptions**?ð¹ | [release.CodeArtifactOptions](#projen-release-codeartifactoptions) | Options for publishing npm package to AWS CodeArtifact.
__*Default*__: undefined
**distTag**?â ïž | string | Tags can be used to provide an alias instead of version numbers.
__*Default*__: "latest"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN" or "GITHUB_TOKEN" if `registry` is set to `npm.pkg.github.com`.
**prePublishSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
**registry**?ð¹ | string | The domain name of the npm package registry.
__*Default*__: "registry.npmjs.org"
## struct NugetPublishOptions ð¹
Options for NuGet releases.
Name | Type | Description
-----|------|-------------
**nugetApiKeySecret**?ð¹ | string | GitHub secret which contains the API key for NuGet.
__*Default*__: "NUGET_API_KEY"
**nugetServer**?ð¹ | string | NuGet Server URL (defaults to nuget.org).
__*Optional*__
**prePublishSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
## struct PublisherOptions ð¹
Options for `Publisher`.
Name | Type | Description
-----|------|-------------
**artifactName**ð¹ | string | The name of the artifact to download (e.g. `dist`).
**buildJobId**ð¹ | string | The job ID that produces the build artifacts.
**condition**?ð¹ | string | A GitHub workflow expression used as a condition for publishers.
__*Default*__: no condition
**dryRun**?ð¹ | boolean | Do not actually publish, only print the commands that would be executed instead.
__*Optional*__
**failureIssue**?ð¹ | boolean | Create an issue when a publish task fails.
__*Default*__: false
**failureIssueLabel**?ð¹ | string | The label to apply to the issue marking failed publish tasks.
__*Default*__: "failed-release"
**jsiiReleaseVersion**?â ïž | string | __*Optional*__
**publibVersion**?ð¹ | string | Version requirement for `publib`.
__*Default*__: "latest"
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowNodeVersion**?ð¹ | string | Node version to setup in GitHub workflows if any node-based CLI utilities are needed.
__*Default*__: 16.x
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct PyPiPublishOptions ð¹
Options for PyPI release.
Name | Type | Description
-----|------|-------------
**prePublishSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.
__*Optional*__
**publishTools**?ð¹ | [github.workflows.Tools](#projen-github-workflows-tools) | Additional tools to install in the publishing job.
__*Default*__: no additional tools are installed
**twinePasswordSecret**?ð¹ | string | The GitHub secret which contains PyPI password.
__*Default*__: "TWINE_PASSWORD"
**twineRegistryUrl**?ð¹ | string | The registry url to use when releasing packages.
__*Default*__: twine default
**twineUsernameSecret**?ð¹ | string | The GitHub secret which contains PyPI user name.
__*Default*__: "TWINE_USERNAME"
## struct ReleaseOptions ð¹
Options for `Release`.
Name | Type | Description
-----|------|-------------
**artifactsDirectory**ð¹ | string | A directory which will contain build artifacts.
**branch**ð¹ | string | The default branch name to release from.
**task**ð¹ | [Task](#projen-task) | The task to execute in order to create the release artifacts.
**versionFile**ð¹ | string | A name of a .json file to set the `version` field in after a bump.
**githubRelease**?ð¹ | boolean | Create a GitHub release for each release.
__*Default*__: true
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowNodeVersion**?ð¹ | string | Node version to setup in GitHub workflows if any node-based CLI utilities are needed.
__*Default*__: 16.x
**workflowPermissions**?ð¹ | [github.workflows.JobPermissions](#projen-github-workflows-jobpermissions) | Permissions granted to the release workflow job.
__*Default*__: `{ contents: JobPermission.WRITE }`
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct ReleaseProjectOptions ð¹
Project options for release.
Name | Type | Description
-----|------|-------------
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct ScheduledReleaseOptions ð¹
Name | Type | Description
-----|------|-------------
**schedule**ð¹ | string | Cron schedule for releases.
## struct ProjenrcOptions ð¹
Name | Type | Description
-----|------|-------------
**filename**?ð¹ | string | The name of the projenrc file.
__*Default*__: ".projenrc.ts"
**projenCodeDir**?ð¹ | string | A directory tree that may contain *.ts files that can be referenced from your projenrc typescript file.
__*Default*__: "projenrc"
**swc**?ð¹ | boolean | Whether to use `SWC` for ts-node.
__*Default*__: false
## struct ProjenrcTsOptions ð¹
Name | Type | Description
-----|------|-------------
**filename**?ð¹ | string | The name of the projenrc file.
__*Default*__: ".projenrc.ts"
**projenCodeDir**?ð¹ | string | A directory tree that may contain *.ts files that can be referenced from your projenrc typescript file.
__*Default*__: "projenrc"
**tsconfigFileName**?ð¹ | string | The name of the tsconfig file that will be used by ts-node when compiling projen source files.
__*Default*__: "tsconfig.projen.json"
## struct TypeScriptLibraryProjectOptions â ïž
Name | Type | Description
-----|------|-------------
**defaultReleaseBranch**â ïž | string | The name of the main release branch.
**name**â ïž | string | This is the name of your project.
**allowLibraryDependencies**?â ïž | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?â ïž | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?â ïž | string | Author's e-mail.
__*Optional*__
**authorName**?â ïž | string | Author's name.
__*Optional*__
**authorOrganization**?â ïž | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?â ïž | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?â ïž | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?â ïž | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?â ïž | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?â ïž | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?â ïž | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?â ïž | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?â ïž | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?â ïž | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?â ïž | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?â ïž | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?â ïž | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?â ïž | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**clobber**?â ïž | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?â ïž | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?â ïž | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?â ïž | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?â ïž | boolean | Whether to commit the managed files by default.
__*Default*__: true
**copyrightOwner**?â ïž | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?â ïž | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?â ïž | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?â ïž | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?â ïž | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?â ïž | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?â ïž | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?â ïž | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?â ïž | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?â ïž | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?â ïž | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?â ïž | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?â ïž | boolean | Docgen by Typedoc.
__*Default*__: false
**docsDirectory**?â ïž | string | Docs directory.
__*Default*__: "docs"
**entrypoint**?â ïž | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?â ïž | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?â ïž | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?â ïž | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**gitIgnoreOptions**?â ïž | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?â ïž | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?â ïž | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?â ïž | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?â ïž | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?â ïž | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?â ïž | string | Package's Homepage / Website.
__*Optional*__
**jest**?â ïž | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?â ïž | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?â ïž | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**keywords**?â ïž | Array | Keywords to include in `package.json`.
__*Optional*__
**libdir**?â ïž | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?â ïž | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?â ïž | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?â ïž | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?â ïž | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?â ïž | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?â ïž | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?â ïž | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?â ïž | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?â ïž | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?â ïž | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?â ïž | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?â ïž | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?â ïž | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?â ïž | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?â ïž | string | The root directory of the project.
__*Default*__: "."
**package**?â ïž | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?â ïž | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?â ïž | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?â ïž | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?â ïž | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?â ïž | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?â ïž | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?â ïž | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?â ïž | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?â ïž | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?â ïž | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?â ïž | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?â ïž | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?â ïž | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?â ïž | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?â ïž | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?â ïž | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?â ïž | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?â ïž | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?â ïž | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?â ïž | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?â ïž | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?â ïž | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**pullRequestTemplate**?â ïž | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?â ïž | Array | The contents of the pull request template.
__*Default*__: default content
**readme**?â ïž | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?â ïž | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?â ïž | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?â ïž | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?â ïž | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?â ïž | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?â ïž | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?â ïž | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?â ïž | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?â ïž | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?â ïž | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?â ïž | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?â ïž | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**sampleCode**?â ïž | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?â ïž | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?â ïž | string | Typescript sources directory.
__*Default*__: "src"
**stability**?â ïž | string | Package's Stability.
__*Optional*__
**stale**?â ïž | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?â ïž | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?â ïž | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?â ïž | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?â ïž | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?â ïž | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?â ïž | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?â ïž | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?â ïž | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?â ïž | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?â ïž | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?â ïž | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?â ïž | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?â ïž | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?â ïž | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct TypeScriptProjectOptions ð¹
Name | Type | Description
-----|------|-------------
**defaultReleaseBranch**ð¹ | string | The name of the main release branch.
**name**ð¹ | string | This is the name of your project.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?ð¹ | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?ð¹ | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?ð¹ | boolean | Docgen by Typedoc.
__*Default*__: false
**docsDirectory**?ð¹ | string | Docs directory.
__*Default*__: "docs"
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?ð¹ | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?ð¹ | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?ð¹ | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**libdir**?ð¹ | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**sampleCode**?ð¹ | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Typescript sources directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?ð¹ | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?ð¹ | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?ð¹ | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct DevContainerFeature ð¹
devcontainer features options.
Name | Type | Description
-----|------|-------------
**name**ð¹ | string | feature name.
**version**?ð¹ | string | feature version.
__*Default*__: latest
## struct DevContainerOptions ð¹
Constructor options for the DevContainer component.
The default docker image used for GitHub Codespaces is defined here:
Name | Type | Description
-----|------|-------------
**dockerImage**?ð¹ | [DevEnvironmentDockerImage](#projen-devenvironmentdockerimage) | A Docker image or Dockerfile for the container.
__*Optional*__
**features**?ð¹ | Array<[vscode.DevContainerFeature](#projen-vscode-devcontainerfeature)> | An array of VSCode features that specify the features that should be installed inside the container when it is created.
__*Optional*__
**ports**?ð¹ | Array | An array of ports that should be exposed from the container.
__*Optional*__
**tasks**?ð¹ | Array<[Task](#projen-task)> | An array of tasks that should be run when the container starts.
__*Optional*__
**vscodeExtensions**?ð¹ | Array | An array of extension IDs that specify the extensions that should be installed inside the container when it is created.
__*Optional*__
## interface IDevContainerEnvironment ð¹
__Implemented by__: [vscode.DevContainer](#projen-vscode-devcontainer)
### Methods
#### addDockerImage(image)ð¹
Add a custom Docker image or Dockerfile for the container.
```ts
addDockerImage(image: DevEnvironmentDockerImage): void
```
* **image** ([DevEnvironmentDockerImage](#projen-devenvironmentdockerimage)) The Docker image.
#### addFeatures(...features)ð¹
Adds a list of VSCode features that should be automatically installed in the container.
```ts
addFeatures(...features: DevContainerFeature[]): void
```
* **features** ([vscode.DevContainerFeature](#projen-vscode-devcontainerfeature)) featureName and version(optional default: latest).
* **name** (string) feature name.
* **version** (string) feature version. __*Default*__: latest
#### addPorts(...ports)ð¹
Adds ports that should be exposed (forwarded) from the container.
```ts
addPorts(...ports: string[]): void
```
* **ports** (string) The new ports.
#### addTasks(...tasks)ð¹
Adds tasks to run when the container starts.
```ts
addTasks(...tasks: Task[]): void
```
* **tasks** ([Task](#projen-task)) The new tasks.
#### addVscodeExtensions(...extensions)ð¹
Adds a list of VSCode extensions that should be automatically installed in the container.
```ts
addVscodeExtensions(...extensions: string[]): void
```
* **extensions** (string) The extension IDs.
## struct Presentation ð¹
VSCode launch configuration Presentation interface "using the order, group, and hidden attributes in the presentation object you can sort, group, and hide configurations and compounds in the Debug configuration dropdown and in the Debug quick pick." Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
Name | Type | Description
-----|------|-------------
**group**ð¹ | string |
**hidden**ð¹ | boolean |
**order**ð¹ | number |
## struct ServerReadyAction ð¹
VSCode launch configuration ServerReadyAction interface "if you want to open a URL in a web browser whenever the program under debugging outputs a specific message to the debug console or integrated terminal." Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
Name | Type | Description
-----|------|-------------
**action**ð¹ | string |
**pattern**?ð¹ | string | __*Optional*__
**uriFormat**?ð¹ | string | __*Optional*__
## struct VsCodeLaunchConfigurationEntry ð¹
Options for a 'VsCodeLaunchConfigurationEntry' Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
Name | Type | Description
-----|------|-------------
**name**ð¹ | string |
**request**ð¹ | string |
**type**ð¹ | string |
**args**?ð¹ | Array | __*Optional*__
**console**?ð¹ | [vscode.Console](#projen-vscode-console) | __*Optional*__
**cwd**?ð¹ | string | __*Optional*__
**debugServer**?ð¹ | number | __*Optional*__
**disableOptimisticBPs**?ð¹ | boolean | __*Optional*__
**env**?ð¹ | Map | Set value to `false` to unset an existing environment variable.
__*Optional*__
**envFile**?ð¹ | string | __*Optional*__
**internalConsoleOptions**?ð¹ | [vscode.InternalConsoleOptions](#projen-vscode-internalconsoleoptions) | __*Optional*__
**outFiles**?ð¹ | Array | __*Optional*__
**port**?ð¹ | number | __*Optional*__
**postDebugTask**?ð¹ | string | __*Optional*__
**preLaunchTask**?ð¹ | string | __*Optional*__
**presentation**?ð¹ | [vscode.Presentation](#projen-vscode-presentation) | __*Optional*__
**program**?ð¹ | string | __*Optional*__
**runtimeArgs**?ð¹ | Array | __*Optional*__
**serverReadyAction**?ð¹ | [vscode.ServerReadyAction](#projen-vscode-serverreadyaction) | __*Optional*__
**skipFiles**?ð¹ | Array | __*Optional*__
**stopOnEntry**?ð¹ | boolean | __*Optional*__
**url**?ð¹ | string | __*Optional*__
**webRoot**?ð¹ | string | __*Optional*__
## struct NextComponentOptions ð¹
Name | Type | Description
-----|------|-------------
**tailwind**?ð¹ | boolean | Setup Tailwind as a PostCSS plugin.
__*Default*__: true
**typescript**?ð¹ | boolean | Whether to apply options specific for TypeScript Next.js projects.
__*Default*__: false
## struct NextJsCommonProjectOptions ð¹
Name | Type | Description
-----|------|-------------
**assetsdir**?ð¹ | string | Assets directory.
__*Default*__: "public"
**tailwind**?ð¹ | boolean | Setup Tailwind CSS as a PostCSS plugin.
__*Default*__: true
## struct NextJsProjectOptions ð¹
Name | Type | Description
-----|------|-------------
**defaultReleaseBranch**ð¹ | string | The name of the main release branch.
**name**ð¹ | string | This is the name of your project.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**assetsdir**?ð¹ | string | Assets directory.
__*Default*__: "public"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**sampleCode**?ð¹ | boolean | Generate one-time sample in `pages/` and `public/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Typescript sources directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**tailwind**?ð¹ | boolean | Setup Tailwind CSS as a PostCSS plugin.
__*Default*__: true
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct NextJsTypeScriptProjectOptions ð¹
Name | Type | Description
-----|------|-------------
**defaultReleaseBranch**ð¹ | string | The name of the main release branch.
**name**ð¹ | string | This is the name of your project.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**assetsdir**?ð¹ | string | Assets directory.
__*Default*__: "public"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?ð¹ | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?ð¹ | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?ð¹ | boolean | Docgen by Typedoc.
__*Default*__: false
**docsDirectory**?ð¹ | string | Docs directory.
__*Default*__: "docs"
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?ð¹ | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?ð¹ | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?ð¹ | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**libdir**?ð¹ | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**sampleCode**?ð¹ | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Typescript sources directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**tailwind**?ð¹ | boolean | Setup Tailwind CSS as a PostCSS plugin.
__*Default*__: true
**testdir**?ð¹ | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?ð¹ | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?ð¹ | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct PostCssOptions ð¹
Name | Type | Description
-----|------|-------------
**fileName**?ð¹ | string | __*Default*__: "postcss.config.json"
**tailwind**?ð¹ | boolean | Install Tailwind CSS as a PostCSS plugin.
__*Default*__: true
**tailwindOptions**?ð¹ | [web.TailwindConfigOptions](#projen-web-tailwindconfigoptions) | Tailwind CSS options.
__*Optional*__
## struct ReactComponentOptions ð¹
Name | Type | Description
-----|------|-------------
**rewire**?ð¹ | Map | Rewire webpack configuration.
__*Default*__: No rewired config.
**typescript**?ð¹ | boolean | Whether to apply options specific for TypeScript React projects.
__*Default*__: false
## struct ReactProjectOptions ð¹
Name | Type | Description
-----|------|-------------
**defaultReleaseBranch**ð¹ | string | The name of the main release branch.
**name**ð¹ | string | This is the name of your project.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**rewire**?ð¹ | Map | Rewire webpack configuration.
__*Default*__: No rewired config.
**sampleCode**?ð¹ | boolean | Generate one-time sample in `src/` and `public/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Source directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct ReactRewireOptions ð¹
Name | Type | Description
-----|------|-------------
**rewire**?ð¹ | Map | Rewire webpack configuration.
__*Default*__: No rewired config.
## struct ReactTypeDefOptions â ïž
Name | Type | Description
-----|------|-------------
**committed**?â ïž | boolean | Indicates whether this file should be committed to git or ignored.
__*Default*__: true
**editGitignore**?â ïž | boolean | Update the project's .gitignore file.
__*Default*__: true
**executable**?â ïž | boolean | Whether the generated file should be marked as executable.
__*Default*__: false
**marker**?â ïž | boolean | Adds the projen marker to the file.
__*Default*__: marker will be included as long as the project is not ejected
**readonly**?â ïž | boolean | Whether the generated file should be readonly.
__*Default*__: true
## struct ReactTypeScriptProjectOptions ð¹
Name | Type | Description
-----|------|-------------
**defaultReleaseBranch**ð¹ | string | The name of the main release branch.
**name**ð¹ | string | This is the name of your project.
**allowLibraryDependencies**?ð¹ | boolean | Allow the project to include `peerDependencies` and `bundledDependencies`.
__*Default*__: true
**artifactsDirectory**?ð¹ | string | A directory which will contain build artifacts.
__*Default*__: "dist"
**authorEmail**?ð¹ | string | Author's e-mail.
__*Optional*__
**authorName**?ð¹ | string | Author's name.
__*Optional*__
**authorOrganization**?ð¹ | boolean | Is the author an organization.
__*Optional*__
**authorUrl**?ð¹ | string | Author's URL / Website.
__*Optional*__
**autoApproveOptions**?ð¹ | [github.AutoApproveOptions](#projen-github-autoapproveoptions) | Enable and configure the 'auto approve' workflow.
__*Default*__: auto approve is disabled
**autoApproveUpgrades**?ð¹ | boolean | Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
__*Default*__: true
**autoDetectBin**?ð¹ | boolean | Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
__*Default*__: true
**autoMerge**?ð¹ | boolean | Enable automatic merging on GitHub.
__*Default*__: true
**autoMergeOptions**?ð¹ | [github.AutoMergeOptions](#projen-github-automergeoptions) | Configure options for automatic merging on GitHub.
__*Default*__: see defaults in `AutoMergeOptions`
**bin**?ð¹ | Map | Binary programs vended with your module.
__*Optional*__
**bugsEmail**?ð¹ | string | The email address to which issues should be reported.
__*Optional*__
**bugsUrl**?ð¹ | string | The url to your project's issue tracker.
__*Optional*__
**buildWorkflow**?ð¹ | boolean | Define a GitHub workflow for building PRs.
__*Default*__: true if not a subproject
**buildWorkflowTriggers**?ð¹ | [github.workflows.Triggers](#projen-github-workflows-triggers) | Build workflow triggers.
__*Default*__: "{ pullRequest: {}, workflowDispatch: {} }"
**bundledDeps**?ð¹ | Array | List of dependencies to bundle into this module.
__*Optional*__
**bundlerOptions**?ð¹ | [javascript.BundlerOptions](#projen-javascript-bundleroptions) | Options for `Bundler`.
__*Optional*__
**clobber**?ð¹ | boolean | Add a `clobber` task which resets the repo to origin.
__*Default*__: true, but false for subprojects
**codeArtifactOptions**?ð¹ | [javascript.CodeArtifactOptions](#projen-javascript-codeartifactoptions) | Options for npm packages using AWS CodeArtifact.
__*Default*__: undefined
**codeCov**?ð¹ | boolean | Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos. Configured with `@codeCovTokenSecret`.
__*Default*__: false
**codeCovTokenSecret**?ð¹ | string | Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
__*Default*__: if this option is not specified, only public repositories are supported
**commitGenerated**?ð¹ | boolean | Whether to commit the managed files by default.
__*Default*__: true
**copyrightOwner**?ð¹ | string | License copyright owner.
__*Default*__: defaults to the value of authorName or "" if `authorName` is undefined.
**copyrightPeriod**?ð¹ | string | The copyright years to put in the LICENSE file.
__*Default*__: current year
**dependabot**?ð¹ | boolean | Use dependabot to handle dependency upgrades.
__*Default*__: false
**dependabotOptions**?ð¹ | [github.DependabotOptions](#projen-github-dependabotoptions) | Options for dependabot.
__*Default*__: default options
**deps**?ð¹ | Array | Runtime dependencies of this module.
__*Default*__: []
**depsUpgrade**?ð¹ | boolean | Use github workflows to handle dependency upgrades.
__*Default*__: true
**depsUpgradeOptions**?ð¹ | [javascript.UpgradeDependenciesOptions](#projen-javascript-upgradedependenciesoptions) | Options for `UpgradeDependencies`.
__*Default*__: default options
**description**?ð¹ | string | The description is just a string that helps people understand the purpose of the package.
__*Optional*__
**devContainer**?ð¹ | boolean | Add a VSCode development environment (used for GitHub Codespaces).
__*Default*__: false
**devDeps**?ð¹ | Array | Build dependencies for this module.
__*Default*__: []
**disableTsconfig**?ð¹ | boolean | Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
__*Default*__: false
**disableTsconfigDev**?ð¹ | boolean | Do not generate a `tsconfig.dev.json` file.
__*Default*__: false
**docgen**?ð¹ | boolean | Docgen by Typedoc.
__*Default*__: false
**docsDirectory**?ð¹ | string | Docs directory.
__*Default*__: "docs"
**entrypoint**?ð¹ | string | Module entrypoint (`main` in `package.json`).
__*Default*__: "lib/index.js"
**entrypointTypes**?ð¹ | string | The .d.ts file that includes the type declarations for this module.
__*Default*__: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
**eslint**?ð¹ | boolean | Setup eslint.
__*Default*__: true
**eslintOptions**?ð¹ | [javascript.EslintOptions](#projen-javascript-eslintoptions) | Eslint options.
__*Default*__: opinionated default options
**gitIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .gitignore file.
__*Optional*__
**gitOptions**?ð¹ | [GitOptions](#projen-gitoptions) | Configuration options for git.
__*Optional*__
**github**?ð¹ | boolean | Enable GitHub integration.
__*Default*__: true
**githubOptions**?ð¹ | [github.GitHubOptions](#projen-github-githuboptions) | Options for GitHub integration.
__*Default*__: see GitHubOptions
**gitignore**?ð¹ | Array | Additional entries to .gitignore.
__*Optional*__
**gitpod**?ð¹ | boolean | Add a Gitpod development environment.
__*Default*__: false
**homepage**?ð¹ | string | Package's Homepage / Website.
__*Optional*__
**jest**?ð¹ | boolean | Setup jest unit tests.
__*Default*__: true
**jestOptions**?ð¹ | [javascript.JestOptions](#projen-javascript-jestoptions) | Jest options.
__*Default*__: default options
**jsiiReleaseVersion**?ð¹ | string | Version requirement of `publib` which is used to publish modules to npm.
__*Default*__: "latest"
**keywords**?ð¹ | Array | Keywords to include in `package.json`.
__*Optional*__
**libdir**?ð¹ | string | Typescript artifacts output directory.
__*Default*__: "lib"
**license**?ð¹ | string | License's SPDX identifier.
__*Default*__: "Apache-2.0"
**licensed**?ð¹ | boolean | Indicates if a license should be added.
__*Default*__: true
**logging**?ð¹ | [LoggerOptions](#projen-loggeroptions) | Configure logging options such as verbosity.
__*Default*__: {}
**majorVersion**?ð¹ | number | Major version to release from the default branch.
__*Default*__: Major version is not enforced.
**maxNodeVersion**?ð¹ | string | Minimum node.js version to require via `engines` (inclusive).
__*Default*__: no max
**mergify**?â ïž | boolean | Whether mergify should be enabled on this repository or not.
__*Default*__: true
**mergifyOptions**?â ïž | [github.MergifyOptions](#projen-github-mergifyoptions) | Options for mergify.
__*Default*__: default options
**minMajorVersion**?ð¹ | number | Minimal Major version to release.
__*Default*__: No minimum version is being enforced
**minNodeVersion**?ð¹ | string | Minimum Node.js version to require via package.json `engines` (inclusive).
__*Default*__: no "engines" specified
**mutableBuild**?ð¹ | boolean | Automatically update files modified during builds to pull-request branches.
__*Default*__: true
**npmAccess**?ð¹ | [javascript.NpmAccess](#projen-javascript-npmaccess) | Access level of the npm package.
__*Default*__: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
**npmDistTag**?ð¹ | string | The npmDistTag to use when publishing from the default branch.
__*Default*__: "latest"
**npmIgnoreOptions**?ð¹ | [IgnoreFileOptions](#projen-ignorefileoptions) | Configuration options for .npmignore file.
__*Optional*__
**npmRegistry**?â ïž | string | The host name of the npm registry to publish to.
__*Optional*__
**npmRegistryUrl**?ð¹ | string | The base URL of the npm package registry.
__*Default*__: "https://registry.npmjs.org"
**npmTokenSecret**?ð¹ | string | GitHub secret which contains the NPM token to use when publishing packages.
__*Default*__: "NPM_TOKEN"
**npmignore**?â ïž | Array | Additional entries to .npmignore.
__*Optional*__
**npmignoreEnabled**?ð¹ | boolean | Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.
__*Default*__: true
**outdir**?ð¹ | string | The root directory of the project.
__*Default*__: "."
**package**?ð¹ | boolean | Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`).
__*Default*__: true
**packageManager**?ð¹ | [javascript.NodePackageManager](#projen-javascript-nodepackagemanager) | The Node Package Manager used to execute scripts.
__*Default*__: NodePackageManager.YARN
**packageName**?ð¹ | string | The "name" in package.json.
__*Default*__: defaults to project name
**parent**?ð¹ | [Project](#projen-project) | The parent project, if this project is part of a bigger project.
__*Optional*__
**peerDependencyOptions**?ð¹ | [javascript.PeerDependencyOptions](#projen-javascript-peerdependencyoptions) | Options for `peerDeps`.
__*Optional*__
**peerDeps**?ð¹ | Array | Peer dependencies for this module.
__*Default*__: []
**pnpmVersion**?ð¹ | string | The version of PNPM to use if using PNPM as a package manager.
__*Default*__: "7"
**postBuildSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Steps to execute after build as part of the release workflow.
__*Default*__: []
**prerelease**?ð¹ | string | Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").
__*Default*__: normal semantic versions
**prettier**?ð¹ | boolean | Setup prettier.
__*Default*__: false
**prettierOptions**?ð¹ | [javascript.PrettierOptions](#projen-javascript-prettieroptions) | Prettier options.
__*Default*__: default options
**projectType**?â ïž | [ProjectType](#projen-projecttype) | Which type of project this is (library/app).
__*Default*__: ProjectType.UNKNOWN
**projenCommand**?ð¹ | string | The shell command to use in order to run the projen CLI.
__*Default*__: "npx projen"
**projenCredentials**?ð¹ | [github.GithubCredentials](#projen-github-githubcredentials) | Choose a method of providing GitHub API access for projen workflows.
__*Default*__: use a personal access token named PROJEN_GITHUB_TOKEN
**projenDevDependency**?ð¹ | boolean | Indicates of "projen" should be installed as a devDependency.
__*Default*__: true
**projenTokenSecret**?â ïž | string | The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows.
__*Default*__: "PROJEN_GITHUB_TOKEN"
**projenVersion**?ð¹ | string | Version of projen to install.
__*Default*__: Defaults to the latest version.
**projenrcJs**?ð¹ | boolean | Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.
__*Default*__: true if projenrcJson is false
**projenrcJsOptions**?ð¹ | [javascript.ProjenrcOptions](#projen-javascript-projenrcoptions) | Options for .projenrc.js.
__*Default*__: default options
**projenrcJson**?ð¹ | boolean | Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
__*Default*__: false
**projenrcJsonOptions**?ð¹ | [ProjenrcJsonOptions](#projen-projenrcjsonoptions) | Options for .projenrc.json.
__*Default*__: default options
**projenrcTs**?ð¹ | boolean | Use TypeScript for your projenrc file (`.projenrc.ts`).
__*Default*__: false
**projenrcTsOptions**?ð¹ | [typescript.ProjenrcOptions](#projen-typescript-projenrcoptions) | Options for .projenrc.ts.
__*Optional*__
**publishDryRun**?ð¹ | boolean | Instead of actually publishing to package managers, just print the publishing command.
__*Default*__: false
**publishTasks**?ð¹ | boolean | Define publishing tasks that can be executed manually as well as workflows.
__*Default*__: false
**pullRequestTemplate**?ð¹ | boolean | Include a GitHub pull request template.
__*Default*__: true
**pullRequestTemplateContents**?ð¹ | Array | The contents of the pull request template.
__*Default*__: default content
**readme**?ð¹ | [SampleReadmeProps](#projen-samplereadmeprops) | The README setup.
__*Default*__: { filename: 'README.md', contents: '# replace this' }
**release**?ð¹ | boolean | Add release management to this project.
__*Default*__: true (false for subprojects)
**releaseBranches**?ð¹ | Map | Defines additional release branches.
__*Default*__: no additional branches are used for release. you can use `addBranch()` to add additional branches.
**releaseEveryCommit**?â ïž | boolean | Automatically release new versions every commit to one of branches in `releaseBranches`.
__*Default*__: true
**releaseFailureIssue**?ð¹ | boolean | Create a github issue on every failed publishing task.
__*Default*__: false
**releaseFailureIssueLabel**?ð¹ | string | The label to apply to issues indicating publish failures.
__*Default*__: "failed-release"
**releaseSchedule**?â ïž | string | CRON schedule to trigger new releases.
__*Default*__: no scheduled releases
**releaseTagPrefix**?ð¹ | string | Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
__*Default*__: "v"
**releaseToNpm**?ð¹ | boolean | Automatically release to npm when new versions are introduced.
__*Default*__: false
**releaseTrigger**?ð¹ | [release.ReleaseTrigger](#projen-release-releasetrigger) | The release trigger to use.
__*Default*__: Continuous releases (`ReleaseTrigger.continuous()`)
**releaseWorkflow**?â ïž | boolean | DEPRECATED: renamed to `release`.
__*Default*__: true if not a subproject
**releaseWorkflowName**?ð¹ | string | The name of the default release workflow.
__*Default*__: "Release"
**releaseWorkflowSetupSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | A set of workflow steps to execute in order to setup the workflow container.
__*Optional*__
**renovatebot**?ð¹ | boolean | Use renovatebot to handle dependency upgrades.
__*Default*__: false
**renovatebotOptions**?ð¹ | [RenovatebotOptions](#projen-renovatebotoptions) | Options for renovatebot.
__*Default*__: default options
**repository**?ð¹ | string | The repository is the location where the actual code for your package lives.
__*Optional*__
**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.
__*Optional*__
**rewire**?ð¹ | Map | Rewire webpack configuration.
__*Default*__: No rewired config.
**sampleCode**?ð¹ | boolean | Generate one-time sample in `src/` and `test/` if there are no files there.
__*Default*__: true
**scopedPackagesOptions**?ð¹ | Array<[javascript.ScopedPackagesOptions](#projen-javascript-scopedpackagesoptions)> | Options for privately hosted scoped packages.
__*Default*__: fetch all scoped packages from the public npm registry
**scripts**?â ïž | Map | npm scripts to include.
__*Default*__: {}
**srcdir**?ð¹ | string | Typescript sources directory.
__*Default*__: "src"
**stability**?ð¹ | string | Package's Stability.
__*Optional*__
**stale**?ð¹ | boolean | Auto-close of stale issues and pull request.
__*Default*__: false
**staleOptions**?ð¹ | [github.StaleOptions](#projen-github-staleoptions) | Auto-close stale issues and pull requests.
__*Default*__: see defaults in `StaleOptions`
**testdir**?ð¹ | string | Jest tests directory. Tests files should be named `xxx.test.ts`.
__*Default*__: "test"
**tsconfig**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom TSConfig.
__*Default*__: default options
**tsconfigDev**?ð¹ | [javascript.TypescriptConfigOptions](#projen-javascript-typescriptconfigoptions) | Custom tsconfig options for the development tsconfig.json file (used for testing).
__*Default*__: use the production tsconfig options
**tsconfigDevFile**?ð¹ | string | The name of the development tsconfig.json file.
__*Default*__: "tsconfig.dev.json"
**typescriptVersion**?ð¹ | string | TypeScript version to use.
__*Default*__: "latest"
**versionrcOptions**?ð¹ | Map | Custom configuration used when creating changelog with standard-version package.
__*Default*__: standard configuration applicable for GitHub repositories
**vscode**?ð¹ | boolean | Enable VSCode integration.
__*Default*__: true
**workflowBootstrapSteps**?ð¹ | Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)> | Workflow steps to use in order to bootstrap this repo.
__*Default*__: "yarn install --frozen-lockfile && yarn projen"
**workflowContainerImage**?ð¹ | string | Container image to use for GitHub workflows.
__*Default*__: default image
**workflowGitIdentity**?ð¹ | [github.GitIdentity](#projen-github-gitidentity) | The git identity to use in workflows.
__*Default*__: GitHub Actions
**workflowNodeVersion**?ð¹ | string | The node version to use in GitHub workflows.
__*Default*__: same as `minNodeVersion`
**workflowPackageCache**?ð¹ | boolean | Enable Node.js package cache in GitHub workflows.
__*Default*__: false
**workflowRunsOn**?ð¹ | Array | Github Runner selection labels.
__*Default*__: ["ubuntu-latest"]
## struct TailwindConfigOptions ð¹
Name | Type | Description
-----|------|-------------
**fileName**?ð¹ | string | __*Default*__: "tailwind.config.json"
## enum DependencyType ð¹
Type of dependency.
Name | Description
-----|-----
**RUNTIME** ð¹|The dependency is required for the program/library during runtime.
**PEER** ð¹|The dependency is required at runtime but expected to be installed by the consumer.
**BUNDLED** ð¹|The dependency is bundled and shipped with the module, so consumers are not required to install it.
**BUILD** ð¹|The dependency is required to run the `build` task.
**TEST** ð¹|The dependency is required to run the `test` task.
**DEVENV** ð¹|The dependency is required for development (e.g. IDE plugins).
**OVERRIDE** ð¹|Transient dependency that needs to be overwritten.
## enum DockerComposeProtocol ð¹
Network protocol for port mapping.
Name | Description
-----|-----
**TCP** ð¹|TCP protocol.
**UDP** ð¹|UDP protocol.
## enum GitpodOnOpen ð¹
What to do when a service on a port is detected.
Name | Description
-----|-----
**OPEN_BROWSER** ð¹|Open a new browser tab.
**OPEN_PREVIEW** ð¹|Open a preview on the right side of the IDE.
**NOTIFY** ð¹|Show a notification asking the user what to do (default).
**IGNORE** ð¹|Do nothing.
## enum GitpodOpenIn ð¹
Configure where in the IDE the terminal should be opened.
Name | Description
-----|-----
**BOTTOM** ð¹|the bottom panel (default).
**LEFT** ð¹|the left panel.
**RIGHT** ð¹|the right panel.
**MAIN** ð¹|the main editor area.
## enum GitpodOpenMode ð¹
Configure how the terminal should be opened relative to the previous task.
Name | Description
-----|-----
**TAB_AFTER** ð¹|Opens in the same tab group right after the previous tab.
**TAB_BEFORE** ð¹|Opens in the same tab group left before the previous tab.
**SPLIT_RIGHT** ð¹|Splits and adds the terminal to the right.
**SPLIT_LEFT** ð¹|Splits and adds the terminal to the left.
**SPLIT_TOP** ð¹|Splits and adds the terminal to the top.
**SPLIT_BOTTOM** ð¹|Splits and adds the terminal to the bottom.
## enum GitpodPortVisibility ð¹
Whether the port visibility should be private or public.
Name | Description
-----|-----
**PUBLIC** ð¹|Allows everyone with the port URL to access the port (default).
**PRIVATE** ð¹|Only allows users with workspace access to access the port.
## enum InitProjectOptionHints ð¹
Choices for how to display commented out options in projenrc files.
Does not apply to projenrc.json files.
Name | Description
-----|-----
**ALL** ð¹|Display all possible options (grouped by which interface they belong to).
**FEATURED** ð¹|Display only featured options, in alphabetical order.
**NONE** ð¹|Display no extra options.
## enum LogLevel ð¹
Logging verbosity.
Name | Description
-----|-----
**OFF** ð¹|
**ERROR** ð¹|
**WARN** ð¹|
**INFO** ð¹|
**DEBUG** ð¹|
**VERBOSE** ð¹|
## enum ProjectType â ïž
Which type of project this is.
Name | Description
-----|-----
**UNKNOWN** â ïž|This module may be a either a library or an app.
**LIB** â ïž|This is a library, intended to be published to a package manager and consumed by other projects.
**APP** â ïž|This is an app (service, tool, website, etc).
## enum RenovatebotScheduleInterval ð¹
How often to check for new versions and raise pull requests for version updates.
Name | Description
-----|-----
**ANY_TIME** ð¹|Run at any time.
**EARLY_MONDAYS** ð¹|Weekly schedule on early monday mornings.
**DAILY** ð¹|Schedule daily.
**MONTHLY** ð¹|Schedule monthly.
**QUARTERLY** ð¹|Schedule quarterly.
**WEEKENDS** ð¹|Schedule for weekends.
**WEEKDAYS** ð¹|Schedule for weekdays.
## enum ApprovalLevel ð¹
Which approval is required when deploying CDK apps.
Name | Description
-----|-----
**NEVER** ð¹|Approval is never required.
**ANY_CHANGE** ð¹|Requires approval on any IAM or security-group-related change.
**BROADENING** ð¹|Requires approval when IAM statements or traffic rules are added;
## enum Stability ð¹
Name | Description
-----|-----
**EXPERIMENTAL** ð¹|
**STABLE** ð¹|
**DEPRECATED** ð¹|
## enum JobType ð¹
A job may have a type of approval indicating it must be manually approved before downstream jobs may proceed.
Name | Description
-----|-----
**APPROVAL** ð¹|
## enum JobWhen ð¹
Specify when to enable or disable the step.
Name | Description
-----|-----
**ALWAYS** ð¹|
**ON_SUCCESS** ð¹|
**ON_FAIL** ð¹|
## enum PipelineParameterType ð¹
Pipeline parameter types.
Name | Description
-----|-----
**STRING** ð¹|
**BOOLEAN** ð¹|
**INTEGER** ð¹|
**ENUM** ð¹|
## enum ResourceClass ð¹
The resource_class feature allows configuring CPU and RAM resources for each job.
Different resource classes are available for different executors, as described in the tables below.
Name | Description
-----|-----
**SMALL** ð¹|
**MEDIUM** ð¹|
**MEDIUM_PLUS** ð¹|
**LARGE_X** ð¹|
**LARGE_2X** ð¹|
**LARGE_2X_PLUS** ð¹|
## enum DependabotRegistryType ð¹
Each configuration type requires you to provide particular settings.
Some types allow more than one way to connect
Name | Description
-----|-----
**COMPOSER_REGISTRY** ð¹|The composer-repository type supports username and password.
**DOCKER_REGISTRY** ð¹|The docker-registry type supports username and password.
**GIT** ð¹|The git type supports username and password.
**HEX_ORGANIZATION** ð¹|The hex-organization type supports organization and key.
**MAVEN_REPOSITORY** ð¹|The maven-repository type supports username and password, or token.
**NPM_REGISTRY** ð¹|The npm-registry type supports username and password, or token.
**NUGET_FEED** ð¹|The nuget-feed type supports username and password, or token.
**PYTHON_INDEX** ð¹|The python-index type supports username and password, or token.
**RUBYGEMS_SERVER** ð¹|The rubygems-server type supports username and password, or token.
**TERRAFORM_REGISTRY** ð¹|The terraform-registry type supports a token.
## enum DependabotScheduleInterval ð¹
How often to check for new versions and raise pull requests for version updates.
Name | Description
-----|-----
**DAILY** ð¹|Runs on every weekday, Monday to Friday.
**WEEKLY** ð¹|Runs once each week.
**MONTHLY** ð¹|Runs once each month.
## enum VersioningStrategy ð¹
The strategy to use when edits manifest and lock files.
Name | Description
-----|-----
**LOCKFILE_ONLY** ð¹|Only create pull requests to update lockfiles updates.
**AUTO** ð¹|- For apps, the version requirements are increased.
**WIDEN** ð¹|Relax the version requirement to include both the new and old version, when possible.
**INCREASE** ð¹|Always increase the version requirement to match the new version.
**INCREASE_IF_NECESSARY** ð¹|Increase the version requirement only when required by the new version.
## enum Action ð¹
Specifies what this job will do.
'start' (default) indicates the job will start the
deployment. 'prepare' indicates this will not affect the deployment. 'stop' indicates
this will stop the deployment.
Name | Description
-----|-----
**PREPARE** ð¹|
**START** ð¹|
**STOP** ð¹|
## enum CachePolicy ð¹
Configure the upload and download behaviour of a cache.
Name | Description
-----|-----
**PULL** ð¹|Only download the cache when the job starts, but never upload changes when the job finishes.
**PUSH** ð¹|Only upload a cache when the job finishes, but never download the cache when the job starts.
**PULL_PUSH** ð¹|The job downloads the cache when the job starts, and uploads changes to the cache when the job ends.
## enum CacheWhen ð¹
Configure when artifacts are uploaded depended on job status.
Name | Description
-----|-----
**ALWAYS** ð¹|Upload artifacts regardless of job status.
**ON_FAILURE** ð¹|Upload artifacts only when the job fails.
**ON_SUCCESS** ð¹|Upload artifacts only when the job succeeds (this is the default).
## enum DefaultElement ð¹
Name | Description
-----|-----
**AFTER_SCRIPT** ð¹|
**ARTIFACTS** ð¹|
**BEFORE_SCRIPT** ð¹|
**CACHE** ð¹|
**IMAGE** ð¹|
**INTERRUPTIBLE** ð¹|
**RETRY** ð¹|
**SERVICES** ð¹|
**TAGS** ð¹|
**TIMEOUT** ð¹|
## enum DeploymentTier ð¹
Explicitly specifies the tier of the deployment environment if non-standard environment name is used.
Name | Description
-----|-----
**DEVELOPMENT** ð¹|
**OTHER** ð¹|
**PRODUCTION** ð¹|
**STAGING** ð¹|
**TESTING** ð¹|
## enum JobWhen ð¹
Describes the conditions for when to run the job.
Defaults to 'on_success'.
Name | Description
-----|-----
**ALWAYS** ð¹|
**DELAYED** ð¹|
**MANUAL** ð¹|
**NEVER** ð¹|
**ON_FAILURE** ð¹|
**ON_SUCCESS** ð¹|
## enum KubernetesEnum ð¹
Filter job based on if Kubernetes integration is active.
Name | Description
-----|-----
**ACTIVE** ð¹|
## enum LinkType ð¹
The content kind of what users can download via url.
Name | Description
-----|-----
**IMAGE** ð¹|
**OTHER** ð¹|
**PACKAGE** ð¹|
**RUNBOOK** ð¹|
## enum Strategy ð¹
You can mirror the pipeline status from the triggered pipeline to the source bridge job by using strategy: depend.
Name | Description
-----|-----
**DEPEND** ð¹|
## enum WorkflowWhen ð¹
Describes the conditions for when to run the job.
Defaults to 'on_success'.
The value can only be 'always' or 'never' when used with workflow.
Name | Description
-----|-----
**ALWAYS** ð¹|
**NEVER** ð¹|
## enum ArrowParens ð¹
Name | Description
-----|-----
**ALWAYS** ð¹|Always include parens.
**AVOID** ð¹|Omit parens when possible.
## enum AutoRelease ð¹
Automatic bump modes.
Name | Description
-----|-----
**EVERY_COMMIT** ð¹|Automatically bump & release a new version for every commit to "main".
**DAILY** ð¹|Automatically bump & release a new version on a daily basis.
## enum CodeArtifactAuthProvider ð¹
Options for authorizing requests to a AWS CodeArtifact npm repository.
Name | Description
-----|-----
**ACCESS_AND_SECRET_KEY_PAIR** ð¹|Fixed credentials provided via Github secrets.
**GITHUB_OIDC** ð¹|Ephemeral credentials provided via Github's OIDC integration with an IAM role.
## enum EmbeddedLanguageFormatting ð¹
Name | Description
-----|-----
**AUTO** ð¹|Format embedded code if Prettier can automatically identify it.
**OFF** ð¹|Never automatically format embedded code.
## enum EndOfLine ð¹
Name | Description
-----|-----
**AUTO** ð¹|Maintain existing (mixed values within one file are normalised by looking at what's used after the first line).
**CR** ð¹|Carriage Return character only (\r), used very rarely.
**CRLF** ð¹|Carriage Return + Line Feed characters (\r\n), common on Windows.
**LF** ð¹|Line Feed only (\n), common on Linux and macOS as well as inside git repos.
## enum HTMLWhitespaceSensitivity ð¹
Name | Description
-----|-----
**CSS** ð¹|Respect the default value of CSS display property.
**IGNORE** ð¹|Whitespaces are considered insignificant.
**STRICT** ð¹|Whitespaces are considered significant.
## enum NodePackageManager ð¹
The node package manager to use.
Name | Description
-----|-----
**YARN** ð¹|Use `yarn` as the package manager.
**YARN2** ð¹|Use `yarn` versions >= 2 as the package manager.
**NPM** ð¹|Use `npm` as the package manager.
**PNPM** ð¹|Use `pnpm` as the package manager.
## enum NpmAccess ð¹
Npm package access level.
Name | Description
-----|-----
**PUBLIC** ð¹|Package is public.
**RESTRICTED** ð¹|Package can only be accessed with credentials.
## enum ProseWrap ð¹
Name | Description
-----|-----
**ALWAYS** ð¹|Wrap prose if it exceeds the print width.
**NEVER** ð¹|Do not wrap prose.
**PRESERVE** ð¹|Wrap prose as-is.
## enum QuoteProps ð¹
Name | Description
-----|-----
**ASNEEDED** ð¹|Only add quotes around object properties where required.
**CONSISTENT** ð¹|If at least one property in an object requires quotes, quote all properties.
**PRESERVE** ð¹|Respect the input use of quotes in object properties.
## enum TrailingComma ð¹
Name | Description
-----|-----
**ALL** ð¹|Trailing commas wherever possible (including function arguments).
**ES5** ð¹|Trailing commas where valid in ES5 (objects, arrays, etc.).
**NONE** ð¹|No trailing commas.
## enum TypeScriptImportsNotUsedAsValues ð¹
This flag controls how `import` works, there are 3 different options.
Name | Description
-----|-----
**REMOVE** ð¹|The default behavior of dropping `import` statements which only reference types.
**PRESERVE** ð¹|Preserves all `import` statements whose values or types are never used.
**ERROR** ð¹|This preserves all imports (the same as the preserve option), but will error when a value import is only used as a type.
## enum TypeScriptJsxMode ð¹
Determines how JSX should get transformed into valid JavaScript.
Name | Description
-----|-----
**PRESERVE** ð¹|Keeps the JSX as part of the output to be further consumed by another transform step (e.g. Babel).
**REACT** ð¹|Converts JSX syntax into React.createElement, does not need to go through a JSX transformation before use, and the output will have a .js file extension.
**REACT_NATIVE** ð¹|Keeps all JSX like 'preserve' mode, but output will have a .js extension.
**REACT_JSX** ð¹|Passes `key` separately from props and always passes `children` as props (since React 17).
**REACT_JSXDEV** ð¹|Same as `REACT_JSX` with additional debug data.
## enum TypeScriptModuleResolution ð¹
Determines how modules get resolved.
Name | Description
-----|-----
**CLASSIC** ð¹|TypeScript's former default resolution strategy.
**NODE** ð¹|Resolution strategy which attempts to mimic the Node.js module resolution strategy at runtime.
**NODE16** ð¹|Node.jsâ ECMAScript Module Support from TypeScript 4.7 onwards.
**NODE_NEXT** ð¹|Node.jsâ ECMAScript Module Support from TypeScript 4.7 onwards.
**BUNDLER** ð¹|Resolution strategy which attempts to mimic resolution patterns of modern bundlers;
## enum UpdateSnapshot ð¹
Name | Description
-----|-----
**ALWAYS** ð¹|Always update snapshots in "test" task.
**NEVER** ð¹|Never update snapshots in "test" task and create a separate "test:update" task.
## enum CodeArtifactAuthProvider ð¹
Options for authorizing requests to a AWS CodeArtifact npm repository.
Name | Description
-----|-----
**ACCESS_AND_SECRET_KEY_PAIR** ð¹|Fixed credentials provided via Github secrets.
**GITHUB_OIDC** ð¹|Ephemeral credentials provided via Github's OIDC integration with an IAM role.
## enum Console ð¹
Controls where to launch the debug target Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
Name | Description
-----|-----
**INTERNAL_CONSOLE** ð¹|
**INTEGRATED_TERMINAL** ð¹|
**EXTERNAL_TERMINAL** ð¹|
## enum InternalConsoleOptions ð¹
Controls the visibility of the VSCode Debug Console panel during a debugging session Source: https://code.visualstudio.com/docs/editor/debugging#_launchjson-attributes.
Name | Description
-----|-----
**NEVER_OPEN** ð¹|
**OPEN_ON_FIRST_SESSION_START** ð¹|
**OPEN_ON_SESSION_START** ð¹|