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] Added strictOptions typing #48657

Merged
merged 1 commit into from Oct 16, 2020

Conversation

Vboivin
Copy link
Contributor

@Vboivin Vboivin commented Oct 9, 2020

Fix part of #47879

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

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <feat: adds strictOptions() yargs/yargs#1738>
  • 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 Oct 9, 2020

@Vboivin 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

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": 48657,
  "author": "Vboivin",
  "owners": [
    "poelstra",
    "mizunashi-mana",
    "pushplay",
    "JimiC",
    "steffenvv",
    "forivall",
    "ExE-Boss",
    "Aankhen"
  ],
  "dangerLevel": "ScopedAndTested",
  "headCommitAbbrOid": "9e6ae58",
  "headCommitOid": "9e6ae58a0182cdfa22cd2e2bcb192a815e685e2f",
  "mergeIsRequested": false,
  "stalenessInDays": 4,
  "lastPushDate": "2020-10-09T19:24:54.000Z",
  "lastCommentDate": "2020-10-09T19:24:54.000Z",
  "maintainerBlessed": false,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/48657/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": true,
  "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-10T20:13:21.000Z",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 2,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Contributor

🔔 @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 Oct 9, 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 #48657 diff
Batch compilation
Memory usage (MiB) 87.5 86.2 -1.4%
Type count 16490 16508 0%
Assignability cache size 2804 2807 0%
Language service
Samples taken 1528 1536 +1%
Identifiers in tests 1528 1536 +1%
getCompletionsAtPosition
    Mean duration (ms) 380.6 380.5 0.0%
    Mean CV 8.0% 8.2%
    Worst duration (ms) 614.4 598.0 -2.7%
    Worst identifier arg parseInt
getQuickInfoAtPosition
    Mean duration (ms) 376.5 374.8 -0.5%
    Mean CV 8.2% 8.2% +0.4%
    Worst duration (ms) 572.9 564.5 -1.5%
    Worst identifier argv2 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 Oct 9, 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 the Owner Approved A listed owner of this package signed off on the pull request. label Oct 10, 2020
@orta orta merged commit 065fb70 into DefinitelyTyped:master Oct 16, 2020
@typescript-bot typescript-bot removed this from Needs Maintainer Review in New Pull Request Status Board Oct 16, 2020
@typescript-bot
Copy link
Contributor

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

forivall added a commit to forivall/DefinitelyTyped that referenced this pull request Jan 19, 2021
This reverts commit 065fb70.

strictOptions is a v16 only feature
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