Package Proclaim: Make msg parameter optional for all assertions by JakeChampion · Pull Request #46905 · DefinitelyTyped/DefinitelyTyped

JakeChampion · 2020-08-19T16:19:18Z

I help maintain the Proclaim library

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. (Run with npm test.)
Follow the advice from the readme.
Avoid common mistakes.
Run npm run lint package-name (or tsc if no tslint.json is present).

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://github.com/rowanmanning/proclaim/#proclaimok-value-message-
If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.
Include tests for your changes
If you are making substantial changes, consider adding a tslint.json containing { "extends": "dtslint/dt.json" }. If for reason the any rule need to be disabled, disable it for that line using // tslint:disable-next-line [ruleName] and not for whole package so that the need for disabling can be reviewed.

typescript-bot · 2020-08-19T16:21:24Z

@JakeChampion 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.

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.

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": 46905,
  "author": "JakeChampion",
  "owners": [
    "adamzerella"
  ],
  "dangerLevel": "ScopedAndTested",
  "headCommitAbbrOid": "fd0b021",
  "headCommitOid": "fd0b021742cfe2dc6b362c9ee7309fa0ecb6588d",
  "mergeIsRequested": true,
  "stalenessInDays": 0,
  "lastPushDate": "2020-08-19T23:06:16.000Z",
  "reopenedDate": "2020-08-19T16:20:04.000Z",
  "lastCommentDate": "2020-08-20T10:20:43.000Z",
  "maintainerBlessed": false,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/46905/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": true,
  "popularityLevel": "Well-liked by everyone",
  "anyPackageIsNew": false,
  "packages": [
    "proclaim"
  ],
  "files": [
    {
      "path": "types/proclaim/index.d.ts",
      "kind": "definition",
      "package": "proclaim"
    },
    {
      "path": "types/proclaim/proclaim-tests.ts",
      "kind": "test",
      "package": "proclaim"
    }
  ],
  "hasDismissedReview": false,
  "ciResult": "pass",
  "lastReviewDate": "2020-08-20T10:13:13.000Z",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 2,
  "isChangesRequested": false
}

typescript-bot · 2020-08-19T16:21:26Z

🔔 @adamzerella — 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 · 2020-08-19T16:25:30Z

👋 Hi there! I’ve run some quick measurements against master and your PR. These metrics should help the humans reviewing this PR gauge whether it might negatively affect compile times or editor responsiveness for users who install these typings.

Let’s review the numbers, shall we?

Comparison details 📊

	master	#46905	diff
Batch compilation
Memory usage (MiB)	36.7	33.3	-9.3%
Type count	2237	2237	0%
Assignability cache size	99	99	0%

Language service
Samples taken	105	105	0%
Identifiers in tests	105	105	0%
`getCompletionsAtPosition`
Mean duration (ms)	69.8	70.1	+0.4%
Mean CV	22.4%	23.2%
Worst duration (ms)	89.9	96.8	+7.7%
Worst identifier	hasName	hasName
`getQuickInfoAtPosition`
Mean duration (ms)	70.0	69.2	-1.2%
Mean CV	23.5%	22.7%	-3.5%
Worst duration (ms)	97.3	93.4	-4.0%
Worst identifier	proclaim	fail

It looks like nothing changed too much. I won’t post performance data again unless it gets worse.

typescript-bot · 2020-08-19T16:38:52Z

@JakeChampion The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

typescript-bot · 2020-08-19T16:47:57Z

@JakeChampion The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

typescript-bot · 2020-08-19T16:57:45Z

@JakeChampion The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

azerella

LGTM!

typescript-bot · 2020-08-20T10:13:58Z

@JakeChampion Everything looks good here. Great job! I am ready to merge this PR on your behalf.

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! ❤️

(@adamzerella: you can do this too.)

JakeChampion · 2020-08-20T10:20:43Z

Ready to merge

@JakeChampion

… optional for all assertions by @JakeChampion * Make msg param optional for assertions in proclaim * Mark message and operator params of fail as optional * Update tests to check the optional parameters are indeed optionals * Make the commonjs export of proclaim point to proclaim.ok function * Add test to prove proclaim.ok points to proclaim

@sbusch

…rop, fix tests by @sbusch * fix types for other components (compare with event and eventWrapper, they just have no special props) * also define props for view-specific event component override * fix withDragAndDrop type definition. disable automatic exports. * any is unnecessary here * fix tests * revert change to ViewsProps due to @eps1lon comments / #43215 * change DragAndDropCalendarProps from type to interface, as suggested by @DanielRosenwasser * 🤖 Merge PR #46905 Package Proclaim: Make msg parameter optional for all assertions by @JakeChampion * Make msg param optional for assertions in proclaim * Mark message and operator params of fail as optional * Update tests to check the optional parameters are indeed optionals * Make the commonjs export of proclaim point to proclaim.ok function * Add test to prove proclaim.ok points to proclaim * Properly describe props for (custom) View, with new test with wrong prop (expecting error). Pass generic types for event and resource at more places (and fix test). Plus: turned off automatic exports for index.d.ts aswell due to own Omit (added to keep compat with older TS versions). * typo * Revert strict views (with their disfunctional tests), but retain ViewProps for optional use (guarded with a test) Strict views cannot expressed du to current limitaion in TypeScript, see <microsoft/TypeScript#13195> Co-authored-by: Jake Champion <me@jakechampion.name>

@JakeChampion

… optional for all assertions by @JakeChampion * Make msg param optional for assertions in proclaim * Mark message and operator params of fail as optional * Update tests to check the optional parameters are indeed optionals * Make the commonjs export of proclaim point to proclaim.ok function * Add test to prove proclaim.ok points to proclaim

