@vocab/core 1.2.0 → 1.2.1

package/dist/vocab-core.esm.js

@@ -84,11 +84,9 @@ function getAltLanguageFilePath(devLanguageFilePath, language) {
 function mapValues(obj, func) {
   const newObj = {};
   const keys = Object.keys(obj);
-
   for (const key of keys) {
     newObj[key] = func(obj[key]);
   }
-
   return newObj;
 }
 function getTranslationMessages(translations) {
@@ -102,60 +100,49 @@ function generateLanguageFromTranslations({
   if (!generator.transformElement && !generator.transformMessage) {
     return baseTranslations;
   }
-
   const translationKeys = Object.keys(baseTranslations);
   const generatedTranslations = {};
-
   for (const translationKey of translationKeys) {
     const translation = baseTranslations[translationKey];
     let transformedMessage = translation.message;
-
     if (generator.transformElement) {
       const messageAst = new IntlMessageFormat(translation.message).getAst();
       const transformedAst = messageAst.map(transformMessageFormatElement(generator.transformElement));
       transformedMessage = printAST(transformedAst);
     }
-
     if (generator.transformMessage) {
       transformedMessage = generator.transformMessage(transformedMessage);
     }
-
     generatedTranslations[translationKey] = {
       message: transformedMessage
     };
   }
-
   return generatedTranslations;
 }
-
 function transformMessageFormatElement(transformElement) {
   return messageFormatElement => {
-    const transformedMessageFormatElement = { ...messageFormatElement
+    const transformedMessageFormatElement = {
+      ...messageFormatElement
     };
-
     switch (transformedMessageFormatElement.type) {
       case TYPE.literal:
         const transformedValue = transformElement(transformedMessageFormatElement.value);
         transformedMessageFormatElement.value = transformedValue;
         break;
-
       case TYPE.select:
       case TYPE.plural:
-        const transformedOptions = { ...transformedMessageFormatElement.options
+        const transformedOptions = {
+          ...transformedMessageFormatElement.options
         };
-
         for (const key of Object.keys(transformedOptions)) {
           transformedOptions[key].value = transformedOptions[key].value.map(transformMessageFormatElement(transformElement));
         }
-
         break;
-
       case TYPE.tag:
         const transformedChildren = transformedMessageFormatElement.children.map(transformMessageFormatElement(transformElement));
         transformedMessageFormatElement.children = transformedChildren;
         break;
     }
-
     return transformedMessageFormatElement;
   };
 }
@@ -170,7 +157,6 @@ function mergeWithDevLanguageTranslation({
   // Only use keys from the dev translation
   const keys = Object.keys(devTranslation);
   const newLanguage = {};
-
   for (const key of keys) {
     if (translation[key]) {
       newLanguage[key] = {
@@ -179,24 +165,19 @@ function mergeWithDevLanguageTranslation({
       };
     }
   }
-
   return newLanguage;
 }
-
 function getLanguageFallbacks({
   languages
 }) {
   const languageFallbackMap = new Map();
-
   for (const lang of languages) {
     if (lang.extends) {
       languageFallbackMap.set(lang.name, lang.extends);
     }
   }
-
   return languageFallbackMap;
 }
-
 function getLanguageHierarchy({
   languages
 }) {
@@ -204,19 +185,15 @@ function getLanguageHierarchy({
   const fallbacks = getLanguageFallbacks({
     languages
   });
-
   for (const lang of languages) {
     const langHierarchy = [];
     let currLang = lang.extends;
-
     while (currLang) {
       langHierarchy.push(currLang);
       currLang = fallbacks.get(currLang);
     }
-
     hierarchyMap.set(lang.name, langHierarchy);
   }
-
   return hierarchyMap;
 }
 function getFallbackLanguageOrder({
@@ -228,41 +205,31 @@ function getFallbackLanguageOrder({
   const languageHierarchy = getLanguageHierarchy({
     languages
   }).get(languageName);
-
   if (!languageHierarchy) {
     throw new Error(`Missing language hierarchy for ${languageName}`);
   }
-
   const fallbackLanguageOrder = [languageName];
-
   if (fallbacks !== 'none') {
     fallbackLanguageOrder.unshift(...languageHierarchy.reverse());
-
     if (fallbacks === 'all' && fallbackLanguageOrder[0] !== devLanguage) {
       fallbackLanguageOrder.unshift(devLanguage);
     }
   }
-
   return fallbackLanguageOrder;
 }
-
 function getNamespaceByFilePath(relativePath, {
   translationsDirectorySuffix = defaultTranslationDirSuffix
 }) {
   let namespace = path.dirname(relativePath).replace(/^src\//, '').replace(/\//g, '_');
-
   if (namespace.endsWith(translationsDirectorySuffix)) {
     namespace = namespace.slice(0, -translationsDirectorySuffix.length);
   }
-
   return namespace;
 }
-
 function printValidationError(...params) {
   // eslint-disable-next-line no-console
   console.error(chalk.red('Error loading translation:'), ...params);
 }
-
 function getTranslationsFromFile(translationFileContents, {
   isAltLanguage,
   filePath,
@@ -271,29 +238,24 @@ function getTranslationsFromFile(translationFileContents, {
   if (!translationFileContents || typeof translationFileContents !== 'object') {
     throw new Error(`Unable to read translation file ${filePath}. Translations must be an object.`);
   }
-
   const {
     $namespace,
     _meta,
     ...keys
   } = translationFileContents;
-
   if (isAltLanguage && $namespace) {
     printValidationError(`Found $namespace in alt language file in ${filePath}. $namespace is only used in the dev language and will be ignored.`);
   }
-
   if (!isAltLanguage && $namespace && typeof $namespace !== 'string') {
     printValidationError(`Found non-string $namespace in language file in ${filePath}. $namespace must be a string.`);
   }
-
   if (isAltLanguage && _meta !== null && _meta !== void 0 && _meta.tags) {
     printValidationError(`Found _meta.tags in alt language file in ${filePath}. _meta.tags is only used in the dev language and will be ignored.`);
-  } // Never return tags if we're fetching translations for an alt language
-
+  }
 
+  // Never return tags if we're fetching translations for an alt language
   const includeTags = !isAltLanguage && withTags;
   const validKeys = {};
-
   for (const [translationKey, {
     tags,
     ...translation
@@ -302,22 +264,19 @@ function getTranslationsFromFile(translationFileContents, {
       printValidationError(`Found string for a translation "${translationKey}" in ${filePath}. Translation must be an object of the format {message: string}.`);
       continue;
     }
-
     if (!translation) {
       printValidationError(`Found empty translation "${translationKey}" in ${filePath}. Translation must be an object of the format {message: string}.`);
       continue;
     }
-
     if (!translation.message || typeof translation.message !== 'string') {
       printValidationError(`No message found for translation "${translationKey}" in ${filePath}. Translation must be an object of the format {message: string}.`);
       continue;
     }
-
-    validKeys[translationKey] = { ...translation,
+    validKeys[translationKey] = {
+      ...translation,
       tags: includeTags ? tags : undefined
     };
   }
-
   const metadata = {
     tags: includeTags ? _meta === null || _meta === void 0 ? void 0 : _meta.tags : undefined
   };
@@ -327,7 +286,6 @@ function getTranslationsFromFile(translationFileContents, {
     metadata
   };
 }
-
 function loadAltLanguageFile({
   filePath,
   languageName,
@@ -345,15 +303,12 @@ function loadAltLanguageFile({
     fallbacks
   });
   trace(`Loading alt language file with precedence: ${fallbackLanguageOrder.slice().reverse().join(' -> ')}`);
-
   for (const fallbackLanguage of fallbackLanguageOrder) {
     if (fallbackLanguage !== devLanguage) {
       try {
         const altFilePath = getAltLanguageFilePath(filePath, fallbackLanguage);
         delete require.cache[altFilePath];
-
         const translationFile = require(altFilePath);
-
         const {
           keys: fallbackLanguageTranslation
         } = getTranslationsFromFile(translationFile, {
@@ -372,17 +327,14 @@ function loadAltLanguageFile({
       Object.assign(altLanguageTranslation, devTranslation);
     }
   }
-
   return altLanguageTranslation;
 }
-
 function stripTagsFromTranslations(translations) {
   return Object.fromEntries(Object.entries(translations).map(([key, {
     tags,
     ...rest
   }]) => [key, rest]));
 }
-
 function loadTranslation({
   filePath,
   fallbacks,
@@ -391,9 +343,7 @@ function loadTranslation({
   trace(`Loading translation file in "${fallbacks}" fallback mode: "${filePath}"`);
   const languageSet = {};
   delete require.cache[filePath];
-
   const translationContent = require(filePath);
-
   const relativePath = path.relative(userConfig.projectRoot || process.cwd(), filePath);
   const {
     $namespace,
@@ -409,7 +359,6 @@ function loadTranslation({
   languageSet[userConfig.devLanguage] = devTranslation;
   const devTranslationNoTags = withTags ? stripTagsFromTranslations(devTranslation) : devTranslation;
   const altLanguages = getAltLanguages(userConfig);
-
   for (const languageName of altLanguages) {
     languageSet[languageName] = loadAltLanguageFile({
       filePath,
@@ -418,7 +367,6 @@ function loadTranslation({
       fallbacks
     }, userConfig);
   }
-
   for (const generatedLanguage of userConfig.generatedLanguages || []) {
     const {
       name: generatedLanguageName,
@@ -431,7 +379,6 @@ function loadTranslation({
       generator
     });
   }
-
   return {
     filePath,
     keys: Object.keys(devTranslation),
@@ -462,42 +409,33 @@ async function loadAllTranslations({
     withTags
   }, config)));
   const keys = new Set();
-
   for (const loadedTranslation of result) {
     for (const key of loadedTranslation.keys) {
       const uniqueKey = getUniqueKey(key, loadedTranslation.namespace);
-
       if (keys.has(uniqueKey)) {
         trace(`Duplicate keys found`);
         throw new Error(`Duplicate keys found. Key with namespace ${loadedTranslation.namespace} and key ${key} was found multiple times.`);
       }
-
       keys.add(uniqueKey);
     }
   }
-
   return result;
 }
 
 const encodeWithinSingleQuotes = v => v.replace(/'/g, "\\'");
-
 const encodeBackslash = v => v.replace(/\\/g, '\\\\');
-
 function extractHasTags(ast) {
   return ast.some(element => {
     if (isSelectElement(element)) {
       const children = Object.values(element.options).map(o => o.value);
       return children.some(child => extractHasTags(child));
     }
-
     return isTagElement(element);
   });
 }
-
 function extractParamTypes(ast) {
   let params = {};
   let imports = new Set();
-
   for (const element of ast) {
     if (isArgumentElement(element)) {
       params[element.value] = 'string';
@@ -505,6 +443,15 @@ function extractParamTypes(ast) {
       params[element.value] = 'number';
     } else if (isPluralElement(element)) {
       params[element.value] = 'number';
+      const children = Object.values(element.options).map(o => o.value);
+      for (const child of children) {
+        const [subParams, subImports] = extractParamTypes(child);
+        imports = new Set([...imports, ...subImports]);
+        params = {
+          ...params,
+          ...subParams
+        };
+      }
     } else if (isDateElement(element) || isTimeElement(element)) {
       params[element.value] = 'Date | number';
     } else if (isTagElement(element)) {
@@ -512,29 +459,27 @@ function extractParamTypes(ast) {
       imports.add(`import { FormatXMLElementFn } from '@vocab/types';`);
       const [subParams, subImports] = extractParamTypes(element.children);
       imports = new Set([...imports, ...subImports]);
-      params = { ...params,
+      params = {
+        ...params,
         ...subParams
       };
     } else if (isSelectElement(element)) {
       params[element.value] = Object.keys(element.options).map(o => `'${o}'`).join(' | ');
       const children = Object.values(element.options).map(o => o.value);
-
       for (const child of children) {
         const [subParams, subImports] = extractParamTypes(child);
         imports = new Set([...imports, ...subImports]);
-        params = { ...params,
+        params = {
+          ...params,
           ...subParams
         };
       }
     }
   }
-
   return [params, imports];
 }
-
 function serialiseObjectToType(v) {
   let result = '';
-
   for (const [key, value] of Object.entries(v)) {
     if (value && typeof value === 'object') {
       result += `'${encodeWithinSingleQuotes(key)}': ${serialiseObjectToType(value)},`;
@@ -542,32 +487,25 @@ function serialiseObjectToType(v) {
       result += `'${encodeWithinSingleQuotes(key)}': ${value},`;
     }
   }
-
   return `{ ${result} }`;
 }
-
 const banner = `// This file is automatically generated by Vocab.\n// To make changes update translation.json files directly.`;
-
 function serialiseTranslationRuntime(value, imports, loadedTranslation) {
   trace('Serialising translations:', loadedTranslation);
   const translationsType = {};
-
   for (const [key, {
     params,
     message,
     hasTags
   }] of value.entries()) {
     let translationFunctionString = `() => ${message}`;
-
     if (Object.keys(params).length > 0) {
       const formatGeneric = hasTags ? '<T = string>' : '';
       const formatReturn = hasTags ? 'string | T | Array<string | T>' : 'string';
       translationFunctionString = `${formatGeneric}(values: ${serialiseObjectToType(params)}) => ${formatReturn}`;
     }
-
     translationsType[encodeBackslash(key)] = translationFunctionString;
   }
-
   const content = Object.entries(loadedTranslation.languages).map(([languageName, translations]) => `'${encodeWithinSingleQuotes(languageName)}': createLanguage(${JSON.stringify(getTranslationMessages(translations))})`).join(',');
   const languagesUnionAsString = Object.keys(loadedTranslation.languages).map(l => `'${l}'`).join(' | ');
   return `${banner}
@@ -579,7 +517,6 @@ function serialiseTranslationRuntime(value, imports, loadedTranslation) {
 
   export default translations;`;
 }
-
 async function generateRuntime(loadedTranslation) {
   const {
     languages: loadedLanguages,
@@ -588,25 +525,23 @@ async function generateRuntime(loadedTranslation) {
   trace('Generating types for', filePath);
   const translationTypes = new Map();
   let imports = new Set();
-
   for (const key of loadedTranslation.keys) {
     let params = {};
     const messages = new Set();
     let hasTags = false;
-
     for (const translatedLanguage of Object.values(loadedLanguages)) {
       if (translatedLanguage[key]) {
         const ast = parse(translatedLanguage[key].message);
         hasTags = hasTags || extractHasTags(ast);
         const [parsedParams, parsedImports] = extractParamTypes(ast);
         imports = new Set([...imports, ...parsedImports]);
-        params = { ...params,
+        params = {
+          ...params,
           ...parsedParams
         };
         messages.add(`'${encodeWithinSingleQuotes(translatedLanguage[key].message)}'`);
       }
     }
-
     const returnType = hasTags ? 'NonNullable<ReactNode>' : 'string';
     translationTypes.set(key, {
       params,
@@ -615,10 +550,10 @@ async function generateRuntime(loadedTranslation) {
       returnType
     });
   }
-
   const prettierConfig = await prettier.resolveConfig(filePath);
   const serializedTranslationType = serialiseTranslationRuntime(translationTypes, imports, loadedTranslation);
-  const declaration = prettier.format(serializedTranslationType, { ...prettierConfig,
+  const declaration = prettier.format(serializedTranslationType, {
+    ...prettierConfig,
     parser: 'typescript'
   });
   const outputFilePath = getTSFileFromDevLanguageFile(filePath);
@@ -632,17 +567,14 @@ function watch(config) {
     ignored: config.ignore ? [...config.ignore, '**/node_modules/**'] : ['**/node_modules/**'],
     ignoreInitial: true
   });
-
   const onTranslationChange = async relativePath => {
     trace(`Detected change for file ${relativePath}`);
     let targetFile;
-
     if (isDevLanguageFile(relativePath)) {
       targetFile = path.resolve(cwd, relativePath);
     } else if (isAltLanguageFile(relativePath)) {
       targetFile = getDevLanguageFileFromAltLanguageFile(path.resolve(cwd, relativePath));
     }
-
     if (targetFile) {
       try {
         const loadedTranslation = loadTranslation({
@@ -652,23 +584,19 @@ function watch(config) {
         await generateRuntime(loadedTranslation);
       } catch (e) {
         // eslint-disable-next-line no-console
-        console.log('Failed to generate types for', relativePath); // eslint-disable-next-line no-console
-
+        console.log('Failed to generate types for', relativePath);
+        // eslint-disable-next-line no-console
         console.error(e);
       }
     }
   };
-
   const onNewDirectory = async relativePath => {
     trace('Detected new directory', relativePath);
-
     if (!isTranslationDirectory(relativePath, config)) {
       trace('Ignoring non-translation directory:', relativePath);
       return;
     }
-
     const newFilePath = path.join(relativePath, devTranslationFileName);
-
     if (!existsSync(newFilePath)) {
       await promises.writeFile(newFilePath, JSON.stringify({}, null, 2));
       trace('Created new empty translation file:', newFilePath);
@@ -676,7 +604,6 @@ function watch(config) {
       trace(`New directory already contains translation file. Skipping creation. Existing file ${newFilePath}`);
     }
   };
-
   watcher.on('addDir', onNewDirectory);
   watcher.on('add', onTranslationChange).on('change', onTranslationChange);
   return () => watcher.close();
@@ -688,28 +615,24 @@ async function compile({
     fallbacks: 'all',
     includeNodeModules: false
   }, config);
-
   for (const loadedTranslation of translations) {
     await generateRuntime(loadedTranslation);
   }
-
   if (shouldWatch) {
     trace('Listening for changes to files...');
     return watch(config);
   }
 }
-
 async function writeIfChanged(filepath, contents) {
   let hasChanged = true;
-
   try {
     const existingContents = await promises.readFile(filepath, {
       encoding: 'utf-8'
     });
     hasChanged = existingContents !== contents;
-  } catch (e) {// ignore error, likely a file doesn't exist error so we want to write anyway
+  } catch (e) {
+    // ignore error, likely a file doesn't exist error so we want to write anyway
   }
-
   if (hasChanged) {
     await promises.writeFile(filepath, contents, {
       encoding: 'utf-8'
@@ -720,36 +643,28 @@ async function writeIfChanged(filepath, contents) {
 /* eslint-disable no-console */
 function findMissingKeys(loadedTranslation, devLanguageName, altLanguages) {
   const devLanguage = loadedTranslation.languages[devLanguageName];
-
   if (!devLanguage) {
     throw new Error(`Failed to load dev language: ${loadedTranslation.filePath}`);
   }
-
   const result = {};
   let valid = true;
   const requiredKeys = Object.keys(devLanguage);
-
   if (requiredKeys.length > 0) {
     for (const altLanguageName of altLanguages) {
       var _loadedTranslation$la;
-
       const altLanguage = (_loadedTranslation$la = loadedTranslation.languages[altLanguageName]) !== null && _loadedTranslation$la !== void 0 ? _loadedTranslation$la : {};
-
       for (const key of requiredKeys) {
         var _altLanguage$key;
-
         if (typeof ((_altLanguage$key = altLanguage[key]) === null || _altLanguage$key === void 0 ? void 0 : _altLanguage$key.message) !== 'string') {
           if (!result[altLanguageName]) {
             result[altLanguageName] = [];
           }
-
           result[altLanguageName].push(key);
           valid = false;
         }
       }
     }
   }
-
   return [valid, result];
 }
 async function validate(config) {
@@ -758,21 +673,17 @@ async function validate(config) {
     includeNodeModules: true
   }, config);
   let valid = true;
-
   for (const loadedTranslation of allTranslations) {
     const [translationValid, result] = findMissingKeys(loadedTranslation, config.devLanguage, getAltLanguages(config));
-
     if (!translationValid) {
       valid = false;
       console.log(chalk.red`Incomplete translations: "${chalk.bold(loadedTranslation.relativePath)}"`);
-
       for (const lang of Object.keys(result)) {
         const missingKeys = result[lang];
         console.log(chalk.yellow(lang), '->', missingKeys.map(v => `"${v}"`).join(', '));
       }
     }
   }
-
   return valid;
 }
 
@@ -782,7 +693,6 @@ class ValidationError extends Error {
     this.code = code;
     this.rawMessage = message;
   }
-
 }
 
 const validator = new Validator();
@@ -850,75 +760,63 @@ const schema = {
   }
 };
 const checkConfigFile = validator.compile(schema);
-
 const splitMap = (message, callback) => message.split(' ,').map(v => callback(v)).join(' ,');
-
 function validateConfig(c) {
-  trace('Validating configuration file'); // Note: checkConfigFile mutates the config file by applying defaults
-
+  trace('Validating configuration file');
+  // Note: checkConfigFile mutates the config file by applying defaults
   const isValid = checkConfigFile(c);
-
   if (isValid !== true) {
     throw new ValidationError('InvalidStructure', (Array.isArray(isValid) ? isValid : []).map(v => {
       if (v.type === 'objectStrict') {
         return `Invalid key(s) ${splitMap(v.actual, m => `"${chalk.cyan(m)}"`)}. Expected one of ${splitMap(v.expected, chalk.green)}`;
       }
-
       if (v.field) {
         var _v$message;
-
         return (_v$message = v.message) === null || _v$message === void 0 ? void 0 : _v$message.replace(v.field, chalk.cyan(v.field));
       }
-
       return v.message;
     }).join(' \n'));
   }
+  const languageStrings = c.languages.map(v => v.name);
 
-  const languageStrings = c.languages.map(v => v.name); // Dev Language should exist in languages
-
+  // Dev Language should exist in languages
   if (!languageStrings.includes(c.devLanguage)) {
     throw new ValidationError('InvalidDevLanguage', `The dev language "${chalk.bold.cyan(c.devLanguage)}" was not found in languages ${languageStrings.join(', ')}.`);
   }
-
   const foundLanguages = [];
-
   for (const lang of c.languages) {
     // Languages must only exist once
     if (foundLanguages.includes(lang.name)) {
       throw new ValidationError('DuplicateLanguage', `The language "${chalk.bold.cyan(lang.name)}" was defined multiple times.`);
     }
+    foundLanguages.push(lang.name);
 
-    foundLanguages.push(lang.name); // Any extends must be in languages
-
+    // Any extends must be in languages
     if (lang.extends && !languageStrings.includes(lang.extends)) {
       throw new ValidationError('InvalidExtends', `The language "${chalk.bold.cyan(lang.name)}"'s extends of ${chalk.bold.cyan(lang.extends)} was not found in languages ${languageStrings.join(', ')}.`);
     }
   }
-
   const foundGeneratedLanguages = [];
-
   for (const generatedLang of c.generatedLanguages || []) {
     // Generated languages must only exist once
     if (foundGeneratedLanguages.includes(generatedLang.name)) {
       throw new ValidationError('DuplicateGeneratedLanguage', `The generated language "${chalk.bold.cyan(generatedLang.name)}" was defined multiple times.`);
     }
+    foundGeneratedLanguages.push(generatedLang.name);
 
-    foundGeneratedLanguages.push(generatedLang.name); // Generated language names must not conflict with language names
-
+    // Generated language names must not conflict with language names
     if (languageStrings.includes(generatedLang.name)) {
       throw new ValidationError('InvalidGeneratedLanguage', `The generated language "${chalk.bold.cyan(generatedLang.name)}" is already defined as a language.`);
-    } // Any extends must be in languages
-
+    }
 
+    // Any extends must be in languages
     if (generatedLang.extends && !languageStrings.includes(generatedLang.extends)) {
       throw new ValidationError('InvalidExtends', `The generated language "${chalk.bold.cyan(generatedLang.name)}"'s extends of ${chalk.bold.cyan(generatedLang.extends)} was not found in languages ${languageStrings.join(', ')}.`);
     }
   }
-
   trace('Configuration file is valid');
   return true;
 }
-
 function createConfig(configFilePath) {
   const cwd = path.dirname(configFilePath);
   return {
@@ -926,26 +824,21 @@ function createConfig(configFilePath) {
     ...require(configFilePath)
   };
 }
-
 async function resolveConfig(customConfigFilePath) {
   const configFilePath = customConfigFilePath ? path.resolve(customConfigFilePath) : await findUp('vocab.config.js');
-
   if (configFilePath) {
     trace(`Resolved configuration file to ${configFilePath}`);
     return createConfig(configFilePath);
   }
-
   trace('No configuration file found');
   return null;
 }
 function resolveConfigSync(customConfigFilePath) {
   const configFilePath = customConfigFilePath ? path.resolve(customConfigFilePath) : findUp.sync('vocab.config.js');
-
   if (configFilePath) {
     trace(`Resolved configuration file to ${configFilePath}`);
     return createConfig(configFilePath);
   }
-
   trace('No configuration file found');
   return null;
 }