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 types to randomatic #45822

Merged
merged 2 commits into from Jul 6, 2020
Merged

Conversation

execfera
Copy link
Contributor

@execfera execfera commented Jul 1, 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 typescript-bot added The CI failed When GH Actions fails New Definition This PR creates a new definition package. labels Jul 1, 2020
@typescript-bot typescript-bot added this to Needs Author Action in New Pull Request Status Board Jul 1, 2020
@typescript-bot
Copy link
Contributor

typescript-bot commented Jul 1, 2020

@execfera Thank you for submitting this PR!

This is a live comment which I will keep updated.

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": 45822,
  "author": "execfera",
  "owners": [],
  "dangerLevel": "ScopedAndConfiguration",
  "headCommitAbbrOid": "21e7ddd",
  "headCommitOid": "21e7ddd176771786014357e41cdd080f9980eb59",
  "mergeIsRequested": false,
  "stalenessInDays": 4,
  "lastCommitDate": "2020-07-01T09:42:58.000Z",
  "lastCommentDate": "2020-07-01T09:42:58.000Z",
  "maintainerBlessed": false,
  "reviewLink": "https://github.com/DefinitelyTyped/DefinitelyTyped/pull/45822/files",
  "hasMergeConflict": false,
  "authorIsOwner": false,
  "isFirstContribution": false,
  "popularityLevel": "Well-liked by everyone",
  "anyPackageIsNew": true,
  "packages": [
    "randomatic"
  ],
  "files": [
    {
      "filePath": "types/randomatic/index.d.ts",
      "kind": "definition",
      "package": "randomatic"
    },
    {
      "filePath": "types/randomatic/randomatic-tests.ts",
      "kind": "test",
      "package": "randomatic"
    },
    {
      "filePath": "types/randomatic/tsconfig.json",
      "kind": "package-meta",
      "package": "randomatic"
    },
    {
      "filePath": "types/randomatic/tslint.json",
      "kind": "package-meta",
      "package": "randomatic"
    }
  ],
  "hasDismissedReview": false,
  "ciResult": "pass",
  "reviewersWithStaleReviews": [],
  "approvalFlags": 0,
  "isChangesRequested": false
}

@typescript-bot
Copy link
Contributor

@execfera The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

@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 randomatic with its source on master.

Comparison details 📊
Batch compilation
Type count 2117
Assignability cache size 97
Language service measurements
Samples taken 6
Identifiers in tests 6
getCompletionsAtPosition
    Mean duration (ms) 90.2
    Mean CV 27.8%
    Worst duration (ms) 109.1
    Worst identifier randomize
getQuickInfoAtPosition
    Mean duration (ms) 92.4
    Mean CV 31.2%
    Worst duration (ms) 99.7
    Worst identifier chars
System information
Node version v12.18.1
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-1089-azure

@typescript-bot typescript-bot removed the The CI failed When GH Actions fails label Jul 1, 2020
@typescript-bot typescript-bot moved this from Needs Author Action to Needs Maintainer Review in New Pull Request Status Board Jul 1, 2020
@typescript-bot typescript-bot moved this from Needs Maintainer Review to Needs Maintainer Action in New Pull Request Status Board Jul 6, 2020
@weswigham weswigham merged commit 1882299 into DefinitelyTyped:master Jul 6, 2020
@typescript-bot typescript-bot removed this from Needs Maintainer Action in New Pull Request Status Board Jul 6, 2020
ngbrown pushed a commit to ngbrown-forks/DefinitelyTyped that referenced this pull request Jul 11, 2020
* Add types to randomatic

* Include definition author for randomatic
danielrearden pushed a commit to danielrearden/DefinitelyTyped that referenced this pull request Sep 22, 2020
* Add types to randomatic

* Include definition author for randomatic
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