chore: convert various files from JS to TS (#1959)

1 files changed, 63 insertions, 0 deletions

diff --git a/scripts/link-readme.ts b/scripts/link-readme.ts
new file mode 100644
index 000000000..77b384ff4
--- /dev/null
+++ b/scripts/link-readme.ts
@@ -0,0 +1,63 @@
+/**
+ * Script that automatically creates links to issues and users inside README.md
+ *
+ * e.g. "#123" => "[#123](https://github.com/getferdi/ferdi/issues/123)"
+ * and  "franz/#123" => "[franz#123](https://github.com/meetfranz/franz/issues/123)"
+ * and "@abc" => "[@abc](https://github.com/abc)"
+ */
+
+import fs from 'fs-extra';
+import path from 'path';
+
+console.log('Linking issues and PRs in README.md');
+
+const readmepath = path.join(__dirname, '..', 'README.md');
+
+// Read README.md
+let readme = fs.readFileSync(readmepath, 'utf-8');
+
+let replacements = 0;
+
+// Replace Franz issues
+// Regex matches strings that don't begin with a "[", i.e. are not already linked
+// followed by a "franz#" and digits to indicate
+// a GitHub issue, and not ending with a "]"
+readme = readme.replace(/(?<!\[)franz#\d+(?![\d\]])/gi, match => {
+  const issueNr = match.replace('franz#', '');
+  replacements += 1;
+  return `[franz#${issueNr}](https://github.com/meetfranz/franz/issues/${issueNr})`;
+});
+
+// Replace external issues
+// Regex matches strings that don't begin with a "[", followed a repo name in the format "user/repo"
+// followed by a "#" and digits to indicate a GitHub issue, and not ending with a "]"
+readme = readme.replace(/(?<!\[)\w+\/\w+#\d+(?![\d\]])/gi, match => {
+  const issueNr = match.replace(/\D/g, '');
+  const repo = match.replace(/#\d+/g, '');
+  replacements += 1;
+  return `[${repo}#${issueNr}](https://github.com/${repo}/issues/${issueNr})`;
+});
+
+// Replace Ferdi issues
+// Regex matches strings that don't begin with a "[", i.e. are not already linked and
+// don't begin with "franz", i.e. are not Franz issues, followed by a "#" and digits to indicate
+// a GitHub issue, and not ending with a "]"
+readme = readme.replace(/(?<!\[|franz)#\d+(?![\d\]])/gi, match => {
+  const issueNr = match.replace('#', '');
+  replacements += 1;
+  return `[#${issueNr}](https://github.com/getferdi/ferdi/issues/${issueNr})`;
+});
+
+// Link GitHub users
+// Regex matches strings that don't begin with a "[", i.e. are not already linked
+// followed by a "@" and at least one word character and not ending with a "]"
+readme = readme.replace(/(?<!\[)@\w+(?!])/gi, match => {
+  const username = match.replace('@', '');
+  replacements += 1;
+  return `[@${username}](https://github.com/${username})`;
+});
+
+// Write to file
+fs.writeFileSync(readmepath, readme);
+
+console.log(`Added ${replacements} strings`);