Skip to content

chore(cli): synth is now default command name, synthesize is alias #32823

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 10, 2025
Merged

chore(cli): synth is now default command name, synthesize is alias #32823

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3c427e3
chore(cli): synth is default command name, synthesize is alias
kaizencc Jan 9, 2025
fb847a1
Merge branch 'main' into conroy/synth
kaizencc Jan 9, 2025
20839d3
Merge branch 'main' into conroy/synth
kaizencc Jan 10, 2025
197f3f0
fix merge and test
kaizencc Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions packages/aws-cdk/lib/cli-arguments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ export interface CliArguments {
/**
* Synthesizes and prints the CloudFormation template for this stack
*
* aliases: synth
* aliases: synthesize
*/
readonly synthesize?: SynthesizeOptions;
readonly synth?: SynthOptions;

/**
* Deploys the CDK toolkit stack into an AWS environment
Expand Down Expand Up @@ -337,11 +337,11 @@ export interface ListOptions {
/**
* Synthesizes and prints the CloudFormation template for this stack
*
* aliases: synth
* aliases: synthesize
*
* @struct
*/
export interface SynthesizeOptions {
export interface SynthOptions {
/**
* Only synthesize requested stacks, don't include dependencies
*
Expand All @@ -368,7 +368,7 @@ export interface SynthesizeOptions {
readonly quiet?: boolean;

/**
* Positional argument for synthesize
* Positional argument for synth
*/
readonly STACKS?: Array<string>;
}
Expand Down
4 changes: 2 additions & 2 deletions packages/aws-cdk/lib/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ export async function makeConfig(): Promise<CliConfig> {
'show-dependencies': { type: 'boolean', default: false, alias: 'd', desc: 'Display stack dependency information for each stack' },
},
},
synthesize: {
synth: {
arg: {
name: 'STACKS',
variadic: true,
},
aliases: ['synth'],
aliases: ['synthesize'],
description: 'Synthesizes and prints the CloudFormation template for this stack',
options: {
exclusively: { type: 'boolean', alias: 'e', desc: 'Only synthesize requested stacks, don\'t include dependencies' },
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk/lib/convert-to-cli-args.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export function convertToCliArgs(args: any): CliArguments {
};
break;

case 'synthesize':
case 'synth':
commandOptions = {
exclusively: args.exclusively,
validation: args.validation,
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk/lib/parse-command-line-arguments.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ export function parseCommandLineArguments(args: Array<string>): any {
desc: 'Display stack dependency information for each stack',
}),
)
.command(['synthesize [STACKS..]', 'synth [STACKS..]'], 'Synthesizes and prints the CloudFormation template for this stack', (yargs: Argv) =>
.command(['synth [STACKS..]', 'synthesize [STACKS..]'], 'Synthesizes and prints the CloudFormation template for this stack', (yargs: Argv) =>
yargs
.option('exclusively', {
default: undefined,
Expand Down
Loading