@lingual/i18n-check 0.1.0 → 0.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingual/i18n-check",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "MIT",
   "main": "./dist/index.js",
   "module": "./dist/index.js",
@@ -8,10 +8,9 @@
     "i18n-check": "./dist/bin/index.js"
   },
   "types": "./dist/index.d.ts",
-  "scripts": {
-    "build": "tsc",
-    "test": "jest"
-  },
+  "files": [
+    "dist/"
+  ],
   "dependencies": {
     "@formatjs/icu-messageformat-parser": "^2.7.6",
     "chalk": "^4.1.2",
@@ -24,5 +23,9 @@
     "@types/node": "^20.12.12",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.2"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "jest"
   }
-}
+}

package/.github/workflows/tests.yaml

@@ -1,31 +0,0 @@
-name: Test
-on:
-  pull_request:
-    branches:
-      - main
-  push:
-    branches:
-      - main
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@master
-
-      - name: yarn install & test
-        run: |
-          yarn install
-          yarn test
-
-  test-build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@master
-
-      - name: yarn install & build
-        run: |
-          yarn install
-          yarn build

package/jest.config.js

@@ -1,6 +0,0 @@
-/** @type {import('ts-jest').JestConfigWithTsJest} */
-module.exports = {
-  preset: "ts-jest",
-  testEnvironment: "node",
-  testPathIgnorePatterns: ["dist"],
-};

package/src/bin/index.ts

