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

Added types for plotly.js-basic-dist #53783

Merged
merged 2 commits into from Jun 13, 2021

Conversation

DreierF
Copy link
Contributor

@DreierF DreierF commented Jun 12, 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.

Links:

@typescript-bot
Copy link
Contributor

typescript-bot commented Jun 12, 2021

@DreierF Thank you for submitting this PR!

This is a live comment which I will keep updated.

1 package in this PR

Code Reviews

This PR adds a new definition, so it needs to be reviewed by a DT maintainer before it can be merged.

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

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ✅ Only a DT maintainer can approve changes when there are new packages added

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": 53783,
  "author": "DreierF",
  "headCommitOid": "0ae3f91756a80740b0e9f64de4c6d946aa51dc1f",
  "lastPushDate": "2021-06-13T03:39:13.000Z",
  "lastActivityDate": "2021-06-13T17:31:06.000Z",
  "mergeOfferDate": "2021-06-13T17:04:16.000Z",
  "mergeRequestDate": "2021-06-13T17:31:06.000Z",
  "mergeRequestUser": "DreierF",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "plotly.js-basic-dist",
      "kind": "add",
      "files": [
        {
          "path": "types/plotly.js-basic-dist/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/plotly.js-basic-dist/plotly.js-basic-dist-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/plotly.js-basic-dist/tsconfig.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/plotly.js-basic-dist/tslint.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [],
      "addedOwners": [
        "DreierF"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "peterblazejewicz",
      "date": "2021-06-13T17:03:41.000Z",
      "isMaintainer": true
    }
  ],
  "mainBotCommentID": 860031907,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added the New Definition This PR creates a new definition package. label Jun 12, 2021
@typescript-bot
Copy link
Contributor

🔔 @DreierF — you're the only owner, but it would still be good if you find someone to review this PR in the next few days, otherwise a maintainer will look at it. (And if you do find someone, maybe even recruit them to be a second owner to make future changes easier...)

@typescript-bot typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board Jun 12, 2021
@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Jun 12, 2021
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Jun 12, 2021
@typescript-bot
Copy link
Contributor

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

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

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

@typescript-bot typescript-bot removed the The CI failed When GH Actions fails label Jun 12, 2021
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Jun 12, 2021
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in New Pull Request Status Board Jun 12, 2021
@DreierF
Copy link
Contributor Author

DreierF commented Jun 12, 2021

🔔 @DreierF — you're the only owner, but it would still be good if you find someone to review this PR in the next few days, otherwise a maintainer will look at it. (And if you do find someone, maybe even recruit them to be a second owner to make future changes easier...)

@chrisgervang @martinduparc @frederikaalund @taoqf @Dadstart @szechyjs @soorajpudiyadath @jonfreedman @meganrm @milesjos @SkipperCool @mtadams007 @marnett-git @peterblazejewicz @brammitch @blizzardjessica @olegshilov @PabloGracia

As all of you contributed to the plotly.js package, could someone of you review this change?

@peterblazejewicz
Copy link
Member

@DreierF does it mean only some types of traces should be re-exported from plotly.js? At the moment, IMO this package
is just a pass-through for all plotly.js definitions.

Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <peterblazejewicz@users.noreply.github.com>
@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Code Reviews in New Pull Request Status Board Jun 13, 2021
@typescript-bot
Copy link
Contributor

@peterblazejewicz 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?

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in New Pull Request Status Board Jun 13, 2021
@DreierF
Copy link
Contributor Author

DreierF commented Jun 13, 2021

Thanks for the review!
Yes, ideally only the relevant subset should be re-exported, but it would be an enormous effort to cherry-pick only the relevant types. WDYT?

I took inspiration of the jQuery slim package, which also just exposes a subset of jQuery in reality, but exports all the types.

Copy link
Member

@peterblazejewicz peterblazejewicz left a comment

Choose a reason for hiding this comment

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

@DreierF agree, LGTM!
thx!

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

DreierF commented Jun 13, 2021

Ready to merge

@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Recently Merged in New Pull Request Status Board Jun 13, 2021
@typescript-bot typescript-bot merged commit 06b805f into DefinitelyTyped:master Jun 13, 2021
@DreierF DreierF deleted the plotly-js-basic-dist branch June 13, 2021 17:31
@typescript-bot
Copy link
Contributor

I just published @types/plotly.js-basic-dist@1.54.0 to npm.

@typescript-bot typescript-bot removed this from Recently Merged in New Pull Request Status Board Jun 13, 2021
@josiahkhor josiahkhor mentioned this pull request Jul 22, 2022
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintainer Approved New Definition This PR creates a new definition package. 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