@twin.org/merge-locales 0.0.1-next.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Merge Locales
+
+This tool will read the locale files from all the dependencies and create a combined one.
+
+## Installation
+
+```shell
+npm install @twin.org/merge-locales
+```
+
+## Examples
+
+Usage of the tool is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/bin/index.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { CLI } from '../dist/esm/index.mjs';
+
+const cli = new CLI();
+const result = await cli.run(process.argv);
+process.exit(result);

package/dist/esm/index.mjs

@@ -0,0 +1,177 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { CLIDisplay, CLIUtils, CLIBase } from '@twin.org/cli-core';
+import { rm, mkdir, writeFile } from 'node:fs/promises';
+import { I18n, Is, GeneralError, ObjectHelper } from '@twin.org/core';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Build the root command to be consumed by the CLI.
+ * @param program The command to build on.
+ */
+function buildCommandMergeLocales(program) {
+    program
+        .option(I18n.formatMessage("commands.merge-locales.options.config.param"), I18n.formatMessage("commands.merge-locales.options.config.description"))
+        .action(async (opts) => {
+        await actionCommandMergeLocales(opts);
+    });
+}
+/**
+ * Action the root command.
+ * @param opts The options for the command.
+ * @param opts.config The optional configuration file.
+ */
+async function actionCommandMergeLocales(opts) {
+    let config;
+    if (Is.stringValue(opts.config)) {
+        try {
+            const configJson = path.resolve(opts.config);
+            CLIDisplay.value(I18n.formatMessage("commands.merge-locales.labels.configJson"), configJson);
+            CLIDisplay.break();
+            CLIDisplay.task(I18n.formatMessage("commands.merge-locales.progress.loadingConfigJson"));
+            CLIDisplay.break();
+            config = await CLIUtils.readJsonFile(configJson);
+            CLIDisplay.break();
+        }
+        catch (err) {
+            throw new GeneralError("commands", "commands.merge-locales.configFailed", undefined, err);
+        }
+        if (Is.empty(config)) {
+            throw new GeneralError("commands", "commands.merge-locales.configFailed");
+        }
+    }
+    await mergeLocales(process.cwd(), config ?? {});
+    CLIDisplay.done();
+}
+/**
+ * Merge the locales.
+ * @param workingDirectory The folder the app was run from.
+ * @param config The configuration for the app.
+ */
+async function mergeLocales(workingDirectory, config) {
+    CLIDisplay.value(I18n.formatMessage("commands.merge-locales.labels.workingDirectory"), workingDirectory);
+    const outputDirectory = path.resolve(config.outputDirectory ?? "./dist/locales");
+    const locales = config.locales ?? [];
+    const includePackages = config.includePackages ?? [];
+    const excludePackages = config.excludePackages ?? [];
+    if (locales.length === 0) {
+        locales.push({ label: "English", code: "en" });
+    }
+    CLIDisplay.value(I18n.formatMessage("commands.merge-locales.labels.outputDirectory"), outputDirectory);
+    const npmRoot = await CLIUtils.findNpmRoot(workingDirectory);
+    CLIDisplay.value(I18n.formatMessage("commands.merge-locales.labels.npmRoot"), npmRoot);
+    CLIDisplay.break();
+    CLIDisplay.task(I18n.formatMessage("commands.merge-locales.progress.creatingOutputDirectory"), outputDirectory);
+    try {
+        await rm(outputDirectory, { recursive: true });
+    }
+    catch { }
+    await mkdir(outputDirectory, { recursive: true });
+    let packageNames = [];
+    const packageJson = await findDependencies(npmRoot, path.join(workingDirectory, "package.json"), packageNames);
+    excludePackages.push("@twin.org/merge-locales");
+    excludePackages.push("@twin.org/nameof");
+    excludePackages.push("@twin.org/nameof-transformer");
+    packageNames = packageNames.filter(pkg => !excludePackages.includes(pkg));
+    packageNames.push(...includePackages);
+    CLIDisplay.break();
+    CLIDisplay.section(I18n.formatMessage("commands.merge-locales.labels.sourcePackages"));
+    for (const packageName of packageNames) {
+        CLIDisplay.value("", packageName, 1);
+    }
+    CLIDisplay.break();
+    const localeDictionaries = {};
+    if (Is.stringValue(packageJson.name)) {
+        await mergePackageLocales(path.join(workingDirectory, "locales"), packageJson.name, locales, localeDictionaries);
+    }
+    for (const packageName of packageNames) {
+        const packageLocalDirectory = path.join(npmRoot, packageName, "locales");
+        await mergePackageLocales(packageLocalDirectory, packageName, locales, localeDictionaries);
+    }
+    CLIDisplay.break();
+    CLIDisplay.task(I18n.formatMessage("commands.merge-locales.progress.writingMergedLocales"));
+    for (const localeDictionary in localeDictionaries) {
+        const localeFile = path.join(outputDirectory, `${localeDictionary}.json`);
+        CLIDisplay.value(I18n.formatMessage("commands.merge-locales.labels.writingLocale"), localeFile, 1);
+        await writeFile(localeFile, JSON.stringify(localeDictionaries[localeDictionary], null, 2), "utf8");
+    }
+    CLIDisplay.break();
+}
+/**
+ * Merge the locales for a package.
+ * @param packageLocalDirectory The root of the NPM packages.
+ * @param packageName The name of the package.
+ * @param locales The locales to merge.
+ * @internal
+ */
+async function mergePackageLocales(packageLocalDirectory, packageName, locales, localeDictionaries) {
+    CLIDisplay.task(I18n.formatMessage("commands.merge-locales.progress.mergingLocalesForPackage"), packageName);
+    if (await CLIUtils.dirExists(packageLocalDirectory)) {
+        for (const locale of locales) {
+            const localeFile = path.join(packageLocalDirectory, `${locale.code}.json`);
+            if (await CLIUtils.dirExists(localeFile)) {
+                CLIDisplay.value(I18n.formatMessage("commands.merge-locales.labels.mergingLocale"), locale.code, 1);
+                const localeDictionary = await CLIUtils.readJsonFile(localeFile);
+                if (!localeDictionaries[locale.code]) {
+                    localeDictionaries[locale.code] = {};
+                }
+                localeDictionaries[locale.code] = ObjectHelper.merge(localeDictionaries[locale.code], localeDictionary);
+            }
+        }
+    }
+    CLIDisplay.break();
+}
+/**
+ * Find dependencies for the package.
+ * @param npmRoot The root of the NPM packages.
+ * @param packageJsonPath The path to the package.json.
+ * @param packageNames The package names to add to.
+ * @returns The package details.
+ * @internal
+ */
+async function findDependencies(npmRoot, packageJsonPath, packageNames) {
+    const packageJson = await CLIUtils.readJsonFile(packageJsonPath);
+    if (Is.objectValue(packageJson?.dependencies)) {
+        for (const pkg in packageJson.dependencies) {
+            if (pkg.startsWith("@twin.org") && !packageNames.includes(pkg)) {
+                packageNames.push(pkg);
+                const packagePath = path.join(npmRoot, pkg, "package.json");
+                await findDependencies(npmRoot, packagePath, packageNames);
+            }
+        }
+    }
+    return packageJson ?? {};
+}
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The main entry point for the CLI.
+ */
+class CLI extends CLIBase {
+    /**
+     * Run the app.
+     * @param argv The process arguments.
+     * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @returns The exit code.
+     */
+    async run(argv, localesDirectory) {
+        return this.execute({
+            title: "TWIN Merge Locales",
+            appName: "merge-locales",
+            version: "0.0.1-next.1",
+            icon: "⚙️ ",
+            supportsEnvFiles: false
+        }, localesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), "../locales"), argv);
+    }
+    /**
+     * Configure any options or actions at the root program level.
+     * @param program The root program command.
+     */
+    configureRoot(program) {
+        buildCommandMergeLocales(program);
+    }
+}
+
+export { CLI, actionCommandMergeLocales, buildCommandMergeLocales, mergeLocales };