@@ -1,244 +0,0 @@
-#! /usr/bin/env node
-
-import { glob } from "glob";
-import chalk from "chalk";
-import fs from "fs";
-import { exit } from "process";
-import { program } from "commander";
-import { CheckResult, TranslationFile } from "../types";
-import { checkTranslations } from "..";
-import { Context, standardReporter, summaryReporter } from "../errorReporters";
-import { flattenTranslations } from "../utils/flattenTranslations";
-
-program
-  .version("0.1.0")
-  .option(
-    "-t, --target [directory]",
-    "name of the directory containing the JSON files to validate"
-  )
-  .option("-s, --source [source file(s)]", "path to the reference file(s)")
-  .option(
-    "-f, --format [format type]",
-    "define the specific format, i.e. i18next"
-  )
-  .option(
-    "-c, --check [checks]",
-    "define the specific checks you want to run: invalid, missing. By default the check will validate against missing and invalid keys, i.e. --check invalidKeys,missingKeys"
-  )
-  .option(
-    "-r, --reporter [error reporting style]",
-    "define the reporting style: standard or summary"
-  )
-  .option(
-    "-e, --exclude [file(s), folder(s)]",
-    "define the file(s) and/or folders(s) that should be excluded from the check"
-  )
-  .parse();
-
-const getCheckOptions = (): Context[] => {
-  const checkOption = program.getOptionValue("check");
-
-  if (!checkOption) {
-    return ["invalidKeys", "missingKeys"];
-  }
-
-  const checks = checkOption
-    .split(",")
-    .filter((check: string) =>
-      ["invalidKeys", "missingKeys"].includes(check.trim())
-    );
-
-  return checks.length > 0 ? checks : ["invalidKeys", "missingKeys"];
-};
-
-const getSourcePath = (sourcePaths: string[], fileName: string) => {
-  return sourcePaths.find((basePathName: string) => {
-    return fileName.includes(basePathName);
-  });
-};
-
-const getTargetPath = (
-  paths: string[],
-  sourcePaths: string[],
-  fileName: string
-) => {
-  const basePath = paths.find((path: string) => {
-    return fileName.includes(path);
-  });
-  if (!basePath) {
-    return null;
-  }
-
-  return sourcePaths.find((path) => path.includes(basePath));
-};
-
-const toArray = (input: string): string[] => {
-  return input
-    .trim()
-    .split(",")
-    .filter((a: string) => a);
-};
-
-const main = async () => {
-  const start = performance.now();
-  const srcPath = program.getOptionValue("source");
-  const targetPath = program.getOptionValue("target");
-  const format = program.getOptionValue("format");
-  const exclude = program.getOptionValue("exclude");
-
-  if (!srcPath) {
-    console.log(
-      chalk.red(
-        "Source file(s) not found. Please provide valid source file(s), i.e. -s translations/en-us.json"
-      )
-    );
-    exit(1);
-  }
-
-  if (!targetPath) {
-    console.log(
-      chalk.red(
-        "Target file(s) not found. Please provide valid target file(s), i.e. -t translations/"
-      )
-    );
-    exit(1);
-  }
-
-  const excludedPaths = exclude ? toArray(exclude) : [];
-  const targetPathFolders: string[] = toArray(targetPath);
-  const srcPaths: string[] = toArray(srcPath);
-
-  const isMultiFolders = targetPathFolders.length > 1;
-
-  let srcFiles: TranslationFile[] = [];
-  let targetFiles: TranslationFile[] = [];
-
-  const pattern = isMultiFolders
-    ? `{${targetPath.trim()}}/**/*.json`
-    : `${targetPath.trim()}/**/*.json`;
-
-  const files = await glob(pattern, {
-    ignore: ["node_modules/**"].concat(excludedPaths),
-  });
-
-  console.log(chalk.blue("i18n translations checker"));
-  console.log(chalk.blackBright(`Source file(s): ${srcPath}`));
-
-  if (format) {
-    console.log(chalk.blackBright(`Selected format is: ${format}`));
-  }
-
-  const options = {
-    checks: getCheckOptions(),
-    format: format ?? undefined,
-  };
-
-  files.forEach((file) => {
-    const content = JSON.parse(fs.readFileSync(file, "utf-8"));
-    const sourcePath = getSourcePath(srcPaths, file);
-    if (sourcePath) {
-      srcFiles.push({
-        reference: null,
-        name: file,
-        content: flattenTranslations(content),
-      });
-    } else {
-      const targetPath = getTargetPath(targetPathFolders, srcPaths, file);
-      const reference = targetPath?.includes(".json")
-        ? targetPath
-        : `${targetPath}${file.split("/").pop()}`;
-
-      targetFiles.push({
-        reference,
-        name: file,
-        content: flattenTranslations(content),
-      });
-    }
-  });
-
-  if (srcFiles.length === 0) {
-    console.log(
-      chalk.red(
-        "Source file(s) not found. Please provide valid source file(s), i.e. -s translations/en-us.json"
-      )
-    );
-    exit(1);
-  }
-
-  if (targetFiles.length === 0) {
-    console.log(
-      chalk.red(
-        "Target file(s) not found. Please provide valid target file(s), i.e. -t translations/"
-      )
-    );
-    exit(1);
-  }
-
-  try {
-    const result = checkTranslations(srcFiles, targetFiles, options);
-
-    print(result);
-
-    const end = performance.now();
-
-    console.log(
-      chalk.green(
-        `\nDone in ${Math.round(((end - start) * 100) / 1000) / 100}s.`
-      )
-    );
-    if (
-      (result.missingKeys && Object.keys(result.missingKeys).length > 0) ||
-      (result.invalidKeys && Object.keys(result.invalidKeys).length > 0)
-    ) {
-      exit(1);
-    } else {
-      exit(0);
-    }
-  } catch (e) {
-    console.log(
-      chalk.red(
-        "\nError: Can't validate translations. Check if the format is supported or specify the translation format i.e. -f i18next"
-      )
-    );
-    exit(1);
-  }
-};
-
-const print = ({
-  missingKeys,
-  invalidKeys,
-}: {
-  missingKeys: CheckResult | undefined;
-  invalidKeys: CheckResult | undefined;
-}) => {
-  const reporter = program.getOptionValue("reporter");
-
-  const errorReporter =
-    reporter === "summary" ? summaryReporter : standardReporter;
-
-  if (missingKeys && Object.keys(missingKeys).length > 0) {
-    console.log(chalk.bgRed(chalk.white("\nFound missing keys!")));
-    for (const [lang, missingMessageKeys] of Object.entries<string[]>(
-      missingKeys
-    )) {
-      console.log(chalk.red(`\nIn ${lang}:\n`));
-      console.log(chalk.red(errorReporter(missingMessageKeys, "missingKeys")));
-    }
-  } else if (missingKeys) {
-    console.log(chalk.green("\nNo missing keys found!"));
-  }
-
-  if (invalidKeys && Object.keys(invalidKeys).length > 0) {
-    console.log(chalk.bgRed(chalk.white("\nFound invalid keys!")));
-    for (const [lang, invalidMessageKeys] of Object.entries<string[]>(
-      invalidKeys
-    )) {
-      console.log(chalk.red(`\nIn ${lang}:\n`));
-      console.log(chalk.red(errorReporter(invalidMessageKeys, "invalidKeys")));
-    }
-  } else if (invalidKeys) {
-    console.log(chalk.green("\nNo invalid translations found!"));
-  }
-};
-
-main();

package/src/errorReporters.ts

