Put asserts on various assert* functions in chai.

[bmeurer]

Please fill in this template.

• Use a meaningful title for the pull request. Include the name of the package modified.
• Test the change in your own code. (Compile and run.)
• Add or edit tests to reflect the change.
• Follow the advice from the readme.
• Avoid common mistakes.
• Run pnpm test <package to test>.

Select one of these and delete the others:

If changing an existing definition:

• Provide a URL to documentation or source code which provides context for the suggested changes: https://www.chaijs.com/api/assert/

Why?

I'm testing the waters here to see how folks feel about these changes. We're using chai quite extensively in Chrome DevTools and the fact that assert functions don't play well with control flow based type narrowing is quite annoying (and we even ended up wrapping the asserts into otherwise useless helpers). We believe this should be solved here.

[typescript-bot]

@bmeurer 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

• chai — on npm, on unpkg

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

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 a DT maintainer

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": 68780,
  "author": "bmeurer",
  "headCommitOid": "566728e4021d8b46f2d3bafb42a9812119256795",
  "mergeBaseOid": "22f4f44996fbf0d550ac70c977bef5377bacc938",
  "lastPushDate": "2024-02-27T15:10:19.000Z",
  "lastActivityDate": "2024-03-19T07:32:44.000Z",
  "mergeOfferDate": "2024-03-18T19:01:44.000Z",
  "mergeRequestDate": "2024-03-19T07:32:44.000Z",
  "mergeRequestUser": "bmeurer",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "chai",
      "kind": "edit",
      "files": [
        {
          "path": "types/chai/chai-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/chai/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "Bartvds",
        "AGBrown",
        "olivr70",
        "mwistrand",
        "shaunluttin",
        "micksatana",
        "ErikSchierboom",
        "bparan",
        "CXuesong",
        "joeykilpatrick"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "sheetalkamat",
      "date": "2024-03-18T19:00:56.000Z",
      "isMaintainer": true
    }
  ],
  "mainBotCommentID": 1966774437,
  "ciResult": "pass"
}

[typescript-bot]

🔔 @Bartvds @AGBrown @olivr70 @mwistrand @shaunluttin @micksatana @ErikSchierboom @bparan @CXuesong @joeykilpatrick — 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.

[typescript-bot]

Re-ping @Bartvds, @AGBrown, @olivr70, @mwistrand, @shaunluttin, @micksatana, @ErikSchierboom, @bparan, @CXuesong, @joeykilpatrick:

This PR has been out for over a week, yet I haven't seen any reviews.

Could someone please give it some attention? Thanks!

[weswigham]

I think this is a good idea, but would like to give the actual type maintainers a bit more time to weigh in before I give this a merge. I'll probably stop by again later in the week, and if things are still silent from the pinged individuals, just merge it.

[bmeurer]

I think this is a good idea, but would like to give the actual type maintainers a bit more time to weigh in before I give this a merge. I'll probably stop by again later in the week, and if things are still silent from the pinged individuals, just merge it.

Thanks for the review. As mentioned, I'm mostly testing the waters here. Happy to expand this to cover more of the assert functions if you guys are okay with upstreaming this.

[typescript-bot]

It has been more than two weeks and this PR still has no reviews.

I'll bump it to the DT maintainer queue. Thank you for your patience, @bmeurer.

(Ping @Bartvds, @AGBrown, @olivr70, @mwistrand, @shaunluttin, @micksatana, @ErikSchierboom, @bparan, @CXuesong, @joeykilpatrick.)

[typescript-bot]

@bmeurer: Everything looks good here. I am ready to merge this PR (at 566728e) on your behalf whenever you think it's ready.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

(@Bartvds, @AGBrown, @olivr70, @mwistrand, @shaunluttin, @micksatana, @ErikSchierboom, @bparan, @CXuesong, @joeykilpatrick: you can do this too.)

[bmeurer]

Ready to merge