@vocab/core 1.0.3 → 1.1.1

package/src/utils.ts

@@ -1,143 +0,0 @@
-import path from 'path';
-
-import type {
-  LanguageName,
-  LanguageTarget,
-  TranslationsByKey,
-  TranslationMessagesByKey,
-  UserConfig,
-} from '@vocab/types';
-import { trace } from './logger';
-
-export const defaultTranslationDirSuffix = '.vocab';
-export const devTranslationFileName = 'translations.json';
-
-export type Fallback = 'none' | 'valid' | 'all';
-
-const globAnyPathWithOptionalPrefix = '**/?(*)';
-
-export function isDevLanguageFile(filePath: string) {
-  return (
-    filePath.endsWith(`/${devTranslationFileName}`) ||
-    filePath === devTranslationFileName
-  );
-}
-export function isAltLanguageFile(filePath: string) {
-  return filePath.endsWith('.translations.json');
-}
-export function isTranslationDirectory(
-  filePath: string,
-  {
-    translationsDirectorySuffix = defaultTranslationDirSuffix,
-  }: {
-    translationsDirectorySuffix?: string;
-  },
-) {
-  return filePath.endsWith(translationsDirectorySuffix);
-}
-
-export function getTranslationFolderGlob({
-  translationsDirectorySuffix = defaultTranslationDirSuffix,
-}: {
-  translationsDirectorySuffix?: string;
-}) {
-  const result = `${globAnyPathWithOptionalPrefix}${translationsDirectorySuffix}`;
-
-  trace('getTranslationFolderGlob', result);
-
-  return result;
-}
-
-export function getDevTranslationFileGlob({
-  translationsDirectorySuffix = defaultTranslationDirSuffix,
-}: {
-  translationsDirectorySuffix?: string;
-}) {
-  const result = `${globAnyPathWithOptionalPrefix}${translationsDirectorySuffix}/${devTranslationFileName}`;
-
-  trace('getDevTranslationFileGlob', result);
-
-  return result;
-}
-
-export function getAltTranslationFileGlob(config: UserConfig) {
-  const altLanguages = getAltLanguages(config);
-  const langMatch =
-    altLanguages.length === 1 ? altLanguages[0] : `{${altLanguages.join(',')}}`;
-
-  const { translationsDirectorySuffix = defaultTranslationDirSuffix } = config;
-  const result = `**/*${translationsDirectorySuffix}/${langMatch}.translations.json`;
-
-  trace('getAltTranslationFileGlob', result);
-
-  return result;
-}
-
-export function getAltLanguages({
-  devLanguage,
-  languages,
-}: {
-  devLanguage: LanguageName;
-  languages: Array<LanguageTarget>;
-}) {
-  return languages.map((v) => v.name).filter((lang) => lang !== devLanguage);
-}
-
-export function getDevLanguageFileFromTsFile(tsFilePath: string) {
-  const directory = path.dirname(tsFilePath);
-  const result = path.normalize(path.join(directory, devTranslationFileName));
-
-  trace(`Returning dev language path ${result} for path ${tsFilePath}`);
-  return result;
-}
-
-export function getDevLanguageFileFromAltLanguageFile(
-  altLanguageFilePath: string,
-) {
-  const directory = path.dirname(altLanguageFilePath);
-  const result = path.normalize(path.join(directory, devTranslationFileName));
-  trace(
-    `Returning dev language path ${result} for path ${altLanguageFilePath}`,
-  );
-  return result;
-}
-
-export function getTSFileFromDevLanguageFile(devLanguageFilePath: string) {
-  const directory = path.dirname(devLanguageFilePath);
-  const result = path.normalize(path.join(directory, 'index.ts'));
-
-  trace(`Returning TS path ${result} for path ${devLanguageFilePath}`);
-  return result;
-}
-
-export function getAltLanguageFilePath(
-  devLanguageFilePath: string,
-  language: string,
-) {
-  const directory = path.dirname(devLanguageFilePath);
-  const result = path.normalize(
-    path.join(directory, `${language}.translations.json`),
-  );
-  trace(
-    `Returning alt language path ${result} for path ${devLanguageFilePath}`,
-  );
-  return path.normalize(result);
-}
-
-export function mapValues<Key extends string, OriginalValue, ReturnValue>(
-  obj: Record<Key, OriginalValue>,
-  func: (val: OriginalValue) => ReturnValue,
-): TranslationMessagesByKey<Key> {
-  const newObj: any = {};
-  const keys = Object.keys(obj) as Key[];
-  for (const key of keys) {
-    newObj[key] = func(obj[key]);
-  }
-  return newObj;
-}
-
-export function getTranslationMessages<Key extends string>(
-  translations: TranslationsByKey<Key>,
-): TranslationMessagesByKey<Key> {
-  return mapValues(translations, (v) => v.message);
-}