@@ -1,18 +0,0 @@
-export type Context = "missingKeys" | "invalidKeys";
-export type ErrorReporter = (result: string[], context: Context) => void;
-
-export const contextMapping: Record<Context, string> = {
-  invalidKeys: "invalid",
-  missingKeys: "missing",
-};
-
-export const standardReporter: ErrorReporter = (result) => {
-  return result.map((key) => `◯ ${key}`).join("\n");
-};
-
-export const summaryReporter: ErrorReporter = (result, context) => {
-  const count = result.length;
-  return `Found ${count} ${contextMapping[context]} ${
-    count === 1 ? "key" : "keys"
-  }.`;
-};

package/src/index.ts

@@ -1,68 +0,0 @@
-import { findMissingKeys } from "./utils/findMissingKeys";
-import { CheckResult, Translation, TranslationFile } from "./types";
-import { findInvalidTranslations } from "./utils/findInvalidTranslations";
-import { findInvalid18nTranslations } from "./utils/findInvalidi18nTranslations";
-import { Context } from "./errorReporters";
-
-export type Options = {
-  format?: "icu" | "i18next";
-  checks?: Context[];
-};
-
-export const checkInvalidTranslations = (
-  source: Translation,
-  targets: Record<string, Translation>,
-  options: Options = { format: "icu" }
-): CheckResult => {
-  return options.format === "i18next"
-    ? findInvalid18nTranslations(source, targets)
-    : findInvalidTranslations(source, targets);
-};
-
-export const checkMissingTranslations = (
-  source: Translation,
-  targets: Record<string, Translation>
-): CheckResult => {
-  return findMissingKeys(source, targets);
-};
-
-export const checkTranslations = (
-  source: TranslationFile[],
-  targets: TranslationFile[],
-  options: Options = { format: "icu", checks: ["invalidKeys", "missingKeys"] }
-): {
-  missingKeys: CheckResult | undefined;
-  invalidKeys: CheckResult | undefined;
-} => {
-  const { checks = ["invalidKeys", "missingKeys"] } = options;
-
-  let missingKeys = {};
-  let invalidKeys = {};
-
-  const hasMissingKeys = checks.includes("missingKeys");
-  const hasInvalidKeys = checks.includes("invalidKeys");
-
-  source.forEach(({ name, content }) => {
-    const files = targets
-      .filter(({ reference }) => reference === name)
-      .reduce((obj, { name: key, content }) => {
-        return Object.assign(obj, { [key]: content });
-      }, {});
-
-    if (hasMissingKeys) {
-      Object.assign(missingKeys, checkMissingTranslations(content, files));
-    }
-
-    if (hasInvalidKeys) {
-      Object.assign(
-        invalidKeys,
-        checkInvalidTranslations(content, files, options)
-      );
-    }
-  });
-
-  return {
-    missingKeys: hasMissingKeys ? missingKeys : undefined,
-    invalidKeys: hasInvalidKeys ? invalidKeys : undefined,
-  };
-};

package/src/types.ts

@@ -1,9 +0,0 @@
-export type Translation = Record<string, unknown>;
-
-export type CheckResult = Record<string, string[]>;
-
-export type TranslationFile = {
-  reference: string | null;
-  name: string;
-  content: Translation;
-};

package/src/utils/findInvalidTranslations.test.ts

@@ -1,78 +0,0 @@
-import {
-  compareTranslationFiles,
-  findInvalidTranslations,
-} from "./findInvalidTranslations";
-import { flattenTranslations } from "./flattenTranslations";
-
-const sourceFile = require("../../translations/messageExamples/en-us.json");
-const secondaryFile = require("../../translations/messageExamples/de-de.json");
-
-describe("findInvalidTranslations:compareTranslationFiles", () => {
-  it("should return empty array if files are identical", () => {
-    expect(
-      compareTranslationFiles(
-        flattenTranslations(sourceFile),
-        flattenTranslations(sourceFile)
-      )
-    ).toEqual([]);
-  });
-
-  it("should return the invalid keys in the target file", () => {
-    expect(
-      compareTranslationFiles(
-        flattenTranslations({
-          ...sourceFile,
-          "ten.eleven.twelve": "ten eleven twelve",
-        }),
-        flattenTranslations(secondaryFile)
-      )
-    ).toEqual(["multipleVariables"]);
-  });
-
-  it("should return empty array if placeholders are identical but in different positions", () => {
-    expect(
-      compareTranslationFiles(
-        {
-          basic: "added {this} and {that} should work.",
-        },
-        {
-          basic: "It is {this} with different position {that}",
-        }
-      )
-    ).toEqual([]);
-  });
-});
-
-describe("findInvalidTranslations", () => {
-  it("should return an empty object if all files have no invalid keys", () => {
-    expect(findInvalidTranslations(sourceFile, { de: sourceFile })).toEqual({});
-  });
-
-  it("should return an object containing the keys for the missing language", () => {
-    expect(
-      findInvalidTranslations(
-        { ...sourceFile, "ten.eleven.twelve": "ten eleven twelve" },
-        { de: secondaryFile }
-      )
-    ).toEqual({ de: ["multipleVariables"] });
-  });
-
-  it("should return an object containing the keys for every language with missing key", () => {
-    expect(
-      findInvalidTranslations(
-        { ...sourceFile, "ten.eleven.twelve": "ten eleven twelve" },
-        {
-          de: secondaryFile,
-          fr: {
-            "four.five.six": "four five six",
-            "seven.eight.nine": "seven eight nine",
-            "message.text-format": "yo,<p><b>John</b></p>!",
-          },
-        }
-      )
-    ).toEqual({
-      de: ["multipleVariables"],
-      fr: ["message.text-format"],
-    });
-  });
-});

