Add support for localization

.vscode/launch.json

@@ -8,11 +8,7 @@
       "name": "Launch Client",
       "runtimeExecutable": "${execPath}",
       "args": ["--extensionDevelopmentPath=${workspaceRoot}/packages/vscode"],
-      "outFiles": [
-        "${workspaceRoot}/packages/vscode/dist/**/*.js",
-        "${workspaceRoot}/packages/core/dist/**/*.cjs",
-        "${workspaceRoot}/packages/usfm/dist/**/*.cjs"
-      ],
+      "outFiles": ["${workspaceRoot}/packages/*/dist/**/*.c?js"],
       "autoAttachChildProcesses": true,
       "preLaunchTask": "npm: dev",
       "sourceMaps": true

packages/core/package.json

@@ -19,8 +19,8 @@
     }
   },
   "scripts": {
-    "build": "tsup src/index.ts --dts --format cjs,esm --clean --sourcemap",
-    "dev": "tsup src/index.ts --dts --format cjs,esm --watch --sourcemap",
+    "build": "tsup-node src/index.ts --dts --format cjs,esm --clean --sourcemap",
+    "dev": "tsup-node src/index.ts --dts --format cjs,esm --watch --sourcemap",
     "check-types": "tsc --noEmit",
     "lint": "eslint .",
     "test": "vitest",
@@ -30,6 +30,7 @@
   "author": "SIL Global",
   "license": "MIT",
   "dependencies": {
+    "i18next": "^23.16.5",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {

packages/core/src/diagnostic/diagnostic-provider.ts

@@ -12,6 +12,7 @@ export interface DiagnosticsChanged {
 export interface DiagnosticProvider {
   readonly id: string;
   readonly diagnosticsChanged$: Observable<DiagnosticsChanged>;
+  init(): Promise<void>;
   getDiagnostics(uri: string): Promise<Diagnostic[]>;
   getDiagnosticFixes(uri: string, diagnostic: Diagnostic): Promise<DiagnosticFix[]>;
 }

packages/core/src/formatting/on-type-formatting-provider.ts

@@ -6,5 +6,6 @@ export interface OnTypeFormattingProvider {
 
   readonly onTypeTriggerCharacters: ReadonlySet<string>;
 
+  init(): Promise<void>;
   getOnTypeEdits(uri: string, position: Position, ch: string): Promise<TextEdit[] | undefined>;
 }

packages/core/src/workspace/index.ts

@@ -1,2 +1,3 @@
+export { Localizer } from './localizer';
 export type { WorkspaceConfig } from './workspace';
 export { Workspace } from './workspace';

packages/core/src/workspace/localizer.ts

@@ -0,0 +1,69 @@
+import i18next, { i18n } from 'i18next';
+
+export class Localizer {
+  private readonly i18n: i18n;
+  private readonly backend: LocalBackend;
+
+  constructor(language?: string) {
+    this.backend = new LocalBackend();
+    this.i18n = i18next
+      .createInstance({
+        lng: language,
+        fallbackLng: 'en',
+        partialBundledLanguages: true,
+        ns: [],
+        resources: {},
+      })
+      .use(this.backend);
+  }
+
+  get language(): string {
+    return this.i18n.language;
+  }
+
+  async init(): Promise<void> {
+    await this.i18n.init();
+  }
+
+  async addNamespace(namespace: string, loader: (language: string) => Promise<unknown>): Promise<void> {
+    if (this.i18n.hasLoadedNamespace(namespace)) {
+      return;
+    }
+    this.backend.addNamespace(namespace, loader);
+    await this.i18n.loadNamespaces(namespace);
+  }
+
+  async changeLanguage(language: string): Promise<void> {
+    await this.i18n.changeLanguage(language);
+  }
+
+  t(key: string, options?: Record<string, string>): string {
+    return this.i18n.t(key, options);
+  }
+}
+
+class LocalBackend {
+  private readonly namespaceLoaders = new Map<string, (language: string) => Promise<unknown>>();
+  readonly type = 'backend';
+
+  init(_services: unknown, _backendOptions: unknown, _i18nextOptions: unknown): void {
+    // do nothing
+  }
+
+  addNamespace(namespace: string, loader: (language: string) => Promise<unknown>): void {
+    this.namespaceLoaders.set(namespace, loader);
+  }
+
+  read(language: string, namespace: string, callback: (err: unknown, data?: unknown) => void): void {
+    const loader = this.namespaceLoaders.get(namespace);
+    if (loader == null) {
+      callback(new Error(`No loader for namespace ${namespace}`));
+      return;
+    }
+    loader(language)
+      .then((data) => {
+        callback(null, data);
+      })
+      .catch(callback);
+  }
+}

packages/core/src/workspace/workspace.ts

@@ -6,20 +6,24 @@ import { Diagnostic } from '../diagnostic/diagnostic';
 import { DiagnosticFix } from '../diagnostic/diagnostic-fix';
 import { DiagnosticProvider, DiagnosticsChanged } from '../diagnostic/diagnostic-provider';
 import { OnTypeFormattingProvider } from '../formatting/on-type-formatting-provider';
+import { Localizer } from './localizer';
 
 export interface WorkspaceConfig {
+  localizer: Localizer;
   diagnosticProviders?: DiagnosticProvider[];
   onTypeFormattingProviders?: OnTypeFormattingProvider[];
 }
 
 export class Workspace {
+  private readonly localizer: Localizer;
   private readonly diagnosticProviders: Map<string, DiagnosticProvider>;
   private readonly onTypeFormattingProviders: Map<string, OnTypeFormattingProvider>;
   private readonly lastDiagnosticChangedEvents = new Map<string, DiagnosticsChanged[]>();
 
   public readonly diagnosticsChanged$: Observable<DiagnosticsChanged>;
 
   constructor(config: WorkspaceConfig) {
+    this.localizer = config.localizer;
     this.diagnosticProviders = new Map(config.diagnosticProviders?.map((provider) => [provider.id, provider]));
     this.diagnosticsChanged$ = merge(
       ...Array.from(this.diagnosticProviders.values()).map((provider, i) =>
@@ -35,6 +39,16 @@ export class Workspace {
     );
   }
 
+  async init(): Promise<void> {
+    await this.localizer.init();
+    await Promise.all(Array.from(this.diagnosticProviders.values()).map((provider) => provider.init()));
+    await Promise.all(Array.from(this.onTypeFormattingProviders.values()).map((provider) => provider.init()));
+  }
+
+  changeLanguage(language: string): Promise<void> {
+    return this.localizer.changeLanguage(language);
+  }
+
   async getDiagnostics(uri: string): Promise<Diagnostic[]> {
     const diagnostics: Diagnostic[] = [];
     for (const provider of this.diagnosticProviders.values()) {

packages/eslint-config/library.mjs

@@ -35,6 +35,7 @@ export default tseslint.config(
       '@typescript-eslint/no-unsafe-assignment': 'off',
       '@typescript-eslint/no-unsafe-return': 'off',
       '@typescript-eslint/no-unsafe-argument': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
     },
   },
   {

packages/examples/eslint.config.mjs

@@ -0,0 +1,12 @@
+import library from '@repo/eslint-config/library.mjs';
+
+export default [
+  {
+    languageOptions: {
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+  },
+  ...library,
+];

packages/examples/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@sillsdev/lynx-examples",
+  "version": "1.0.0",
+  "description": "",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "scripts": {
+    "build": "tsup-node src/index.ts --dts --format cjs,esm --clean --sourcemap",
+    "dev": "tsup-node src/index.ts --dts --format cjs,esm --watch --sourcemap",
+    "check-types": "tsc --noEmit",
+    "lint": "eslint .",
+    "test": "vitest",
+    "coverage": "vitest run --coverage"
+  },
+  "keywords": [],
+  "author": "SIL Global",
+  "license": "MIT",
+  "dependencies": {
+    "@sillsdev/lynx": "*"
+  },
+  "devDependencies": {
+    "@repo/eslint-config": "*",
+    "@repo/typescript-config": "*",
+    "@vitest/coverage-v8": "^2.1.4",
+    "eslint": "^9.9.1",
+    "tsup": "^8.3.0",
+    "typescript": "^5.5.4",
+    "vitest": "^2.1.4"
+  }
+}

packages/examples/src/index.ts

@@ -0,0 +1,2 @@
+export { SimpleQuoteFormattingProvider } from './simple-quote-formatting-provider';
+export { VerseOrderDiagnosticProvider } from './verse-order-diagnostic-provider';

packages/examples/src/locales/en/verse-order.json

@@ -0,0 +1,9 @@
+{
+  "missingVerse": {
+    "description": "Verse {{verse}} is missing from chapter {{chapter}}. Insert the missing verse to fix.",
+    "fixTitle": "Insert missing verse"
+  },
+  "verseOutOfOrder": {
+    "description": "Verse {{verse}} occurs out of order in chapter {{chapter}}."
+  }
+}

packages/examples/src/locales/es/verse-order.json

@@ -0,0 +1,9 @@
+{
+  "missingVerse": {
+    "description": "Falta el versículo {{verse}} del capítulo {{chapter}}. Inserta el versículo que falta para arreglarlo.",
+    "fixTitle": "Inserta el versículo que falta"
+  },
+  "verseOutOfOrder": {
+    "description": "El versículo {{verse}} aparece fuera de orden en el capítulo {{chapter}}."
+  }
+}

packages/vscode/src/smart-quote-formatting-provider.ts → packages/examples/src/simple-quote-formatting-provider.ts

@@ -1,11 +1,15 @@
 import { DocumentManager, OnTypeFormattingProvider, Position, TextDocument, TextEdit } from '@sillsdev/lynx';
 
-export class SmartQuoteFormattingProvider implements OnTypeFormattingProvider {
-  readonly id = 'smart-quote';
+export class SimpleQuoteFormattingProvider implements OnTypeFormattingProvider {
+  readonly id = 'simple-quote';
   readonly onTypeTriggerCharacters: ReadonlySet<string> = new Set(['"', '“', '”']);
 
   constructor(private readonly documentManager: DocumentManager<TextDocument>) {}
 
+  init(): Promise<void> {
+    return Promise.resolve();
+  }
+
   async getOnTypeEdits(uri: string, _position: Position, _ch: string): Promise<TextEdit[] | undefined> {
     const doc = await this.documentManager.get(uri);
     if (doc == null) {