@nikovirtala/projen-constructs 0.3.79 → 0.3.81

package/README.md

@@ -327,6 +327,110 @@ Features:
 - Validates paths to prevent directory traversal attacks
 - Structured error handling with custom error classes
 
+## Migrating from the standalone packages
+
+The components used to be published as separate packages. Those packages are deprecated and won't
+get new features or fixes. Every class, interface, enum and function they exported is exported from
+`@nikovirtala/projen-constructs` under the same name, except `AwsCdkApp` (see below).
+
+| Deprecated package | Replacement in `@nikovirtala/projen-constructs` |
+| --- | --- |
+| `@nikovirtala/projen-vitest` | `Vitest`, `VitestOptions`, `VitestConfigOptions`, `Environment`, `Pool`, `CoverageProvider`, `CoverageReporter` |
+| `@nikovirtala/projen-typedoc` | `TypeDoc`, `TypeDocOptions`, `TypeDocConfiguration` and its enums |
+| `@nikovirtala/projen-homebrew` | `Homebrew`, `HomebrewOptions` |
+| `@nikovirtala/projen-colima` | `Colima` |
+| `@nikovirtala/projen-localstack` | `LocalStack`, `LocalStackOptions` |
+| `@nikovirtala/projen-bundle-lambda-function-code` | `Bundler`, `LambdaFunctionCodeBundle`, `LambdaFunctionCodeBundler` and their options |
+| `@nikovirtala/projen-lambda-function-construct-generator` | `LambdaFunctionConstructGenerator`, `LambdaFunctionConstructGeneratorOptions` |
+| `@nikovirtala/projen-aws-cdk-app` | `AwsCdkTypeScriptAppProject`, `AwsCdkTypeScriptAppProjectOptions` |
+
+### Steps
+
+1. In `.projenrc.ts`, replace the old package in `devDeps` with `@nikovirtala/projen-constructs`, and
+   change the imports:
+
+   ```typescript
+   // before
+   import { Vitest } from "@nikovirtala/projen-vitest";
+   // after
+   import { Vitest } from "@nikovirtala/projen-constructs";
+   ```
+
+2. Check the peer dependencies. `@nikovirtala/projen-constructs` needs `projen` ^0.104, `constructs`
+   ^10 and `@mrgrain/cdk-esbuild` ^5. The standalone packages accepted older projen versions, so you
+   may have to upgrade projen in the same change.
+3. Install the new package, run `npx projen` and review the changes to the generated files.
+
+### Changes to expect
+
+These are the differences in behaviour or generated files between the standalone packages and this
+library.
+
+**Vitest**
+
+- `vitest.config.ts` imports `defineConfig` from
+  `@nikovirtala/projen-constructs/lib/vitest-define-config` instead of
+  `@nikovirtala/projen-vitest/lib/bundled-define-config`. Projen rewrites the file, so there's
+  nothing to change by hand.
+- The config is rendered as JSON, so its keys are quoted. The settings are the same.
+- `config.typecheckTsconfig` defaults to the project's development tsconfig (`test/tsconfig.json`
+  in current projen) instead of `tsconfig.dev.json`.
+- JSII and construct library projects exclude `vitest.config.ts` from the published package.
+- New: `extraTestConfig` and `extraConfig` for Vitest settings that `config` doesn't cover.
+
+**Homebrew and Colima**
+
+- Packages from a tap (`owner/tap/formula`) also add a `tap` line to the `Brewfile`, and the
+  `Brewfile` is sorted.
+- The `install:homebrew`, `homebrew:bundle` and `colima` tasks run in bash. `homebrew:bundle` also
+  finds a freshly installed `brew` that isn't on the `PATH` yet.
+
+**LocalStack**
+
+- `imageTag` is applied: LocalStack starts with `localstack/localstack:<imageTag>`. It used to be
+  ignored.
+
+**Bundler / LambdaFunctionCodeBundler**
+
+- `LambdaFunctionCodeBundler.bundleOptions` applies to every discovered entrypoint. Its `entrypoint`
+  used to replace them all.
+
+**LambdaFunctionConstructGenerator**
+
+- The bundle task runs `tsx` with the project's development tsconfig instead of `tsconfig.dev.json`.
+
+**TypeDoc**: no changes.
+
+### From `AwsCdkApp` to `AwsCdkTypeScriptAppProject`
+
+```typescript
+// before
+import { AwsCdkApp } from "@nikovirtala/projen-aws-cdk-app";
+const project = new AwsCdkApp({ name: "my-app", cdkVersion: "2.221.0" });
+
+// after
+import { AwsCdkTypeScriptAppProject } from "@nikovirtala/projen-constructs";
+const project = new AwsCdkTypeScriptAppProject({ name: "my-app", cdkVersion: "2.221.0" });
+```
+
+Both are ES module apps run with `tsx`, using pnpm, Biome, Vitest and mise. The differences:
+
+- **`nvm` is removed.** Use mise (on by default), which pins the Node.js version in `mise.toml`.
+- **Homebrew is on by default.** The project gets a `Brewfile`, and `npx projen` runs
+  `install:homebrew` (installs Homebrew if `brew` is missing) and `homebrew:bundle`. Set
+  `homebrew: false` to turn it off.
+- **cdk.json `app`** is `npx tsx src/main.ts` instead of `tsx --tsconfig tsconfig.json src/main.ts`.
+- **Defaults** come from this library: Node.js, TypeScript, CDK and pnpm versions (pnpm 11 instead
+  of 10), Dependabot off, auto-merge on, `auto-approve` and `auto-merge` labels on dependency
+  upgrade PRs, and auto-approval of PRs by `nikovirtala`. Any option you set explicitly still wins,
+  so set `autoApproveOptions` if you aren't `nikovirtala`.
+- **tsconfig**: `noImplicitOverride` and `allowSyntheticDefaultImports` move from `tsconfig.json`
+  to the development tsconfig (`test/tsconfig.json`).
+- **Options removed from the interface**: `eslint`, `jest`, `prettier` (and their options),
+  `sampleCode` and `tsJestOptions`.
+- `vitestOptions` takes the `VitestOptions` of this library, and now also `homebrewOptions` and
+  `miseOptions`.
+
 ## Development
 
 This project is managed by Projen and generates itself: `.projenrc.ts` defines the project using the

