mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-12 22:10:25 +00:00
- Replace the [Monaco Editor](https://microsoft.github.io/monaco-editor/)
with [CodeMirror 6](https://codemirror.net/). This editor is used to
facilitate the 'Add file' and 'Edit file' functionality.
- Rationale:
- Monaco editor is a great and powerful editor, however for Forgejo's
purpose it acts more like a small IDE than a code editor and is doing
too much. In my limited user research the usage of editing files via
the web UI is largely for small changes that does not need the
features that Monaco editor provides.
- Monaco editor has no mobile support, Codemirror is very usable on mobile.
- Monaco editor pulls in large dependencies (for language support) and
by replacing it with Codemirror the amount of time that webpack needs
to build the frontend is reduced by 50% (~30s -> ~15s).
- The binary of Forgejo (build with `bindata` tag) is reduced by 2MiB.
- Codemirror is much more lightweight and should be more usable on
less powerful hardware, most notably the lazy loading is much faster
as codemirror uses less javascript.
- Because Codemirror is modular it is much easier to change the
behavior of the code editor if we wish to.
- Drawbacks:
- Codemirror is quite modular and as seen in `package.json` and in
`codeeditor.ts` we have to supply a lot more of its features to have
feature parity with Monaco editor.
- Monaco editor has great integrated language support (features that
an lsp would provide), Codemirror only has such language support to an
extend.
- Monaco editor has its famous command palette (known by many as its
also available in VSCode), this is not available in code mirror.
- Good to note:
- All features that was added on top of the monaco editor (such as
dynamically changing language support depending on the filename)
still works and the theme is based on the VSCode colors which largely
resembles the monaco editor.
- The code editor is still lazy-loaded (this is painfully clear by
reading how imports are passed around in `codeeditor.ts`).
- This change was privately tested by a few people, a few bugs were
found (and fixed) but no major drawbacks were noted for their usage of
the web editor.
- There's a "search" button in the top bar, so that search can be used
on mobile. It is otherwise only accessible via
<kbd>Ctrl</kbd>+<kbd>f</kbd>.
Co-authored-by: Beowulf <beowulf@beocode.eu>
Co-authored-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Gusted <postmaster@gusted.xyz>
Co-committed-by: Beowulf <beowulf@beocode.eu>
(cherry picked from commit 28e0af23fa)
Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10697
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
118 lines
4.4 KiB
JavaScript
118 lines
4.4 KiB
JavaScript
import $ from 'jquery';
|
|
import {minimatch} from 'minimatch';
|
|
import {onInputDebounce, toggleElem} from '../utils/dom.js';
|
|
import {POST} from '../modules/fetch.js';
|
|
import {createCodemirror} from './codemirror.ts';
|
|
|
|
const {appSubUrl} = window.config;
|
|
|
|
export function initRepoSettingsCollaboration() {
|
|
// Change collaborator access mode
|
|
$('.page-content.repository .ui.dropdown.access-mode').each((_, el) => {
|
|
const $dropdown = $(el);
|
|
const $text = $dropdown.find('> .text');
|
|
$dropdown.dropdown({
|
|
async action(_text, value) {
|
|
const lastValue = el.getAttribute('data-last-value');
|
|
try {
|
|
el.setAttribute('data-last-value', value);
|
|
$dropdown.dropdown('hide');
|
|
const data = new FormData();
|
|
data.append('uid', el.getAttribute('data-uid'));
|
|
data.append('mode', value);
|
|
await POST(el.getAttribute('data-url'), {data});
|
|
} catch {
|
|
$text.text('(error)'); // prevent from misleading users when error occurs
|
|
el.setAttribute('data-last-value', lastValue);
|
|
}
|
|
},
|
|
onChange(_value, text, _$choice) {
|
|
$text.text(text); // update the text when using keyboard navigating
|
|
},
|
|
onHide() {
|
|
// set to the really selected value, defer to next tick to make sure `action` has finished its work because the calling order might be onHide -> action
|
|
setTimeout(() => {
|
|
const $item = $dropdown.dropdown('get item', el.getAttribute('data-last-value'));
|
|
if ($item) {
|
|
$dropdown.dropdown('set selected', el.getAttribute('data-last-value'));
|
|
} else {
|
|
$text.text('(none)'); // prevent from misleading users when the access mode is undefined
|
|
}
|
|
}, 0);
|
|
},
|
|
});
|
|
});
|
|
}
|
|
|
|
export function initRepoSettingSearchTeamBox() {
|
|
const searchTeamBox = document.getElementById('search-team-box');
|
|
if (!searchTeamBox) return;
|
|
|
|
$(searchTeamBox).search({
|
|
minCharacters: 2,
|
|
apiSettings: {
|
|
url: `${appSubUrl}/org/${searchTeamBox.getAttribute('data-org-name')}/teams/-/search?q={query}`,
|
|
onResponse(response) {
|
|
const items = [];
|
|
for (const item of response.data) {
|
|
items.push({
|
|
title: item.name,
|
|
description: `${item.permission} access`, // TODO: translate this string
|
|
});
|
|
}
|
|
return {results: items};
|
|
},
|
|
},
|
|
searchFields: ['name', 'description'],
|
|
showNoResults: false,
|
|
});
|
|
}
|
|
|
|
export function initRepoSettingGitHook() {
|
|
if (!$('.edit.githook').length) return;
|
|
const filename = document.querySelector('.hook-filename').textContent;
|
|
const _promise = createCodemirror($('#content')[0], filename, {language: 'shell'});
|
|
}
|
|
|
|
export function initRepoSettingBranches() {
|
|
if (!document.querySelector('.repository.settings.branches')) return;
|
|
|
|
for (const el of document.getElementsByClassName('toggle-target-enabled')) {
|
|
el.addEventListener('change', function () {
|
|
const target = document.querySelector(this.getAttribute('data-target'));
|
|
target?.classList.toggle('disabled', !this.checked);
|
|
});
|
|
}
|
|
|
|
for (const el of document.getElementsByClassName('toggle-target-disabled')) {
|
|
el.addEventListener('change', function () {
|
|
const target = document.querySelector(this.getAttribute('data-target'));
|
|
if (this.checked) target?.classList.add('disabled'); // only disable, do not auto enable
|
|
});
|
|
}
|
|
|
|
document.getElementById('dismiss_stale_approvals')?.addEventListener('change', function () {
|
|
document.getElementById('ignore_stale_approvals_box')?.classList.toggle('disabled', this.checked);
|
|
});
|
|
|
|
// show the `Matched` mark for the status checks that match the pattern
|
|
const markMatchedStatusChecks = () => {
|
|
const patterns = (document.getElementById('status_check_contexts').value || '').split(/[\r\n]+/);
|
|
const validPatterns = patterns.map((item) => item.trim()).filter(Boolean);
|
|
const marks = document.getElementsByClassName('status-check-matched-mark');
|
|
|
|
for (const el of marks) {
|
|
let matched = false;
|
|
const statusCheck = el.getAttribute('data-status-check');
|
|
for (const pattern of validPatterns) {
|
|
if (minimatch(statusCheck, pattern)) {
|
|
matched = true;
|
|
break;
|
|
}
|
|
}
|
|
toggleElem(el, matched);
|
|
}
|
|
};
|
|
markMatchedStatusChecks();
|
|
document.getElementById('status_check_contexts').addEventListener('input', onInputDebounce(markMatchedStatusChecks));
|
|
}
|