chore(cli): `CliArguments` interface generated from config.ts #32556

kaizencc · 2024-12-17T19:01:15Z

This PR:

generates a new type, CliArguments which is an interface created from the cli source-of-truth in config.ts.
renames yargs-gen into cli-args-gen to better reflect what we are generating now

The purpose of CliArguments is to eventually replace our current Arguments type, turning it into a strongly-typed object. Arguments today looks like this:

export type Arguments = {
  readonly _: [Command, ...string[]];
  readonly exclusively?: boolean;
  readonly STACKS?: string[];
  readonly lookups?: boolean;
  readonly [name: string]: unknown;
};

And because the last line in the definition essentially accepts any kind of property, we end up passing in and using values that are not documented anywhere. The purpose of this PR is to introduce a better type to enforce that the args object in cli.ts only holds values we expect. We are not currently using the new type anywhere; that will be done in a subsequent PR.

The success criteria of this PR is that we are generating a new type from the source of truth that will eventually represent the type of the object we receive from CLI inputs.

Part of #32474

Checklist

My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

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

aws-cdk-automation

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

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

packages/aws-cdk/lib/config.ts

tools/@aws-cdk/cli-args-gen/lib/cli-type-gen.ts

kaizencc · 2024-12-17T19:05:44Z

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

+  /**
+   * The CLI command name followed by any properties of the command
+   */
+  readonly _: Array<string>;


This is supposed to be typed [Command, ...string] but I don't have a good way of doing that via code-gen (enlighten me if you think differently). Instead I plan to validate that the first array element is a valid Command when I am converting the input into this type.

we might also want to pull out the additional elements into its own STACKS property, as that is what the current Arguments type does:

export type Arguments = { readonly _: [Command, ...string[]]; readonly exclusively?: boolean; readonly STACKS?: string[]; readonly lookups?: boolean; readonly [name: string]: unknown; };

You could just not include it hear, keep this interface to just the auto-generated stuff and inside the CLI have an interface extending the codegen'd one with whatever extra types you need.

Misusing ambient should work: Type.ambient('[Command, ...string[]]') You'll have to import Command manually though.

Otherwise we would need proper support for this in typewriter:

A new Type.variadic(elementType: Type)

A new Type.tuple(...elementTypes: Type[])

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

codecov · 2024-12-17T19:15:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.13%. Comparing base (d5e45c4) to head (5f2d7c7).

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #32556      +/-   ##
==========================================
+ Coverage   78.86%   79.13%   +0.26%     
==========================================
  Files         108      107       -1     
  Lines        7165     7131      -34     
  Branches     1319     1319              
==========================================
- Hits         5651     5643       -8     
+ Misses       1330     1304      -26     
  Partials      184      184

Flag	Coverage Δ
suite.unit	`79.13% <ø> (+0.26%)`	⬆️

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

Components	Coverage Δ
packages/aws-cdk	`79.13% <ø> (+0.26%)`	⬆️

aws-cdk-automation · 2024-12-17T20:40:32Z

➡️ PR build request submitted to test-main-pipeline ⬅️

A maintainer must now check the pipeline and add the pr-linter/cli-integ-tested label once the pipeline succeeds.

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

tools/@aws-cdk/cli-args-gen/test/cli.test.ts

tools/@aws-cdk/cli-args-gen/lib/cli-type-gen.ts

mrgrain

Note: The package rename could have been a separate PR that would be very easy to approve.

Co-authored-by: Momo Kornher <kornherm@amazon.co.uk>

…egenwork

mergify · 2024-12-19T19:08:06Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2024-12-19T19:47:46Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2024-12-19T19:47:51Z

This pull request has been removed from the queue for the following reason: pull request dequeued.

Pull request #32556 has been dequeued. The pull request could not be merged. This could be related to an activated branch protection or ruleset rule that prevents us from merging. (detail: 3 of 6 required status checks have not succeeded: 2 expected and 1 failing.).

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

…nto conroy/codegenwork

aws-cdk-automation · 2024-12-19T20:19:15Z

AWS CodeBuild CI Report

CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
Commit ID: 5f2d7c7
Result: SUCCEEDED
Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

mergify · 2024-12-19T20:19:37Z

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

mergify · 2024-12-19T20:19:43Z

This pull request has been removed from the queue for the following reason: pull request dequeued.

Pull request #32556 has been dequeued. The pull request could not be merged. This could be related to an activated branch protection or ruleset rule that prevents us from merging. (detail: 4 of 6 required status checks are expected.).

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

kaizencc · 2024-12-19T21:09:03Z

@Mergifyio refresh

mergify · 2024-12-19T21:09:05Z

refresh

✅ Pull request refreshed

github-actions · 2024-12-19T21:09:59Z

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

kaizencc added 4 commits December 17, 2024 13:01

initial codegen

e0c3d68

cli type defined with docs

d06f939

rename yargs-gen into cli-args-gen

14df9b4

more package renaming, + type renamed to CliArguments

dbbd144

kaizencc requested a review from a team as a code owner December 17, 2024 19:01

kaizencc changed the title ~~chore(cli): add CliArguments type generated from config.ts~~ chore(cli): CliArguments type generated from config.ts Dec 17, 2024

aws-cdk-automation requested a review from a team December 17, 2024 19:01

github-actions bot added the p2 label Dec 17, 2024

mergify bot added the contribution/core This is a PR that came from AWS. label Dec 17, 2024

kaizencc had a problem deploying to test-pipeline December 17, 2024 19:02 — with GitHub Actions Failure

aws-cdk-automation previously requested changes Dec 17, 2024

View reviewed changes

aws-cdk-automation added the pr/needs-cli-test-run This PR needs CLI tests run against it. label Dec 17, 2024