package/docs/api/classes/Bundler.html

@@ -10,6 +10,10 @@
 <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
 <li><a href="" aria-current="page">Bundler</a></li></ul>
 <h1>Class Bundler</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>Adds support for bundling JavaScript applications and dependencies into a
+single file.</p>
+</div></section>
 <section class="tsd-panel tsd-hierarchy" data-refl="15">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
@@ -59,6 +63,8 @@
 <li class="">
 <div class="tsd-signature tsd-anchor-link" id="constructorbundler"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">Bundler</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">project</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/BundlerOptions.html" class="tsd-signature-type tsd-kind-interface">BundlerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Bundler</a><a href="#constructorbundler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
 <div class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Creates a <code>Bundler</code>.</p>
+</div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
@@ -71,10 +77,14 @@
 <section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="bundledir"><code class="tsd-tag">Readonly</code><span>bundledir</span><a href="#bundledir" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">bundledir</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">bundledir</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
+<div class="tsd-comment tsd-typography"><p>Root bundle directory.</p>
+</div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="esbuildversion"><code class="tsd-tag">Readonly</code><span>esbuild<wbr/>Version</span><a href="#esbuildversion" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">esbuildVersion</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">undefined</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">esbuildVersion</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">undefined</span></div>
+<div class="tsd-comment tsd-typography"><p>The semantic version requirement for <code>esbuild</code> (if defined).</p>
+</div></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
 <h3 class="tsd-anchor-link" id="node"><code class="tsd-tag">Readonly</code><span>node</span><a href="#node" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">node</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span></div>
@@ -94,6 +104,10 @@
 <li>
 <div class="tsd-signature" id="bundletaskbundletask"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">bundleTask</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span></div>
 <div class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Gets or creates the singleton &quot;bundle&quot; task of the project.</p>
+<p>If the project doesn't have a &quot;bundle&quot; task, it will be created and spawned
+during the pre-compile phase (unless <code>addToPreCompile</code> is <code>false</code>).</p>
+</div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Task</span></h4></div></li></ul></section></section></details>
 <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
 <h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-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>