package/src/validate/index.test.ts

@@ -1,64 +0,0 @@
-import { LoadedTranslation, LanguageName } from '@vocab/types';
-import { findMissingKeys } from './index';
-
-interface TestCase {
-  loadedTranslation: LoadedTranslation;
-  devLanguage: LanguageName;
-  altLanguages: Array<LanguageName>;
-  valid: boolean;
-  missingKeys?: Record<LanguageName, Array<string>>;
-}
-
-const testCases: Array<TestCase> = [
-  {
-    loadedTranslation: {
-      filePath: 'some-file.json',
-      namespace: 'some-file',
-      keys: ['key1', 'key2'],
-      relativePath: 'some-file.json',
-      languages: {
-        en: { key1: { message: 'Hi' } },
-        th: { key1: { message: 'Bye' } },
-      },
-    },
-    devLanguage: 'en',
-    altLanguages: ['th'],
-    valid: true,
-  },
-  {
-    loadedTranslation: {
-      filePath: 'some-file.json',
-      relativePath: 'some-file.json',
-      namespace: 'some-file-2',
-      keys: ['key1'],
-      languages: {
-        en: { key1: { message: 'Hi' } },
-        th: {},
-      },
-    },
-    devLanguage: 'en',
-    altLanguages: ['th'],
-    valid: false,
-    missingKeys: {
-      th: ['key1'],
-    },
-  },
-];
-
-test.each(testCases)(
-  'validate',
-  ({ loadedTranslation, devLanguage, altLanguages, valid, missingKeys }) => {
-    const result = findMissingKeys(
-      loadedTranslation,
-      devLanguage,
-      altLanguages,
-    );
-
-    expect(result[0]).toBe(valid);
-
-    if (missingKeys) {
-      // eslint-disable-next-line jest/no-conditional-expect
-      expect(result[1]).toMatchObject(missingKeys);
-    }
-  },
-);

package/src/validate/index.ts

@@ -1,81 +0,0 @@
-/* eslint-disable no-console */
-import { UserConfig, LoadedTranslation, LanguageName } from '@vocab/types';
-import chalk from 'chalk';
-
-import { loadAllTranslations } from '../load-translations';
-import { getAltLanguages } from '../utils';
-
-export function findMissingKeys(
-  loadedTranslation: LoadedTranslation,
-  devLanguageName: LanguageName,
-  altLangauges: Array<LanguageName>,
-) {
-  const devLanguage = loadedTranslation.languages[devLanguageName];
-
-  if (!devLanguage) {
-    throw new Error(
-      `Failed to load dev language: ${loadedTranslation.filePath}`,
-    );
-  }
-
-  const result: Record<LanguageName, Array<string>> = {};
-  let valid = true;
-
-  const requiredKeys = Object.keys(devLanguage);
-
-  if (requiredKeys.length > 0) {
-    for (const altLanguageName of altLangauges) {
-      const altLanguage = loadedTranslation.languages[altLanguageName] ?? {};
-
-      for (const key of requiredKeys) {
-        if (typeof altLanguage[key]?.message !== 'string') {
-          if (!result[altLanguageName]) {
-            result[altLanguageName] = [];
-          }
-
-          result[altLanguageName].push(key);
-          valid = false;
-        }
-      }
-    }
-  }
-  return [valid, result] as const;
-}
-
-export async function validate(config: UserConfig) {
-  const allTranslations = await loadAllTranslations(
-    { fallbacks: 'valid', 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;
-}