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 type definitions for Keychain NPM module #64842

Merged
merged 8 commits into from Mar 23, 2023

Conversation

khaosdoctor
Copy link
Contributor

@khaosdoctor khaosdoctor commented Mar 21, 2023

Please fill in this template.

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 contain { "extends": "@definitelytyped/dtslint/dt.json" }, and no additional rules.
  • tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

@typescript-bot
Copy link
Contributor

typescript-bot commented Mar 21, 2023

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

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

You can test the changes of this PR in the Playground.

Status

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

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": 64842,
  "author": "khaosdoctor",
  "headCommitOid": "9c0fc4b5e599e3e0fdc7bac1dca4a792ebb6d709",
  "mergeBaseOid": "c8d68f04d24f4354b2e7d018966483333958c528",
  "lastPushDate": "2023-03-23T14:07:13.000Z",
  "lastActivityDate": "2023-03-23T20:30:36.000Z",
  "mergeOfferDate": "2023-03-23T20:06:10.000Z",
  "mergeRequestDate": "2023-03-23T20:30:36.000Z",
  "mergeRequestUser": "khaosdoctor",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "keychain",
      "kind": "add",
      "files": [
        {
          "path": "types/keychain/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/keychain/keychain-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/keychain/tsconfig.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/keychain/tslint.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [],
      "addedOwners": [
        "khaosdoctor"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "peterblazejewicz",
      "date": "2023-03-23T20:05:23.000Z",
      "isMaintainer": true
    },
    {
      "type": "stale",
      "reviewer": "sandersn",
      "date": "2023-03-21T23:41:14.000Z",
      "abbrOid": "92862ae"
    }
  ],
  "mainBotCommentID": 1478506775,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added the New Definition This PR creates a new definition package. label Mar 21, 2023
@typescript-bot typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board Mar 21, 2023
@typescript-bot
Copy link
Contributor

typescript-bot commented Mar 21, 2023

🔔 @khaosdoctor — you're the only owner, but it would still be good if you find someone to review this PR in the next few days, otherwise a maintainer will look at it. (And if you do find someone, maybe even recruit them to be a second owner to make future changes easier...)

@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Mar 21, 2023
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Mar 21, 2023
@typescript-bot
Copy link
Contributor

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

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

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

Signed-off-by: Lucas Santos <lucas.santos@klarna.com>
@typescript-bot typescript-bot removed the The CI failed When GH Actions fails label Mar 21, 2023
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Mar 21, 2023
@DangerBotOSS
Copy link

DangerBotOSS commented Mar 21, 2023

Inspecting the JavaScript source for this package found some properties that are not in the .d.ts files.
The check for missing properties isn't always right, so take this list as advice, not a requirement.

keychain (unpkg)

was missing the following properties:

  1. executablePath

Generated by 🚫 dangerJS against 9c0fc4b

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in New Pull Request Status Board Mar 21, 2023
@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Code Reviews in New Pull Request Status Board Mar 21, 2023
@khaosdoctor
Copy link
Contributor Author

Inspecting the JavaScript source for this package found some properties that are not in the .d.ts files.
The check for missing properties isn't always right, so take this list as advice, not a requirement.

This is because the module is exported as a default export, I've tested this in a real CLI to make sure the types were ok

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in New Pull Request Status Board Mar 21, 2023
types/keychain/keychain-tests.ts Outdated Show resolved Hide resolved
types/keychain/index.d.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 Mar 21, 2023
@typescript-bot typescript-bot moved this from Needs Maintainer Action to Needs Author Action in New Pull Request Status Board Mar 21, 2023
@typescript-bot
Copy link
Contributor

@khaosdoctor 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. Thank you!

Signed-off-by: Lucas Santos <lucas.santos@klarna.com>
@typescript-bot typescript-bot removed the Revision needed This PR needs code changes before it can be merged. label Mar 22, 2023
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Mar 22, 2023
@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Mar 22, 2023
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Author Action in New Pull Request Status Board Mar 22, 2023
@typescript-bot
Copy link
Contributor

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

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

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

@khaosdoctor
Copy link
Contributor Author

Forgot to run the tests 😅

Signed-off-by: Lucas Santos <lucas.santos@klarna.com>
@typescript-bot typescript-bot removed the The CI failed When GH Actions fails label Mar 22, 2023
@typescript-bot typescript-bot moved this from Needs Author Action to Waiting for Code Reviews in New Pull Request Status Board Mar 22, 2023
@typescript-bot
Copy link
Contributor

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

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in New Pull Request Status Board Mar 22, 2023
@typescript-bot
Copy link
Contributor

@peterblazejewicz, @sandersn 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?

khaosdoctor and others added 2 commits March 23, 2023 15:04
Co-authored-by: Piotr Błażejewicz (Peter Blazejewicz) <peterblazejewicz@users.noreply.github.com>
@typescript-bot typescript-bot added the Where is GH Actions? GH Actions didn't give a response to this PR label Mar 23, 2023
@typescript-bot typescript-bot moved this from Needs Maintainer Action to Other in New Pull Request Status Board Mar 23, 2023
@typescript-bot typescript-bot removed the Where is GH Actions? GH Actions didn't give a response to this PR label Mar 23, 2023
@typescript-bot typescript-bot moved this from Other to Waiting for Code Reviews in New Pull Request Status Board Mar 23, 2023
@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Action in New Pull Request Status Board Mar 23, 2023
@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Mar 23, 2023
@typescript-bot typescript-bot moved this from Needs Maintainer Action to Waiting for Author to Merge in New Pull Request Status Board Mar 23, 2023
@typescript-bot
Copy link
Contributor

@khaosdoctor: Everything looks good here. I am ready to merge this PR (at 9c0fc4b) on your behalf whenever you think it's ready.

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

@khaosdoctor
Copy link
Contributor Author

Ready to merge

@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Recently Merged in New Pull Request Status Board Mar 23, 2023
@typescript-bot typescript-bot merged commit fa8b4f5 into DefinitelyTyped:master Mar 23, 2023
2 checks passed
@typescript-bot typescript-bot removed this from Recently Merged in New Pull Request Status Board Mar 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintainer Approved New Definition This PR creates a new definition package. 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

5 participants