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] Add types for deprecate, deprecated, and deprecatedOptions #47867

Merged
merged 1 commit into from Oct 8, 2020
Merged

[yargs] Add types for deprecate, deprecated, and deprecatedOptions #47867

merged 1 commit into from Oct 8, 2020

Conversation

natasha-audrey
Copy link
Contributor

@natasha-audrey natasha-audrey commented Sep 21, 2020

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

If changing an existing definition:

Note this was added in yargs@15.2.0 -- I don't know if there is a version update that should be made here

@typescript-bot
Copy link
Contributor

typescript-bot commented Sep 21, 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 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 or DT maintainers

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": 47867,
  "author": "NathanYocum",
  "owners": [
    "poelstra",
    "mizunashi-mana",
    "pushplay",
    "JimiC",
    "steffenvv",
    "forivall",
    "ExE-Boss",
    "Aankhen"
  ],
  "dangerLevel": "ScopedAndTested",
  "headCommitAbbrOid": "61892ba",
  "headCommitOid": "61892ba3012bd844181c33c2be10e05f6ea8dfcd",
  "mergeIsRequested": true,
  "stalenessInDays": 0,
  "lastPushDate": "2020-09-21T21:27:00.000Z",
  "lastCommentDate": "2020-10-08T18:03:02.000Z",
  "maintainerBlessed": true,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/47867/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-10-07T05:21:18.000Z",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 2,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Contributor

typescript-bot commented Sep 21, 2020

🔔 @poelstra @mizunashi-mana @pushplay @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 21, 2020
@natasha-audrey natasha-audrey changed the title [@types/yargs] Add types for deprecate, deprecated, and deprecatedOptions Add types for deprecate, deprecated, and deprecatedOptions Sep 21, 2020
@natasha-audrey natasha-audrey changed the title Add types for deprecate, deprecated, and deprecatedOptions [yargs] Add types for deprecate, deprecated, and deprecatedOptions Sep 21, 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 #47867 diff
Batch compilation
Memory usage (MiB) 82.7 84.5 +2.2%
Type count 16259 16306 0%
Assignability cache size 2786 2791 0%
Language service
Samples taken 1503 1512 +1%
Identifiers in tests 1503 1512 +1%
getCompletionsAtPosition
    Mean duration (ms) 373.6 374.7 +0.3%
    Mean CV 8.1% 8.0%
    Worst duration (ms) 592.7 593.3 +0.1%
    Worst identifier arg array
getQuickInfoAtPosition
    Mean duration (ms) 371.3 371.9 +0.2%
    Mean CV 8.4% 8.3% -1.4%
    Worst duration (ms) 572.9 607.2 +6.0%
    Worst identifier argv2 positional

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 21, 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

@forivall forivall left a comment

Choose a reason for hiding this comment

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

LGTM

@typescript-bot typescript-bot added Owner Approved A listed owner of this package signed off on the pull request. Self Merge This PR can now be self-merged by the PR author or an owner labels Oct 7, 2020
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Waiting for Author to Merge in New Pull Request Status Board Oct 7, 2020
@typescript-bot
Copy link
Contributor

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

(@poelstra, @mizunashi-mana, @pushplay, @JimiC, @steffenvv, @forivall, @ExE-Boss, @Aankhen: you can do this too.)

@pushplay
Copy link
Contributor

pushplay commented Oct 8, 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 Oct 8, 2020
@typescript-bot typescript-bot merged commit 5dff0e3 into DefinitelyTyped:master Oct 8, 2020
@typescript-bot
Copy link
Contributor

I just published @types/yargs@15.0.8 to npm.

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

4 participants