stage

Author: northword

packages/scaffold/package.json

@@ -69,6 +69,7 @@
     }
   },
   "dependencies": {
+    "@fluent/syntax": "^0.19.0",
     "@swc/core": "^1.11.16",
     "adm-zip": "^0.5.16",
     "bumpp": "^10.1.0",

packages/scaffold/src/core/builder/fluent.ts

@@ -0,0 +1,108 @@
+import type { BaseNode, Message, MessageReference, Resource } from "@fluent/syntax";
+import type { BuildConfig } from "../../types/config.js";
+import { readFile, writeFile } from "node:fs/promises";
+import { basename, dirname } from "node:path";
+import { parse, serialize, Transformer } from "@fluent/syntax";
+import { move } from "fs-extra/esm";
+import { glob } from "tinyglobby";
+import { logger } from "../../utils/logger.js";
+
+export async function buildLocale(
+  dist: string,
+  namespace: string,
+  options: BuildConfig["fluent"],
+) {
+  const locales = (await glob(`${dist}/addon/locale/*`, { onlyDirectories: true }))
+    .map(locale => basename(locale));
+
+  const allMessages = new Set<string>();
+  const messagesByLocale = new Map<string, Set<string>>();
+
+  for (const locale of locales) {
+    // Prefix Fluent messages in each ftl, add message to set.
+    const localeMessages = new Set<string>();
+    const ftlPaths = await glob(`${dist}/addon/locale/${locale}/**/*.ftl`);
+
+    await Promise.all(ftlPaths.map(async (ftlPath: string) => {
+      const ftlContent = await readFile(ftlPath, "utf-8");
+      const messages = getMessages(ftlContent);
+      messages.forEach((message) => {
+        localeMessages.add(message);
+        allMessages.add(message);
+      });
+
+      // If prefixFluentMessages===true, we save the changed ftl file,
+      // otherwise discard the changes
+      if (options.prefixFluentMessages) {
+        const newFtlContent = transformFluent(ftlContent, namespace);
+        await writeFile(ftlPath, newFtlContent);
+      }
+
+      // rename *.ftl to addonRef-*.ftl
+      if (options.prefixLocaleFiles === true) {
+        await move(ftlPath, `${dirname(ftlPath)}/${namespace}-${basename(ftlPath)}`);
+        logger.debug(`FTL file '${ftlPath}' is renamed to '${namespace}-${basename(ftlPath)}'.`);
+      }
+    }));
+
+    messagesByLocale.set(locale, localeMessages);
+  }
+}
+
+export function parseFluent(source: string): Resource {
+  const resource = parse(source, {});
+  return resource;
+}
+
+export function getMessages(source: string) {
+  const resource = parseFluent(source);
+  return resource.body
+    .filter(entry => entry.type === "Message")
+    .map(message => message.id.name);
+}
+
+export function serializeFluent(resource: Resource): string {
+  const output = serialize(resource, {});
+  return output;
+}
+
+export function transformFluent(source: string, prefix: string | false): string {
+  const resource = parseFluent(source);
+  new _Transformer(prefix).genericVisit(resource);
+  return serializeFluent(resource);
+}
+
+class _Transformer extends Transformer {
+  namespace: string | false;
+  constructor(namespace: string | false) {
+    super();
+    this.namespace = namespace;
+  }
+
+  private needPrefix(name: string): boolean {
+    if (!this.namespace)
+      return false;
+    else if (name.startsWith(this.namespace))
+      return false;
+    else
+      return true;
+  }
+
+  private doPrefix(name: string): string {
+    return `${this.namespace}-${name}`;
+  }
+
+  visitMessage(node: Message): BaseNode | undefined {
+    if (this.needPrefix(node.id.name)) {
+      node.id.name = this.doPrefix(node.id.name);
+    }
+    return node;
+  }
+
+  visitMessageReference(node: MessageReference): BaseNode | undefined {
+    if (this.needPrefix(node.id.name)) {
+      node.id.name = this.doPrefix(node.id.name);
+    }
+    return node;
+  }
+}