@@ -104,11 +118,18 @@
 <li class="">
 <div class="tsd-signature tsd-anchor-link" id="addbundle-1"><span class="tsd-kind-call-signature">addBundle</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entrypoint</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/BundlingOptions.html" class="tsd-signature-type tsd-kind-interface">BundlingOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Bundle.html" class="tsd-signature-type tsd-kind-interface">Bundle</a><a href="#addbundle-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></div>
 <div class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Adds a task to the project which bundles a specific entrypoint and all of
+its dependencies into a single javascript output file.</p>
+</div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
-<li><span><span class="tsd-kind-parameter">entrypoint</span>: <span class="tsd-signature-type">string</span></span></li>
-<li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/BundlingOptions.html" class="tsd-signature-type tsd-kind-interface">BundlingOptions</a></span></li></ul></div>
+<li><span><span class="tsd-kind-parameter">entrypoint</span>: <span class="tsd-signature-type">string</span></span>
+<div class="tsd-comment tsd-typography"><p>The relative path of the artifact within the project</p>
+</div></li>
+<li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/BundlingOptions.html" class="tsd-signature-type tsd-kind-interface">BundlingOptions</a></span>
+<div class="tsd-comment tsd-typography"><p>Bundling options</p>
+</div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="../interfaces/Bundle.html" class="tsd-signature-type tsd-kind-interface">Bundle</a></h4></div></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external">
 <h3 class="tsd-anchor-link" id="postprojectcreation"><span>post<wbr/>Project<wbr/>Creation</span><a href="#postprojectcreation" aria-label="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>
@@ -258,11 +279,17 @@ this type-testing method instead.</p>
 <li class="">
 <div class="tsd-signature tsd-anchor-link" id="of-1"><span class="tsd-kind-call-signature">of</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">project</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Bundler</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#of-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></div>
 <div class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Returns the <code>Bundler</code> instance associated with a project or <code>undefined</code> if
+there is no Bundler.</p>
+</div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
-<li><span><span class="tsd-kind-parameter">project</span>: <span class="tsd-signature-type">Project</span></span></li></ul></div>
-<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Bundler</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4></div></li></ul></section></section></details></div>
+<li><span><span class="tsd-kind-parameter">project</span>: <span class="tsd-signature-type">Project</span></span>
+<div class="tsd-comment tsd-typography"><p>The project</p>
+</div></li></ul></div>
+<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">Bundler</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><p>A bundler</p>
+</div></li></ul></section></section></details></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/api/classes/Colima.html

@@ -10,6 +10,10 @@
 <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
 <li><a href="" aria-current="page">Colima</a></li></ul>
 <h1>Class Colima</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>Colima component for projen projects.</p>
+<p>Adds Colima support to your project with automatic installation and startup.</p>
+</div></section>
 <section class="tsd-panel tsd-hierarchy" data-refl="155">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">

package/docs/api/classes/LambdaFunctionCodeBundle.html

@@ -10,6 +10,20 @@
 <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
 <li><a href="" aria-current="page">LambdaFunctionCodeBundle</a></li></ul>
 <h1>Class LambdaFunctionCodeBundle</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>Generates a pre-bundled AWS Lambda Function code asset from handler code.</p>
+<p>Adds a task to the project's <code>Bundler</code> that uses <code>esbuild</code> to bundle the
+handler into the assets directory, and generates a file (e.g. <code>src/foo-code.ts</code>)
+exporting an <code>aws_lambda.Code</code> constant (e.g. <code>FooFunctionCode</code>) that points to
+the bundle. Pass it as the <code>code</code> of an <code>aws_lambda.Function</code>.</p>
+<p>Requires a <code>Bundler</code> component in the project.</p>
+</div>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-example">
+<h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" 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">new</span><span class="hl-1"> </span><span class="hl-0">Bundler</span><span class="hl-1">(</span><span class="hl-5">myProject</span><span class="hl-1">);</span><br/><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">LambdaFunctionCodeBundle</span><span class="hl-1">(</span><span class="hl-5">myProject</span><span class="hl-1">, {</span><br/><span class="hl-1">  </span><span class="hl-5">entrypoint:</span><span class="hl-1"> </span><span class="hl-2">&quot;src/foo.lambda.ts&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-5">extension:</span><span class="hl-1"> </span><span class="hl-2">&quot;.lambda.ts&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></section>
 <section class="tsd-panel tsd-hierarchy" data-refl="90">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
