Skip to content
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.

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

[d3-path] Update types to v2.0 #48243

Merged
merged 4 commits into from Sep 29, 2020

Conversation

Methuselah96
Copy link
Contributor

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

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: https://github.com/d3/d3-path/releases/tag/v2.0.0
  • 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.

Related: #38939

@typescript-bot typescript-bot added Popular package This PR affects a popular package (as counted by NPM download counts). Edits multiple packages labels Sep 26, 2020
@typescript-bot typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board Sep 26, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented Sep 26, 2020

@Methuselah96 Thank you for submitting this PR!

This is a live comment which I will keep updated.

3 packages in this PR

Code Reviews

Because this PR edits multiple packages, it can be merged once it's reviewed by a DT maintainer.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ✅ A DT maintainer needs to approve changes which affect more than one package

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": 48243,
  "author": "Methuselah96",
  "owners": [
    "tomwanzek",
    "gustavderdrache",
    "borisyankov",
    "denisname",
    "Methuselah96"
  ],
  "dangerLevel": "MultiplePackagesEdited",
  "headCommitAbbrOid": "77ee165",
  "headCommitOid": "77ee165c5596092ca7bf4cdae5b9d9dbc02cbfb3",
  "mergeIsRequested": true,
  "stalenessInDays": 0,
  "lastPushDate": "2020-09-29T22:25:12.000Z",
  "lastCommentDate": "2020-09-29T22:50:00.000Z",
  "maintainerBlessed": false,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/48243/files",
  "hasMergeConflict": false,
  "authorIsOwner": true,
  "isFirstContribution": false,
  "popularityLevel": "Popular",
  "newPackages": [],
  "packages": [
    "d3-path",
    "d3-shape",
    "d3"
  ],
  "files": [
    {
      "path": "types/d3-path/index.d.ts",
      "kind": "definition",
      "package": "d3-path"
    },
    {
      "path": "types/d3-path/v1/d3-path-tests.ts",
      "kind": "test",
      "package": "d3-path"
    },
    {
      "path": "types/d3-path/v1/index.d.ts",
      "kind": "definition",
      "package": "d3-path"
    },
    {
      "path": "types/d3-path/v1/tsconfig.json",
      "kind": "package-meta",
      "package": "d3-path",
      "suspect": "created"
    },
    {
      "path": "types/d3-path/v1/tslint.json",
      "kind": "package-meta",
      "package": "d3-path",
      "suspect": "not the required form"
    },
    {
      "path": "types/d3-shape/index.d.ts",
      "kind": "definition",
      "package": "d3-shape"
    },
    {
      "path": "types/d3-shape/tsconfig.json",
      "kind": "package-meta",
      "package": "d3-shape",
      "suspect": "changes outside of \"files\" list"
    },
    {
      "path": "types/d3/tsconfig.json",
      "kind": "package-meta",
      "package": "d3",
      "suspect": "changes outside of \"files\" list"
    },
    {
      "path": "types/d3/v4/tsconfig.json",
      "kind": "package-meta",
      "package": "d3",
      "suspect": "changes outside of \"files\" list"
    }
  ],
  "hasDismissedReview": false,
  "ciResult": "pass",
  "lastReviewDate": "2020-09-29T22:46:50.000Z",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 4,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Contributor

🔔 @tomwanzek @gustavderdrache @borisyankov @denisname — 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 typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board Sep 26, 2020
@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?

d3-path/v*

