From 417a3ac474a696134b60e215b8830282d623574c Mon Sep 17 00:00:00 2001
From: Rich Trott <rtrott@gmail.com>
Date: Fri, 20 Aug 2021 17:54:28 -0700
Subject: [PATCH] tools: use find-inactive-collaborators to modify README.md

Update find-inactive-collaborators to move inactive collaborators to the
emeriti section of README.md.

PR-URL: https://github.com/nodejs/node/pull/39825
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
---
 README.md                             |  7 +++
 tools/find-inactive-collaborators.mjs | 87 ++++++++++++++++++++++++++-
 2 files changed, 92 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7307e6ad89cef7..74a31d75d60f02 100644
--- a/README.md
+++ b/README.md
@@ -152,6 +152,8 @@ For information on reporting security vulnerabilities in Node.js, see
 For information about the governance of the Node.js project, see
 [GOVERNANCE.md](./GOVERNANCE.md).
 
+<!-- node-core-utils depends on the format of the TSC list. If the
+     format changes, those utilities need to be tested and updated. -->
 ### TSC (Technical Steering Committee)
 
 <!--lint disable prohibited-strings-->
@@ -249,6 +251,9 @@ For information about the governance of the Node.js project, see
 
 </details>
 
+<!-- node-core-utils and find-inactive-collaborators.mjs depend on the format
+     of the collaborator list. If the format changes, those utilities need to be
+     tested and updated. -->
 ### Collaborators
 
 * [addaleax](https://github.com/addaleax) -
@@ -462,6 +467,8 @@ For information about the governance of the Node.js project, see
 
 <summary>Emeriti</summary>
 
+<!-- find-inactive-collaborators.mjs depends on the format of the emeriti list.
+     If the format changes, those utilities need to be tested and updated. -->
 ### Collaborator emeriti
 
 * [andrasq](https://github.com/andrasq) -
diff --git a/tools/find-inactive-collaborators.mjs b/tools/find-inactive-collaborators.mjs
index 0d89d2869cf4f7..9f7ac239d2df01 100755
--- a/tools/find-inactive-collaborators.mjs
+++ b/tools/find-inactive-collaborators.mjs
@@ -100,6 +100,85 @@ async function getCollaboratorsFromReadme() {
   return returnedArray;
 }
 
+async function moveCollaboratorToEmeritus(peopleToMove) {
+  const readmeText = readline.createInterface({
+    input: fs.createReadStream(new URL('../README.md', import.meta.url)),
+    crlfDelay: Infinity,
+  });
+  let fileContents = '';
+  let inCollaboratorsSection = false;
+  let inCollaboratorEmeritusSection = false;
+  let collaboratorFirstLine = '';
+  const textToMove = [];
+  for await (const line of readmeText) {
+    // If we've been processing collaborator emeriti and we reach the end of
+    // the list, print out the remaining entries to be moved because they come
+    // alphabetically after the last item.
+    if (inCollaboratorEmeritusSection && line === '' &&
+        fileContents.endsWith('&gt;\n')) {
+      while (textToMove.length) {
+        fileContents += textToMove.pop();
+      }
+    }
+
+    // If we've found the collaborator heading already, stop processing at the
+    // next heading.
+    if (line.startsWith('#')) {
+      inCollaboratorsSection = false;
+      inCollaboratorEmeritusSection = false;
+    }
+
+    const isCollaborator = inCollaboratorsSection && line.length;
+    const isCollaboratorEmeritus = inCollaboratorEmeritusSection && line.length;
+
+    if (line === '### Collaborators') {
+      inCollaboratorsSection = true;
+    }
+    if (line === '### Collaborator emeriti') {
+      inCollaboratorEmeritusSection = true;
+    }
+
+    if (isCollaborator) {
+      if (line.startsWith('* ')) {
+        collaboratorFirstLine = line;
+      } else if (line.startsWith('**')) {
+        const [, name, email] = /^\*\*([^*]+)\*\* &lt;(.+)&gt;/.exec(line);
+        if (peopleToMove.some((entry) => {
+          return entry.name === name && entry.email === email;
+        })) {
+          textToMove.push(`${collaboratorFirstLine}\n${line}\n`);
+        } else {
+          fileContents += `${collaboratorFirstLine}\n${line}\n`;
+        }
+      } else {
+        fileContents += `${line}\n`;
+      }
+    }
+
+    if (isCollaboratorEmeritus) {
+      if (line.startsWith('* ')) {
+        collaboratorFirstLine = line;
+      } else if (line.startsWith('**')) {
+        const currentLine = `${collaboratorFirstLine}\n${line}\n`;
+        // If textToMove is empty, this still works because when undefined is
+        // used in a comparison with <, the result is always false.
+        while (textToMove[0] < currentLine) {
+          fileContents += textToMove.shift();
+        }
+        fileContents += currentLine;
+      } else {
+        fileContents += `${line}\n`;
+      }
+    }
+
+    if (!isCollaborator && !isCollaboratorEmeritus) {
+      fileContents += `${line}\n`;
+    }
+  }
+
+  return fileContents;
+}
+
 // Get list of current collaborators from README.md.
 const collaborators = await getCollaboratorsFromReadme();
 
@@ -113,9 +192,13 @@ const inactive = collaborators.filter((collaborator) =>
   !authors.has(collaborator.mailmap) &&
   !landers.has(collaborator.mailmap) &&
   !approvingReviewers.has(collaborator.name)
-).map((collaborator) => collaborator.name);
+);
 
 if (inactive.length) {
   console.log('\nInactive collaborators:\n');
-  console.log(inactive.map((name) => `* ${name}`).join('\n'));
+  console.log(inactive.map((entry) => `* ${entry.name}`).join('\n'));
+  console.log('\nGenerating new README.md file...');
+  const newReadmeText = await moveCollaboratorToEmeritus(inactive);
+  fs.writeFileSync(new URL('../README.md', import.meta.url), newReadmeText);
+  console.log('Updated README.md generated. Please commit these changes.');
 }