Skip to content

Add type definitions for Electron Progress Bar#49026

Merged
elibarzilay merged 9 commits intoDefinitelyTyped:masterfrom
samchouse:electron-progressbar
Oct 24, 2020
Merged

Add type definitions for Electron Progress Bar#49026
elibarzilay merged 9 commits intoDefinitelyTyped:masterfrom
samchouse:electron-progressbar

Conversation

@samchouse
Copy link
Copy Markdown
Contributor

@samchouse samchouse commented Oct 22, 2020

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).

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 be present and it shouldn't have any additional or disabling of rules. Just content as { "extends": "dtslint/dt.json" }. If for reason the some 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.
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

@typescript-bot typescript-bot added the New Definition This PR creates a new definition package. label Oct 22, 2020
@typescript-bot
Copy link
Copy Markdown
Contributor

typescript-bot commented Oct 22, 2020

@xenfo 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 adds a new definition, so it needs to be reviewed by a DT maintainer before it can be merged.

Status

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

Once every item on this list is checked, I'll ask you for permission to merge and publish the changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 49026,
  "author": "Xenfo",
  "owners": [],
  "dangerLevel": "ScopedAndConfiguration",
  "headCommitAbbrOid": "2474fc2",
  "headCommitOid": "2474fc284719c4dd681c260e6726847c575cdaa8",
  "mergeIsRequested": false,
  "stalenessInDays": 0,
  "lastPushDate": "2020-10-22T21:48:00.000Z",
  "lastCommentDate": "2020-10-23T21:36:30.000Z",
  "maintainerBlessed": false,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/49026/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": true,
  "popularityLevel": "Well-liked by everyone",
  "newPackages": [
    "electron-progressbar"
  ],
  "packages": [
    "electron-progressbar"
  ],
  "files": [
    {
      "path": "types/electron-progressbar/electron-progressbar-tests.ts",
      "kind": "test",
      "package": "electron-progressbar"
    },
    {
      "path": "types/electron-progressbar/index.d.ts",
      "kind": "definition",
      "package": "electron-progressbar"
    },
    {
      "path": "types/electron-progressbar/package.json",
      "kind": "package-meta-ok",
      "package": "electron-progressbar"
    },
    {
      "path": "types/electron-progressbar/tsconfig.json",
      "kind": "package-meta",
      "package": "electron-progressbar",
      "suspect": "not the required form"
    },
    {
      "path": "types/electron-progressbar/tslint.json",
      "kind": "package-meta-ok",
      "package": "electron-progressbar"
    }
  ],
  "hasDismissedReview": false,
  "ciResult": "pass",
  "lastReviewDate": "2020-10-23T20:07:13.000Z",
  "firstApprovalDate": "2020-10-23T20:07:13.000Z",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 1,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Copy Markdown
Contributor

🔔 @xenfo — 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 the The CI failed When GH Actions fails label Oct 22, 2020
@typescript-bot
Copy link
Copy Markdown
Contributor

@xenfo 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
Copy link
Copy Markdown
Contributor

@xenfo 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
Copy link
Copy Markdown
Contributor

@xenfo 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
Copy link
Copy Markdown
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?

These typings are for a package that doesn’t yet exist on master, so I don’t have anything to compare against yet! In the future, I’ll be able to compare PRs to electron-progressbar with its source on master.

Comparison details 📊
Batch compilation
Type count 12221
Assignability cache size 1930
Language service measurements
Samples taken 9
Identifiers in tests 9
getCompletionsAtPosition
    Mean duration (ms) 100.1
    Mean CV 26.4%
    Worst duration (ms) 129.8
    Worst identifier progressBar
getQuickInfoAtPosition
    Mean duration (ms) 98.2
    Mean CV 22.1%
    Worst duration (ms) 121.3
    Worst identifier title
System information
Node version v12.19.0
CPU count 2
CPU speed 2.095 GHz
CPU model Intel(R) Xeon(R) Platinum 8171M CPU @ 2.60GHz
CPU Architecture x64
Memory 6.8 GiB
Platform linux
Release 4.15.0-1098-azure

@typescript-bot
Copy link
Copy Markdown
Contributor

@xenfo 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 typescript-bot removed the The CI failed When GH Actions fails label Oct 22, 2020
Copy link
Copy Markdown
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.

LGTM!
@xenfo thx!

@typescript-bot typescript-bot added the Other Approved This PR was reviewed and signed-off by a community member. label Oct 22, 2020
samchouse and others added 2 commits October 22, 2020 17:47
Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <peterblazejewicz@users.noreply.github.com>
Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <peterblazejewicz@users.noreply.github.com>
@typescript-bot typescript-bot removed the Other Approved This PR was reviewed and signed-off by a community member. label Oct 22, 2020
@typescript-bot
Copy link
Copy Markdown
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 added the Other Approved This PR was reviewed and signed-off by a community member. label Oct 23, 2020
@samchouse
Copy link
Copy Markdown
Contributor Author

How many people have to approve?

@elibarzilay elibarzilay merged commit d1b20f7 into DefinitelyTyped:master Oct 24, 2020
@typescript-bot
Copy link
Copy Markdown
Contributor

I just published @types/electron-progressbar@1.2.0 to npm.

@samchouse samchouse deleted the electron-progressbar branch October 24, 2020 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

New Definition This PR creates a new definition package. Other Approved This PR was reviewed and signed-off by a community member.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants