Skip to content

Commit b0684c5

Browse files
authored
fix: improve settings metadata display (#547)
1 parent 498ed31 commit b0684c5

27 files changed

Lines changed: 87 additions & 13 deletions

src/components/json-schema/SettingsList.tsx

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,40 @@ const DISABLE_AUTO_FILL_PROPS = {
2323
"data-1p-ignore": "true",
2424
};
2525

26+
const buildFieldDescription = (
27+
t: ReturnType<typeof useTranslation<["settingsSchemaDescriptions", "common"]>>["t"],
28+
property: JSONSchema7 & { requiresRestart?: boolean },
29+
newPath: string,
30+
) => {
31+
let description: string | undefined;
32+
const fieldDefault = property.default != null ? `${t(($) => $.default, { ns: "common" })}: ${property.default}` : undefined;
33+
const requiresRestart = property.requiresRestart ? t(($) => $.requires_restart, { ns: "common" }) : undefined;
34+
35+
if (property.description !== null) {
36+
description = `${t(($) => $[newPath as keyof (typeof $)["settingsSchemaDescriptions"]], { defaultValue: property.description })}`;
37+
38+
if (fieldDefault) {
39+
description += ` 🔹${fieldDefault}`;
40+
}
41+
42+
if (requiresRestart) {
43+
description += ` 🔸${requiresRestart}`;
44+
}
45+
} else {
46+
if (fieldDefault) {
47+
description = `🔹${fieldDefault}`;
48+
49+
if (requiresRestart) {
50+
description += ` 🔸${requiresRestart}`;
51+
}
52+
} else if (requiresRestart) {
53+
description = `🔸${requiresRestart}`;
54+
}
55+
}
56+
57+
return description;
58+
};
59+
2660
const propertyToField = (
2761
key: string,
2862
property: JSONSchema7,
@@ -249,19 +283,8 @@ const groupProperties = (
249283
);
250284
}
251285
} else {
252-
const feature = propertyToField(
253-
key,
254-
property,
255-
data[key] ?? property.default,
256-
set,
257-
depth,
258-
required.includes(key),
259-
property.description
260-
? `${t(($) => $[newPath as keyof (typeof $)["settingsSchemaDescriptions"]], { defaultValue: property.description })}${property.default != null ? ` (${t(($) => $.default, { ns: "common", defaultValue: "Default" })}: ${property.default})` : ""}`
261-
: property.default != null
262-
? `${t(($) => $.default, { ns: "common", defaultValue: "Default" })}: ${property.default}}`
263-
: undefined,
264-
);
286+
const description = buildFieldDescription(t, property, newPath);
287+
const feature = propertyToField(key, property, data[key] ?? property.default, set, depth, required.includes(key), description);
265288

266289
if (feature) {
267290
elements.push(

src/i18n/locales/bg.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
"edit_selected": "Редактирай избраните",
4747
"empty_exposes_definition": "Празна exposes дефиниция",
4848
"entries": "Записи",
49+
"error": "Error",
4950
"execute": "Изпълнение",
5051
"execute_command": "Изпълни команда",
5152
"exposes": "Експонирани функции",
@@ -83,6 +84,7 @@
8384
"read_the_docs_info": "Прочетете в документацията…",
8485
"recent_activity": "Скорошна активност",
8586
"remove": "Премахни",
87+
"requires_restart": "Requires restart",
8688
"reset": "Нулиране",
8789
"reset_selected": "Нулирай избраните",
8890
"save": "Запис",

src/i18n/locales/ca.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
"edit_selected": "Edita els seleccionats",
4747
"empty_exposes_definition": "Definició exposes buida",
4848
"entries": "Entrades",
49+
"error": "Error",
4950
"execute": "Executa",
5051
"execute_command": "Executa comanda",
5152
"exposes": "Funcions exposades",
@@ -83,6 +84,7 @@
8384
"read_the_docs_info": "Llegeix-ho a la documentació…",
8485
"recent_activity": "Activitat recent",
8586
"remove": "Elimina",
87+
"requires_restart": "Requires restart",
8688
"reset": "Restableix",
8789
"reset_selected": "Restableix els seleccionats",
8890
"save": "Desa",

src/i18n/locales/cs.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
"edit_selected": "Upravit vybrané",
4747
"empty_exposes_definition": "Chybí definice funkcí zařízení",
4848
"entries": "Záznamy",
49+
"error": "Error",
4950
"execute": "Spustit",
5051
"execute_command": "Spustit příkaz",
5152
"exposes": "Hlavní přehled",
@@ -83,6 +84,7 @@
8384
"read_the_docs_info": "Podrobnosti najdete v dokumentaci…",
8485
"recent_activity": "Nedávná aktivita",
8586
"remove": "Odstranit",
87+
"requires_restart": "Requires restart",
8688
"reset": "Resetovat",
8789
"reset_selected": "Resetovat vybrané",
8890
"save": "Uložit",

src/i18n/locales/da.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
"edit_selected": "Redigér valgte",
4747
"empty_exposes_definition": "Tom exposes-definition",
4848
"entries": "Poster",
49+
"error": "Error",
4950
"execute": "Udfør",
5051
"execute_command": "Udfør kommando",
5152
"exposes": "Eksponerede funktioner",
@@ -83,6 +84,7 @@
8384
"read_the_docs_info": "Læs i dokumentationen…",
8485
"recent_activity": "Seneste aktivitet",
8586
"remove": "Fjern",
87+
"requires_restart": "Requires restart",
8688
"reset": "Nulstil",
8789
"reset_selected": "Nulstil valgte",
8890
"save": "Gem",

src/i18n/locales/de.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
"edit_selected": "Auswahl bearbeiten",
4747
"empty_exposes_definition": "Leere Exposes-Definition",
4848
"entries": "Einträge",
49+
"error": "Error",
4950
"execute": "Ausführen",
5051
"execute_command": "Befehl ausführen",
5152
"exposes": "Expose-Funktionen",
@@ -83,6 +84,7 @@
8384
"read_the_docs_info": "Mehr Informationen finden Sie in der Dokumentation ...",
8485
"recent_activity": "Aktuelle Aktivität",
8586
"remove": "Entfernen",
87+
"requires_restart": "Requires restart",
8688
"reset": "Zurücksetzen",
8789
"reset_selected": "Auswahl zurücksetzen",
8890
"save": "Speichern",

src/i18n/locales/en.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@
8484
"read_the_docs_info": "Read about this in the documentation…",
8585
"recent_activity": "Recent activity",
8686
"remove": "Remove",
87+
"requires_restart": "Requires restart",
8788
"reset": "Reset",
8889
"reset_selected": "Reset selected",
8990
"save": "Save",

src/i18n/locales/es.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
"edit_selected": "Editar seleccionados",
4747
"empty_exposes_definition": "Definición de exposes vacía",
4848
"entries": "Entradas",
49+
"error": "Error",
4950
"execute": "Ejecutar",
5051
"execute_command": "Ejecutar comando",
5152
"exposes": "Funciones expuestas",
@@ -83,6 +84,7 @@
8384
"read_the_docs_info": "Léalo en la documentación…",
8485
"recent_activity": "Actividad reciente",
8586
"remove": "Eliminar",
87+
"requires_restart": "Requires restart",
8688
"reset": "Restablecer",
8789
"reset_selected": "Restablecer seleccionados",
8890
"save": "Guardar",

src/i18n/locales/eu.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
"edit_selected": "Editatu hautatuak",
4747
"empty_exposes_definition": "Exposes definizio hutsik",
4848
"entries": "Sarrerak",
49+
"error": "Error",
4950
"execute": "Exekutatu",
5051
"execute_command": "Exekutatu komandoa",
5152
"exposes": "Esposatutako funtzioak",
@@ -83,6 +84,7 @@
8384
"read_the_docs_info": "Irakurri dokumentazioan…",
8485
"recent_activity": "Azken jarduera",
8586
"remove": "Kendu",
87+
"requires_restart": "Requires restart",
8688
"reset": "Berrezarri",
8789
"reset_selected": "Berrezarri hautatuak",
8890
"save": "Gorde",

src/i18n/locales/fi.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
"edit_selected": "Muokkaa valittuja",
4747
"empty_exposes_definition": "Tyhjä exposes-määritelmä",
4848
"entries": "Merkinnät",
49+
"error": "Error",
4950
"execute": "Suorita",
5051
"execute_command": "Suorita komento",
5152
"exposes": "Näkyvät toiminnot",
@@ -83,6 +84,7 @@
8384
"read_the_docs_info": "Lue dokumentaatiosta…",
8485
"recent_activity": "Viimeisin toiminta",
8586
"remove": "Poista",
87+
"requires_restart": "Requires restart",
8688
"reset": "Palauta",
8789
"reset_selected": "Palauta valitut",
8890
"save": "Tallenna",

0 commit comments

Comments
 (0)