@nikovirtala/projen-constructs 0.2.31 → 0.2.32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +96 -24
- package/docs/api/assets/search.js +1 -1
- package/docs/api/interfaces/AwsCdkConstructLibraryProjectOptions.html +92 -87
- package/docs/api/interfaces/AwsCdkTypeScriptAppProjectOptions.html +88 -83
- package/docs/api/interfaces/JsiiProjectOptions.html +90 -85
- package/docs/api/interfaces/TypeScriptProjectOptions.html +81 -76
- package/lib/components/typedoc.js +1 -1
- package/lib/components/vitest.js +1 -1
- package/lib/project-generator.js +1 -1
- package/lib/projects/awscdk-construct-library-options.generated.d.ts +5 -0
- package/lib/projects/awscdk-construct-library-options.generated.js +1 -1
- package/lib/projects/awscdk-construct-library.generated.js +5 -4
- package/lib/projects/awscdk-typescript-app-options.generated.d.ts +5 -0
- package/lib/projects/awscdk-typescript-app-options.generated.js +1 -1
- package/lib/projects/awscdk-typescript-app.generated.js +5 -4
- package/lib/projects/jsii-options.generated.d.ts +5 -0
- package/lib/projects/jsii-options.generated.js +1 -1
- package/lib/projects/jsii.generated.js +5 -4
- package/lib/projects/typescript-options.generated.d.ts +5 -0
- package/lib/projects/typescript-options.generated.js +1 -1
- package/lib/projects/typescript.generated.js +5 -4
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>JsiiProjectOptions | @nikovirtala/projen-constructs</title><meta name="description" content="Documentation for @nikovirtala/projen-constructs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@nikovirtala/projen-constructs</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">JsiiProjectOptions</a></li></ul><h1>Interface JsiiProjectOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>JsiiProjectOptions</p>
|
|
2
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">JsiiProjectOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#allowlibrarydependencies">allowLibraryDependencies</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#artifactsdirectory">artifactsDirectory</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#auditdeps">auditDeps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#auditdepsoptions">auditDepsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AuditOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#author">author</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authoraddress">authorAddress</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authoremail">authorEmail</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authorname">authorName</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authororganization">authorOrganization</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authorurl">authorUrl</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#autoapproveoptions">autoApproveOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoApproveOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#autoapproveupgrades">autoApproveUpgrades</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#autodetectbin">autoDetectBin</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#automerge">autoMerge</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#automergeoptions">autoMergeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoMergeOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bin">bin</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#biome">biome</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#biomeoptions">biomeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BiomeOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bugsemail">bugsEmail</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bugsurl">bugsUrl</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#buildworkflow">buildWorkflow</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#buildworkflowoptions">buildWorkflowOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildWorkflowOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bumppackage">bumpPackage</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bundleddeps">bundledDeps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bundleroptions">bundlerOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BundlerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bunversion">bunVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#checklicenses">checkLicenses</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LicenseCheckerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#clobber">clobber</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#codeartifactoptions">codeArtifactOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CodeArtifactOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#codecov">codeCov</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#codecovtokensecret">codeCovTokenSecret</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#commitgenerated">commitGenerated</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#compat">compat</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#compatignore">compatIgnore</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#compressassembly">compressAssembly</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#copyrightowner">copyrightOwner</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#copyrightperiod">copyrightPeriod</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#defaultreleasebranch">defaultReleaseBranch</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#dependabot">dependabot</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#dependabotoptions">dependabotOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DependabotOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#deps">deps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#depsupgrade">depsUpgrade</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#depsupgradeoptions">depsUpgradeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">UpgradeDependenciesOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#devcontainer">devContainer</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#devdeps">devDeps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabletsconfig">disableTsconfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabletsconfigdev">disableTsconfigDev</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#docgen">docgen</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#docgenfilepath">docgenFilePath</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#docsdirectory">docsDirectory</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#entrypoint">entrypoint</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#entrypointtypes">entrypointTypes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#excludetypescript">excludeTypescript</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#github">github</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#githuboptions">githubOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitHubOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitignore">gitignore</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitignoreoptions">gitIgnoreOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitoptions">gitOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitpod">gitpod</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#homepage">homepage</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#jsiireleaseversion">jsiiReleaseVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#jsiiversion">jsiiVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#keywords">keywords</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#libdir">libdir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#license">license</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#licensed">licensed</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#logging">logging</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LoggerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#majorversion">majorVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxnodeversion">maxNodeVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minmajorversion">minMajorVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minnodeversion">minNodeVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#mise">mise</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nextversioncommand">nextVersionCommand</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmaccess">npmAccess</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NpmAccess</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmdisttag">npmDistTag</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmignoreenabled">npmignoreEnabled</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmignoreoptions">npmIgnoreOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmprovenance">npmProvenance</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmregistryurl">npmRegistryUrl</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmtokensecret">npmTokenSecret</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmtrustedpublishing">npmTrustedPublishing</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#outdir">outdir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#package">package</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#packagemanager">packageManager</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NodePackageManager</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#packagename">packageName</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#parent">parent</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#peerdependencyoptions">peerDependencyOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PeerDependencyOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#peerdeps">peerDeps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#pnpmversion">pnpmVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#postbuildsteps">postBuildSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prerelease">prerelease</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projencommand">projenCommand</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projencredentials">projenCredentials</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GithubCredentials</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projendevdependency">projenDevDependency</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcjs">projenrcJs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcjson">projenrcJson</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcjsonoptions">projenrcJsonOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcJsonOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcjsoptions">projenrcJsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcts">projenrcTs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrctsoptions">projenrcTsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenversion">projenVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishdryrun">publishDryRun</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishtasks">publishTasks</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishtogo">publishToGo</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiGoTarget</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishtomaven">publishToMaven</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiJavaTarget</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishtonuget">publishToNuget</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiDotNetTarget</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishtopypi">publishToPypi</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiPythonTarget</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#pullrequesttemplate">pullRequestTemplate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#pullrequesttemplatecontents">pullRequestTemplateContents</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#readme">readme</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SampleReadmeProps</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasablecommits">releasableCommits</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleasableCommits</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#release">release</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasebranches">releaseBranches</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">BranchOptions</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseenvironment">releaseEnvironment</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasefailureissue">releaseFailureIssue</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasefailureissuelabel">releaseFailureIssueLabel</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasetagprefix">releaseTagPrefix</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasetonpm">releaseToNpm</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasetrigger">releaseTrigger</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleaseTrigger</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseworkflowenv">releaseWorkflowEnv</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseworkflowname">releaseWorkflowName</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseworkflowsetupsteps">releaseWorkflowSetupSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#renovatebot">renovatebot</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#renovatebotoptions">renovatebotOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RenovatebotOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repository">repository</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repositorydirectory">repositoryDirectory</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repositoryurl">repositoryUrl</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#rootdir">rootdir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#scopedpackagesoptions">scopedPackagesOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ScopedPackagesOptions</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#srcdir">srcdir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stability">stability</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stale">stale</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#staleoptions">staleOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StaleOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#testdir">testdir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tsconfig">tsconfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tsconfigdev">tsconfigDev</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tsconfigdevfile">tsconfigDevFile</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typedoc">typeDoc</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typedocoptions">typeDocOptions</a><span class="tsd-signature-symbol">?:</span> <a href="TypeDocOptions.html" class="tsd-signature-type tsd-kind-interface">TypeDocOptions</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typescriptversion">typescriptVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#versionrcoptions">versionrcOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#vitest">vitest</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#vitestoptions">vitestOptions</a><span class="tsd-signature-symbol">?:</span> <a href="VitestOptions.html" class="tsd-signature-type tsd-kind-interface">VitestOptions</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#vscode">vscode</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowbootstrapsteps">workflowBootstrapSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowcontainerimage">workflowContainerImage</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowgitidentity">workflowGitIdentity</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitIdentity</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflownodeversion">workflowNodeVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowpackagecache">workflowPackageCache</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowrunson">workflowRunsOn</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowrunsongroup">workflowRunsOnGroup</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GroupRunnerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#yarnberryoptions">yarnBerryOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">YarnBerryOptions</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#allowlibrarydependencies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies?</span></a>
|
|
2
|
+
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">JsiiProjectOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#allowlibrarydependencies">allowLibraryDependencies</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#artifactsdirectory">artifactsDirectory</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#auditdeps">auditDeps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#auditdepsoptions">auditDepsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AuditOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#author">author</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authoraddress">authorAddress</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authoremail">authorEmail</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authorname">authorName</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authororganization">authorOrganization</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#authorurl">authorUrl</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#autoapproveoptions">autoApproveOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoApproveOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#autoapproveupgrades">autoApproveUpgrades</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#autodetectbin">autoDetectBin</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#automerge">autoMerge</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#automergeoptions">autoMergeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoMergeOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bin">bin</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#biome">biome</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#biomeoptions">biomeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BiomeOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bugsemail">bugsEmail</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bugsurl">bugsUrl</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#buildworkflow">buildWorkflow</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#buildworkflowoptions">buildWorkflowOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildWorkflowOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bumppackage">bumpPackage</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bundleddeps">bundledDeps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bundleroptions">bundlerOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BundlerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#bunversion">bunVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#checklicenses">checkLicenses</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LicenseCheckerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#clobber">clobber</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#codeartifactoptions">codeArtifactOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CodeArtifactOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#codecov">codeCov</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#codecovtokensecret">codeCovTokenSecret</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#commitgenerated">commitGenerated</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#compat">compat</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#compatignore">compatIgnore</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#compressassembly">compressAssembly</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#copyrightowner">copyrightOwner</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#copyrightperiod">copyrightPeriod</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#defaultreleasebranch">defaultReleaseBranch</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#dependabot">dependabot</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#dependabotoptions">dependabotOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DependabotOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#deps">deps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#depsupgrade">depsUpgrade</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#depsupgradeoptions">depsUpgradeOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">UpgradeDependenciesOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#description">description</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#devcontainer">devContainer</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#devdeps">devDeps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabletsconfig">disableTsconfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#disabletsconfigdev">disableTsconfigDev</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#docgen">docgen</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#docgenfilepath">docgenFilePath</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#docsdirectory">docsDirectory</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#entrypoint">entrypoint</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#entrypointtypes">entrypointTypes</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#excludetypescript">excludeTypescript</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#github">github</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#githuboptions">githubOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitHubOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitignore">gitignore</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitignoreoptions">gitIgnoreOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitoptions">gitOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#gitpod">gitpod</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#homebrew">homebrew</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#homepage">homepage</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#jsiireleaseversion">jsiiReleaseVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#jsiiversion">jsiiVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#keywords">keywords</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#libdir">libdir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#license">license</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#licensed">licensed</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#logging">logging</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LoggerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#majorversion">majorVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxnodeversion">maxNodeVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minmajorversion">minMajorVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minnodeversion">minNodeVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#mise">mise</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#nextversioncommand">nextVersionCommand</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmaccess">npmAccess</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NpmAccess</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmdisttag">npmDistTag</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmignoreenabled">npmignoreEnabled</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmignoreoptions">npmIgnoreOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmprovenance">npmProvenance</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmregistryurl">npmRegistryUrl</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmtokensecret">npmTokenSecret</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#npmtrustedpublishing">npmTrustedPublishing</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#outdir">outdir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#package">package</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#packagemanager">packageManager</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NodePackageManager</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#packagename">packageName</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#parent">parent</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#peerdependencyoptions">peerDependencyOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PeerDependencyOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#peerdeps">peerDeps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#pnpmversion">pnpmVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#postbuildsteps">postBuildSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#prerelease">prerelease</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projencommand">projenCommand</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projencredentials">projenCredentials</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GithubCredentials</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projendevdependency">projenDevDependency</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcjs">projenrcJs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcjson">projenrcJson</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcjsonoptions">projenrcJsonOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcJsonOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcjsoptions">projenrcJsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrcts">projenrcTs</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenrctsoptions">projenrcTsOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#projenversion">projenVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishdryrun">publishDryRun</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishtasks">publishTasks</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishtogo">publishToGo</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiGoTarget</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishtomaven">publishToMaven</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiJavaTarget</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishtonuget">publishToNuget</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiDotNetTarget</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#publishtopypi">publishToPypi</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiPythonTarget</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#pullrequesttemplate">pullRequestTemplate</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#pullrequesttemplatecontents">pullRequestTemplateContents</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#readme">readme</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SampleReadmeProps</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasablecommits">releasableCommits</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleasableCommits</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#release">release</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasebranches">releaseBranches</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">BranchOptions</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseenvironment">releaseEnvironment</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasefailureissue">releaseFailureIssue</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasefailureissuelabel">releaseFailureIssueLabel</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasetagprefix">releaseTagPrefix</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasetonpm">releaseToNpm</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releasetrigger">releaseTrigger</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleaseTrigger</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseworkflowenv">releaseWorkflowEnv</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseworkflowname">releaseWorkflowName</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#releaseworkflowsetupsteps">releaseWorkflowSetupSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#renovatebot">renovatebot</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#renovatebotoptions">renovatebotOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RenovatebotOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repository">repository</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repositorydirectory">repositoryDirectory</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#repositoryurl">repositoryUrl</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#rootdir">rootdir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#scopedpackagesoptions">scopedPackagesOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ScopedPackagesOptions</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#srcdir">srcdir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stability">stability</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#stale">stale</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#staleoptions">staleOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StaleOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#testdir">testdir</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tsconfig">tsconfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tsconfigdev">tsconfigDev</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tsconfigdevfile">tsconfigDevFile</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typedoc">typeDoc</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typedocoptions">typeDocOptions</a><span class="tsd-signature-symbol">?:</span> <a href="TypeDocOptions.html" class="tsd-signature-type tsd-kind-interface">TypeDocOptions</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#typescriptversion">typescriptVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#versionrcoptions">versionrcOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#vitest">vitest</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#vitestoptions">vitestOptions</a><span class="tsd-signature-symbol">?:</span> <a href="VitestOptions.html" class="tsd-signature-type tsd-kind-interface">VitestOptions</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#vscode">vscode</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowbootstrapsteps">workflowBootstrapSteps</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowcontainerimage">workflowContainerImage</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowgitidentity">workflowGitIdentity</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitIdentity</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflownodeversion">workflowNodeVersion</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowpackagecache">workflowPackageCache</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowrunson">workflowRunsOn</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#workflowrunsongroup">workflowRunsOnGroup</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GroupRunnerOptions</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#yarnberryoptions">yarnBerryOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">YarnBerryOptions</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#allowlibrarydependencies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies?</span></a>
|
|
3
3
|
<a href="#artifactsdirectory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Directory?</span></a>
|
|
4
4
|
<a href="#auditdeps" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>audit<wbr/>Deps?</span></a>
|
|
5
5
|
<a href="#auditdepsoptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>audit<wbr/>Deps<wbr/>Options?</span></a>
|
|
@@ -59,6 +59,7 @@
|
|
|
59
59
|
<a href="#gitignoreoptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git<wbr/>Ignore<wbr/>Options?</span></a>
|
|
60
60
|
<a href="#gitoptions" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git<wbr/>Options?</span></a>
|
|
61
61
|
<a href="#gitpod" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitpod?</span></a>
|
|
62
|
+
<a href="#homebrew" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>homebrew?</span></a>
|
|
62
63
|
<a href="#homepage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>homepage?</span></a>
|
|
63
64
|
<a href="#jsiireleaseversion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jsii<wbr/>Release<wbr/>Version?</span></a>
|
|
64
65
|
<a href="#jsiiversion" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jsii<wbr/>Version?</span></a>
|
|
@@ -465,10 +466,14 @@ Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
|
465
466
|
</code><button type="button">Copy</button></pre>
|
|
466
467
|
|
|
467
468
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-60">Stability<a href="#stability-60" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
469
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="homebrew"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>homebrew</span><a href="#homebrew" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">homebrew</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable Homebrew component</p>
|
|
470
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-45">Default<a href="#default-45" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
471
|
+
</code><button type="button">Copy</button></pre>
|
|
472
|
+
|
|
468
473
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="homepage"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>homepage</span><a href="#homepage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">homepage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Package's Homepage / Website.</p>
|
|
469
474
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-61">Stability<a href="#stability-61" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
470
475
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="jsiireleaseversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>jsii<wbr/>Release<wbr/>Version</span><a href="#jsiireleaseversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">jsiiReleaseVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Version requirement of <code>publib</code> which is used to publish modules to npm.</p>
|
|
471
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
476
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-46">Default<a href="#default-46" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"latest"</span>
|
|
472
477
|
</code><button type="button">Copy</button></pre>
|
|
473
478
|
|
|
474
479
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-62">Stability<a href="#stability-62" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -478,7 +483,7 @@ project by managing updates to <code>package.json</code> on your own.</p>
|
|
|
478
483
|
<p>NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned
|
|
479
484
|
and should remain on the same minor, so we recommend using a <code>~</code> dependency
|
|
480
485
|
(e.g. <code>~5.0.0</code>).</p>
|
|
481
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
486
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-47">Default<a href="#default-47" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"~5.8.0"</span>
|
|
482
487
|
</code><button type="button">Copy</button></pre>
|
|
483
488
|
|
|
484
489
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-63">Stability<a href="#stability-63" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -486,31 +491,31 @@ and should remain on the same minor, so we recommend using a <code>~</code> depe
|
|
|
486
491
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="keywords"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>keywords</span><a href="#keywords" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">keywords</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Keywords to include in <code>package.json</code>.</p>
|
|
487
492
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-64">Stability<a href="#stability-64" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
488
493
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="libdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>libdir</span><a href="#libdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">libdir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Typescript artifacts output directory.</p>
|
|
489
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
494
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-48">Default<a href="#default-48" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"lib"</span>
|
|
490
495
|
</code><button type="button">Copy</button></pre>
|
|
491
496
|
|
|
492
497
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-65">Stability<a href="#stability-65" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
493
498
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="license"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>license</span><a href="#license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">license</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>License's SPDX identifier.
|
|
494
499
|
See <a href="https://github.com/projen/projen/tree/main/license-text">https://github.com/projen/projen/tree/main/license-text</a> for a list of supported licenses.
|
|
495
500
|
Use the <code>licensed</code> option if you want to no license to be specified.</p>
|
|
496
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
501
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-49">Default<a href="#default-49" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"Apache-2.0"</span>
|
|
497
502
|
</code><button type="button">Copy</button></pre>
|
|
498
503
|
|
|
499
504
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-66">Stability<a href="#stability-66" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
500
505
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="licensed"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>licensed</span><a href="#licensed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">licensed</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if a license should be added.</p>
|
|
501
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
506
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-50">Default<a href="#default-50" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
502
507
|
</code><button type="button">Copy</button></pre>
|
|
503
508
|
|
|
504
509
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-67">Stability<a href="#stability-67" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
505
510
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="logging"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>logging</span><a href="#logging" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">logging</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LoggerOptions</span></div><div class="tsd-comment tsd-typography"><p>Configure logging options such as verbosity.</p>
|
|
506
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
511
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-51">Default<a href="#default-51" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">{}</span>
|
|
507
512
|
</code><button type="button">Copy</button></pre>
|
|
508
513
|
|
|
509
514
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-68">Stability<a href="#stability-68" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
510
515
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="majorversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>major<wbr/>Version</span><a href="#majorversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">majorVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Major version to release from the default branch.
|
|
511
516
|
If this is specified, we bump the latest version of this major version line.
|
|
512
517
|
If not specified, we bump the global latest version.</p>
|
|
513
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
518
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-52">Default<a href="#default-52" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">Major</span><span class="hl-1"> </span><span class="hl-5">version</span><span class="hl-1"> </span><span class="hl-5">is</span><span class="hl-1"> </span><span class="hl-5">not</span><span class="hl-1"> </span><span class="hl-5">enforced</span><span class="hl-1">.</span>
|
|
514
519
|
</code><button type="button">Copy</button></pre>
|
|
515
520
|
|
|
516
521
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-69">Stability<a href="#stability-69" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -519,7 +524,7 @@ The value indicates that the package is incompatible with any newer versions of
|
|
|
519
524
|
This requirement is enforced via the engines field.</p>
|
|
520
525
|
<p>You will normally not need to set this option.
|
|
521
526
|
Consider this option only if your package is known to not function with newer versions of node.</p>
|
|
522
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
527
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-53">Default<a href="#default-53" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">no</span><span class="hl-1"> </span><span class="hl-5">maximum</span><span class="hl-1"> </span><span class="hl-5">version</span><span class="hl-1"> </span><span class="hl-5">is</span><span class="hl-1"> </span><span class="hl-5">enforced</span>
|
|
523
528
|
</code><button type="button">Copy</button></pre>
|
|
524
529
|
|
|
525
530
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-70">Stability<a href="#stability-70" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -527,7 +532,7 @@ Consider this option only if your package is known to not function with newer ve
|
|
|
527
532
|
This can be useful to set to 1, as breaking changes before the 1.x major
|
|
528
533
|
release are not incrementing the major version number.</p>
|
|
529
534
|
<p>Can not be set together with <code>majorVersion</code>.</p>
|
|
530
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
535
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-54">Default<a href="#default-54" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">No</span><span class="hl-1"> </span><span class="hl-5">minimum</span><span class="hl-1"> </span><span class="hl-5">version</span><span class="hl-1"> </span><span class="hl-5">is</span><span class="hl-1"> </span><span class="hl-5">being</span><span class="hl-1"> </span><span class="hl-5">enforced</span>
|
|
531
536
|
</code><button type="button">Copy</button></pre>
|
|
532
537
|
|
|
533
538
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-71">Stability<a href="#stability-71" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -539,16 +544,16 @@ Consider this option only if your package depends on a specific feature, that is
|
|
|
539
544
|
Setting this option has very high impact on the consumers of your package,
|
|
540
545
|
as package managers will actively prevent usage with node versions you have marked as incompatible.</p>
|
|
541
546
|
<p>To change the node version of your CI/CD workflows, use <code>workflowNodeVersion</code>.</p>
|
|
542
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
547
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-55">Default<a href="#default-55" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">no</span><span class="hl-1"> </span><span class="hl-5">minimum</span><span class="hl-1"> </span><span class="hl-5">version</span><span class="hl-1"> </span><span class="hl-5">is</span><span class="hl-1"> </span><span class="hl-5">enforced</span>
|
|
543
548
|
</code><button type="button">Copy</button></pre>
|
|
544
549
|
|
|
545
550
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-72">Stability<a href="#stability-72" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
546
551
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="mise"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>mise</span><a href="#mise" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">mise</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable Mise component</p>
|
|
547
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
552
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-56">Default<a href="#default-56" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
548
553
|
</code><button type="button">Copy</button></pre>
|
|
549
554
|
|
|
550
555
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="name"><code class="tsd-tag">Readonly</code><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>This is the name of your project.</p>
|
|
551
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
556
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-57">Default<a href="#default-57" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">$BASEDIR</span>
|
|
552
557
|
</code><button type="button">Copy</button></pre>
|
|
553
558
|
|
|
554
559
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-73">Stability<a href="#stability-73" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -572,12 +577,12 @@ with the indicated component bumped.</li>
|
|
|
572
577
|
</ul>
|
|
573
578
|
<p>This setting cannot be specified together with <code>minMajorVersion</code>; the invoked
|
|
574
579
|
script can be used to achieve the effects of <code>minMajorVersion</code>.</p>
|
|
575
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
580
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-58">Default<a href="#default-58" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">The</span><span class="hl-1"> </span><span class="hl-5">next</span><span class="hl-1"> </span><span class="hl-5">version</span><span class="hl-1"> </span><span class="hl-5">will</span><span class="hl-1"> </span><span class="hl-5">be</span><span class="hl-1"> </span><span class="hl-5">determined</span><span class="hl-1"> </span><span class="hl-5">based</span><span class="hl-1"> </span><span class="hl-5">on</span><span class="hl-1"> </span><span class="hl-5">the</span><span class="hl-1"> </span><span class="hl-5">commit</span><span class="hl-1"> </span><span class="hl-5">history</span><span class="hl-1"> </span><span class="hl-5">and</span><span class="hl-1"> </span><span class="hl-5">project</span><span class="hl-1"> </span><span class="hl-5">settings</span><span class="hl-1">.</span>
|
|
576
581
|
</code><button type="button">Copy</button></pre>
|
|
577
582
|
|
|
578
583
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-74">Stability<a href="#stability-74" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
579
584
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="npmaccess"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Access</span><a href="#npmaccess" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">npmAccess</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NpmAccess</span></div><div class="tsd-comment tsd-typography"><p>Access level of the npm package.</p>
|
|
580
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
585
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-59">Default<a href="#default-59" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
581
586
|
<li>for scoped packages (e.g. <code>foo@bar</code>), the default is
|
|
582
587
|
<code>NpmAccess.RESTRICTED</code>, for non-scoped packages, the default is
|
|
583
588
|
<code>NpmAccess.PUBLIC</code>.</li>
|
|
@@ -586,12 +591,12 @@ script can be used to achieve the effects of <code>minMajorVersion</code>.</p>
|
|
|
586
591
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="npmdisttag"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Dist<wbr/>Tag</span><a href="#npmdisttag" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">npmDistTag</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The npmDistTag to use when publishing from the default branch.
|
|
587
592
|
To set the npm dist-tag for release branches, set the <code>npmDistTag</code> property
|
|
588
593
|
for each branch.</p>
|
|
589
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
594
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-60">Default<a href="#default-60" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"latest"</span>
|
|
590
595
|
</code><button type="button">Copy</button></pre>
|
|
591
596
|
|
|
592
597
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-76">Stability<a href="#stability-76" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
593
598
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="npmignoreenabled"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npmignore<wbr/>Enabled</span><a href="#npmignoreenabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">npmignoreEnabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.</p>
|
|
594
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
599
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-61">Default<a href="#default-61" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
595
600
|
</code><button type="button">Copy</button></pre>
|
|
596
601
|
|
|
597
602
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-77">Stability<a href="#stability-77" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -602,23 +607,23 @@ A supported package manager is required to publish a package with npm provenance
|
|
|
602
607
|
you will need to use a supported CI/CD provider.</p>
|
|
603
608
|
<p>Note that the projen <code>Release</code> and <code>Publisher</code> components are using <code>publib</code> to publish packages,
|
|
604
609
|
which is using npm internally and supports provenance statements independently of the package manager used.</p>
|
|
605
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
610
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-62">Default<a href="#default-62" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> </span><span class="hl-5">for</span><span class="hl-1"> </span><span class="hl-5">public</span><span class="hl-1"> </span><span class="hl-5">packages</span><span class="hl-1">, </span><span class="hl-3">false</span><span class="hl-1"> </span><span class="hl-5">otherwise</span>
|
|
606
611
|
</code><button type="button">Copy</button></pre>
|
|
607
612
|
|
|
608
613
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-79">Stability<a href="#stability-79" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
609
614
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="npmregistryurl"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Registry<wbr/>Url</span><a href="#npmregistryurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">npmRegistryUrl</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The base URL of the npm package registry.
|
|
610
615
|
Must be a URL (e.g. start with "https://" or "http://")</p>
|
|
611
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
616
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-63">Default<a href="#default-63" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"https://registry.npmjs.org"</span>
|
|
612
617
|
</code><button type="button">Copy</button></pre>
|
|
613
618
|
|
|
614
619
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-80">Stability<a href="#stability-80" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
615
620
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="npmtokensecret"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Token<wbr/>Secret</span><a href="#npmtokensecret" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">npmTokenSecret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>GitHub secret which contains the NPM token to use when publishing packages.</p>
|
|
616
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
621
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-64">Default<a href="#default-64" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"NPM_TOKEN"</span>
|
|
617
622
|
</code><button type="button">Copy</button></pre>
|
|
618
623
|
|
|
619
624
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-81">Stability<a href="#stability-81" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
620
625
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="npmtrustedpublishing"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Trusted<wbr/>Publishing</span><a href="#npmtrustedpublishing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">npmTrustedPublishing</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Use trusted publishing for publishing to <a href="http://npmjs.com">npmjs.com</a> Needs to be pre-configured on npm.js to work.</p>
|
|
621
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
626
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-65">Default<a href="#default-65" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-3">false</span>
|
|
622
627
|
</code><button type="button">Copy</button></pre>
|
|
623
628
|
|
|
624
629
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-82">Stability<a href="#stability-82" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -627,22 +632,22 @@ Relative to this directory, all files are synthesized.</p>
|
|
|
627
632
|
<p>If this project has a parent, this directory is relative to the parent
|
|
628
633
|
directory and it cannot be the same as the parent or any of it's other
|
|
629
634
|
subprojects.</p>
|
|
630
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
635
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-66">Default<a href="#default-66" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"."</span>
|
|
631
636
|
</code><button type="button">Copy</button></pre>
|
|
632
637
|
|
|
633
638
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-83">Stability<a href="#stability-83" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
634
639
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="package"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>package</span><a href="#package" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">package</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Defines a <code>package</code> task that will produce an npm tarball under the artifacts directory (e.g. <code>dist</code>).</p>
|
|
635
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
640
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-67">Default<a href="#default-67" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
636
641
|
</code><button type="button">Copy</button></pre>
|
|
637
642
|
|
|
638
643
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-84">Stability<a href="#stability-84" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
639
644
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="packagemanager"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>package<wbr/>Manager</span><a href="#packagemanager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">packageManager</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">NodePackageManager</span></div><div class="tsd-comment tsd-typography"><p>The Node Package Manager used to execute scripts.</p>
|
|
640
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
645
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-68">Default<a href="#default-68" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">NodePackageManager</span><span class="hl-1">.</span><span class="hl-4">YARN_CLASSIC</span>
|
|
641
646
|
</code><button type="button">Copy</button></pre>
|
|
642
647
|
|
|
643
648
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-85">Stability<a href="#stability-85" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
644
649
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="packagename"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>package<wbr/>Name</span><a href="#packagename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">packageName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The "name" in package.json.</p>
|
|
645
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
650
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-69">Default<a href="#default-69" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">defaults</span><span class="hl-1"> </span><span class="hl-5">to</span><span class="hl-1"> </span><span class="hl-5">project</span><span class="hl-1"> </span><span class="hl-5">name</span>
|
|
646
651
|
</code><button type="button">Copy</button></pre>
|
|
647
652
|
|
|
648
653
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-86">Stability<a href="#stability-86" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -663,63 +668,63 @@ breaking change for your customers.</p>
|
|
|
663
668
|
enabled by default), projen will automatically add a dev dependency with a
|
|
664
669
|
pinned version for each peer dependency. This will ensure that you build &
|
|
665
670
|
test your module against the lowest peer version required.</p>
|
|
666
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
671
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-70">Default<a href="#default-70" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">[]</span>
|
|
667
672
|
</code><button type="button">Copy</button></pre>
|
|
668
673
|
|
|
669
674
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-89">Stability<a href="#stability-89" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
670
675
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pnpmversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>pnpm<wbr/>Version</span><a href="#pnpmversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pnpmVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The version of PNPM to use if using PNPM as a package manager.</p>
|
|
671
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
676
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-71">Default<a href="#default-71" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"9"</span>
|
|
672
677
|
</code><button type="button">Copy</button></pre>
|
|
673
678
|
|
|
674
679
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-90">Stability<a href="#stability-90" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
675
680
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="postbuildsteps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>post<wbr/>Build<wbr/>Steps</span><a href="#postbuildsteps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">postBuildSteps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Steps to execute after build as part of the release workflow.</p>
|
|
676
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
681
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-72">Default<a href="#default-72" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">[]</span>
|
|
677
682
|
</code><button type="button">Copy</button></pre>
|
|
678
683
|
|
|
679
684
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-91">Stability<a href="#stability-91" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
680
685
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="prerelease"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>prerelease</span><a href="#prerelease" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">prerelease</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").</p>
|
|
681
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
686
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-73">Default<a href="#default-73" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">normal</span><span class="hl-1"> </span><span class="hl-5">semantic</span><span class="hl-1"> </span><span class="hl-5">versions</span>
|
|
682
687
|
</code><button type="button">Copy</button></pre>
|
|
683
688
|
|
|
684
689
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-92">Stability<a href="#stability-92" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
685
690
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="projencommand"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projen<wbr/>Command</span><a href="#projencommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">projenCommand</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The shell command to use in order to run the projen CLI.
|
|
686
691
|
Can be used to customize in special environments.</p>
|
|
687
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
692
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-74">Default<a href="#default-74" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"npx projen"</span>
|
|
688
693
|
</code><button type="button">Copy</button></pre>
|
|
689
694
|
|
|
690
695
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-93">Stability<a href="#stability-93" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
691
696
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="projencredentials"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projen<wbr/>Credentials</span><a href="#projencredentials" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">projenCredentials</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GithubCredentials</span></div><div class="tsd-comment tsd-typography"><p>Choose a method of providing GitHub API access for projen workflows.</p>
|
|
692
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
697
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-75">Default<a href="#default-75" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">use</span><span class="hl-1"> </span><span class="hl-5">a</span><span class="hl-1"> </span><span class="hl-5">personal</span><span class="hl-1"> </span><span class="hl-5">access</span><span class="hl-1"> </span><span class="hl-5">token</span><span class="hl-1"> </span><span class="hl-5">named</span><span class="hl-1"> </span><span class="hl-4">PROJEN_GITHUB_TOKEN</span>
|
|
693
698
|
</code><button type="button">Copy</button></pre>
|
|
694
699
|
|
|
695
700
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-94">Stability<a href="#stability-94" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
696
701
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="projendevdependency"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projen<wbr/>Dev<wbr/>Dependency</span><a href="#projendevdependency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">projenDevDependency</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates of "projen" should be installed as a devDependency.</p>
|
|
697
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
702
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-76">Default<a href="#default-76" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1"> </span><span class="hl-5">not</span><span class="hl-1"> </span><span class="hl-5">a</span><span class="hl-1"> </span><span class="hl-5">subproject</span>
|
|
698
703
|
</code><button type="button">Copy</button></pre>
|
|
699
704
|
|
|
700
705
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-95">Stability<a href="#stability-95" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
701
706
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="projenrcjs"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Js</span><a href="#projenrcjs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">projenrcJs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Generate (once) .projenrc.js (in JavaScript). Set to <code>false</code> in order to disable .projenrc.js generation.</p>
|
|
702
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
707
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-77">Default<a href="#default-77" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1"> </span><span class="hl-5">projenrcJson</span><span class="hl-1"> </span><span class="hl-5">is</span><span class="hl-1"> </span><span class="hl-3">false</span>
|
|
703
708
|
</code><button type="button">Copy</button></pre>
|
|
704
709
|
|
|
705
710
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-96">Stability<a href="#stability-96" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
706
711
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="projenrcjson"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Json</span><a href="#projenrcjson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">projenrcJson</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Generate (once) .projenrc.json (in JSON). Set to <code>false</code> in order to disable .projenrc.json generation.</p>
|
|
707
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
712
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-78">Default<a href="#default-78" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
|
|
708
713
|
</code><button type="button">Copy</button></pre>
|
|
709
714
|
|
|
710
715
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-97">Stability<a href="#stability-97" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
711
716
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="projenrcjsonoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Json<wbr/>Options</span><a href="#projenrcjsonoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">projenrcJsonOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcJsonOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for .projenrc.json.</p>
|
|
712
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
717
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-79">Default<a href="#default-79" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-5">options</span>
|
|
713
718
|
</code><button type="button">Copy</button></pre>
|
|
714
719
|
|
|
715
720
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-98">Stability<a href="#stability-98" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
716
721
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="projenrcjsoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Js<wbr/>Options</span><a href="#projenrcjsoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">projenrcJsOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for .projenrc.js.</p>
|
|
717
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
722
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-80">Default<a href="#default-80" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-5">options</span>
|
|
718
723
|
</code><button type="button">Copy</button></pre>
|
|
719
724
|
|
|
720
725
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-99">Stability<a href="#stability-99" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
721
726
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="projenrcts"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Ts</span><a href="#projenrcts" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">projenrcTs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Use TypeScript for your projenrc file (<code>.projenrc.ts</code>).</p>
|
|
722
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
727
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-81">Default<a href="#default-81" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
|
|
723
728
|
</code><button type="button">Copy</button></pre>
|
|
724
729
|
|
|
725
730
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-100">Stability<a href="#stability-100" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -727,64 +732,64 @@ Can be used to customize in special environments.</p>
|
|
|
727
732
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="projenrctsoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projenrc<wbr/>Ts<wbr/>Options</span><a href="#projenrctsoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">projenrcTsOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ProjenrcOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for .projenrc.ts.</p>
|
|
728
733
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-101">Stability<a href="#stability-101" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
729
734
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="projenversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>projen<wbr/>Version</span><a href="#projenversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">projenVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Version of projen to install.</p>
|
|
730
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
735
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-82">Default<a href="#default-82" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">Defaults</span><span class="hl-1"> </span><span class="hl-5">to</span><span class="hl-1"> </span><span class="hl-5">the</span><span class="hl-1"> </span><span class="hl-5">latest</span><span class="hl-1"> </span><span class="hl-5">version</span><span class="hl-1">.</span>
|
|
731
736
|
</code><button type="button">Copy</button></pre>
|
|
732
737
|
|
|
733
738
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-102">Stability<a href="#stability-102" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
734
739
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="publishdryrun"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>publish<wbr/>Dry<wbr/>Run</span><a href="#publishdryrun" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">publishDryRun</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Instead of actually publishing to package managers, just print the publishing command.</p>
|
|
735
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
740
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-83">Default<a href="#default-83" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
|
|
736
741
|
</code><button type="button">Copy</button></pre>
|
|
737
742
|
|
|
738
743
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-103">Stability<a href="#stability-103" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
739
744
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="publishtasks"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>publish<wbr/>Tasks</span><a href="#publishtasks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">publishTasks</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Define publishing tasks that can be executed manually as well as workflows.
|
|
740
745
|
Normally, publishing only happens within automated workflows. Enable this
|
|
741
746
|
in order to create a publishing task for each publishing activity.</p>
|
|
742
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
747
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-84">Default<a href="#default-84" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
|
|
743
748
|
</code><button type="button">Copy</button></pre>
|
|
744
749
|
|
|
745
750
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-104">Stability<a href="#stability-104" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
746
751
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="publishtogo"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>publish<wbr/>To<wbr/>Go</span><a href="#publishtogo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">publishToGo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiGoTarget</span></div><div class="tsd-comment tsd-typography"><p>Publish Go bindings to a git repository.</p>
|
|
747
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
752
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-85">Default<a href="#default-85" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">no</span><span class="hl-1"> </span><span class="hl-5">publishing</span>
|
|
748
753
|
</code><button type="button">Copy</button></pre>
|
|
749
754
|
|
|
750
755
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-105">Stability<a href="#stability-105" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
751
756
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="publishtomaven"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>publish<wbr/>To<wbr/>Maven</span><a href="#publishtomaven" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">publishToMaven</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiJavaTarget</span></div><div class="tsd-comment tsd-typography"><p>Publish to maven.</p>
|
|
752
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
757
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-86">Default<a href="#default-86" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">no</span><span class="hl-1"> </span><span class="hl-5">publishing</span>
|
|
753
758
|
</code><button type="button">Copy</button></pre>
|
|
754
759
|
|
|
755
760
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-106">Stability<a href="#stability-106" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
756
761
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="publishtonuget"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>publish<wbr/>To<wbr/>Nuget</span><a href="#publishtonuget" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">publishToNuget</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiDotNetTarget</span></div><div class="tsd-comment tsd-typography"><p>Publish to NuGet.</p>
|
|
757
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
762
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-87">Default<a href="#default-87" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">no</span><span class="hl-1"> </span><span class="hl-5">publishing</span>
|
|
758
763
|
</code><button type="button">Copy</button></pre>
|
|
759
764
|
|
|
760
765
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-107">Stability<a href="#stability-107" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
761
766
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="publishtopypi"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>publish<wbr/>To<wbr/>Pypi</span><a href="#publishtopypi" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">publishToPypi</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JsiiPythonTarget</span></div><div class="tsd-comment tsd-typography"><p>Publish to pypi.</p>
|
|
762
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
767
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-88">Default<a href="#default-88" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">no</span><span class="hl-1"> </span><span class="hl-5">publishing</span>
|
|
763
768
|
</code><button type="button">Copy</button></pre>
|
|
764
769
|
|
|
765
770
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-108">Stability<a href="#stability-108" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
766
771
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pullrequesttemplate"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>pull<wbr/>Request<wbr/>Template</span><a href="#pullrequesttemplate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pullRequestTemplate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Include a GitHub pull request template.</p>
|
|
767
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
772
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-89">Default<a href="#default-89" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
768
773
|
</code><button type="button">Copy</button></pre>
|
|
769
774
|
|
|
770
775
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-109">Stability<a href="#stability-109" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
771
776
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="pullrequesttemplatecontents"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span><a href="#pullrequesttemplatecontents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pullRequestTemplateContents</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The contents of the pull request template.</p>
|
|
772
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
777
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-90">Default<a href="#default-90" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-5">content</span>
|
|
773
778
|
</code><button type="button">Copy</button></pre>
|
|
774
779
|
|
|
775
780
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-110">Stability<a href="#stability-110" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
776
781
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readme"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>readme</span><a href="#readme" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">readme</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SampleReadmeProps</span></div><div class="tsd-comment tsd-typography"><p>The README setup.</p>
|
|
777
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
782
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-91">Default<a href="#default-91" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- { </span><span class="hl-10">filename</span><span class="hl-1">: </span><span class="hl-2">'README.md'</span><span class="hl-1">, </span><span class="hl-10">contents</span><span class="hl-1">: </span><span class="hl-2">'# replace this'</span><span class="hl-1"> }</span>
|
|
778
783
|
</code><button type="button">Copy</button></pre>
|
|
779
784
|
|
|
780
785
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-111">Stability<a href="#stability-111" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
781
786
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="releasablecommits"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>releasable<wbr/>Commits</span><a href="#releasablecommits" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">releasableCommits</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleasableCommits</span></div><div class="tsd-comment tsd-typography"><p>Find commits that should be considered releasable Used to decide if a release is required.</p>
|
|
782
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
787
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-92">Default<a href="#default-92" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">ReleasableCommits</span><span class="hl-1">.</span><span class="hl-0">everyCommit</span><span class="hl-1">()</span>
|
|
783
788
|
</code><button type="button">Copy</button></pre>
|
|
784
789
|
|
|
785
790
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-112">Stability<a href="#stability-112" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
786
791
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="release"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release</span><a href="#release" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">release</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Add release management to this project.</p>
|
|
787
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
792
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-93">Default<a href="#default-93" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-3">true</span><span class="hl-1"> (</span><span class="hl-3">false</span><span class="hl-1"> </span><span class="hl-5">for</span><span class="hl-1"> </span><span class="hl-5">subprojects</span><span class="hl-1">)</span>
|
|
788
793
|
</code><button type="button">Copy</button></pre>
|
|
789
794
|
|
|
790
795
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-113">Stability<a href="#stability-113" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -795,7 +800,7 @@ Each release branch <em>must</em> be assigned a major version number which is us
|
|
|
795
800
|
to enforce that versions published from that branch always use that major
|
|
796
801
|
version. If multiple branches are used, the <code>majorVersion</code> field must also
|
|
797
802
|
be provided for the default branch.</p>
|
|
798
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
803
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-94">Default<a href="#default-94" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
799
804
|
<li>no additional branches are used for release. you can use
|
|
800
805
|
<code>addBranch()</code> to add additional branches.</li>
|
|
801
806
|
</ul>
|
|
@@ -805,18 +810,18 @@ This can be used to add an explicit approval step to the release
|
|
|
805
810
|
or limit who can initiate a release through environment protection rules.</p>
|
|
806
811
|
<p>When multiple artifacts are released, the environment can be overwritten
|
|
807
812
|
on a per artifact basis.</p>
|
|
808
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
813
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-95">Default<a href="#default-95" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">no</span><span class="hl-1"> </span><span class="hl-5">environment</span><span class="hl-1"> </span><span class="hl-5">used</span><span class="hl-1">, </span><span class="hl-5">unless</span><span class="hl-1"> </span><span class="hl-5">set</span><span class="hl-1"> </span><span class="hl-5">at</span><span class="hl-1"> </span><span class="hl-5">the</span><span class="hl-1"> </span><span class="hl-5">artifact</span><span class="hl-1"> </span><span class="hl-5">level</span>
|
|
809
814
|
</code><button type="button">Copy</button></pre>
|
|
810
815
|
|
|
811
816
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-115">Stability<a href="#stability-115" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
812
817
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="releasefailureissue"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Failure<wbr/>Issue</span><a href="#releasefailureissue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">releaseFailureIssue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Create a github issue on every failed publishing task.</p>
|
|
813
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
818
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-96">Default<a href="#default-96" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
|
|
814
819
|
</code><button type="button">Copy</button></pre>
|
|
815
820
|
|
|
816
821
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-116">Stability<a href="#stability-116" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
817
822
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="releasefailureissuelabel"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Failure<wbr/>Issue<wbr/>Label</span><a href="#releasefailureissuelabel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">releaseFailureIssueLabel</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The label to apply to issues indicating publish failures.
|
|
818
823
|
Only applies if <code>releaseFailureIssue</code> is true.</p>
|
|
819
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
824
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-97">Default<a href="#default-97" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"failed-release"</span>
|
|
820
825
|
</code><button type="button">Copy</button></pre>
|
|
821
826
|
|
|
822
827
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-117">Stability<a href="#stability-117" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -825,39 +830,39 @@ Note: this prefix is used to detect the latest tagged version
|
|
|
825
830
|
when bumping, so if you change this on a project with an existing version
|
|
826
831
|
history, you may need to manually tag your latest release
|
|
827
832
|
with the new prefix.</p>
|
|
828
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
833
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-98">Default<a href="#default-98" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"v"</span>
|
|
829
834
|
</code><button type="button">Copy</button></pre>
|
|
830
835
|
|
|
831
836
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-118">Stability<a href="#stability-118" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
832
837
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="releasetonpm"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>To<wbr/>Npm</span><a href="#releasetonpm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">releaseToNpm</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Automatically release to npm when new versions are introduced.</p>
|
|
833
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
838
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-99">Default<a href="#default-99" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
|
|
834
839
|
</code><button type="button">Copy</button></pre>
|
|
835
840
|
|
|
836
841
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-119">Stability<a href="#stability-119" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
837
842
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="releasetrigger"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Trigger</span><a href="#releasetrigger" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">releaseTrigger</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ReleaseTrigger</span></div><div class="tsd-comment tsd-typography"><p>The release trigger to use.</p>
|
|
838
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
843
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-100">Default<a href="#default-100" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
839
844
|
<li>Continuous releases (<code>ReleaseTrigger.continuous()</code>)</li>
|
|
840
845
|
</ul>
|
|
841
846
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-120">Stability<a href="#stability-120" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
842
847
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="releaseworkflowenv"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Workflow<wbr/>Env</span><a href="#releaseworkflowenv" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">releaseWorkflowEnv</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Build environment variables for release workflows.</p>
|
|
843
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
848
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-101">Default<a href="#default-101" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">{}</span>
|
|
844
849
|
</code><button type="button">Copy</button></pre>
|
|
845
850
|
|
|
846
851
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-121">Stability<a href="#stability-121" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
847
852
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="releaseworkflowname"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Workflow<wbr/>Name</span><a href="#releaseworkflowname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">releaseWorkflowName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of the default release workflow.</p>
|
|
848
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
853
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-102">Default<a href="#default-102" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"release"</span>
|
|
849
854
|
</code><button type="button">Copy</button></pre>
|
|
850
855
|
|
|
851
856
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-122">Stability<a href="#stability-122" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
852
857
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="releaseworkflowsetupsteps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span><a href="#releaseworkflowsetupsteps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">releaseWorkflowSetupSteps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A set of workflow steps to execute in order to setup the workflow container.</p>
|
|
853
858
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-123">Stability<a href="#stability-123" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
854
859
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="renovatebot"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>renovatebot</span><a href="#renovatebot" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">renovatebot</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Use renovatebot to handle dependency upgrades.</p>
|
|
855
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
860
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-103">Default<a href="#default-103" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
|
|
856
861
|
</code><button type="button">Copy</button></pre>
|
|
857
862
|
|
|
858
863
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-124">Stability<a href="#stability-124" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
859
864
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="renovatebotoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>renovatebot<wbr/>Options</span><a href="#renovatebotoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">renovatebotOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">RenovatebotOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for renovatebot.</p>
|
|
860
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
865
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-104">Default<a href="#default-104" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-5">options</span>
|
|
861
866
|
</code><button type="button">Copy</button></pre>
|
|
862
867
|
|
|
863
868
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-125">Stability<a href="#stability-125" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -867,21 +872,21 @@ See <a href="https://classic.yarnpkg.com/en/docs/package-json/#toc-repository">h
|
|
|
867
872
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="repositorydirectory"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>repository<wbr/>Directory</span><a href="#repositorydirectory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">repositoryDirectory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>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.</p>
|
|
868
873
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-127">Stability<a href="#stability-127" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
869
874
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="repositoryurl"><code class="tsd-tag">Readonly</code><span>repository<wbr/>Url</span><a href="#repositoryurl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">repositoryUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Git repository URL.</p>
|
|
870
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
875
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-105">Default<a href="#default-105" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-5">$GIT_REMOTE</span>
|
|
871
876
|
</code><button type="button">Copy</button></pre>
|
|
872
877
|
|
|
873
878
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-128">Stability<a href="#stability-128" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
874
|
-
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="rootdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>rootdir</span><a href="#rootdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">rootdir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
879
|
+
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="rootdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>rootdir</span><a href="#rootdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">rootdir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-106">Default<a href="#default-106" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"."</span>
|
|
875
880
|
</code><button type="button">Copy</button></pre>
|
|
876
881
|
|
|
877
882
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-129">Stability<a href="#stability-129" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
878
883
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="scopedpackagesoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>scoped<wbr/>Packages<wbr/>Options</span><a href="#scopedpackagesoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">scopedPackagesOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ScopedPackagesOptions</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Options for privately hosted scoped packages.</p>
|
|
879
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
884
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-107">Default<a href="#default-107" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">fetch</span><span class="hl-1"> </span><span class="hl-5">all</span><span class="hl-1"> </span><span class="hl-5">scoped</span><span class="hl-1"> </span><span class="hl-5">packages</span><span class="hl-1"> </span><span class="hl-5">from</span><span class="hl-1"> </span><span class="hl-5">the</span><span class="hl-1"> </span><span class="hl-5">public</span><span class="hl-1"> </span><span class="hl-5">npm</span><span class="hl-1"> </span><span class="hl-5">registry</span>
|
|
880
885
|
</code><button type="button">Copy</button></pre>
|
|
881
886
|
|
|
882
887
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-130">Stability<a href="#stability-130" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
883
888
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="srcdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>srcdir</span><a href="#srcdir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">srcdir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Typescript sources directory.</p>
|
|
884
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
889
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-108">Default<a href="#default-108" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"src"</span>
|
|
885
890
|
</code><button type="button">Copy</button></pre>
|
|
886
891
|
|
|
887
892
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-131">Stability<a href="#stability-131" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -889,13 +894,13 @@ See <a href="https://classic.yarnpkg.com/en/docs/package-json/#toc-repository">h
|
|
|
889
894
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-132">Stability<a href="#stability-132" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
890
895
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stale"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>stale</span><a href="#stale" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Auto-close of stale issues and pull request.
|
|
891
896
|
See <code>staleOptions</code> for options.</p>
|
|
892
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
897
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-109">Default<a href="#default-109" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
|
|
893
898
|
</code><button type="button">Copy</button></pre>
|
|
894
899
|
|
|
895
900
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-133">Stability<a href="#stability-133" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
896
901
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="staleoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>stale<wbr/>Options</span><a href="#staleoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">staleOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">StaleOptions</span></div><div class="tsd-comment tsd-typography"><p>Auto-close stale issues and pull requests.
|
|
897
902
|
To disable set <code>stale</code> to <code>false</code>.</p>
|
|
898
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
903
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-110">Default<a href="#default-110" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
899
904
|
<li>see defaults in <code>StaleOptions</code></li>
|
|
900
905
|
</ul>
|
|
901
906
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-134">Stability<a href="#stability-134" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -904,88 +909,88 @@ If this directory is under <code>srcdir</code> (e.g. <code>src/test</code>, <cod
|
|
|
904
909
|
then tests are going to be compiled into <code>lib/</code> and executed as javascript.
|
|
905
910
|
If the test directory is outside of <code>src</code>, then we configure jest to
|
|
906
911
|
compile the code in-memory.</p>
|
|
907
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
912
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-111">Default<a href="#default-111" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"test"</span>
|
|
908
913
|
</code><button type="button">Copy</button></pre>
|
|
909
914
|
|
|
910
915
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-135">Stability<a href="#stability-135" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
911
916
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tsconfig"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>tsconfig</span><a href="#tsconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tsconfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span></div><div class="tsd-comment tsd-typography"><p>Custom TSConfig.</p>
|
|
912
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
917
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-112">Default<a href="#default-112" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-5">options</span>
|
|
913
918
|
</code><button type="button">Copy</button></pre>
|
|
914
919
|
|
|
915
920
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-136">Stability<a href="#stability-136" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
916
921
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tsconfigdev"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>tsconfig<wbr/>Dev</span><a href="#tsconfigdev" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tsconfigDev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypescriptConfigOptions</span></div><div class="tsd-comment tsd-typography"><p>Custom tsconfig options for the development tsconfig.json file (used for testing).</p>
|
|
917
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
922
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-113">Default<a href="#default-113" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">use</span><span class="hl-1"> </span><span class="hl-5">the</span><span class="hl-1"> </span><span class="hl-5">production</span><span class="hl-1"> </span><span class="hl-5">tsconfig</span><span class="hl-1"> </span><span class="hl-5">options</span>
|
|
918
923
|
</code><button type="button">Copy</button></pre>
|
|
919
924
|
|
|
920
925
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-137">Stability<a href="#stability-137" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
921
926
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="tsconfigdevfile"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>tsconfig<wbr/>Dev<wbr/>File</span><a href="#tsconfigdevfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tsconfigDevFile</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of the development tsconfig.json file.</p>
|
|
922
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
927
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-114">Default<a href="#default-114" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"tsconfig.dev.json"</span>
|
|
923
928
|
</code><button type="button">Copy</button></pre>
|
|
924
929
|
|
|
925
930
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-138">Stability<a href="#stability-138" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
926
931
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="typedoc"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>type<wbr/>Doc</span><a href="#typedoc" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">typeDoc</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable TypeDoc component</p>
|
|
927
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
932
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-115">Default<a href="#default-115" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
928
933
|
</code><button type="button">Copy</button></pre>
|
|
929
934
|
|
|
930
935
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="typedocoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>type<wbr/>Doc<wbr/>Options</span><a href="#typedocoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">typeDocOptions</span><span class="tsd-signature-symbol">?:</span> <a href="TypeDocOptions.html" class="tsd-signature-type tsd-kind-interface">TypeDocOptions</a></div><div class="tsd-comment tsd-typography"><p>TypeDoc configuration</p>
|
|
931
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
936
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-116">Default<a href="#default-116" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-5">TypeDoc</span><span class="hl-1"> </span><span class="hl-5">configuration</span>
|
|
932
937
|
</code><button type="button">Copy</button></pre>
|
|
933
938
|
|
|
934
939
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="typescriptversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>typescript<wbr/>Version</span><a href="#typescriptversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">typescriptVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>TypeScript version to use.
|
|
935
940
|
NOTE: Typescript is not semantically versioned and should remain on the
|
|
936
941
|
same minor, so we recommend using a <code>~</code> dependency (e.g. <code>~1.2.3</code>).</p>
|
|
937
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
942
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-117">Default<a href="#default-117" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"latest"</span>
|
|
938
943
|
</code><button type="button">Copy</button></pre>
|
|
939
944
|
|
|
940
945
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-139">Stability<a href="#stability-139" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
941
946
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="versionrcoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>versionrc<wbr/>Options</span><a href="#versionrcoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">versionrcOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Custom configuration used when creating changelog with commit-and-tag-version package.
|
|
942
947
|
Given values either append to default configuration or overwrite values in it.</p>
|
|
943
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
948
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-118">Default<a href="#default-118" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">standard</span><span class="hl-1"> </span><span class="hl-5">configuration</span><span class="hl-1"> </span><span class="hl-5">applicable</span><span class="hl-1"> </span><span class="hl-5">for</span><span class="hl-1"> </span><span class="hl-5">GitHub</span><span class="hl-1"> </span><span class="hl-5">repositories</span>
|
|
944
949
|
</code><button type="button">Copy</button></pre>
|
|
945
950
|
|
|
946
951
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-140">Stability<a href="#stability-140" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
947
952
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="vitest"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>vitest</span><a href="#vitest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">vitest</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable Vitest component</p>
|
|
948
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
953
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-119">Default<a href="#default-119" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
949
954
|
</code><button type="button">Copy</button></pre>
|
|
950
955
|
|
|
951
956
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="vitestoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>vitest<wbr/>Options</span><a href="#vitestoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">vitestOptions</span><span class="tsd-signature-symbol">?:</span> <a href="VitestOptions.html" class="tsd-signature-type tsd-kind-interface">VitestOptions</a></div><div class="tsd-comment tsd-typography"><p>Vitest configuration</p>
|
|
952
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
957
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-120">Default<a href="#default-120" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-5">Vitest</span><span class="hl-1"> </span><span class="hl-5">configuration</span>
|
|
953
958
|
</code><button type="button">Copy</button></pre>
|
|
954
959
|
|
|
955
960
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="vscode"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>vscode</span><a href="#vscode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">vscode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable VSCode integration.
|
|
956
961
|
Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
957
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
962
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-121">Default<a href="#default-121" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">true</span>
|
|
958
963
|
</code><button type="button">Copy</button></pre>
|
|
959
964
|
|
|
960
965
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-141">Stability<a href="#stability-141" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
961
966
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="workflowbootstrapsteps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Bootstrap<wbr/>Steps</span><a href="#workflowbootstrapsteps" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">workflowBootstrapSteps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">JobStep</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Workflow steps to use in order to bootstrap this repo.</p>
|
|
962
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
967
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-122">Default<a href="#default-122" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-2">"yarn install --frozen-lockfile && yarn projen"</span>
|
|
963
968
|
</code><button type="button">Copy</button></pre>
|
|
964
969
|
|
|
965
970
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-142">Stability<a href="#stability-142" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
966
971
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="workflowcontainerimage"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Container<wbr/>Image</span><a href="#workflowcontainerimage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">workflowContainerImage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Container image to use for GitHub workflows.</p>
|
|
967
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
972
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-123">Default<a href="#default-123" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-5">image</span>
|
|
968
973
|
</code><button type="button">Copy</button></pre>
|
|
969
974
|
|
|
970
975
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-143">Stability<a href="#stability-143" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
971
976
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="workflowgitidentity"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Git<wbr/>Identity</span><a href="#workflowgitidentity" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">workflowGitIdentity</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitIdentity</span></div><div class="tsd-comment tsd-typography"><p>The git identity to use in workflows.</p>
|
|
972
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
977
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-124">Default<a href="#default-124" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-5">GitHub</span><span class="hl-1"> </span><span class="hl-5">Actions</span><span class="hl-1"> </span><span class="hl-5">user</span>
|
|
973
978
|
</code><button type="button">Copy</button></pre>
|
|
974
979
|
|
|
975
980
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-144">Stability<a href="#stability-144" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
976
981
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="workflownodeversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Node<wbr/>Version</span><a href="#workflownodeversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">workflowNodeVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The node version used in GitHub Actions workflows.
|
|
977
982
|
Always use this option if your GitHub Actions workflows require a specific to run.</p>
|
|
978
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
983
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-125">Default<a href="#default-125" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><ul>
|
|
979
984
|
<li><code>minNodeVersion</code> if set, otherwise <code>lts/*</code>.</li>
|
|
980
985
|
</ul>
|
|
981
986
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-145">Stability<a href="#stability-145" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
982
987
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="workflowpackagecache"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Package<wbr/>Cache</span><a href="#workflowpackagecache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">workflowPackageCache</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Enable Node.js package cache in GitHub workflows.</p>
|
|
983
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
988
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-126">Default<a href="#default-126" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">false</span>
|
|
984
989
|
</code><button type="button">Copy</button></pre>
|
|
985
990
|
|
|
986
991
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-146">Stability<a href="#stability-146" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
987
992
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="workflowrunson"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Runs<wbr/>On</span><a href="#workflowrunson" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">workflowRunsOn</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Github Runner selection labels.</p>
|
|
988
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
993
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-127">Default<a href="#default-127" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">[</span><span class="hl-2">"ubuntu-latest"</span><span class="hl-1">]</span>
|
|
989
994
|
</code><button type="button">Copy</button></pre>
|
|
990
995
|
|
|
991
996
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-147">Stability<a href="#stability-147" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
@@ -996,8 +1001,8 @@ Always use this option if your GitHub Actions workflows require a specific to ru
|
|
|
996
1001
|
</div><div class="tsd-tag-description"><h4 class="tsd-anchor-link" id="description-2">Description<a href="#description-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Defines a target Runner Group by name and/or labels</p>
|
|
997
1002
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>if both <code>runsOn</code> and <code>runsOnGroup</code> are specified</p>
|
|
998
1003
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="yarnberryoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>yarn<wbr/>Berry<wbr/>Options</span><a href="#yarnberryoptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">yarnBerryOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">YarnBerryOptions</span></div><div class="tsd-comment tsd-typography"><p>Options for Yarn Berry.</p>
|
|
999
|
-
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-
|
|
1004
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-default"><h4 class="tsd-anchor-link" id="default-128">Default<a href="#default-128" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">Yarn</span><span class="hl-1"> </span><span class="hl-5">Berry</span><span class="hl-1"> </span><span class="hl-5">v4</span><span class="hl-1"> </span><span class="hl-7">with</span><span class="hl-1"> </span><span class="hl-5">all</span><span class="hl-1"> </span><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-5">options</span>
|
|
1000
1005
|
</code><button type="button">Copy</button></pre>
|
|
1001
1006
|
|
|
1002
1007
|
</div><div class="tsd-tag-stability"><h4 class="tsd-anchor-link" id="stability-149">Stability<a href="#stability-149" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>experimental</p>
|
|
1003
|
-
</div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#allowlibrarydependencies"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies</span></a><a href="#artifactsdirectory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Directory</span></a><a href="#auditdeps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>audit<wbr/>Deps</span></a><a href="#auditdepsoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>audit<wbr/>Deps<wbr/>Options</span></a><a href="#author"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author</span></a><a href="#authoraddress"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Address</span></a><a href="#authoremail"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Email</span></a><a href="#authorname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Name</span></a><a href="#authororganization"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Organization</span></a><a href="#authorurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Url</span></a><a href="#autoapproveoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve<wbr/>Options</span></a><a href="#autoapproveupgrades"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve<wbr/>Upgrades</span></a><a href="#autodetectbin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Detect<wbr/>Bin</span></a><a href="#automerge"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge</span></a><a href="#automergeoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge<wbr/>Options</span></a><a href="#bin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bin</span></a><a href="#biome"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome</span></a><a href="#biomeoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome<wbr/>Options</span></a><a href="#bugsemail"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bugs<wbr/>Email</span></a><a href="#bugsurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bugs<wbr/>Url</span></a><a href="#buildworkflow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow</span></a><a href="#buildworkflowoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow<wbr/>Options</span></a><a href="#bumppackage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bump<wbr/>Package</span></a><a href="#bundleddeps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bundled<wbr/>Deps</span></a><a href="#bundleroptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bundler<wbr/>Options</span></a><a href="#bunversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bun<wbr/>Version</span></a><a href="#checklicenses"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>check<wbr/>Licenses</span></a><a href="#clobber"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clobber</span></a><a href="#codeartifactoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Artifact<wbr/>Options</span></a><a href="#codecov"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Cov</span></a><a href="#codecovtokensecret"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Cov<wbr/>Token<wbr/>Secret</span></a><a href="#commitgenerated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>commit<wbr/>Generated</span></a><a href="#compat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>compat</span></a><a href="#compatignore"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>compat<wbr/>Ignore</span></a><a href="#compressassembly"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>compress<wbr/>Assembly</span></a><a href="#copyrightowner"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>copyright<wbr/>Owner</span></a><a href="#copyrightperiod"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>copyright<wbr/>Period</span></a><a href="#defaultreleasebranch"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Release<wbr/>Branch</span></a><a href="#dependabot"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dependabot</span></a><a href="#dependabotoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dependabot<wbr/>Options</span></a><a href="#deps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps</span></a><a href="#depsupgrade"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps<wbr/>Upgrade</span></a><a href="#depsupgradeoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps<wbr/>Upgrade<wbr/>Options</span></a><a href="#description"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#devcontainer"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Container</span></a><a href="#devdeps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Deps</span></a><a href="#disabletsconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Tsconfig</span></a><a href="#disabletsconfigdev"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Tsconfig<wbr/>Dev</span></a><a href="#docgen"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docgen</span></a><a href="#docgenfilepath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docgen<wbr/>File<wbr/>Path</span></a><a href="#docsdirectory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docs<wbr/>Directory</span></a><a href="#entrypoint"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entrypoint</span></a><a href="#entrypointtypes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entrypoint<wbr/>Types</span></a><a href="#excludetypescript"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude<wbr/>Typescript</span></a><a href="#github"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github</span></a><a href="#githuboptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github<wbr/>Options</span></a><a href="#gitignore"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitignore</span></a><a href="#gitignoreoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git<wbr/>Ignore<wbr/>Options</span></a><a href="#gitoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git<wbr/>Options</span></a><a href="#gitpod"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitpod</span></a><a href="#homepage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>homepage</span></a><a href="#jsiireleaseversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jsii<wbr/>Release<wbr/>Version</span></a><a href="#jsiiversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jsii<wbr/>Version</span></a><a href="#keywords"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keywords</span></a><a href="#libdir"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>libdir</span></a><a href="#license"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>license</span></a><a href="#licensed"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>licensed</span></a><a href="#logging"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logging</span></a><a href="#majorversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>major<wbr/>Version</span></a><a href="#maxnodeversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a><a href="#minmajorversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Major<wbr/>Version</span></a><a href="#minnodeversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a><a href="#mise"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mise</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#nextversioncommand"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next<wbr/>Version<wbr/>Command</span></a><a href="#npmaccess"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Access</span></a><a href="#npmdisttag"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Dist<wbr/>Tag</span></a><a href="#npmignoreenabled"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npmignore<wbr/>Enabled</span></a><a href="#npmignoreoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Ignore<wbr/>Options</span></a><a href="#npmprovenance"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Provenance</span></a><a href="#npmregistryurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Registry<wbr/>Url</span></a><a href="#npmtokensecret"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Token<wbr/>Secret</span></a><a href="#npmtrustedpublishing"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Trusted<wbr/>Publishing</span></a><a href="#outdir"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outdir</span></a><a href="#package"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package</span></a><a href="#packagemanager"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package<wbr/>Manager</span></a><a href="#packagename"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package<wbr/>Name</span></a><a href="#parent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent</span></a><a href="#peerdependencyoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>Dependency<wbr/>Options</span></a><a href="#peerdeps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>Deps</span></a><a href="#pnpmversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pnpm<wbr/>Version</span></a><a href="#postbuildsteps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>post<wbr/>Build<wbr/>Steps</span></a><a href="#prerelease"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prerelease</span></a><a href="#projencommand"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Command</span></a><a href="#projencredentials"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Credentials</span></a><a href="#projendevdependency"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Dev<wbr/>Dependency</span></a><a href="#projenrcjs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Js</span></a><a href="#projenrcjson"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Json</span></a><a href="#projenrcjsonoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Json<wbr/>Options</span></a><a href="#projenrcjsoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Js<wbr/>Options</span></a><a href="#projenrcts"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Ts</span></a><a href="#projenrctsoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Ts<wbr/>Options</span></a><a href="#projenversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Version</span></a><a href="#publishdryrun"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>Dry<wbr/>Run</span></a><a href="#publishtasks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>Tasks</span></a><a href="#publishtogo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>To<wbr/>Go</span></a><a href="#publishtomaven"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>To<wbr/>Maven</span></a><a href="#publishtonuget"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>To<wbr/>Nuget</span></a><a href="#publishtopypi"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>To<wbr/>Pypi</span></a><a href="#pullrequesttemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template</span></a><a href="#pullrequesttemplatecontents"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span></a><a href="#readme"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>readme</span></a><a href="#releasablecommits"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>releasable<wbr/>Commits</span></a><a href="#release"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release</span></a><a href="#releasebranches"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Branches</span></a><a href="#releaseenvironment"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Environment</span></a><a href="#releasefailureissue"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Failure<wbr/>Issue</span></a><a href="#releasefailureissuelabel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Failure<wbr/>Issue<wbr/>Label</span></a><a href="#releasetagprefix"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Tag<wbr/>Prefix</span></a><a href="#releasetonpm"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>To<wbr/>Npm</span></a><a href="#releasetrigger"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Trigger</span></a><a href="#releaseworkflowenv"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Env</span></a><a href="#releaseworkflowname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Name</span></a><a href="#releaseworkflowsetupsteps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span></a><a href="#renovatebot"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>renovatebot</span></a><a href="#renovatebotoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>renovatebot<wbr/>Options</span></a><a href="#repository"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>repository</span></a><a href="#repositorydirectory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>repository<wbr/>Directory</span></a><a href="#repositoryurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>repository<wbr/>Url</span></a><a href="#rootdir"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rootdir</span></a><a href="#scopedpackagesoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scoped<wbr/>Packages<wbr/>Options</span></a><a href="#srcdir"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>srcdir</span></a><a href="#stability"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stability</span></a><a href="#stale"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stale</span></a><a href="#staleoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stale<wbr/>Options</span></a><a href="#testdir"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>testdir</span></a><a href="#tsconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig</span></a><a href="#tsconfigdev"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Dev</span></a><a href="#tsconfigdevfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Dev<wbr/>File</span></a><a href="#typedoc"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type<wbr/>Doc</span></a><a href="#typedocoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type<wbr/>Doc<wbr/>Options</span></a><a href="#typescriptversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typescript<wbr/>Version</span></a><a href="#versionrcoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>versionrc<wbr/>Options</span></a><a href="#vitest"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vitest</span></a><a href="#vitestoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vitest<wbr/>Options</span></a><a href="#vscode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vscode</span></a><a href="#workflowbootstrapsteps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Bootstrap<wbr/>Steps</span></a><a href="#workflowcontainerimage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Container<wbr/>Image</span></a><a href="#workflowgitidentity"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Git<wbr/>Identity</span></a><a href="#workflownodeversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Node<wbr/>Version</span></a><a href="#workflowpackagecache"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Package<wbr/>Cache</span></a><a href="#workflowrunson"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Runs<wbr/>On</span></a><a href="#workflowrunsongroup"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Runs<wbr/>On<wbr/>Group</span></a><a href="#yarnberryoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yarn<wbr/>Berry<wbr/>Options</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@nikovirtala/projen-constructs</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
1008
|
+
</div></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#allowlibrarydependencies"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Library<wbr/>Dependencies</span></a><a href="#artifactsdirectory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>artifacts<wbr/>Directory</span></a><a href="#auditdeps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>audit<wbr/>Deps</span></a><a href="#auditdepsoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>audit<wbr/>Deps<wbr/>Options</span></a><a href="#author"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author</span></a><a href="#authoraddress"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Address</span></a><a href="#authoremail"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Email</span></a><a href="#authorname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Name</span></a><a href="#authororganization"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Organization</span></a><a href="#authorurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>author<wbr/>Url</span></a><a href="#autoapproveoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve<wbr/>Options</span></a><a href="#autoapproveupgrades"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Approve<wbr/>Upgrades</span></a><a href="#autodetectbin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Detect<wbr/>Bin</span></a><a href="#automerge"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge</span></a><a href="#automergeoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auto<wbr/>Merge<wbr/>Options</span></a><a href="#bin"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bin</span></a><a href="#biome"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome</span></a><a href="#biomeoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>biome<wbr/>Options</span></a><a href="#bugsemail"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bugs<wbr/>Email</span></a><a href="#bugsurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bugs<wbr/>Url</span></a><a href="#buildworkflow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow</span></a><a href="#buildworkflowoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>build<wbr/>Workflow<wbr/>Options</span></a><a href="#bumppackage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bump<wbr/>Package</span></a><a href="#bundleddeps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bundled<wbr/>Deps</span></a><a href="#bundleroptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bundler<wbr/>Options</span></a><a href="#bunversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bun<wbr/>Version</span></a><a href="#checklicenses"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>check<wbr/>Licenses</span></a><a href="#clobber"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clobber</span></a><a href="#codeartifactoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Artifact<wbr/>Options</span></a><a href="#codecov"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Cov</span></a><a href="#codecovtokensecret"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>code<wbr/>Cov<wbr/>Token<wbr/>Secret</span></a><a href="#commitgenerated"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>commit<wbr/>Generated</span></a><a href="#compat"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>compat</span></a><a href="#compatignore"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>compat<wbr/>Ignore</span></a><a href="#compressassembly"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>compress<wbr/>Assembly</span></a><a href="#copyrightowner"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>copyright<wbr/>Owner</span></a><a href="#copyrightperiod"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>copyright<wbr/>Period</span></a><a href="#defaultreleasebranch"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Release<wbr/>Branch</span></a><a href="#dependabot"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dependabot</span></a><a href="#dependabotoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dependabot<wbr/>Options</span></a><a href="#deps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps</span></a><a href="#depsupgrade"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps<wbr/>Upgrade</span></a><a href="#depsupgradeoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>deps<wbr/>Upgrade<wbr/>Options</span></a><a href="#description"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</span></a><a href="#devcontainer"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Container</span></a><a href="#devdeps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dev<wbr/>Deps</span></a><a href="#disabletsconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Tsconfig</span></a><a href="#disabletsconfigdev"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Tsconfig<wbr/>Dev</span></a><a href="#docgen"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docgen</span></a><a href="#docgenfilepath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docgen<wbr/>File<wbr/>Path</span></a><a href="#docsdirectory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>docs<wbr/>Directory</span></a><a href="#entrypoint"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entrypoint</span></a><a href="#entrypointtypes"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>entrypoint<wbr/>Types</span></a><a href="#excludetypescript"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>exclude<wbr/>Typescript</span></a><a href="#github"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github</span></a><a href="#githuboptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>github<wbr/>Options</span></a><a href="#gitignore"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitignore</span></a><a href="#gitignoreoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git<wbr/>Ignore<wbr/>Options</span></a><a href="#gitoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>git<wbr/>Options</span></a><a href="#gitpod"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>gitpod</span></a><a href="#homebrew"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>homebrew</span></a><a href="#homepage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>homepage</span></a><a href="#jsiireleaseversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jsii<wbr/>Release<wbr/>Version</span></a><a href="#jsiiversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>jsii<wbr/>Version</span></a><a href="#keywords"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>keywords</span></a><a href="#libdir"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>libdir</span></a><a href="#license"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>license</span></a><a href="#licensed"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>licensed</span></a><a href="#logging"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>logging</span></a><a href="#majorversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>major<wbr/>Version</span></a><a href="#maxnodeversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Node<wbr/>Version</span></a><a href="#minmajorversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Major<wbr/>Version</span></a><a href="#minnodeversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Node<wbr/>Version</span></a><a href="#mise"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mise</span></a><a href="#name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#nextversioncommand"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next<wbr/>Version<wbr/>Command</span></a><a href="#npmaccess"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Access</span></a><a href="#npmdisttag"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Dist<wbr/>Tag</span></a><a href="#npmignoreenabled"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npmignore<wbr/>Enabled</span></a><a href="#npmignoreoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Ignore<wbr/>Options</span></a><a href="#npmprovenance"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Provenance</span></a><a href="#npmregistryurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Registry<wbr/>Url</span></a><a href="#npmtokensecret"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Token<wbr/>Secret</span></a><a href="#npmtrustedpublishing"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>npm<wbr/>Trusted<wbr/>Publishing</span></a><a href="#outdir"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outdir</span></a><a href="#package"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package</span></a><a href="#packagemanager"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package<wbr/>Manager</span></a><a href="#packagename"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>package<wbr/>Name</span></a><a href="#parent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>parent</span></a><a href="#peerdependencyoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>Dependency<wbr/>Options</span></a><a href="#peerdeps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>peer<wbr/>Deps</span></a><a href="#pnpmversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pnpm<wbr/>Version</span></a><a href="#postbuildsteps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>post<wbr/>Build<wbr/>Steps</span></a><a href="#prerelease"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>prerelease</span></a><a href="#projencommand"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Command</span></a><a href="#projencredentials"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Credentials</span></a><a href="#projendevdependency"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Dev<wbr/>Dependency</span></a><a href="#projenrcjs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Js</span></a><a href="#projenrcjson"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Json</span></a><a href="#projenrcjsonoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Json<wbr/>Options</span></a><a href="#projenrcjsoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Js<wbr/>Options</span></a><a href="#projenrcts"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Ts</span></a><a href="#projenrctsoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projenrc<wbr/>Ts<wbr/>Options</span></a><a href="#projenversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>projen<wbr/>Version</span></a><a href="#publishdryrun"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>Dry<wbr/>Run</span></a><a href="#publishtasks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>Tasks</span></a><a href="#publishtogo"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>To<wbr/>Go</span></a><a href="#publishtomaven"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>To<wbr/>Maven</span></a><a href="#publishtonuget"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>To<wbr/>Nuget</span></a><a href="#publishtopypi"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>publish<wbr/>To<wbr/>Pypi</span></a><a href="#pullrequesttemplate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template</span></a><a href="#pullrequesttemplatecontents"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pull<wbr/>Request<wbr/>Template<wbr/>Contents</span></a><a href="#readme"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>readme</span></a><a href="#releasablecommits"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>releasable<wbr/>Commits</span></a><a href="#release"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release</span></a><a href="#releasebranches"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Branches</span></a><a href="#releaseenvironment"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Environment</span></a><a href="#releasefailureissue"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Failure<wbr/>Issue</span></a><a href="#releasefailureissuelabel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Failure<wbr/>Issue<wbr/>Label</span></a><a href="#releasetagprefix"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Tag<wbr/>Prefix</span></a><a href="#releasetonpm"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>To<wbr/>Npm</span></a><a href="#releasetrigger"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Trigger</span></a><a href="#releaseworkflowenv"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Env</span></a><a href="#releaseworkflowname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Name</span></a><a href="#releaseworkflowsetupsteps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>release<wbr/>Workflow<wbr/>Setup<wbr/>Steps</span></a><a href="#renovatebot"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>renovatebot</span></a><a href="#renovatebotoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>renovatebot<wbr/>Options</span></a><a href="#repository"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>repository</span></a><a href="#repositorydirectory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>repository<wbr/>Directory</span></a><a href="#repositoryurl"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>repository<wbr/>Url</span></a><a href="#rootdir"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rootdir</span></a><a href="#scopedpackagesoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>scoped<wbr/>Packages<wbr/>Options</span></a><a href="#srcdir"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>srcdir</span></a><a href="#stability"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stability</span></a><a href="#stale"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stale</span></a><a href="#staleoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stale<wbr/>Options</span></a><a href="#testdir"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>testdir</span></a><a href="#tsconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig</span></a><a href="#tsconfigdev"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Dev</span></a><a href="#tsconfigdevfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tsconfig<wbr/>Dev<wbr/>File</span></a><a href="#typedoc"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type<wbr/>Doc</span></a><a href="#typedocoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type<wbr/>Doc<wbr/>Options</span></a><a href="#typescriptversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typescript<wbr/>Version</span></a><a href="#versionrcoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>versionrc<wbr/>Options</span></a><a href="#vitest"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vitest</span></a><a href="#vitestoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vitest<wbr/>Options</span></a><a href="#vscode"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vscode</span></a><a href="#workflowbootstrapsteps"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Bootstrap<wbr/>Steps</span></a><a href="#workflowcontainerimage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Container<wbr/>Image</span></a><a href="#workflowgitidentity"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Git<wbr/>Identity</span></a><a href="#workflownodeversion"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Node<wbr/>Version</span></a><a href="#workflowpackagecache"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Package<wbr/>Cache</span></a><a href="#workflowrunson"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Runs<wbr/>On</span></a><a href="#workflowrunsongroup"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow<wbr/>Runs<wbr/>On<wbr/>Group</span></a><a href="#yarnberryoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>yarn<wbr/>Berry<wbr/>Options</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@nikovirtala/projen-constructs</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|