@discord/intl-loader-core 0.2.0 → 0.2.1-canary.d971c43

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@discord/intl-loader-core",
-  "version": "0.2.0",
+  "version": "0.2.1-canary.d971c43",
   "license": "MIT",
   "description": "Core utilities for writing loaders and transformers using @discord/intl",
   "author": "Jon Egeland",
@@ -19,7 +19,7 @@
     "chokidar": "^3.6.0",
     "debug": "^4.3.6",
     "fast-glob": "^3.3.2",
-    "@discord/intl-message-database": "0.2.0"
+    "@discord/intl-message-database": "0.2.1-rc.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12"

package/src/transformer.js

@@ -28,8 +28,8 @@
  * const {i18n} = require('@discord/intl');
  * const _keys = ["a9fn23"];
  * const _locales = {"en-US": () => require('./messages/en-US.messages.json')};
- * const loader = createLoader(_keys, _locales);
- * export default loader.getBinds();
+ * export const messagesLoader = createLoader(_keys, _locales);
+ * export default messagesLoader.getBinds();
  * ```
  *
  * Notice how the message keys have been hashed into short keys, and the
@@ -43,6 +43,24 @@
  * import someModuleMessages from 'SomeModule.messages.js';
  * i18n.format(someModuleMessages["a9fn23"], {values: "i'm a value!"});
  * ```
+ *
+ * The transformed file also contains a named export for `messagesLoader`,
+ * which consumers can use to query and update the loading state for the
+ * messages managed by that loader, including waiting for a locale to be
+ * loaded, kicking off new loads, and more:
+ *
+ * ```typescript
+ * import {messagesLoader} from 'SomeModule.messages.js';
+ * // Wait for the loader to be initialized with default messages
+ * await messagesLoader.waitForDefaultLocaleLoaded();
+ * // Wait for a specific locale to load, starting the load if it
+ * // is not yet in progress.
+ * await messagesLoader.waitForLocaleLoaded('fr');
+ * // In hot-reloading environments, use the second `requireCurrent`
+ * // parameter to wait for the latest data, even if a value already
+ * // exists.
+ * const loaded = messagesLoader.isLocaleLoaded('fr', true);
+ * ```
  */
 class MessageDefinitionsTransformer {
   /**
@@ -50,6 +68,7 @@ class MessageDefinitionsTransformer {
    */
   constructor(options) {
     this.options = options;
+    this.loaderName = 'messagesLoader';
   }
 
   /**
@@ -87,7 +106,7 @@ class MessageDefinitionsTransformer {
     if (!this.options.debug) return [];
 
     return [
-      `loader.withDebugValues(${JSON.stringify(this.options.messageKeys)}, ${JSON.stringify(this.options.localeMap)})`,
+      `${this.loaderName}.withDebugValues(${JSON.stringify(this.options.messageKeys)}, ${JSON.stringify(this.options.localeMap)})`,
     ];
   }
 
@@ -105,9 +124,9 @@ class MessageDefinitionsTransformer {
       `const _keys = ${JSON.stringify(this.options.messageKeys)};`,
       `const _locales = ${this.getLocaleRequireMap()};`,
       `const _defaultLocale = ${JSON.stringify(this.options.defaultLocale)};`,
-      'const loader = createLoader(_keys, _locales, _defaultLocale);',
+      `export const ${this.loaderName} = createLoader(_keys, _locales, _defaultLocale);`,
       ...this.debugModeSetup(),
-      'export default loader.getBinds();',
+      `export default ${this.loaderName}.getBinds();`,
     ].join('\n');
   }
 }