@discord/intl-loader-core 0.10.4 → 0.11.1-rc.0

package/index.js

@@ -7,6 +7,8 @@ const {
 
 const { database } = require('./src/database');
 const {
+  findAllMessagesFiles,
+  processAllMessagesFiles,
   generateTypeDefinitions,
   processDefinitionsFile,
   processTranslationsFile,
@@ -31,5 +33,7 @@ module.exports = {
   processDefinitionsFile,
   processTranslationsFile,
   precompileFileForLocale,
+  findAllMessagesFiles,
+  processAllMessagesFiles,
   watcher,
 };

package/package.json

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

package/src/processing.js

@@ -15,7 +15,7 @@ const { findAllTranslationFiles, getLocaleFromTranslationsFileName } = require('
 
 /**
  * @param {string} sourcePath
- * @param {import('@discord/intl-message-database').IntlSourceFile} sourceFile
+ * @param {import('../types').IntlSourceFile} sourceFile
  */
 function debugSourceFile(sourcePath, sourceFile) {
   debug(
@@ -26,7 +26,7 @@ function debugSourceFile(sourcePath, sourceFile) {
 /**
  *
  * @param {string} sourcePath Path of the source file being processed, for debug logging
- * @param {import('@discord/intl-message-database').IntlSourceFile} sourceFile SourceFile object from the database used to find translations.
+ * @param {import('../types').IntlSourceFile} sourceFile SourceFile object from the database used to find translations.
  * @param {string} translationsPath Fully-resolved path to the directory for translations.
  * @returns {Record<string, string>}
  */
@@ -43,6 +43,33 @@ function buildTranslationsLocaleMap(sourcePath, sourceFile, translationsPath) {
   return map;
 }
 
+/**
+ * Scan the entire file system within the given `directories` to find all files that can be treated
+ * as messages definitions _or_ translations.
+ *
+ * @param {string[]} directories
+ * @param {string} defaultLocale
+ * @returns {import('../types').IntlMessagesFileDescriptor[]}
+ */
+function findAllMessagesFiles(directories, defaultLocale = 'en-US') {
+  return database.findAllMessagesFiles(directories, defaultLocale);
+}
+
+/**
+ * Iterate the given `files`, processing each one's content into the database. Processing is done
+ * in parallel using native acceleration, and returns the list of all file names that were used.
+ *
+ * Note that this method _only_ operates by reading file contents from the system, it is not
+ * possible to supply preloaded content through a Buffer in the same way as `processDefinitionsFile`
+ * with a `sourceContent` argument.
+ *
+ * @param {import('../types').IntlMessagesFileDescriptor[]} files
+ * @returns {string[]}
+ */
+function processAllMessagesFiles(files) {
+  return database.processAllMessagesFiles(files);
+}
+
 /**
  * @param {string} sourcePath
  * @param {string=} sourceContent
@@ -188,6 +215,8 @@ function generateTypeDefinitions(sourcePath, outputFile, allowNullability = fals
 }
 
 module.exports = {
+  findAllMessagesFiles,
+  processAllMessagesFiles,
   generateTypeDefinitions,
   precompileFileForLocale,
   processDefinitionsFile,

package/types/index.d.ts

@@ -10,5 +10,7 @@ import { isMessageTranslationsFile } from "@discord/intl-message-database";
 import { processDefinitionsFile } from "./src/processing";
 import { processTranslationsFile } from "./src/processing";
 import { precompileFileForLocale } from "./src/processing";
+import { findAllMessagesFiles } from "./src/processing";
+import { processAllMessagesFiles } from "./src/processing";
 import watcher = require("./src/watcher");
-export { IntlCompiledMessageFormat, MessageDefinitionsTransformer, database, findAllTranslationFiles, getLocaleFromTranslationsFileName, generateTypeDefinitions, hashMessageKey, isMessageDefinitionsFile, isMessageTranslationsFile, processDefinitionsFile, processTranslationsFile, precompileFileForLocale, watcher };
+export { IntlCompiledMessageFormat, MessageDefinitionsTransformer, database, findAllTranslationFiles, getLocaleFromTranslationsFileName, generateTypeDefinitions, hashMessageKey, isMessageDefinitionsFile, isMessageTranslationsFile, processDefinitionsFile, processTranslationsFile, precompileFileForLocale, findAllMessagesFiles, processAllMessagesFiles, watcher };

package/types/src/processing.d.ts

@@ -2,6 +2,27 @@ export type IntlPrecompileOptions = {
     format?: IntlCompiledMessageFormat;
     bundleSecrets?: boolean;
 };
+/**
+ * Scan the entire file system within the given `directories` to find all files that can be treated
+ * as messages definitions _or_ translations.
+ *
+ * @param {string[]} directories
+ * @param {string} defaultLocale
+ * @returns {import('../types').IntlMessagesFileDescriptor[]}
+ */
+export function findAllMessagesFiles(directories: string[], defaultLocale?: string): import("../types").IntlMessagesFileDescriptor[];
+/**
+ * Iterate the given `files`, processing each one's content into the database. Processing is done
+ * in parallel using native acceleration, and returns the list of all file names that were used.
+ *
+ * Note that this method _only_ operates by reading file contents from the system, it is not
+ * possible to supply preloaded content through a Buffer in the same way as `processDefinitionsFile`
+ * with a `sourceContent` argument.
+ *
+ * @param {import('../types').IntlMessagesFileDescriptor[]} files
+ * @returns {string[]}
+ */
+export function processAllMessagesFiles(files: import("../types").IntlMessagesFileDescriptor[]): string[];
 /**
  * Generate a `.d.ts` file containing TypeScript type definitions for all of the messages defined in
  * `sourcePath`. This method does not process `sourcePath` at all, meaning it expects the database