Merge pull request #27 from Pisyukaev/print-diff-and-fixes

.changeset/fair-yaks-boil.md

@@ -0,0 +1,7 @@
+---
+'@xml-locales/cli': patch
+---
+
+feat: print diff
+fix: --help flag now it works
+chore: remove unused prompts

.changeset/kind-birds-change.md

@@ -0,0 +1,5 @@
+---
+'xml-locales': patch
+---
+
+fix: filtering undefined xml nodes

packages/cli/package.json

@@ -26,11 +26,12 @@
 		"test:watch": "vitest --ui --watch --coverage"
 	},
 	"dependencies": {
-		"@inquirer/prompts": "3.3.0",
+		"diff": "5.1.0",
 		"xml-locales": "workspace:0.0.4",
 		"yargs": "17.7.2"
 	},
 	"devDependencies": {
+		"@types/diff": "5.0.8",
 		"@types/yargs": "17.0.32"
 	}
 }

packages/cli/src/bin.ts

@@ -9,4 +9,4 @@ yargs(hideBin(process.argv))
 	.usage('$0 <cmd> [args]')
 	// @ts-ignore
 	.command(commands)
-	.help();
+	.help().argv;

packages/cli/src/commands/add.ts

@@ -2,6 +2,7 @@ import type { ArgumentsCamelCase, Argv } from 'yargs';
 
 import { keyValueOptions } from '../options/key-value.js';
 import { pathOption } from '../options/path.js';
+import { Diff } from '../utils/diff.js';
 import { readFiles, writeFile } from '../utils/files.js';
 
 export const command = 'add';
@@ -24,6 +25,9 @@ export async function handler({
 }>) {
 	const files = await readFiles(path);
 	for (const [path, file] of files) {
-		await writeFile(path, file.add({ key, value }).toXML());
+		const diff = new Diff(path, file);
+		const xml = file.add({ key, value }).toXML();
+		await writeFile(path, xml);
+		diff.print(xml);
 	}
 }

packages/cli/src/commands/remove.ts

@@ -2,6 +2,7 @@ import type { ArgumentsCamelCase, Argv } from 'yargs';
 
 import { keyValueOptions } from '../options/key-value.js';
 import { pathOption } from '../options/path.js';
+import { Diff } from '../utils/diff.js';
 import { readFiles, writeFile } from '../utils/files.js';
 
 export const command = 'remove';
@@ -24,6 +25,8 @@ export async function handler({
 }>) {
 	const files = await readFiles(path);
 	for (let [path, file] of files) {
+		const diff = new Diff(path, file);
+
 		if (key) {
 			file = file.deleteByKey(key);
 		}
@@ -32,6 +35,8 @@ export async function handler({
 			file = file.deleteByValue(value);
 		}
 
-		await writeFile(path, file.toXML());
+		const xml = file.toXML();
+		await writeFile(path, xml);
+		diff.print(xml);
 	}
 }

packages/cli/src/commands/sort.ts

@@ -3,6 +3,7 @@ import type { ArgumentsCamelCase, Argv } from 'yargs';
 
 import { directionOption } from '../options/direction.js';
 import { pathOption } from '../options/path.js';
+import { Diff } from '../utils/diff.js';
 import { readFiles, writeFile } from '../utils/files.js';
 
 export const command = 'sort';
@@ -20,6 +21,9 @@ export async function handler({
 }: ArgumentsCamelCase<{ path: string; direction: SortDirection }>) {
 	const files = await readFiles(path);
 	for (const [path, file] of files) {
-		await writeFile(path, file.sort(direction).toXML());
+		const diff = new Diff(path, file);
+		const xml = file.sort(direction).toXML();
+		await writeFile(path, xml);
+		diff.print(xml);
 	}
 }

packages/cli/src/commands/update.ts

@@ -2,6 +2,7 @@ import type { ArgumentsCamelCase, Argv } from 'yargs';
 
 import { oldKeyOrValueOptions } from '../options/key-value.js';
 import { pathOption } from '../options/path.js';
+import { Diff } from '../utils/diff.js';
 import { readFiles, writeFile } from '../utils/files.js';
 
 export const command = 'update';
@@ -24,6 +25,9 @@ export async function handler({
 }>) {
 	const files = await readFiles(path);
 	for (const [path, file] of files) {
-		await writeFile(path, file.update({ oldValue, newValue }).toXML());
+		const diff = new Diff(path, file);
+		const xml = file.update({ oldValue, newValue }).toXML();
+		await writeFile(path, xml);
+		diff.print(xml);
 	}
 }

packages/cli/src/utils/diff.ts

@@ -0,0 +1,55 @@
+import { createPatch } from 'diff';
+import { XmlLocales } from 'xml-locales';
+
+export class Diff {
+	/** @internal */
+	private filePath: string;
+
+	/** @internal */
+	private actual: string;
+
+	constructor(filePath: string, xmlLocales: XmlLocales) {
+		this.filePath = filePath;
+		this.actual = xmlLocales.toXML();
+	}
+
+	print(expected: string): void {
+		const patch = createPatch('string', this.actual, expected);
+		const lines = patch.split('\n').slice(4).map(rework).filter(notNull);
+		console.log(
+			`${this.filePath}: ${
+				lines.length ? `\n${lines.join('\n')}` : 'no changes'
+			}\n`
+		);
+	}
+}
+
+function rework(line: string): string | null {
+	switch (line.charAt(0)) {
+		case '+':
+			return colorize('added', line);
+		case '-':
+			return colorize('removed', line);
+		case ' ':
+			return line;
+		case '@':
+			return null;
+		case '\\':
+			return null;
+		default:
+			return null;
+	}
+}
+
+function notNull<T extends string>(line: string | null): line is T {
+	return line !== null;
+}
+
+const colors = {
+	added: 32,
+	removed: 31
+} as const;
+
+function colorize(color: keyof typeof colors, string: string): string {
+	return `\u001b[${colors[color]}m${string}\u001b[0m`;
+}

packages/cli/src/utils/files.ts

@@ -1,4 +1,5 @@
 import fs from 'node:fs/promises';
+import { resolve } from 'node:path';
 import { XmlLocales } from 'xml-locales';
 
 async function scanPath(path: string): Promise<string[]> {
@@ -9,7 +10,7 @@ async function scanPath(path: string): Promise<string[]> {
 			const paths = await fs.readdir(path);
 			return paths
 				.filter((file) => file.endsWith('.xml'))
-				.map((file) => `${path}/${file}`);
+				.map((file) => resolve(`${path}/${file}`));
 		}
 	} catch (err) {
 		throw new Error(

packages/xml-locales/src/xml-locales.ts

@@ -41,7 +41,13 @@ export class XmlLocales {
 		if (xmlData) {
 			const parsedXml = this.xmlParser.xmlToJson(xmlData);
 			if (Array.isArray(parsedXml.resources.string)) {
-				this.xmlData = parsedXml;
+				const filteredNodes = parsedXml.resources.string.filter(
+					(element) => element !== undefined
+				);
+
+				this.xmlData = new XmlJsonData({
+					resources: { string: filteredNodes }
+				});
 			} else {
 				this.xmlData = new XmlJsonData({
 					resources: { string: [parsedXml.resources.string] }