package/src/utils/findInvalidTranslations.ts

@@ -1,120 +0,0 @@
-import {
-  MessageFormatElement,
-  isLiteralElement,
-  isPluralElement,
-  isPoundElement,
-  isSelectElement,
-  isTagElement,
-  parse,
-} from "@formatjs/icu-messageformat-parser";
-import { Translation } from "../types";
-
-export const findInvalidTranslations = (
-  source: Translation,
-  files: Record<string, Translation>
-) => {
-  let differences = {};
-  if (Object.keys(files).length === 0) {
-    return differences;
-  }
-
-  for (const [lang, file] of Object.entries(files)) {
-    const result = compareTranslationFiles(source, file);
-
-    if (result.length > 0) {
-      differences = Object.assign(differences, { [lang]: result });
-    }
-  }
-
-  return differences;
-};
-
-const sortParsedKeys = (a: MessageFormatElement, b: MessageFormatElement) => {
-  if (a.type === b.type) {
-    return !isPoundElement(a) && !isPoundElement(b)
-      ? a.value < b.value
-        ? -1
-        : 1
-      : -1;
-  }
-  return a.type - b.type;
-};
-
-export const compareTranslationFiles = (a: Translation, b: Translation) => {
-  let diffs = [];
-  for (const key in a) {
-    if (
-      b[key] !== undefined &&
-      hasDiff(parse(String(a[key])), parse(String(b[key])))
-    ) {
-      diffs.push(key);
-    }
-  }
-
-  return diffs;
-};
-
-export const hasDiff = (
-  a: MessageFormatElement[],
-  b: MessageFormatElement[]
-) => {
-  const compA = a
-    .filter((element) => !isLiteralElement(element))
-    .sort(sortParsedKeys);
-
-  const compB = b
-    .filter((element) => !isLiteralElement(element))
-    .sort(sortParsedKeys);
-  if (compA.length !== compB.length) {
-    return true;
-  }
-
-  const hasErrors = compA.some((formatElementA, index) => {
-    const formatElementB = compB[index];
-
-    if (
-      formatElementA.type !== formatElementB.type ||
-      formatElementA.location !== formatElementB.location
-    ) {
-      return true;
-    }
-
-    if (
-      (isLiteralElement(formatElementA) && isLiteralElement(formatElementB)) ||
-      (isPoundElement(formatElementA) && isPoundElement(formatElementB))
-    ) {
-      return false;
-    }
-
-    // @ts-ignore
-    if (formatElementA.value !== formatElementB.value) {
-      return true;
-    }
-
-    if (isTagElement(formatElementA) && isTagElement(formatElementB)) {
-      return hasDiff(formatElementA.children, formatElementB.children);
-    }
-
-    if (
-      (isSelectElement(formatElementA) && isSelectElement(formatElementB)) ||
-      (isPluralElement(formatElementA) && isPluralElement(formatElementB))
-    ) {
-      const optionsA = Object.keys(formatElementA.options).sort();
-      const optionsB = Object.keys(formatElementA.options).sort();
-
-      if (optionsA.join("-") !== optionsB.join("-")) {
-        return true;
-      }
-      return optionsA.some((key) => {
-        return hasDiff(
-          formatElementA.options[key].value,
-          formatElementB.options[key].value
-        );
-      });
-    }
-
-    return false;
-  });
-
-  return hasErrors;
-};