Add GitHub connection type — repo viewer with org grouping and auto-refresh

New protocol type 'github' for browsing repositories via the GitHub REST API.
Creates a non-terminal panel showing repos grouped by owner/org, sorted by
last commit date (newest first), with search filtering and auto-refresh.

Backend:
- ProtocolGitHub constant and GitHubConfig/GitHubRepo model structs
- New internal/githubclient package (REST API, pagination, token validation)
- Session manager connectGitHub() with periodic refresh goroutine
- API surface: RefreshGitHubRepos() for on-demand refresh
- Token stored via existing credential infrastructure (keychain/vault)

Frontend:
- GitHub tab in profile editor with API URL and token storage fields
- New github.js viewer component (grouped repos, badges, language dots)
- github.css with charcoal-themed repo cards and org headers
- Protocol colour tokens, tab badge, sidebar indicator for GitHub
- Event wiring for session:github:repos and session:github:error
- Cleanup on tab close

Supports GitHub Enterprise via configurable API base URL.
This commit is contained in:
2026-04-16 00:00:00 +01:00
parent 58eb1626f6
commit c98ace2396
20 changed files with 1179 additions and 21 deletions
+21
View File
@@ -166,6 +166,20 @@ class App {
this.rawViewer.handleData(payload);
});
// GitHub repository data
window.runtime.EventsOn('session:github:repos', (payload) => {
window.NexusTerminal.GitHubViewer.updateRepos(
payload.sessionID, payload.login, payload.repos
);
});
// GitHub refresh errors
window.runtime.EventsOn('session:github:error', (payload) => {
window.NexusTerminal.GitHubViewer.showError(
payload.sessionID, payload.error
);
});
// Telnet negotiation debug messages
window.runtime.EventsOn('session:debug', (payload) => {
console.debug('[session:debug]', payload);
@@ -341,6 +355,13 @@ class App {
const panelId = `panel-${sessionInfo.id}`;
if (profile.protocol === 'raw') {
this.rawViewer.createViewer(sessionInfo.id, panelId, profile);
} else if (profile.protocol === 'github') {
const container = document.getElementById(panelId);
if (container) {
window.NexusTerminal.GitHubViewer.createViewer(
sessionInfo.id, container, profile.displayName || profile.host
);
}
} else {
this.terminals.createTerminal(sessionInfo.id, panelId, profile);
}
+385
View File
@@ -0,0 +1,385 @@
(function() {
/**
* Nexus Terminal — GitHub repository viewer.
* Renders a scrollable list of repositories grouped by owner/organisation,
* sorted by last commit date (newest first). Automatically refreshes via
* Wails events emitted by the Go backend.
*/
const { createElement, escapeHtml, relativeTime, $ } = window.NexusTerminal;
class GitHubViewer {
constructor() {
/** @type {Map<string, GitHubViewerInstance>} sessionID → viewer */
this._viewers = new Map();
}
/**
* Creates a viewer panel for a GitHub session inside the given container.
* @param {string} sessionID
* @param {HTMLElement} container - The .session-panel element.
* @param {string} profileName
*/
createViewer(sessionID, container, profileName) {
if (this._viewers.has(sessionID)) return;
const viewer = new GitHubViewerInstance(sessionID, container, profileName);
this._viewers.set(sessionID, viewer);
viewer.render();
}
/**
* Destroys a viewer for the given session.
* @param {string} sessionID
*/
destroyViewer(sessionID) {
const viewer = this._viewers.get(sessionID);
if (viewer) {
viewer.destroy();
this._viewers.delete(sessionID);
}
}
/**
* Handles incoming repo data from the backend event.
* @param {string} sessionID
* @param {string} login - The authenticated GitHub username.
* @param {Array} repos
*/
updateRepos(sessionID, login, repos) {
const viewer = this._viewers.get(sessionID);
if (viewer) {
viewer.setData(login, repos);
}
}
/**
* Handles an error event for a session.
* @param {string} sessionID
* @param {string} message
*/
showError(sessionID, message) {
const viewer = this._viewers.get(sessionID);
if (viewer) {
viewer.showError(message);
}
}
}
class GitHubViewerInstance {
/**
* @param {string} sessionID
* @param {HTMLElement} container
* @param {string} profileName
*/
constructor(sessionID, container, profileName) {
this.sessionID = sessionID;
this.container = container;
this.profileName = profileName;
/** @type {string} */
this._login = '';
/** @type {Array} */
this._repos = [];
/** @type {string} */
this._filter = '';
/** @type {HTMLElement|null} */
this._el = null;
/** @type {HTMLElement|null} */
this._listEl = null;
/** @type {HTMLElement|null} */
this._statusEl = null;
/** @type {number|null} */
this._refreshTimer = null;
}
render() {
this.container.innerHTML = '';
const wrapper = createElement('div', 'github-viewer');
// ── Header bar ──────────────────────────────────────────
const header = createElement('div', 'github-viewer-header');
const titleArea = createElement('div', 'github-viewer-title-area');
const icon = createElement('span', 'github-viewer-icon');
icon.innerHTML = this._githubSVG();
titleArea.appendChild(icon);
const titleText = createElement('span', 'github-viewer-title');
titleText.textContent = this.profileName || 'GitHub';
titleArea.appendChild(titleText);
header.appendChild(titleArea);
// Search / filter
const searchWrap = createElement('div', 'github-viewer-search');
const searchInput = createElement('input', 'github-viewer-search-input', {
type: 'text',
placeholder: 'Filter repositories…',
});
searchInput.addEventListener('input', (e) => {
this._filter = e.target.value.toLowerCase();
this._renderList();
});
searchWrap.appendChild(searchInput);
header.appendChild(searchWrap);
// Refresh button
const refreshBtn = createElement('button', 'github-viewer-refresh', {
title: 'Refresh now',
});
refreshBtn.innerHTML = '↻';
refreshBtn.addEventListener('click', () => this._manualRefresh());
header.appendChild(refreshBtn);
wrapper.appendChild(header);
// ── Status bar ──────────────────────────────────────────
this._statusEl = createElement('div', 'github-viewer-status');
this._statusEl.textContent = 'Connecting…';
wrapper.appendChild(this._statusEl);
// ── Repo list ───────────────────────────────────────────
this._listEl = createElement('div', 'github-viewer-list');
wrapper.appendChild(this._listEl);
this.container.appendChild(wrapper);
this._el = wrapper;
}
/**
* Updates the viewer with fresh data.
* @param {string} login
* @param {Array} repos
*/
setData(login, repos) {
this._login = login;
this._repos = repos || [];
this._updateStatus();
this._renderList();
}
/**
* Displays an error message in the status bar.
* @param {string} message
*/
showError(message) {
if (this._statusEl) {
this._statusEl.textContent = `⚠ ${message}`;
this._statusEl.classList.add('github-viewer-status-error');
}
}
destroy() {
if (this._refreshTimer) {
clearInterval(this._refreshTimer);
this._refreshTimer = null;
}
if (this._el) {
this._el.remove();
this._el = null;
}
}
// ── Private ──────────────────────────────────────────────────
_updateStatus() {
if (!this._statusEl) return;
this._statusEl.classList.remove('github-viewer-status-error');
const count = this._repos.length;
const now = new Date().toLocaleTimeString();
this._statusEl.textContent = `${this._login} · ${count} repositor${count === 1 ? 'y' : 'ies'} · updated ${now}`;
}
_renderList() {
if (!this._listEl) return;
this._listEl.innerHTML = '';
// Filter
let filtered = this._repos;
if (this._filter) {
filtered = this._repos.filter((r) =>
r.fullName.toLowerCase().includes(this._filter) ||
(r.description || '').toLowerCase().includes(this._filter) ||
(r.language || '').toLowerCase().includes(this._filter)
);
}
if (filtered.length === 0) {
const empty = createElement('div', 'github-viewer-empty');
empty.textContent = this._filter ? 'No matching repositories.' : 'No repositories found.';
this._listEl.appendChild(empty);
return;
}
// Group by owner
const groups = new Map();
for (const repo of filtered) {
const owner = repo.owner || 'unknown';
if (!groups.has(owner)) groups.set(owner, []);
groups.get(owner).push(repo);
}
// Sort groups alphabetically (user's own repos first)
const sortedKeys = [...groups.keys()].sort((a, b) => {
if (a === this._login) return -1;
if (b === this._login) return 1;
return a.localeCompare(b);
});
for (const owner of sortedKeys) {
const repos = groups.get(owner);
// Group header
const groupEl = createElement('div', 'github-group');
const groupHeader = createElement('div', 'github-group-header');
groupHeader.innerHTML = `
<span class="github-group-name">${escapeHtml(owner)}</span>
<span class="github-group-count">${repos.length}</span>
`;
groupEl.appendChild(groupHeader);
// Repo cards
for (const repo of repos) {
groupEl.appendChild(this._renderRepoCard(repo));
}
this._listEl.appendChild(groupEl);
}
}
/**
* Renders a single repository card.
* @param {Object} repo
* @returns {HTMLElement}
*/
_renderRepoCard(repo) {
const card = createElement('div', 'github-repo-card');
card.addEventListener('click', () => {
if (repo.htmlURL) window.open(repo.htmlURL, '_blank');
});
// Top row: name + badges
const topRow = createElement('div', 'github-repo-top');
const nameEl = createElement('span', 'github-repo-name');
nameEl.textContent = repo.name;
topRow.appendChild(nameEl);
if (repo.private) {
const badge = createElement('span', 'github-repo-badge github-repo-private');
badge.textContent = 'Private';
topRow.appendChild(badge);
}
if (repo.fork) {
const badge = createElement('span', 'github-repo-badge github-repo-fork');
badge.textContent = 'Fork';
topRow.appendChild(badge);
}
if (repo.archived) {
const badge = createElement('span', 'github-repo-badge github-repo-archived');
badge.textContent = 'Archived';
topRow.appendChild(badge);
}
card.appendChild(topRow);
// Description
if (repo.description) {
const desc = createElement('div', 'github-repo-desc');
desc.textContent = repo.description;
card.appendChild(desc);
}
// Meta row: language, stars, pushed
const meta = createElement('div', 'github-repo-meta');
if (repo.language) {
const lang = createElement('span', 'github-repo-lang');
lang.innerHTML = `<span class="github-lang-dot" style="background:${this._langColour(repo.language)}"></span> ${escapeHtml(repo.language)}`;
meta.appendChild(lang);
}
if (repo.stars > 0) {
const stars = createElement('span', 'github-repo-stars');
stars.textContent = `★ ${repo.stars.toLocaleString()}`;
meta.appendChild(stars);
}
if (repo.pushedAt) {
const pushed = createElement('span', 'github-repo-pushed');
pushed.textContent = relativeTime(repo.pushedAt);
pushed.title = new Date(repo.pushedAt).toLocaleString();
meta.appendChild(pushed);
}
card.appendChild(meta);
return card;
}
async _manualRefresh() {
if (!this._statusEl) return;
this._statusEl.textContent = 'Refreshing…';
try {
await window.go.api.Service.RefreshGitHubRepos(this.sessionID);
} catch (err) {
this.showError(err.message || 'Refresh failed');
}
}
/**
* Returns a colour for the given programming language.
* Uses a subset of GitHub's linguist colours.
* @param {string} lang
* @returns {string} CSS colour value.
*/
_langColour(lang) {
const colours = {
'JavaScript': '#f1e05a',
'TypeScript': '#3178c6',
'Python': '#3572A5',
'Go': '#00ADD8',
'Rust': '#dea584',
'Java': '#b07219',
'C': '#555555',
'C++': '#f34b7d',
'C#': '#178600',
'Ruby': '#701516',
'PHP': '#4F5D95',
'Swift': '#F05138',
'Kotlin': '#A97BFF',
'Shell': '#89e051',
'HTML': '#e34c26',
'CSS': '#563d7c',
'Dart': '#00B4AB',
'Lua': '#000080',
'Scala': '#c22d40',
'Elixir': '#6e4a7e',
'Haskell': '#5e5086',
'Zig': '#ec915c',
'Vue': '#41b883',
'SCSS': '#c6538c',
};
return colours[lang] || '#8b949e';
}
/**
* GitHub Invertocat SVG icon.
* @returns {string}
*/
_githubSVG() {
return '<svg viewBox="0 0 16 16" width="20" height="20" fill="currentColor"><path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"/></svg>';
}
}
window.NexusTerminal = window.NexusTerminal || {};
window.NexusTerminal.GitHubViewer = new GitHubViewer();
})();
+69 -10
View File
@@ -52,6 +52,16 @@ const DEFAULTS = {
payloadPresets: [],
},
},
github: {
port: 443,
protocol: 'github',
host: 'github.com',
github: {
baseURL: 'https://api.github.com',
secretMode: 'saved',
refreshIntervalSecs: 300,
},
},
};
class ProfileEditor {
@@ -119,11 +129,12 @@ class ProfileEditor {
drawer.appendChild(header);
// ── Protocol selector tabs ──────────────────────────────
const protocols = ['ssh', 'telnet', 'raw'];
const protocols = ['ssh', 'telnet', 'raw', 'github'];
const tabBar = createElement('div', 'drawer-protocol-tabs');
for (const proto of protocols) {
const label = proto === 'github' ? 'GitHub' : proto.toUpperCase();
const btn = createElement('button', `drawer-proto-tab ${profile.protocol === proto ? 'active' : ''}`, {
textContent: proto.toUpperCase(),
textContent: label,
dataset: { proto },
});
btn.addEventListener('click', () => this.handleProtocolChange(proto));
@@ -148,10 +159,13 @@ class ProfileEditor {
case 'raw':
this._renderRAWSections(profile).forEach((s) => body.appendChild(s));
break;
case 'github':
this._renderGitHubSections(profile).forEach((s) => body.appendChild(s));
break;
}
// Terminal section (SSH and Telnet only)
if (profile.protocol !== 'raw') {
if (profile.protocol !== 'raw' && profile.protocol !== 'github') {
body.appendChild(this._renderTerminalSection(profile));
}
@@ -237,14 +251,24 @@ class ProfileEditor {
/** @private */
_renderGeneralSection(profile) {
return this._renderSection('General', [
const fields = [
this._field('text', 'displayName', 'Display Name', profile.displayName, { placeholder: 'My Server' }),
this._field('text', 'host', 'Host', profile.host, { placeholder: '192.168.1.1 or example.com', required: true }),
this._field('number', 'port', 'Port', profile.port, { min: 1, max: 65535, required: true }),
this._field('text', 'username', 'Username', profile.username, { placeholder: 'root' }),
this._renderGroupField(profile),
this._field('text', 'description', 'Description', profile.description, { placeholder: 'Optional description' }),
]);
this._field('text', 'host', 'Host', profile.host, {
placeholder: profile.protocol === 'github' ? 'github.com' : '192.168.1.1 or example.com',
required: true,
}),
];
// Port and username not relevant for GitHub connections
if (profile.protocol !== 'github') {
fields.push(this._field('number', 'port', 'Port', profile.port, { min: 1, max: 65535, required: true }));
fields.push(this._field('text', 'username', 'Username', profile.username, { placeholder: 'root' }));
}
fields.push(this._renderGroupField(profile));
fields.push(this._field('text', 'description', 'Description', profile.description, { placeholder: 'Optional description' }));
return this._renderSection('General', fields);
}
/**
@@ -451,6 +475,33 @@ class ProfileEditor {
return sections;
}
/** @private */
_renderGitHubSections(profile) {
const sections = [];
const gh = profile.github || DEFAULTS.github.github;
sections.push(this._renderSection('API', [
this._field('text', 'github.baseURL', 'API Base URL', gh.baseURL, {
placeholder: 'https://api.github.com',
}),
this._field('select', 'github.secretMode', 'Token Storage', gh.secretMode, {
options: [
{ value: 'saved', label: 'Save to keychain' },
{ value: 'session-only', label: 'Remember for session' },
{ value: 'ask-every-time', label: 'Ask every time' },
],
}),
]));
sections.push(this._renderSection('Refresh', [
this._field('number', 'github.refreshIntervalSecs', 'Refresh Interval (seconds)', gh.refreshIntervalSecs, {
min: 60, max: 3600,
}),
]));
return sections;
}
/** @private */
_renderTerminalSection(profile) {
return this._renderSection('Terminal', [
@@ -843,6 +894,14 @@ class ProfileEditor {
}
p.raw.payloadPresets = presets;
}
// GitHub-specific
if (p.protocol === 'github') {
if (!p.github) p.github = {};
p.github.baseURL = val('github.baseURL') || 'https://api.github.com';
p.github.secretMode = val('github.secretMode') || 'saved';
p.github.refreshIntervalSecs = val('github.refreshIntervalSecs') || 300;
}
}
// ── Validation ───────────────────────────────────────────────────
+5 -2
View File
@@ -141,6 +141,7 @@ class TabManager {
this.app.terminals.destroyTerminal(sessionId);
this.app.rawViewer.destroyViewer(sessionId);
window.NexusTerminal.GitHubViewer.destroyViewer(sessionId);
this.app.state.removeSession(sessionId);
this.removeTab(sessionId);
}
@@ -394,8 +395,9 @@ class TabManager {
});
// Protocol badge
const badge = createElement('span', `tab-badge ${protocolColour(sessionInfo.protocol)}`, {
textContent: sessionInfo.protocol.toUpperCase(),
const protoLabel = sessionInfo.protocol === 'github' ? 'GitHub' : sessionInfo.protocol.toUpperCase();
const badge = createElement('span', `tab-badge badge-${sessionInfo.protocol}`, {
textContent: protoLabel,
});
tab.appendChild(badge);
@@ -515,6 +517,7 @@ class TabManager {
// Close the current tab, then open a fresh connection
this.app.terminals.destroyTerminal(sessionId);
this.app.rawViewer.destroyViewer(sessionId);
window.NexusTerminal.GitHubViewer.destroyViewer(sessionId);
this.app.state.removeSession(sessionId);
this.removeTab(sessionId);
+29 -2
View File
@@ -202,7 +202,7 @@ function dismissContextMenus() {
/**
* Returns the protocol badge colour class.
* @param {string} protocol - 'ssh', 'telnet', or 'raw'.
* @param {string} protocol - 'ssh', 'telnet', 'raw', or 'github'.
* @returns {string}
*/
function protocolColour(protocol) {
@@ -210,10 +210,37 @@ function protocolColour(protocol) {
case 'ssh': return 'proto-ssh';
case 'telnet': return 'proto-telnet';
case 'raw': return 'proto-raw';
case 'github': return 'proto-github';
default: return '';
}
}
/**
* Returns a human-friendly relative time string for an ISO date.
* @param {string} isoDate - ISO 8601 date string.
* @returns {string} e.g. "3 hours ago", "2 days ago".
*/
function relativeTime(isoDate) {
if (!isoDate) return '';
const d = new Date(isoDate);
if (isNaN(d.getTime())) return '';
const now = Date.now();
const diff = now - d.getTime();
const secs = Math.floor(diff / 1000);
if (secs < 60) return 'just now';
const mins = Math.floor(secs / 60);
if (mins < 60) return mins === 1 ? '1 minute ago' : `${mins} minutes ago`;
const hrs = Math.floor(mins / 60);
if (hrs < 24) return hrs === 1 ? '1 hour ago' : `${hrs} hours ago`;
const days = Math.floor(hrs / 24);
if (days < 30) return days === 1 ? '1 day ago' : `${days} days ago`;
const months = Math.floor(days / 30);
if (months < 12) return months === 1 ? '1 month ago' : `${months} months ago`;
const years = Math.floor(months / 12);
return years === 1 ? '1 year ago' : `${years} years ago`;
}
/**
* Returns a human-friendly label for a session state.
* @param {string} state
@@ -230,6 +257,6 @@ function stateLabel(state) {
}
window.NexusTerminal = window.NexusTerminal || {};
Object.assign(window.NexusTerminal, { $, $$, createElement, escapeHtml, formatTimestamp, debounce, fuzzyMatch, base64Encode, base64Decode, generateId, formatBytes, truncate, dismissContextMenus, protocolColour, stateLabel });
Object.assign(window.NexusTerminal, { $, $$, createElement, escapeHtml, formatTimestamp, debounce, fuzzyMatch, base64Encode, base64Decode, generateId, formatBytes, truncate, dismissContextMenus, protocolColour, stateLabel, relativeTime });
})();