v0.2: observe page changes and inject the script before page load (#3)

* script: - add a new metadata @run-at - the script will be injected before page load - Documentation: https://www.tampermonkey.net/documentation.php?locale=en#meta:run_at Signed-off-by: Aolin <[email protected]> * script: add a mark to specify newly added element Signed-off-by: Aolin <[email protected]> * script: (EnsureCommentButton) create comment button only when there is no comment-button element Signed-off-by: Aolin <[email protected]> * script: (EnsureFileLink) - rename from CreateFileLink to EnsureFileLink - add File element only when there is no file-link-span element Signed-off-by: Aolin <[email protected]> * script: (Init) trigger EnsureFileLink and EnsureCommentButton when observing page changes Signed-off-by: Aolin <[email protected]> * script: publish version v0.2 Signed-off-by: Aolin <[email protected]> --------- Signed-off-by: Aolin <[email protected]>
Oreoxmt · Feb 9, 2023 · e7df2f8 · e7df2f8
1 parent 5d34e1d
commit e7df2f8
Showing 1 changed file with 54 additions and 32 deletions.
diff --git a/gh-util.user.js b/gh-util.user.js
@@ -1,16 +1,18 @@
 // ==UserScript==
 // @name         Octopus GitHub
-// @version      0.1
+// @version      0.2
 // @description  A userscript for GitHub
 // @author       Oreo
 // @match        https://github.com/*/pulls*
 // @grant        none
+// @run-at       document-start
 // ==/UserScript==
 
 (function () {
 
     'use strict';
 
+    const ATTR = 'octopus-github-util-mark'
     const STORAGEKEY = 'octopus-github-util:token'
 
     function GetRepositoryInformation() {
@@ -63,14 +65,19 @@
     }
 
     // TODO: Use toggle instead of button, and add more features to the toggle, e.g., editing tokens.
-    function CreateCommentButton() {
+    function EnsureCommentButton() {
+        const MARK = 'comment-button'
+        if (document.querySelector(`button[${ATTR}="${MARK}"]`)) {
+            return;
+        }
         // First, find the "table-list-header-toggle" div
         var toggleDiv = document.querySelector('.table-list-header-toggle.float-right');
 
         // Next, create a button element and add it to the page
         var button = document.createElement('button');
         button.innerHTML = 'Comment';
         button.setAttribute('class', 'btn btn-sm js-details-target d-inline-block float-left float-none m-0 mr-md-0 js-title-edit-button')
+        button.setAttribute(ATTR, MARK)
         toggleDiv.appendChild(button);
 
         // Next, add an event listener to the button to listen for clicks
@@ -105,38 +112,53 @@
         });
     }
 
-    function CreateFileLink() {
-
-        // Get all div elements with an id that starts with "issue_"
-        var issueElements = document.querySelectorAll('div[id^="issue_"]');
-        issueElements.forEach((element) => {
-            var issueId = element.getAttribute("id")
-            var originalLinkElement = document.getElementById(issueId + "_link")
-            var originalLink = originalLinkElement.getAttribute("href")
-            var newLink = originalLink + "/files"
-            // Get all span elements within the current element
-            var spanElements = element.querySelectorAll('span[class="opened-by"]');
-            if (spanElements.length == 1) {
-                var openedBy = spanElements[0];
-                var linkSpanElement = document.createElement('span');
-                linkSpanElement.setAttribute('class', 'd-inline-block mr-1')
-                var dotSpanElement = document.createElement('span');
-                dotSpanElement.innerHTML = ' • ';
-                dotSpanElement.setAttribute('class', 'd-inline-block mr-1')
-                var linkElement = document.createElement('a')
-                linkElement.setAttribute('href', newLink)
-                linkElement.setAttribute('class', 'Link--muted')
-                linkElement.innerHTML = "Files"
-                linkSpanElement.appendChild(linkElement)
-                openedBy.insertAdjacentElement('beforebegin', linkSpanElement)
-                openedBy.insertAdjacentElement('beforebegin', dotSpanElement);
-            }
-        })
+    function EnsureFileLink(issueElement) {
+        const MARK = 'file-link-span'
+
+        if (issueElement.querySelector(`span[${ATTR}="${MARK}"]`)) {
+            return; // Already added
+        }
+
+        var issueId = issueElement.getAttribute("id")
+        var originalLinkElement = document.getElementById(issueId + "_link")
+        if (!originalLinkElement) {
+            return; // Element is not ready
+        }
 
+        var originalLink = originalLinkElement.getAttribute("href")
+        var newLink = originalLink + "/files"
+
+        var openedByElement = issueElement.querySelectorAll('span[class="opened-by"]');
+        if (openedByElement.length == 1) {
+            var openedBy = openedByElement[0];
+            var linkSpanElement = document.createElement('span');
+            linkSpanElement.setAttribute('class', 'd-inline-block mr-1 custom')
+            linkSpanElement.setAttribute(ATTR, MARK)
+            var dotSpanElement = document.createElement('span');
+            dotSpanElement.innerHTML = ' • ';
+            dotSpanElement.setAttribute('class', 'd-inline-block mr-1 custom')
+            var linkElement = document.createElement('a')
+            linkElement.setAttribute('href', newLink)
+            linkElement.setAttribute('class', 'Link--muted')
+            linkElement.innerHTML = "Files"
+            linkSpanElement.appendChild(linkElement)
+            openedBy.insertAdjacentElement('beforebegin', linkSpanElement)
+            openedBy.insertAdjacentElement('beforebegin', dotSpanElement);
+        }
+    }
+
+    function Init() {
+
+        const observer = new MutationObserver(() => {
+            document.querySelectorAll('div[id^="issue_"]').forEach((element) => {
+                EnsureFileLink(element);
+            })
+            EnsureCommentButton();
+        });
+        const config = { childList: true, subtree: true };
+        observer.observe(document, config);
     }
 
-    // TODO: Do this everytime on switching to new page
-    CreateCommentButton();
-    CreateFileLink();
+    Init();
 
 })();