Skip to content

[react] Fix link to React profiler API documentation#52735

Merged
typescript-bot merged 3 commits intoDefinitelyTyped:masterfrom
intgr:react-fix-profiler-api-link
May 4, 2021
Merged

[react] Fix link to React profiler API documentation#52735
typescript-bot merged 3 commits intoDefinitelyTyped:masterfrom
intgr:react-fix-profiler-api-link

Conversation

@intgr
Copy link
Contributor

@intgr intgr commented May 4, 2021

Please fill in this template.

Select one of these and delete the others:

If adding a new definition:

  • The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
  • If this is for an npm package, match the name. If not, do not conflict with the name of an npm package.
  • Create it with dts-gen --dt, not by basing it on an existing project.
  • Represents shape of module/library correctly
  • tslint.json should contain { "extends": "dtslint/dt.json" }, and no additional rules.
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: https://reactjs.org/docs/profiler.html
  • 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.

If removing a declaration:

  • If a package was never on Definitely Typed, you don't need to do anything. (If you wrote a package and provided types, you don't need to register it with us.)
  • Delete the package's directory.
  • Add it to notNeededPackages.json.

@typescript-bot typescript-bot added Critical package Untested Change This PR does not touch tests labels May 4, 2021
@typescript-bot
Copy link
Contributor

Hey @intgr,

😒 Your PR doesn't modify any tests, so it's hard to know what's being fixed, and your changes might regress in the future. Please consider adding tests to cover the change you're making. Including tests allows this PR to be merged by yourself and the owners of this module. This can potentially save days of time for you.

@typescript-bot
Copy link
Contributor

typescript-bot commented May 4, 2021

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

This PR can be merged once it's reviewed.

Status

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

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": 52735,
  "author": "intgr",
  "headCommitOid": "031654b79a9c85a47fb2cdf9106d8e092789639b",
  "lastPushDate": "2021-05-04T09:09:26.000Z",
  "lastActivityDate": "2021-05-04T20:30:56.000Z",
  "maintainerBlessed": true,
  "mergeOfferDate": "2021-05-04T19:26:13.000Z",
  "mergeRequestDate": "2021-05-04T20:30:56.000Z",
  "mergeRequestUser": "intgr",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "react",
      "kind": "edit",
      "files": [
        {
          "path": "types/react/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/react/v16/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "johnnyreilly",
        "bbenezech",
        "pzavolinsky",
        "digiguru",
        "ericanderson",
        "DovydasNavickas",
        "theruther4d",
        "guilhermehubner",
        "ferdaber",
        "jrakotoharisoa",
        "pascaloliv",
        "hotell",
        "franklixuefei",
        "Jessidhia",
        "saranshkataria",
        "lukyth",
        "eps1lon",
        "zieka",
        "dancerphil",
        "dimitropoulos",
        "disjukr",
        "vhfmag",
        "hellatan"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "eps1lon",
      "date": "2021-05-04T09:11:37.000Z",
      "isMaintainer": false
    }
  ],
  "ciResult": "pass"
}

@typescript-bot
Copy link
Contributor

Copy link
Collaborator

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

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

Thanks! I would suggest we directly link to the onRender callback.

@typescript-bot typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label May 4, 2021
intgr and others added 2 commits May 4, 2021 12:09
Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>
Co-authored-by: Sebastian Silbermann <silbermann.sebastian@gmail.com>
@typescript-bot typescript-bot removed the Owner Approved A listed owner of this package signed off on the pull request. label May 4, 2021
@typescript-bot typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label May 4, 2021
@typescript-bot
Copy link
Contributor

👋 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?

master #52735 diff
Batch compilation
Memory usage (MiB) 121.7 120.2 -1.3%
Type count 35681 35681 0%
Assignability cache size 9988 9988 0%
Language service
Samples taken 2860 2359 -18%
Identifiers in tests 2939 2939 0%
getCompletionsAtPosition
    Mean duration (ms) 264.2 326.8 +23.7% 🔸
    Mean CV 7.9% 8.3%
    Worst duration (ms) 1127.4 1326.5 +17.7%
    Worst identifier props props
getQuickInfoAtPosition
    Mean duration (ms) 265.8 330.5 +24.3% 🔸
    Mean CV 9.4% 9.4%
    Worst duration (ms) 864.0 1107.6 +28.2% 🔸
    Worst identifier ref x
System information
Node version v14.16.1 v14.16.1
CPU count 2 2
CPU speed 2.593 GHz 2.394 GHz
CPU model Intel(R) Xeon(R) Platinum 8272CL CPU @ 2.60GHz Intel(R) Xeon(R) CPU E5-2673 v3 @ 2.40GHz
CPU Architecture x64 x64
Memory 6.8 GiB 6.8 GiB
Platform linux linux
Release 4.15.0-1113-azure 4.15.0-1113-azure

First off, note that the system varied slightly between these two runs, so you’ll have to take these measurements with a grain of salt.

Looks like there were a couple significant differences—take a look at mean duration for getting completions at a position, mean duration for getting quick info at a position, and worst-case duration for getting quick info at a position to make sure everything looks ok.

@typescript-bot typescript-bot added Perf: Worse typescript-bot determined that this PR has a negative impact on compilation performance. Self Merge This PR can now be self-merged by the PR author or an owner labels May 4, 2021
@typescript-bot
Copy link
Contributor

@intgr Everything looks good here. Great job! I am ready to merge this PR (at 031654b) 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! ❤️

(@johnnyreilly, @bbenezech, @pzavolinsky, @digiguru, @ericanderson, @DovydasNavickas, @theruther4d, @guilhermehubner, @ferdaber, @jrakotoharisoa, @pascaloliv, @Hotell, @franklixuefei, @Jessidhia, @saranshkataria, @lukyth, @eps1lon, @zieka, @dancerphil, @dimitropoulos, @disjukr, @vhfmag, @hellatan: you can do this too.)

@intgr
Copy link
Contributor Author

intgr commented May 4, 2021

Ready to merge

@typescript-bot typescript-bot merged commit 72dd979 into DefinitelyTyped:master May 4, 2021
@typescript-bot
Copy link
Contributor

I just published @types/react@17.0.5 to npm.

@typescript-bot
Copy link
Contributor

I just published @types/react@16.14.6 to npm.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Critical package Owner Approved A listed owner of this package signed off on the pull request. Perf: Worse typescript-bot determined that this PR has a negative impact on compilation performance. Self Merge This PR can now be self-merged by the PR author or an owner Untested Change This PR does not touch tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants