Fix some types. Formatting

Author: mdbenito

src/githubHelper.ts

@@ -4,7 +4,6 @@ import * as utils from './utils';
 import { Octokit as GitHubApi, RestEndpointMethodTypes } from '@octokit/rest';
 import { Endpoints } from '@octokit/types';
 import { GitlabHelper } from './gitlabHelper';
-import { LabelSchema } from '@gitbeaker/core/dist/types/types';
 
 type IssuesListForRepoResponseData =
   Endpoints['GET /repos/{owner}/{repo}/issues']['response']['data'];
@@ -13,11 +12,6 @@ type PullsListResponseData =
 
 const gitHubLocation = 'https://github.com';
 
-interface Milestone {
-  number: number;
-  title: string;
-}
-
 interface CommentImport {
   created_at?: string;
   body: string;
@@ -34,7 +28,24 @@ interface IssueImport {
   labels?: Array<string>;
 }
 
-export type SimpleLabel = Pick<LabelSchema, 'name' | 'color'>;
+export interface MilestoneImport {
+  id?: number; // GitHub internal identifier
+  iid?: number; // GitLab external number
+  title: string;
+  description: string;
+  state: string;
+  due_date?: string;
+}
+
+export interface SimpleLabel {
+  name: string;
+  color: string;
+}
+
+export interface SimpleMilestone {
+  number: number;
+  title: string;
+}
 
 export class GithubHelper {
   githubApi: GitHubApi;
@@ -100,7 +111,7 @@ export class GithubHelper {
   /**
    * Get a list of all GitHub milestones currently in new repo
    */
-  async getAllGithubMilestones(): Promise<Milestone[]> {
+  async getAllGithubMilestones(): Promise<SimpleMilestone[]> {
     try {
       await utils.sleep(this.delayInMs);
       // get an array of GitHub milestones for the new repo
@@ -708,7 +719,9 @@ export class GithubHelper {
    * @param milestone GitLab milestone data
    * @return Created milestone data (or void if debugging => nothing created)
    */
-  async createMilestone(milestone): Promise<Milestone | void> {
+  async createMilestone(
+    milestone: MilestoneImport
+  ): Promise<SimpleMilestone | void> {
     // convert from GitLab to GitHub
     let githubMilestone: RestEndpointMethodTypes['issues']['createMilestone']['parameters'] =
       {

src/gitlabHelper.ts

@@ -1,16 +1,6 @@
 import { Gitlab } from '@gitbeaker/node';
 import { GitlabSettings } from './settings';
 import axios from 'axios';
-// import { MilestoneSchema } from '@gitbeaker/core/dist/types/types';
-// export type Milestone = Partial<MilestoneSchema>;
-
-export interface Milestone {
-  id?: number; // internal gitlab identifier
-  iid: number; // milestone number, equivalent to github number
-  title: string;
-  description: string;
-  state: string;
-}
 
 export class GitlabHelper {
   // Wait for this issue to be resolved
@@ -126,8 +116,10 @@ export class GitlabHelper {
    * Gets all branches.
    */
   async getAllBranches() {
-    if (!this.allBranches){
-      this.allBranches = await this.gitlabApi.Branches.all(this.gitlabProjectId);
+    if (!this.allBranches) {
+      this.allBranches = await this.gitlabApi.Branches.all(
+        this.gitlabProjectId
+      );
     }
     return this.allBranches as any[];
   }

src/index.ts

@@ -1,5 +1,5 @@
-import { GithubHelper, SimpleLabel } from './githubHelper';
-import { GitlabHelper, Milestone } from './gitlabHelper';
+import { GithubHelper, MilestoneImport, SimpleLabel } from './githubHelper';
+import { GitlabHelper } from './gitlabHelper';
 import settings from '../settings';
 
 import { Octokit as GitHubApi } from '@octokit/rest';
@@ -59,7 +59,7 @@ const MyOctokit = GitHubApi.plugin(throttling);
 
 // Create a GitHub API object
 const githubApi = new MyOctokit({
-  previews: settings.useIssueImportAPI ? ["golden-comet"] : [],
+  previews: settings.useIssueImportAPI ? ['golden-comet'] : [],
   debug: false,
   baseUrl: settings.github.baseUrl
     ? settings.github.baseUrl
@@ -113,7 +113,7 @@ if (!settings.gitlab.projectId) {
  * @param expectedIdx Number of the GitLab milestone
  * @returns Data for the milestone
  */
-function createPlaceholderMilestone(expectedIdx: number): Milestone {
+function createPlaceholderMilestone(expectedIdx: number): MilestoneImport {
   return {
     iid: expectedIdx,
     title: `[PLACEHOLDER] - for milestone #${expectedIdx}`,
@@ -185,13 +185,11 @@ async function migrate() {
       await transferLabels(true, settings.conversion.useLowerCaseLabels);
     }
 
-
     // transfer GitLab releases to GitHub
     if (settings.transfer.releases) {
       await transferReleases();
     }
 
-
     // Transfer issues with their comments; do this before transferring the merge requests
     if (settings.transfer.issues) {
       await transferIssues();
@@ -223,7 +221,7 @@ async function transferMilestones(
   inform('Transferring Milestones');
 
   // Get a list of all milestones associated with this project
-  let milestones: Milestone[] = await gitlabApi.ProjectMilestones.all(
+  let milestones: MilestoneImport[] = await gitlabApi.ProjectMilestones.all(
     settings.gitlab.projectId
   );
 
@@ -499,9 +497,11 @@ async function transferMergeRequests() {
     );
     if (!githubRequest && !githubIssue) {
       if (settings.skipMergeRequestStates.includes(request.state)) {
-          console.log(`Skipping MR ${request.iid} in "${request.state}" state: ${request.title}`)
-          continue;
-        }
+        console.log(
+          `Skipping MR ${request.iid} in "${request.state}" state: ${request.title}`
+        );
+        continue;
+      }
       console.log(
         'Creating pull request: !' + request.iid + ' - ' + request.title
       );
@@ -540,25 +540,25 @@ async function transferMergeRequests() {
 
 /**
  * Transfer any releases that exist in GitLab that do not exist in GitHub
- * Please note that due to github api restrictions, this only transfers the 
+ * Please note that due to github api restrictions, this only transfers the
  * name, description and tag name of the release. It sorts the releases chronologically
  * and creates them on github one by one
  * @returns {Promise<void>}
  */
- async function transferReleases() {
+async function transferReleases() {
   inform('Transferring Releases');
 
   // Get a list of all releases associated with this project
-  let releases = await gitlabApi.Releases.all(settings.gitlab.projectId) as any;
+  let releases = (await gitlabApi.Releases.all(
+    settings.gitlab.projectId
+  )) as any;
 
   // Sort releases in ascending order of their release date
   releases = releases.sort((a, b) => {
     return (new Date(a.released_at) as any) - (new Date(b.released_at) as any);
   });
 
-  console.log(
-    'Transferring ' + releases.length.toString() + ' releases'
-  );
+  console.log('Transferring ' + releases.length.toString() + ' releases');
 
   //
   // Create GitHub release for each GitLab release
@@ -569,26 +569,34 @@ async function transferMergeRequests() {
     // Try to find an existing github release that already exists for this GitLab
     // release
     let githubRelease = await githubHelper.getReleaseByTag(release.tag_name);
-    
+
     if (!githubRelease) {
       console.log(
         'Creating release: !' + release.name + ' - ' + release.tag_name
       );
       try {
         // process asynchronous code in sequence
-        await githubHelper.createRelease(release.tag_name, release.name, release.description);
+        await githubHelper.createRelease(
+          release.tag_name,
+          release.name,
+          release.description
+        );
       } catch (err) {
         console.error(
           'Could not create release: !' +
-          release.name + ' - ' + release.tag_name
+            release.name +
+            ' - ' +
+            release.tag_name
         );
         console.error(err);
       }
     } else {
-        console.log(
-          'Gitlab release already exists (as github release): ' +
-          githubRelease.data.name + ' - ' + githubRelease.data.tag_name
-        );
+      console.log(
+        'Gitlab release already exists (as github release): ' +
+          githubRelease.data.name +
+          ' - ' +
+          githubRelease.data.tag_name
+      );
     }
   }
 }