1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2025-10-05 19:30:58 +00:00
forgejo/web_src/js/features/repo-code.ts
Jordan Atwood 01419d9c36 chore(ui): replace repo-code jQuery use, convert file to typescript (#9337)
This PR moves repo-code.js to repo-code.ts (with appropriate changes for the JS -> TS conversion), adds e2e tests for file folding and file line permalink copying to fully cover the features implemented in repo-code, then removes the jQuery usage in the file in favor of vanilla JS.

* chore(ui): replace jQuery uses in repo-code.ts

* chore(ui): add copy line permalink test

* chore(ui): add file folding test

* chore(ui): convert repo-code to ts

  This commit additionally removes the use of `document.selection` for IE8
support, as we no longer offer support for the browser.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/9337
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Reviewed-by: 0ko <0ko@noreply.codeberg.org>
Co-authored-by: Jordan Atwood <nightfirecat@nightfirec.at>
Co-committed-by: Jordan Atwood <nightfirecat@nightfirec.at>
2025-09-21 08:08:47 +02:00

207 lines
6.4 KiB
TypeScript

import {svg} from '../svg.js';
import {invertFileFolding} from './file-fold.js';
import {createTippy} from '../modules/tippy.js';
import {clippie} from 'clippie';
import {toAbsoluteUrl} from '../utils.js';
export const singleAnchorRegex = /^#[Ln]([1-9][0-9]*)$/;
export const rangeAnchorRegex = /^#[Ln]([1-9][0-9]*)-[Ln]?([1-9][0-9]*)$/;
function changeHash(hash) {
if (window.history.pushState) {
window.history.pushState(null, null, hash);
} else {
window.location.hash = hash;
}
}
function isBlame() {
return Boolean(document.querySelector('div.blame'));
}
function getLineEls(): Element[] {
return Array.from(document.querySelectorAll(`.code-view td.lines-code${isBlame() ? '.blame-code' : ''}`));
}
function selectRange(linesEls: Element[], selectionEndEl: Element, selectionStartEl?: Element) {
for (const el of linesEls) {
el.closest('tr').classList.remove('active');
}
// add hashchange to permalink
const refInNewIssue = document.querySelector('a.ref-in-new-issue');
const copyPermalink = document.querySelector('a.copy-line-permalink');
const viewGitBlame = document.querySelector('a.view_git_blame');
const updateIssueHref = function (anchor) {
if (!refInNewIssue) return;
const urlIssueNew = refInNewIssue.getAttribute('data-url-issue-new');
const urlParamBodyLink = refInNewIssue.getAttribute('data-url-param-body-link');
const issueContent = `${toAbsoluteUrl(urlParamBodyLink)}#${anchor}`; // the default content for issue body
refInNewIssue.setAttribute('href', `${urlIssueNew}?body=${encodeURIComponent(issueContent)}`);
};
const updateViewGitBlameFragment = function (anchor) {
if (!viewGitBlame) return;
let href = viewGitBlame.getAttribute('href');
href = `${href.replace(/#L\d+$|#L\d+-L\d+$/, '')}`;
if (anchor.length !== 0) {
href = `${href}#${anchor}`;
}
viewGitBlame.setAttribute('href', href);
};
const updateCopyPermalinkUrl = function (anchor) {
if (!copyPermalink) return;
let link = copyPermalink.getAttribute('data-url');
link = `${link.replace(/#L\d+$|#L\d+-L\d+$/, '')}#${anchor}`;
copyPermalink.setAttribute('data-url', link);
};
if (selectionStartEl) {
let a = parseInt(selectionEndEl.getAttribute('rel').slice(1));
let b = parseInt(selectionStartEl.getAttribute('rel').slice(1));
let c;
if (a !== b) {
if (a > b) {
c = a;
a = b;
b = c;
}
const classes = [];
for (let i = a; i <= b; i++) {
classes.push(`[rel=L${i}]`);
}
for (const selectedLine of linesEls.filter((line) => line.matches(classes.join(',')))) {
selectedLine.closest('tr').classList.add('active');
}
changeHash(`#L${a}-L${b}`);
updateIssueHref(`L${a}-L${b}`);
updateViewGitBlameFragment(`L${a}-L${b}`);
updateCopyPermalinkUrl(`L${a}-L${b}`);
return;
}
}
selectionEndEl.closest('tr').classList.add('active');
changeHash(`#${selectionEndEl.getAttribute('rel')}`);
updateIssueHref(selectionEndEl.getAttribute('rel'));
updateViewGitBlameFragment(selectionEndEl.getAttribute('rel'));
updateCopyPermalinkUrl(selectionEndEl.getAttribute('rel'));
}
function showLineButton() {
const menu = document.querySelector('.code-line-menu');
if (!menu) return;
// remove all other line buttons
for (const el of document.querySelectorAll('.code-line-button')) {
el.remove();
}
// find active row and add button
const tr = document.querySelector('.code-view tr.active');
const td = tr.querySelector('td.lines-num');
const btn = document.createElement('button');
btn.classList.add('code-line-button', 'ui', 'basic', 'button');
btn.innerHTML = svg('octicon-kebab-horizontal');
td.prepend(btn);
// put a copy of the menu back into DOM for the next click
btn.closest('.code-view').append(menu.cloneNode(true));
createTippy(btn, {
trigger: 'click',
hideOnClick: true,
content: menu,
placement: 'right-start',
interactive: true,
onShow: (tippy) => {
tippy.popper.addEventListener('click', () => {
tippy.hide();
}, {once: true});
},
});
}
export function initRepoCodeView() {
if (document.querySelector('.code-view .lines-num')) {
document.addEventListener('click', (e) => {
const target = e.target as Element;
if (!target.matches('.lines-num span')) {
return;
}
const linesEls = getLineEls();
const selectedEl = linesEls.find((el) => {
return el.matches(`[rel=${target.id}]`);
});
let from;
if (e.shiftKey) {
from = linesEls.find((el) => {
return el.closest('tr').classList.contains('active');
});
}
selectRange(linesEls, selectedEl, from);
window.getSelection().removeAllRanges();
showLineButton();
});
window.addEventListener('hashchange', () => {
let m = window.location.hash.match(rangeAnchorRegex);
const linesEls = getLineEls();
let first;
if (m) {
first = linesEls.find((el) => el.matches(`[rel=L${m[1]}]`));
if (first) {
const last = linesEls.findLast((el) => el.matches(`[rel=L${m[2]}]`));
selectRange(linesEls, first, last ?? linesEls.at(-1));
// show code view menu marker (don't show in blame page)
if (!isBlame()) {
showLineButton();
}
window.scrollBy({top: first.getBoundingClientRect().top - 200});
return;
}
}
m = window.location.hash.match(singleAnchorRegex);
if (m) {
first = linesEls.find((el) => el.matches(`[rel=L${m[1]}]`));
if (first) {
selectRange(linesEls, first);
// show code view menu marker (don't show in blame page)
if (!isBlame()) {
showLineButton();
}
window.scrollBy({top: first.getBoundingClientRect().top - 200});
}
}
});
window.dispatchEvent(new Event('hashchange'));
}
document.addEventListener('click', (e) => {
const target = e.target as Element;
const foldFileButton = target.closest('.fold-file');
if (!foldFileButton) {
return;
}
invertFileFolding(foldFileButton.closest('.file-content'), foldFileButton);
});
document.addEventListener('click', async (e) => {
const target = e.target as Element;
if (!target.matches('.copy-line-permalink')) {
return;
}
await clippie(toAbsoluteUrl(target.getAttribute('data-url')));
});
}