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

[detect-port]: add PortConfig type for first argument from default function #44439

Merged

Conversation

ivandevp
Copy link
Contributor

@ivandevp ivandevp commented May 2, 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.)
  • 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:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <https://github.com/node-modules/detect-port/blob/master/lib/detect-port.js#L10>
  • 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
Copy link
Contributor

typescript-bot commented May 2, 2020

@ivandevp Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 - keep an eye on this comment as I'll be updating it with information as things progress.

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": 44439,
  "author": "ivandevp",
  "owners": [
    "lith-light-g"
  ],
  "dangerLevel": "ScopedAndTested",
  "headCommitAbbrOid": "7175178",
  "headCommitOid": "717517805e8a928d3c2f126893d8063017259663",
  "mergeIsRequested": true,
  "stalenessInDays": 0,
  "lastCommitDate": "2020-05-02T14:58:42.000Z",
  "lastAuthorCommentDate": "2020-05-03T13:38:46.000Z",
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/44439/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": true,
  "popularityLevel": "Well-liked by everyone",
  "anyPackageIsNew": false,
  "packages": [
    "detect-port"
  ],
  "files": [
    {
      "filePath": "types/detect-port/detect-port-tests.ts",
      "kind": "test",
      "package": "detect-port"
    },
    {
      "filePath": "types/detect-port/index.d.ts",
      "kind": "definition",
      "package": "detect-port"
    }
  ],
  "hasDismissedReview": false,
  "travisResult": "pass",
  "lastReviewDate": "2020-05-03T11:58:37.000Z",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 1,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Contributor

🔔 @lith-light-g - 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 Other to Waiting for Code Reviews in New Pull Request Status Board May 2, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board May 2, 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?

Comparison details 📊
master #44439 diff
Batch compilation
Memory usage (MiB) 31.2 31.4 +0.6%
Type count 2176 2200 +1%
Assignability cache size 117 119 +2%
Language service
Samples taken 17 32 +88%
Identifiers in tests 17 32 +88%
getCompletionsAtPosition
    Mean duration (ms) 68.6 75.1 +9.5%
    Mean CV 19.0% 30.4%
    Worst duration (ms) 88.5 102.2 +15.4%
    Worst identifier catch Error
getQuickInfoAtPosition
    Mean duration (ms) 68.3 73.9 +8.2%
    Mean CV 21.4% 28.7% +33.8%
    Worst duration (ms) 77.9 90.0 +15.4%
    Worst identifier detect catch

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 May 2, 2020
@orta
Copy link
Collaborator

orta commented May 2, 2020

I think you accidentally included the .tgz in this PR

@ivandevp
Copy link
Contributor Author

ivandevp commented May 2, 2020

Thanks @orta! I didn't see it. I've just removed it.

@peterblazejewicz
Copy link
Member

I think you accidentally included the .tgz in this PR

@orta
Maybe the .gitignore can be amended to ignore this (referring to the gitter's discussion).

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.

LGTM!
@ivandevp thx for contribution!

@typescript-bot typescript-bot added Other Approved This PR was reviewed and signed-off by a community member. Self Merge This PR can now be self-merged by the PR author or an owner labels May 3, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Waiting for Author to Merge in New Pull Request Status Board May 3, 2020
@typescript-bot
Copy link
Contributor

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

peterblazejewicz pushed a commit to peterblazejewicz/DefinitelyTyped that referenced this pull request May 3, 2020
@ivandevp
Copy link
Contributor Author

ivandevp commented May 3, 2020

Ready to merge

@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Recently Merged in New Pull Request Status Board May 3, 2020
@typescript-bot typescript-bot merged commit 8bb6f0d into DefinitelyTyped:master May 3, 2020
@typescript-bot
Copy link
Contributor

I just published @types/detect-port@1.3.0 to npm.

orta pushed a commit that referenced this pull request May 3, 2020
This prevents accidental inclusion of common artefact:

see:
https://github.com/github/gitignore/blob/master/Node.gitignore#L65
#44439 (comment)

Thanks!

Co-authored-by: PiotrB <pblazejewicz@appriss.com>
jjballano-qatium pushed a commit to jjballano-qatium/DefinitelyTyped that referenced this pull request Jun 16, 2020
…or first argument from default function by @ivandevp

* Add portconfig type for detect port first argument

* Update detect-port version

* Fix version format

* Remove autogenerated bin
jjballano-qatium pushed a commit to jjballano-qatium/DefinitelyTyped that referenced this pull request Jun 16, 2020
This prevents accidental inclusion of common artefact:

see:
https://github.com/github/gitignore/blob/master/Node.gitignore#L65
DefinitelyTyped#44439 (comment)

Thanks!

Co-authored-by: PiotrB <pblazejewicz@appriss.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Other Approved This PR was reviewed and signed-off by a community member. Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance. Self Merge This PR can now be self-merged by the PR author or an owner
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants