chore: Add pretify-deep-diff utility with localization support

Author: whoekage

.gitignore

@@ -127,4 +127,4 @@ dist
 .yarn/unplugged
 .yarn/build-state.yml
 .yarn/install-state.gz
-.pnp.*
+.pnp.*

README.md

@@ -0,0 +1,66 @@
+
+# pretify-deep-diff
+
+A utility to prettify the results of `deep-diff` with emojis and localization support.
+
+## Installation
+
+To install the package, use npm:
+
+```bash
+npm install pretify-deep-diff
+```
+
+## Usage
+
+Here's an example of how to use `pretify-deep-diff`:
+
+```javascript
+const diff = require('deep-diff');
+const pretifyDeepDiff = require('pretify-deep-diff');
+
+const lhs = {
+    name: 'John',
+    age: 30,
+    pets: ['dog', 'cat'],
+    address: {
+        city: 'Chicago',
+        street: 'Main St'
+    }
+};
+
+const rhs = {
+    name: 'Jane',
+    age: 31,
+    pets: ['dog', 'parrot'],
+    city: 'New York'
+};
+
+const changes = diff(lhs, rhs);
+
+console.log(pretifyDeepDiff(changes, { locale: 'ru' }));
+```
+
+### Output
+
+```text
+ Добавлено:
+➕ Добавлено: city = "New York"
+
+❌ Удалено:
+❌ Удалено: address
+
+✏️ Изменено:
+✏️ Изменено: name с "John" на "Jane"
+✏️ Изменено: age с 30 на 31
+✏️ Изменено: pets.1 с "cat" на "parrot"
+```
+
+## Options
+
+- `locale`: Specify the locale (`en` or `ru`). Default is `en`.
+- `customTexts`: An object to customize text templates.
+
+## Localization
+
+The library supports localization through JSON files in the `locales` directory.

index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/pretify-deep-diff');

lib/formatGroupedChanges.js

@@ -0,0 +1,19 @@
+const formatGroupedChanges = (groupedChanges, locale, customTexts) => {
+    let result = '';
+    if (groupedChanges.added.length) {
+        result += `${customTexts.addedTitle || locale.addedTitle}\n` + groupedChanges.added.join('\n') + '\n\n';
+    }
+    if (groupedChanges.deleted.length) {
+        result += `${customTexts.deletedTitle || locale.deletedTitle}\n` + groupedChanges.deleted.join('\n') + '\n\n';
+    }
+    if (groupedChanges.edited.length) {
+        result += `${customTexts.editedTitle || locale.editedTitle}\n` + groupedChanges.edited.join('\n') + '\n\n';
+    }
+    if (groupedChanges.arrayChange.length) {
+        result += `${customTexts.arrayChangeTitle || locale.arrayChangeTitle}\n` + groupedChanges.arrayChange.join('\n') + '\n\n';
+    }
+    
+    return result.trim();
+}
+
+module.exports = formatGroupedChanges;

lib/formatPath.js

@@ -0,0 +1,5 @@
+function formatPath(path) {
+    return path ? path.join('.') : '';
+}
+
+module.exports = formatPath;

lib/formatText.js

@@ -0,0 +1,5 @@
+function formatText(template, variables) {
+    return template.replace(/{(\w+)}/g, (_, key) => variables[key] || '');
+}
+
+module.exports = formatText;

lib/pretify-deep-diff.js

@@ -0,0 +1,64 @@
+const diff = require('deep-diff');
+const formatText = require('./formatText');
+const formatPath = require('./formatPath');
+const formatGroupedChanges = require('./formatGroupedChanges');
+const enLocale = require('../locales/en.json');
+const ruLocale = require('../locales/ru.json');
+
+const locales = {
+    en: enLocale,
+    ru: ruLocale
+};
+
+function pretifyDeepDiff(changes, options = {}) {
+    const locale = locales[options.locale] || locales['en'];
+    const customTexts = options.customTexts || {};
+
+    if (!changes || !Array.isArray(changes)) {
+        return 'No changes detected.';
+    }
+
+    const groupedChanges = {
+        added: [],
+        deleted: [],
+        edited: [],
+        arrayChange: []
+    };
+
+    changes.forEach(change => {
+        switch (change.kind) {
+            case 'N':
+                groupedChanges.added.push(formatText(customTexts.added || locale.added, {
+                    path: formatPath(change.path),
+                    value: JSON.stringify(change.rhs)
+                }));
+                break;
+            case 'D':
+                groupedChanges.deleted.push(formatText(customTexts.deleted || locale.deleted, {
+                    path: formatPath(change.path)
+                }));
+                break;
+            case 'E':
+                groupedChanges.edited.push(formatText(customTexts.edited || locale.edited, {
+                    path: formatPath(change.path),
+                    oldValue: JSON.stringify(change.lhs),
+                    newValue: JSON.stringify(change.rhs)
+                }));
+                break;
+            case 'A':
+                const arrayChangeText = pretifyDeepDiff([change.item], options);
+                groupedChanges.arrayChange.push(formatText(customTexts.arrayChange || locale.arrayChange, {
+                    path: formatPath(change.path),
+                    index: change.index,
+                    item: arrayChangeText
+                }));
+                break;
+            default:
+                break;
+        }
+    });
+
+    return formatGroupedChanges(groupedChanges, locale, customTexts);
+}
+
+module.exports = pretifyDeepDiff;

locales/en.json

@@ -0,0 +1,10 @@
+{
+    "added": "🆕 Added: {path} = {value}",
+    "deleted": "🗑️ Deleted: {path}",
+    "edited": "✏️ Edited: {path} from {oldValue} to {newValue}",
+    "arrayChange": "🔄 Array change at {path} index {index}: {item}",
+    "addedTitle": "🆕 Added:",
+    "deletedTitle": "🗑️ Deleted:",
+    "editedTitle": "✏️ Edited:",
+    "arrayChangeTitle": "🔄 Array Changes:"
+}

locales/ru.json

@@ -0,0 +1,10 @@
+{
+    "added": "➕ Добавлено: {path} = {value}",
+    "deleted": "❌ Удалено: {path}",
+    "edited": "✏️ Изменено: {path} с {oldValue} на {newValue}",
+    "arrayChange": "🔄 Изменение массива по пути {path} индекс {index}: {item}",
+    "addedTitle": "➕ Добавлено:",
+    "deletedTitle": "❌ Удалено:",
+    "editedTitle": "✏️ Изменено:",
+    "arrayChangeTitle": "🔄 Изменения в массиве:"
+}