@vocab/core 1.0.3 → 1.1.1

package/src/load-translations.ts

@@ -1,317 +0,0 @@
-import path from 'path';
-
-import glob from 'fast-glob';
-import {
-  TranslationsByKey,
-  UserConfig,
-  LoadedTranslation,
-  LanguageTarget,
-  LanguageName,
-} from '@vocab/types';
-import chalk from 'chalk';
-
-import { trace } from './logger';
-import {
-  defaultTranslationDirSuffix,
-  Fallback,
-  getAltLanguageFilePath,
-  getAltLanguages,
-  getDevTranslationFileGlob,
-} from './utils';
-
-export function getUniqueKey(key: string, namespace: string) {
-  return `${key}.${namespace}`;
-}
-
-function mergeWithDevLanguage(
-  translation: TranslationsByKey,
-  devTranslation: TranslationsByKey,
-) {
-  // Only use keys from the dev translation
-  const keys = Object.keys(devTranslation);
-  const newLanguage: TranslationsByKey = {};
-  for (const key of keys) {
-    if (translation[key]) {
-      newLanguage[key] = {
-        message: translation[key].message,
-        description: devTranslation[key].description,
-      };
-    }
-  }
-  return newLanguage;
-}
-
-function getLanguageFallbacks({
-  languages,
-}: {
-  languages: Array<LanguageTarget>;
-}) {
-  const languageFallbackMap = new Map<LanguageName, LanguageName>();
-
-  for (const lang of languages) {
-    if (lang.extends) {
-      languageFallbackMap.set(lang.name, lang.extends);
-    }
-  }
-
-  return languageFallbackMap;
-}
-
-export function getLanguageHierarcy({
-  languages,
-}: {
-  languages: Array<LanguageTarget>;
-}) {
-  const hierarchyMap = new Map<LanguageName, Array<LanguageName>>();
-  const fallbacks = getLanguageFallbacks({ languages });
-
-  for (const lang of languages) {
-    const langHierachy = [];
-
-    let currLang = lang.extends;
-
-    while (currLang) {
-      langHierachy.push(currLang);
-
-      currLang = fallbacks.get(currLang);
-    }
-
-    hierarchyMap.set(lang.name, langHierachy);
-  }
-
-  return hierarchyMap;
-}
-
-function getNamespaceByFilePath(
-  relativePath: string,
-  { translationsDirectorySuffix = defaultTranslationDirSuffix }: UserConfig,
-) {
-  let namespace = path
-    .dirname(relativePath)
-    .replace(/^src\//, '')
-    .replace(/\//g, '_');
-
-  if (namespace.endsWith(translationsDirectorySuffix)) {
-    namespace = namespace.slice(0, -translationsDirectorySuffix.length);
-  }
-
-  return namespace;
-}
-
-function printValidationError(...params: unknown[]) {
-  // eslint-disable-next-line no-console
-  console.error(chalk.red('Error loading translation:'), ...params);
-}
-
-function getTranslationsFromFile(
-  translations: unknown,
-  { isAltLanguage, filePath }: { isAltLanguage: boolean; filePath: string },
-): { $namespace: unknown; keys: TranslationsByKey } {
-  if (!translations || typeof translations !== 'object') {
-    throw new Error(
-      `Unable to read translation file ${filePath}. Translations must be an object`,
-    );
-  }
-  const { $namespace, ...keys } = translations as TranslationsByKey;
-  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.`,
-    );
-  }
-  const validKeys: TranslationsByKey = {};
-  for (const [translationKey, translation] of Object.entries(keys)) {
-    if (typeof translation === 'string') {
-      printValidationError(
-        `Found string for a translation "${translationKey}" in ${filePath}. Translation must be an object of the format {mesage: string}.`,
-      );
-      continue;
-    }
-    if (!translation) {
-      printValidationError(
-        `Found empty translation "${translationKey}" in ${filePath}. Translation must be an object of the format {mesage: 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 {mesage: string}.`,
-      );
-      continue;
-    }
-    validKeys[translationKey] = translation;
-  }
-  return { $namespace, keys: validKeys };
-}
-
-function loadAltLanguageFile(
-  {
-    filePath,
-    languageName,
-    devTranslation,
-    fallbacks,
-  }: {
-    filePath: string;
-    languageName: string;
-    devTranslation: TranslationsByKey;
-    fallbacks: Fallback;
-  },
-  { devLanguage, languages }: UserConfig,
-): TranslationsByKey {
-  const result = {};
-
-  const languageHierarchy = getLanguageHierarcy({ languages }).get(
-    languageName,
-  );
-
-  if (!languageHierarchy) {
-    throw new Error(`Missing language hierarchy for ${languageName}`);
-  }
-
-  const fallbackLanguages: Array<string> = [languageName];
-
-  if (fallbacks !== 'none') {
-    fallbackLanguages.unshift(...languageHierarchy);
-
-    if (fallbacks === 'all' && fallbackLanguages[0] !== devLanguage) {
-      fallbackLanguages.unshift(devLanguage);
-    }
-  }
-
-  trace(
-    `Loading alt language file with precendence: ${fallbackLanguages
-      .slice()
-      .reverse()
-      .join(' -> ')}`,
-  );
-
-  for (const fallbackLang of fallbackLanguages) {
-    if (fallbackLang !== devLanguage) {
-      try {
-        const altFilePath = getAltLanguageFilePath(filePath, fallbackLang);
-        delete require.cache[altFilePath];
-
-        const translationFile = require(altFilePath);
-        const { keys } = getTranslationsFromFile(translationFile, {
-          filePath: altFilePath,
-          isAltLanguage: true,
-        });
-        Object.assign(result, mergeWithDevLanguage(keys, devTranslation));
-      } catch (e) {
-        trace(`Missing alt language file ${getAltLanguageFilePath(
-          filePath,
-          fallbackLang,
-        )}
-        `);
-      }
-    } else {
-      Object.assign(result, devTranslation);
-    }
-  }
-
-  return result;
-}
-
-export function loadTranslation(
-  {
-    filePath,
-    fallbacks,
-  }: {
-    filePath: string;
-    fallbacks: Fallback;
-  },
-  userConfig: UserConfig,
-): LoadedTranslation {
-  trace(
-    `Loading translation file in "${fallbacks}" fallback mode: "${filePath}"`,
-  );
-
-  const languageSet: Record<
-    string,
-    Record<string, { message: string; description?: string | undefined }>
-  > = {};
-
-  delete require.cache[filePath];
-  const translationContent = require(filePath);
-  const relativePath = path.relative(
-    userConfig.projectRoot || process.cwd(),
-    filePath,
-  );
-  const { $namespace, keys: devTranslation } = getTranslationsFromFile(
-    translationContent,
-    {
-      filePath,
-      isAltLanguage: false,
-    },
-  );
-  const namespace: string =
-    typeof $namespace === 'string'
-      ? $namespace
-      : getNamespaceByFilePath(relativePath, userConfig);
-
-  trace(`Found file ${filePath}. Using namespace ${namespace}`);
-
-  languageSet[userConfig.devLanguage] = devTranslation;
-  const altLanguages = getAltLanguages(userConfig);
-  for (const languageName of altLanguages) {
-    languageSet[languageName] = loadAltLanguageFile(
-      {
-        filePath,
-        languageName,
-        devTranslation,
-        fallbacks,
-      },
-      userConfig,
-    );
-  }
-
-  return {
-    filePath,
-    keys: Object.keys(devTranslation),
-    namespace,
-    relativePath,
-    languages: languageSet,
-  };
-}
-
-export async function loadAllTranslations(
-  {
-    fallbacks,
-    includeNodeModules,
-  }: { fallbacks: Fallback; includeNodeModules: boolean },
-  config: UserConfig,
-): Promise<Array<LoadedTranslation>> {
-  const { projectRoot, ignore = [] } = config;
-
-  const translationFiles = await glob(getDevTranslationFileGlob(config), {
-    ignore: includeNodeModules ? ignore : [...ignore, '**/node_modules/**'],
-    absolute: true,
-    cwd: projectRoot,
-  });
-
-  trace(`Found ${translationFiles.length} translation files`);
-
-  const result = await Promise.all(
-    translationFiles.map((filePath) =>
-      loadTranslation({ filePath, fallbacks }, 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;
-}

package/src/logger.ts

@@ -1,9 +0,0 @@
-import chalk from 'chalk';
-import debug from 'debug';
-
-export const trace = debug(`vocab:core`);
-
-export const log = (...params: unknown[]) => {
-  // eslint-disable-next-line no-console
-  console.log(chalk.yellow('Vocab'), ...params);
-};

package/src/runtime.test.ts

@@ -1,153 +0,0 @@
-import { FormatXMLElementFn } from 'intl-messageformat';
-import { createTranslationFile, createLanguage } from './runtime';
-
-const createDemoTranslationFile = () =>
-  createTranslationFile<
-    'en' | 'fr',
-    {
-      vocabPublishDate: <T = string>(values: {
-        publishDate: Date | number;
-      }) => string | T | Array<string | T>;
-    }
-  >({
-    en: createLanguage({
-      vocabPublishDate: 'Vocab was published on {publishDate, date, small}',
-    }),
-    fr: createLanguage({
-      vocabPublishDate: 'Vocab a été publié le {publishDate, date, medium}',
-    }),
-  });
-const createDemoTranslationFileWithTag = () =>
-  createTranslationFile<
-    'en' | 'fr',
-    {
-      vocabPublishDate: <T = string>(values: {
-        link: FormatXMLElementFn<T>;
-        strong: FormatXMLElementFn<T>;
-      }) => string | T | Array<string | T>;
-    }
-  >({
-    en: createLanguage({
-      vocabPublishDate: '<link><strong>Vocab</strong> is awesome</link>!',
-    }),
-    fr: createLanguage({
-      vocabPublishDate: '<link><strong>Vocab</strong> est génial</link>!',
-    }),
-  });
-
-describe('createTranslationFile', () => {
-  it('should return translations as a promise', async () => {
-    const translations = createDemoTranslationFile();
-    const translationModule = await translations.getMessages('en');
-    expect(
-      translationModule?.vocabPublishDate.format({
-        publishDate: 1605847714000,
-      }),
-    ).toBe('Vocab was published on 11/20/2020');
-  });
-  it('should return TranslationModules with language as locale', () => {
-    const translations = createDemoTranslationFile();
-    const translationModule = translations.getLoadedMessages('en');
-    expect(
-      translationModule?.vocabPublishDate.format({
-        publishDate: 1605847714000,
-      }),
-    ).toBe('Vocab was published on 11/20/2020');
-  });
-
-  // Support for alternative ICU locales in Node not available in current CI environment
-  // Disabling test for now until `full-icu` can be added. See https://nodejs.org/api/intl.html#intl_options_for_building_node_js
-  // eslint-disable-next-line jest/no-disabled-tests
-  it.skip('should return TranslationModules with en-AU locale', () => {
-    const translations = createDemoTranslationFile();
-    const translationModule = translations.getLoadedMessages('en', 'en-AU');
-    expect(
-      translationModule?.vocabPublishDate.format({
-        publishDate: 1605847714000,
-      }),
-    ).toBe('Vocab was published on 20/11/2020');
-  });
-  it('should return an array when tags return objects', () => {
-    const translations = createDemoTranslationFileWithTag();
-    const translationModule = translations.getLoadedMessages('en', 'en-US');
-    interface TagResult {
-      type: string;
-      children: unknown;
-    }
-    type ExpectedResultType = string | TagResult | Array<string | TagResult>;
-    if (!translationModule) {
-      throw new Error('no translationModule');
-    }
-    const result = translationModule.vocabPublishDate.format<TagResult>({
-      strong: (children) => ({
-        type: 'strong',
-        children,
-      }),
-      link: (children) => ({
-        type: 'link',
-        children,
-      }),
-    });
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const _unused: ExpectedResultType = result;
-    expect(result).toEqual(expect.any(Array));
-    expect(result).toEqual([
-      {
-        children: [{ children: ['Vocab'], type: 'strong' }, ' is awesome'],
-        type: 'link',
-      },
-      '!',
-    ]);
-  });
-  it('should return a string when all tags return strings', () => {
-    const translations = createDemoTranslationFileWithTag();
-    const translationModule = translations.getLoadedMessages('en', 'en-US');
-    type ExpectedResultType = string | Array<string>;
-    if (!translationModule) {
-      throw new Error('no translationModule');
-    }
-    const result = translationModule.vocabPublishDate.format({
-      strong: (children) => `*${children}*`,
-      link: (children) => `[${children}]()`,
-    });
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const _unused: ExpectedResultType = result;
-    expect(typeof result).toBe('string');
-    expect(result).toBe('[*Vocab* is awesome]()!');
-  });
-  it('should return TranslationModules with en-US locale', () => {
-    const translations = createDemoTranslationFile();
-    const translationModule = translations.getLoadedMessages('en', 'en-US');
-    if (!translationModule) {
-      throw new Error('no translationModule');
-    }
-    const result = translationModule.vocabPublishDate.format({
-      publishDate: 1605847714000,
-    });
-    expect(result).toBe('Vocab was published on 11/20/2020');
-  });
-  it('should require parameters to be passed in', () => {
-    const translations = createDemoTranslationFile();
-    const translationModule = translations.getLoadedMessages('en');
-    expect(() => {
-      // @ts-expect-error Incorrect params parameter
-      const result = translationModule?.vocabPublishDate.format({});
-      return result;
-    }).toThrowError(
-      expect.objectContaining({
-        message: expect.stringContaining('not provided'),
-      }),
-    );
-    expect(() => {
-      const result = translationModule?.vocabPublishDate.format({
-        // @ts-expect-error Incorrect params parameter
-        unrelated: 'message',
-      });
-      return result;
-    }).toThrowError(
-      expect.objectContaining({
-        message: expect.stringContaining('not provided'),
-      }),
-    );
-  });
-});

package/src/runtime.ts

@@ -1,12 +0,0 @@
-import { TranslationModule, TranslationMessagesByKey } from '@vocab/types';
-
-import { getParsedICUMessages } from './icu-handler';
-
-export { createTranslationFile } from './translation-file';
-
-export const createLanguage = (
-  module: TranslationMessagesByKey,
-): TranslationModule<any> => ({
-  getValue: (locale) => getParsedICUMessages(module, locale),
-  load: () => Promise.resolve(),
-});

package/src/translation-file.ts

@@ -1,54 +0,0 @@
-import {
-  TranslationModule,
-  TranslationModuleByLanguage,
-  ParsedICUMessages,
-  LanguageName,
-  ParsedFormatFnByKey,
-  TranslationFile,
-} from '@vocab/types';
-
-export function createTranslationFile<
-  Language extends LanguageName,
-  FormatFnByKey extends ParsedFormatFnByKey,
->(
-  translationsByLanguage: TranslationModuleByLanguage<Language, FormatFnByKey>,
-): TranslationFile<Language, FormatFnByKey> {
-  function getByLanguage(language: Language): TranslationModule<FormatFnByKey> {
-    const translationModule = translationsByLanguage[language];
-    if (!translationModule) {
-      throw new Error(
-        `Attempted to retrieve translations for unknown language "${language}"`,
-      );
-    }
-    return translationModule;
-  }
-
-  return {
-    getLoadedMessages(
-      language: Language,
-      locale?: string,
-    ): ParsedICUMessages<FormatFnByKey> | null {
-      const translationModule = getByLanguage(language);
-      return translationModule.getValue(locale || language) || null;
-    },
-    getMessages(
-      language: Language,
-      locale?: string,
-    ): Promise<ParsedICUMessages<FormatFnByKey>> {
-      const translationModule = getByLanguage(language);
-      return translationModule.load().then(() => {
-        const result = translationModule.getValue(locale || language);
-        if (!result) {
-          throw new Error(
-            `Unable to find translations for ${language} after attempting to load. Module may have failed to load or an internal error may have occurred.`,
-          );
-        }
-        return result;
-      });
-    },
-    load(language: Language): Promise<void> {
-      const translationModule = getByLanguage(language);
-      return translationModule.load();
-    },
-  };
-}

package/src/utils.test.ts

@@ -1,78 +0,0 @@
-import {
-  getDevLanguageFileFromTsFile,
-  getAltLanguageFilePath,
-  getTSFileFromDevLanguageFile,
-  getDevLanguageFileFromAltLanguageFile,
-  isDevLanguageFile,
-  isAltLanguageFile,
-} from './utils';
-
-describe('getDevLanguageFileFromTsFile', () => {
-  it('should find a translation.json file', () => {
-    expect(getDevLanguageFileFromTsFile('/my/foobar/index.ts')).toBe(
-      '/my/foobar/translations.json',
-    );
-  });
-});
-
-describe('getAltLanguageFilePath', () => {
-  it('should find a translation.json file', () => {
-    expect(getAltLanguageFilePath('/my/awesome/translations.json', 'fr')).toBe(
-      '/my/awesome/fr.translations.json',
-    );
-  });
-});
-
-describe('getTSFileFromDevLanguageFile', () => {
-  it('should find a translation.ts file', () => {
-    expect(getTSFileFromDevLanguageFile('/my/foobar/translations.json')).toBe(
-      '/my/foobar/index.ts',
-    );
-  });
-});
-
-describe('getDevLanguageFileFromAltLanguageFile', () => {
-  it('should find a translation.json file', () => {
-    expect(
-      getDevLanguageFileFromAltLanguageFile(
-        '/my/awesome/__translations__/fr.translations.json',
-      ),
-    ).toBe('/my/awesome/__translations__/translations.json');
-  });
-});
-
-describe('isDevLanguageFile', () => {
-  it('should match dev language filename', () => {
-    expect(
-      isDevLanguageFile('/my/awesome/__translations__/translations.json'),
-    ).toBe(true);
-  });
-
-  it('should match relative dev language filename', () => {
-    expect(isDevLanguageFile('translations.json')).toBe(true);
-  });
-
-  it('should not match alt language filename', () => {
-    expect(
-      isDevLanguageFile('/my/awesome/__translations__/fr.translations.json'),
-    ).toBe(false);
-  });
-});
-
-describe('isAltLanguageFile', () => {
-  it('should match alt language filename', () => {
-    expect(
-      isAltLanguageFile('/my/awesome/__translations__/fr.translations.json'),
-    ).toBe(true);
-  });
-
-  it('should match relative alt language filename', () => {
-    expect(isAltLanguageFile('fr.translations.json')).toBe(true);
-  });
-
-  it('should not match alt language filename', () => {
-    expect(
-      isAltLanguageFile('/my/awesome/__translations__/translations.json'),
-    ).toBe(false);
-  });
-});