Some types added. Cosmetic changes.

Author: mdbenito

src/githubHelper.ts

@@ -20,12 +20,12 @@ interface CommentImport {
 interface IssueImport {
   title: string;
   body: string;
-  created_at: string;
   closed: boolean;
   assignee?: string;
+  created_at?: string;
   updated_at?: string;
   milestone?: number;
-  labels?: Array<string>;
+  labels?: string[];
 }
 
 export interface MilestoneImport {
@@ -200,7 +200,7 @@ export class GithubHelper {
    * @param tag {string} - the tag name to search a release for
    * @returns
    */
-  async getReleaseByTag(tag) {
+  async getReleaseByTag(tag: string) {
     try {
       await utils.sleep(this.delayInMs);
       // get an existing release by tag name in github
@@ -604,9 +604,7 @@ export class GithubHelper {
     let nrOfMigratedNotes = 0;
     for (let note of notes) {
       const gotMigrated = await this.processNote(note, githubIssue);
-      if (gotMigrated) {
-        nrOfMigratedNotes++;
-      }
+      if (gotMigrated) nrOfMigratedNotes++;
     }
 
     console.log(
@@ -625,7 +623,7 @@ export class GithubHelper {
    * Note that this is case insensitive!
    *
    */
-  checkIfNoteCanBeSkipped(noteBody) {
+  checkIfNoteCanBeSkipped(noteBody: string) {
     const stateChange =
       (/Status changed to .*/i.test(noteBody) &&
         !/Status changed to closed by commit.*/i.test(noteBody)) ||
@@ -734,7 +732,7 @@ export class GithubHelper {
 
     await utils.sleep(this.delayInMs);
 
-    if (settings.debug) return Promise.resolve();
+    if (settings.debug) return Promise.resolve({ number: -1, title: 'DEBUG' });
 
     const created = await this.githubApi.issues.createMilestone(
       githubMilestone
@@ -754,7 +752,7 @@ export class GithubHelper {
       owner: this.githubOwner,
       repo: this.githubRepo,
       name: label.name,
-      color: label.color.substr(1), // remove leading "#" because gitlab returns it but github wants the color without it
+      color: label.color.substring(1), // remove leading "#" because gitlab returns it but github wants the color without it
     };
 
     await utils.sleep(this.delayInMs);
@@ -1249,7 +1247,7 @@ export class GithubHelper {
    * When migrating in-line comments to GitHub then creates a link to the
    * appropriate line of the diff.
    */
-  static createLineRef(position, repoLink) {
+  static createLineRef(position, repoLink: string): string {
     if (
       !repoLink ||
       !repoLink.startsWith(gitHubLocation) ||

src/gitlabHelper.ts

@@ -25,6 +25,9 @@ export class GitlabHelper {
     this.gitlabToken = gitlabSettings.token;
     this.gitlabProjectId = gitlabSettings.projectId;
     this.host = gitlabSettings.url ? gitlabSettings.url : 'http://gitlab.com';
+    this.host = this.host.endsWith('/')
+      ? this.host.substring(0, this.host.length - 1)
+      : this.host;
     this.sessionCookie = gitlabSettings.sessionCookie;
     this.allBranches = null;
   }
@@ -37,13 +40,13 @@ export class GitlabHelper {
       const projects = await this.gitlabApi.Projects.all({ membership: true });
 
       // print each project with info
-      for (let i = 0; i < projects.length; i++) {
+      for (let project of projects) {
         console.log(
-          projects[i].id.toString(),
+          project.id.toString(),
           '\t',
-          projects[i].name,
+          project.name,
           '\t--\t',
-          projects[i]['description']
+          project['description']
         );
       }
 
@@ -93,8 +96,7 @@ export class GitlabHelper {
    */
   async getAttachment(relurl: string) {
     try {
-      const host = this.host.endsWith('/') ? this.host : this.host + '/';
-      const attachmentUrl = host + this.projectPath + relurl;
+      const attachmentUrl = this.host + '/' + this.projectPath + relurl;
       const data = (
         await axios.get(attachmentUrl, {
           responseType: 'arraybuffer',

src/index.ts

@@ -102,6 +102,7 @@ if (!settings.gitlab.projectId) {
  */
 function createPlaceholderMilestone(expectedIdx: number): MilestoneImport {
   return {
+    id: -1, // dummy
     iid: expectedIdx,
     title: `[PLACEHOLDER] - for milestone #${expectedIdx}`,
     description:
@@ -155,35 +156,30 @@ async function migrate() {
   //
 
   try {
-    let milestoneMap: Map<number, number>;
-
     await githubHelper.registerRepoId();
     await gitlabHelper.registerProjectPath(settings.gitlab.projectId);
 
-    // transfer GitLab milestones to GitHub
     if (settings.transfer.milestones) {
-      milestoneMap = await transferMilestones(
+      await transferMilestones(
         settings.usePlaceholderMilestonesForMissingMilestones
       );
     }
 
-    // transfer GitLab labels to GitHub
     if (settings.transfer.labels) {
       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
+    // Important: do this before transferring the merge requests
     if (settings.transfer.issues) {
       await transferIssues();
     }
+
     if (settings.transfer.mergeRequests) {
       if (settings.mergeRequests.log) {
-        // log merge requests
         await logMergeRequests(settings.mergeRequests.logFile);
       } else {
         await transferMergeRequests();
@@ -299,9 +295,7 @@ async function transferLabels(attachmentLabel = true, useLowerCase = true) {
   // if a GitLab label does not exist in GitHub repo, create it.
   for (let label of labels) {
     // GitHub prefers lowercase label names
-    if (useLowerCase) {
-      label.name = label.name.toLowerCase();
-    }
+    if (useLowerCase) label.name = label.name.toLowerCase();
 
     if (!githubLabels.find(l => l === label.name)) {
       console.log('Creating: ' + label.name);
@@ -536,9 +530,7 @@ 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);
 
   // Sort releases in ascending order of their release date
   releases = releases.sort((a, b) => {
@@ -593,44 +585,40 @@ async function transferReleases() {
 /**
  * logs merge requests that exist in GitLab to a file.
  */
-async function logMergeRequests(logFile) {
+async function logMergeRequests(logFile: string) {
   inform('Logging Merge Requests');
 
   // get a list of all GitLab merge requests associated with this project
   // TODO return all MRs via pagination
-  let mergeRequests = (await gitlabApi.MergeRequests.all({
+  let mergeRequests = await gitlabApi.MergeRequests.all({
     projectId: settings.gitlab.projectId,
     labels: settings.filterByLabel,
-  })) as any;
+  });
 
   // sort MRs in ascending order of when they were created (by id)
   mergeRequests = mergeRequests.sort((a, b) => a.id - b.id);
 
   console.log('Logging ' + mergeRequests.length.toString() + ' merge requests');
 
-  for (let mergeRequest of mergeRequests) {
+  for (let mr of mergeRequests) {
     let mergeRequestDiscussions = await gitlabApi.MergeRequestDiscussions.all(
       settings.gitlab.projectId,
-      mergeRequest.iid
+      mr.iid
     );
     let mergeRequestNotes = await gitlabApi.MergeRequestNotes.all(
       settings.gitlab.projectId,
-      mergeRequest.iid,
+      mr.iid,
       {}
     );
 
-    mergeRequest.discussions = mergeRequestDiscussions
-      ? mergeRequestDiscussions
-      : [];
-    mergeRequest.notes = mergeRequestNotes ? mergeRequestNotes : [];
+    mr.discussions = mergeRequestDiscussions ? mergeRequestDiscussions : [];
+    mr.notes = mergeRequestNotes ? mergeRequestNotes : [];
   }
 
   //
   // Log the merge requests to a file
   //
-  const output = {
-    mergeRequests: mergeRequests,
-  };
+  const output = { mergeRequests: mergeRequests };
 
   fs.writeFileSync(logFile, JSON.stringify(output, null, 2));
 }
@@ -640,7 +628,7 @@ async function logMergeRequests(logFile) {
 /**
  * Print out a section heading to let the user know what is happening
  */
-function inform(msg) {
+function inform(msg: string) {
   console.log('==================================');
   console.log(msg);
   console.log('==================================');

src/settings.ts

@@ -23,7 +23,7 @@ export default interface Settings {
   usePlaceholderIssuesForMissingIssues: boolean;
   useReplacementIssuesForCreationFails: boolean;
   useIssuesForAllMergeRequests: boolean;
-  filterByLabel: string | null;
+  filterByLabel?: string;
   skipMergeRequestStates: string[];
   skipMatchingComments: string[];
   mergeRequests: {

src/utils.ts

@@ -36,7 +36,7 @@ export const generateUserProjectRegex = () => {
 export const migrateAttachments = async (
   body: string,
   githubRepoId: number | undefined,
-  s3: S3Settings,
+  s3: S3Settings | undefined,
   gitlabHelper: GitlabHelper
 ) => {
   const regexp = /(!?)\[([^\]]+)\]\((\/uploads[^)]+)\)/g;
@@ -79,7 +79,7 @@ export const migrateAttachments = async (
         const params: S3.PutObjectRequest = {
           Key: relativePath,
           Body: attachmentBuffer,
-          ContentType: mimeType === false ? null : mimeType,
+          ContentType: mimeType === false ? undefined : mimeType,
           Bucket: s3.bucket,
         };
 
@@ -94,14 +94,18 @@ export const migrateAttachments = async (
       });
 
       // Add the new URL to the map
-      offsetToAttachment[match.index] = `${prefix}[${name}](${s3url})`;
+      offsetToAttachment[
+        match.index as number
+      ] = `${prefix}[${name}](${s3url})`;
     } else {
       // Not using S3: default to old URL, adding absolute path
       const host = gitlabHelper.host.endsWith('/')
         ? gitlabHelper.host
         : gitlabHelper.host + '/';
       const attachmentUrl = host + gitlabHelper.projectPath + url;
-      offsetToAttachment[match.index] = `${prefix}[${name}](${attachmentUrl})`;
+      offsetToAttachment[
+        match.index as number
+      ] = `${prefix}[${name}](${attachmentUrl})`;
     }
   }