[gamedig] Add GameResolver Types

[MaximumWoahverdrive]

the lib/GameResolver.js class was previously not included in DT. It has proven useful in preprocessing and User interaction before the main functions provided by Gamedig are used and therefore make sense to include. This PR adheres to the source and does not introduce new classes, objects or interfaces not present in the source at the cost some readability. Prettier has also been run on relevant files (as advised in common-mistakes) which has resulted in a visually larger than needed diff.

Please fill in this template.

• [x] Use a meaningful title for the pull request. Include the name of the package modified.
• [x] Test the change in your own code. (Compile and run.)
• [x] Add or edit tests to reflect the change.
• [x] Follow the advice from the readme.
• [x] Avoid common mistakes.
• [x] Run npm test <package to test>.

Select one of these and delete the others:

If changing an existing definition:

• [x] Provide a URL to documentation or source code which provides context for the suggested changes: GameResolver.js in gamedig repo
• [ ] 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.

[typescript-bot]

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

• gamedig — on npm, on unpkg
  • owner-approval: @P4sca1, @marcopixel
  • 1 added owner: ✎@MaximumWoahverdrive
  • 1 removed owner: @marcopixel

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

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

Status

• ✅ No merge conflicts
• ✅ Continuous integration tests have passed
• ✅ Most recent commit is approved by type definition owners, DT maintainers or others

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": 62210,
  "author": "MaximumWoahverdrive",
  "headCommitOid": "829843527ebb94f69fbe481954d031f130f5ccaa",
  "mergeBaseOid": "b98c25a5c17b6a34b4e327d0cd566649643e4eed",
  "lastPushDate": "2022-10-05T18:03:46.000Z",
  "lastActivityDate": "2022-10-10T17:13:54.000Z",
  "mergeOfferDate": "2022-10-05T18:11:40.000Z",
  "mergeRequestDate": "2022-10-10T17:13:54.000Z",
  "mergeRequestUser": "MaximumWoahverdrive",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Well-liked by everyone",
  "pkgInfo": [
    {
      "name": "gamedig",
      "kind": "edit",
      "files": [
        {
          "path": "types/gamedig/gamedig-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/gamedig/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/gamedig/lib/GameResolver.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/gamedig/tslint.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "ivansieder",
        "marcopixel",
        "p4sca1"
      ],
      "addedOwners": [
        "MaximumWoahverdrive"
      ],
      "deletedOwners": [
        "marcopixel"
      ],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "rbuckton",
      "date": "2022-10-10T15:56:53.000Z",
      "isMaintainer": true
    },
    {
      "type": "approved",
      "reviewer": "P4sca1",
      "date": "2022-10-05T21:44:45.000Z",
      "isMaintainer": false
    },
    {
      "type": "approved",
      "reviewer": "marcopixel",
      "date": "2022-10-05T18:05:18.000Z",
      "isMaintainer": false
    }
  ],
  "mainBotCommentID": 1243033277,
  "ciResult": "pass"
}

[typescript-bot]

🔔 @ivansieder @marcopixel @p4sca1 — 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]

@MaximumWoahverdrive 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]

@MaximumWoahverdrive 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]

Re-ping @ivansieder, @marcopixel, @p4sca1:

This PR has been out for over a week, yet I haven't seen any reviews.

Could someone please give it some attention? Thanks!

[MaximumWoahverdrive]

Thank you for the PR. Would you be able to also rewrite the index.d.ts file to use the declare class Gamedig and export = Gamedig syntax, like in your GameResolver.d.ts file?

Sure, but it'll have to wait till late Saturday/Sunday as I'm on the road till then. I'm assuming you'll want that added to this PR and not as a separate one, correct?

[P4sca1]

Yes, that would be great. That way we can get rid of the warning from the bot, hopefully.

[typescript-bot]

It has been more than two weeks and this PR still has no reviews.

I'll bump it to the DT maintainer queue. Thank you for your patience, @MaximumWoahverdrive.

(Ping @ivansieder, @marcopixel, @p4sca1.)

[rbuckton]

Thank you for the PR. Would you be able to also rewrite the index.d.ts file to use the declare class Gamedig and export = Gamedig syntax, like in your GameResolver.d.ts file?

Sure, but it'll have to wait till late Saturday/Sunday as I'm on the road till then. [...]

@MaximumWoahverdrive, are you still planning to make changes to this PR?

[MaximumWoahverdrive]

@rbuckton

@MaximumWoahverdrive, are you still planning to make changes to this PR?

absolutely, doing some real code tests with the requested change to index.d.ts and should have the PR updated with it within an hour or so. (great timing on the message :P ) had quite some trouble getting both the Gamedig class and the previously exported types exported without breaking compatibility which delayed progress a bit.

[typescript-bot]

@MaximumWoahverdrive 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]

@rbuckton, @P4sca1 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?

[P4sca1]

Thank you!

[typescript-bot]

@rbuckton 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]

@MaximumWoahverdrive 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]

@MaximumWoahverdrive: Everything looks good here. I am ready to merge this PR (at 8298435) 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! :heart:

(@ivansieder, @marcopixel, @p4sca1: you can do this too.)

[typescript-bot]

@P4sca1, @rbuckton 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?

[MaximumWoahverdrive]

Ready to merge