@discord/intl-loader-core 0.11.5 → 0.12.0

package/index.js

@@ -7,7 +7,9 @@ const {
 
 const { database } = require('./src/database');
 const {
+  findAllDefinitionsFilesForTranslations,
   findAllMessagesFiles,
+  filterAllMessagesFiles,
   processAllMessagesFiles,
   generateTypeDefinitions,
   processDefinitionsFile,
@@ -25,6 +27,7 @@ module.exports = {
   MessageDefinitionsTransformer,
   database,
   findAllTranslationFiles,
+  findAllDefinitionsFilesForTranslations,
   getLocaleFromTranslationsFileName,
   generateTypeDefinitions,
   hashMessageKey,
@@ -34,6 +37,7 @@ module.exports = {
   processTranslationsFile,
   precompileFileForLocale,
   findAllMessagesFiles,
+  filterAllMessagesFiles,
   processAllMessagesFiles,
   watcher,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@discord/intl-loader-core",
-  "version": "0.11.5",
+  "version": "0.12.0",
   "license": "MIT",
   "description": "Core utilities for writing loaders and transformers using @discord/intl",
   "author": "Jon Egeland",
@@ -28,7 +28,7 @@
   "dependencies": {
     "chokidar": "^3.6.0",
     "debug": "^4.3.6",
-    "@discord/intl-message-database": "0.11.5"
+    "@discord/intl-message-database": "0.12.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",

package/src/processing.js

@@ -43,6 +43,33 @@ function buildTranslationsLocaleMap(sourcePath, sourceFile, translationsPath) {
   return map;
 }
 
+/**
+ * Return file paths for all definitions files with a translations path meta value that would
+ * include the given `translationPath`. This can be used to add reverse dependencies, and safely
+ * cache translations files with appropriate change detection.
+ *
+ * Note that this process is _only_ accurate if the database has full knowledge of all messages
+ * files that exist in the project, which can be guaranteed by running `findAllMessagesFiles` and
+ * `processAllMessagesFiles` beforehand. In most cases, this is suitable to do only once when a
+ * loader process is initializing.
+ *
+ * @param {string} filePath
+ * @returns {string[]}
+ */
+function findAllDefinitionsFilesForTranslations(filePath) {
+  const expectedTranslationsPath = path.dirname(filePath);
+  const sourceFiles = database.getAllSourceFilePaths();
+  const relevantPaths = [];
+  for (const file of sourceFiles) {
+    const source = database.getSourceFile(file);
+    if (source.type === 'definition' && source.meta.translationsPath === expectedTranslationsPath) {
+      console.log(file, source.meta);
+      relevantPaths.push(source.file);
+    }
+  }
+  return relevantPaths;
+}
+
 /**
  * Scan the entire file system within the given `directories` to find all files that can be treated
  * as messages definitions _or_ translations.
@@ -54,6 +81,7 @@ function buildTranslationsLocaleMap(sourcePath, sourceFile, translationsPath) {
 function findAllMessagesFiles(directories, defaultLocale = 'en-US') {
   return database.findAllMessagesFiles(directories, defaultLocale);
 }
+
 /**
  * Given an arbitrary list of `files`, keep only those that can be treated as messages files, either
  * definitions or translations. The returned list is a set of descriptors that can be processed by
@@ -228,6 +256,7 @@ function generateTypeDefinitions(sourcePath, outputFile, allowNullability = fals
 }
 
 module.exports = {
+  findAllDefinitionsFilesForTranslations,
   findAllMessagesFiles,
   filterAllMessagesFiles,
   processAllMessagesFiles,

package/types/index.d.ts

@@ -2,6 +2,7 @@ import { IntlCompiledMessageFormat } from "@discord/intl-message-database";
 import { MessageDefinitionsTransformer } from "./src/transformer";
 import { database } from "./src/database";
 import { findAllTranslationFiles } from "./src/util";
+import { findAllDefinitionsFilesForTranslations } from "./src/processing";
 import { getLocaleFromTranslationsFileName } from "./src/util";
 import { generateTypeDefinitions } from "./src/processing";
 import { hashMessageKey } from "@discord/intl-message-database";
@@ -11,6 +12,7 @@ import { processDefinitionsFile } from "./src/processing";
 import { processTranslationsFile } from "./src/processing";
 import { precompileFileForLocale } from "./src/processing";
 import { findAllMessagesFiles } from "./src/processing";
+import { filterAllMessagesFiles } 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, findAllMessagesFiles, processAllMessagesFiles, watcher };
+export { IntlCompiledMessageFormat, MessageDefinitionsTransformer, database, findAllTranslationFiles, findAllDefinitionsFilesForTranslations, getLocaleFromTranslationsFileName, generateTypeDefinitions, hashMessageKey, isMessageDefinitionsFile, isMessageTranslationsFile, processDefinitionsFile, processTranslationsFile, precompileFileForLocale, findAllMessagesFiles, filterAllMessagesFiles, processAllMessagesFiles, watcher };

package/types/src/processing.d.ts

@@ -2,6 +2,20 @@ export type IntlPrecompileOptions = {
     format?: IntlCompiledMessageFormat;
     bundleSecrets?: boolean;
 };
+/**
+ * Return file paths for all definitions files with a translations path meta value that would
+ * include the given `translationPath`. This can be used to add reverse dependencies, and safely
+ * cache translations files with appropriate change detection.
+ *
+ * Note that this process is _only_ accurate if the database has full knowledge of all messages
+ * files that exist in the project, which can be guaranteed by running `findAllMessagesFiles` and
+ * `processAllMessagesFiles` beforehand. In most cases, this is suitable to do only once when a
+ * loader process is initializing.
+ *
+ * @param {string} filePath
+ * @returns {string[]}
+ */
+export function findAllDefinitionsFilesForTranslations(filePath: string): string[];
 /**
  * Scan the entire file system within the given `directories` to find all files that can be treated
  * as messages definitions _or_ translations.