Fix types after octokit update

Author: mdbenito

src/githubHelper.ts

@@ -1,10 +1,15 @@
 import settings from '../settings';
 import { GithubSettings } from './settings';
 import * as utils from './utils';
-import {Octokit as GitHubApi, RestEndpointMethodTypes} from '@octokit/rest';
-import { IssuesListForRepoResponseData, PullsListResponseData } from "@octokit/types";
+import { Octokit as GitHubApi, RestEndpointMethodTypes } from '@octokit/rest';
+import { Endpoints } from '@octokit/types';
 import GitlabHelper from './gitlabHelper';
 
+type IssuesListForRepoResponseData =
+  Endpoints['GET /repos/{owner}/{repo}/issues']['response']['data'];
+type PullsListResponseData =
+  Endpoints['GET /repos/{owner}/{repo}/pulls']['response']['data'];
+
 const gitHubLocation = 'https://github.com';
 
 export default class GithubHelper {
@@ -20,10 +25,12 @@ export default class GithubHelper {
   delayInMs: number;
   useIssuesForAllMergeRequests: boolean;
 
-  constructor(githubApi: GitHubApi,
-              githubSettings: GithubSettings,
-              gitlabHelper: GitlabHelper,
-              useIssuesForAllMergeRequests: boolean) {
+  constructor(
+    githubApi: GitHubApi,
+    githubSettings: GithubSettings,
+    gitlabHelper: GitlabHelper,
+    useIssuesForAllMergeRequests: boolean
+  ) {
     this.githubApi = githubApi;
     this.githubUrl = githubSettings.baseUrl
       ? githubSettings.baseUrl
@@ -54,7 +61,7 @@ export default class GithubHelper {
       // get an array of GitHub milestones for the new repo
       let result = await this.githubApi.repos.get({
         owner: this.githubOwner,
-        repo: this.githubRepo
+        repo: this.githubRepo,
       });
 
       this.repoId = result.data.id;
@@ -209,9 +216,12 @@ export default class GithubHelper {
    * TODO description
    */
   async createIssue(milestones, issue) {
-    let bodyConverted = await this.convertIssuesAndComments(issue.description, issue);
+    let bodyConverted = await this.convertIssuesAndComments(
+      issue.description,
+      issue
+    );
 
-    let props : RestEndpointMethodTypes["issues"]["create"]["parameters"] = {
+    let props: RestEndpointMethodTypes['issues']['create']['parameters'] = {
       owner: this.githubOwner,
       repo: this.githubRepo,
       title: issue.title.trim(),
@@ -316,8 +326,9 @@ export default class GithubHelper {
     }
 
     console.log(
-      `\t...Done creating issue comments (migrated ${nrOfMigratedNotes} comments, skipped ${notes.length -
-        nrOfMigratedNotes} comments)`
+      `\t...Done creating issue comments (migrated ${nrOfMigratedNotes} comments, skipped ${
+        notes.length - nrOfMigratedNotes
+      } comments)`
     );
   }
 
@@ -395,7 +406,7 @@ export default class GithubHelper {
     // default state is open so we don't have to update if the issue is closed.
     if (issue.state !== 'closed' || githubIssue.state === 'closed') return;
 
-    let props: RestEndpointMethodTypes["issues"]["update"]["parameters"] = {
+    let props: RestEndpointMethodTypes['issues']['update']['parameters'] = {
       owner: this.githubOwner,
       repo: this.githubRepo,
       issue_number: githubIssue.number,
@@ -418,13 +429,14 @@ export default class GithubHelper {
    */
   async createMilestone(milestone) {
     // convert from GitLab to GitHub
-    let githubMilestone : RestEndpointMethodTypes["issues"]["createMilestone"]["parameters"] = {
-      owner: this.githubOwner,
-      repo: this.githubRepo,
-      title: milestone.title,
-      description: milestone.description,
-      state: milestone.state === 'active' ? 'open' : 'closed',
-    };
+    let githubMilestone: RestEndpointMethodTypes['issues']['createMilestone']['parameters'] =
+      {
+        owner: this.githubOwner,
+        repo: this.githubRepo,
+        title: milestone.title,
+        description: milestone.description,
+        state: milestone.state === 'active' ? 'open' : 'closed',
+      };
 
     if (milestone.due_date) {
       githubMilestone.due_on = milestone.due_date + 'T00:00:00Z';
@@ -574,13 +586,13 @@ export default class GithubHelper {
         await this.githubApi.pulls.create(props);
         return Promise.resolve({ data: null }); // need to return null promise for parent to wait on
       } catch (err) {
-        if(err.status === 422) {
+        if (err.status === 422) {
           console.error(
             `Pull request #${pullRequest.iid} - attempt to create has failed, assume '${pullRequest.source_branch}' has already been merged => cannot migrate pull request, creating an issue instead.`
           );
           // fall through to next section
         } else {
-          throw (err);
+          throw err;
         }
       }
     }
@@ -651,8 +663,9 @@ export default class GithubHelper {
     }
 
     console.log(
-      `\t...Done creating pull request comments (migrated ${nrOfMigratedNotes} pull request comments, skipped ${notes.length -
-        nrOfMigratedNotes} pull request comments)`
+      `\t...Done creating pull request comments (migrated ${nrOfMigratedNotes} pull request comments, skipped ${
+        notes.length - nrOfMigratedNotes
+      } pull request comments)`
     );
   }
 
@@ -667,7 +680,7 @@ export default class GithubHelper {
    * @returns {Promise<Github.Response<Github.IssuesUpdateResponse>>}
    */
   async updatePullRequestData(githubPullRequest, pullRequest, milestones) {
-    let props: RestEndpointMethodTypes["issues"]["update"]["parameters"] = {
+    let props: RestEndpointMethodTypes['issues']['update']['parameters'] = {
       owner: this.githubOwner,
       repo: this.githubRepo,
       issue_number: githubPullRequest.number || githubPullRequest.iid,
@@ -746,7 +759,7 @@ export default class GithubHelper {
     if (pullRequest.state !== 'closed' || githubPullRequest.state === 'closed')
       return;
 
-    let props : RestEndpointMethodTypes["issues"]["update"]["parameters"] = {
+    let props: RestEndpointMethodTypes['issues']['update']['parameters'] = {
       owner: this.githubOwner,
       repo: this.githubRepo,
       issue_number: githubPullRequest.number,
@@ -825,7 +838,12 @@ export default class GithubHelper {
         }
       );
 
-      strWithMigLine = await utils.migrateAttachments(strWithMigLine, this.repoId, settings.s3, this.gitlabHelper);
+      strWithMigLine = await utils.migrateAttachments(
+        strWithMigLine,
+        this.repoId,
+        settings.s3,
+        this.gitlabHelper
+      );
 
       return strWithMigLine;
     }
@@ -899,10 +917,7 @@ export default class GithubHelper {
         line = position.old_line;
       }
       const crypto = require('crypto');
-      const hash = crypto
-        .createHash('md5')
-        .update(path)
-        .digest('hex');
+      const hash = crypto.createHash('md5').update(path).digest('hex');
       slug = `#diff-${hash}${side}${line}`;
     }
     // Mention the file and line number. If we can't get this for some reason then use the commit id instead.