Skip to content

[@uswds/uswds]: Fix inaccurate typings for optional elements, add new components #68863

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

Jump to bottom
Merged
typescript-bot merged 5 commits into from
Mar 1, 2024
Merged

[@uswds/uswds]: Fix inaccurate typings for optional elements, add new components #68863

typescript-bot merged 5 commits into from
Mar 1, 2024

Conversation

@aduth
Copy link
Contributor

@aduth aduth commented Mar 1, 2024

Please fill in this template.

If changing an existing definition:

@typescript-bot
Copy link
Contributor

typescript-bot commented Mar 1, 2024 •
edited
Loading

@aduth Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment which I will keep updated.

1 package in this PR

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

You can test the changes of this PR in the Playground.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ✅ Most recent commit is approved by type definition owners, DT maintainers or others

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.

Diagnostic Information: What the bot saw about this PR 
{
  "type": "info",
  "now": "-",
  "pr_number": 68863,
  "author": "aduth",
  "headCommitOid": "d1b238628ec6cf755192a0e9437ae1bd46c8cca0",
  "mergeBaseOid": "1e70b911ff8c1ff74e1ea371115d267c0a383a93",
  "lastPushDate": "2024-03-01T19:00:00.000Z",
  "lastActivityDate": "2024-03-01T22:51:50.000Z",
  "mergeOfferDate": "2024-03-01T22:04:04.000Z",
  "mergeRequestDate": "2024-03-01T22:51:50.000Z",
  "mergeRequestUser": "aduth",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "uswds__uswds",
      "kind": "edit",
      "files": [
        {
          "path": "types/uswds__uswds/js/_usa-password/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-accordion/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-banner/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-button/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-character-count/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-combo-box/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-date-picker/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-date-range-picker/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-file-input/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-footer/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-header/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-in-page-navigation/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-input-mask/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-input-prefix-suffix/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-language-selector/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-modal/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-range/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-search/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-skipnav/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-table/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-time-picker/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-tooltip/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/js/usa-validation/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/uswds__uswds/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/uswds__uswds/uswds__uswds-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "morganmspencer"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "morganmspencer",
      "date": "2024-03-01T22:03:23.000Z",
      "isMaintainer": false
    }
  ],
  "mainBotCommentID": 1973757274,
  "ciResult": "pass"
}

@typescript-bot
Copy link
Contributor

typescript-bot commented Mar 1, 2024

🔔 @morganmspencer — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

@aduth aduth mentioned this pull request Mar 1, 2024
Merged
@aduth
Copy link
Contributor Author

aduth commented Mar 1, 2024

Hi @morganmspencer 👋 Thanks for maintaining these types. I added myself to the owners list here since I'd be willing to help maintain them. I'm a heavy consumer and contributor to USWDS so I'd have an interest in keeping these types accurate and up-to-date. Let me know if there's any issue!

morganspencerdev
morganspencerdev approved these changes Mar 1, 2024
View reviewed changes
Copy link
Contributor

@morganspencerdev morganspencerdev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for submitting these updates!

@typescript-bot typescript-bot added Owner Approved A listed owner of this package signed off on the pull request. Self Merge This PR can now be self-merged by the PR author or an owner labels Mar 1, 2024
@aduth
Copy link
Contributor Author

aduth commented Mar 1, 2024

Ready to merge

@typescript-bot typescript-bot merged commit 792195d into DefinitelyTyped:master Mar 1, 2024
@aduth aduth deleted the aduth-uswds-3-7 branch March 1, 2024 22:58
@aduth
Copy link
Contributor Author

aduth commented Mar 2, 2024

Hey @morganmspencer , I noticed I forgot to update the index.d.ts file as part of this to include range and button. I was going to create a follow-up fix, but in trying to consider how to write tests for this, it occurred to me that the root @uswds/uswds doesn't actually have any exported members, so maybe it's correct to have just js/index.d.ts (imported as @uswds/uswds/js)?

Do you think it could make sense to remove or empty out the contents of index.d.ts?

@aduth aduth mentioned this pull request Mar 20, 2024
Merged
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@morganspencerdev morganspencerdev morganspencerdev approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Owner Approved A listed owner of this package signed off on the pull request. Self Merge This PR can now be self-merged by the PR author or an owner

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@aduth @typescript-bot @morganspencerdev