eslint-plugin-i18n-json/src/util/compare-translations-structure.js

Fully extendable eslint plugin for JSON i18n translation files.

const { set } = require('lodash');
const diff = require('jest-diff');
const deepForOwn = require('./deep-for-own');

const DIFF_OPTIONS = {
  expand: false,
  contextLines: 1
};

// we don't care what the actual values are.
// lodash.set will automatically convert a previous string value
// into an object, if the current path states that a key is nested inside.
// reminder, deepForOwn goes from the root level to the deepest level (preorder)
const compareTranslationsStructure = (settings, translationsA, translationsB) => {
  const augmentedTranslationsA = {};
  const augmentedTranslationsB = {};

  const ignorePaths = settings['i18n-json/ignore-keys'] || [];

  const opts = {
    ignorePaths
  };

  deepForOwn(translationsA, (value, key, path) => {
    set(augmentedTranslationsA, path, 'Message<String>');
  }, opts);
  deepForOwn(translationsB, (value, key, path) => {
    set(augmentedTranslationsB, path, 'Message<String>');
  }, opts);
  return diff(augmentedTranslationsA, augmentedTranslationsB, DIFF_OPTIONS);
};

module.exports = compareTranslationsStructure;