@concordance-wiki/i18n 0.1.0

package/dist/src/labels.js

@@ -0,0 +1,86 @@
+import { parse } from "@formatjs/icu-messageformat-parser";
+import { argumentsOf, parseMessage } from "./arguments.js";
+import { source } from "./ids.js";
+import { shipped, shippedLanguages } from "./shipped.js";
+function isMessageId(id) {
+    return Object.hasOwn(source, id);
+}
+/** The source catalogue is verified to parse by its own test, so the parser cannot throw here. */
+function sourceNames(id) {
+    return [...argumentsOf(parse(source[id].defaultMessage)).keys()];
+}
+function describeDifference(missing, extra) {
+    const parts = [];
+    if (missing.length > 0)
+        parts.push(`missing variable(s) ${missing.join(", ")}`);
+    if (extra.length > 0)
+        parts.push(`unknown variable(s) ${extra.join(", ")}`);
+    return parts.join("; ");
+}
+/** The issue an override raises, or undefined when it can replace the source message. */
+export function validateOverride(id, message, path) {
+    if (!isMessageId(id)) {
+        return {
+            severity: "error",
+            path,
+            message: "unknown message identifier",
+            received: id,
+            expected: "an identifier of the source catalogue, messages/en/",
+        };
+    }
+    const parsed = parseMessage(message);
+    if (!parsed.ok) {
+        return {
+            severity: "error",
+            path,
+            message: `invalid ICU MessageFormat syntax: ${parsed.reason}`,
+            received: message,
+            expected: "a message in ICU MessageFormat syntax",
+        };
+    }
+    const expected = sourceNames(id);
+    const actual = [...argumentsOf(parsed.elements).keys()];
+    const missing = expected.filter((name) => !actual.includes(name));
+    const extra = actual.filter((name) => !expected.includes(name));
+    if (missing.length === 0 && extra.length === 0)
+        return undefined;
+    return {
+        severity: "error",
+        path,
+        message: describeDifference(missing, extra),
+        received: message,
+        expected: expected.length === 0
+            ? "a message without variable"
+            : `a message using exactly the variable(s) ${expected.join(", ")}`,
+    };
+}
+/** Validates the overrides of one language; `prefix` is the path of the block, `labels.fr` style. */
+export function validateOverrides(overrides, prefix) {
+    const issues = [];
+    for (const [id, message] of Object.entries(overrides).sort(([a], [b]) => (a < b ? -1 : 1))) {
+        const issue = validateOverride(id, message, `${prefix}.${id}`);
+        if (issue !== undefined)
+            issues.push(issue);
+    }
+    return issues;
+}
+/** Validates the whole `labels` block of a theme: every language must ship a catalogue and every override must be valid. */
+export function validateLabels(labels) {
+    const issues = [];
+    for (const [language, overrides] of Object.entries(labels).sort(([a], [b]) => (a < b ? -1 : 1))) {
+        if (language in shipped) {
+            issues.push(...validateOverrides(overrides, `labels.${language}`));
+        }
+        else {
+            issues.push({
+                severity: "error",
+                path: `labels.${language}`,
+                message: "no catalogue ships for this language",
+                received: language,
+                expected: `one of ${shippedLanguages.join(", ")}`,
+            });
+        }
+    }
+    return issues;
+}
+//# sourceMappingURL=labels.js.map

