Skip to content

chore(cli): rename _ to command in UserInput #32822

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 9 commits into from
Jan 10, 2025
Merged

chore(cli): rename _ to command in UserInput #32822

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ab743fa
user-input-gen
kaizencc Jan 9, 2025
de651b2
tests
kaizencc Jan 9, 2025
aa89ea6
deleted cli-args-gen
kaizencc Jan 9, 2025
5ebfc97
finish renaming
kaizencc Jan 9, 2025
7e450f7
chore(cli): rename `_` to `command` in `UserInput`
kaizencc Jan 9, 2025
62b1e26
update test
kaizencc Jan 9, 2025
cf444ec
Merge branch 'main' into conroy/cmdd
kaizencc Jan 10, 2025
2bef77f
update tests
kaizencc Jan 10, 2025
ee888f1
Merge branch 'main' into conroy/cmdd
mergify[bot] 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
2 changes: 1 addition & 1 deletion packages/aws-cdk/lib/convert-to-user-input.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ export function convertYargsToUserInput(args: any): UserInput {
break;
}
const userInput: UserInput = {
_: args._[0],
command: args._[0],
globalOptions,
[args._[0]]: commandOptions,
};
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk/lib/user-input.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export interface UserInput {
/**
* The CLI command name
*/
readonly _?: Command;
readonly command?: Command;

/**
* Global options available to all CLI commands
Expand Down
6 changes: 3 additions & 3 deletions packages/aws-cdk/test/cli-arguments.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ describe('yargs', () => {
const result = convertYargsToUserInput(input);

expect(result).toEqual({
_: 'deploy',
command: 'deploy',
globalOptions: {
app: undefined,
assetMetadata: undefined,
Expand Down Expand Up @@ -73,7 +73,7 @@ describe('yargs', () => {
const result = convertYargsToUserInput(input);

expect(result).toEqual({
_: 'deploy',
command: 'deploy',
deploy: expect.objectContaining({
STACKS: ['stack1', 'stack2'],
}),
Expand All @@ -87,7 +87,7 @@ describe('yargs', () => {
const result = convertYargsToUserInput(input);

expect(result).toEqual({
_: 'acknowledge',
command: 'acknowledge',
acknowledge: expect.objectContaining({
ID: 'id1',
}),
Expand Down
2 changes: 1 addition & 1 deletion tools/@aws-cdk/user-input-gen/lib/convert-to-user-input-gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ function buildPositionalArguments(arg: { name: string; variadic: boolean }, argN
function buildUserInput(argName: string): string {
return [
'const userInput: UserInput = {',
`_: ${argName}._[0],`,
`command: ${argName}._[0],`,
'globalOptions,',
`[${argName}._[0]]: commandOptions`,
'}',
Expand Down
2 changes: 1 addition & 1 deletion tools/@aws-cdk/user-input-gen/lib/user-input-gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export async function renderUserInputType(config: CliConfig): Promise<string> {
const commandEnum = Type.fromName(scope, 'Command');

userInputType.addProperty({
name: '_',
name: 'command',
type: commandEnum,
docs: {
summary: 'The CLI command name',
Expand Down
2 changes: 1 addition & 1 deletion tools/@aws-cdk/user-input-gen/test/convert-to-user-input-gen.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ describe('render', () => {
break;
}
const userInput: UserInput = {
_: args._[0],
command: args._[0],
globalOptions,
[args._[0]]: commandOptions,
};
Expand Down
6 changes: 3 additions & 3 deletions tools/@aws-cdk/user-input-gen/test/user-input-gen.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ describe('render', () => {
/**
* The CLI command name
*/
readonly _?: Command;
readonly command?: Command;

/**
* Global options available to all CLI commands
Expand Down Expand Up @@ -169,7 +169,7 @@ describe('render', () => {
/**
* The CLI command name
*/
readonly _?: Command;
readonly command?: Command;

/**
* Global options available to all CLI commands
Expand Down Expand Up @@ -251,7 +251,7 @@ describe('render', () => {
/**
* The CLI command name
*/
readonly _?: Command;
readonly command?: Command;

/**
* Global options available to all CLI commands
Expand Down
Loading