Files
BastiaanandClaude Opus 5.5 6d9a32d28b Show localised names of mod settings in the web UI (#1181)
The mod pack page only looked up mod-setting-name.<name>, so settings
with a localised_name showed the internal name, and rich text tags in
the locale showed up as raw text.

Resolve localised_name and localised_description from the exported
settings prototypes against the exported locale, falling back to the
mod-setting-name/mod-setting-description keys and then the internal
name. The resolver handles parameters, the "" and "?" keys and
__ITEM__/__ENTITY__/__TILE__/__FLUID__ references. Rich text
formatting tags are removed and prototype icons are replaced with
their name.

Fixes #768

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-04 18:02:37 +00:00

60 lines
2.6 KiB
JavaScript

import assert from "node:assert/strict";
import { modSettingFields } from "../../packages/web_ui/src/util/mod_settings.ts";
describe("web_ui/util/mod_settings", function() {
describe("modSettingFields()", function() {
const stored = new Map([
["kept", { value: true }],
["gone-number", { value: 2 }],
["gone-color", { value: { r: 1, g: 0, b: 0, a: 1 } }],
["gone-string", { value: "x" }],
]);
const prototypes = {
"bool-setting": {
"kept": { type: "bool-setting", name: "kept", mod: "b", setting_type: "startup", default_value: false },
"map": {
type: "bool-setting", name: "map", mod: "a", setting_type: "runtime-global", default_value: false,
},
},
"string-setting": {
"first": {
type: "string-setting", name: "first", mod: "a", setting_type: "startup",
default_value: "x", allowed_values: ["x", "y"],
localised_name: ["name.first"], localised_description: ["description.first"],
},
},
"unrelated": { "gone-number": { type: "unrelated", name: "gone-number", setting_type: "startup" } },
};
it("should split stored settings no prototype defines into unknown", function() {
const { known, unknown } = modSettingFields(prototypes, "startup", stored);
assert.deepEqual(known.map(field => field.name), ["first", "kept"]);
assert.deepEqual(known[0].allowed_values, ["x", "y"]);
assert.deepEqual(known[0].localised_name, ["name.first"]);
assert.deepEqual(known[0].localised_description, ["description.first"]);
assert.deepEqual(
unknown.map(field => [field.name, field.type]),
[["gone-color", "color-setting"], ["gone-number", "double-setting"], ["gone-string", "string-setting"]],
);
});
it("should only use prototypes of the given scope", function() {
const kept = new Map([["kept", { value: true }]]);
const { known, unknown } = modSettingFields(prototypes, "runtime-global", kept);
assert.deepEqual(known.map(field => field.name), ["map"]);
assert.deepEqual(unknown.map(field => field.name), ["kept"]);
});
it("should not call settings unknown without export data", function() {
const { known, unknown } = modSettingFields(undefined, "startup", stored);
assert.deepEqual(known.map(field => field.name), [...stored.keys()]);
assert(known.every(field => field.mod === undefined));
assert.deepEqual(unknown, []);
});
it("should treat every stored setting as unknown if the export has no settings", function() {
const { known, unknown } = modSettingFields({}, "startup", stored);
assert.deepEqual(known, []);
assert.equal(unknown.length, stored.size);
});
});
});