Skip to content

[@atom/watcher] Add type definitions#56580

Merged
typescript-bot merged 5 commits intoDefinitelyTyped:masterfrom
jnv:atom-watcher
Oct 20, 2021
Merged

[@atom/watcher] Add type definitions#56580
typescript-bot merged 5 commits intoDefinitelyTyped:masterfrom
jnv:atom-watcher

Conversation

@jnv
Copy link
Contributor

@jnv jnv commented Oct 17, 2021

Based upon types provided by @LoganDark in #56006. I have added tests for type definitions and changed the comments to be JSDoc. The type depends on Disposable from @types/event-kit package.


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": "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 Oct 17, 2021

@jnv Thank you for submitting this PR!

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": 56580,
  "author": "jnv",
  "headCommitOid": "068709ad4efcf6734c8d9453b2d13775bf179fc6",
  "lastPushDate": "2021-10-20T08:25:05.000Z",
  "lastActivityDate": "2021-10-20T20:51:10.000Z",
  "mergeOfferDate": "2021-10-20T15:48:39.000Z",
  "mergeRequestDate": "2021-10-20T20:51:10.000Z",
  "mergeRequestUser": "jnv",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "atom__watcher",
      "kind": "add",
      "files": [
        {
          "path": "types/atom__watcher/atom__watcher-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/atom__watcher/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/atom__watcher/tsconfig.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/atom__watcher/tslint.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [],
      "addedOwners": [
        "LoganDark",
        "jnv"
      ],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "sandersn",
      "date": "2021-10-20T15:48:01.000Z",
      "isMaintainer": true
    }
  ],
  "mainBotCommentID": 945170428,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added New Definition This PR creates a new definition package. Check Config Changes a module config files labels Oct 17, 2021
@typescript-bot
Copy link
Contributor

🔔 @jnv — 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...)

Co-authored-by: LoganDark <logandarklock@gmail.com>
@LoganDark
Copy link
Contributor

I think you misspelled package.json

@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Oct 17, 2021
@typescript-bot
Copy link
Contributor

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

@LoganDark
Copy link
Contributor

Definitely misspelled package.json

@typescript-bot typescript-bot removed the The CI failed When GH Actions fails label Oct 17, 2021
@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Oct 17, 2021
@typescript-bot
Copy link
Contributor

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

@jnv
Copy link
Contributor Author

jnv commented Oct 17, 2021

🤦 Thanks @LoganDark!

@typescript-bot typescript-bot removed The CI failed When GH Actions fails Check Config Changes a module config files labels Oct 17, 2021
@typescript-bot typescript-bot added the The CI failed When GH Actions fails label Oct 17, 2021
@typescript-bot
Copy link
Contributor

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

@typescript-bot typescript-bot added The CI failed When GH Actions fails and removed The CI failed When GH Actions fails labels Oct 17, 2021
@typescript-bot
Copy link
Contributor

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

jnv added a commit to jnv/DefinitelyTyped-tools that referenced this pull request Oct 17, 2021
@typescript-bot
Copy link
Contributor

@jnv 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!

@typescript-bot typescript-bot added the Revision needed This PR needs code changes before it can be merged. label Oct 19, 2021
@typescript-bot typescript-bot removed Revision needed This PR needs code changes before it can be merged. The CI failed When GH Actions fails labels Oct 20, 2021
@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?

Copy link
Contributor

@sandersn sandersn left a comment

Choose a reason for hiding this comment

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

@jnv, thanks for adapting @LoganDark's types. It's a big pile of work just to set up a scoped package on DT and get it past the bot.

@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Oct 20, 2021
@typescript-bot
Copy link
Contributor

@jnv: Everything looks good here. I am ready to merge this PR (at 068709a) 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! ❤️

@jnv
Copy link
Contributor Author

jnv commented Oct 20, 2021

Ready to merge

@typescript-bot typescript-bot merged commit ff9d529 into DefinitelyTyped:master Oct 20, 2021
@jnv jnv deleted the atom-watcher branch October 20, 2021 20:52
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.

4 participants