@@ -51,11 +65,17 @@
 <li class="">
 <div class="tsd-signature tsd-anchor-link" id="constructorlambdafunctioncodebundle"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">LambdaFunctionCodeBundle</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">project</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Project</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/LambdaFunctionCodeBundleOptions.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionCodeBundleOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunctionCodeBundle</a><a href="#constructorlambdafunctioncodebundle" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
 <div class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Defines a pre-bundled AWS Lambda Function code asset from handler code.</p>
+</div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
-<li><span><span class="tsd-kind-parameter">project</span>: <span class="tsd-signature-type">Project</span></span></li>
-<li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/LambdaFunctionCodeBundleOptions.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionCodeBundleOptions</a></span></li></ul></div>
+<li><span><span class="tsd-kind-parameter">project</span>: <span class="tsd-signature-type">Project</span></span>
+<div class="tsd-comment tsd-typography"><p>The project to use</p>
+</div></li>
+<li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/LambdaFunctionCodeBundleOptions.html" class="tsd-signature-type tsd-kind-interface">LambdaFunctionCodeBundleOptions</a></span>
+<div class="tsd-comment tsd-typography"><p>Options</p>
+</div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">LambdaFunctionCodeBundle</a></h4><aside class="tsd-sources">
 <p>Overrides Component.constructor</p></aside></div></li></ul></section></section></details>
 <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>

package/docs/api/classes/LambdaFunctionConstructGenerator.html

@@ -10,6 +10,10 @@
 <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
 <li><a href="" aria-current="page">LambdaFunctionConstructGenerator</a></li></ul>
 <h1>Class LambdaFunctionConstructGenerator</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>A projen component that generates AWS CDK Lambda Function constructs and bundles their code assets using esbuild.</p>
+<p>The bundling happens during projen execution, not during CDK synth, enabling a &quot;build once, deploy many&quot; pattern.</p>
+</div></section>
 <section class="tsd-panel tsd-hierarchy" data-refl="234">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">

package/docs/api/classes/LocalStack.html

@@ -10,6 +10,10 @@
 <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
 <li><a href="" aria-current="page">LocalStack</a></li></ul>
 <h1>Class LocalStack</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>LocalStack component for projen projects.</p>
+<p>Adds LocalStack support to your project with automatic Docker/Colima setup.</p>
+</div></section>
 <section class="tsd-panel tsd-hierarchy" data-refl="291">
 <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">

package/docs/api/functions/convertToPosixPath.html

@@ -15,6 +15,8 @@
 <li class="">
 <div class="tsd-signature tsd-anchor-link" id="converttoposixpath"><span class="tsd-kind-call-signature">convertToPosixPath</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">p</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> <span class="tsd-signature-type">string</span><a href="#converttoposixpath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
 <div class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Converts the given path string to posix if it wasn't already.</p>
+</div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">

package/docs/api/functions/renderBundleName.html

@@ -15,11 +15,19 @@
 <li class="">
 <div class="tsd-signature tsd-anchor-link" id="renderbundlename"><span class="tsd-kind-call-signature">renderBundleName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entrypoint</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> <span class="tsd-signature-type">string</span><a href="#renderbundlename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
 <div class="tsd-description">
+<div class="tsd-comment tsd-typography"><p>Renders the bundle name of an entrypoint: its path without the extension and without a leading <code>src</code> directory.</p>
+</div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li><span><span class="tsd-kind-parameter">entrypoint</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
-<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></div></li></ul></section></div>
+<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
+<div class="tsd-comment tsd-typography">
+<div class="tsd-tag-example">
+<h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" 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-0">renderBundleName</span><span class="hl-1">(</span><span class="hl-2">&quot;src/handlers/foo.lambda.ts&quot;</span><span class="hl-1">) </span><span class="hl-8">// &quot;handlers/foo.lambda&quot;</span>
+</code><button type="button">Copy</button></pre>
+
+</div></div></div></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

package/docs/api/index.html

@@ -180,6 +180,129 @@ render into a generated <code>.projenrc.ts</code> as the package manager that ra
 <li>Validates paths to prevent directory traversal attacks</li>
 <li>Structured error handling with custom error classes</li>
 </ul>