kaizencc commented Dec 17, 2024

View reviewed changes

snapshot test

491e2fc

kaizencc temporarily deployed to test-pipeline December 17, 2024 19:47 — with GitHub Actions Inactive

kaizencc changed the title ~~chore(cli): CliArguments type generated from config.ts~~ chore(cli): CliArguments interface generated from config.ts Dec 17, 2024

kaizencc added pr-linter/cli-integ-tested Assert that any CLI changes have been integ tested and removed pr/needs-cli-test-run This PR needs CLI tests run against it. labels Dec 17, 2024

aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 17, 2024

mrgrain reviewed Dec 18, 2024

View reviewed changes

tools/@aws-cdk/cli-args-gen/test/cli.test.ts Outdated Show resolved Hide resolved

mrgrain reviewed Dec 18, 2024

View reviewed changes

tools/@aws-cdk/cli-args-gen/lib/cli-type-gen.ts Outdated Show resolved Hide resolved

mrgrain requested changes Dec 18, 2024

View reviewed changes

aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Dec 18, 2024

kaizencc and others added 2 commits December 18, 2024 13:47

Update tools/@aws-cdk/cli-args-gen/lib/cli-type-gen.ts

b614ca5

Co-authored-by: Momo Kornher <kornherm@amazon.co.uk>

Merge branch 'main' into conroy/codegenwork

7ded3c4

kaizencc had a problem deploying to test-pipeline December 18, 2024 18:48 — with GitHub Actions Failure

separate out two test files

edf4200

import Command enum correctly

8b462d2

kaizencc had a problem deploying to test-pipeline December 18, 2024 19:10 — with GitHub Actions Failure

fix eslint rules

3b17714

kaizencc had a problem deploying to test-pipeline December 18, 2024 19:17 — with GitHub Actions Failure

kaizencc requested a review from mrgrain December 18, 2024 23:57

mrgrain approved these changes Dec 19, 2024

View reviewed changes

Merge branch 'main' into conroy/codegenwork

e2d28f8

kaizencc had a problem deploying to test-pipeline December 19, 2024 17:41 — with GitHub Actions Failure

ignore file in codecov

c23c9a0

kaizencc had a problem deploying to test-pipeline December 19, 2024 18:31 — with GitHub Actions Failure

kaizencc added 2 commits December 19, 2024 13:36

fix up test

d3b3907

Merge branch 'main' of https://github.com/aws/aws-cdk into conroy/cod…

fb5c593

…egenwork

kaizencc had a problem deploying to test-pipeline December 19, 2024 18:38 — with GitHub Actions Failure

Merge branch 'main' into conroy/codegenwork

185dce4

mergify bot had a problem deploying to test-pipeline December 19, 2024 19:18 Failure

kaizencc added 2 commits December 19, 2024 14:48

codecov ignore

ad3a524

Merge branch 'conroy/codegenwork' of https://github.com/aws/aws-cdk i…

5f2d7c7

…nto conroy/codegenwork

kaizencc had a problem deploying to test-pipeline December 19, 2024 19:49 — with GitHub Actions Failure

mergify bot merged commit dc1647e into main Dec 19, 2024
16 of 17 checks passed

mergify bot deleted the conroy/codegenwork branch December 19, 2024 21:09

github-actions bot locked as resolved and limited conversation to collaborators Dec 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(cli): `CliArguments` interface generated from config.ts #32556

chore(cli): `CliArguments` interface generated from config.ts #32556

kaizencc commented Dec 17, 2024 •

edited

Loading

aws-cdk-automation left a comment

kaizencc Dec 17, 2024

kaizencc Dec 17, 2024

mrgrain Dec 18, 2024

mrgrain Dec 18, 2024

codecov bot commented Dec 17, 2024 •

edited

Loading

aws-cdk-automation commented Dec 17, 2024

mrgrain left a comment

mergify bot commented Dec 19, 2024

mergify bot commented Dec 19, 2024

mergify bot commented Dec 19, 2024

aws-cdk-automation commented Dec 19, 2024

mergify bot commented Dec 19, 2024

mergify bot commented Dec 19, 2024

kaizencc commented Dec 19, 2024

mergify bot commented Dec 19, 2024

github-actions bot commented Dec 19, 2024

chore(cli): CliArguments interface generated from config.ts #32556

chore(cli): CliArguments interface generated from config.ts #32556

Conversation

kaizencc commented Dec 17, 2024 • edited Loading

Checklist

aws-cdk-automation left a comment

Choose a reason for hiding this comment

kaizencc Dec 17, 2024

Choose a reason for hiding this comment

kaizencc Dec 17, 2024

Choose a reason for hiding this comment

mrgrain Dec 18, 2024

Choose a reason for hiding this comment

mrgrain Dec 18, 2024

Choose a reason for hiding this comment

codecov bot commented Dec 17, 2024 • edited Loading

Codecov Report

aws-cdk-automation commented Dec 17, 2024

mrgrain left a comment

Choose a reason for hiding this comment

mergify bot commented Dec 19, 2024

mergify bot commented Dec 19, 2024

mergify bot commented Dec 19, 2024

aws-cdk-automation commented Dec 19, 2024

AWS CodeBuild CI Report

mergify bot commented Dec 19, 2024

mergify bot commented Dec 19, 2024

kaizencc commented Dec 19, 2024

mergify bot commented Dec 19, 2024

✅ Pull request refreshed

github-actions bot commented Dec 19, 2024

chore(cli): `CliArguments` interface generated from config.ts #32556

chore(cli): `CliArguments` interface generated from config.ts #32556

kaizencc commented Dec 17, 2024 •

edited

Loading

codecov bot commented Dec 17, 2024 •

edited

Loading