package/dist/src/labels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"labels.js","sourceRoot":"","sources":["../../src/labels.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,oCAAoC,CAAC;AAE3D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEzD,SAAS,WAAW,CAAC,EAAU;IAC7B,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACnC,CAAC;AAED,kGAAkG;AAClG,SAAS,WAAW,CAAC,EAAa;IAChC,OAAO,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,kBAAkB,CAAC,OAA0B,EAAE,KAAwB;IAC9E,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,uBAAuB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChF,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,uBAAuB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5E,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,yFAAyF;AACzF,MAAM,UAAU,gBAAgB,CAC9B,EAAU,EACV,OAAe,EACf,IAAY;IAEZ,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,EAAE,CAAC;QACrB,OAAO;YACL,QAAQ,EAAE,OAAO;YACjB,IAAI;YACJ,OAAO,EAAE,4BAA4B;YACrC,QAAQ,EAAE,EAAE;YACZ,QAAQ,EAAE,qDAAqD;SAChE,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO;YACL,QAAQ,EAAE,OAAO;YACjB,IAAI;YACJ,OAAO,EAAE,qCAAqC,MAAM,CAAC,MAAM,EAAE;YAC7D,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE,uCAAuC;SAClD,CAAC;IACJ,CAAC;IACD,MAAM,QAAQ,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;IACjC,MAAM,MAAM,GAAG,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACxD,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACjE,OAAO;QACL,QAAQ,EAAE,OAAO;QACjB,IAAI;QACJ,OAAO,EAAE,kBAAkB,CAAC,OAAO,EAAE,KAAK,CAAC;QAC3C,QAAQ,EAAE,OAAO;QACjB,QAAQ,EACN,QAAQ,CAAC,MAAM,KAAK,CAAC;YACnB,CAAC,CAAC,4BAA4B;YAC9B,CAAC,CAAC,2CAA2C,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;KACvE,CAAC;AACJ,CAAC;AAED,qGAAqG;AACrG,MAAM,UAAU,iBAAiB,CAC/B,SAA2C,EAC3C,MAAc;IAEd,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3F,MAAM,KAAK,GAAG,gBAAgB,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,EAAE,EAAE,CAAC,CAAC;QAC/D,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,4HAA4H;AAC5H,MAAM,UAAU,cAAc,CAC5B,MAAkE;IAElE,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,KAAK,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChG,IAAI,QAAQ,IAAI,OAAO,EAAE,CAAC;YACxB,MAAM,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,SAAS,EAAE,UAAU,QAAQ,EAAE,CAAC,CAAC,CAAC;QACrE,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,CAAC;gBACV,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,UAAU,QAAQ,EAAE;gBAC1B,OAAO,EAAE,sCAAsC;gBAC/C,QAAQ,EAAE,QAAQ;gBAClB,QAAQ,EAAE,UAAU,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;aAClD,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/src/shipped.d.ts

@@ -0,0 +1,7 @@
+import type { MessageId } from "./ids.js";
+export declare const SOURCE_LANGUAGE = "en";
+/** The shipped catalogues, flat, by language, in identifier order; adding a locale means adding it here. */
+export declare const shipped: Readonly<Record<string, Readonly<Record<MessageId, string>>>>;
+/** The languages that ship with a catalogue, in sorted order. */
+export declare const shippedLanguages: readonly string[];
+//# sourceMappingURL=shipped.d.ts.map

package/dist/src/shipped.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipped.d.ts","sourceRoot":"","sources":["../../src/shipped.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAG1C,eAAO,MAAM,eAAe,OAAO,CAAC;AAEpC,4GAA4G;AAC5G,eAAO,MAAM,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,CAGjF,CAAC;AAEF,iEAAiE;AACjE,eAAO,MAAM,gBAAgB,EAAE,SAAS,MAAM,EAA0C,CAAC"}

package/dist/src/shipped.js

@@ -0,0 +1,10 @@
+import { byCodeUnit, byMessageId, french, source } from "./ids.js";
+export const SOURCE_LANGUAGE = "en";
+/** The shipped catalogues, flat, by language, in identifier order; adding a locale means adding it here. */
+export const shipped = {
+    en: byMessageId((id) => source[id].defaultMessage),
+    fr: byMessageId((id) => french[id]),
+};
+/** The languages that ship with a catalogue, in sorted order. */
+export const shippedLanguages = Object.keys(shipped).sort(byCodeUnit);
+//# sourceMappingURL=shipped.js.map

package/dist/src/shipped.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipped.js","sourceRoot":"","sources":["../../src/shipped.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEnE,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC;AAEpC,4GAA4G;AAC5G,MAAM,CAAC,MAAM,OAAO,GAAkE;IACpF,EAAE,EAAE,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,cAAc,CAAC;IAClD,EAAE,EAAE,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;CACpC,CAAC;AAEF,iEAAiE;AACjE,MAAM,CAAC,MAAM,gBAAgB,GAAsB,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@concordance-wiki/i18n",
+  "version": "0.1.0",
+  "description": "Message catalogues of the generated site and their build-time resolution.",
+  "license": "GPL-3.0-or-later",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/concordance-wiki/concordance.git",
+    "directory": "packages/i18n"
+  },
+  "homepage": "https://github.com/concordance-wiki/concordance/tree/main/packages/i18n#readme",
+  "bugs": "https://github.com/concordance-wiki/concordance/issues",
+  "type": "module",
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "default": "./dist/src/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "typecheck": "tsc -b tsconfig.json"
+  },
+  "dependencies": {
+    "@concordance-wiki/core": "workspace:*",
+    "@formatjs/icu-messageformat-parser": "3.5.18",
+    "intl-messageformat": "11.2.15"
+  }
+}