@nikovirtala/projen-constructs 0.2.156 → 0.3.0
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 +1077 -818
- package/.kiro/steering/product.md +1 -1
- package/.kiro/steering/tech.md +6 -4
- package/API.md +9711 -5492
- package/docs/api/assets/highlight.css +1 -1
- package/docs/api/assets/main.js +1 -1
- package/docs/api/assets/search.js +1 -1
- package/docs/api/assets/style.css +18 -3
- package/docs/api/classes/AwsCdkConstructLibraryProject.html +997 -162
- package/docs/api/classes/AwsCdkTypeScriptAppProject.html +1015 -157
- package/docs/api/classes/Bundler.html +267 -17
- package/docs/api/classes/Colima.html +221 -16
- package/docs/api/classes/Homebrew.html +244 -16
- package/docs/api/classes/JsiiProject.html +983 -150
- package/docs/api/classes/LambdaFunctionCodeBundle.html +222 -16
- package/docs/api/classes/LambdaFunctionCodeBundler.html +222 -16
- package/docs/api/classes/LambdaFunctionConstructGenerator.html +243 -16
- package/docs/api/classes/LocalStack.html +222 -16
- package/docs/api/classes/Mise.html +233 -16
- package/docs/api/classes/ProjectGenerator.html +229 -19
- package/docs/api/classes/TypeDoc.html +246 -19
- package/docs/api/classes/TypeScriptProject.html +983 -150
- package/docs/api/classes/Vitest.html +295 -16
- package/docs/api/enums/CommentStyle.html +74 -8
- package/docs/api/enums/CoverageProvider.html +65 -6
- package/docs/api/enums/CoverageReporter.html +72 -7
- package/docs/api/enums/EntryPointStrategy.html +74 -8
- package/docs/api/enums/Environment.html +79 -9
- package/docs/api/enums/LogLevel.html +79 -9
- package/docs/api/enums/Pool.html +75 -8
- package/docs/api/enums/ProjectType.html +149 -27
- package/docs/api/enums/Visibility.html +69 -7
- package/docs/api/functions/applyDefaults.html +41 -1
- package/docs/api/functions/convertToPosixPath.html +40 -1
- package/docs/api/functions/renderBundleName.html +40 -1
- package/docs/api/functions/toJson_TypeDocConfiguration.html +42 -2
- package/docs/api/hierarchy.html +29 -1
- package/docs/api/index.html +60 -2
- package/docs/api/interfaces/AwsCdkConstructLibraryProjectOptions.html +2404 -770
- package/docs/api/interfaces/AwsCdkTypeScriptAppProjectOptions.html +2302 -740
- package/docs/api/interfaces/Bundle.html +57 -2
- package/docs/api/interfaces/BundlerOptions.html +60 -2
- package/docs/api/interfaces/BundlingOptions.html +84 -2
- package/docs/api/interfaces/Component.html +70 -7
- package/docs/api/interfaces/ComponentOptions.html +66 -6
- package/docs/api/interfaces/HomebrewOptions.html +51 -2
- package/docs/api/interfaces/JsiiProjectOptions.html +2263 -713
- package/docs/api/interfaces/LambdaFunctionCodeBundleOptions.html +63 -2
- package/docs/api/interfaces/LambdaFunctionCodeBundlerOptions.html +57 -2
- package/docs/api/interfaces/LambdaFunctionConstructGeneratorOptions.html +72 -2
- package/docs/api/interfaces/LocalStackOptions.html +60 -2
- package/docs/api/interfaces/MiseOptions.html +51 -2
- package/docs/api/interfaces/ProjectGeneratorOptions.html +136 -20
- package/docs/api/interfaces/TypeDocConfiguration.html +469 -96
- package/docs/api/interfaces/TypeDocOptions.html +62 -5
- package/docs/api/interfaces/TypeScriptProjectOptions.html +2032 -638
- package/docs/api/interfaces/ValidationOptions.html +70 -7
- package/docs/api/interfaces/VitestConfigOptions.html +268 -57
- package/docs/api/interfaces/VitestOptions.html +71 -7
- package/docs/api/modules.html +52 -1
- package/docs/api/variables/defaultOptions.html +40 -1
- package/docs/api/variables/defaults.html +48 -1
- package/docs/api/variables/projectDefaultOptions.html +120 -1
- package/lib/bundle-vitest-define-config.js +37 -4
- package/lib/components/bundle-lambda-function-code.js +43 -9
- package/lib/components/colima.js +6 -4
- package/lib/components/homebrew.js +10 -4
- package/lib/components/lambda-function-construct-generator.js +47 -6
- package/lib/components/localstack.js +2 -4
- package/lib/components/mise.js +2 -4
- package/lib/components/typedoc.js +11 -4
- package/lib/components/vitest.d.ts +1 -1
- package/lib/components/vitest.js +58 -6
- package/lib/config.d.ts +52 -6
- package/lib/config.js +87 -10
- package/lib/errors.js +7 -1
- package/lib/project-generator.js +46 -9
- package/lib/project-type.d.ts +0 -8
- package/lib/project-type.js +1 -9
- package/lib/projects/awscdk-construct-library-options.generated.d.ts +72 -18
- package/lib/projects/awscdk-construct-library-options.generated.js +1 -1
- package/lib/projects/awscdk-construct-library.generated.d.ts +1 -1
- package/lib/projects/awscdk-construct-library.generated.js +2 -4
- package/lib/projects/awscdk-typescript-app-options.generated.d.ts +63 -17
- package/lib/projects/awscdk-typescript-app-options.generated.js +1 -1
- package/lib/projects/awscdk-typescript-app.generated.d.ts +1 -1
- package/lib/projects/awscdk-typescript-app.generated.js +2 -4
- package/lib/projects/jsii-options.generated.d.ts +72 -10
- package/lib/projects/jsii-options.generated.js +1 -1
- package/lib/projects/jsii.generated.d.ts +1 -1
- package/lib/projects/jsii.generated.js +2 -4
- package/lib/projects/typescript-options.generated.d.ts +63 -9
- package/lib/projects/typescript-options.generated.js +1 -1
- package/lib/projects/typescript.generated.d.ts +1 -1
- package/lib/projects/typescript.generated.js +2 -4
- package/lib/utils.d.ts +8 -0
- package/lib/utils.js +11 -2
- package/lib/versions.json +1 -1
- package/node_modules/@jsii/spec/lib/assembly-utils.js +36 -3
- package/node_modules/@jsii/spec/lib/validators.js +1 -1
- package/node_modules/@jsii/spec/package.json +4 -4
- package/package.json +19 -20
- package/pnpm-workspace.yaml +8 -0
- package/lib/components/vitest-bundled-define-config.d.ts +0 -1
- package/lib/components/vitest-bundled-define-config.js +0 -6
- package/lib/vitest-define-config-entry.d.ts +0 -1
- package/lib/vitest-define-config-entry.js +0 -6
|
@@ -1,6 +1,29 @@
|
|
|
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>TypeScriptProjectOptions | @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"
|
|
2
|
-
</div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TypeScriptProjectOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#addpackagemanagertodevengines">addPackageManagerToDevEngines</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="#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="#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="#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="#deleteorphanedlockfiles">deleteOrphanedLockFiles</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="#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="#devengines">devEngines</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DevEngines</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="#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="#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="#homebrewoptions">homebrewOptions</a><span class="tsd-signature-symbol">?:</span> <a href="HomebrewOptions.html" class="tsd-signature-type tsd-kind-interface">HomebrewOptions</a><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="#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="#miseoptions">miseOptions</a><span class="tsd-signature-symbol">?:</span> <a href="MiseOptions.html" class="tsd-signature-type tsd-kind-interface">MiseOptions</a><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="#projecttree">projectTree</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="#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="#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="#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="#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="#addpackagemanagertodevengines" 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>add<wbr/>Package<wbr/>Manager<wbr/>To<wbr/>Dev<wbr/>Engines?</span></a>
|
|
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>TypeScriptProjectOptions | @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">
|
|
2
|
+
<div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@nikovirtala/projen-constructs</a>
|
|
3
|
+
<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"/>
|
|
4
|
+
<ul role="listbox" id="tsd-search-results"></ul>
|
|
5
|
+
<div id="tsd-search-status" aria-live="polite" aria-atomic="true">
|
|
6
|
+
<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>
|
|
7
|
+
<div class="container container-main">
|
|
8
|
+
<div class="col-content">
|
|
9
|
+
<div class="tsd-page-title">
|
|
10
|
+
<ul class="tsd-breadcrumb" aria-label="Breadcrumb">
|
|
11
|
+
<li><a href="" aria-current="page">TypeScriptProjectOptions</a></li></ul>
|
|
12
|
+
<h1>Interface TypeScriptProjectOptions</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-comment">
|
|
14
|
+
<div class="tsd-comment tsd-typography"><p>TypeScriptProjectOptions</p>
|
|
15
|
+
</div></section>
|
|
16
|
+
<div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">TypeScriptProjectOptions</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#addpackagemanagertodevengines">addPackageManagerToDevEngines</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="#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="#allowscripts">allowScripts</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="#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="#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="#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="#deleteorphanedlockfiles">deleteOrphanedLockFiles</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="#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="#devengines">devEngines</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DevEngines</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="#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="#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="#homebrewoptions">homebrewOptions</a><span class="tsd-signature-symbol">?:</span> <a href="HomebrewOptions.html" class="tsd-signature-type tsd-kind-interface">HomebrewOptions</a><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="#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="#miseoptions">miseOptions</a><span class="tsd-signature-symbol">?:</span> <a href="MiseOptions.html" class="tsd-signature-type tsd-kind-interface">MiseOptions</a><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="#pnpmoptions">pnpmOptions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PnpmOptions</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="#projecttree">projectTree</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="#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="#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="#runner">runner</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypeScriptRunner</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="#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>
|
|
17
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
18
|
+
<section class="tsd-panel tsd-index-panel">
|
|
19
|
+
<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>
|
|
20
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
21
|
+
<div class="tsd-accordion-details">
|
|
22
|
+
<section class="tsd-index-section">
|
|
23
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" 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>
|
|
24
|
+
<div class="tsd-index-list"><a href="#addpackagemanagertodevengines" 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>add<wbr/>Package<wbr/>Manager<wbr/>To<wbr/>Dev<wbr/>Engines?</span></a>
|
|
3
25
|
<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>
|
|
26
|
+
<a href="#allowscripts" 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/>Scripts?</span></a>
|
|
4
27
|
<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>
|
|
5
28
|
<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>
|
|
6
29
|
<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>
|
|
@@ -32,7 +55,7 @@
|
|
|
32
55
|
<a href="#commitgenerated" 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>commit<wbr/>Generated?</span></a>
|
|
33
56
|
<a href="#copyrightowner" 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>copyright<wbr/>Owner?</span></a>
|
|
34
57
|
<a href="#copyrightperiod" 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>copyright<wbr/>Period?</span></a>
|
|
35
|
-
<a href="#defaultreleasebranch" 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>default<wbr/>Release<wbr/>Branch
|
|
58
|
+
<a href="#defaultreleasebranch" 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>default<wbr/>Release<wbr/>Branch?</span></a>
|
|
36
59
|
<a href="#deleteorphanedlockfiles" 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>delete<wbr/>Orphaned<wbr/>Lock<wbr/>Files?</span></a>
|
|
37
60
|
<a href="#dependabot" 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>dependabot?</span></a>
|
|
38
61
|
<a href="#dependabotoptions" 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>dependabot<wbr/>Options?</span></a>
|
|
@@ -87,6 +110,7 @@
|
|
|
87
110
|
<a href="#parent" 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>parent?</span></a>
|
|
88
111
|
<a href="#peerdependencyoptions" 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>peer<wbr/>Dependency<wbr/>Options?</span></a>
|
|
89
112
|
<a href="#peerdeps" 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>peer<wbr/>Deps?</span></a>
|
|
113
|
+
<a href="#pnpmoptions" 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>pnpm<wbr/>Options?</span></a>
|
|
90
114
|
<a href="#pnpmversion" 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>pnpm<wbr/>Version?</span></a>
|
|
91
115
|
<a href="#postbuildsteps" 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>post<wbr/>Build<wbr/>Steps?</span></a>
|
|
92
116
|
<a href="#prerelease" 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>prerelease?</span></a>
|
|
@@ -122,6 +146,7 @@
|
|
|
122
146
|
<a href="#renovatebotoptions" 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>renovatebot<wbr/>Options?</span></a>
|
|
123
147
|
<a href="#repository" 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>repository?</span></a>
|
|
124
148
|
<a href="#repositorydirectory" 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>repository<wbr/>Directory?</span></a>
|
|
149
|
+
<a href="#runner" 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>runner?</span></a>
|
|
125
150
|
<a href="#scopedpackagesoptions" 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>scoped<wbr/>Packages<wbr/>Options?</span></a>
|
|
126
151
|
<a href="#srcdir" 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>srcdir?</span></a>
|
|
127
152
|
<a href="#stability" 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>stability?</span></a>
|
|
@@ -144,107 +169,334 @@
|
|
|
144
169
|
<a href="#workflowrunson" 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>workflow<wbr/>Runs<wbr/>On?</span></a>
|
|
145
170
|
<a href="#workflowrunsongroup" 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>workflow<wbr/>Runs<wbr/>On<wbr/>Group?</span></a>
|
|
146
171
|
<a href="#yarnberryoptions" 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>yarn<wbr/>Berry<wbr/>Options?</span></a>
|
|
147
|
-
</div></section></div></details></section></section
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
172
|
+
</div></section></div></details></section></section>
|
|
173
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><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>
|
|
174
|
+
<h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-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></h2></summary>
|
|
175
|
+
<section>
|
|
176
|
+
<section class="tsd-panel tsd-member">
|
|
177
|
+
<h3 class="tsd-anchor-link" id="addpackagemanagertodevengines"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>add<wbr/>Package<wbr/>Manager<wbr/>To<wbr/>Dev<wbr/>Engines</span><a href="#addpackagemanagertodevengines" 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>
|
|
178
|
+
<div class="tsd-signature"><span class="tsd-kind-property">addPackageManagerToDevEngines</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
179
|
+
<div class="tsd-comment tsd-typography"><p>Automatically add the resolved <code>packageManager</code> to <code>devEngines.packageManager</code> in <code>package.json</code>, setting <code>onFail</code> to <code>ignore</code>.</p>
|
|
180
|
+
</div>
|
|
181
|
+
<div class="tsd-comment tsd-typography">
|
|
182
|
+
<div class="tsd-tag-default">
|
|
183
|
+
<h4 class="tsd-anchor-link" id="default">Default<a href="#default" 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>
|
|
184
|
+
</code><button type="button">Copy</button></pre>
|
|
185
|
+
|
|
186
|
+
</div>
|
|
187
|
+
<div class="tsd-tag-stability">
|
|
188
|
+
<h4 class="tsd-anchor-link" id="stability-1">Stability<a href="#stability-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>experimental</p>
|
|
189
|
+
</div></div></section>
|
|
190
|
+
<section class="tsd-panel tsd-member">
|
|
191
|
+
<h3 class="tsd-anchor-link" id="allowlibrarydependencies"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>allow<wbr/>Library<wbr/>Dependencies</span><a href="#allowlibrarydependencies" 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>
|
|
192
|
+
<div class="tsd-signature"><span class="tsd-kind-property">allowLibraryDependencies</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
193
|
+
<div class="tsd-comment tsd-typography"><p>Allow the project to include <code>peerDependencies</code> and <code>bundledDependencies</code>.
|
|
153
194
|
This is normally only allowed for libraries. For apps, there's no meaning
|
|
154
195
|
for specifying these.</p>
|
|
155
|
-
</div
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
</
|
|
160
|
-
|
|
161
|
-
</
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
</div></div></section
|
|
196
|
+
</div>
|
|
197
|
+
<div class="tsd-comment tsd-typography">
|
|
198
|
+
<div class="tsd-tag-default">
|
|
199
|
+
<h4 class="tsd-anchor-link" id="default-1">Default<a href="#default-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><pre><code class="ts"><span class="hl-3">true</span>
|
|
200
|
+
</code><button type="button">Copy</button></pre>
|
|
201
|
+
|
|
202
|
+
</div>
|
|
203
|
+
<div class="tsd-tag-stability">
|
|
204
|
+
<h4 class="tsd-anchor-link" id="stability-2">Stability<a href="#stability-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>experimental</p>
|
|
205
|
+
</div></div></section>
|
|
206
|
+
<section class="tsd-panel tsd-member">
|
|
207
|
+
<h3 class="tsd-anchor-link" id="allowscripts"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>allow<wbr/>Scripts</span><a href="#allowscripts" 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>
|
|
208
|
+
<div class="tsd-signature"><span class="tsd-kind-property">allowScripts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
209
|
+
<div class="tsd-comment tsd-typography"><p>List of dependency (package) names that are allowed to run lifecycle install scripts (<code>preinstall</code>, <code>install</code>, <code>postinstall</code>, <code>prepare</code>) during dependency installation.
|
|
210
|
+
These scripts can execute arbitrary code, making them a common
|
|
211
|
+
supply-chain attack vector. Package managers are moving toward
|
|
212
|
+
blocking them by default and requiring an explicit allowlist.
|
|
213
|
+
Configuring <code>allowScripts</code> sets up that allowlist so scripts only run
|
|
214
|
+
for the packages you have explicitly reviewed and trust.</p>
|
|
215
|
+
<p>Support for this setting depends on the configured <code>packageManager</code>:</p>
|
|
216
|
+
<ul>
|
|
217
|
+
<li><code>NPM</code>: written to the native <code>allowScripts</code> field in <code>package.json</code>
|
|
218
|
+
(requires npm >= 11.16; see <a href="https://docs.npmjs.com/cli/v11/commands/npm-approve-scripts">https://docs.npmjs.com/cli/v11/commands/npm-approve-scripts</a>).</li>
|
|
219
|
+
<li><code>BUN</code>: written to the native <code>trustedDependencies</code> field in
|
|
220
|
+
<code>package.json</code> (see <a href="https://bun.com/docs/pm/lifecycle">https://bun.com/docs/pm/lifecycle</a>).</li>
|
|
221
|
+
<li><code>PNPM</code>: written to the <code>onlyBuiltDependencies</code> setting in
|
|
222
|
+
<code>pnpm-workspace.yaml</code> (see <a href="https://pnpm.io/settings#onlybuiltdependencies">https://pnpm.io/settings#onlybuiltdependencies</a>).</li>
|
|
223
|
+
<li><code>YARN2</code>, <code>YARN_BERRY</code>: written to the native
|
|
224
|
+
<code>dependenciesMeta.<pkg>.built</code> allowlist in <code>package.json</code>, combined
|
|
225
|
+
with <code>enableScripts: false</code> in <code>.yarnrc.yml</code> (see
|
|
226
|
+
<a href="https://yarnpkg.com/features/security#postinstalls">https://yarnpkg.com/features/security#postinstalls</a>). If you set
|
|
227
|
+
<code>yarnBerryOptions.yarnRcOptions.enableScripts</code> explicitly, that value
|
|
228
|
+
is respected instead of being overridden.</li>
|
|
229
|
+
<li><code>YARN</code>, <code>YARN_CLASSIC</code>: not supported. Yarn Classic has no native
|
|
230
|
+
mechanism to allowlist install scripts for specific dependencies.
|
|
231
|
+
Setting this option with one of these package managers throws an
|
|
232
|
+
error at synthesis time.</li>
|
|
233
|
+
</ul>
|
|
234
|
+
</div>
|
|
235
|
+
<div class="tsd-comment tsd-typography">
|
|
236
|
+
<div class="tsd-tag-default">
|
|
237
|
+
<h4 class="tsd-anchor-link" id="default-2">Default<a href="#default-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><pre><code class="ts"><span class="hl-1">- </span><span class="hl-5">all</span><span class="hl-1"> </span><span class="hl-5">install</span><span class="hl-1"> </span><span class="hl-5">scripts</span><span class="hl-1"> </span><span class="hl-5">are</span><span class="hl-1"> </span><span class="hl-5">allowed</span><span class="hl-1"> </span><span class="hl-5">to</span><span class="hl-1"> </span><span class="hl-0">run</span><span class="hl-1"> (</span><span class="hl-5">package</span><span class="hl-1"> </span><span class="hl-5">manager</span><span class="hl-1"> </span><span class="hl-5">default</span><span class="hl-1">)</span>
|
|
238
|
+
</code><button type="button">Copy</button></pre>
|
|
239
|
+
|
|
240
|
+
</div>
|
|
241
|
+
<div class="tsd-tag-stability">
|
|
242
|
+
<h4 class="tsd-anchor-link" id="stability-3">Stability<a href="#stability-3" 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>
|
|
243
|
+
</div></div></section>
|
|
244
|
+
<section class="tsd-panel tsd-member">
|
|
245
|
+
<h3 class="tsd-anchor-link" id="artifactsdirectory"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>artifacts<wbr/>Directory</span><a href="#artifactsdirectory" 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>
|
|
246
|
+
<div class="tsd-signature"><span class="tsd-kind-property">artifactsDirectory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
247
|
+
<div class="tsd-comment tsd-typography"><p>A directory which will contain build artifacts.</p>
|
|
248
|
+
</div>
|
|
249
|
+
<div class="tsd-comment tsd-typography">
|
|
250
|
+
<div class="tsd-tag-default">
|
|
251
|
+
<h4 class="tsd-anchor-link" id="default-3">Default<a href="#default-3" 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">"dist"</span>
|
|
252
|
+
</code><button type="button">Copy</button></pre>
|
|
253
|
+
|
|
254
|
+
</div>
|
|
255
|
+
<div class="tsd-tag-stability">
|
|
256
|
+
<h4 class="tsd-anchor-link" id="stability-4">Stability<a href="#stability-4" 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>
|
|
257
|
+
</div></div></section>
|
|
258
|
+
<section class="tsd-panel tsd-member">
|
|
259
|
+
<h3 class="tsd-anchor-link" id="auditdeps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>audit<wbr/>Deps</span><a href="#auditdeps" 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>
|
|
260
|
+
<div class="tsd-signature"><span class="tsd-kind-property">auditDeps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
261
|
+
<div class="tsd-comment tsd-typography"><p>Run security audit on dependencies.
|
|
165
262
|
When enabled, creates an "audit" task that checks for known security vulnerabilities
|
|
166
263
|
in dependencies. By default, runs during every build and checks for "high" severity
|
|
167
264
|
vulnerabilities or above in all dependencies (including dev dependencies).</p>
|
|
168
|
-
</div
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
</
|
|
173
|
-
|
|
174
|
-
</
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
</div></div></section
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
</div
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
</
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
265
|
+
</div>
|
|
266
|
+
<div class="tsd-comment tsd-typography">
|
|
267
|
+
<div class="tsd-tag-default">
|
|
268
|
+
<h4 class="tsd-anchor-link" id="default-4">Default<a href="#default-4" 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>
|
|
269
|
+
</code><button type="button">Copy</button></pre>
|
|
270
|
+
|
|
271
|
+
</div>
|
|
272
|
+
<div class="tsd-tag-stability">
|
|
273
|
+
<h4 class="tsd-anchor-link" id="stability-5">Stability<a href="#stability-5" 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>
|
|
274
|
+
</div></div></section>
|
|
275
|
+
<section class="tsd-panel tsd-member">
|
|
276
|
+
<h3 class="tsd-anchor-link" id="auditdepsoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>audit<wbr/>Deps<wbr/>Options</span><a href="#auditdepsoptions" 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>
|
|
277
|
+
<div class="tsd-signature"><span class="tsd-kind-property">auditDepsOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AuditOptions</span></div>
|
|
278
|
+
<div class="tsd-comment tsd-typography"><p>Security audit options.</p>
|
|
279
|
+
</div>
|
|
280
|
+
<div class="tsd-comment tsd-typography">
|
|
281
|
+
<div class="tsd-tag-default">
|
|
282
|
+
<h4 class="tsd-anchor-link" id="default-5">Default<a href="#default-5" 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>
|
|
283
|
+
</code><button type="button">Copy</button></pre>
|
|
284
|
+
|
|
285
|
+
</div>
|
|
286
|
+
<div class="tsd-tag-stability">
|
|
287
|
+
<h4 class="tsd-anchor-link" id="stability-6">Stability<a href="#stability-6" 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>
|
|
288
|
+
</div></div></section>
|
|
289
|
+
<section class="tsd-panel tsd-member">
|
|
290
|
+
<h3 class="tsd-anchor-link" id="authoremail"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>author<wbr/>Email</span><a href="#authoremail" 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>
|
|
291
|
+
<div class="tsd-signature"><span class="tsd-kind-property">authorEmail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
292
|
+
<div class="tsd-comment tsd-typography"><p>Author's e-mail.</p>
|
|
293
|
+
</div>
|
|
294
|
+
<div class="tsd-comment tsd-typography">
|
|
295
|
+
<div class="tsd-tag-stability">
|
|
296
|
+
<h4 class="tsd-anchor-link" id="stability-7">Stability<a href="#stability-7" 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>
|
|
297
|
+
</div></div></section>
|
|
298
|
+
<section class="tsd-panel tsd-member">
|
|
299
|
+
<h3 class="tsd-anchor-link" id="authorname"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>author<wbr/>Name</span><a href="#authorname" 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>
|
|
300
|
+
<div class="tsd-signature"><span class="tsd-kind-property">authorName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
301
|
+
<div class="tsd-comment tsd-typography"><p>Author's name.</p>
|
|
302
|
+
</div>
|
|
303
|
+
<div class="tsd-comment tsd-typography">
|
|
304
|
+
<div class="tsd-tag-stability">
|
|
305
|
+
<h4 class="tsd-anchor-link" id="stability-8">Stability<a href="#stability-8" 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>
|
|
306
|
+
</div></div></section>
|
|
307
|
+
<section class="tsd-panel tsd-member">
|
|
308
|
+
<h3 class="tsd-anchor-link" id="authororganization"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>author<wbr/>Organization</span><a href="#authororganization" 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>
|
|
309
|
+
<div class="tsd-signature"><span class="tsd-kind-property">authorOrganization</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
310
|
+
<div class="tsd-comment tsd-typography"><p>Is the author an organization.</p>
|
|
311
|
+
</div>
|
|
312
|
+
<div class="tsd-comment tsd-typography">
|
|
313
|
+
<div class="tsd-tag-stability">
|
|
314
|
+
<h4 class="tsd-anchor-link" id="stability-9">Stability<a href="#stability-9" 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>
|
|
315
|
+
</div></div></section>
|
|
316
|
+
<section class="tsd-panel tsd-member">
|
|
317
|
+
<h3 class="tsd-anchor-link" id="authorurl"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>author<wbr/>Url</span><a href="#authorurl" 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>
|
|
318
|
+
<div class="tsd-signature"><span class="tsd-kind-property">authorUrl</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
319
|
+
<div class="tsd-comment tsd-typography"><p>Author's URL / Website.</p>
|
|
320
|
+
</div>
|
|
321
|
+
<div class="tsd-comment tsd-typography">
|
|
322
|
+
<div class="tsd-tag-stability">
|
|
323
|
+
<h4 class="tsd-anchor-link" id="stability-10">Stability<a href="#stability-10" 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>
|
|
324
|
+
</div></div></section>
|
|
325
|
+
<section class="tsd-panel tsd-member">
|
|
326
|
+
<h3 class="tsd-anchor-link" id="autoapproveoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Approve<wbr/>Options</span><a href="#autoapproveoptions" 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>
|
|
327
|
+
<div class="tsd-signature"><span class="tsd-kind-property">autoApproveOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoApproveOptions</span></div>
|
|
328
|
+
<div class="tsd-comment tsd-typography"><p>Enable and configure the 'auto approve' workflow.</p>
|
|
329
|
+
</div>
|
|
330
|
+
<div class="tsd-comment tsd-typography">
|
|
331
|
+
<div class="tsd-tag-default">
|
|
332
|
+
<h4 class="tsd-anchor-link" id="default-6">Default<a href="#default-6" 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">auto</span><span class="hl-1"> </span><span class="hl-5">approve</span><span class="hl-1"> </span><span class="hl-5">is</span><span class="hl-1"> </span><span class="hl-5">disabled</span>
|
|
333
|
+
</code><button type="button">Copy</button></pre>
|
|
334
|
+
|
|
335
|
+
</div>
|
|
336
|
+
<div class="tsd-tag-stability">
|
|
337
|
+
<h4 class="tsd-anchor-link" id="stability-11">Stability<a href="#stability-11" 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>
|
|
338
|
+
</div></div></section>
|
|
339
|
+
<section class="tsd-panel tsd-member">
|
|
340
|
+
<h3 class="tsd-anchor-link" id="autoapproveupgrades"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Approve<wbr/>Upgrades</span><a href="#autoapproveupgrades" 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>
|
|
341
|
+
<div class="tsd-signature"><span class="tsd-kind-property">autoApproveUpgrades</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
342
|
+
<div class="tsd-comment tsd-typography"><p>Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configured).
|
|
191
343
|
Throw if set to true but <code>autoApproveOptions</code> are not defined.</p>
|
|
192
|
-
</div
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
</
|
|
197
|
-
|
|
198
|
-
</
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
</div></div></section
|
|
344
|
+
</div>
|
|
345
|
+
<div class="tsd-comment tsd-typography">
|
|
346
|
+
<div class="tsd-tag-default">
|
|
347
|
+
<h4 class="tsd-anchor-link" id="default-7">Default<a href="#default-7" 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>
|
|
348
|
+
</code><button type="button">Copy</button></pre>
|
|
349
|
+
|
|
350
|
+
</div>
|
|
351
|
+
<div class="tsd-tag-stability">
|
|
352
|
+
<h4 class="tsd-anchor-link" id="stability-12">Stability<a href="#stability-12" 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>
|
|
353
|
+
</div></div></section>
|
|
354
|
+
<section class="tsd-panel tsd-member">
|
|
355
|
+
<h3 class="tsd-anchor-link" id="autodetectbin"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Detect<wbr/>Bin</span><a href="#autodetectbin" 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>
|
|
356
|
+
<div class="tsd-signature"><span class="tsd-kind-property">autoDetectBin</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
357
|
+
<div class="tsd-comment tsd-typography"><p>Automatically add all executables under the <code>bin</code> directory to your <code>package.json</code> file under the <code>bin</code> section.</p>
|
|
358
|
+
</div>
|
|
359
|
+
<div class="tsd-comment tsd-typography">
|
|
360
|
+
<div class="tsd-tag-default">
|
|
361
|
+
<h4 class="tsd-anchor-link" id="default-8">Default<a href="#default-8" 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>
|
|
362
|
+
</code><button type="button">Copy</button></pre>
|
|
363
|
+
|
|
364
|
+
</div>
|
|
365
|
+
<div class="tsd-tag-stability">
|
|
366
|
+
<h4 class="tsd-anchor-link" id="stability-13">Stability<a href="#stability-13" 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>
|
|
367
|
+
</div></div></section>
|
|
368
|
+
<section class="tsd-panel tsd-member">
|
|
369
|
+
<h3 class="tsd-anchor-link" id="automerge"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Merge</span><a href="#automerge" 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>
|
|
370
|
+
<div class="tsd-signature"><span class="tsd-kind-property">autoMerge</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
371
|
+
<div class="tsd-comment tsd-typography"><p>Enable automatic merging on GitHub.
|
|
202
372
|
Has no effect if <code>github.mergify</code>
|
|
203
373
|
is set to false.</p>
|
|
204
|
-
</div
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
</
|
|
374
|
+
</div>
|
|
375
|
+
<div class="tsd-comment tsd-typography">
|
|
376
|
+
<div class="tsd-tag-default">
|
|
377
|
+
<h4 class="tsd-anchor-link" id="default-9">Default<a href="#default-9" 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>
|
|
378
|
+
</code><button type="button">Copy</button></pre>
|
|
379
|
+
|
|
380
|
+
</div>
|
|
381
|
+
<div class="tsd-tag-stability">
|
|
382
|
+
<h4 class="tsd-anchor-link" id="stability-14">Stability<a href="#stability-14" 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>
|
|
383
|
+
</div></div></section>
|
|
384
|
+
<section class="tsd-panel tsd-member">
|
|
385
|
+
<h3 class="tsd-anchor-link" id="automergeoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>auto<wbr/>Merge<wbr/>Options</span><a href="#automergeoptions" 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>
|
|
386
|
+
<div class="tsd-signature"><span class="tsd-kind-property">autoMergeOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AutoMergeOptions</span></div>
|
|
387
|
+
<div class="tsd-comment tsd-typography"><p>Configure options for automatic merging on GitHub.
|
|
209
388
|
Has no effect if
|
|
210
389
|
<code>github.mergify</code> or <code>autoMerge</code> is set to false.</p>
|
|
211
|
-
</div
|
|
390
|
+
</div>
|
|
391
|
+
<div class="tsd-comment tsd-typography">
|
|
392
|
+
<div class="tsd-tag-default">
|
|
393
|
+
<h4 class="tsd-anchor-link" id="default-10">Default<a href="#default-10" 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>
|
|
212
394
|
<li>see defaults in <code>AutoMergeOptions</code></li>
|
|
213
395
|
</ul>
|
|
214
|
-
</div
|
|
215
|
-
|
|
396
|
+
</div>
|
|
397
|
+
<div class="tsd-tag-stability">
|
|
398
|
+
<h4 class="tsd-anchor-link" id="stability-15">Stability<a href="#stability-15" 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>
|
|
399
|
+
</div></div></section>
|
|
400
|
+
<section class="tsd-panel tsd-member">
|
|
401
|
+
<h3 class="tsd-anchor-link" id="bin"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bin</span><a href="#bin" 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>
|
|
402
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bin</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>
|
|
403
|
+
<div class="tsd-comment tsd-typography"><p>Binary programs vended with your module.
|
|
216
404
|
You can use this option to add/customize how binaries are represented in
|
|
217
405
|
your <code>package.json</code>, but unless <code>autoDetectBin</code> is <code>false</code>, every
|
|
218
406
|
executable file under <code>bin</code> will automatically be added to this section.</p>
|
|
219
|
-
</div
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
</
|
|
233
|
-
|
|
234
|
-
</div
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
407
|
+
</div>
|
|
408
|
+
<div class="tsd-comment tsd-typography">
|
|
409
|
+
<div class="tsd-tag-stability">
|
|
410
|
+
<h4 class="tsd-anchor-link" id="stability-16">Stability<a href="#stability-16" 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>
|
|
411
|
+
</div></div></section>
|
|
412
|
+
<section class="tsd-panel tsd-member">
|
|
413
|
+
<h3 class="tsd-anchor-link" id="biome"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>biome</span><a href="#biome" 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>
|
|
414
|
+
<div class="tsd-signature"><span class="tsd-kind-property">biome</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
415
|
+
<div class="tsd-comment tsd-typography"><p>Setup Biome.</p>
|
|
416
|
+
</div>
|
|
417
|
+
<div class="tsd-comment tsd-typography">
|
|
418
|
+
<div class="tsd-tag-default">
|
|
419
|
+
<h4 class="tsd-anchor-link" id="default-11">Default<a href="#default-11" 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>
|
|
420
|
+
</code><button type="button">Copy</button></pre>
|
|
421
|
+
|
|
422
|
+
</div>
|
|
423
|
+
<div class="tsd-tag-stability">
|
|
424
|
+
<h4 class="tsd-anchor-link" id="stability-17">Stability<a href="#stability-17" 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>
|
|
425
|
+
</div></div></section>
|
|
426
|
+
<section class="tsd-panel tsd-member">
|
|
427
|
+
<h3 class="tsd-anchor-link" id="biomeoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>biome<wbr/>Options</span><a href="#biomeoptions" 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>
|
|
428
|
+
<div class="tsd-signature"><span class="tsd-kind-property">biomeOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BiomeOptions</span></div>
|
|
429
|
+
<div class="tsd-comment tsd-typography"><p>Biome options.</p>
|
|
430
|
+
</div>
|
|
431
|
+
<div class="tsd-comment tsd-typography">
|
|
432
|
+
<div class="tsd-tag-default">
|
|
433
|
+
<h4 class="tsd-anchor-link" id="default-12">Default<a href="#default-12" 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>
|
|
434
|
+
</code><button type="button">Copy</button></pre>
|
|
435
|
+
|
|
436
|
+
</div>
|
|
437
|
+
<div class="tsd-tag-stability">
|
|
438
|
+
<h4 class="tsd-anchor-link" id="stability-18">Stability<a href="#stability-18" 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>
|
|
439
|
+
</div></div></section>
|
|
440
|
+
<section class="tsd-panel tsd-member">
|
|
441
|
+
<h3 class="tsd-anchor-link" id="bugsemail"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bugs<wbr/>Email</span><a href="#bugsemail" 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>
|
|
442
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bugsEmail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
443
|
+
<div class="tsd-comment tsd-typography"><p>The email address to which issues should be reported.</p>
|
|
444
|
+
</div>
|
|
445
|
+
<div class="tsd-comment tsd-typography">
|
|
446
|
+
<div class="tsd-tag-stability">
|
|
447
|
+
<h4 class="tsd-anchor-link" id="stability-19">Stability<a href="#stability-19" 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>
|
|
448
|
+
</div></div></section>
|
|
449
|
+
<section class="tsd-panel tsd-member">
|
|
450
|
+
<h3 class="tsd-anchor-link" id="bugsurl"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bugs<wbr/>Url</span><a href="#bugsurl" 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>
|
|
451
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bugsUrl</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
452
|
+
<div class="tsd-comment tsd-typography"><p>The url to your project's issue tracker.</p>
|
|
453
|
+
</div>
|
|
454
|
+
<div class="tsd-comment tsd-typography">
|
|
455
|
+
<div class="tsd-tag-stability">
|
|
456
|
+
<h4 class="tsd-anchor-link" id="stability-20">Stability<a href="#stability-20" 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>
|
|
457
|
+
</div></div></section>
|
|
458
|
+
<section class="tsd-panel tsd-member">
|
|
459
|
+
<h3 class="tsd-anchor-link" id="buildworkflow"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>build<wbr/>Workflow</span><a href="#buildworkflow" 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>
|
|
460
|
+
<div class="tsd-signature"><span class="tsd-kind-property">buildWorkflow</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
461
|
+
<div class="tsd-comment tsd-typography"><p>Define a GitHub workflow for building PRs.</p>
|
|
462
|
+
</div>
|
|
463
|
+
<div class="tsd-comment tsd-typography">
|
|
464
|
+
<div class="tsd-tag-default">
|
|
465
|
+
<h4 class="tsd-anchor-link" id="default-13">Default<a href="#default-13" 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>
|
|
466
|
+
</code><button type="button">Copy</button></pre>
|
|
467
|
+
|
|
468
|
+
</div>
|
|
469
|
+
<div class="tsd-tag-stability">
|
|
470
|
+
<h4 class="tsd-anchor-link" id="stability-21">Stability<a href="#stability-21" 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>
|
|
471
|
+
</div></div></section>
|
|
472
|
+
<section class="tsd-panel tsd-member">
|
|
473
|
+
<h3 class="tsd-anchor-link" id="buildworkflowoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>build<wbr/>Workflow<wbr/>Options</span><a href="#buildworkflowoptions" 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>
|
|
474
|
+
<div class="tsd-signature"><span class="tsd-kind-property">buildWorkflowOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BuildWorkflowOptions</span></div>
|
|
475
|
+
<div class="tsd-comment tsd-typography"><p>Options for PR build workflow.</p>
|
|
476
|
+
</div>
|
|
477
|
+
<div class="tsd-comment tsd-typography">
|
|
478
|
+
<div class="tsd-tag-stability">
|
|
479
|
+
<h4 class="tsd-anchor-link" id="stability-22">Stability<a href="#stability-22" 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>
|
|
480
|
+
</div></div></section>
|
|
481
|
+
<section class="tsd-panel tsd-member">
|
|
482
|
+
<h3 class="tsd-anchor-link" id="bumppackage"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bump<wbr/>Package</span><a href="#bumppackage" 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>
|
|
483
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bumpPackage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
484
|
+
<div class="tsd-comment tsd-typography"><p>The <code>commit-and-tag-version</code> compatible package used to bump the package version, as a dependency string.
|
|
242
485
|
This can be any compatible package version, including the deprecated <code>standard-version@9</code>.</p>
|
|
243
|
-
</div
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
</
|
|
486
|
+
</div>
|
|
487
|
+
<div class="tsd-comment tsd-typography">
|
|
488
|
+
<div class="tsd-tag-default">
|
|
489
|
+
<h4 class="tsd-anchor-link" id="default-14">Default<a href="#default-14" 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-4">A</span><span class="hl-1"> </span><span class="hl-5">recent</span><span class="hl-1"> </span><span class="hl-5">version</span><span class="hl-1"> </span><span class="hl-3">of</span><span class="hl-1"> </span><span class="hl-2">"commit-and-tag-version"</span>
|
|
490
|
+
</code><button type="button">Copy</button></pre>
|
|
491
|
+
|
|
492
|
+
</div>
|
|
493
|
+
<div class="tsd-tag-stability">
|
|
494
|
+
<h4 class="tsd-anchor-link" id="stability-23">Stability<a href="#stability-23" 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>
|
|
495
|
+
</div></div></section>
|
|
496
|
+
<section class="tsd-panel tsd-member">
|
|
497
|
+
<h3 class="tsd-anchor-link" id="bundleddeps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bundled<wbr/>Deps</span><a href="#bundleddeps" 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>
|
|
498
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bundledDeps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
499
|
+
<div class="tsd-comment tsd-typography"><p>List of dependencies to bundle into this module.
|
|
248
500
|
These modules will be
|
|
249
501
|
added both to the <code>dependencies</code> section and <code>bundledDependencies</code> section of
|
|
250
502
|
your <code>package.json</code>.</p>
|
|
@@ -254,114 +506,301 @@ sense that it will add the module as a dependency to your <code>package.json</co
|
|
|
254
506
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
255
507
|
the same syntax passed to <code>pnpm add</code> or <code>npm i</code> (e.g. <code>express@^2</code>) and
|
|
256
508
|
this will be what your <code>package.json</code> will eventually include.</p>
|
|
257
|
-
</div
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
</div
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
509
|
+
</div>
|
|
510
|
+
<div class="tsd-comment tsd-typography">
|
|
511
|
+
<div class="tsd-tag-stability">
|
|
512
|
+
<h4 class="tsd-anchor-link" id="stability-24">Stability<a href="#stability-24" 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>
|
|
513
|
+
</div></div></section>
|
|
514
|
+
<section class="tsd-panel tsd-member">
|
|
515
|
+
<h3 class="tsd-anchor-link" id="bundleroptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bundler<wbr/>Options</span><a href="#bundleroptions" 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>
|
|
516
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bundlerOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">BundlerOptions</span></div>
|
|
517
|
+
<div class="tsd-comment tsd-typography"><p>Options for <code>Bundler</code>.</p>
|
|
518
|
+
</div>
|
|
519
|
+
<div class="tsd-comment tsd-typography">
|
|
520
|
+
<div class="tsd-tag-stability">
|
|
521
|
+
<h4 class="tsd-anchor-link" id="stability-25">Stability<a href="#stability-25" 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>
|
|
522
|
+
</div></div></section>
|
|
523
|
+
<section class="tsd-panel tsd-member">
|
|
524
|
+
<h3 class="tsd-anchor-link" id="bunversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>bun<wbr/>Version</span><a href="#bunversion" 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>
|
|
525
|
+
<div class="tsd-signature"><span class="tsd-kind-property">bunVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
526
|
+
<div class="tsd-comment tsd-typography"><p>The version of Bun to use if using Bun as a package manager.</p>
|
|
527
|
+
</div>
|
|
528
|
+
<div class="tsd-comment tsd-typography">
|
|
529
|
+
<div class="tsd-tag-default">
|
|
530
|
+
<h4 class="tsd-anchor-link" id="default-15">Default<a href="#default-15" 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>
|
|
531
|
+
</code><button type="button">Copy</button></pre>
|
|
532
|
+
|
|
533
|
+
</div>
|
|
534
|
+
<div class="tsd-tag-stability">
|
|
535
|
+
<h4 class="tsd-anchor-link" id="stability-26">Stability<a href="#stability-26" 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>
|
|
536
|
+
</div></div></section>
|
|
537
|
+
<section class="tsd-panel tsd-member">
|
|
538
|
+
<h3 class="tsd-anchor-link" id="checklicenses"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>check<wbr/>Licenses</span><a href="#checklicenses" 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>
|
|
539
|
+
<div class="tsd-signature"><span class="tsd-kind-property">checkLicenses</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LicenseCheckerOptions</span></div>
|
|
540
|
+
<div class="tsd-comment tsd-typography"><p>Configure which licenses should be deemed acceptable for use by dependencies.
|
|
266
541
|
This setting will cause the build to fail, if any prohibited or not allowed licenses ares encountered.</p>
|
|
267
|
-
</div
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
</
|
|
272
|
-
|
|
273
|
-
</
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
</div></div></section
|
|
542
|
+
</div>
|
|
543
|
+
<div class="tsd-comment tsd-typography">
|
|
544
|
+
<div class="tsd-tag-default">
|
|
545
|
+
<h4 class="tsd-anchor-link" id="default-16">Default<a href="#default-16" 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">license</span><span class="hl-1"> </span><span class="hl-5">checks</span><span class="hl-1"> </span><span class="hl-5">are</span><span class="hl-1"> </span><span class="hl-5">run</span><span class="hl-1"> </span><span class="hl-5">during</span><span class="hl-1"> </span><span class="hl-5">the</span><span class="hl-1"> </span><span class="hl-5">build</span><span class="hl-1"> </span><span class="hl-5">and</span><span class="hl-1"> </span><span class="hl-5">all</span><span class="hl-1"> </span><span class="hl-5">licenses</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">accepted</span>
|
|
546
|
+
</code><button type="button">Copy</button></pre>
|
|
547
|
+
|
|
548
|
+
</div>
|
|
549
|
+
<div class="tsd-tag-stability">
|
|
550
|
+
<h4 class="tsd-anchor-link" id="stability-27">Stability<a href="#stability-27" 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>
|
|
551
|
+
</div></div></section>
|
|
552
|
+
<section class="tsd-panel tsd-member">
|
|
553
|
+
<h3 class="tsd-anchor-link" id="clobber"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>clobber</span><a href="#clobber" 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>
|
|
554
|
+
<div class="tsd-signature"><span class="tsd-kind-property">clobber</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
555
|
+
<div class="tsd-comment tsd-typography"><p>Add a <code>clobber</code> task which resets the repo to origin.</p>
|
|
556
|
+
</div>
|
|
557
|
+
<div class="tsd-comment tsd-typography">
|
|
558
|
+
<div class="tsd-tag-default">
|
|
559
|
+
<h4 class="tsd-anchor-link" id="default-17">Default<a href="#default-17" 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">but</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>
|
|
560
|
+
</code><button type="button">Copy</button></pre>
|
|
561
|
+
|
|
562
|
+
</div>
|
|
563
|
+
<div class="tsd-tag-stability">
|
|
564
|
+
<h4 class="tsd-anchor-link" id="stability-28">Stability<a href="#stability-28" 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>
|
|
565
|
+
</div></div></section>
|
|
566
|
+
<section class="tsd-panel tsd-member">
|
|
567
|
+
<h3 class="tsd-anchor-link" id="codeartifactoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>code<wbr/>Artifact<wbr/>Options</span><a href="#codeartifactoptions" 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>
|
|
568
|
+
<div class="tsd-signature"><span class="tsd-kind-property">codeArtifactOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">CodeArtifactOptions</span></div>
|
|
569
|
+
<div class="tsd-comment tsd-typography"><p>Options for npm packages using AWS CodeArtifact.
|
|
277
570
|
This is required if publishing packages to, or installing scoped packages from AWS CodeArtifact</p>
|
|
278
|
-
</div
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
</
|
|
283
|
-
|
|
284
|
-
</
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
</div></div></section
|
|
288
|
-
|
|
289
|
-
</code
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
</div
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
</
|
|
297
|
-
|
|
298
|
-
</div
|
|
571
|
+
</div>
|
|
572
|
+
<div class="tsd-comment tsd-typography">
|
|
573
|
+
<div class="tsd-tag-default">
|
|
574
|
+
<h4 class="tsd-anchor-link" id="default-18">Default<a href="#default-18" 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">undefined</span>
|
|
575
|
+
</code><button type="button">Copy</button></pre>
|
|
576
|
+
|
|
577
|
+
</div>
|
|
578
|
+
<div class="tsd-tag-stability">
|
|
579
|
+
<h4 class="tsd-anchor-link" id="stability-29">Stability<a href="#stability-29" 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>
|
|
580
|
+
</div></div></section>
|
|
581
|
+
<section class="tsd-panel tsd-member">
|
|
582
|
+
<h3 class="tsd-anchor-link" id="codecov"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>code<wbr/>Cov</span><a href="#codecov" 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>
|
|
583
|
+
<div class="tsd-signature"><span class="tsd-kind-property">codeCov</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
584
|
+
<div class="tsd-comment tsd-typography"><p>Define a GitHub workflow step for sending code coverage metrics to <a href="https://codecov.io/">https://codecov.io/</a> Uses codecov/codecov-action@v5 By default, OIDC auth is used. Alternatively a token can be provided via <code>codeCovTokenSecret</code>.</p>
|
|
585
|
+
</div>
|
|
586
|
+
<div class="tsd-comment tsd-typography">
|
|
587
|
+
<div class="tsd-tag-default">
|
|
588
|
+
<h4 class="tsd-anchor-link" id="default-19">Default<a href="#default-19" 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>
|
|
589
|
+
</code><button type="button">Copy</button></pre>
|
|
590
|
+
|
|
591
|
+
</div>
|
|
592
|
+
<div class="tsd-tag-stability">
|
|
593
|
+
<h4 class="tsd-anchor-link" id="stability-30">Stability<a href="#stability-30" 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>
|
|
594
|
+
</div></div></section>
|
|
595
|
+
<section class="tsd-panel tsd-member">
|
|
596
|
+
<h3 class="tsd-anchor-link" id="codecovtokensecret"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>code<wbr/>Cov<wbr/>Token<wbr/>Secret</span><a href="#codecovtokensecret" 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>
|
|
597
|
+
<div class="tsd-signature"><span class="tsd-kind-property">codeCovTokenSecret</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
598
|
+
<div class="tsd-comment tsd-typography"><p>Define the secret name for a specified <a href="https://codecov.io/">https://codecov.io/</a> token.</p>
|
|
599
|
+
</div>
|
|
600
|
+
<div class="tsd-comment tsd-typography">
|
|
601
|
+
<div class="tsd-tag-default">
|
|
602
|
+
<h4 class="tsd-anchor-link" id="default-20">Default<a href="#default-20" 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-4">OIDC</span><span class="hl-1"> </span><span class="hl-5">auth</span><span class="hl-1"> </span><span class="hl-5">is</span><span class="hl-1"> </span><span class="hl-5">used</span>
|
|
603
|
+
</code><button type="button">Copy</button></pre>
|
|
604
|
+
|
|
605
|
+
</div>
|
|
606
|
+
<div class="tsd-tag-stability">
|
|
607
|
+
<h4 class="tsd-anchor-link" id="stability-31">Stability<a href="#stability-31" 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>
|
|
608
|
+
</div></div></section>
|
|
609
|
+
<section class="tsd-panel tsd-member">
|
|
610
|
+
<h3 class="tsd-anchor-link" id="commitgenerated"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>commit<wbr/>Generated</span><a href="#commitgenerated" 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>
|
|
611
|
+
<div class="tsd-signature"><span class="tsd-kind-property">commitGenerated</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
612
|
+
<div class="tsd-comment tsd-typography"><p>Whether to commit the managed files by default.</p>
|
|
613
|
+
</div>
|
|
614
|
+
<div class="tsd-comment tsd-typography">
|
|
615
|
+
<div class="tsd-tag-default">
|
|
616
|
+
<h4 class="tsd-anchor-link" id="default-21">Default<a href="#default-21" 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>
|
|
617
|
+
</code><button type="button">Copy</button></pre>
|
|
618
|
+
|
|
619
|
+
</div>
|
|
620
|
+
<div class="tsd-tag-stability">
|
|
621
|
+
<h4 class="tsd-anchor-link" id="stability-32">Stability<a href="#stability-32" 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>
|
|
622
|
+
</div></div></section>
|
|
623
|
+
<section class="tsd-panel tsd-member">
|
|
624
|
+
<h3 class="tsd-anchor-link" id="copyrightowner"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>copyright<wbr/>Owner</span><a href="#copyrightowner" 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>
|
|
625
|
+
<div class="tsd-signature"><span class="tsd-kind-property">copyrightOwner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
626
|
+
<div class="tsd-comment tsd-typography"><p>License copyright owner.
|
|
627
|
+
This value is only used if the selected license text contains the
|
|
628
|
+
<code>$copyright_owner</code> placeholder. For example, it has no effect on the
|
|
629
|
+
MPL-2.0 license text.</p>
|
|
630
|
+
</div>
|
|
631
|
+
<div class="tsd-comment tsd-typography">
|
|
632
|
+
<div class="tsd-tag-default">
|
|
633
|
+
<h4 class="tsd-anchor-link" id="default-22">Default<a href="#default-22" 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>
|
|
299
634
|
<li>defaults to the value of authorName or "" if <code>authorName</code> is undefined.</li>
|
|
300
635
|
</ul>
|
|
301
|
-
</div
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
</
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
</div
|
|
636
|
+
</div>
|
|
637
|
+
<div class="tsd-tag-stability">
|
|
638
|
+
<h4 class="tsd-anchor-link" id="stability-33">Stability<a href="#stability-33" 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
|
+
</div></div></section>
|
|
640
|
+
<section class="tsd-panel tsd-member">
|
|
641
|
+
<h3 class="tsd-anchor-link" id="copyrightperiod"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>copyright<wbr/>Period</span><a href="#copyrightperiod" 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>
|
|
642
|
+
<div class="tsd-signature"><span class="tsd-kind-property">copyrightPeriod</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
643
|
+
<div class="tsd-comment tsd-typography"><p>The copyright years to put in the LICENSE file.
|
|
644
|
+
This value is only used if the selected license text contains the
|
|
645
|
+
<code>$copyright_period</code> placeholder. For example, it has no effect on the
|
|
646
|
+
MPL-2.0 license text.</p>
|
|
647
|
+
</div>
|
|
648
|
+
<div class="tsd-comment tsd-typography">
|
|
649
|
+
<div class="tsd-tag-default">
|
|
650
|
+
<h4 class="tsd-anchor-link" id="default-23">Default<a href="#default-23" 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">current</span><span class="hl-1"> </span><span class="hl-5">year</span>
|
|
651
|
+
</code><button type="button">Copy</button></pre>
|
|
652
|
+
|
|
653
|
+
</div>
|
|
654
|
+
<div class="tsd-tag-stability">
|
|
655
|
+
<h4 class="tsd-anchor-link" id="stability-34">Stability<a href="#stability-34" 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>
|
|
656
|
+
</div></div></section>
|
|
657
|
+
<section class="tsd-panel tsd-member">
|
|
658
|
+
<h3 class="tsd-anchor-link" id="defaultreleasebranch"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>default<wbr/>Release<wbr/>Branch</span><a href="#defaultreleasebranch" 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>
|
|
659
|
+
<div class="tsd-signature"><span class="tsd-kind-property">defaultReleaseBranch</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
660
|
+
<div class="tsd-comment tsd-typography"><p>The name of the main release branch.</p>
|
|
661
|
+
</div>
|
|
662
|
+
<div class="tsd-comment tsd-typography">
|
|
663
|
+
<div class="tsd-tag-default">
|
|
664
|
+
<h4 class="tsd-anchor-link" id="default-24">Default<a href="#default-24" 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">"main"</span>
|
|
665
|
+
</code><button type="button">Copy</button></pre>
|
|
666
|
+
|
|
667
|
+
</div>
|
|
668
|
+
<div class="tsd-tag-stability">
|
|
669
|
+
<h4 class="tsd-anchor-link" id="stability-35">Stability<a href="#stability-35" 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
|
+
</div>
|
|
671
|
+
<div class="tsd-tag-featured">
|
|
672
|
+
<h4 class="tsd-anchor-link" id="featured">Featured<a href="#featured" 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>true</p>
|
|
673
|
+
</div></div></section>
|
|
674
|
+
<section class="tsd-panel tsd-member">
|
|
675
|
+
<h3 class="tsd-anchor-link" id="deleteorphanedlockfiles"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>delete<wbr/>Orphaned<wbr/>Lock<wbr/>Files</span><a href="#deleteorphanedlockfiles" 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>
|
|
676
|
+
<div class="tsd-signature"><span class="tsd-kind-property">deleteOrphanedLockFiles</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
677
|
+
<div class="tsd-comment tsd-typography"><p>Automatically delete lockfiles from package managers that are not the active one.
|
|
313
678
|
Only triggered when the lockfile for the configured package
|
|
314
679
|
manager already exists.</p>
|
|
315
680
|
<p>This is useful when migrating between package managers to avoid conflicts.</p>
|
|
316
|
-
</div
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
</
|
|
681
|
+
</div>
|
|
682
|
+
<div class="tsd-comment tsd-typography">
|
|
683
|
+
<div class="tsd-tag-default">
|
|
684
|
+
<h4 class="tsd-anchor-link" id="default-25">Default<a href="#default-25" 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>
|
|
685
|
+
</code><button type="button">Copy</button></pre>
|
|
686
|
+
|
|
687
|
+
</div>
|
|
688
|
+
<div class="tsd-tag-stability">
|
|
689
|
+
<h4 class="tsd-anchor-link" id="stability-36">Stability<a href="#stability-36" 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>
|
|
690
|
+
</div></div></section>
|
|
691
|
+
<section class="tsd-panel tsd-member">
|
|
692
|
+
<h3 class="tsd-anchor-link" id="dependabot"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dependabot</span><a href="#dependabot" 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>
|
|
693
|
+
<div class="tsd-signature"><span class="tsd-kind-property">dependabot</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
694
|
+
<div class="tsd-comment tsd-typography"><p>Use dependabot to handle dependency upgrades.
|
|
321
695
|
Cannot be used in conjunction with <code>depsUpgrade</code>.</p>
|
|
322
|
-
</div
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
</
|
|
327
|
-
|
|
328
|
-
</
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
</div></div></section
|
|
696
|
+
</div>
|
|
697
|
+
<div class="tsd-comment tsd-typography">
|
|
698
|
+
<div class="tsd-tag-default">
|
|
699
|
+
<h4 class="tsd-anchor-link" id="default-26">Default<a href="#default-26" 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>
|
|
700
|
+
</code><button type="button">Copy</button></pre>
|
|
701
|
+
|
|
702
|
+
</div>
|
|
703
|
+
<div class="tsd-tag-stability">
|
|
704
|
+
<h4 class="tsd-anchor-link" id="stability-37">Stability<a href="#stability-37" 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>
|
|
705
|
+
</div></div></section>
|
|
706
|
+
<section class="tsd-panel tsd-member">
|
|
707
|
+
<h3 class="tsd-anchor-link" id="dependabotoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dependabot<wbr/>Options</span><a href="#dependabotoptions" 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>
|
|
708
|
+
<div class="tsd-signature"><span class="tsd-kind-property">dependabotOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DependabotOptions</span></div>
|
|
709
|
+
<div class="tsd-comment tsd-typography"><p>Options for dependabot.</p>
|
|
710
|
+
</div>
|
|
711
|
+
<div class="tsd-comment tsd-typography">
|
|
712
|
+
<div class="tsd-tag-default">
|
|
713
|
+
<h4 class="tsd-anchor-link" id="default-27">Default<a href="#default-27" 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>
|
|
714
|
+
</code><button type="button">Copy</button></pre>
|
|
715
|
+
|
|
716
|
+
</div>
|
|
717
|
+
<div class="tsd-tag-stability">
|
|
718
|
+
<h4 class="tsd-anchor-link" id="stability-38">Stability<a href="#stability-38" 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>
|
|
719
|
+
</div></div></section>
|
|
720
|
+
<section class="tsd-panel tsd-member">
|
|
721
|
+
<h3 class="tsd-anchor-link" id="deps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>deps</span><a href="#deps" 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>
|
|
722
|
+
<div class="tsd-signature"><span class="tsd-kind-property">deps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
723
|
+
<div class="tsd-comment tsd-typography"><p>Runtime dependencies of this module.
|
|
332
724
|
The recommendation is to only specify the module name here (e.g.
|
|
333
725
|
<code>express</code>). This will behave similar to <code>pnpm add</code> or <code>npm install</code> in the
|
|
334
726
|
sense that it will add the module as a dependency to your <code>package.json</code>
|
|
335
727
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
336
728
|
the same syntax passed to <code>pnpm add</code> or <code>npm i</code> (e.g. <code>express@^2</code>) and
|
|
337
729
|
this will be what your <code>package.json</code> will eventually include.</p>
|
|
338
|
-
</div
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
</
|
|
343
|
-
|
|
730
|
+
</div>
|
|
731
|
+
<div class="tsd-comment tsd-typography">
|
|
732
|
+
<div class="tsd-tag-default">
|
|
733
|
+
<h4 class="tsd-anchor-link" id="default-28">Default<a href="#default-28" 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>
|
|
734
|
+
</code><button type="button">Copy</button></pre>
|
|
735
|
+
|
|
736
|
+
</div>
|
|
737
|
+
<div class="tsd-tag-stability">
|
|
738
|
+
<h4 class="tsd-anchor-link" id="stability-39">Stability<a href="#stability-39" 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
|
+
</div>
|
|
740
|
+
<div class="tsd-tag-featured">
|
|
741
|
+
<h4 class="tsd-anchor-link" id="featured-1">Featured<a href="#featured-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>true</p>
|
|
742
|
+
</div></div></section>
|
|
743
|
+
<section class="tsd-panel tsd-member">
|
|
744
|
+
<h3 class="tsd-anchor-link" id="depsupgrade"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>deps<wbr/>Upgrade</span><a href="#depsupgrade" 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>
|
|
745
|
+
<div class="tsd-signature"><span class="tsd-kind-property">depsUpgrade</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
746
|
+
<div class="tsd-comment tsd-typography"><p>Use tasks and github workflows to handle dependency upgrades.
|
|
344
747
|
Cannot be used in conjunction with <code>dependabot</code>.</p>
|
|
345
|
-
</div
|
|
748
|
+
</div>
|
|
749
|
+
<div class="tsd-comment tsd-typography">
|
|
750
|
+
<div class="tsd-tag-default">
|
|
751
|
+
<h4 class="tsd-anchor-link" id="default-29">Default<a href="#default-29" 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>
|
|
346
752
|
<li><code>true</code> for root projects, <code>false</code> for subprojects</li>
|
|
347
753
|
</ul>
|
|
348
|
-
</div
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
</
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
754
|
+
</div>
|
|
755
|
+
<div class="tsd-tag-stability">
|
|
756
|
+
<h4 class="tsd-anchor-link" id="stability-40">Stability<a href="#stability-40" 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>
|
|
757
|
+
</div></div></section>
|
|
758
|
+
<section class="tsd-panel tsd-member">
|
|
759
|
+
<h3 class="tsd-anchor-link" id="depsupgradeoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>deps<wbr/>Upgrade<wbr/>Options</span><a href="#depsupgradeoptions" 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>
|
|
760
|
+
<div class="tsd-signature"><span class="tsd-kind-property">depsUpgradeOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">UpgradeDependenciesOptions</span></div>
|
|
761
|
+
<div class="tsd-comment tsd-typography"><p>Options for <code>UpgradeDependencies</code>.</p>
|
|
762
|
+
</div>
|
|
763
|
+
<div class="tsd-comment tsd-typography">
|
|
764
|
+
<div class="tsd-tag-default">
|
|
765
|
+
<h4 class="tsd-anchor-link" id="default-30">Default<a href="#default-30" 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>
|
|
766
|
+
</code><button type="button">Copy</button></pre>
|
|
767
|
+
|
|
768
|
+
</div>
|
|
769
|
+
<div class="tsd-tag-stability">
|
|
770
|
+
<h4 class="tsd-anchor-link" id="stability-41">Stability<a href="#stability-41" 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
|
+
</div></div></section>
|
|
772
|
+
<section class="tsd-panel tsd-member">
|
|
773
|
+
<h3 class="tsd-anchor-link" id="description"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>description</span><a href="#description" 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>
|
|
774
|
+
<div class="tsd-signature"><span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
775
|
+
<div class="tsd-comment tsd-typography"><p>The description is just a string that helps people understand the purpose of the package.
|
|
355
776
|
It can be used when searching for packages in a package manager as well.
|
|
356
777
|
See <a href="https://classic.yarnpkg.com/en/docs/package-json/#toc-description">https://classic.yarnpkg.com/en/docs/package-json/#toc-description</a></p>
|
|
357
|
-
</div
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
</
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
</div></div></section
|
|
778
|
+
</div>
|
|
779
|
+
<div class="tsd-comment tsd-typography">
|
|
780
|
+
<div class="tsd-tag-stability">
|
|
781
|
+
<h4 class="tsd-anchor-link" id="stability-42">Stability<a href="#stability-42" 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>
|
|
782
|
+
</div>
|
|
783
|
+
<div class="tsd-tag-featured">
|
|
784
|
+
<h4 class="tsd-anchor-link" id="featured-2">Featured<a href="#featured-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>true</p>
|
|
785
|
+
</div></div></section>
|
|
786
|
+
<section class="tsd-panel tsd-member">
|
|
787
|
+
<h3 class="tsd-anchor-link" id="devcontainer"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dev<wbr/>Container</span><a href="#devcontainer" 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>
|
|
788
|
+
<div class="tsd-signature"><span class="tsd-kind-property">devContainer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
789
|
+
<div class="tsd-comment tsd-typography"><p>Add a VSCode development environment (used for GitHub Codespaces).</p>
|
|
790
|
+
</div>
|
|
791
|
+
<div class="tsd-comment tsd-typography">
|
|
792
|
+
<div class="tsd-tag-default">
|
|
793
|
+
<h4 class="tsd-anchor-link" id="default-31">Default<a href="#default-31" 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>
|
|
794
|
+
</code><button type="button">Copy</button></pre>
|
|
795
|
+
|
|
796
|
+
</div>
|
|
797
|
+
<div class="tsd-tag-stability">
|
|
798
|
+
<h4 class="tsd-anchor-link" id="stability-43">Stability<a href="#stability-43" 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>
|
|
799
|
+
</div></div></section>
|
|
800
|
+
<section class="tsd-panel tsd-member">
|
|
801
|
+
<h3 class="tsd-anchor-link" id="devdeps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dev<wbr/>Deps</span><a href="#devdeps" 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>
|
|
802
|
+
<div class="tsd-signature"><span class="tsd-kind-property">devDeps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
803
|
+
<div class="tsd-comment tsd-typography"><p>Build dependencies for this module.
|
|
365
804
|
These dependencies will only be
|
|
366
805
|
available in your build environment but will not be fetched when this
|
|
367
806
|
module is consumed.</p>
|
|
@@ -371,133 +810,353 @@ sense that it will add the module as a dependency to your <code>package.json</co
|
|
|
371
810
|
file with the latest version (<code>^</code>). You can specify semver requirements in
|
|
372
811
|
the same syntax passed to <code>pnpm add</code> or <code>npm i</code> (e.g. <code>express@^2</code>) and
|
|
373
812
|
this will be what your <code>package.json</code> will eventually include.</p>
|
|
374
|
-
</div
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
</
|
|
379
|
-
|
|
813
|
+
</div>
|
|
814
|
+
<div class="tsd-comment tsd-typography">
|
|
815
|
+
<div class="tsd-tag-default">
|
|
816
|
+
<h4 class="tsd-anchor-link" id="default-32">Default<a href="#default-32" 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>
|
|
817
|
+
</code><button type="button">Copy</button></pre>
|
|
818
|
+
|
|
819
|
+
</div>
|
|
820
|
+
<div class="tsd-tag-stability">
|
|
821
|
+
<h4 class="tsd-anchor-link" id="stability-44">Stability<a href="#stability-44" 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>
|
|
822
|
+
</div>
|
|
823
|
+
<div class="tsd-tag-featured">
|
|
824
|
+
<h4 class="tsd-anchor-link" id="featured-3">Featured<a href="#featured-3" 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>true</p>
|
|
825
|
+
</div></div></section>
|
|
826
|
+
<section class="tsd-panel tsd-member">
|
|
827
|
+
<h3 class="tsd-anchor-link" id="devengines"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>dev<wbr/>Engines</span><a href="#devengines" 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>
|
|
828
|
+
<div class="tsd-signature"><span class="tsd-kind-property">devEngines</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">DevEngines</span></div>
|
|
829
|
+
<div class="tsd-comment tsd-typography"><p>Configure the <code>devEngines</code> field in <code>package.json</code>.
|
|
380
830
|
The <code>devEngines.packageManager</code> field is automatically populated based on
|
|
381
831
|
the resolved <code>packageManager</code> value. Any fields provided here are merged
|
|
382
832
|
with the auto-populated <code>packageManager</code> entry.</p>
|
|
383
|
-
</div
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
</code><button type="button">Copy</button></pre>
|
|
397
|
-
|
|
398
|
-
</div
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
</
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
833
|
+
</div>
|
|
834
|
+
<div class="tsd-comment tsd-typography">
|
|
835
|
+
<div class="tsd-tag-stability">
|
|
836
|
+
<h4 class="tsd-anchor-link" id="stability-45">Stability<a href="#stability-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><p>experimental</p>
|
|
837
|
+
</div></div></section>
|
|
838
|
+
<section class="tsd-panel tsd-member">
|
|
839
|
+
<h3 class="tsd-anchor-link" id="disabletsconfig"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>disable<wbr/>Tsconfig</span><a href="#disabletsconfig" 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>
|
|
840
|
+
<div class="tsd-signature"><span class="tsd-kind-property">disableTsconfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
841
|
+
<div class="tsd-comment tsd-typography"><p>Do not generate a <code>tsconfig.json</code> file (used by jsii projects since tsconfig.json is generated by the jsii compiler).</p>
|
|
842
|
+
</div>
|
|
843
|
+
<div class="tsd-comment tsd-typography">
|
|
844
|
+
<div class="tsd-tag-default">
|
|
845
|
+
<h4 class="tsd-anchor-link" id="default-33">Default<a href="#default-33" 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>
|
|
846
|
+
</code><button type="button">Copy</button></pre>
|
|
847
|
+
|
|
848
|
+
</div>
|
|
849
|
+
<div class="tsd-tag-stability">
|
|
850
|
+
<h4 class="tsd-anchor-link" id="stability-46">Stability<a href="#stability-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><p>experimental</p>
|
|
851
|
+
</div></div></section>
|
|
852
|
+
<section class="tsd-panel tsd-member">
|
|
853
|
+
<h3 class="tsd-anchor-link" id="disabletsconfigdev"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>disable<wbr/>Tsconfig<wbr/>Dev</span><a href="#disabletsconfigdev" 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>
|
|
854
|
+
<div class="tsd-signature"><span class="tsd-kind-property">disableTsconfigDev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
855
|
+
<div class="tsd-comment tsd-typography"><p>Do not generate a development tsconfig file.</p>
|
|
856
|
+
</div>
|
|
857
|
+
<div class="tsd-comment tsd-typography">
|
|
858
|
+
<div class="tsd-tag-default">
|
|
859
|
+
<h4 class="tsd-anchor-link" id="default-34">Default<a href="#default-34" 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>
|
|
860
|
+
</code><button type="button">Copy</button></pre>
|
|
861
|
+
|
|
862
|
+
</div>
|
|
863
|
+
<div class="tsd-tag-stability">
|
|
864
|
+
<h4 class="tsd-anchor-link" id="stability-47">Stability<a href="#stability-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><p>experimental</p>
|
|
865
|
+
</div></div></section>
|
|
866
|
+
<section class="tsd-panel tsd-member">
|
|
867
|
+
<h3 class="tsd-anchor-link" id="docgen"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>docgen</span><a href="#docgen" 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>
|
|
868
|
+
<div class="tsd-signature"><span class="tsd-kind-property">docgen</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
869
|
+
<div class="tsd-comment tsd-typography"><p>Docgen by Typedoc.</p>
|
|
870
|
+
</div>
|
|
871
|
+
<div class="tsd-comment tsd-typography">
|
|
872
|
+
<div class="tsd-tag-default">
|
|
873
|
+
<h4 class="tsd-anchor-link" id="default-35">Default<a href="#default-35" 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>
|
|
874
|
+
</code><button type="button">Copy</button></pre>
|
|
875
|
+
|
|
876
|
+
</div>
|
|
877
|
+
<div class="tsd-tag-stability">
|
|
878
|
+
<h4 class="tsd-anchor-link" id="stability-48">Stability<a href="#stability-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><p>experimental</p>
|
|
879
|
+
</div></div></section>
|
|
880
|
+
<section class="tsd-panel tsd-member">
|
|
881
|
+
<h3 class="tsd-anchor-link" id="docsdirectory"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>docs<wbr/>Directory</span><a href="#docsdirectory" 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>
|
|
882
|
+
<div class="tsd-signature"><span class="tsd-kind-property">docsDirectory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
883
|
+
<div class="tsd-comment tsd-typography"><p>Docs directory.</p>
|
|
884
|
+
</div>
|
|
885
|
+
<div class="tsd-comment tsd-typography">
|
|
886
|
+
<div class="tsd-tag-default">
|
|
887
|
+
<h4 class="tsd-anchor-link" id="default-36">Default<a href="#default-36" 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">"docs"</span>
|
|
888
|
+
</code><button type="button">Copy</button></pre>
|
|
889
|
+
|
|
890
|
+
</div>
|
|
891
|
+
<div class="tsd-tag-stability">
|
|
892
|
+
<h4 class="tsd-anchor-link" id="stability-49">Stability<a href="#stability-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><p>experimental</p>
|
|
893
|
+
</div></div></section>
|
|
894
|
+
<section class="tsd-panel tsd-member">
|
|
895
|
+
<h3 class="tsd-anchor-link" id="entrypoint"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>entrypoint</span><a href="#entrypoint" 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>
|
|
896
|
+
<div class="tsd-signature"><span class="tsd-kind-property">entrypoint</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
897
|
+
<div class="tsd-comment tsd-typography"><p>Module entrypoint (<code>main</code> in <code>package.json</code>).
|
|
405
898
|
Set to an empty string to not include <code>main</code> in your package.json</p>
|
|
406
|
-
</div
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
</
|
|
411
|
-
|
|
412
|
-
</
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
</div></div></section
|
|
899
|
+
</div>
|
|
900
|
+
<div class="tsd-comment tsd-typography">
|
|
901
|
+
<div class="tsd-tag-default">
|
|
902
|
+
<h4 class="tsd-anchor-link" id="default-37">Default<a href="#default-37" 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/index.js"</span>
|
|
903
|
+
</code><button type="button">Copy</button></pre>
|
|
904
|
+
|
|
905
|
+
</div>
|
|
906
|
+
<div class="tsd-tag-stability">
|
|
907
|
+
<h4 class="tsd-anchor-link" id="stability-50">Stability<a href="#stability-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><p>experimental</p>
|
|
908
|
+
</div></div></section>
|
|
909
|
+
<section class="tsd-panel tsd-member">
|
|
910
|
+
<h3 class="tsd-anchor-link" id="entrypointtypes"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>entrypoint<wbr/>Types</span><a href="#entrypointtypes" 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>
|
|
911
|
+
<div class="tsd-signature"><span class="tsd-kind-property">entrypointTypes</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
912
|
+
<div class="tsd-comment tsd-typography"><p>The .d.ts file that includes the type declarations for this module.</p>
|
|
913
|
+
</div>
|
|
914
|
+
<div class="tsd-comment tsd-typography">
|
|
915
|
+
<div class="tsd-tag-default">
|
|
916
|
+
<h4 class="tsd-anchor-link" id="default-38">Default<a href="#default-38" 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">d</span><span class="hl-1">.</span><span class="hl-5">ts</span><span class="hl-1"> </span><span class="hl-5">file</span><span class="hl-1"> </span><span class="hl-5">derived</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">project</span><span class="hl-2">'s entrypoint (usually lib/index.d.ts</span><span class="hl-9">)</span>
|
|
917
|
+
</code><button type="button">Copy</button></pre>
|
|
918
|
+
|
|
919
|
+
</div>
|
|
920
|
+
<div class="tsd-tag-stability">
|
|
921
|
+
<h4 class="tsd-anchor-link" id="stability-51">Stability<a href="#stability-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><p>experimental</p>
|
|
922
|
+
</div></div></section>
|
|
923
|
+
<section class="tsd-panel tsd-member">
|
|
924
|
+
<h3 class="tsd-anchor-link" id="github"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>github</span><a href="#github" 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>
|
|
925
|
+
<div class="tsd-signature"><span class="tsd-kind-property">github</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
926
|
+
<div class="tsd-comment tsd-typography"><p>Enable GitHub integration.
|
|
416
927
|
Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
417
|
-
</div
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
</
|
|
422
|
-
|
|
423
|
-
</
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
</div></div></section
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
</div
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
</div
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
</
|
|
444
|
-
|
|
445
|
-
</div
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
</
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
</div
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
</div
|
|
459
|
-
|
|
928
|
+
</div>
|
|
929
|
+
<div class="tsd-comment tsd-typography">
|
|
930
|
+
<div class="tsd-tag-default">
|
|
931
|
+
<h4 class="tsd-anchor-link" id="default-39">Default<a href="#default-39" 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>
|
|
932
|
+
</code><button type="button">Copy</button></pre>
|
|
933
|
+
|
|
934
|
+
</div>
|
|
935
|
+
<div class="tsd-tag-stability">
|
|
936
|
+
<h4 class="tsd-anchor-link" id="stability-52">Stability<a href="#stability-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><p>experimental</p>
|
|
937
|
+
</div></div></section>
|
|
938
|
+
<section class="tsd-panel tsd-member">
|
|
939
|
+
<h3 class="tsd-anchor-link" id="githuboptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>github<wbr/>Options</span><a href="#githuboptions" 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>
|
|
940
|
+
<div class="tsd-signature"><span class="tsd-kind-property">githubOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitHubOptions</span></div>
|
|
941
|
+
<div class="tsd-comment tsd-typography"><p>Options for GitHub integration.</p>
|
|
942
|
+
</div>
|
|
943
|
+
<div class="tsd-comment tsd-typography">
|
|
944
|
+
<div class="tsd-tag-default">
|
|
945
|
+
<h4 class="tsd-anchor-link" id="default-40">Default<a href="#default-40" 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">see</span><span class="hl-1"> </span><span class="hl-5">GitHubOptions</span>
|
|
946
|
+
</code><button type="button">Copy</button></pre>
|
|
947
|
+
|
|
948
|
+
</div>
|
|
949
|
+
<div class="tsd-tag-stability">
|
|
950
|
+
<h4 class="tsd-anchor-link" id="stability-53">Stability<a href="#stability-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><p>experimental</p>
|
|
951
|
+
</div></div></section>
|
|
952
|
+
<section class="tsd-panel tsd-member">
|
|
953
|
+
<h3 class="tsd-anchor-link" id="gitignore"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>gitignore</span><a href="#gitignore" 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>
|
|
954
|
+
<div class="tsd-signature"><span class="tsd-kind-property">gitignore</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
955
|
+
<div class="tsd-comment tsd-typography"><p>Additional entries to .gitignore.</p>
|
|
956
|
+
</div>
|
|
957
|
+
<div class="tsd-comment tsd-typography">
|
|
958
|
+
<div class="tsd-tag-stability">
|
|
959
|
+
<h4 class="tsd-anchor-link" id="stability-54">Stability<a href="#stability-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><p>experimental</p>
|
|
960
|
+
</div></div></section>
|
|
961
|
+
<section class="tsd-panel tsd-member">
|
|
962
|
+
<h3 class="tsd-anchor-link" id="gitignoreoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>git<wbr/>Ignore<wbr/>Options</span><a href="#gitignoreoptions" 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>
|
|
963
|
+
<div class="tsd-signature"><span class="tsd-kind-property">gitIgnoreOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span></div>
|
|
964
|
+
<div class="tsd-comment tsd-typography"><p>Configuration options for .gitignore file.</p>
|
|
965
|
+
</div>
|
|
966
|
+
<div class="tsd-comment tsd-typography">
|
|
967
|
+
<div class="tsd-tag-stability">
|
|
968
|
+
<h4 class="tsd-anchor-link" id="stability-55">Stability<a href="#stability-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><p>experimental</p>
|
|
969
|
+
</div></div></section>
|
|
970
|
+
<section class="tsd-panel tsd-member">
|
|
971
|
+
<h3 class="tsd-anchor-link" id="gitoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>git<wbr/>Options</span><a href="#gitoptions" 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>
|
|
972
|
+
<div class="tsd-signature"><span class="tsd-kind-property">gitOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GitOptions</span></div>
|
|
973
|
+
<div class="tsd-comment tsd-typography"><p>Configuration options for git.</p>
|
|
974
|
+
</div>
|
|
975
|
+
<div class="tsd-comment tsd-typography">
|
|
976
|
+
<div class="tsd-tag-stability">
|
|
977
|
+
<h4 class="tsd-anchor-link" id="stability-56">Stability<a href="#stability-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><p>experimental</p>
|
|
978
|
+
</div></div></section>
|
|
979
|
+
<section class="tsd-panel tsd-member">
|
|
980
|
+
<h3 class="tsd-anchor-link" id="gitpod"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>gitpod</span><a href="#gitpod" 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>
|
|
981
|
+
<div class="tsd-signature"><span class="tsd-kind-property">gitpod</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
982
|
+
<div class="tsd-comment tsd-typography"><p>Add a Gitpod development environment.</p>
|
|
983
|
+
</div>
|
|
984
|
+
<div class="tsd-comment tsd-typography">
|
|
985
|
+
<div class="tsd-tag-default">
|
|
986
|
+
<h4 class="tsd-anchor-link" id="default-41">Default<a href="#default-41" 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>
|
|
987
|
+
</code><button type="button">Copy</button></pre>
|
|
988
|
+
|
|
989
|
+
</div>
|
|
990
|
+
<div class="tsd-tag-stability">
|
|
991
|
+
<h4 class="tsd-anchor-link" id="stability-57">Stability<a href="#stability-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><p>experimental</p>
|
|
992
|
+
</div></div></section>
|
|
993
|
+
<section class="tsd-panel tsd-member">
|
|
994
|
+
<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>
|
|
995
|
+
<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>
|
|
996
|
+
<div class="tsd-comment tsd-typography"><p>Enable Homebrew component</p>
|
|
997
|
+
</div>
|
|
998
|
+
<div class="tsd-comment tsd-typography">
|
|
999
|
+
<div class="tsd-tag-default">
|
|
1000
|
+
<h4 class="tsd-anchor-link" id="default-42">Default<a href="#default-42" 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>
|
|
1001
|
+
</code><button type="button">Copy</button></pre>
|
|
1002
|
+
|
|
1003
|
+
</div></div></section>
|
|
1004
|
+
<section class="tsd-panel tsd-member">
|
|
1005
|
+
<h3 class="tsd-anchor-link" id="homebrewoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>homebrew<wbr/>Options</span><a href="#homebrewoptions" 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>
|
|
1006
|
+
<div class="tsd-signature"><span class="tsd-kind-property">homebrewOptions</span><span class="tsd-signature-symbol">?:</span> <a href="HomebrewOptions.html" class="tsd-signature-type tsd-kind-interface">HomebrewOptions</a></div>
|
|
1007
|
+
<div class="tsd-comment tsd-typography"><p>Homebrew configuration</p>
|
|
1008
|
+
</div>
|
|
1009
|
+
<div class="tsd-comment tsd-typography">
|
|
1010
|
+
<div class="tsd-tag-default">
|
|
1011
|
+
<h4 class="tsd-anchor-link" id="default-43">Default<a href="#default-43" 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">Homebrew</span><span class="hl-1"> </span><span class="hl-5">configuration</span>
|
|
1012
|
+
</code><button type="button">Copy</button></pre>
|
|
1013
|
+
|
|
1014
|
+
</div></div></section>
|
|
1015
|
+
<section class="tsd-panel tsd-member">
|
|
1016
|
+
<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>
|
|
1017
|
+
<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>
|
|
1018
|
+
<div class="tsd-comment tsd-typography"><p>Package's Homepage / Website.</p>
|
|
1019
|
+
</div>
|
|
1020
|
+
<div class="tsd-comment tsd-typography">
|
|
1021
|
+
<div class="tsd-tag-stability">
|
|
1022
|
+
<h4 class="tsd-anchor-link" id="stability-58">Stability<a href="#stability-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><p>experimental</p>
|
|
1023
|
+
</div></div></section>
|
|
1024
|
+
<section class="tsd-panel tsd-member">
|
|
1025
|
+
<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>
|
|
1026
|
+
<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>
|
|
1027
|
+
<div class="tsd-comment tsd-typography"><p>Version requirement of <code>publib</code> which is used to publish modules to npm.</p>
|
|
1028
|
+
</div>
|
|
1029
|
+
<div class="tsd-comment tsd-typography">
|
|
1030
|
+
<div class="tsd-tag-default">
|
|
1031
|
+
<h4 class="tsd-anchor-link" id="default-44">Default<a href="#default-44" 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>
|
|
1032
|
+
</code><button type="button">Copy</button></pre>
|
|
1033
|
+
|
|
1034
|
+
</div>
|
|
1035
|
+
<div class="tsd-tag-stability">
|
|
1036
|
+
<h4 class="tsd-anchor-link" id="stability-59">Stability<a href="#stability-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><p>experimental</p>
|
|
1037
|
+
</div></div></section>
|
|
1038
|
+
<section class="tsd-panel tsd-member">
|
|
1039
|
+
<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>
|
|
1040
|
+
<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>
|
|
1041
|
+
<div class="tsd-comment tsd-typography"><p>Keywords to include in <code>package.json</code>.</p>
|
|
1042
|
+
</div>
|
|
1043
|
+
<div class="tsd-comment tsd-typography">
|
|
1044
|
+
<div class="tsd-tag-stability">
|
|
1045
|
+
<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>
|
|
1046
|
+
</div></div></section>
|
|
1047
|
+
<section class="tsd-panel tsd-member">
|
|
1048
|
+
<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>
|
|
1049
|
+
<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>
|
|
1050
|
+
<div class="tsd-comment tsd-typography"><p>Typescript artifacts output directory.</p>
|
|
1051
|
+
</div>
|
|
1052
|
+
<div class="tsd-comment tsd-typography">
|
|
1053
|
+
<div class="tsd-tag-default">
|
|
1054
|
+
<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-2">"lib"</span>
|
|
1055
|
+
</code><button type="button">Copy</button></pre>
|
|
1056
|
+
|
|
1057
|
+
</div>
|
|
1058
|
+
<div class="tsd-tag-stability">
|
|
1059
|
+
<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>
|
|
1060
|
+
</div></div></section>
|
|
1061
|
+
<section class="tsd-panel tsd-member">
|
|
1062
|
+
<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>
|
|
1063
|
+
<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>
|
|
1064
|
+
<div class="tsd-comment tsd-typography"><p>License's SPDX identifier.
|
|
460
1065
|
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.
|
|
461
1066
|
Use the <code>licensed</code> option if you want to no license to be specified.</p>
|
|
462
|
-
</div
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
</
|
|
467
|
-
|
|
468
|
-
</
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
</div></div></section
|
|
472
|
-
|
|
473
|
-
</code
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
</div
|
|
1067
|
+
</div>
|
|
1068
|
+
<div class="tsd-comment tsd-typography">
|
|
1069
|
+
<div class="tsd-tag-default">
|
|
1070
|
+
<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">"Apache-2.0"</span>
|
|
1071
|
+
</code><button type="button">Copy</button></pre>
|
|
1072
|
+
|
|
1073
|
+
</div>
|
|
1074
|
+
<div class="tsd-tag-stability">
|
|
1075
|
+
<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>
|
|
1076
|
+
</div></div></section>
|
|
1077
|
+
<section class="tsd-panel tsd-member">
|
|
1078
|
+
<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>
|
|
1079
|
+
<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>
|
|
1080
|
+
<div class="tsd-comment tsd-typography"><p>Indicates if a license should be added.</p>
|
|
1081
|
+
</div>
|
|
1082
|
+
<div class="tsd-comment tsd-typography">
|
|
1083
|
+
<div class="tsd-tag-default">
|
|
1084
|
+
<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-3">true</span>
|
|
1085
|
+
</code><button type="button">Copy</button></pre>
|
|
1086
|
+
|
|
1087
|
+
</div>
|
|
1088
|
+
<div class="tsd-tag-stability">
|
|
1089
|
+
<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>
|
|
1090
|
+
</div></div></section>
|
|
1091
|
+
<section class="tsd-panel tsd-member">
|
|
1092
|
+
<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>
|
|
1093
|
+
<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>
|
|
1094
|
+
<div class="tsd-comment tsd-typography"><p>Configure logging options such as verbosity.</p>
|
|
1095
|
+
</div>
|
|
1096
|
+
<div class="tsd-comment tsd-typography">
|
|
1097
|
+
<div class="tsd-tag-default">
|
|
1098
|
+
<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-1">{}</span>
|
|
1099
|
+
</code><button type="button">Copy</button></pre>
|
|
1100
|
+
|
|
1101
|
+
</div>
|
|
1102
|
+
<div class="tsd-tag-stability">
|
|
1103
|
+
<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>
|
|
1104
|
+
</div></div></section>
|
|
1105
|
+
<section class="tsd-panel tsd-member">
|
|
1106
|
+
<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>
|
|
1107
|
+
<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>
|
|
1108
|
+
<div class="tsd-comment tsd-typography"><p>Major version to release from the default branch.
|
|
477
1109
|
If this is specified, we bump the latest version of this major version line.
|
|
478
1110
|
If not specified, we bump the global latest version.</p>
|
|
479
|
-
</div
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
</
|
|
1111
|
+
</div>
|
|
1112
|
+
<div class="tsd-comment tsd-typography">
|
|
1113
|
+
<div class="tsd-tag-default">
|
|
1114
|
+
<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-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>
|
|
1115
|
+
</code><button type="button">Copy</button></pre>
|
|
1116
|
+
|
|
1117
|
+
</div>
|
|
1118
|
+
<div class="tsd-tag-stability">
|
|
1119
|
+
<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>
|
|
1120
|
+
</div></div></section>
|
|
1121
|
+
<section class="tsd-panel tsd-member">
|
|
1122
|
+
<h3 class="tsd-anchor-link" id="maxnodeversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>max<wbr/>Node<wbr/>Version</span><a href="#maxnodeversion" 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>
|
|
1123
|
+
<div class="tsd-signature"><span class="tsd-kind-property">maxNodeVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1124
|
+
<div class="tsd-comment tsd-typography"><p>The maximum node version supported by this package. Most projects should not use this option.
|
|
484
1125
|
The value indicates that the package is incompatible with any newer versions of node.
|
|
485
1126
|
This requirement is enforced via the engines field.</p>
|
|
486
1127
|
<p>You will normally not need to set this option.
|
|
487
1128
|
Consider this option only if your package is known to not function with newer versions of node.</p>
|
|
488
|
-
</div
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
</
|
|
1129
|
+
</div>
|
|
1130
|
+
<div class="tsd-comment tsd-typography">
|
|
1131
|
+
<div class="tsd-tag-default">
|
|
1132
|
+
<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-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>
|
|
1133
|
+
</code><button type="button">Copy</button></pre>
|
|
1134
|
+
|
|
1135
|
+
</div>
|
|
1136
|
+
<div class="tsd-tag-stability">
|
|
1137
|
+
<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>
|
|
1138
|
+
</div></div></section>
|
|
1139
|
+
<section class="tsd-panel tsd-member">
|
|
1140
|
+
<h3 class="tsd-anchor-link" id="minmajorversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>min<wbr/>Major<wbr/>Version</span><a href="#minmajorversion" 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>
|
|
1141
|
+
<div class="tsd-signature"><span class="tsd-kind-property">minMajorVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
|
|
1142
|
+
<div class="tsd-comment tsd-typography"><p>Minimal Major version to release.
|
|
493
1143
|
This can be useful to set to 1, as breaking changes before the 1.x major
|
|
494
1144
|
release are not incrementing the major version number.</p>
|
|
495
1145
|
<p>Can not be set together with <code>majorVersion</code>.</p>
|
|
496
|
-
</div
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
</
|
|
1146
|
+
</div>
|
|
1147
|
+
<div class="tsd-comment tsd-typography">
|
|
1148
|
+
<div class="tsd-tag-default">
|
|
1149
|
+
<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><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>
|
|
1150
|
+
</code><button type="button">Copy</button></pre>
|
|
1151
|
+
|
|
1152
|
+
</div>
|
|
1153
|
+
<div class="tsd-tag-stability">
|
|
1154
|
+
<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>
|
|
1155
|
+
</div></div></section>
|
|
1156
|
+
<section class="tsd-panel tsd-member">
|
|
1157
|
+
<h3 class="tsd-anchor-link" id="minnodeversion"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>min<wbr/>Node<wbr/>Version</span><a href="#minnodeversion" 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>
|
|
1158
|
+
<div class="tsd-signature"><span class="tsd-kind-property">minNodeVersion</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1159
|
+
<div class="tsd-comment tsd-typography"><p>The minimum node version required by this package to function. Most projects should not use this option.
|
|
501
1160
|
The value indicates that the package is incompatible with any older versions of node.
|
|
502
1161
|
This requirement is enforced via the engines field.</p>
|
|
503
1162
|
<p>You will normally not need to set this option, even if your package is incompatible with EOL versions of node.
|
|
@@ -505,25 +1164,59 @@ Consider this option only if your package depends on a specific feature, that is
|
|
|
505
1164
|
Setting this option has very high impact on the consumers of your package,
|
|
506
1165
|
as package managers will actively prevent usage with node versions you have marked as incompatible.</p>
|
|
507
1166
|
<p>To change the node version of your CI/CD workflows, use <code>workflowNodeVersion</code>.</p>
|
|
508
|
-
</div
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
</
|
|
513
|
-
|
|
514
|
-
</
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
</div
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
</
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
</
|
|
1167
|
+
</div>
|
|
1168
|
+
<div class="tsd-comment tsd-typography">
|
|
1169
|
+
<div class="tsd-tag-default">
|
|
1170
|
+
<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">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>
|
|
1171
|
+
</code><button type="button">Copy</button></pre>
|
|
1172
|
+
|
|
1173
|
+
</div>
|
|
1174
|
+
<div class="tsd-tag-stability">
|
|
1175
|
+
<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>
|
|
1176
|
+
</div></div></section>
|
|
1177
|
+
<section class="tsd-panel tsd-member">
|
|
1178
|
+
<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>
|
|
1179
|
+
<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>
|
|
1180
|
+
<div class="tsd-comment tsd-typography"><p>Enable Mise component</p>
|
|
1181
|
+
</div>
|
|
1182
|
+
<div class="tsd-comment tsd-typography">
|
|
1183
|
+
<div class="tsd-tag-default">
|
|
1184
|
+
<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-3">true</span>
|
|
1185
|
+
</code><button type="button">Copy</button></pre>
|
|
1186
|
+
|
|
1187
|
+
</div></div></section>
|
|
1188
|
+
<section class="tsd-panel tsd-member">
|
|
1189
|
+
<h3 class="tsd-anchor-link" id="miseoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>mise<wbr/>Options</span><a href="#miseoptions" 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>
|
|
1190
|
+
<div class="tsd-signature"><span class="tsd-kind-property">miseOptions</span><span class="tsd-signature-symbol">?:</span> <a href="MiseOptions.html" class="tsd-signature-type tsd-kind-interface">MiseOptions</a></div>
|
|
1191
|
+
<div class="tsd-comment tsd-typography"><p>Mise configuration</p>
|
|
1192
|
+
</div>
|
|
1193
|
+
<div class="tsd-comment tsd-typography">
|
|
1194
|
+
<div class="tsd-tag-default">
|
|
1195
|
+
<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-7">default</span><span class="hl-1"> </span><span class="hl-5">Mise</span><span class="hl-1"> </span><span class="hl-5">configuration</span>
|
|
1196
|
+
</code><button type="button">Copy</button></pre>
|
|
1197
|
+
|
|
1198
|
+
</div></div></section>
|
|
1199
|
+
<section class="tsd-panel tsd-member">
|
|
1200
|
+
<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>
|
|
1201
|
+
<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>
|
|
1202
|
+
<div class="tsd-comment tsd-typography"><p>This is the name of your project.</p>
|
|
1203
|
+
</div>
|
|
1204
|
+
<div class="tsd-comment tsd-typography">
|
|
1205
|
+
<div class="tsd-tag-default">
|
|
1206
|
+
<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-5">$BASEDIR</span>
|
|
1207
|
+
</code><button type="button">Copy</button></pre>
|
|
1208
|
+
|
|
1209
|
+
</div>
|
|
1210
|
+
<div class="tsd-tag-stability">
|
|
1211
|
+
<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>
|
|
1212
|
+
</div>
|
|
1213
|
+
<div class="tsd-tag-featured">
|
|
1214
|
+
<h4 class="tsd-anchor-link" id="featured-4">Featured<a href="#featured-4" 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>true</p>
|
|
1215
|
+
</div></div></section>
|
|
1216
|
+
<section class="tsd-panel tsd-member">
|
|
1217
|
+
<h3 class="tsd-anchor-link" id="nextversioncommand"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>next<wbr/>Version<wbr/>Command</span><a href="#nextversioncommand" 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>
|
|
1218
|
+
<div class="tsd-signature"><span class="tsd-kind-property">nextVersionCommand</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1219
|
+
<div class="tsd-comment tsd-typography"><p>A shell command to control the next version to release.
|
|
527
1220
|
If present, this shell command will be run before the bump is executed, and
|
|
528
1221
|
it determines what version to release. It will be executed in the following
|
|
529
1222
|
environment:</p>
|
|
@@ -542,87 +1235,220 @@ with the indicated component bumped.</li>
|
|
|
542
1235
|
</ul>
|
|
543
1236
|
<p>This setting cannot be specified together with <code>minMajorVersion</code>; the invoked
|
|
544
1237
|
script can be used to achieve the effects of <code>minMajorVersion</code>.</p>
|
|
545
|
-
</div
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
</
|
|
550
|
-
|
|
1238
|
+
</div>
|
|
1239
|
+
<div class="tsd-comment tsd-typography">
|
|
1240
|
+
<div class="tsd-tag-default">
|
|
1241
|
+
<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-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>
|
|
1242
|
+
</code><button type="button">Copy</button></pre>
|
|
1243
|
+
|
|
1244
|
+
</div>
|
|
1245
|
+
<div class="tsd-tag-stability">
|
|
1246
|
+
<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>
|
|
1247
|
+
</div></div></section>
|
|
1248
|
+
<section class="tsd-panel tsd-member">
|
|
1249
|
+
<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>
|
|
1250
|
+
<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>
|
|
1251
|
+
<div class="tsd-comment tsd-typography"><p>Access level of the npm package.</p>
|
|
1252
|
+
</div>
|
|
1253
|
+
<div class="tsd-comment tsd-typography">
|
|
1254
|
+
<div class="tsd-tag-default">
|
|
1255
|
+
<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><ul>
|
|
551
1256
|
<li>for scoped packages (e.g. <code>foo@bar</code>), the default is
|
|
552
1257
|
<code>NpmAccess.RESTRICTED</code>, for non-scoped packages, the default is
|
|
553
1258
|
<code>NpmAccess.PUBLIC</code>.</li>
|
|
554
1259
|
</ul>
|
|
555
|
-
</div
|
|
556
|
-
|
|
1260
|
+
</div>
|
|
1261
|
+
<div class="tsd-tag-stability">
|
|
1262
|
+
<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>
|
|
1263
|
+
</div></div></section>
|
|
1264
|
+
<section class="tsd-panel tsd-member">
|
|
1265
|
+
<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>
|
|
1266
|
+
<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>
|
|
1267
|
+
<div class="tsd-comment tsd-typography"><p>The npmDistTag to use when publishing from the default branch.
|
|
557
1268
|
To set the npm dist-tag for release branches, set the <code>npmDistTag</code> property
|
|
558
1269
|
for each branch.</p>
|
|
559
|
-
</div
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
</
|
|
564
|
-
|
|
565
|
-
</
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
</div></div></section
|
|
569
|
-
|
|
570
|
-
|
|
1270
|
+
</div>
|
|
1271
|
+
<div class="tsd-comment tsd-typography">
|
|
1272
|
+
<div class="tsd-tag-default">
|
|
1273
|
+
<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-2">"latest"</span>
|
|
1274
|
+
</code><button type="button">Copy</button></pre>
|
|
1275
|
+
|
|
1276
|
+
</div>
|
|
1277
|
+
<div class="tsd-tag-stability">
|
|
1278
|
+
<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>
|
|
1279
|
+
</div></div></section>
|
|
1280
|
+
<section class="tsd-panel tsd-member">
|
|
1281
|
+
<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>
|
|
1282
|
+
<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>
|
|
1283
|
+
<div class="tsd-comment tsd-typography"><p>Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.</p>
|
|
1284
|
+
</div>
|
|
1285
|
+
<div class="tsd-comment tsd-typography">
|
|
1286
|
+
<div class="tsd-tag-default">
|
|
1287
|
+
<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><pre><code class="ts"><span class="hl-3">true</span>
|
|
1288
|
+
</code><button type="button">Copy</button></pre>
|
|
1289
|
+
|
|
1290
|
+
</div>
|
|
1291
|
+
<div class="tsd-tag-stability">
|
|
1292
|
+
<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>
|
|
1293
|
+
</div></div></section>
|
|
1294
|
+
<section class="tsd-panel tsd-member">
|
|
1295
|
+
<h3 class="tsd-anchor-link" id="npmignoreoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Ignore<wbr/>Options</span><a href="#npmignoreoptions" 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>
|
|
1296
|
+
<div class="tsd-signature"><span class="tsd-kind-property">npmIgnoreOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IgnoreFileOptions</span></div>
|
|
1297
|
+
<div class="tsd-comment tsd-typography"><p>Configuration options for .npmignore file.</p>
|
|
1298
|
+
</div>
|
|
1299
|
+
<div class="tsd-comment tsd-typography">
|
|
1300
|
+
<div class="tsd-tag-stability">
|
|
1301
|
+
<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>
|
|
1302
|
+
</div></div></section>
|
|
1303
|
+
<section class="tsd-panel tsd-member">
|
|
1304
|
+
<h3 class="tsd-anchor-link" id="npmprovenance"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>npm<wbr/>Provenance</span><a href="#npmprovenance" 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>
|
|
1305
|
+
<div class="tsd-signature"><span class="tsd-kind-property">npmProvenance</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1306
|
+
<div class="tsd-comment tsd-typography"><p>Should provenance statements be generated when the package is published.
|
|
571
1307
|
A supported package manager is required to publish a package with npm provenance statements and
|
|
572
1308
|
you will need to use a supported CI/CD provider.</p>
|
|
573
1309
|
<p>Note that the projen <code>Release</code> and <code>Publisher</code> components are using <code>publib</code> to publish packages,
|
|
574
1310
|
which is using npm internally and supports provenance statements independently of the package manager used.</p>
|
|
575
|
-
</div
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
</
|
|
1311
|
+
</div>
|
|
1312
|
+
<div class="tsd-comment tsd-typography">
|
|
1313
|
+
<div class="tsd-tag-default">
|
|
1314
|
+
<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-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>
|
|
1315
|
+
</code><button type="button">Copy</button></pre>
|
|
1316
|
+
|
|
1317
|
+
</div>
|
|
1318
|
+
<div class="tsd-tag-stability">
|
|
1319
|
+
<h4 class="tsd-anchor-link" id="stability-75">Stability<a href="#stability-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><p>experimental</p>
|
|
1320
|
+
</div></div></section>
|
|
1321
|
+
<section class="tsd-panel tsd-member">
|
|
1322
|
+
<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>
|
|
1323
|
+
<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>
|
|
1324
|
+
<div class="tsd-comment tsd-typography"><p>The base URL of the npm package registry.
|
|
580
1325
|
Must be a URL (e.g. start with "https://" or "http://")</p>
|
|
581
|
-
</div
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
</
|
|
586
|
-
|
|
587
|
-
</
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
</div></div></section
|
|
591
|
-
|
|
592
|
-
</code
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
</div
|
|
1326
|
+
</div>
|
|
1327
|
+
<div class="tsd-comment tsd-typography">
|
|
1328
|
+
<div class="tsd-tag-default">
|
|
1329
|
+
<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-2">"https://registry.npmjs.org"</span>
|
|
1330
|
+
</code><button type="button">Copy</button></pre>
|
|
1331
|
+
|
|
1332
|
+
</div>
|
|
1333
|
+
<div class="tsd-tag-stability">
|
|
1334
|
+
<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>
|
|
1335
|
+
</div></div></section>
|
|
1336
|
+
<section class="tsd-panel tsd-member">
|
|
1337
|
+
<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>
|
|
1338
|
+
<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>
|
|
1339
|
+
<div class="tsd-comment tsd-typography"><p>GitHub secret which contains the NPM token to use when publishing packages.</p>
|
|
1340
|
+
</div>
|
|
1341
|
+
<div class="tsd-comment tsd-typography">
|
|
1342
|
+
<div class="tsd-tag-default">
|
|
1343
|
+
<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-2">"NPM_TOKEN"</span>
|
|
1344
|
+
</code><button type="button">Copy</button></pre>
|
|
1345
|
+
|
|
1346
|
+
</div>
|
|
1347
|
+
<div class="tsd-tag-stability">
|
|
1348
|
+
<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>
|
|
1349
|
+
</div></div></section>
|
|
1350
|
+
<section class="tsd-panel tsd-member">
|
|
1351
|
+
<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>
|
|
1352
|
+
<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>
|
|
1353
|
+
<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>
|
|
1354
|
+
</div>
|
|
1355
|
+
<div class="tsd-comment tsd-typography">
|
|
1356
|
+
<div class="tsd-tag-default">
|
|
1357
|
+
<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-1">- </span><span class="hl-3">false</span>
|
|
1358
|
+
</code><button type="button">Copy</button></pre>
|
|
1359
|
+
|
|
1360
|
+
</div>
|
|
1361
|
+
<div class="tsd-tag-stability">
|
|
1362
|
+
<h4 class="tsd-anchor-link" id="stability-78">Stability<a href="#stability-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><p>experimental</p>
|
|
1363
|
+
</div></div></section>
|
|
1364
|
+
<section class="tsd-panel tsd-member">
|
|
1365
|
+
<h3 class="tsd-anchor-link" id="outdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>outdir</span><a href="#outdir" 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>
|
|
1366
|
+
<div class="tsd-signature"><span class="tsd-kind-property">outdir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1367
|
+
<div class="tsd-comment tsd-typography"><p>The root directory of the project.
|
|
596
1368
|
Relative to this directory, all files are synthesized.</p>
|
|
597
1369
|
<p>If this project has a parent, this directory is relative to the parent
|
|
598
1370
|
directory and it cannot be the same as the parent or any of it's other
|
|
599
1371
|
subprojects.</p>
|
|
600
|
-
</div
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
</
|
|
605
|
-
|
|
606
|
-
</
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
</div></div></section
|
|
610
|
-
|
|
1372
|
+
</div>
|
|
1373
|
+
<div class="tsd-comment tsd-typography">
|
|
1374
|
+
<div class="tsd-tag-default">
|
|
1375
|
+
<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">"."</span>
|
|
1376
|
+
</code><button type="button">Copy</button></pre>
|
|
1377
|
+
|
|
1378
|
+
</div>
|
|
1379
|
+
<div class="tsd-tag-stability">
|
|
1380
|
+
<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>
|
|
1381
|
+
</div></div></section>
|
|
1382
|
+
<section class="tsd-panel tsd-member">
|
|
1383
|
+
<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>
|
|
1384
|
+
<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>
|
|
1385
|
+
<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>
|
|
1386
|
+
</div>
|
|
1387
|
+
<div class="tsd-comment tsd-typography">
|
|
1388
|
+
<div class="tsd-tag-default">
|
|
1389
|
+
<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-3">true</span>
|
|
1390
|
+
</code><button type="button">Copy</button></pre>
|
|
1391
|
+
|
|
1392
|
+
</div>
|
|
1393
|
+
<div class="tsd-tag-stability">
|
|
1394
|
+
<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>
|
|
1395
|
+
</div></div></section>
|
|
1396
|
+
<section class="tsd-panel tsd-member">
|
|
1397
|
+
<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>
|
|
1398
|
+
<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>
|
|
1399
|
+
<div class="tsd-comment tsd-typography"><p>The Node Package Manager used to execute scripts.</p>
|
|
1400
|
+
</div>
|
|
1401
|
+
<div class="tsd-comment tsd-typography">
|
|
1402
|
+
<div class="tsd-tag-default">
|
|
1403
|
+
<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><ul>
|
|
611
1404
|
<li>Detected from the calling process or <code>YARN_CLASSIC</code> if detection fails.</li>
|
|
612
1405
|
</ul>
|
|
613
|
-
</div
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
</div
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
</div
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
</div
|
|
625
|
-
|
|
1406
|
+
</div>
|
|
1407
|
+
<div class="tsd-tag-stability">
|
|
1408
|
+
<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>
|
|
1409
|
+
</div>
|
|
1410
|
+
<div class="tsd-tag-pjnew">
|
|
1411
|
+
<h4 class="tsd-anchor-link" id="pjnew">Pjnew<a href="#pjnew" 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>$PACKAGE_MANAGER</p>
|
|
1412
|
+
</div></div></section>
|
|
1413
|
+
<section class="tsd-panel tsd-member">
|
|
1414
|
+
<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>
|
|
1415
|
+
<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>
|
|
1416
|
+
<div class="tsd-comment tsd-typography"><p>The "name" in package.json.</p>
|
|
1417
|
+
</div>
|
|
1418
|
+
<div class="tsd-comment tsd-typography">
|
|
1419
|
+
<div class="tsd-tag-default">
|
|
1420
|
+
<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-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>
|
|
1421
|
+
</code><button type="button">Copy</button></pre>
|
|
1422
|
+
|
|
1423
|
+
</div>
|
|
1424
|
+
<div class="tsd-tag-stability">
|
|
1425
|
+
<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>
|
|
1426
|
+
</div>
|
|
1427
|
+
<div class="tsd-tag-featured">
|
|
1428
|
+
<h4 class="tsd-anchor-link" id="featured-5">Featured<a href="#featured-5" 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>true</p>
|
|
1429
|
+
</div></div></section>
|
|
1430
|
+
<section class="tsd-panel tsd-member">
|
|
1431
|
+
<h3 class="tsd-anchor-link" id="parent"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>parent</span><a href="#parent" 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>
|
|
1432
|
+
<div class="tsd-signature"><span class="tsd-kind-property">parent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Project</span></div>
|
|
1433
|
+
<div class="tsd-comment tsd-typography"><p>The parent project, if this project is part of a bigger project.</p>
|
|
1434
|
+
</div>
|
|
1435
|
+
<div class="tsd-comment tsd-typography">
|
|
1436
|
+
<div class="tsd-tag-stability">
|
|
1437
|
+
<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>
|
|
1438
|
+
</div></div></section>
|
|
1439
|
+
<section class="tsd-panel tsd-member">
|
|
1440
|
+
<h3 class="tsd-anchor-link" id="peerdependencyoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>peer<wbr/>Dependency<wbr/>Options</span><a href="#peerdependencyoptions" 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>
|
|
1441
|
+
<div class="tsd-signature"><span class="tsd-kind-property">peerDependencyOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PeerDependencyOptions</span></div>
|
|
1442
|
+
<div class="tsd-comment tsd-typography"><p>Options for <code>peerDeps</code>.</p>
|
|
1443
|
+
</div>
|
|
1444
|
+
<div class="tsd-comment tsd-typography">
|
|
1445
|
+
<div class="tsd-tag-stability">
|
|
1446
|
+
<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>
|
|
1447
|
+
</div></div></section>
|
|
1448
|
+
<section class="tsd-panel tsd-member">
|
|
1449
|
+
<h3 class="tsd-anchor-link" id="peerdeps"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>peer<wbr/>Deps</span><a href="#peerdeps" 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>
|
|
1450
|
+
<div class="tsd-signature"><span class="tsd-kind-property">peerDeps</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
1451
|
+
<div class="tsd-comment tsd-typography"><p>Peer dependencies for this module.
|
|
626
1452
|
Dependencies listed here are required to
|
|
627
1453
|
be installed (and satisfied) by the <em>consumer</em> of this library. Using peer
|
|
628
1454
|
dependencies allows you to ensure that only a single module of a certain
|
|
@@ -634,309 +1460,877 @@ breaking change for your customers.</p>
|
|
|
634
1460
|
enabled by default), projen will automatically add a dev dependency with a
|
|
635
1461
|
pinned version for each peer dependency. This will ensure that you build &
|
|
636
1462
|
test your module against the lowest peer version required.</p>
|
|
637
|
-
</div
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
</
|
|
642
|
-
|
|
643
|
-
</
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
</div></div></section
|
|
647
|
-
|
|
648
|
-
</code
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
</div
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
</
|
|
656
|
-
|
|
657
|
-
</div
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
</div
|
|
661
|
-
|
|
1463
|
+
</div>
|
|
1464
|
+
<div class="tsd-comment tsd-typography">
|
|
1465
|
+
<div class="tsd-tag-default">
|
|
1466
|
+
<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-1">[]</span>
|
|
1467
|
+
</code><button type="button">Copy</button></pre>
|
|
1468
|
+
|
|
1469
|
+
</div>
|
|
1470
|
+
<div class="tsd-tag-stability">
|
|
1471
|
+
<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>
|
|
1472
|
+
</div></div></section>
|
|
1473
|
+
<section class="tsd-panel tsd-member">
|
|
1474
|
+
<h3 class="tsd-anchor-link" id="pnpmoptions"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>pnpm<wbr/>Options</span><a href="#pnpmoptions" 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>
|
|
1475
|
+
<div class="tsd-signature"><span class="tsd-kind-property">pnpmOptions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PnpmOptions</span></div>
|
|
1476
|
+
<div class="tsd-comment tsd-typography"><p>Options for pnpm.</p>
|
|
1477
|
+
</div>
|
|
1478
|
+
<div class="tsd-comment tsd-typography">
|
|
1479
|
+
<div class="tsd-tag-default">
|
|
1480
|
+
<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">all</span><span class="hl-1"> </span><span class="hl-7">default</span><span class="hl-1"> </span><span class="hl-5">options</span>
|
|
1481
|
+
</code><button type="button">Copy</button></pre>
|
|
1482
|
+
|
|
1483
|
+
</div>
|
|
1484
|
+
<div class="tsd-tag-stability">
|
|
1485
|
+
<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>
|
|
1486
|
+
</div></div></section>
|
|
1487
|
+
<section class="tsd-panel tsd-member">
|
|
1488
|
+
<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>
|
|
1489
|
+
<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>
|
|
1490
|
+
<div class="tsd-comment tsd-typography"><p>The version of PNPM to use if using PNPM as a package manager.</p>
|
|
1491
|
+
</div>
|
|
1492
|
+
<div class="tsd-comment tsd-typography">
|
|
1493
|
+
<div class="tsd-tag-default">
|
|
1494
|
+
<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-2">"10.33.0"</span>
|
|
1495
|
+
</code><button type="button">Copy</button></pre>
|
|
1496
|
+
|
|
1497
|
+
</div>
|
|
1498
|
+
<div class="tsd-tag-stability">
|
|
1499
|
+
<h4 class="tsd-anchor-link" id="stability-87">Stability<a href="#stability-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><p>experimental</p>
|
|
1500
|
+
</div></div></section>
|
|
1501
|
+
<section class="tsd-panel tsd-member">
|
|
1502
|
+
<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>
|
|
1503
|
+
<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>
|
|
1504
|
+
<div class="tsd-comment tsd-typography"><p>Steps to execute after build as part of the release workflow.</p>
|
|
1505
|
+
</div>
|
|
1506
|
+
<div class="tsd-comment tsd-typography">
|
|
1507
|
+
<div class="tsd-tag-default">
|
|
1508
|
+
<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-1">[]</span>
|
|
1509
|
+
</code><button type="button">Copy</button></pre>
|
|
1510
|
+
|
|
1511
|
+
</div>
|
|
1512
|
+
<div class="tsd-tag-stability">
|
|
1513
|
+
<h4 class="tsd-anchor-link" id="stability-88">Stability<a href="#stability-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><p>experimental</p>
|
|
1514
|
+
</div></div></section>
|
|
1515
|
+
<section class="tsd-panel tsd-member">
|
|
1516
|
+
<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>
|
|
1517
|
+
<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>
|
|
1518
|
+
<div class="tsd-comment tsd-typography"><p>Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").</p>
|
|
1519
|
+
</div>
|
|
1520
|
+
<div class="tsd-comment tsd-typography">
|
|
1521
|
+
<div class="tsd-tag-default">
|
|
1522
|
+
<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><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>
|
|
1523
|
+
</code><button type="button">Copy</button></pre>
|
|
1524
|
+
|
|
1525
|
+
</div>
|
|
1526
|
+
<div class="tsd-tag-stability">
|
|
1527
|
+
<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>
|
|
1528
|
+
</div></div></section>
|
|
1529
|
+
<section class="tsd-panel tsd-member">
|
|
1530
|
+
<h3 class="tsd-anchor-link" id="projecttree"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>project<wbr/>Tree</span><a href="#projecttree" 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>
|
|
1531
|
+
<div class="tsd-signature"><span class="tsd-kind-property">projectTree</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
1532
|
+
<div class="tsd-comment tsd-typography"><p>Generate a project tree file (<code>.projen/tree.json</code>) that shows all components and their relationships. Useful for understanding your project structure and debugging.</p>
|
|
1533
|
+
</div>
|
|
1534
|
+
<div class="tsd-comment tsd-typography">
|
|
1535
|
+
<div class="tsd-tag-default">
|
|
1536
|
+
<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-3">false</span>
|
|
1537
|
+
</code><button type="button">Copy</button></pre>
|
|
1538
|
+
|
|
1539
|
+
</div>
|
|
1540
|
+
<div class="tsd-tag-stability">
|
|
1541
|
+
<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>
|
|
1542
|
+
</div></div></section>
|
|
1543
|
+
<section class="tsd-panel tsd-member">
|
|
1544
|
+
<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>
|
|
1545
|
+
<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>
|
|
1546
|
+
<div class="tsd-comment tsd-typography"><p>The shell command to use in order to run the projen CLI.
|
|
662
1547
|
Can be used to customize in special environments.</p>
|
|
663
|
-
</div
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
</
|
|
668
|
-
|
|
669
|
-
</
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
</div></div></section
|
|
673
|
-
|
|
674
|
-
</code
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
</div
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
</
|
|
682
|
-
|
|
683
|
-
</div
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
</div
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
</
|
|
690
|
-
|
|
691
|
-
</div
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
</div
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
</div
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
</
|
|
710
|
-
|
|
711
|
-
</div
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
</div
|
|
715
|
-
|
|
1548
|
+
</div>
|
|
1549
|
+
<div class="tsd-comment tsd-typography">
|
|
1550
|
+
<div class="tsd-tag-default">
|
|
1551
|
+
<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>
|
|
1552
|
+
</code><button type="button">Copy</button></pre>
|
|
1553
|
+
|
|
1554
|
+
</div>
|
|
1555
|
+
<div class="tsd-tag-stability">
|
|
1556
|
+
<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>
|
|
1557
|
+
</div></div></section>
|
|
1558
|
+
<section class="tsd-panel tsd-member">
|
|
1559
|
+
<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>
|
|
1560
|
+
<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>
|
|
1561
|
+
<div class="tsd-comment tsd-typography"><p>Choose a method of providing GitHub API access for projen workflows.</p>
|
|
1562
|
+
</div>
|
|
1563
|
+
<div class="tsd-comment tsd-typography">
|
|
1564
|
+
<div class="tsd-tag-default">
|
|
1565
|
+
<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>
|
|
1566
|
+
</code><button type="button">Copy</button></pre>
|
|
1567
|
+
|
|
1568
|
+
</div>
|
|
1569
|
+
<div class="tsd-tag-stability">
|
|
1570
|
+
<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>
|
|
1571
|
+
</div></div></section>
|
|
1572
|
+
<section class="tsd-panel tsd-member">
|
|
1573
|
+
<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>
|
|
1574
|
+
<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>
|
|
1575
|
+
<div class="tsd-comment tsd-typography"><p>Indicates of "projen" should be installed as a devDependency.</p>
|
|
1576
|
+
</div>
|
|
1577
|
+
<div class="tsd-comment tsd-typography">
|
|
1578
|
+
<div class="tsd-tag-default">
|
|
1579
|
+
<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>
|
|
1580
|
+
</code><button type="button">Copy</button></pre>
|
|
1581
|
+
|
|
1582
|
+
</div>
|
|
1583
|
+
<div class="tsd-tag-stability">
|
|
1584
|
+
<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>
|
|
1585
|
+
</div></div></section>
|
|
1586
|
+
<section class="tsd-panel tsd-member">
|
|
1587
|
+
<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>
|
|
1588
|
+
<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>
|
|
1589
|
+
<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>
|
|
1590
|
+
</div>
|
|
1591
|
+
<div class="tsd-comment tsd-typography">
|
|
1592
|
+
<div class="tsd-tag-default">
|
|
1593
|
+
<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>
|
|
1594
|
+
</code><button type="button">Copy</button></pre>
|
|
1595
|
+
|
|
1596
|
+
</div>
|
|
1597
|
+
<div class="tsd-tag-stability">
|
|
1598
|
+
<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>
|
|
1599
|
+
</div></div></section>
|
|
1600
|
+
<section class="tsd-panel tsd-member">
|
|
1601
|
+
<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>
|
|
1602
|
+
<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>
|
|
1603
|
+
<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>
|
|
1604
|
+
</div>
|
|
1605
|
+
<div class="tsd-comment tsd-typography">
|
|
1606
|
+
<div class="tsd-tag-default">
|
|
1607
|
+
<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>
|
|
1608
|
+
</code><button type="button">Copy</button></pre>
|
|
1609
|
+
|
|
1610
|
+
</div>
|
|
1611
|
+
<div class="tsd-tag-stability">
|
|
1612
|
+
<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>
|
|
1613
|
+
</div></div></section>
|
|
1614
|
+
<section class="tsd-panel tsd-member">
|
|
1615
|
+
<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>
|
|
1616
|
+
<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>
|
|
1617
|
+
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.json.</p>
|
|
1618
|
+
</div>
|
|
1619
|
+
<div class="tsd-comment tsd-typography">
|
|
1620
|
+
<div class="tsd-tag-default">
|
|
1621
|
+
<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>
|
|
1622
|
+
</code><button type="button">Copy</button></pre>
|
|
1623
|
+
|
|
1624
|
+
</div>
|
|
1625
|
+
<div class="tsd-tag-stability">
|
|
1626
|
+
<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>
|
|
1627
|
+
</div></div></section>
|
|
1628
|
+
<section class="tsd-panel tsd-member">
|
|
1629
|
+
<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>
|
|
1630
|
+
<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>
|
|
1631
|
+
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.js.</p>
|
|
1632
|
+
</div>
|
|
1633
|
+
<div class="tsd-comment tsd-typography">
|
|
1634
|
+
<div class="tsd-tag-default">
|
|
1635
|
+
<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>
|
|
1636
|
+
</code><button type="button">Copy</button></pre>
|
|
1637
|
+
|
|
1638
|
+
</div>
|
|
1639
|
+
<div class="tsd-tag-stability">
|
|
1640
|
+
<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>
|
|
1641
|
+
</div></div></section>
|
|
1642
|
+
<section class="tsd-panel tsd-member">
|
|
1643
|
+
<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>
|
|
1644
|
+
<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>
|
|
1645
|
+
<div class="tsd-comment tsd-typography"><p>Use TypeScript for your projenrc file (<code>.projenrc.ts</code>).</p>
|
|
1646
|
+
</div>
|
|
1647
|
+
<div class="tsd-comment tsd-typography">
|
|
1648
|
+
<div class="tsd-tag-default">
|
|
1649
|
+
<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>
|
|
1650
|
+
</code><button type="button">Copy</button></pre>
|
|
1651
|
+
|
|
1652
|
+
</div>
|
|
1653
|
+
<div class="tsd-tag-stability">
|
|
1654
|
+
<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>
|
|
1655
|
+
</div>
|
|
1656
|
+
<div class="tsd-tag-pjnew">
|
|
1657
|
+
<h4 class="tsd-anchor-link" id="pjnew-1">Pjnew<a href="#pjnew-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>true</p>
|
|
1658
|
+
</div></div></section>
|
|
1659
|
+
<section class="tsd-panel tsd-member">
|
|
1660
|
+
<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>
|
|
1661
|
+
<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>
|
|
1662
|
+
<div class="tsd-comment tsd-typography"><p>Options for .projenrc.ts.</p>
|
|
1663
|
+
</div>
|
|
1664
|
+
<div class="tsd-comment tsd-typography">
|
|
1665
|
+
<div class="tsd-tag-stability">
|
|
1666
|
+
<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>
|
|
1667
|
+
</div></div></section>
|
|
1668
|
+
<section class="tsd-panel tsd-member">
|
|
1669
|
+
<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>
|
|
1670
|
+
<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>
|
|
1671
|
+
<div class="tsd-comment tsd-typography"><p>Version of projen to install.</p>
|
|
1672
|
+
</div>
|
|
1673
|
+
<div class="tsd-comment tsd-typography">
|
|
1674
|
+
<div class="tsd-tag-default">
|
|
1675
|
+
<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>
|
|
1676
|
+
</code><button type="button">Copy</button></pre>
|
|
1677
|
+
|
|
1678
|
+
</div>
|
|
1679
|
+
<div class="tsd-tag-stability">
|
|
1680
|
+
<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>
|
|
1681
|
+
</div></div></section>
|
|
1682
|
+
<section class="tsd-panel tsd-member">
|
|
1683
|
+
<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>
|
|
1684
|
+
<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>
|
|
1685
|
+
<div class="tsd-comment tsd-typography"><p>Instead of actually publishing to package managers, just print the publishing command.</p>
|
|
1686
|
+
</div>
|
|
1687
|
+
<div class="tsd-comment tsd-typography">
|
|
1688
|
+
<div class="tsd-tag-default">
|
|
1689
|
+
<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>
|
|
1690
|
+
</code><button type="button">Copy</button></pre>
|
|
1691
|
+
|
|
1692
|
+
</div>
|
|
1693
|
+
<div class="tsd-tag-stability">
|
|
1694
|
+
<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>
|
|
1695
|
+
</div></div></section>
|
|
1696
|
+
<section class="tsd-panel tsd-member">
|
|
1697
|
+
<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>
|
|
1698
|
+
<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>
|
|
1699
|
+
<div class="tsd-comment tsd-typography"><p>Define publishing tasks that can be executed manually as well as workflows.
|
|
716
1700
|
Normally, publishing only happens within automated workflows. Enable this
|
|
717
1701
|
in order to create a publishing task for each publishing activity.</p>
|
|
718
|
-
</div
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
</
|
|
723
|
-
|
|
724
|
-
</
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
</div></div></section
|
|
728
|
-
|
|
729
|
-
</code
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
</div
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
</
|
|
737
|
-
|
|
738
|
-
</div
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
</div
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
</
|
|
745
|
-
|
|
746
|
-
</div
|
|
747
|
-
|
|
1702
|
+
</div>
|
|
1703
|
+
<div class="tsd-comment tsd-typography">
|
|
1704
|
+
<div class="tsd-tag-default">
|
|
1705
|
+
<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>
|
|
1706
|
+
</code><button type="button">Copy</button></pre>
|
|
1707
|
+
|
|
1708
|
+
</div>
|
|
1709
|
+
<div class="tsd-tag-stability">
|
|
1710
|
+
<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>
|
|
1711
|
+
</div></div></section>
|
|
1712
|
+
<section class="tsd-panel tsd-member">
|
|
1713
|
+
<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>
|
|
1714
|
+
<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>
|
|
1715
|
+
<div class="tsd-comment tsd-typography"><p>Include a GitHub pull request template.</p>
|
|
1716
|
+
</div>
|
|
1717
|
+
<div class="tsd-comment tsd-typography">
|
|
1718
|
+
<div class="tsd-tag-default">
|
|
1719
|
+
<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-3">true</span>
|
|
1720
|
+
</code><button type="button">Copy</button></pre>
|
|
1721
|
+
|
|
1722
|
+
</div>
|
|
1723
|
+
<div class="tsd-tag-stability">
|
|
1724
|
+
<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>
|
|
1725
|
+
</div></div></section>
|
|
1726
|
+
<section class="tsd-panel tsd-member">
|
|
1727
|
+
<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>
|
|
1728
|
+
<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>
|
|
1729
|
+
<div class="tsd-comment tsd-typography"><p>The contents of the pull request template.</p>
|
|
1730
|
+
</div>
|
|
1731
|
+
<div class="tsd-comment tsd-typography">
|
|
1732
|
+
<div class="tsd-tag-default">
|
|
1733
|
+
<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-7">default</span><span class="hl-1"> </span><span class="hl-5">content</span>
|
|
1734
|
+
</code><button type="button">Copy</button></pre>
|
|
1735
|
+
|
|
1736
|
+
</div>
|
|
1737
|
+
<div class="tsd-tag-stability">
|
|
1738
|
+
<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>
|
|
1739
|
+
</div></div></section>
|
|
1740
|
+
<section class="tsd-panel tsd-member">
|
|
1741
|
+
<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>
|
|
1742
|
+
<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>
|
|
1743
|
+
<div class="tsd-comment tsd-typography"><p>The README setup.</p>
|
|
1744
|
+
</div>
|
|
1745
|
+
<div class="tsd-comment tsd-typography">
|
|
1746
|
+
<div class="tsd-tag-default">
|
|
1747
|
+
<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-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>
|
|
1748
|
+
</code><button type="button">Copy</button></pre>
|
|
1749
|
+
|
|
1750
|
+
</div>
|
|
1751
|
+
<div class="tsd-tag-stability">
|
|
1752
|
+
<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>
|
|
1753
|
+
</div></div></section>
|
|
1754
|
+
<section class="tsd-panel tsd-member">
|
|
1755
|
+
<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>
|
|
1756
|
+
<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>
|
|
1757
|
+
<div class="tsd-comment tsd-typography"><p>Find commits that should be considered releasable Used to decide if a release is required.</p>
|
|
1758
|
+
</div>
|
|
1759
|
+
<div class="tsd-comment tsd-typography">
|
|
1760
|
+
<div class="tsd-tag-default">
|
|
1761
|
+
<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-5">ReleasableCommits</span><span class="hl-1">.</span><span class="hl-0">everyCommit</span><span class="hl-1">()</span>
|
|
1762
|
+
</code><button type="button">Copy</button></pre>
|
|
1763
|
+
|
|
1764
|
+
</div>
|
|
1765
|
+
<div class="tsd-tag-stability">
|
|
1766
|
+
<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>
|
|
1767
|
+
</div></div></section>
|
|
1768
|
+
<section class="tsd-panel tsd-member">
|
|
1769
|
+
<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>
|
|
1770
|
+
<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>
|
|
1771
|
+
<div class="tsd-comment tsd-typography"><p>Add release management to this project.</p>
|
|
1772
|
+
</div>
|
|
1773
|
+
<div class="tsd-comment tsd-typography">
|
|
1774
|
+
<div class="tsd-tag-default">
|
|
1775
|
+
<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-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>
|
|
1776
|
+
</code><button type="button">Copy</button></pre>
|
|
1777
|
+
|
|
1778
|
+
</div>
|
|
1779
|
+
<div class="tsd-tag-stability">
|
|
1780
|
+
<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>
|
|
1781
|
+
</div></div></section>
|
|
1782
|
+
<section class="tsd-panel tsd-member">
|
|
1783
|
+
<h3 class="tsd-anchor-link" id="releasebranches"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Branches</span><a href="#releasebranches" 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>
|
|
1784
|
+
<div class="tsd-signature"><span class="tsd-kind-property">releaseBranches</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">BranchOptions</span><span class="tsd-signature-symbol">></span></div>
|
|
1785
|
+
<div class="tsd-comment tsd-typography"><p>Defines additional release branches.
|
|
748
1786
|
A workflow will be created for each
|
|
749
1787
|
release branch which will publish releases from commits in this branch.
|
|
750
1788
|
Each release branch <em>must</em> be assigned a major version number which is used
|
|
751
1789
|
to enforce that versions published from that branch always use that major
|
|
752
1790
|
version. If multiple branches are used, the <code>majorVersion</code> field must also
|
|
753
1791
|
be provided for the default branch.</p>
|
|
754
|
-
</div
|
|
1792
|
+
</div>
|
|
1793
|
+
<div class="tsd-comment tsd-typography">
|
|
1794
|
+
<div class="tsd-tag-default">
|
|
1795
|
+
<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><ul>
|
|
755
1796
|
<li>no additional branches are used for release. you can use
|
|
756
1797
|
<code>addBranch()</code> to add additional branches.</li>
|
|
757
1798
|
</ul>
|
|
758
|
-
</div
|
|
759
|
-
|
|
1799
|
+
</div>
|
|
1800
|
+
<div class="tsd-tag-stability">
|
|
1801
|
+
<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>
|
|
1802
|
+
</div></div></section>
|
|
1803
|
+
<section class="tsd-panel tsd-member">
|
|
1804
|
+
<h3 class="tsd-anchor-link" id="releaseenvironment"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Environment</span><a href="#releaseenvironment" 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>
|
|
1805
|
+
<div class="tsd-signature"><span class="tsd-kind-property">releaseEnvironment</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1806
|
+
<div class="tsd-comment tsd-typography"><p>The GitHub Actions environment used for the release.
|
|
760
1807
|
This can be used to add an explicit approval step to the release
|
|
761
1808
|
or limit who can initiate a release through environment protection rules.</p>
|
|
762
1809
|
<p>When multiple artifacts are released, the environment can be overwritten
|
|
763
1810
|
on a per artifact basis.</p>
|
|
764
|
-
</div
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
</
|
|
769
|
-
|
|
770
|
-
</
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
</div></div></section
|
|
1811
|
+
</div>
|
|
1812
|
+
<div class="tsd-comment tsd-typography">
|
|
1813
|
+
<div class="tsd-tag-default">
|
|
1814
|
+
<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-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>
|
|
1815
|
+
</code><button type="button">Copy</button></pre>
|
|
1816
|
+
|
|
1817
|
+
</div>
|
|
1818
|
+
<div class="tsd-tag-stability">
|
|
1819
|
+
<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>
|
|
1820
|
+
</div></div></section>
|
|
1821
|
+
<section class="tsd-panel tsd-member">
|
|
1822
|
+
<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>
|
|
1823
|
+
<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>
|
|
1824
|
+
<div class="tsd-comment tsd-typography"><p>Create a github issue on every failed publishing task.</p>
|
|
1825
|
+
</div>
|
|
1826
|
+
<div class="tsd-comment tsd-typography">
|
|
1827
|
+
<div class="tsd-tag-default">
|
|
1828
|
+
<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-3">false</span>
|
|
1829
|
+
</code><button type="button">Copy</button></pre>
|
|
1830
|
+
|
|
1831
|
+
</div>
|
|
1832
|
+
<div class="tsd-tag-stability">
|
|
1833
|
+
<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>
|
|
1834
|
+
</div></div></section>
|
|
1835
|
+
<section class="tsd-panel tsd-member">
|
|
1836
|
+
<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>
|
|
1837
|
+
<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>
|
|
1838
|
+
<div class="tsd-comment tsd-typography"><p>The label to apply to issues indicating publish failures.
|
|
774
1839
|
Only applies if <code>releaseFailureIssue</code> is true.</p>
|
|
775
|
-
</div
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
</
|
|
1840
|
+
</div>
|
|
1841
|
+
<div class="tsd-comment tsd-typography">
|
|
1842
|
+
<div class="tsd-tag-default">
|
|
1843
|
+
<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-2">"failed-release"</span>
|
|
1844
|
+
</code><button type="button">Copy</button></pre>
|
|
1845
|
+
|
|
1846
|
+
</div>
|
|
1847
|
+
<div class="tsd-tag-stability">
|
|
1848
|
+
<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>
|
|
1849
|
+
</div></div></section>
|
|
1850
|
+
<section class="tsd-panel tsd-member">
|
|
1851
|
+
<h3 class="tsd-anchor-link" id="releasetagprefix"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>release<wbr/>Tag<wbr/>Prefix</span><a href="#releasetagprefix" 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>
|
|
1852
|
+
<div class="tsd-signature"><span class="tsd-kind-property">releaseTagPrefix</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1853
|
+
<div class="tsd-comment tsd-typography"><p>Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
|
|
780
1854
|
Note: this prefix is used to detect the latest tagged version
|
|
781
1855
|
when bumping, so if you change this on a project with an existing version
|
|
782
1856
|
history, you may need to manually tag your latest release
|
|
783
1857
|
with the new prefix.</p>
|
|
784
|
-
</div
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
</
|
|
789
|
-
|
|
790
|
-
</
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
</div></div></section
|
|
794
|
-
|
|
1858
|
+
</div>
|
|
1859
|
+
<div class="tsd-comment tsd-typography">
|
|
1860
|
+
<div class="tsd-tag-default">
|
|
1861
|
+
<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><pre><code class="ts"><span class="hl-2">"v"</span>
|
|
1862
|
+
</code><button type="button">Copy</button></pre>
|
|
1863
|
+
|
|
1864
|
+
</div>
|
|
1865
|
+
<div class="tsd-tag-stability">
|
|
1866
|
+
<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>
|
|
1867
|
+
</div></div></section>
|
|
1868
|
+
<section class="tsd-panel tsd-member">
|
|
1869
|
+
<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>
|
|
1870
|
+
<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>
|
|
1871
|
+
<div class="tsd-comment tsd-typography"><p>Automatically release to npm when new versions are introduced.</p>
|
|
1872
|
+
</div>
|
|
1873
|
+
<div class="tsd-comment tsd-typography">
|
|
1874
|
+
<div class="tsd-tag-default">
|
|
1875
|
+
<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-3">false</span>
|
|
1876
|
+
</code><button type="button">Copy</button></pre>
|
|
1877
|
+
|
|
1878
|
+
</div>
|
|
1879
|
+
<div class="tsd-tag-stability">
|
|
1880
|
+
<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>
|
|
1881
|
+
</div></div></section>
|
|
1882
|
+
<section class="tsd-panel tsd-member">
|
|
1883
|
+
<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>
|
|
1884
|
+
<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>
|
|
1885
|
+
<div class="tsd-comment tsd-typography"><p>The release trigger to use.</p>
|
|
1886
|
+
</div>
|
|
1887
|
+
<div class="tsd-comment tsd-typography">
|
|
1888
|
+
<div class="tsd-tag-default">
|
|
1889
|
+
<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><ul>
|
|
795
1890
|
<li>Continuous releases (<code>ReleaseTrigger.continuous()</code>)</li>
|
|
796
1891
|
</ul>
|
|
797
|
-
</div
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
</
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
</
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
</
|
|
810
|
-
|
|
811
|
-
</div
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
</div
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
</
|
|
818
|
-
|
|
819
|
-
</div
|
|
820
|
-
|
|
1892
|
+
</div>
|
|
1893
|
+
<div class="tsd-tag-stability">
|
|
1894
|
+
<h4 class="tsd-anchor-link" id="stability-114">Stability<a href="#stability-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><p>experimental</p>
|
|
1895
|
+
</div></div></section>
|
|
1896
|
+
<section class="tsd-panel tsd-member">
|
|
1897
|
+
<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>
|
|
1898
|
+
<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>
|
|
1899
|
+
<div class="tsd-comment tsd-typography"><p>Build environment variables for release workflows.</p>
|
|
1900
|
+
</div>
|
|
1901
|
+
<div class="tsd-comment tsd-typography">
|
|
1902
|
+
<div class="tsd-tag-default">
|
|
1903
|
+
<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-1">{}</span>
|
|
1904
|
+
</code><button type="button">Copy</button></pre>
|
|
1905
|
+
|
|
1906
|
+
</div>
|
|
1907
|
+
<div class="tsd-tag-stability">
|
|
1908
|
+
<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>
|
|
1909
|
+
</div></div></section>
|
|
1910
|
+
<section class="tsd-panel tsd-member">
|
|
1911
|
+
<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>
|
|
1912
|
+
<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>
|
|
1913
|
+
<div class="tsd-comment tsd-typography"><p>The name of the default release workflow.</p>
|
|
1914
|
+
</div>
|
|
1915
|
+
<div class="tsd-comment tsd-typography">
|
|
1916
|
+
<div class="tsd-tag-default">
|
|
1917
|
+
<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">"release"</span>
|
|
1918
|
+
</code><button type="button">Copy</button></pre>
|
|
1919
|
+
|
|
1920
|
+
</div>
|
|
1921
|
+
<div class="tsd-tag-stability">
|
|
1922
|
+
<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>
|
|
1923
|
+
</div></div></section>
|
|
1924
|
+
<section class="tsd-panel tsd-member">
|
|
1925
|
+
<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>
|
|
1926
|
+
<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>
|
|
1927
|
+
<div class="tsd-comment tsd-typography"><p>A set of workflow steps to execute in order to setup the workflow container.</p>
|
|
1928
|
+
</div>
|
|
1929
|
+
<div class="tsd-comment tsd-typography">
|
|
1930
|
+
<div class="tsd-tag-stability">
|
|
1931
|
+
<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>
|
|
1932
|
+
</div></div></section>
|
|
1933
|
+
<section class="tsd-panel tsd-member">
|
|
1934
|
+
<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>
|
|
1935
|
+
<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>
|
|
1936
|
+
<div class="tsd-comment tsd-typography"><p>Use renovatebot to handle dependency upgrades.</p>
|
|
1937
|
+
</div>
|
|
1938
|
+
<div class="tsd-comment tsd-typography">
|
|
1939
|
+
<div class="tsd-tag-default">
|
|
1940
|
+
<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>
|
|
1941
|
+
</code><button type="button">Copy</button></pre>
|
|
1942
|
+
|
|
1943
|
+
</div>
|
|
1944
|
+
<div class="tsd-tag-stability">
|
|
1945
|
+
<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>
|
|
1946
|
+
</div></div></section>
|
|
1947
|
+
<section class="tsd-panel tsd-member">
|
|
1948
|
+
<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>
|
|
1949
|
+
<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>
|
|
1950
|
+
<div class="tsd-comment tsd-typography"><p>Options for renovatebot.</p>
|
|
1951
|
+
</div>
|
|
1952
|
+
<div class="tsd-comment tsd-typography">
|
|
1953
|
+
<div class="tsd-tag-default">
|
|
1954
|
+
<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><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>
|
|
1955
|
+
</code><button type="button">Copy</button></pre>
|
|
1956
|
+
|
|
1957
|
+
</div>
|
|
1958
|
+
<div class="tsd-tag-stability">
|
|
1959
|
+
<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>
|
|
1960
|
+
</div></div></section>
|
|
1961
|
+
<section class="tsd-panel tsd-member">
|
|
1962
|
+
<h3 class="tsd-anchor-link" id="repository"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>repository</span><a href="#repository" 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>
|
|
1963
|
+
<div class="tsd-signature"><span class="tsd-kind-property">repository</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
1964
|
+
<div class="tsd-comment tsd-typography"><p>The repository is the location where the actual code for your package lives.
|
|
821
1965
|
See <a href="https://classic.yarnpkg.com/en/docs/package-json/#toc-repository">https://classic.yarnpkg.com/en/docs/package-json/#toc-repository</a></p>
|
|
822
|
-
</div
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
</div
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
</div
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
</div></div></section
|
|
836
|
-
|
|
837
|
-
|
|
1966
|
+
</div>
|
|
1967
|
+
<div class="tsd-comment tsd-typography">
|
|
1968
|
+
<div class="tsd-tag-stability">
|
|
1969
|
+
<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>
|
|
1970
|
+
</div></div></section>
|
|
1971
|
+
<section class="tsd-panel tsd-member">
|
|
1972
|
+
<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>
|
|
1973
|
+
<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>
|
|
1974
|
+
<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>
|
|
1975
|
+
</div>
|
|
1976
|
+
<div class="tsd-comment tsd-typography">
|
|
1977
|
+
<div class="tsd-tag-stability">
|
|
1978
|
+
<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>
|
|
1979
|
+
</div></div></section>
|
|
1980
|
+
<section class="tsd-panel tsd-member">
|
|
1981
|
+
<h3 class="tsd-anchor-link" id="runner"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>runner</span><a href="#runner" 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>
|
|
1982
|
+
<div class="tsd-signature"><span class="tsd-kind-property">runner</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">TypeScriptRunner</span></div>
|
|
1983
|
+
<div class="tsd-comment tsd-typography"><p>The TypeScript runner to use for executing TypeScript files.
|
|
1984
|
+
This is a project-level setting that components (e.g. projenrc) will
|
|
1985
|
+
use as their default runner.</p>
|
|
1986
|
+
</div>
|
|
1987
|
+
<div class="tsd-comment tsd-typography">
|
|
1988
|
+
<div class="tsd-tag-default">
|
|
1989
|
+
<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-5">TypeScriptRunner</span><span class="hl-1">.</span><span class="hl-0">tsNode</span><span class="hl-1">()</span>
|
|
1990
|
+
</code><button type="button">Copy</button></pre>
|
|
1991
|
+
|
|
1992
|
+
</div>
|
|
1993
|
+
<div class="tsd-tag-stability">
|
|
1994
|
+
<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>
|
|
1995
|
+
</div></div></section>
|
|
1996
|
+
<section class="tsd-panel tsd-member">
|
|
1997
|
+
<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>
|
|
1998
|
+
<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>
|
|
1999
|
+
<div class="tsd-comment tsd-typography"><p>Options for privately hosted scoped packages.</p>
|
|
2000
|
+
</div>
|
|
2001
|
+
<div class="tsd-comment tsd-typography">
|
|
2002
|
+
<div class="tsd-tag-default">
|
|
2003
|
+
<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-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>
|
|
2004
|
+
</code><button type="button">Copy</button></pre>
|
|
2005
|
+
|
|
2006
|
+
</div>
|
|
2007
|
+
<div class="tsd-tag-stability">
|
|
2008
|
+
<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>
|
|
2009
|
+
</div></div></section>
|
|
2010
|
+
<section class="tsd-panel tsd-member">
|
|
2011
|
+
<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>
|
|
2012
|
+
<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>
|
|
2013
|
+
<div class="tsd-comment tsd-typography"><p>Typescript sources directory.</p>
|
|
2014
|
+
</div>
|
|
2015
|
+
<div class="tsd-comment tsd-typography">
|
|
2016
|
+
<div class="tsd-tag-default">
|
|
2017
|
+
<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-2">"src"</span>
|
|
2018
|
+
</code><button type="button">Copy</button></pre>
|
|
2019
|
+
|
|
2020
|
+
</div>
|
|
2021
|
+
<div class="tsd-tag-stability">
|
|
2022
|
+
<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>
|
|
2023
|
+
</div></div></section>
|
|
2024
|
+
<section class="tsd-panel tsd-member">
|
|
2025
|
+
<h3 class="tsd-anchor-link" id="stability"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>stability</span><a href="#stability" 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>
|
|
2026
|
+
<div class="tsd-signature"><span class="tsd-kind-property">stability</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
2027
|
+
<div class="tsd-comment tsd-typography"><p>Package's Stability.</p>
|
|
2028
|
+
</div>
|
|
2029
|
+
<div class="tsd-comment tsd-typography">
|
|
2030
|
+
<div class="tsd-tag-stability">
|
|
2031
|
+
<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>
|
|
2032
|
+
</div></div></section>
|
|
2033
|
+
<section class="tsd-panel tsd-member">
|
|
2034
|
+
<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>
|
|
2035
|
+
<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>
|
|
2036
|
+
<div class="tsd-comment tsd-typography"><p>Auto-close of stale issues and pull request.
|
|
838
2037
|
See <code>staleOptions</code> for options.</p>
|
|
839
|
-
</div
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
</
|
|
2038
|
+
</div>
|
|
2039
|
+
<div class="tsd-comment tsd-typography">
|
|
2040
|
+
<div class="tsd-tag-default">
|
|
2041
|
+
<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-3">false</span>
|
|
2042
|
+
</code><button type="button">Copy</button></pre>
|
|
2043
|
+
|
|
2044
|
+
</div>
|
|
2045
|
+
<div class="tsd-tag-stability">
|
|
2046
|
+
<h4 class="tsd-anchor-link" id="stability-126">Stability<a href="#stability-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><p>experimental</p>
|
|
2047
|
+
</div></div></section>
|
|
2048
|
+
<section class="tsd-panel tsd-member">
|
|
2049
|
+
<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>
|
|
2050
|
+
<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>
|
|
2051
|
+
<div class="tsd-comment tsd-typography"><p>Auto-close stale issues and pull requests.
|
|
844
2052
|
To disable set <code>stale</code> to <code>false</code>.</p>
|
|
845
|
-
</div
|
|
2053
|
+
</div>
|
|
2054
|
+
<div class="tsd-comment tsd-typography">
|
|
2055
|
+
<div class="tsd-tag-default">
|
|
2056
|
+
<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><ul>
|
|
846
2057
|
<li>see defaults in <code>StaleOptions</code></li>
|
|
847
2058
|
</ul>
|
|
848
|
-
</div
|
|
849
|
-
|
|
2059
|
+
</div>
|
|
2060
|
+
<div class="tsd-tag-stability">
|
|
2061
|
+
<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>
|
|
2062
|
+
</div></div></section>
|
|
2063
|
+
<section class="tsd-panel tsd-member">
|
|
2064
|
+
<h3 class="tsd-anchor-link" id="testdir"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>testdir</span><a href="#testdir" 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>
|
|
2065
|
+
<div class="tsd-signature"><span class="tsd-kind-property">testdir</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
|
|
2066
|
+
<div class="tsd-comment tsd-typography"><p>Jest tests directory. Tests files should be named <code>xxx.test.ts</code>.
|
|
850
2067
|
If this directory is under <code>srcdir</code> (e.g. <code>src/test</code>, <code>src/__tests__</code>),
|
|
851
2068
|
then tests are going to be compiled into <code>lib/</code> and executed as javascript.
|
|
852
2069
|
If the test directory is outside of <code>src</code>, then we configure jest to
|
|
853
2070
|
compile the code in-memory.</p>
|
|
854
|
-
</div
|
|
855
|
-
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
</
|
|
859
|
-
|
|
860
|
-
</
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
</div></div></section
|
|
864
|
-
|
|
865
|
-
</code
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
</div
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
</
|
|
873
|
-
|
|
2071
|
+
</div>
|
|
2072
|
+
<div class="tsd-comment tsd-typography">
|
|
2073
|
+
<div class="tsd-tag-default">
|
|
2074
|
+
<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">"test"</span>
|
|
2075
|
+
</code><button type="button">Copy</button></pre>
|
|
2076
|
+
|
|
2077
|
+
</div>
|
|
2078
|
+
<div class="tsd-tag-stability">
|
|
2079
|
+
<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>
|
|
2080
|
+
</div></div></section>
|
|
2081
|
+
<section class="tsd-panel tsd-member">
|
|
2082
|
+
<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>
|
|
2083
|
+
<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>
|
|
2084
|
+
<div class="tsd-comment tsd-typography"><p>Custom TSConfig.</p>
|
|
2085
|
+
</div>
|
|
2086
|
+
<div class="tsd-comment tsd-typography">
|
|
2087
|
+
<div class="tsd-tag-default">
|
|
2088
|
+
<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-7">default</span><span class="hl-1"> </span><span class="hl-5">options</span>
|
|
2089
|
+
</code><button type="button">Copy</button></pre>
|
|
2090
|
+
|
|
2091
|
+
</div>
|
|
2092
|
+
<div class="tsd-tag-stability">
|
|
2093
|
+
<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>
|
|
2094
|
+
</div></div></section>
|
|
2095
|
+
<section class="tsd-panel tsd-member">
|
|
2096
|
+
<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>
|
|
2097
|
+
<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>
|
|
2098
|
+
<div class="tsd-comment tsd-typography"><p>Custom tsconfig options for the development tsconfig.json file (used for testing).</p>
|
|
2099
|
+
</div>
|
|
2100
|
+
<div class="tsd-comment tsd-typography">
|
|
2101
|
+
<div class="tsd-tag-default">
|
|
2102
|
+
<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-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>
|
|
2103
|
+
</code><button type="button">Copy</button></pre>
|
|
2104
|
+
|
|
2105
|
+
</div>
|
|
2106
|
+
<div class="tsd-tag-stability">
|
|
2107
|
+
<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>
|
|
2108
|
+
</div></div></section>
|
|
2109
|
+
<section class="tsd-panel tsd-member">
|
|
2110
|
+
<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>
|
|
2111
|
+
<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>
|
|
2112
|
+
<div class="tsd-comment tsd-typography"><p>The name (and path) of the development tsconfig file.
|
|
2113
|
+
By default this lives inside the test directory (e.g. <code>test/tsconfig.json</code>)
|
|
2114
|
+
so that the TypeScript language service resolves it as the nearest config
|
|
2115
|
+
for test files.</p>
|
|
2116
|
+
</div>
|
|
2117
|
+
<div class="tsd-comment tsd-typography">
|
|
2118
|
+
<div class="tsd-tag-default">
|
|
2119
|
+
<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-1">- </span><span class="hl-2">"{testdir}/tsconfig.json"</span>
|
|
2120
|
+
</code><button type="button">Copy</button></pre>
|
|
2121
|
+
|
|
2122
|
+
</div>
|
|
2123
|
+
<div class="tsd-tag-stability">
|
|
2124
|
+
<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>
|
|
2125
|
+
</div></div></section>
|
|
2126
|
+
<section class="tsd-panel tsd-member">
|
|
2127
|
+
<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>
|
|
2128
|
+
<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>
|
|
2129
|
+
<div class="tsd-comment tsd-typography"><p>TypeScript version to use.
|
|
874
2130
|
NOTE: Typescript is not semantically versioned and should remain on the
|
|
875
2131
|
same minor, so we recommend using a <code>~</code> dependency (e.g. <code>~1.2.3</code>).</p>
|
|
876
|
-
</div
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
</
|
|
2132
|
+
</div>
|
|
2133
|
+
<div class="tsd-comment tsd-typography">
|
|
2134
|
+
<div class="tsd-tag-default">
|
|
2135
|
+
<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><pre><code class="ts"><span class="hl-2">"latest"</span>
|
|
2136
|
+
</code><button type="button">Copy</button></pre>
|
|
2137
|
+
|
|
2138
|
+
</div>
|
|
2139
|
+
<div class="tsd-tag-stability">
|
|
2140
|
+
<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>
|
|
2141
|
+
</div></div></section>
|
|
2142
|
+
<section class="tsd-panel tsd-member">
|
|
2143
|
+
<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>
|
|
2144
|
+
<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>
|
|
2145
|
+
<div class="tsd-comment tsd-typography"><p>Custom configuration used when creating changelog with commit-and-tag-version package.
|
|
881
2146
|
Given values either append to default configuration or overwrite values in it.</p>
|
|
882
|
-
</div
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
</
|
|
887
|
-
|
|
888
|
-
</
|
|
889
|
-
|
|
890
|
-
|
|
891
|
-
</div
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
2147
|
+
</div>
|
|
2148
|
+
<div class="tsd-comment tsd-typography">
|
|
2149
|
+
<div class="tsd-tag-default">
|
|
2150
|
+
<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-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>
|
|
2151
|
+
</code><button type="button">Copy</button></pre>
|
|
2152
|
+
|
|
2153
|
+
</div>
|
|
2154
|
+
<div class="tsd-tag-stability">
|
|
2155
|
+
<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>
|
|
2156
|
+
</div></div></section>
|
|
2157
|
+
<section class="tsd-panel tsd-member">
|
|
2158
|
+
<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>
|
|
2159
|
+
<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>
|
|
2160
|
+
<div class="tsd-comment tsd-typography"><p>Enable Vitest component</p>
|
|
2161
|
+
</div>
|
|
2162
|
+
<div class="tsd-comment tsd-typography">
|
|
2163
|
+
<div class="tsd-tag-default">
|
|
2164
|
+
<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-3">true</span>
|
|
2165
|
+
</code><button type="button">Copy</button></pre>
|
|
2166
|
+
|
|
2167
|
+
</div></div></section>
|
|
2168
|
+
<section class="tsd-panel tsd-member">
|
|
2169
|
+
<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>
|
|
2170
|
+
<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>
|
|
2171
|
+
<div class="tsd-comment tsd-typography"><p>Vitest configuration</p>
|
|
2172
|
+
</div>
|
|
2173
|
+
<div class="tsd-comment tsd-typography">
|
|
2174
|
+
<div class="tsd-tag-default">
|
|
2175
|
+
<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-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>
|
|
2176
|
+
</code><button type="button">Copy</button></pre>
|
|
2177
|
+
|
|
2178
|
+
</div></div></section>
|
|
2179
|
+
<section class="tsd-panel tsd-member">
|
|
2180
|
+
<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>
|
|
2181
|
+
<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>
|
|
2182
|
+
<div class="tsd-comment tsd-typography"><p>Enable VSCode integration.
|
|
895
2183
|
Enabled by default for root projects. Disabled for non-root projects.</p>
|
|
896
|
-
</div
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
900
|
-
</
|
|
901
|
-
|
|
902
|
-
</
|
|
903
|
-
|
|
904
|
-
|
|
905
|
-
</div></div></section
|
|
906
|
-
|
|
907
|
-
</code
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
</div
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
|
|
914
|
-
</
|
|
915
|
-
|
|
2184
|
+
</div>
|
|
2185
|
+
<div class="tsd-comment tsd-typography">
|
|
2186
|
+
<div class="tsd-tag-default">
|
|
2187
|
+
<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-3">true</span>
|
|
2188
|
+
</code><button type="button">Copy</button></pre>
|
|
2189
|
+
|
|
2190
|
+
</div>
|
|
2191
|
+
<div class="tsd-tag-stability">
|
|
2192
|
+
<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>
|
|
2193
|
+
</div></div></section>
|
|
2194
|
+
<section class="tsd-panel tsd-member">
|
|
2195
|
+
<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>
|
|
2196
|
+
<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>
|
|
2197
|
+
<div class="tsd-comment tsd-typography"><p>Workflow steps to use in order to bootstrap this repo.</p>
|
|
2198
|
+
</div>
|
|
2199
|
+
<div class="tsd-comment tsd-typography">
|
|
2200
|
+
<div class="tsd-tag-default">
|
|
2201
|
+
<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-2">"yarn install --frozen-lockfile && yarn projen"</span>
|
|
2202
|
+
</code><button type="button">Copy</button></pre>
|
|
2203
|
+
|
|
2204
|
+
</div>
|
|
2205
|
+
<div class="tsd-tag-stability">
|
|
2206
|
+
<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>
|
|
2207
|
+
</div></div></section>
|
|
2208
|
+
<section class="tsd-panel tsd-member">
|
|
2209
|
+
<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>
|
|
2210
|
+
<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>
|
|
2211
|
+
<div class="tsd-comment tsd-typography"><p>Container image to use for GitHub workflows.</p>
|
|
2212
|
+
</div>
|
|
2213
|
+
<div class="tsd-comment tsd-typography">
|
|
2214
|
+
<div class="tsd-tag-default">
|
|
2215
|
+
<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">image</span>
|
|
2216
|
+
</code><button type="button">Copy</button></pre>
|
|
2217
|
+
|
|
2218
|
+
</div>
|
|
2219
|
+
<div class="tsd-tag-stability">
|
|
2220
|
+
<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>
|
|
2221
|
+
</div></div></section>
|
|
2222
|
+
<section class="tsd-panel tsd-member">
|
|
2223
|
+
<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>
|
|
2224
|
+
<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>
|
|
2225
|
+
<div class="tsd-comment tsd-typography"><p>The git identity to use in workflows.</p>
|
|
2226
|
+
</div>
|
|
2227
|
+
<div class="tsd-comment tsd-typography">
|
|
2228
|
+
<div class="tsd-tag-default">
|
|
2229
|
+
<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-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>
|
|
2230
|
+
</code><button type="button">Copy</button></pre>
|
|
2231
|
+
|
|
2232
|
+
</div>
|
|
2233
|
+
<div class="tsd-tag-stability">
|
|
2234
|
+
<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>
|
|
2235
|
+
</div></div></section>
|
|
2236
|
+
<section class="tsd-panel tsd-member">
|
|
2237
|
+
<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>
|
|
2238
|
+
<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>
|
|
2239
|
+
<div class="tsd-comment tsd-typography"><p>The node version used in GitHub Actions workflows.
|
|
916
2240
|
Always use this option if your GitHub Actions workflows require a specific to run.</p>
|
|
917
|
-
</div
|
|
2241
|
+
</div>
|
|
2242
|
+
<div class="tsd-comment tsd-typography">
|
|
2243
|
+
<div class="tsd-tag-default">
|
|
2244
|
+
<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><ul>
|
|
918
2245
|
<li><code>minNodeVersion</code> if set, otherwise <code>lts/*</code>.</li>
|
|
919
2246
|
</ul>
|
|
920
|
-
</div
|
|
921
|
-
|
|
922
|
-
|
|
923
|
-
</
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
</
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
</
|
|
933
|
-
|
|
934
|
-
</div
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
</div></div></section
|
|
938
|
-
|
|
939
|
-
</code
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
</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="#addpackagemanagertodevengines"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Package<wbr/>Manager<wbr/>To<wbr/>Dev<wbr/>Engines</span></a><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="#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="#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="#deleteorphanedlockfiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Orphaned<wbr/>Lock<wbr/>Files</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="#devengines"><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/>Engines</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="#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="#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="#homebrewoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>homebrew<wbr/>Options</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="#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="#miseoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mise<wbr/>Options</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="#projecttree"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Tree</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="#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="#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="#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>
|
|
2247
|
+
</div>
|
|
2248
|
+
<div class="tsd-tag-stability">
|
|
2249
|
+
<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>
|
|
2250
|
+
</div></div></section>
|
|
2251
|
+
<section class="tsd-panel tsd-member">
|
|
2252
|
+
<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>
|
|
2253
|
+
<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>
|
|
2254
|
+
<div class="tsd-comment tsd-typography"><p>Enable Node.js package cache in GitHub workflows.</p>
|
|
2255
|
+
</div>
|
|
2256
|
+
<div class="tsd-comment tsd-typography">
|
|
2257
|
+
<div class="tsd-tag-default">
|
|
2258
|
+
<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">false</span>
|
|
2259
|
+
</code><button type="button">Copy</button></pre>
|
|
2260
|
+
|
|
2261
|
+
</div>
|
|
2262
|
+
<div class="tsd-tag-stability">
|
|
2263
|
+
<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>
|
|
2264
|
+
</div></div></section>
|
|
2265
|
+
<section class="tsd-panel tsd-member">
|
|
2266
|
+
<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>
|
|
2267
|
+
<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>
|
|
2268
|
+
<div class="tsd-comment tsd-typography"><p>Github Runner selection labels.</p>
|
|
2269
|
+
</div>
|
|
2270
|
+
<div class="tsd-comment tsd-typography">
|
|
2271
|
+
<div class="tsd-tag-default">
|
|
2272
|
+
<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-2">"ubuntu-latest"</span><span class="hl-1">]</span>
|
|
2273
|
+
</code><button type="button">Copy</button></pre>
|
|
2274
|
+
|
|
2275
|
+
</div>
|
|
2276
|
+
<div class="tsd-tag-stability">
|
|
2277
|
+
<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>
|
|
2278
|
+
</div>
|
|
2279
|
+
<div class="tsd-tag-description">
|
|
2280
|
+
<h4 class="tsd-anchor-link" id="description-1">Description<a href="#description-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>Defines a target Runner by labels</p>
|
|
2281
|
+
</div>
|
|
2282
|
+
<div class="tsd-tag-throws">
|
|
2283
|
+
<h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" 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>
|
|
2284
|
+
</div></div></section>
|
|
2285
|
+
<section class="tsd-panel tsd-member">
|
|
2286
|
+
<h3 class="tsd-anchor-link" id="workflowrunsongroup"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>workflow<wbr/>Runs<wbr/>On<wbr/>Group</span><a href="#workflowrunsongroup" 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>
|
|
2287
|
+
<div class="tsd-signature"><span class="tsd-kind-property">workflowRunsOnGroup</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GroupRunnerOptions</span></div>
|
|
2288
|
+
<div class="tsd-comment tsd-typography"><p>Github Runner Group selection options.</p>
|
|
2289
|
+
</div>
|
|
2290
|
+
<div class="tsd-comment tsd-typography">
|
|
2291
|
+
<div class="tsd-tag-stability">
|
|
2292
|
+
<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>
|
|
2293
|
+
</div>
|
|
2294
|
+
<div class="tsd-tag-description">
|
|
2295
|
+
<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>
|
|
2296
|
+
</div>
|
|
2297
|
+
<div class="tsd-tag-throws">
|
|
2298
|
+
<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>
|
|
2299
|
+
</div></div></section>
|
|
2300
|
+
<section class="tsd-panel tsd-member">
|
|
2301
|
+
<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>
|
|
2302
|
+
<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>
|
|
2303
|
+
<div class="tsd-comment tsd-typography"><p>Options for Yarn Berry.</p>
|
|
2304
|
+
</div>
|
|
2305
|
+
<div class="tsd-comment tsd-typography">
|
|
2306
|
+
<div class="tsd-tag-default">
|
|
2307
|
+
<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-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>
|
|
2308
|
+
</code><button type="button">Copy</button></pre>
|
|
2309
|
+
|
|
2310
|
+
</div>
|
|
2311
|
+
<div class="tsd-tag-stability">
|
|
2312
|
+
<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>
|
|
2313
|
+
</div></div></section></section></details></div>
|
|
2314
|
+
<div class="col-sidebar">
|
|
2315
|
+
<div class="page-menu">
|
|
2316
|
+
<div class="tsd-navigation settings">
|
|
2317
|
+
<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>
|
|
2318
|
+
<h3>Settings</h3></summary>
|
|
2319
|
+
<div class="tsd-accordion-details">
|
|
2320
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
2321
|
+
<ul id="tsd-filter-options">
|
|
2322
|
+
<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>
|
|
2323
|
+
<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>
|
|
2324
|
+
<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>
|
|
2325
|
+
<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>
|
|
2326
|
+
<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>
|
|
2327
|
+
<h3>On This Page</h3></summary>
|
|
2328
|
+
<div class="tsd-accordion-details">
|
|
2329
|
+
<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>
|
|
2330
|
+
<div><a href="#addpackagemanagertodevengines"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Package<wbr/>Manager<wbr/>To<wbr/>Dev<wbr/>Engines</span></a><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="#allowscripts"><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/>Scripts</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="#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="#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="#deleteorphanedlockfiles"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Orphaned<wbr/>Lock<wbr/>Files</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="#devengines"><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/>Engines</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="#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="#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="#homebrewoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>homebrew<wbr/>Options</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="#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="#miseoptions"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>mise<wbr/>Options</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="#pnpmoptions"><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/>Options</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="#projecttree"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>project<wbr/>Tree</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="#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="#runner"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>runner</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="#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>
|
|
2331
|
+
<div class="site-menu">
|
|
2332
|
+
<nav class="tsd-navigation"><a href="../modules.html">@nikovirtala/projen-constructs</a>
|
|
2333
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
2334
|
+
<li>Loading...</li></ul></nav></div></div></div><footer>
|
|
2335
|
+
<p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer>
|
|
2336
|
+
<div class="overlay"></div></body></html>
|