Merge pull request #12 from alma-cdk/feature/allow-cdk-version-override

feat: add cdkVersion option to AlmaCdkConstructLibraryOptions

Author: aripalo

API.md

@@ -12,7 +12,6 @@ import { uniqueKeywordsCaseInsensitive } from './uniqueKeywordsCaseInsensitive';
 
 export type { AlmaCdkConstructLibraryOptions } from './schemas/almaCdkConstructLibraryOptions';
 
-const CDK_VERSION = '2.220.0';
 const CONSTRUCTS_VERSION = '10.3.0';
 const JSII_VERSION = '~5.9.0';
 const JEST_VERSION = '^30';
@@ -101,7 +100,6 @@ function buildAwsCdkConstructLibraryOptions(
       ? buildPublishToGoOptions(validatedOptions.repositoryUrl)
       : undefined,
     // CDK
-    cdkVersion: CDK_VERSION,
     constructsVersion: CONSTRUCTS_VERSION,
     // Git & dev
     gitignore: [...DEFAULT_GITIGNORE_PATTERNS],

src/AlmaCdkConstructLibrary.ts

@@ -1,3 +1,4 @@
+export { CDK_DEFAULT_VERSION } from './schemas/almaCdkConstructLibraryOptions';
 export {
   AlmaCdkConstructLibrary,
   type AlmaCdkConstructLibraryOptions,

src/index.ts

@@ -16,10 +16,10 @@ function coerceValidSemver(value: string): semver.SemVer | null {
 }
 
 /**
- * Node/engine version: must be valid semver or coercible to one (e.g. major-only `20`).
+ * Version string: valid semver or coercible to one (e.g. major-only `20`, full `2.220.0`).
  * Parsed output is the original string — no normalization (e.g. `20` stays `20`, not `20.0.0`).
  */
-const nodeVersionStringSchema = z.string().refine(
+const versionStringSchema = z.string().refine(
   (s) => coerceValidSemver(s) != null,
   { message: 'Must be a valid semver or coercible to one' },
 );
@@ -79,6 +79,8 @@ export interface AlmaCdkConstructLibraryOptions {
   readonly pnpmSettings?: PnpmWorkspaceSpecification;
   /** Appended to generated `sonar-project.properties` after the default lines (e.g. Sonar multicriteria ignores). */
   readonly sonarProjectPropertiesExtraLines?: string[];
+  /** AWS CDK version for the generated library (semver or coercible, same rules as Node version fields); when omitted, defaults to the exported `CDK_DEFAULT_VERSION` constant. */
+  readonly cdkVersion?: string;
   readonly golang?: boolean;
   readonly python?: boolean;
 }
@@ -92,6 +94,9 @@ const NODEJS_MIN_VERSION = '20';
 const NODEJS_MAX_VERSION = '24';
 const NODEJS_WORKFLOW_VERSION = NODEJS_MAX_VERSION;
 
+/** Default AWS CDK version passed to projen when `cdkVersion` is omitted from options. */
+export const CDK_DEFAULT_VERSION = '2.220.0';
+
 
 /** Projen AwsCdkConstructLibrary options with validation and defaults (min/max/workflow Node versions, package name, etc.). */
 // JSII cannot infer this schema shape cleanly, so we keep the runtime schema
@@ -114,11 +119,12 @@ export const almaCdkConstructLibraryOptionsSchema = z
     devDeps: z.array(z.string()).optional(),
     bundledDeps: z.array(z.string()).optional(),
     codeCov: z.boolean().default(false),
-    minNodeVersion: nodeVersionStringSchema.default(NODEJS_MIN_VERSION),
-    workflowNodeVersion: nodeVersionStringSchema.default(NODEJS_WORKFLOW_VERSION),
-    maxNodeVersion: nodeVersionStringSchema.default(NODEJS_MAX_VERSION),
+    minNodeVersion: versionStringSchema.default(NODEJS_MIN_VERSION),
+    workflowNodeVersion: versionStringSchema.default(NODEJS_WORKFLOW_VERSION),
+    maxNodeVersion: versionStringSchema.default(NODEJS_MAX_VERSION),
     pnpmSettings: pnpmSettingsSchema.optional(),
     sonarProjectPropertiesExtraLines: z.array(z.string()).optional(),
+    cdkVersion: versionStringSchema.default(CDK_DEFAULT_VERSION),
     golang: z.boolean().default(true),
     python: z.boolean().default(true),
   })

src/schemas/almaCdkConstructLibraryOptions.ts

@@ -2,6 +2,7 @@ import { cdk } from 'projen';
 import {
   almaCdkConstructLibraryOptionsSchema,
   branchOptionsSchema,
+  CDK_DEFAULT_VERSION,
 } from '../../src/schemas/almaCdkConstructLibraryOptions';
 
 const validBaseOptions = {
@@ -68,6 +69,7 @@ describe('almaCdkConstructLibraryOptionsSchema', () => {
     expect(result.minNodeVersion).toBe('20');
     expect(result.workflowNodeVersion).toBe('24');
     expect(result.maxNodeVersion).toBe('24');
+    expect(result.cdkVersion).toBe(CDK_DEFAULT_VERSION);
   });
 
   it('applies default Node versions when omitted', () => {
@@ -88,6 +90,23 @@ describe('almaCdkConstructLibraryOptionsSchema', () => {
     expect(result.codeCov).toBe(true);
   });
 
+  it('accepts cdkVersion override', () => {
+    const result = almaCdkConstructLibraryOptionsSchema.parse({
+      ...validBaseOptions,
+      cdkVersion: '2.100.0',
+    });
+    expect(result.cdkVersion).toBe('2.100.0');
+  });
+
+  it('rejects invalid semver for cdkVersion', () => {
+    expect(() =>
+      almaCdkConstructLibraryOptionsSchema.parse({
+        ...validBaseOptions,
+        cdkVersion: 'not-semver',
+      }),
+    ).toThrow();
+  });
+
   it('accepts custom Node versions when min <= workflow <= max', () => {
     const result = almaCdkConstructLibraryOptionsSchema.parse({
       ...validBaseOptions,