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

[yargs] Example can take an array of args #47885

Merged
merged 2 commits into from Sep 23, 2020
Merged

[yargs] Example can take an array of args #47885

merged 2 commits into from Sep 23, 2020

Conversation

natasha-audrey
Copy link
Contributor

  • 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 yargs.)
  • 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 changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: feat(): add examples yargs/yargs#1682
  • 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.
    • there are multiple in-flight PRs for uptaking to yargs v16.0
  • Include tests for your changes

@typescript-bot
Copy link
Contributor

typescript-bot commented Sep 22, 2020

@NathanYocum Thank you for submitting this PR!

This is a live comment which I will keep updated.

1 package in 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": 47885,
  "author": "NathanYocum",
  "owners": [
    "poelstra",
    "mizunashi-mana",
    "pushplay",
    "jeffkenney",
    "JimiC",
    "steffenvv",
    "forivall",
    "ExE-Boss",
    "Aankhen"
  ],
  "dangerLevel": "ScopedAndTested",
  "headCommitAbbrOid": "b691b4a",
  "headCommitOid": "b691b4a0741a7d8d7a3bd4e50e5fa5eda7d8f4cc",
  "mergeIsRequested": false,
  "stalenessInDays": 0,
  "lastPushDate": "2020-09-23T01:29:00.000Z",
  "lastCommentDate": "2020-09-23T01:24:28.000Z",
  "maintainerBlessed": false,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/47885/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": false,
  "popularityLevel": "Critical",
  "newPackages": [],
  "packages": [
    "yargs"
  ],
  "files": [
    {
      "path": "types/yargs/index.d.ts",
      "kind": "definition",
      "package": "yargs"
    },
    {
      "path": "types/yargs/yargs-tests.ts",
      "kind": "test",
      "package": "yargs"
    }
  ],
  "hasDismissedReview": false,
  "ciResult": "pass",
  "lastReviewDate": "2020-09-23T01:33:38.000Z",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 2,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Contributor

🔔 @poelstra @mizunashi-mana @pushplay @jeffkenney @JimiC @steffenvv @forivall @ExE-Boss @Aankhen — 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 22, 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 #47885 diff
Batch compilation
Memory usage (MiB) 82.7 81.8 -1.0%
Type count 16259 16283 0%
Assignability cache size 2786 2789 0%
Language service
Samples taken 1503 1504 0%
Identifiers in tests 1503 1504 0%
getCompletionsAtPosition
    Mean duration (ms) 354.9 364.3 +2.6%
    Mean CV 8.9% 7.9%
    Worst duration (ms) 572.9 613.5 +7.1%
    Worst identifier arg array
getQuickInfoAtPosition
    Mean duration (ms) 353.2 361.9 +2.5%
    Mean CV 9.3% 8.5% -9.0%
    Worst duration (ms) 543.9 583.7 +7.3%
    Worst identifier arg argv2

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 22, 2020
@sheetalkamat sheetalkamat moved this from Needs Maintainer Review to Waiting for Code Reviews in New Pull Request Status Board Sep 22, 2020
Copy link
Contributor

@pushplay pushplay left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. It just needs a bit of clean up.

types/yargs/index.d.ts Outdated Show resolved Hide resolved
types/yargs/yargs-tests.ts Outdated Show resolved Hide resolved
@typescript-bot typescript-bot added the Revision needed This PR needs code changes before it can be merged. label Sep 22, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Sep 22, 2020
@typescript-bot
Copy link
Contributor

@NathanYocum One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits or comments. If you disagree with the reviewer's comments, you can "dismiss" the review using GitHub's review UI. Thank you!

@typescript-bot typescript-bot removed the Revision needed This PR needs code changes before it can be merged. label Sep 23, 2020
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Sep 23, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board Sep 23, 2020
@typescript-bot
Copy link
Contributor

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

Copy link
Contributor

@pushplay pushplay left a comment

Choose a reason for hiding this comment

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

Awesome. Thanks for the changes.

@typescript-bot typescript-bot added the Owner Approved A listed owner of this package signed off on the pull request. label Sep 23, 2020
@sheetalkamat sheetalkamat merged commit 4fd4a57 into DefinitelyTyped:master Sep 23, 2020
@typescript-bot typescript-bot removed this from Needs Maintainer Review in New Pull Request Status Board Sep 23, 2020
@natasha-audrey natasha-audrey deleted the yargs/15.4/example-takes-array branch September 26, 2020 03:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Critical package Owner Approved A listed owner of this package signed off on the pull request. Perf: Same typescript-bot determined that this PR will not significantly impact compilation performance.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants