@nikovirtala/projen-constructs 0.5.1 → 0.5.2

package/docs/migration.md

@@ -0,0 +1,106 @@
+# Migrating from the standalone packages
+
+The components used to be published as separate packages. Those packages are deprecated and will not
+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.23, `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 is
+  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` does not 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 is not 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 using pnpm, Biome, Vitest and mise. The differences:
+
+- **Native TypeScript**: `.projenrc.ts` and the app run with `node` instead of `tsx`, and the
+  tsconfig sets `erasableSyntaxOnly` and `verbatimModuleSyntax` (see
+  [Native TypeScript](./configuration.md#native-typescript)).
+- **`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 `node 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 12 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 are not `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`.

package/lib/components/bundle-lambda-function-code.js

@@ -67,7 +67,7 @@ function convertToPosixPath(p) {
  * single file.
  */
 class Bundler extends projen_1.Component {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Bundler", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Bundler", version: "0.5.2" };
     /**
      * Returns the `Bundler` instance associated with a project or `undefined` if
      * there is no Bundler.
@@ -221,7 +221,7 @@ exports.Bundler = Bundler;
  * });
  */
 class LambdaFunctionCodeBundle extends projen_1.Component {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionCodeBundle", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionCodeBundle", version: "0.5.2" };
     /**
      * Defines a pre-bundled AWS Lambda Function code asset from handler code.
      *
@@ -273,7 +273,7 @@ exports.LambdaFunctionCodeBundle = LambdaFunctionCodeBundle;
  * Creates Lambda Function code bundles from entrypoints discovered in the project's source tree.
  */
 class LambdaFunctionCodeBundler extends projen_1.cdk.AutoDiscoverBase {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionCodeBundler", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionCodeBundler", version: "0.5.2" };
     constructor(project, options) {
         super(project, {
             projectdir: options.srcdir,

package/lib/components/colima.js

@@ -11,7 +11,7 @@ const homebrew_1 = require("./homebrew");
  * Adds Colima support to your project with automatic installation and startup.
  */
 class Colima extends component_1.Component {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Colima", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Colima", version: "0.5.2" };
     constructor(scope) {
         super(scope);
         const project = this.project;

package/lib/components/homebrew.js

@@ -14,7 +14,7 @@ function tapOf(packageName) {
     return parts.length === 3 ? `${parts[0]}/${parts[1]}` : undefined;
 }
 class Homebrew extends component_1.Component {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Homebrew", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Homebrew", version: "0.5.2" };
     static of(project) {
         const isHomebrew = (c) => c instanceof Homebrew;
         return project.components.find(isHomebrew);

package/lib/components/lambda-function-construct-generator.js

@@ -44,7 +44,7 @@ const utils_1 = require("../utils");
  * The bundling happens during projen execution, not during CDK synth, enabling a "build once, deploy many" pattern.
  */
 class LambdaFunctionConstructGenerator extends projen_1.Component {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionConstructGenerator", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LambdaFunctionConstructGenerator", version: "0.5.2" };
     sourceDir;
     outputDir;
     filePattern;

package/lib/components/localstack.js

@@ -12,7 +12,7 @@ const homebrew_1 = require("./homebrew");
  * Adds LocalStack support to your project with automatic Docker/Colima setup.
  */
 class LocalStack extends component_1.Component {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LocalStack", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.LocalStack", version: "0.5.2" };
     constructor(scope, options = {}) {
         super(scope);
         const project = javascript_1.NodeProject.of(this);

package/lib/components/mise.js

@@ -7,7 +7,7 @@ const component_1 = require("projen/lib/component");
 const textfile_1 = require("projen/lib/textfile");
 const homebrew_1 = require("./homebrew");
 class Mise extends component_1.Component {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Mise", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Mise", version: "0.5.2" };
     static of(project) {
         const isMise = (c) => c instanceof Mise;
         return project.components.find(isMise);

package/lib/components/typedoc.js

@@ -34,7 +34,7 @@ const DEFAULT_CONFIG = {
  * TypeDoc component for projen projects
  */
 class TypeDoc extends component_1.Component {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.TypeDoc", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.TypeDoc", version: "0.5.2" };
     static of(project) {
         const isTypeDoc = (c) => c instanceof TypeDoc;
         return project.components.find(isTypeDoc);

package/lib/components/vitest.js

@@ -141,7 +141,7 @@ var CoverageReporter;
     CoverageReporter["TEXT"] = "text";
 })(CoverageReporter || (exports.CoverageReporter = CoverageReporter = {}));
 class Vitest extends component_1.Component {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Vitest", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.Vitest", version: "0.5.2" };
     static of(project) {
         const isVitest = (c) => c instanceof Vitest;
         return project.components.find(isVitest);

package/lib/project-generator.js

@@ -428,7 +428,7 @@ class TypeScriptClassRenderer {
  */
 class ProjectGenerator extends projen.Component {
     options;
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.ProjectGenerator", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.ProjectGenerator", version: "0.5.2" };
     renderer;
     static enumGenerated = false;
     /**

package/lib/projects/awscdk-construct-library.generated.js

@@ -15,7 +15,7 @@ const utils_1 = require("../utils");
  * Extends Projen's base class with opinionated defaults and automatic component setup.
  */
 class AwsCdkConstructLibraryProject extends projen_1.awscdk.AwsCdkConstructLibrary {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.AwsCdkConstructLibraryProject", version: "0.5.2" };
     /**
      * @param options - Project configuration
      */

package/lib/projects/awscdk-typescript-app.generated.js

@@ -15,7 +15,7 @@ const utils_1 = require("../utils");
  * Extends Projen's base class with opinionated defaults and automatic component setup.
  */
 class AwsCdkTypeScriptAppProject extends projen_1.awscdk.AwsCdkTypeScriptApp {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.AwsCdkTypeScriptAppProject", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.AwsCdkTypeScriptAppProject", version: "0.5.2" };
     /**
      * @param options - Project configuration
      */

package/lib/projects/jsii.generated.js

@@ -16,7 +16,7 @@ const utils_1 = require("../utils");
  * Extends Projen's base class with opinionated defaults and automatic component setup.
  */
 class JsiiProject extends projen_1.cdk.JsiiProject {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.JsiiProject", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.JsiiProject", version: "0.5.2" };
     /**
      * @param options - Project configuration
      */

package/lib/projects/typescript.generated.js

@@ -15,7 +15,7 @@ const utils_1 = require("../utils");
  * Extends Projen's base class with opinionated defaults and automatic component setup.
  */
 class TypeScriptProject extends projen_1.typescript.TypeScriptProject {
-    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.TypeScriptProject", version: "0.5.1" };
+    static [JSII_RTTI_SYMBOL_1] = { fqn: "@nikovirtala/projen-constructs.TypeScriptProject", version: "0.5.2" };
     /**
      * @param options - Project configuration
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nikovirtala/projen-constructs",
-  "description": "Projen project types with standard configuration",
+  "description": "Opinionated projen project types that scaffold TypeScript, JSII and AWS CDK repositories with one shared config.",
   "repository": {
     "type": "git",
     "url": "https://github.com/nikovirtala/projen-constructs.git"
@@ -60,7 +60,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.5.1",
+  "version": "0.5.2",
   "types": "lib/index.d.ts",
   "jsii": {
     "outdir": "dist",
@@ -96,6 +96,7 @@
     "test:watch": "projen test:watch",
     "typedoc": "projen typedoc",
     "unbump": "projen unbump",
+    "update-readme": "projen update-readme",
     "update-versions": "projen update-versions",
     "upgrade": "projen upgrade",
     "watch": "projen watch",