package/dist/locales/en.json

@@ -0,0 +1,40 @@
+{
+	"error": {
+		"commands": {
+			"merge-locales": {
+				"configFailed": "Configuration failed to load."
+			}
+		}
+	},
+	"commands": {
+		"merge-locales": {
+			"options": {
+				"config": {
+					"param": "--config '<'file'>'",
+					"description": "Path to the JSON configuration file."
+				}
+			},
+			"progress": {
+				"loadingConfigJson": "Loading Config JSON",
+				"creatingOutputDirectory": "Creating Output Directory",
+				"writingMergedLocales": "Writing Merged Locales",
+				"mergingLocalesForPackage": "Merging Locales for Package"
+			},
+			"labels": {
+				"configJson": "Config JSON",
+				"workingDirectory": "Working Directory",
+				"outputDirectory": "Output Directory",
+				"npmRoot": "NPM Root",
+				"sourcePackages": "Source Packages",
+				"writingLocale": "Writing Locale",
+				"mergingLocale": "Merging Locale"
+			}
+		}
+	},
+	"cli": {
+		"progress": {
+			"done": "Done.",
+			"error": "Error"
+		}
+	}
+}

package/dist/types/cli.d.ts

@@ -0,0 +1,19 @@
+import { CLIBase } from "@twin.org/cli-core";
+import type { Command } from "commander";
+/**
+ * The main entry point for the CLI.
+ */
+export declare class CLI extends CLIBase {
+    /**
+     * Run the app.
+     * @param argv The process arguments.
+     * @param localesDirectory The directory for the locales, default to relative to the script.
+     * @returns The exit code.
+     */
+    run(argv: string[], localesDirectory?: string): Promise<number>;
+    /**
+     * Configure any options or actions at the root program level.
+     * @param program The root program command.
+     */
+    protected configureRoot(program: Command): void;
+}