+<h2 id="migrating-from-the-standalone-packages" class="tsd-anchor-link">Migrating from the standalone packages<a href="#migrating-from-the-standalone-packages" aria-label="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>
+<p>The components used to be published as separate packages. Those packages are deprecated and won't
+get new features or fixes. Every class, interface, enum and function they exported is exported from
+<code>@nikovirtala/projen-constructs</code> under the same name, except <code>AwsCdkApp</code> (see below).</p>
+<table>
+<thead>
+<tr>
+<th>Deprecated package</th>
+<th>Replacement in <code>@nikovirtala/projen-constructs</code></th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>@nikovirtala/projen-vitest</code></td>
+<td><code>Vitest</code>, <code>VitestOptions</code>, <code>VitestConfigOptions</code>, <code>Environment</code>, <code>Pool</code>, <code>CoverageProvider</code>, <code>CoverageReporter</code></td>
+</tr>
+<tr>
+<td><code>@nikovirtala/projen-typedoc</code></td>
+<td><code>TypeDoc</code>, <code>TypeDocOptions</code>, <code>TypeDocConfiguration</code> and its enums</td>
+</tr>
+<tr>
+<td><code>@nikovirtala/projen-homebrew</code></td>
+<td><code>Homebrew</code>, <code>HomebrewOptions</code></td>
+</tr>
+<tr>
+<td><code>@nikovirtala/projen-colima</code></td>
+<td><code>Colima</code></td>
+</tr>
+<tr>
+<td><code>@nikovirtala/projen-localstack</code></td>
+<td><code>LocalStack</code>, <code>LocalStackOptions</code></td>
+</tr>
+<tr>
+<td><code>@nikovirtala/projen-bundle-lambda-function-code</code></td>
+<td><code>Bundler</code>, <code>LambdaFunctionCodeBundle</code>, <code>LambdaFunctionCodeBundler</code> and their options</td>
+</tr>
+<tr>
+<td><code>@nikovirtala/projen-lambda-function-construct-generator</code></td>
+<td><code>LambdaFunctionConstructGenerator</code>, <code>LambdaFunctionConstructGeneratorOptions</code></td>
+</tr>
+<tr>
+<td><code>@nikovirtala/projen-aws-cdk-app</code></td>
+<td><code>AwsCdkTypeScriptAppProject</code>, <code>AwsCdkTypeScriptAppProjectOptions</code></td>
+</tr>
+</tbody>
+</table>
+<h3 id="steps" class="tsd-anchor-link">Steps<a href="#steps" aria-label="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>
+<ol>
+<li>
+<p>In <code>.projenrc.ts</code>, replace the old package in <code>devDeps</code> with <code>@nikovirtala/projen-constructs</code>, and
+change the imports:</p>
+<pre><code class="typescript"><span class="hl-8">// before</span><br/><span class="hl-7">import</span><span class="hl-1"> { </span><span class="hl-5">Vitest</span><span class="hl-1"> } </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@nikovirtala/projen-vitest&quot;</span><span class="hl-1">;</span><br/><span class="hl-8">// after</span><br/><span class="hl-7">import</span><span class="hl-1"> { </span><span class="hl-5">Vitest</span><span class="hl-1"> } </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@nikovirtala/projen-constructs&quot;</span><span class="hl-1">;</span>
+</code><button type="button">Copy</button></pre>
+
+</li>
+<li>
+<p>Check the peer dependencies. <code>@nikovirtala/projen-constructs</code> needs <code>projen</code> ^0.104, <code>constructs</code>
+^10 and <code>@mrgrain/cdk-esbuild</code> ^5. The standalone packages accepted older projen versions, so you
+may have to upgrade projen in the same change.</p>
+</li>
+<li>
+<p>Install the new package, run <code>npx projen</code> and review the changes to the generated files.</p>
+</li>
+</ol>
+<h3 id="changes-to-expect" class="tsd-anchor-link">Changes to expect<a href="#changes-to-expect" aria-label="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>
+<p>These are the differences in behaviour or generated files between the standalone packages and this
+library.</p>
+<p><strong>Vitest</strong></p>
+<ul>
+<li><code>vitest.config.ts</code> imports <code>defineConfig</code> from
+<code>@nikovirtala/projen-constructs/lib/vitest-define-config</code> instead of
+<code>@nikovirtala/projen-vitest/lib/bundled-define-config</code>. Projen rewrites the file, so there's
+nothing to change by hand.</li>
+<li>The config is rendered as JSON, so its keys are quoted. The settings are the same.</li>
+<li><code>config.typecheckTsconfig</code> defaults to the project's development tsconfig (<code>test/tsconfig.json</code>
+in current projen) instead of <code>tsconfig.dev.json</code>.</li>
+<li>JSII and construct library projects exclude <code>vitest.config.ts</code> from the published package.</li>
+<li>New: <code>extraTestConfig</code> and <code>extraConfig</code> for Vitest settings that <code>config</code> doesn't cover.</li>
+</ul>
+<p><strong>Homebrew and Colima</strong></p>
+<ul>
+<li>Packages from a tap (<code>owner/tap/formula</code>) also add a <code>tap</code> line to the <code>Brewfile</code>, and the
+<code>Brewfile</code> is sorted.</li>
+<li>The <code>install:homebrew</code>, <code>homebrew:bundle</code> and <code>colima</code> tasks run in bash. <code>homebrew:bundle</code> also
+finds a freshly installed <code>brew</code> that isn't on the <code>PATH</code> yet.</li>
+</ul>
+<p><strong>LocalStack</strong></p>
+<ul>
+<li><code>imageTag</code> is applied: LocalStack starts with <code>localstack/localstack:&lt;imageTag&gt;</code>. It used to be
+ignored.</li>
+</ul>
+<p><strong>Bundler / LambdaFunctionCodeBundler</strong></p>
+<ul>
+<li><code>LambdaFunctionCodeBundler.bundleOptions</code> applies to every discovered entrypoint. Its <code>entrypoint</code>
+used to replace them all.</li>
+</ul>
+<p><strong>LambdaFunctionConstructGenerator</strong></p>
+<ul>
+<li>The bundle task runs <code>tsx</code> with the project's development tsconfig instead of <code>tsconfig.dev.json</code>.</li>
+</ul>
+<p><strong>TypeDoc</strong>: no changes.</p>
+<h3 id="from-to" class="tsd-anchor-link">From <code>AwsCdkApp</code> to <code>AwsCdkTypeScriptAppProject</code><a href="#from-to" aria-label="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>
+<pre><code class="typescript"><span class="hl-8">// before</span><br/><span class="hl-7">import</span><span class="hl-1"> { </span><span class="hl-5">AwsCdkApp</span><span class="hl-1"> } </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@nikovirtala/projen-aws-cdk-app&quot;</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">project</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">AwsCdkApp</span><span class="hl-1">({ </span><span class="hl-5">name:</span><span class="hl-1"> </span><span class="hl-2">&quot;my-app&quot;</span><span class="hl-1">, </span><span class="hl-5">cdkVersion:</span><span class="hl-1"> </span><span class="hl-2">&quot;2.221.0&quot;</span><span class="hl-1"> });</span><br/><br/><span class="hl-8">// after</span><br/><span class="hl-7">import</span><span class="hl-1"> { </span><span class="hl-5">AwsCdkTypeScriptAppProject</span><span class="hl-1"> } </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">&quot;@nikovirtala/projen-constructs&quot;</span><span class="hl-1">;</span><br/><span class="hl-3">const</span><span class="hl-1"> </span><span class="hl-4">project</span><span class="hl-1"> = </span><span class="hl-3">new</span><span class="hl-1"> </span><span class="hl-0">AwsCdkTypeScriptAppProject</span><span class="hl-1">({ </span><span class="hl-5">name:</span><span class="hl-1"> </span><span class="hl-2">&quot;my-app&quot;</span><span class="hl-1">, </span><span class="hl-5">cdkVersion:</span><span class="hl-1"> </span><span class="hl-2">&quot;2.221.0&quot;</span><span class="hl-1"> });</span>
+</code><button type="button">Copy</button></pre>
+
+<p>Both are ES module apps run with <code>tsx</code>, using pnpm, Biome, Vitest and mise. The differences:</p>
+<ul>
+<li><strong><code>nvm</code> is removed.</strong> Use mise (on by default), which pins the Node.js version in <code>mise.toml</code>.</li>
+<li><strong>Homebrew is on by default.</strong> The project gets a <code>Brewfile</code>, and <code>npx projen</code> runs
+<code>install:homebrew</code> (installs Homebrew if <code>brew</code> is missing) and <code>homebrew:bundle</code>. Set
+<code>homebrew: false</code> to turn it off.</li>
+<li><strong>cdk.json <code>app</code></strong> is <code>npx tsx src/main.ts</code> instead of <code>tsx --tsconfig tsconfig.json src/main.ts</code>.</li>
+<li><strong>Defaults</strong> come from this library: Node.js, TypeScript, CDK and pnpm versions (pnpm 11 instead
+of 10), Dependabot off, auto-merge on, <code>auto-approve</code> and <code>auto-merge</code> labels on dependency
+upgrade PRs, and auto-approval of PRs by <code>nikovirtala</code>. Any option you set explicitly still wins,
+so set <code>autoApproveOptions</code> if you aren't <code>nikovirtala</code>.</li>
+<li><strong>tsconfig</strong>: <code>noImplicitOverride</code> and <code>allowSyntheticDefaultImports</code> move from <code>tsconfig.json</code>
+to the development tsconfig (<code>test/tsconfig.json</code>).</li>
+<li><strong>Options removed from the interface</strong>: <code>eslint</code>, <code>jest</code>, <code>prettier</code> (and their options),
+<code>sampleCode</code> and <code>tsJestOptions</code>.</li>
+<li><code>vitestOptions</code> takes the <code>VitestOptions</code> of this library, and now also <code>homebrewOptions</code> and
+<code>miseOptions</code>.</li>
+</ul>
 <h2 id="development" class="tsd-anchor-link">Development<a href="#development" aria-label="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>
 <p>This project is managed by Projen and generates itself: <code>.projenrc.ts</code> defines the project using the
 <code>JsiiProject</code> type from <code>src/</code>. Configuration changes belong in <code>.projenrc.ts</code>, never in the
