[Feature] Show icons in releases page. (#98)

* added back scripting permission * github releases now have icons * gitea releases now have icons * gitlab releases now have icons * gitee releases now have icons * removed console.log call * added underscores to all intentional unused function parameters in transformFileName functions --------- Co-authored-by: Philipp Kief <[email protected]>
material-extensions · Jul 9, 2024 · 12ce1eb · 12ce1eb
1 parent d8b1116
commit 12ce1eb
Show file tree

Hide file tree

Showing 10 changed files with 152 additions and 21 deletions.
diff --git a/src/injected-styles.css b/src/injected-styles.css
@@ -20,3 +20,16 @@ img[data-material-icons-extension='icon'] + svg.octicon-file-directory-open-fill
 img[data-material-icons-extension='icon'] + svg.octicon-file-directory-fill {
   display: none !important;
 }
+
+/* github package icon spacing fix */
+.octicon-package[data-material-icons-extension] {
+  margin-right: 5px;
+}
+.octicon-file-zip[data-material-icons-extension] {
+  margin-right: 5px;
+}
+
+.releases-download-list .item a {
+  display: flex;
+  align-items: center;
+}
diff --git a/src/lib/replace-icon.ts b/src/lib/replace-icon.ts
@@ -26,22 +26,28 @@ export function replaceIconInRow(
   provider: Provider,
   iconPack: string | null
 ): void {
-  const fileName = itemRow
+  let fileName = itemRow
     .querySelector(provider.selectors.filename)
-    ?.textContent// get the last folder for the icon
+    ?.textContent // get the last folder for the icon
     ?.split('/')
     .reverse()[0]
-    .trim()
-    // remove possible sha from submodule
-    // matches 4 or more to future proof in case they decide to increase it.
-    .replace(/\s+@\s+[a-fA-F0-9]{4,}$/, '');
+    // when using textContent, it can add multiple types of whitespace,
+    // using regex to replace them with a single space,
+    // can be used later to transform the filename
+    .replace(/\s+/g, ' ')
+    .trim();
   if (!fileName) return;
 
   const iconEl = itemRow.querySelector(
     provider.selectors.icon
   ) as HTMLElement | null;
   if (iconEl?.getAttribute('data-material-icons-extension')) return;
-  if (iconEl) replaceIcon(iconEl, fileName, itemRow, provider, iconPack);
+
+  if (!iconEl) return;
+
+  fileName = provider.transformFileName(itemRow, iconEl, fileName);
+
+  replaceIcon(iconEl, fileName, itemRow, provider, iconPack);
 }
 
 function replaceIcon(

diff --git a/src/models/provider.ts b/src/models/provider.ts
@@ -15,4 +15,9 @@ export interface Provider {
   getIsSymlink: (params: { row: HTMLElement; icon: HTMLElement }) => boolean;
   getIsLightTheme: () => boolean;
   replaceIcon: (oldIcon: HTMLElement, newIcon: HTMLElement) => void;
+  transformFileName: (
+    rowEl: HTMLElement,
+    iconEl: HTMLElement,
+    fileName: string
+  ) => string;
 }
diff --git a/src/providers/azure.ts b/src/providers/azure.ts
@@ -78,5 +78,12 @@ export default function azure(): Provider {
         subtree: true,
       });
     },
+    transformFileName: (
+      _rowEl: HTMLElement,
+      _iconEl: HTMLElement,
+      fileName: string
+    ): string => {
+      return fileName;
+    },
   };
 }
diff --git a/src/providers/bitbucket.ts b/src/providers/bitbucket.ts
@@ -46,5 +46,12 @@ export default function bitbucket(): Provider {
       svgEl.parentNode?.replaceChild(newSVG, svgEl);
     },
     onAdd: () => {},
+    transformFileName: (
+      _rowEl: HTMLElement,
+      _iconEl: HTMLElement,
+      fileName: string
+    ): string => {
+      return fileName;
+    },
   };
 }
diff --git a/src/providers/gitea.ts b/src/providers/gitea.ts
@@ -10,9 +10,10 @@ export default function gitea(): Provider {
       },
     ],
     selectors: {
-      row: 'tr.ready.entry',
-      filename: 'td.name.four.wide > span.truncate > a',
-      icon: 'td.name.four.wide > span.truncate > svg',
+      row: 'tr.ready.entry, details.download ul.list li',
+      filename:
+        'td.name.four.wide > span.truncate > a, a[download] strong, a.archive-link strong',
+      icon: 'td.name.four.wide > span.truncate > svg, .octicon-package, .octicon-file-zip',
       // Element by which to detect if the tested domain is gitea.
       detect: 'body > .full.height > .page-content[role=main]',
     },
@@ -38,5 +39,20 @@ export default function gitea(): Provider {
       svgEl.parentNode?.replaceChild(newSVG, svgEl);
     },
     onAdd: () => {},
+    transformFileName: (
+      rowEl: HTMLElement,
+      _iconEl: HTMLElement,
+      fileName: string
+    ): string => {
+      // try to match the 'Source code (zip)' type of rows in releases page in github.
+      if (
+        rowEl.querySelector('.archive-link') &&
+        fileName.includes('Source code')
+      ) {
+        return fileName.replace(/\s+\((.*?)\)$/, '.$1');
+      }
+
+      return fileName;
+    },
   };
 }
diff --git a/src/providers/gitee.ts b/src/providers/gitee.ts
@@ -11,12 +11,17 @@ export default function gitee(): Provider {
     ],
     selectors: {
       // File list row, README header, file view header
-      row: '#git-project-content .tree-content .row.tree-item, .file_title, .blob-description',
+      row: `#git-project-content .tree-content .row.tree-item,
+        .file_title,
+        .blob-description,
+        .release-body .releases-download-list .item`,
       // File name table cell, Submodule name table cell, file view header
-      filename:
-        '.tree-list-item > a, .tree-item-submodule-name a, span.file_name',
+      filename: `.tree-list-item > a,
+        .tree-item-submodule-name a,
+        span.file_name,
+        a`,
       // The iconfont icon not including the delete button icon in the file view header
-      icon: 'i.iconfont:not(.icon-delete)',
+      icon: 'i.iconfont:not(.icon-delete), i.icon',
       // Element by which to detect if the tested domain is gitee.
       detect: null,
     },
@@ -42,5 +47,20 @@ export default function gitee(): Provider {
       svgEl.parentNode?.replaceChild(newSVG, svgEl);
     },
     onAdd: () => {},
+    transformFileName: (
+      rowEl: HTMLElement,
+      _iconEl: HTMLElement,
+      fileName: string
+    ): string => {
+      // try to match the 'Source code (zip)' type of rows in releases page in github.
+      if (
+        rowEl.classList.contains('item') &&
+        fileName.includes('Source code')
+      ) {
+        return fileName.replace(/\s+\((.*?)\)$/, '.$1');
+      }
+
+      return fileName;
+    },
   };
 }
diff --git a/src/providers/github.ts b/src/providers/github.ts
@@ -14,17 +14,21 @@ export default function github(): Provider {
         file-tree .ActionList-content,
         a.tree-browser-result,
         .PRIVATE_TreeView-item-content,
-        .react-directory-filename-column`,
+        .react-directory-filename-column,
+        .Box details .Box-row`,
       filename: `div[role="rowheader"] > span,
         .ActionList-item-label,
         a.tree-browser-result > marked-text,
         .PRIVATE_TreeView-item-content > .PRIVATE_TreeView-item-content-text,
-        .react-directory-filename-column a`,
+        .react-directory-filename-column a,
+        a.Truncate`,
       icon: `.octicon-file,
         .octicon-file-directory-fill,
         .octicon-file-directory-open-fill,
         .octicon-file-submodule,
-        .react-directory-filename-column > svg`,
+        .react-directory-filename-column > svg,
+        .octicon-package,
+        .octicon-file-zip`,
       // Element by which to detect if the tested domain is github.
       detect: 'body > div[data-turbo-body]',
     },
@@ -82,5 +86,26 @@ export default function github(): Provider {
       }
     },
     onAdd: () => {},
+    transformFileName: (
+      rowEl: HTMLElement,
+      _iconEl: HTMLElement,
+      fileName: string
+    ): string => {
+      // remove possible sha from submodule
+      // matches 4 or more to future proof in case they decide to increase it.
+      if (fileName.includes('@')) {
+        return fileName.replace(/\s+@\s+[a-fA-F0-9]{4,}$/, '');
+      }
+
+      // try to match the 'Source code (zip)' type of rows in releases page in github.
+      if (
+        rowEl.classList.contains('Box-row') &&
+        fileName.includes('Source code')
+      ) {
+        return fileName.replace(/\s+\((.*?)\)$/, '.$1');
+      }
+
+      return fileName;
+    },
   };
 }
diff --git a/src/providers/gitlab.ts b/src/providers/gitlab.ts
@@ -11,12 +11,20 @@ export default function gitlab(): Provider {
     ],
     selectors: {
       // Row in file list, file view header
-      row: 'table[data-testid="file-tree-table"].table.tree-table tr.tree-item, table[data-qa-selector="file_tree_table"] tr, .file-header-content',
+      row: `table[data-testid="file-tree-table"].table.tree-table tr.tree-item,
+         table[data-qa-selector="file_tree_table"] tr,
+         .file-header-content,
+         .gl-card[data-testid="release-block"] .js-assets-list ul li`,
       // Cell in file list, file view header, readme header
-      filename:
-        'td.tree-item-file-name .tree-item-link, td.tree-item-file-name, .file-header-content .file-title-name, .file-header-content .gl-link',
+      filename: `td.tree-item-file-name .tree-item-link,
+        td.tree-item-file-name,
+        .file-header-content .file-title-name,
+        .file-header-content .gl-link,
+        .gl-link`,
       // Any icon not contained in a button
-      icon: 'td.tree-item-file-name .tree-item-link svg, .tree-item svg, .file-header-content svg:not(.gl-button-icon)',
+      icon: `td.tree-item-file-name .tree-item-link svg,
+        .tree-item svg, .file-header-content svg:not(.gl-button-icon),
+        .gl-link svg.gl-icon[data-testid="doc-code-icon"]`,
       // Element by which to detect if the tested domain is gitlab.
       detect: 'body.page-initialized[data-page]',
     },
@@ -46,5 +54,22 @@ export default function gitlab(): Provider {
       svgEl.parentNode?.replaceChild(newSVG, svgEl);
     },
     onAdd: () => {},
+    transformFileName: (
+      rowEl: HTMLElement,
+      _iconEl: HTMLElement,
+      fileName: string
+    ): string => {
+      // try to match the 'Source code (zip)' type of rows in releases page in github.
+      if (
+        rowEl.parentElement?.parentElement?.classList.contains(
+          'js-assets-list'
+        ) &&
+        fileName.includes('Source code')
+      ) {
+        return fileName.replace(/\s+\((.*?)\)$/, '.$1');
+      }
+
+      return fileName;
+    },
   };
 }
diff --git a/src/providers/sourceforge.ts b/src/providers/sourceforge.ts
@@ -70,5 +70,12 @@ export default function sourceforge(): Provider {
       }
     },
     onAdd: () => {},
+    transformFileName: (
+      _rowEl: HTMLElement,
+      _iconEl: HTMLElement,
+      fileName: string
+    ): string => {
+      return fileName;
+    },
   };
 }