package/dist/types/commands/mergeLocales.d.ts

@@ -0,0 +1,21 @@
+import type { Command } from "commander";
+import type { IMergeLocalesConfig } from "../models/IMergeLocalesConfig";
+/**
+ * Build the root command to be consumed by the CLI.
+ * @param program The command to build on.
+ */
+export declare function buildCommandMergeLocales(program: Command): void;
+/**
+ * Action the root command.
+ * @param opts The options for the command.
+ * @param opts.config The optional configuration file.
+ */
+export declare function actionCommandMergeLocales(opts: {
+    config?: string;
+}): Promise<void>;
+/**
+ * Merge the locales.
+ * @param workingDirectory The folder the app was run from.
+ * @param config The configuration for the app.
+ */
+export declare function mergeLocales(workingDirectory: string, config: IMergeLocalesConfig): Promise<void>;

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./cli";
+export * from "./commands/mergeLocales";
+export * from "./models/IMergeLocalesConfig";

package/dist/types/models/IMergeLocalesConfig.d.ts

@@ -0,0 +1,22 @@
+import type { ILocale } from "@twin.org/core";
+/**
+ * Configuration for the CLI.
+ */
+export interface IMergeLocalesConfig {
+    /**
+     * The languages to include while merging, if none are supplied only English will be included.
+     */
+    locales?: ILocale[];
+    /**
+     * Additional packages to add locales for, which are not part of the dependencies.
+     */
+    includePackages?: string[];
+    /**
+     * Packages to exclude from the locales.
+     */
+    excludePackages?: string[];
+    /**
+     * Output directory for the merged locales.
+     */
+    outputDirectory?: string;
+}