@@ -301,6 +424,12 @@ then synthesize again.</p>
 <li><a href="#lambdafunctionconstructgenerator"><span>Lambda<wbr/>Function<wbr/>Construct<wbr/>Generator</span></a></li>
 <li><a href="#bundler"><span>Bundler</span></a></li>
 <li><a href="#projectgenerator"><span>Project<wbr/>Generator</span></a></li></ul></li></ul></li>
+<li><a href="#migrating-from-the-standalone-packages"><span>Migrating from the standalone packages</span></a></li>
+<li>
+<ul>
+<li><a href="#steps"><span>Steps</span></a></li>
+<li><a href="#changes-to-expect"><span>Changes to expect</span></a></li>
+<li><a href="#from-to"><span>From  to </span></a></li></ul></li>
 <li><a href="#development"><span>Development</span></a></li>
 <li>
 <ul>

package/docs/api/interfaces/Bundle.html

@@ -10,6 +10,9 @@
 <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
 <li><a href="" aria-current="page">Bundle</a></li></ul>
 <h1>Interface Bundle</h1></div>
+<section class="tsd-panel tsd-comment">
+<div class="tsd-comment tsd-typography"><p>A bundle created by <code>Bundler.addBundle</code>.</p>
+</div></section>
 <div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">Bundle</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="#bundletask">bundleTask</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</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="#outfile">outfile</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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">
@@ -27,13 +30,19 @@
 <section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="bundletask"><code class="tsd-tag">Readonly</code><span>bundle<wbr/>Task</span><a href="#bundletask" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">bundleTask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span></div></section>
+<div class="tsd-signature"><span class="tsd-kind-property">bundleTask</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Task</span></div>
+<div class="tsd-comment tsd-typography"><p>The task that produces this bundle.</p>
+</div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="outdir"><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>
-<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></section>
+<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>
+<div class="tsd-comment tsd-typography"><p>Base directory containing the output file (relative to project root).</p>
+</div></section>
 <section class="tsd-panel tsd-member">
 <h3 class="tsd-anchor-link" id="outfile"><code class="tsd-tag">Readonly</code><span>outfile</span><a href="#outfile" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
-<div class="tsd-signature"><span class="tsd-kind-property">outfile</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div></section></section></details></div>
+<div class="tsd-signature"><span class="tsd-kind-property">outfile</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
+<div class="tsd-comment tsd-typography"><p>Location of the output file (relative to project root).</p>
+</div></section></section></details></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">