Thanks to visit codestin.com
Credit goes to github.com

Skip to content

fix(glob): correct return type to match Glob interface #45193

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.

Sign up for GitHub

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

Jump to bottom
Merged
rbuckton merged 1 commit into from
Jun 4, 2020
Merged

fix(glob): correct return type to match Glob interface #45193

rbuckton merged 1 commit into from
Jun 4, 2020

Conversation

@peterblazejewicz
Copy link
Member

@peterblazejewicz peterblazejewicz commented May 31, 2020

This changes detail of lesser known usage of the module.
As pointed in #45192 the function usage should return fully initialized
instance of the glob:
https://git.io/Jf6WM

/cc @Shinigami92

Thanks!

Fixes #45192

  • 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.)
  • Run npm run lint package-name (or tsc if no tslint.json is present).
  • Provide a URL to documentation or source code which provides context for the suggested changes
  • Include tests for your changes

@peterblazejewicz
fix(glob): correct return type to mach Glob interface
0ae328c 
This changes detail of lesser known usage of the module.
As pointed in DefinitelyTyped#45192 the function usage should return fully initialized
instance of the glob:
https://git.io/Jf6WM

/cc @Shinigami92

Thanks!

Fixes DefinitelyTyped#45192
@peterblazejewicz peterblazejewicz requested a review from vvakame as a code owner May 31, 2020 11:23
@typescript-bot typescript-bot added Where is GH Actions? GH Actions didn't give a response to this PR Critical package labels May 31, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented May 31, 2020 •
edited
Loading

@peterblazejewicz Thank you for submitting this PR!

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ❌ Most recent commit is approved by DT maintainers

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": 45193,
  "author": "peterblazejewicz",
  "owners": [
    "vvakame",
    "voy",
    "ajafff"
  ],
  "dangerLevel": "ScopedAndTested",
  "headCommitAbbrOid": "0ae328c",
  "headCommitOid": "0ae328c98463cd05c1594cf36baa030ad9c7fe4c",
  "mergeIsRequested": false,
  "stalenessInDays": 3,
  "lastCommitDate": "2020-05-31T11:22:10.000Z",
  "lastCommentDate": "2020-05-31T11:25:40.000Z",
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/45193/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": false,
  "popularityLevel": "Critical",
  "anyPackageIsNew": false,
  "packages": [
    "glob"
  ],
  "files": [
    {
      "filePath": "types/glob/glob-tests.ts",
      "kind": "test",
      "package": "glob"
    },
    {
      "filePath": "types/glob/index.d.ts",
      "kind": "definition",
      "package": "glob"
    }
  ],
  "hasDismissedReview": false,
  "ciResult": "pass",
  "lastReviewDate": "2020-05-31T11:28:57.000Z",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 1,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Contributor

typescript-bot commented May 31, 2020

🔔 @vvakame @voy @ajafff - 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 removed the Where is GH Actions? GH Actions didn't give a response to this PR label May 31, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented May 31, 2020

🔔 @vvakame @voy @ajafff - 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.

@danger-public
Copy link

danger-public commented May 31, 2020

Inspecting the JavaScript source for this package found some properties that are not in the .d.ts files.
The check for missing properties isn't always right, so take this list as advice, not a requirement.

glob (unpkg)

was missing the following properties:

  1. glob

Generated by 🚫 dangerJS against 0ae328c

@peterblazejewicz peterblazejewicz changed the title fix(glob): correct return type to mach Glob interface fix(glob): correct return type to match Glob interface May 31, 2020
@typescript-bot typescript-bot added the Other Approved This PR was reviewed and signed-off by a community member. label May 31, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented May 31, 2020

👋 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 #45193 diff
Batch compilation
Memory usage (MiB) 64.5 63.8 -1.2%
Type count 9325 9335 0%
Assignability cache size 3227 3227 0%
Language service
Samples taken 58 72 +24%
Identifiers in tests 58 72 +24%
getCompletionsAtPosition
    Mean duration (ms) 287.3 275.5 -4.1%
    Mean CV 12.0% 14.5%
    Worst duration (ms) 338.5 339.7 +0.3%
    Worst identifier mark globInstance
getQuickInfoAtPosition
    Mean duration (ms) 289.7 272.2 -6.0%
    Mean CV 13.1% 14.9% +14.4%
    Worst duration (ms) 344.8 314.3 -8.8%
    Worst identifier log abort

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 31, 2020
@rbuckton rbuckton merged commit ad85beb into DefinitelyTyped:master Jun 4, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented Jun 4, 2020

I just published @types/[email protected] to npm.

@peterblazejewicz peterblazejewicz deleted the fix/45192 branch June 4, 2020 23:50
jjballano-qatium pushed a commit to jjballano-qatium/DefinitelyTyped that referenced this pull request Jun 16, 2020
@peterblazejewicz @jjballano-qatium
fix(glob): correct return type to mach Glob interface (DefinitelyType…
993e7c0 
…d#45193)

This changes detail of lesser known usage of the module.
As pointed in DefinitelyTyped#45192 the function usage should return fully initialized
instance of the glob:
https://git.io/Jf6WM

/cc @Shinigami92

Thanks!

Fixes DefinitelyTyped#45192
ngbrown pushed a commit to ngbrown-forks/DefinitelyTyped that referenced this pull request Jul 11, 2020
@peterblazejewicz @ngbrown
fix(glob): correct return type to mach Glob interface (DefinitelyType…
311f440 
…d#45193)

This changes detail of lesser known usage of the module.
As pointed in DefinitelyTyped#45192 the function usage should return fully initialized
instance of the glob:
https://git.io/Jf6WM

/cc @Shinigami92

Thanks!

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

Reviewers

@vvakame vvakame Awaiting requested review from vvakame

1 more reviewer

@Shinigami92 Shinigami92 Shinigami92 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Critical package 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.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[@types/glob] glob returns something instead of void

5 participants

@peterblazejewicz @typescript-bot @danger-public @Shinigami92 @rbuckton