package/dist/types/models/IPackageJson.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Configuration for each individual package.
+ */
+export interface IPackageJson {
+    /**
+     * The name of the package.
+     */
+    name?: string;
+    /**
+     * The dependencies for the package.
+     */
+    dependencies?: {
+        [id: string]: string;
+    };
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/ts-to-openapi - Changelog
+
+## v0.0.1
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1,15 @@
+# @twin.org/merge-locales - Examples
+
+## Command Line Tool
+
+First install the tool with the following script.
+
+```shell
+npm install @twin.org/merge-locales
+```
+
+You can then run the tool from the command line e.g.
+
+```shell
+merge-locales
+```

package/docs/reference/classes/CLI.md

@@ -0,0 +1,67 @@
+# Class: CLI
+
+The main entry point for the CLI.
+
+## Extends
+
+- `CLIBase`
+
+## Constructors
+
+### new CLI()
+
+> **new CLI**(): [`CLI`](CLI.md)
+
+#### Returns
+
+[`CLI`](CLI.md)
+
+#### Inherited from
+
+`CLIBase.constructor`
+
+## Methods
+
+### run()
+
+> **run**(`argv`, `localesDirectory`?): `Promise`\<`number`\>
+
+Run the app.
+
+#### Parameters
+
+• **argv**: `string`[]
+
+The process arguments.
+
+• **localesDirectory?**: `string`
+
+The directory for the locales, default to relative to the script.
+
+#### Returns
+
+`Promise`\<`number`\>
+
+The exit code.
+
+***
+
+### configureRoot()
+
+> `protected` **configureRoot**(`program`): `void`
+
+Configure any options or actions at the root program level.
+
+#### Parameters
+
+• **program**: `Command`
+
+The root program command.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+`CLIBase.configureRoot`

package/docs/reference/functions/actionCommandMergeLocales.md

@@ -0,0 +1,19 @@
+# Function: actionCommandMergeLocales()
+
+> **actionCommandMergeLocales**(`opts`): `Promise`\<`void`\>
+
+Action the root command.
+
+## Parameters
+
+• **opts**
+
+The options for the command.
+
+• **opts.config?**: `string`
+
+The optional configuration file.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/buildCommandMergeLocales.md

@@ -0,0 +1,15 @@
+# Function: buildCommandMergeLocales()
+
+> **buildCommandMergeLocales**(`program`): `void`
+
+Build the root command to be consumed by the CLI.
+
+## Parameters
+
+• **program**: `Command`
+
+The command to build on.
+
+## Returns
+
+`void`

package/docs/reference/functions/mergeLocales.md

@@ -0,0 +1,19 @@
+# Function: mergeLocales()
+
+> **mergeLocales**(`workingDirectory`, `config`): `Promise`\<`void`\>
+
+Merge the locales.
+
+## Parameters
+
+• **workingDirectory**: `string`
+
+The folder the app was run from.
+
+• **config**: [`IMergeLocalesConfig`](../interfaces/IMergeLocalesConfig.md)
+
+The configuration for the app.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/globals.md

@@ -0,0 +1,15 @@
+# @twin.org/merge-locales
+
+## Classes
+
+- [CLI](classes/CLI.md)
+
+## Interfaces
+
+- [IMergeLocalesConfig](interfaces/IMergeLocalesConfig.md)
+
+## Functions
+
+- [buildCommandMergeLocales](functions/buildCommandMergeLocales.md)
+- [actionCommandMergeLocales](functions/actionCommandMergeLocales.md)
+- [mergeLocales](functions/mergeLocales.md)

package/docs/reference/interfaces/IMergeLocalesConfig.md

@@ -0,0 +1,35 @@
+# Interface: IMergeLocalesConfig
+
+Configuration for the CLI.
+
+## Properties
+
+### locales?
+
+> `optional` **locales**: `ILocale`[]
+
+The languages to include while merging, if none are supplied only English will be included.
+
+***
+
+### includePackages?
+
+> `optional` **includePackages**: `string`[]
+
+Additional packages to add locales for, which are not part of the dependencies.
+
+***
+
+### excludePackages?
+
+> `optional` **excludePackages**: `string`[]
+
+Packages to exclude from the locales.
+
+***
+
+### outputDirectory?
+
+> `optional` **outputDirectory**: `string`
+
+Output directory for the merged locales.

package/locales/en.json

@@ -0,0 +1,40 @@
+{
+	"error": {
+		"commands": {
+			"merge-locales": {
+				"configFailed": "Configuration failed to load."
+			}
+		}
+	},
+	"commands": {
+		"merge-locales": {
+			"options": {
+				"config": {
+					"param": "--config '<'file'>'",
+					"description": "Path to the JSON configuration file."
+				}
+			},
+			"progress": {
+				"loadingConfigJson": "Loading Config JSON",
+				"creatingOutputDirectory": "Creating Output Directory",
+				"writingMergedLocales": "Writing Merged Locales",
+				"mergingLocalesForPackage": "Merging Locales for Package"
+			},
+			"labels": {
+				"configJson": "Config JSON",
+				"workingDirectory": "Working Directory",
+				"outputDirectory": "Output Directory",
+				"npmRoot": "NPM Root",
+				"sourcePackages": "Source Packages",
+				"writingLocale": "Writing Locale",
+				"mergingLocale": "Merging Locale"
+			}
+		}
+	},
+	"cli": {
+		"progress": {
+			"done": "Done.",
+			"error": "Error"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,83 @@
+{
+	"name": "@twin.org/merge-locales",
+	"version": "0.0.1-next.1",
+	"description": "Tool to merge locale files from all dependencies",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/tools.git",
+		"directory": "packages/merge-locales"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage",
+		"build": "tspc",
+		"merge-locales": "copyfiles locales/en.json dist && npm run bundle:esm && node bin/index.js",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run merge-locales && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@gtsc/core": "npm:@twin.org/core@next",
+		"@gtsc/crypto": "npm:@twin.org/crypto@next",
+		"@twin.org/cli-core": "next",
+		"@twin.org/core": "next",
+		"@twin.org/nameof": "0.0.1-next.1",
+		"commander": "12.1.0",
+		"glob": "11.0.0"
+	},
+	"devDependencies": {
+		"@twin.org/nameof-transformer": "0.0.1-next.1",
+		"@types/node": "22.5.5",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"rimraf": "6.0.1",
+		"rollup": "4.21.3",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		}
+	},
+	"files": [
+		"bin",
+		"dist/cjs",
+		"dist/esm",
+		"dist/locales",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"bin": {
+		"merge-locales": "bin/index.js"
+	},
+	"directories": {
+		"doc": "docs",
+		"test": "tests"
+	},
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/tools/issues"
+	},
+	"homepage": "https://github.com/twinfoundation/tools#readme"
+}