mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-06-11 00:49:31 +00:00
Replace the 'relative-time' element scripting with custom, translatable rewrite (#6154)
This is my take to fix #6078 Should also resolve #6111 As far as I can tell, Forgejo uses only a subset of the relative-time functionality, and as far as I can see, this subset can be implemented using browser built-in date conversion and arithmetic. So I wrote a JavaScript to format the relative-time element accordingly, and a Go binding to generate the translated elements. This is my first time writing Go code, and my first time coding for a large-scale server application, so please tell me if I'm doing something wrong, or if the whole approach is not acceptable. --- Screenshot: Localized times in Low German  Screenshot: The same with Forgejo in English  --- ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [x] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [x] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [x] I do not want this change to show in the release notes. - [ ] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/6154 Reviewed-by: 0ko <0ko@noreply.codeberg.org> Reviewed-by: Michael Kriese <michael.kriese@gmx.de> Co-authored-by: Benedikt Straub <benedikt-straub@web.de> Co-committed-by: Benedikt Straub <benedikt-straub@web.de>
This commit is contained in:
Benedikt Straub
Earl Warren
parent
37d566bdb0
commit
cf03286b5b
19 changed files with 698 additions and 35 deletions
144
web_src/js/webcomponents/relative-time.js
Normal file
144
web_src/js/webcomponents/relative-time.js
Normal file
|
|
@ -0,0 +1,144 @@
|
|||
import {GetPluralizedString} from './i18n.js';
|
||||
import dayjs from 'dayjs';
|
||||
const {pageData} = window.config;
|
||||
|
||||
export const HALF_MINUTE = 30 * 1000;
|
||||
export const ONE_MINUTE = 60 * 1000;
|
||||
export const ONE_HOUR = 60 * ONE_MINUTE;
|
||||
export const ONE_DAY = 24 * ONE_HOUR;
|
||||
|
||||
const ABSOLUTE_DATETIME_FORMAT = new Intl.DateTimeFormat(navigator.language, {
|
||||
year: 'numeric',
|
||||
month: 'short',
|
||||
day: 'numeric',
|
||||
hour: '2-digit',
|
||||
minute: '2-digit',
|
||||
timeZoneName: 'short',
|
||||
});
|
||||
const FALLBACK_DATETIME_FORMAT = new Intl.RelativeTimeFormat(navigator.language, {style: 'long'});
|
||||
|
||||
function GetPluralizedStringOrFallback(key, n, unit) {
|
||||
const translation = GetPluralizedString(key, n, true);
|
||||
if (translation) return translation.replace('%d', n);
|
||||
return FALLBACK_DATETIME_FORMAT.format(-n, unit);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the displayed text of the given relative-time DOM element with its
|
||||
* human-readable, localized relative time string.
|
||||
* Returns the recommended interval in milliseconds until the object should be updated again,
|
||||
* or null if the object is invalid.
|
||||
*/
|
||||
export function DoUpdateRelativeTime(object, now) {
|
||||
const absoluteTime = object.getAttribute('datetime');
|
||||
if (!absoluteTime) {
|
||||
return null; // Object does not contain a datetime.
|
||||
}
|
||||
|
||||
if (!now) now = Date.now();
|
||||
|
||||
const nowJS = dayjs(now);
|
||||
const thenJS = dayjs(absoluteTime);
|
||||
|
||||
object.setAttribute('data-tooltip-content', ABSOLUTE_DATETIME_FORMAT.format(thenJS.toDate()));
|
||||
|
||||
if (nowJS.isBefore(thenJS)) {
|
||||
// Datetime is in the future.
|
||||
object.textContent = pageData.DATETIMESTRINGS.FUTURE;
|
||||
return -Math.floor(nowJS.diff(thenJS, 'millisecond'));
|
||||
}
|
||||
|
||||
const years = Math.floor(nowJS.diff(thenJS, 'year'));
|
||||
if (years >= 1) {
|
||||
// Datetime is at least one year ago.
|
||||
if (years === 1 && pageData.DATETIMESTRINGS['relativetime.1year']) {
|
||||
// Datetime is one year ago.
|
||||
object.textContent = pageData.DATETIMESTRINGS['relativetime.1year'];
|
||||
} else if (years === 2 && pageData.DATETIMESTRINGS['relativetime.2years']) {
|
||||
// Datetime is two year ago.
|
||||
object.textContent = pageData.DATETIMESTRINGS['relativetime.2years'];
|
||||
} else {
|
||||
// Datetime is more than a year ago.
|
||||
object.textContent = GetPluralizedStringOrFallback('relativetime.years', years, 'year');
|
||||
}
|
||||
return ONE_DAY;
|
||||
}
|
||||
|
||||
const months = Math.floor(nowJS.diff(thenJS, 'month'));
|
||||
if (months >= 1) {
|
||||
// Datetime is at least one month but less than a year ago.
|
||||
if (months === 1 && pageData.DATETIMESTRINGS['relativetime.1month']) {
|
||||
// Datetime is one month ago.
|
||||
object.textContent = pageData.DATETIMESTRINGS['relativetime.1month'];
|
||||
} else if (months === 2 && pageData.DATETIMESTRINGS['relativetime.2months']) {
|
||||
// Datetime is two months ago.
|
||||
object.textContent = pageData.DATETIMESTRINGS['relativetime.2months'];
|
||||
} else {
|
||||
// Datetime is several months ago (but less than a year).
|
||||
object.textContent = GetPluralizedStringOrFallback('relativetime.months', months, 'month');
|
||||
}
|
||||
return ONE_DAY;
|
||||
}
|
||||
|
||||
const weeks = Math.floor(nowJS.diff(thenJS, 'week'));
|
||||
if (weeks >= 1) {
|
||||
// Datetime is at least one week but less than a month ago.
|
||||
if (weeks === 1 && pageData.DATETIMESTRINGS['relativetime.1week']) {
|
||||
// Datetime is one week ago.
|
||||
object.textContent = pageData.DATETIMESTRINGS['relativetime.1week'];
|
||||
} else if (weeks === 2 && pageData.DATETIMESTRINGS['relativetime.2weeks']) {
|
||||
// Datetime is two week ago.
|
||||
object.textContent = pageData.DATETIMESTRINGS['relativetime.2weeks'];
|
||||
} else {
|
||||
// Datetime is several weeks ago (but less than a month).
|
||||
object.textContent = GetPluralizedStringOrFallback('relativetime.weeks', weeks, 'week');
|
||||
}
|
||||
return ONE_DAY;
|
||||
}
|
||||
|
||||
const days = Math.floor(nowJS.diff(thenJS, 'day'));
|
||||
if (days >= 1) {
|
||||
if (days === 1 && pageData.DATETIMESTRINGS['relativetime.1day']) {
|
||||
// Datetime is one day ago.
|
||||
object.textContent = pageData.DATETIMESTRINGS['relativetime.1day'];
|
||||
} else if (days === 2 && pageData.DATETIMESTRINGS['relativetime.2days']) {
|
||||
// Datetime is two days ago.
|
||||
object.textContent = pageData.DATETIMESTRINGS['relativetime.2days'];
|
||||
} else {
|
||||
// Datetime is several days but less than a week ago.
|
||||
object.textContent = GetPluralizedStringOrFallback('relativetime.days', days, 'day');
|
||||
}
|
||||
return ONE_DAY;
|
||||
}
|
||||
|
||||
const hours = Math.floor(nowJS.diff(thenJS, 'hour'));
|
||||
if (hours >= 1) {
|
||||
// Datetime is one or more hours but less than a day ago.
|
||||
object.textContent = GetPluralizedStringOrFallback('relativetime.hours', hours, 'hour');
|
||||
return ONE_HOUR;
|
||||
}
|
||||
|
||||
const minutes = Math.floor(nowJS.diff(thenJS, 'minute'));
|
||||
if (minutes >= 1) {
|
||||
// Datetime is one or more minutes but less than an hour ago.
|
||||
object.textContent = GetPluralizedStringOrFallback('relativetime.mins', minutes, 'minute');
|
||||
return ONE_MINUTE;
|
||||
}
|
||||
|
||||
// Datetime is very recent.
|
||||
object.textContent = pageData.DATETIMESTRINGS.NOW;
|
||||
return HALF_MINUTE;
|
||||
}
|
||||
|
||||
/** Update the displayed text of one relative-time DOM element with its human-readable, localized relative time string. */
|
||||
function UpdateRelativeTime(object) {
|
||||
const next = DoUpdateRelativeTime(object);
|
||||
if (next !== null) setTimeout(() => { UpdateRelativeTime(object) }, next);
|
||||
}
|
||||
|
||||
/** Update the displayed text of all relative-time DOM elements with their respective human-readable, localized relative time string. */
|
||||
function UpdateAllRelativeTimes() {
|
||||
for (const object of document.querySelectorAll('relative-time')) UpdateRelativeTime(object);
|
||||
}
|
||||
|
||||
document.addEventListener('DOMContentLoaded', UpdateAllRelativeTimes);
|
||||
Loading…
Add table
Add a link
Reference in a new issue