@sbusch

…ix withDragAndDrop, fix tests by @sbusch * fix types for other components (compare with event and eventWrapper, they just have no special props) * also define props for view-specific event component override * fix withDragAndDrop type definition. disable automatic exports. * any is unnecessary here * fix tests * revert change to ViewsProps due to @eps1lon comments / DefinitelyTyped#43215 * change DragAndDropCalendarProps from type to interface, as suggested by @DanielRosenwasser * 🤖 Merge PR DefinitelyTyped#46905 Package Proclaim: Make msg parameter optional for all assertions by @JakeChampion * Make msg param optional for assertions in proclaim * Mark message and operator params of fail as optional * Update tests to check the optional parameters are indeed optionals * Make the commonjs export of proclaim point to proclaim.ok function * Add test to prove proclaim.ok points to proclaim * Properly describe props for (custom) View, with new test with wrong prop (expecting error). Pass generic types for event and resource at more places (and fix test). Plus: turned off automatic exports for index.d.ts aswell due to own Omit (added to keep compat with older TS versions). * typo * Revert strict views (with their disfunctional tests), but retain ViewProps for optional use (guarded with a test) Strict views cannot expressed du to current limitaion in TypeScript, see <microsoft/TypeScript#13195> Co-authored-by: Jake Champion <me@jakechampion.name>

@JakeChampion

… optional for all assertions by @JakeChampion * Make msg param optional for assertions in proclaim * Mark message and operator params of fail as optional * Update tests to check the optional parameters are indeed optionals * Make the commonjs export of proclaim point to proclaim.ok function * Add test to prove proclaim.ok points to proclaim

@sbusch

…ix withDragAndDrop, fix tests by @sbusch * fix types for other components (compare with event and eventWrapper, they just have no special props) * also define props for view-specific event component override * fix withDragAndDrop type definition. disable automatic exports. * any is unnecessary here * fix tests * revert change to ViewsProps due to @eps1lon comments / DefinitelyTyped#43215 * change DragAndDropCalendarProps from type to interface, as suggested by @DanielRosenwasser * 🤖 Merge PR DefinitelyTyped#46905 Package Proclaim: Make msg parameter optional for all assertions by @JakeChampion * Make msg param optional for assertions in proclaim * Mark message and operator params of fail as optional * Update tests to check the optional parameters are indeed optionals * Make the commonjs export of proclaim point to proclaim.ok function * Add test to prove proclaim.ok points to proclaim * Properly describe props for (custom) View, with new test with wrong prop (expecting error). Pass generic types for event and resource at more places (and fix test). Plus: turned off automatic exports for index.d.ts aswell due to own Omit (added to keep compat with older TS versions). * typo * Revert strict views (with their disfunctional tests), but retain ViewProps for optional use (guarded with a test) Strict views cannot expressed du to current limitaion in TypeScript, see <microsoft/TypeScript#13195> Co-authored-by: Jake Champion <me@jakechampion.name>

JakeChampion added 2 commits August 19, 2020 17:16

Make msg param optional for assertions in proclaim

0e94878

Mark message and operator params of fail as optional

0442036

JakeChampion marked this pull request as ready for review August 19, 2020 16:20

typescript-bot added the Untested Change This PR does not touch tests label Aug 19, 2020

typescript-bot added the Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance. label Aug 19, 2020

Update tests to check the optional parameters are indeed optionals

992c9f7

typescript-bot added The CI failed When GH Actions fails and removed Untested Change This PR does not touch tests labels Aug 19, 2020

typescript-bot removed the The CI failed When GH Actions fails label Aug 19, 2020

JakeChampion added 2 commits August 20, 2020 00:03

Make the commonjs export of proclaim point to proclaim.ok function

5ee3d9d

Add test to prove proclaim.ok points to proclaim

fd0b021

azerella approved these changes Aug 20, 2020

View reviewed changes

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 Aug 20, 2020

typescript-bot merged commit 726a137 into DefinitelyTyped:master Aug 20, 2020

JakeChampion deleted the patch-1 branch August 20, 2020 10:21

Navigation Menu

Repository navigation

Package Proclaim: Make msg parameter optional for all assertions - #46905

Package Proclaim: Make msg parameter optional for all assertions#46905
typescript-bot merged 5 commits into
DefinitelyTyped:masterfrom
JakeChampion:patch-1

JakeChampion commented Aug 19, 2020 •

edited

Loading

Uh oh!

typescript-bot commented Aug 19, 2020 •

edited

Loading

Uh oh!

typescript-bot commented Aug 19, 2020

Uh oh!

typescript-bot commented Aug 19, 2020

Uh oh!

typescript-bot commented Aug 19, 2020

Uh oh!

typescript-bot commented Aug 19, 2020

Uh oh!

typescript-bot commented Aug 19, 2020

Uh oh!

azerella left a comment

Uh oh!

typescript-bot commented Aug 20, 2020

Uh oh!

JakeChampion commented Aug 20, 2020

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

JakeChampion commented Aug 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

typescript-bot commented Aug 19, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Code Reviews

Status

Uh oh!

typescript-bot commented Aug 19, 2020

Uh oh!

typescript-bot commented Aug 19, 2020

Uh oh!

typescript-bot commented Aug 19, 2020

Uh oh!

typescript-bot commented Aug 19, 2020

Uh oh!

typescript-bot commented Aug 19, 2020

Uh oh!

azerella left a comment

Choose a reason for hiding this comment

Uh oh!

typescript-bot commented Aug 20, 2020

Uh oh!

JakeChampion commented Aug 20, 2020

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

JakeChampion commented Aug 19, 2020 •

edited

Loading

typescript-bot commented Aug 19, 2020 •

edited

Loading