feat(cli): add package manager option to cdk init #961

ren-yamanashi · 2025-11-26T13:43:04Z

Fixes #940

Adds --package-manager option to cdk init for choosing npm, yarn, or pnpm when initializing TypeScript/JavaScript projects.

Usage

cdk init app -l ts --package-manager npm
cdk init app -l ts --package-manager yarn
cdk init app -l ts --package-manager pnpm
cdk init app -l ts --package-manager bun

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

codecov-commenter · 2025-11-26T13:52:29Z

Codecov Report

❌ Patch coverage is 94.11765% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 87.40%. Comparing base (2a6f8d3) to head (e251095).

Files with missing lines	Patch %	Lines
packages/aws-cdk/lib/cli/cli.ts	0.00%	1 Missing ⚠️
packages/aws-cdk/lib/commands/init/init.ts	96.42%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #961      +/-   ##
==========================================
+ Coverage   87.38%   87.40%   +0.02%     
==========================================
  Files          71       72       +1     
  Lines       10010    10036      +26     
  Branches     1311     1314       +3     
==========================================
+ Hits         8747     8772      +25     
  Misses       1240     1240              
- Partials       23       24       +1

Flag	Coverage Δ
suite.unit	`87.40% <94.11%> (+0.02%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…nto feat(init)/support-package-manager-option

packages/aws-cdk/lib/cli/cli-type-registry.json

mrgrain

Thanks, few notes.

packages/aws-cdk/lib/cli/cli-config.ts

mrgrain · 2025-12-04T17:29:18Z

packages/aws-cdk/lib/cli/user-input.ts

+  /**
+   * The package manager to use to install dependencies. Only applicable for TypeScript and JavaScript projects.
+   *
+   * @default - undefined


instead of undefined describe what it does

This JSDoc is auto generated during the build process, and as mentioned in #961 (comment) comments, I think difficult to change this @default comment because package-manager option can't set default value.

packages/aws-cdk/lib/commands/init/init.ts

…nto feat(init)/support-package-manager-option

ren-yamanashi

@mrgrain

Thanks review! I fixed.

packages/aws-cdk/lib/cli/cli-type-registry.json

packages/aws-cdk/lib/cli/cli-config.ts

ren-yamanashi · 2025-12-06T06:34:08Z

packages/aws-cdk/lib/cli/user-input.ts

+  /**
+   * The package manager to use to install dependencies. Only applicable for TypeScript and JavaScript projects.
+   *
+   * @default - undefined


packages/aws-cdk/lib/commands/init/init.ts

mrgrain

almost there!

mrgrain · 2025-12-06T23:57:46Z

packages/aws-cdk/lib/cli/cli-config.ts

          'from-path': { type: 'string', desc: 'Path to a local custom template directory or multi-template repository', requiresArg: true, conflicts: ['lib-version'] },
          'template-path': { type: 'string', desc: 'Path to a specific template within a multi-template repository', requiresArg: true },
-          'package-manager': { type: 'string', desc: 'The package manager to use to install dependencies. Only applicable for TypeScript and JavaScript projects.', choices: JS_PACKAGE_MANAGERS },
+          'package-manager': { type: 'string', desc: 'The package manager to use to install dependencies. Only applicable for TypeScript and JavaScript projects.', default: JS_PACKAGE_MANAGER.NPM, choices: Object.values(JS_PACKAGE_MANAGER) },


we can't add a default here, this will now always cause a warning for other languages

mrgrain · 2025-12-06T23:58:40Z

packages/aws-cdk/test/commands/init.test.ts

+      await withTempDir(async (workDir) => {
+        const warnSpy = jest.spyOn(ioHelper.defaults, 'warn');
+
+        await cliInit({


I'm aware there's no infrastructure yet for this in this test file, but can we make this an end-to-end test of the CLI please, instead of testing just cliInit. Same for the other one.

I fixed some test cases. deedd00

I'm aware there's no infrastructure yet for this in this test file

I referred to test that was already implemented as an E2E test.

aws-cdk-cli/packages/aws-cdk/test/commands/init.test.ts

Lines 732 to 746 in deedd00

cliTest('conflict between lib-version and from-path is enforced', async (workDir) => {

const { exec } = await import('child_process');

const { promisify } = await import('util');

const execAsync = promisify(exec);

const templateDir = await createSingleLanguageTemplate(workDir, 'conflict-test', 'typescript');

const cdkBin = path.join(__dirname, '..', '..', 'bin', 'cdk');

// Test that using both flags together causes an error

await expect(execAsync(`node ${cdkBin} init app --language typescript --lib-version 2.0.0 --from-path ${templateDir} --generate-only`, {

cwd: workDir,

env: { ...process.env, CDK_DISABLE_VERSION_CHECK: '1' },

})).rejects.toThrow();

});

Same for the other one.

Would you suggesting that test cases within describe('package-manager option' should also be made into e2e tests? Or suggesting that all test cases within describe('validate CLI init options' should be made into e2e tests?

I suspect it's latter, so I've implemented it that way (please comment if I'm mistaken).

ren-yamanashi

@mrgrain

I fixed! Please confirm.

ren-yamanashi · 2025-12-07T02:39:08Z

packages/aws-cdk/lib/cli/cli-config.ts

          'from-path': { type: 'string', desc: 'Path to a local custom template directory or multi-template repository', requiresArg: true, conflicts: ['lib-version'] },
          'template-path': { type: 'string', desc: 'Path to a specific template within a multi-template repository', requiresArg: true },
-          'package-manager': { type: 'string', desc: 'The package manager to use to install dependencies. Only applicable for TypeScript and JavaScript projects.', choices: JS_PACKAGE_MANAGERS },
+          'package-manager': { type: 'string', desc: 'The package manager to use to install dependencies. Only applicable for TypeScript and JavaScript projects.', default: JS_PACKAGE_MANAGER.NPM, choices: Object.values(JS_PACKAGE_MANAGER) },


ren-yamanashi · 2025-12-07T02:39:23Z

packages/aws-cdk/lib/cli/user-input.ts

+  /**
+   * The package manager to use to install dependencies. Only applicable for TypeScript and JavaScript projects.
+   *
+   * @default - undefined


This JSDoc is auto generated during the build process, and as mentioned in #961 (comment) comments, I think difficult to change this @default comment because package-manager option can't set default value.

ren-yamanashi · 2025-12-07T05:13:24Z

packages/aws-cdk/test/commands/init.test.ts

+      await withTempDir(async (workDir) => {
+        const warnSpy = jest.spyOn(ioHelper.defaults, 'warn');
+
+        await cliInit({


I fixed some test cases. deedd00

I'm aware there's no infrastructure yet for this in this test file

I referred to test that was already implemented as an E2E test.

aws-cdk-cli/packages/aws-cdk/test/commands/init.test.ts

Lines 732 to 746 in deedd00

cliTest('conflict between lib-version and from-path is enforced', async (workDir) => {

const { exec } = await import('child_process');

const { promisify } = await import('util');

const execAsync = promisify(exec);

const templateDir = await createSingleLanguageTemplate(workDir, 'conflict-test', 'typescript');

const cdkBin = path.join(__dirname, '..', '..', 'bin', 'cdk');

// Test that using both flags together causes an error

await expect(execAsync(`node ${cdkBin} init app --language typescript --lib-version 2.0.0 --from-path ${templateDir} --generate-only`, {

cwd: workDir,

env: { ...process.env, CDK_DISABLE_VERSION_CHECK: '1' },

})).rejects.toThrow();

});

Same for the other one.

Would you suggesting that test cases within describe('package-manager option' should also be made into e2e tests? Or suggesting that all test cases within describe('validate CLI init options' should be made into e2e tests?

I suspect it's latter, so I've implemented it that way (please comment if I'm mistaken).

feat(init): add package manager option to cdk init

2870fad

ren-yamanashi requested a deployment to integ-approval November 26, 2025 13:43 — with GitHub Actions Waiting

aws-cdk-automation requested a review from a team November 26, 2025 13:43

github-actions bot added feature-request p2 labels Nov 26, 2025

feat: update

22ebe3d

ren-yamanashi requested a deployment to integ-approval November 26, 2025 14:38 — with GitHub Actions Waiting

ren-yamanashi changed the title ~~feat(init): add package manager option to cdk init~~ feat(cli): add package manager option to cdk init Nov 26, 2025

Merge branch 'main' of https://github.com/ren-yamanashi/aws-cdk-cli i…

6e3cbca

…nto feat(init)/support-package-manager-option

ren-yamanashi requested a deployment to integ-approval November 26, 2025 14:39 — with GitHub Actions Waiting

feat: update

751bfeb

ren-yamanashi requested a deployment to integ-approval November 26, 2025 15:06 — with GitHub Actions Waiting

test: update

8bfcafd

ren-yamanashi requested a deployment to integ-approval November 26, 2025 15:09 — with GitHub Actions Waiting

test: update

40ad75c

ren-yamanashi requested a deployment to integ-approval November 26, 2025 15:10 — with GitHub Actions Waiting

test: update

60297e6

ren-yamanashi requested a deployment to integ-approval November 26, 2025 15:12 — with GitHub Actions Waiting

test: update

58d5af4

ren-yamanashi requested a deployment to integ-approval November 26, 2025 15:31 — with GitHub Actions Waiting

test: update

c12960f

ren-yamanashi requested a deployment to integ-approval November 26, 2025 15:40 — with GitHub Actions Waiting

test: update

4fc01f6

ren-yamanashi requested a deployment to integ-approval November 26, 2025 15:59 — with GitHub Actions Waiting

ren-yamanashi marked this pull request as ready for review November 26, 2025 16:07

mrgrain reviewed Dec 4, 2025

View reviewed changes

packages/aws-cdk/lib/cli/cli-type-registry.json Show resolved Hide resolved

mrgrain requested changes Dec 4, 2025

View reviewed changes

ren-yamanashi added 2 commits December 6, 2025 14:47

add default (npm)

d02f3d2

add bun

65c69d8

ren-yamanashi added 3 commits December 6, 2025 14:54

Merge branch 'main' of https://github.com/ren-yamanashi/aws-cdk-cli i…

bf552cb

…nto feat(init)/support-package-manager-option

update default comments

0eeb924

add validate option logic

cad7630

ren-yamanashi requested a deployment to integ-approval December 6, 2025 06:32 — with GitHub Actions Waiting

minor change

421227f

ren-yamanashi requested a deployment to integ-approval December 6, 2025 06:35 — with GitHub Actions Waiting

minor change

2507e8f

ren-yamanashi requested a deployment to integ-approval December 6, 2025 06:44 — with GitHub Actions Waiting

ren-yamanashi commented Dec 6, 2025

View reviewed changes

mrgrain requested changes Dec 6, 2025

View reviewed changes

rm default value at cli-config.ts

1292545

ren-yamanashi requested a deployment to integ-approval December 7, 2025 02:34 — with GitHub Actions Waiting

update test

deedd00

ren-yamanashi requested a deployment to integ-approval December 7, 2025 04:57 — with GitHub Actions Waiting

minor change

e251095

ren-yamanashi requested a deployment to integ-approval December 7, 2025 05:17 — with GitHub Actions Waiting

ren-yamanashi commented Dec 7, 2025

View reviewed changes

	cliTest('conflict between lib-version and from-path is enforced', async (workDir) => {
	const { exec } = await import('child_process');
	const { promisify } = await import('util');
	const execAsync = promisify(exec);

	const templateDir = await createSingleLanguageTemplate(workDir, 'conflict-test', 'typescript');

	const cdkBin = path.join(__dirname, '..', '..', 'bin', 'cdk');

	// Test that using both flags together causes an error
	await expect(execAsync(`node ${cdkBin} init app --language typescript --lib-version 2.0.0 --from-path ${templateDir} --generate-only`, {
	cwd: workDir,
	env: { ...process.env, CDK_DISABLE_VERSION_CHECK: '1' },
	})).rejects.toThrow();
	});

feat(cli): add package manager option to cdk init #961

Are you sure you want to change the base?

feat(cli): add package manager option to cdk init #961

Uh oh!

Conversation

ren-yamanashi commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Usage

Uh oh!

codecov-commenter commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

mrgrain left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ren-yamanashi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mrgrain left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ren-yamanashi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ren-yamanashi commented Nov 26, 2025 •

edited

Loading

codecov-commenter commented Nov 26, 2025 •

edited

Loading