Comparison details for d3-path/* 📊
master #48243 diff
Batch compilation
Memory usage (MiB) 36.3 36.4 +0.3%
Type count 2154 2154 0%
Assignability cache size 99 99 0%
Language service
Samples taken 31 31 0%
Identifiers in tests 31 31 0%
getCompletionsAtPosition
    Mean duration (ms) 93.8 88.8 -5.4%
    Mean CV 21.0% 17.8%
    Worst duration (ms) 107.6 108.0 +0.4%
    Worst identifier context toString
getQuickInfoAtPosition
    Mean duration (ms) 92.3 89.3 -3.2%
    Mean CV 21.2% 18.2% -13.8%
    Worst duration (ms) 107.0 119.4 +11.6%
    Worst identifier toString d3Path

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

d3-path/v*

Comparison details for d3-path/* 📊
master #48243 diff
Batch compilation
Memory usage (MiB) 36.4 36.5 +0.3%
Type count 2154 2154 0%
Assignability cache size 99 99 0%
Language service
Samples taken 31 31 0%
Identifiers in tests 31 31 0%
getCompletionsAtPosition
    Mean duration (ms) 90.2 88.6 -1.9%
    Mean CV 20.5% 22.3%
    Worst duration (ms) 113.2 110.7 -2.2%
    Worst identifier toString toString
getQuickInfoAtPosition
    Mean duration (ms) 88.6 85.8 -3.1%
    Mean CV 16.3% 17.5% +7.1%
    Worst duration (ms) 112.6 101.1 -10.3%
    Worst identifier d3Path d3Path

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

d3-shape/v*

Comparison details for d3-shape/* 📊
master #48243 diff
Batch compilation
Memory usage (MiB) 88.5 85.5 -3.4%
Type count 13547 13547 0%
Assignability cache size 4165 4165 0%
Language service
Samples taken 2464 2464 0%
Identifiers in tests 2464 2464 0%
getCompletionsAtPosition
    Mean duration (ms) 430.5 426.1 -1.0%
    Mean CV 6.9% 7.0%
    Worst duration (ms) 542.4 592.5 +9.2%
    Worst identifier canvasSymbol d3Shape
getQuickInfoAtPosition
    Mean duration (ms) 423.5 419.9 -0.8%
    Mean CV 7.0% 7.2% +2.4%
    Worst duration (ms) 560.4 579.2 +3.4%
    Worst identifier alpha defaultArea

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

d3/v*

Comparison details for d3/* 📊
master #48243 diff
Batch compilation
Memory usage (MiB) 92.2 91.7 -0.5%
Type count 13504 13504 0%
Assignability cache size 3680 3680 0%
Language service
Samples taken 4 4 0%
Identifiers in tests 4 4 0%
getCompletionsAtPosition
    Mean duration (ms) 610.3 603.3 -1.1%
    Mean CV 10.2% 8.3%
    Worst duration (ms) 645.9 639.7 -1.0%
    Worst identifier version d3
getQuickInfoAtPosition
    Mean duration (ms) 603.9 614.4 +1.7%
    Mean CV 11.9% 10.9% -8.8%
    Worst duration (ms) 640.0 677.5 +5.9%
    Worst identifier d3 d3

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

d3/v*

Comparison details for d3/* 📊
master #48243 diff
Batch compilation
Memory usage (MiB) 93.3 92.4 -1.0%
Type count 13504 13504 0%
Assignability cache size 3680 3680 0%
Language service
Samples taken 4 4 0%
Identifiers in tests 4 4 0%
getCompletionsAtPosition
    Mean duration (ms) 626.6 605.8 -3.3%
    Mean CV 9.2% 9.3%
    Worst duration (ms) 719.6 665.2 -7.5%
    Worst identifier d3 version
getQuickInfoAtPosition
    Mean duration (ms) 591.4 614.5 +3.9%
    Mean CV 10.2% 13.3% +29.9%
    Worst duration (ms) 657.0 650.5 -1.0%
    Worst identifier version version

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

d3/v*

Comparison details for d3/* 📊
master #48243 diff
Batch compilation
Memory usage (MiB) 93.3 92.0 -1.4%
Type count 13504 13504 0%
Assignability cache size 3680 3680 0%
Language service
Samples taken 4 4 0%
Identifiers in tests 4 4 0%
getCompletionsAtPosition
    Mean duration (ms) 601.4 604.7 +0.6%
    Mean CV 8.3% 9.1%
    Worst duration (ms) 642.3 680.6 +6.0%
    Worst identifier version version
getQuickInfoAtPosition
    Mean duration (ms) 600.1 592.7 -1.2%
    Mean CV 11.6% 11.0% -5.4%
    Worst duration (ms) 652.7 620.6 -4.9%
    Worst identifier d3 d3

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

@typescript-bot typescript-bot added the Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance. label Sep 26, 2020
Copy link
Contributor

@amcasey amcasey left a comment

Choose a reason for hiding this comment

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

I'm not actually verifying that all of the v1 files are straight copies. Please let me know if that's ever not the case.

@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Sep 29, 2020
@typescript-bot typescript-bot moved this from Needs Maintainer Review to Waiting for Author to Merge in New Pull Request Status Board Sep 29, 2020
@Methuselah96
Copy link
Contributor Author

@amcasey About half of them are not straight copies. I'll add a comment to each of them noting whether they are straight copies or not.

@Methuselah96
Copy link
Contributor Author

Methuselah96 commented Sep 29, 2020

v2 is a straight copy of v1.

@typescript-bot typescript-bot removed Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Sep 29, 2020
@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Waiting for Code Reviews in New Pull Request Status Board Sep 29, 2020
@typescript-bot typescript-bot added the Author is Owner The author of this PR is a listed owner of the package. label Sep 29, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board Sep 29, 2020
@typescript-bot
Copy link
Contributor

@amcasey Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

@amcasey
Copy link
Contributor

amcasey commented Sep 29, 2020

@Methuselah96, sorry, I was unclear - I actually meant that I was assuming the new contents of the v1 folder were directly copied from the root folder (and not, for some reason, modified). Fortunately, it's easy to tell when v2 is not a straight copy of v1. 😄

@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Sep 29, 2020
@typescript-bot typescript-bot moved this from Needs Maintainer Review to Waiting for Author to Merge in New Pull Request Status Board Sep 29, 2020
@Methuselah96
Copy link
Contributor Author

@amcasey Makes sense. Yes, they're all directly copied, sorry for my misunderstanding.

@typescript-bot typescript-bot removed Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Sep 29, 2020
@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Waiting for Code Reviews in New Pull Request Status Board Sep 29, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board Sep 29, 2020
@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Sep 29, 2020
@typescript-bot typescript-bot moved this from Needs Maintainer Review to Waiting for Author to Merge in New Pull Request Status Board Sep 29, 2020
@typescript-bot
Copy link
Contributor

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

@Methuselah96
Copy link
Contributor Author

Ready to merge

@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Recently Merged in New Pull Request Status Board Sep 29, 2020
@typescript-bot typescript-bot merged commit 357524d into DefinitelyTyped:master Sep 29, 2020
@Methuselah96 Methuselah96 deleted the d3-path-2.0 branch September 29, 2020 22:51
@typescript-bot
Copy link
Contributor

I just published @types/d3@5.7.4 to npm.

@typescript-bot
Copy link
Contributor

I just published @types/d3@4.13.4 to npm.

@typescript-bot
Copy link
Contributor

I just published @types/d3-path@2.0.0 to npm.

@typescript-bot
Copy link
Contributor

I just published @types/d3-path@1.0.9 to npm.

@typescript-bot
Copy link
Contributor

I just published @types/d3-shape@1.3.3 to npm.

@typescript-bot typescript-bot removed this from Recently Merged in New Pull Request Status Board Sep 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Author is Owner The author of this PR is a listed owner of the package. Edits multiple packages Maintainer Approved Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance. Popular package This PR affects a popular package (as counted by NPM download counts). Self Merge This PR can now be self-merged by the PR author or an owner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants