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

Add definition types for 'ip6addr' npm package #44831

Merged
merged 3 commits into from
May 19, 2020

Conversation

slaweet
Copy link
Contributor

@slaweet slaweet commented May 18, 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:

If adding a new definition:

  • The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
  • If this is for an NPM package, match the name. If not, do not conflict with the name of an NPM package.
  • Create it with dts-gen --dt, not by basing it on an existing project.
  • Represents shape of module/library correctly
  • tslint.json should be present and it shouldn't have any additional or disabling of rules. Just content as { "extends": "dtslint/dt.json" }. If for reason the some 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.
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

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

These typings are for a package that doesn’t yet exist on master, so I don’t have anything to compare against yet! In the future, I’ll be able to compare PRs to ip6addr with its source on master.

Comparison details 📊
Batch compilation
Type count 9283
Assignability cache size 3212
Language service measurements
Samples taken 75
Identifiers in tests 75
getCompletionsAtPosition
    Mean duration (ms) 288.6
    Mean CV 12.2%
    Worst duration (ms) 358.4
    Worst identifier ip6addr
getQuickInfoAtPosition
    Mean duration (ms) 289.0
    Mean CV 13.4%
    Worst duration (ms) 333.3
    Worst identifier compareCIDR
System information
Node version v12.16.3
CPU count 2
CPU speed 2.095 GHz
CPU model Intel(R) Xeon(R) Platinum 8171M CPU @ 2.60GHz
CPU Architecture x64
Memory 6.8 GiB
Platform linux
Release 4.15.0-1082-azure

@slaweet slaweet marked this pull request as ready for review May 19, 2020 05:17
@typescript-bot
Copy link
Contributor

typescript-bot commented May 19, 2020

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

This PR adds a new definition, so it needs to be reviewed by a DT maintainer before it can be merged.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ❌ Only a DT maintainer can merge changes when there are new packages added

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": 44831,
  "author": "slaweet",
  "owners": [],
  "dangerLevel": "ScopedAndConfiguration",
  "headCommitAbbrOid": "74a762f",
  "headCommitOid": "74a762fa344fb393896343733ce56e067b2bcf1b",
  "mergeIsRequested": false,
  "stalenessInDays": 0,
  "lastCommitDate": "2020-05-19T05:22:02.000Z",
  "reopenedDate": "2020-05-19T05:17:20.000Z",
  "lastCommentDate": "2020-05-19T05:22:02.000Z",
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/44831/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": true,
  "popularityLevel": "Well-liked by everyone",
  "anyPackageIsNew": true,
  "packages": [
    "ip6addr"
  ],
  "files": [
    {
      "filePath": "types/ip6addr/index.d.ts",
      "kind": "definition",
      "package": "ip6addr"
    },
    {
      "filePath": "types/ip6addr/ip6addr-tests.ts",
      "kind": "test",
      "package": "ip6addr"
    },
    {
      "filePath": "types/ip6addr/tsconfig.json",
      "kind": "package-meta",
      "package": "ip6addr"
    },
    {
      "filePath": "types/ip6addr/tslint.json",
      "kind": "package-meta",
      "package": "ip6addr"
    }
  ],
  "hasDismissedReview": false,
  "travisResult": "pass",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 0,
  "isChangesRequested": false
}

@typescript-bot typescript-bot added the New Definition This PR creates a new definition package. label May 19, 2020
@typescript-bot typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board May 19, 2020
@sheetalkamat sheetalkamat merged commit 4431288 into DefinitelyTyped:master May 19, 2020
@typescript-bot typescript-bot removed this from Waiting for Code Reviews in New Pull Request Status Board May 19, 2020
@typescript-bot
Copy link
Contributor

I just published @types/ip6addr@0.2.0 to npm.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
New Definition This PR creates a new definition package.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants