mirror of
https://github.com/GetOpenScript/GitHub.openscript.git
synced 2026-09-18 08:25:42 +00:00
Move size to About section, add Git Trees fallback for 0KB repos, and enhance GH_PAT secret retrieval
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
// ==UserScript==
|
||||
// @name Display Repo Size for GitHub
|
||||
// @version 1.0.0
|
||||
// @description Displays the total repository size on GitHub repository pages (supports public & private repos via GH_PAT).
|
||||
// @version 1.1.0
|
||||
// @description Displays repository size inside the About section on GitHub (supports public & private repos using GH_PAT).
|
||||
// @author OpenScript
|
||||
// @match https://github.com/*/*
|
||||
// @grant none
|
||||
@@ -11,86 +11,132 @@
|
||||
'use strict';
|
||||
|
||||
const cache = new Map();
|
||||
const BADGE_ID = 'openscript-repo-size';
|
||||
const ROW_ID = 'openscript-repo-size-about';
|
||||
|
||||
// Format KB to readable size
|
||||
const formatBytes = kb => {
|
||||
if (kb < 1024) return `${kb} KB`;
|
||||
// Format bytes to human readable format
|
||||
const formatSize = bytes => {
|
||||
const kb = bytes / 1024;
|
||||
if (kb < 1024) return `${kb.toFixed(1)} KB`;
|
||||
if (kb < 1024 * 1024) return `${(kb / 1024).toFixed(1)} MB`;
|
||||
return `${(kb / (1024 * 1024)).toFixed(2)} GB`;
|
||||
};
|
||||
|
||||
// Parse owner & repo from path
|
||||
// Extract owner & repo
|
||||
const getRepoInfo = () => {
|
||||
const [, owner, repo] = location.pathname.split('/');
|
||||
const reserved = new Set(['settings', 'orgs', 'organizations', 'notifications', 'search', 'features', 'pricing', 'explore']);
|
||||
const reserved = new Set(['settings', 'orgs', 'organizations', 'notifications', 'search', 'features', 'pricing', 'explore', 'marketplace']);
|
||||
return (owner && repo && !reserved.has(owner)) ? { owner, repo } : null;
|
||||
};
|
||||
|
||||
// Fetch size from GitHub API with optional GH_PAT
|
||||
// Safely retrieve GH_PAT from OpenScript environment
|
||||
const getPat = () => {
|
||||
const secrets = (typeof OpenScript !== 'undefined' ? OpenScript?.env : null) ||
|
||||
(typeof env !== 'undefined' ? env : null) ||
|
||||
window.OpenScript?.env ||
|
||||
window.env ||
|
||||
{};
|
||||
return secrets.GH_PAT || secrets.gh_pat || secrets.GITHUB_PAT || secrets.GITHUB_TOKEN || null;
|
||||
};
|
||||
|
||||
// Fetch repository size from GitHub API (with fallback to recursive Git Trees API when size is 0)
|
||||
const fetchRepoSize = async (owner, repo) => {
|
||||
const key = `${owner}/${repo}`;
|
||||
if (cache.has(key)) return cache.get(key);
|
||||
|
||||
const token = window.OpenScript?.env?.GH_PAT || window.env?.GH_PAT;
|
||||
const pat = getPat();
|
||||
const headers = { Accept: 'application/vnd.github.v3+json' };
|
||||
if (token) headers.Authorization = `Bearer ${token}`;
|
||||
if (pat) headers.Authorization = `Bearer ${pat.trim()}`;
|
||||
|
||||
try {
|
||||
const res = await fetch(`https://api.github.com/repos/${owner}/${repo}`, { headers });
|
||||
if (!res.ok) return res.status === 404 ? 'private/missing GH_PAT' : 'error';
|
||||
if (!res.ok) {
|
||||
if (res.status === 404) return pat ? 'repo not found' : 'private (set GH_PAT)';
|
||||
if (res.status === 401) return 'invalid GH_PAT';
|
||||
return `API error (${res.status})`;
|
||||
}
|
||||
|
||||
const data = await res.json();
|
||||
const formatted = formatBytes(data.size);
|
||||
let bytes = (data.size || 0) * 1024;
|
||||
|
||||
// GitHub async calculation fallback: if size is 0, sum blob sizes via Git Trees API
|
||||
if (bytes <= 0) {
|
||||
const branch = data.default_branch || 'main';
|
||||
const treeRes = await fetch(`https://api.github.com/repos/${owner}/${repo}/git/trees/${branch}?recursive=1`, { headers });
|
||||
if (treeRes.ok) {
|
||||
const treeData = await treeRes.json();
|
||||
bytes = (treeData.tree || []).reduce((acc, item) => acc + (item.size || 0), 0);
|
||||
}
|
||||
}
|
||||
|
||||
const formatted = formatSize(bytes);
|
||||
cache.set(key, formatted);
|
||||
return formatted;
|
||||
} catch {
|
||||
return null;
|
||||
return 'failed to load';
|
||||
}
|
||||
};
|
||||
|
||||
// Inject or update size badge
|
||||
const updateBadge = async () => {
|
||||
// Find the GitHub "About" section in sidebar
|
||||
const findAboutContainer = () => {
|
||||
// Priority 1: First BorderGrid-cell containing About header or in right sidebar
|
||||
const cells = document.querySelectorAll('.Layout-sidebar .BorderGrid-cell, .BorderGrid-cell');
|
||||
for (const cell of cells) {
|
||||
const h2 = cell.querySelector('h2');
|
||||
if (h2 && /About/i.test(h2.textContent)) return cell;
|
||||
}
|
||||
|
||||
// Priority 2: Standard first cell in sidebar
|
||||
return document.querySelector('.Layout-sidebar .BorderGrid-row:first-child .BorderGrid-cell') ||
|
||||
document.querySelector('[data-testid="about-section"]') ||
|
||||
document.querySelector('.Layout-sidebar section');
|
||||
};
|
||||
|
||||
// Render or update the size element inside the About section
|
||||
const updateAboutSize = async () => {
|
||||
const info = getRepoInfo();
|
||||
if (!info) return;
|
||||
|
||||
// Anchor locations on GitHub repo pages
|
||||
const anchor = document.querySelector('.file-navigation') ||
|
||||
document.querySelector('[data-testid="latest-commit-details"]') ||
|
||||
document.querySelector('.BorderGrid-cell .d-flex') ||
|
||||
document.querySelector('#repository-container-header ul');
|
||||
// Clean up any old top badge if present
|
||||
document.getElementById('openscript-repo-size')?.remove();
|
||||
|
||||
if (!anchor || document.getElementById(BADGE_ID)) return;
|
||||
const container = findAboutContainer();
|
||||
if (!container || document.getElementById(ROW_ID)) return;
|
||||
|
||||
const badge = document.createElement('div');
|
||||
badge.id = BADGE_ID;
|
||||
badge.className = 'd-inline-flex flex-items-center mr-2 px-2 py-1 text-bold text-small rounded-2 border color-border-default color-bg-subtle';
|
||||
badge.style.cssText = 'align-self: center; font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif;';
|
||||
badge.innerHTML = `
|
||||
<svg aria-hidden="true" height="14" viewBox="0 0 16 16" width="14" class="octicon octicon-database mr-1 color-fg-muted" fill="currentColor">
|
||||
const row = document.createElement('div');
|
||||
row.id = ROW_ID;
|
||||
row.className = 'mt-2 text-small color-fg-muted d-flex flex-items-center';
|
||||
row.innerHTML = `
|
||||
<svg aria-hidden="true" height="16" viewBox="0 0 16 16" width="16" class="octicon octicon-database mr-2 color-fg-muted" fill="currentColor">
|
||||
<path d="M1 3.5c0-.83.67-1.5 1.5-1.5h11c.83 0 1.5.67 1.5 1.5v9c0 .83-.67 1.5-1.5 1.5h-11A1.5 1.5 0 0 1 1 12.5v-9Zm1.5-.5a.5.5 0 0 0-.5.5V5h12V3.5a.5.5 0 0 0-.5-.5h-11ZM14 6H2v2h12V6Zm0 3H2v3.5a.5.5 0 0 0 .5.5h11a.5.5 0 0 0 .5-.5V9Z"></path>
|
||||
</svg>
|
||||
<span class="size-text color-fg-default">calculating...</span>
|
||||
<span><strong class="size-val color-fg-default font-semibold">calculating...</strong> repo size</span>
|
||||
`;
|
||||
|
||||
anchor.prepend(badge);
|
||||
// Insert after description / before bottom stats
|
||||
const heading = container.querySelector('h2');
|
||||
if (heading && heading.nextElementSibling) {
|
||||
heading.parentNode.insertBefore(row, heading.nextElementSibling.nextElementSibling || heading.nextElementSibling);
|
||||
} else {
|
||||
container.appendChild(row);
|
||||
}
|
||||
|
||||
const size = await fetchRepoSize(info.owner, info.repo);
|
||||
const sizeSpan = badge.querySelector('.size-text');
|
||||
if (sizeSpan) sizeSpan.textContent = size ? size : 'unknown';
|
||||
const valEl = row.querySelector('.size-val');
|
||||
if (valEl) valEl.textContent = size;
|
||||
};
|
||||
|
||||
// Re-run on Turbo navigation & DOM mutations
|
||||
['turbo:load', 'turbo:render', 'pjax:end', 'popstate'].forEach(ev =>
|
||||
// Listen to GitHub SPA navigation events
|
||||
['turbo:load', 'turbo:render', 'pjax:end', 'popstate'].forEach(ev =>
|
||||
window.addEventListener(ev, () => {
|
||||
document.getElementById(BADGE_ID)?.remove();
|
||||
updateBadge();
|
||||
document.getElementById(ROW_ID)?.remove();
|
||||
updateAboutSize();
|
||||
})
|
||||
);
|
||||
|
||||
const observer = new MutationObserver(() => {
|
||||
if (!document.getElementById(BADGE_ID)) updateBadge();
|
||||
if (!document.getElementById(ROW_ID)) updateAboutSize();
|
||||
});
|
||||
|
||||
observer.observe(document.body, { childList: true, subtree: true });
|
||||
updateBadge();
|
||||
updateAboutSize();
|
||||
})();
|
||||
|
||||
Reference in New Issue
Block a user