Add option to save a list of users

Author: kinow

README.md

@@ -190,6 +190,12 @@ and add them to github in chronological order, but it would not preserve the ori
 
 As default it is set to false. Doesn't fire the requests to github api and only does the work on the gitlab side to test for wonky cases before using up api-calls
 
+### exportUsers
+
+If this is set to true (default is false) then a file called "users.txt" wil be created containing all
+usernames that contributed to the repository. You can use this with dryRun when you need to map users
+for the migration, but you do not know all the source usernames.
+
 ### useIssueImportAPI
 
 Set to true (default) to enable using the [GitHub preview API for importing issues](https://gist.github.com/jonmagic/5282384165e0f86ef105). This allows setting the date for issues and comments instead of inserting an additional line in the body.

sample_settings.ts

@@ -44,6 +44,7 @@ export default {
     releases: true,
   },
   dryRun: false,
+  exportUsers: false,
   useIssueImportAPI: true,
   usePlaceholderMilestonesForMissingMilestones: true,
   usePlaceholderIssuesForMissingIssues: true,

src/githubHelper.ts

@@ -21,6 +21,9 @@ type GitHubPullRequest = PullsListResponseData[0];
 
 const gitHubLocation = 'https://github.com';
 
+// Source for regex: https://stackoverflow.com/a/30281147
+const usernameRegex = new RegExp('\\B@([a-z0-9](?:-(?=[a-z0-9])|[a-z0-9]){0,38}(?<=[a-z0-9]))', 'gi')
+
 interface CommentImport {
   created_at?: string;
   body: string;
@@ -71,6 +74,7 @@ export class GithubHelper {
   delayInMs: number;
   useIssuesForAllMergeRequests: boolean;
   milestoneMap?: Map<number, SimpleMilestone>;
+  users: Set<string>;
 
   constructor(
     githubApi: GitHubApi,
@@ -91,6 +95,7 @@ export class GithubHelper {
     this.gitlabHelper = gitlabHelper;
     this.delayInMs = 2000;
     this.useIssuesForAllMergeRequests = useIssuesForAllMergeRequests;
+    this.users = new Set<string>();
   }
 
   /*
@@ -305,6 +310,7 @@ export class GithubHelper {
    ******************************************************************************
    */
   userIsCreator(author: GitLabUser) {
+    this.users.add(author.username as string);
     return (
       author &&
       ((settings.usermap &&
@@ -366,6 +372,7 @@ export class GithubHelper {
     let assignees: string[] = [];
     for (let assignee of item.assignees) {
       let username: string = assignee.username as string;
+      this.users.add(username);
       if (username === settings.github.username) {
         assignees.push(settings.github.username);
       } else if (settings.usermap && settings.usermap[username]) {
@@ -516,6 +523,7 @@ export class GithubHelper {
     for (let note of notes) {
       if (this.checkIfNoteCanBeSkipped(note.body)) continue;
 
+      this.users.add(note.author.username);
       let userIsPoster =
         (settings.usermap &&
           settings.usermap[note.author.username] ===
@@ -1167,6 +1175,14 @@ export class GithubHelper {
       );
     }
 
+    // Store usernames found in the text
+    const matches: Array<string> = str.match(usernameRegex);
+    if (matches && matches.length > 0) {
+      for (const username of matches) {
+        this.users.add(username.substring(1));
+      }
+    }
+
     //
     // Issue reference conversion
     //

src/index.ts

@@ -224,6 +224,11 @@ async function migrate() {
         await transferMergeRequests();
       }
     }
+
+    if (settings.exportUsers) {
+      const users = Array.from(githubHelper.users.values()).join("\n");
+      fs.writeFileSync('users.txt', users);
+    }
   } catch (err) {
     console.error('Error during transfer:');
     console.error(err);

src/settings.ts

@@ -1,5 +1,6 @@
 export default interface Settings {
   dryRun: boolean;
+  exportUsers: boolean;
   gitlab: GitlabSettings;
   github: GithubSettings;
   usermap: {