@twin.org/validate-locales 0.0.2-next.21

package/dist/locales/en.json

@@ -0,0 +1,216 @@
+{
+	"error": {
+		"commands": {
+			"common": {
+				"missingEnv": "The \"{option}\" option is configured as an environment variable, but there is no environment variable with the name \"{value}\" set.",
+				"optionInvalidHex": "The \"{option}\" does not appear to be hex. \"{value}\"",
+				"optionInvalidBase64": "The \"{option}\" does not appear to be base64. \"{value}\"",
+				"optionInvalidHexBase64": "The \"{option}\" does not appear to be hex or base64. \"{value}\"",
+				"optionMinValue": "The \"{option}\" option must be greater than or equal to {minValue}, it is {value}.",
+				"optionMaxValue": "The \"{option}\" option must be less than or equal to {maxValue}, it is {value}."
+			}
+		},
+		"validation": {
+			"beEmpty": "{fieldName} must be empty",
+			"beNotEmpty": "{fieldName} must not be empty",
+			"beText": "{fieldName} must be text",
+			"beTextValue": "{fieldName} must contain some text",
+			"beTextMinMax": "{fieldName} must be longer than {minLength} and shorter than {maxLength} characters",
+			"beTextMin": "{fieldName} must be longer than {minLength} characters",
+			"beTextMax": "{fieldName} must be shorter than {maxLength} characters",
+			"beTextBase58": "{fieldName} must be text formatted using Base58 characters",
+			"beTextBase64": "{fieldName} must be text formatted using Base64 characters",
+			"beTextHex": "{fieldName} must be text formatted using Hex characters",
+			"beTextRegExp": "{fieldName} must be text formatted using the matching pattern {format}",
+			"beNumber": "{fieldName} must be a number",
+			"beNumberMinMax": "{fieldName} must be >= {minValue} and <= {maxValue}",
+			"beNumberMin": "{fieldName} must be >= {minValue}",
+			"beNumberMax": "{fieldName} must be <= {maxValue}",
+			"beWholeNumber": "{fieldName} must be a whole number",
+			"beWholeNumberMinMax": "{fieldName} must be a whole number >= {minValue} and <= {maxValue}",
+			"beWholeNumberMin": "{fieldName} must be a whole number >= {minValue}",
+			"beWholeNumberMax": "{fieldName} must be a whole number <= {maxValue}",
+			"beBigInteger": "{fieldName} must be a bigint",
+			"beBigIntegerMinMax": "{fieldName} must be a bigint >= {minValue} and <= {maxValue}",
+			"beBigIntegerMin": "{fieldName} must be a bigint >= {minValue}",
+			"beBigIntegerMax": "{fieldName} must be a bigint <= {maxValue}",
+			"beBoolean": "{fieldName} must be true or false",
+			"beDate": "{fieldName} must be a date",
+			"beDateTime": "{fieldName} must be a date/time",
+			"beTime": "{fieldName} must be a time",
+			"beTimestampMilliseconds": "{fieldName} must be a timestamp in milliseconds",
+			"beTimestampSeconds": "{fieldName} must be a timestamp in seconds",
+			"beObject": "{fieldName} must be an object",
+			"beArray": "{fieldName} must be an array",
+			"beArrayValue": "{fieldName} must be an array with at least one item",
+			"beIncluded": "{fieldName} is unrecognised",
+			"beByteArray": "{fieldName} must be a byte array",
+			"beUrn": "{fieldName} must be a correctly formatted urn",
+			"beUrl": "{fieldName} must be a correctly formatted url",
+			"beJSON": "{fieldName} must be correctly formatted JSON",
+			"beEmail": "{fieldName} must be a correctly formatted e-mail address"
+		},
+		"guard": {
+			"undefined": "Property \"{property}\" must be defined, it is \"{value}\"",
+			"string": "Property \"{property}\" must be a string, it is \"{value}\"",
+			"stringEmpty": "Property \"{property}\" must have a value, it is empty",
+			"stringBase64": "Property \"{property}\" must be a base64 encoded string, it is \"{value}\"",
+			"stringBase64Url": "Property \"{property}\" must be a base64 url encoded string, it is \"{value}\"",
+			"stringBase58": "Property \"{property}\" must be a base58 encoded string, it is \"{value}\"",
+			"stringHex": "Property \"{property}\" must be a hex string, it is \"{value}\"",
+			"stringHexLength": "Property \"{property}\" must be a hex string of length \"{options}\", it is \"{value}\"",
+			"stringJson": "Property \"{property}\" must be a JSON string",
+			"number": "Property \"{property}\" must be a number, it is \"{value}\"",
+			"integer": "Property \"{property}\" must be an integer, it is \"{value}\"",
+			"bigint": "Property \"{property}\" must be a bigint, it is \"{value}\"",
+			"boolean": "Property \"{property}\" must be a boolean, it is \"{value}\"",
+			"date": "Property \"{property}\" must be a date, it is \"{value}\"",
+			"timestampMilliseconds": "Property \"{property}\" must be a timestamp in milliseconds, it is \"{value}\"",
+			"timestampSeconds": "Property \"{property}\" must be a timestamp in seconds, it is \"{value}\"",
+			"objectUndefined": "Property \"{property}\" must be an object, it is \"undefined\"",
+			"object": "Property \"{property}\" must be an object, it is \"{value}\"",
+			"objectValue": "Property \"{property}\" must be an object, with at least one property, it is \"{value}\"",
+			"array": "Property \"{property}\" must be an array, it is \"{value}\"",
+			"arrayValue": "Property \"{property}\" must be an array with at least one item",
+			"arrayOneOf": "Property \"{property}\" must be one of [{options}], it is \"{value}\"",
+			"arrayStartsWith": "Property \"{property}\" must be an array starting with [{startValues}], it is \"{value}\"",
+			"arrayEndsWith": "Property \"{property}\" must be an array ending with [{endValues}], it is \"{value}\"",
+			"uint8Array": "Property \"{property}\" must be a Uint8Array, it is \"{value}\"",
+			"function": "Property \"{property}\" must be a function, it is \"{value}\"",
+			"urn": "Property \"{property}\" must be a Urn formatted string, it is \"{value}\"",
+			"url": "Property \"{property}\" must be a Url formatted string, it is \"{value}\"",
+			"email": "Property \"{property}\" must be string in e-mail format, it is \"{value}\""
+		},
+		"objectHelper": {
+			"failedBytesToJSON": "Failed converting bytes to JSON",
+			"cannotSetArrayIndex": "Cannot set property \"{property}\" using index \"{index}\" as it is not an array",
+			"cannotSetProperty": "Cannot set property \"{property}\" when the target is not an object"
+		},
+		"common": {
+			"notImplementedMethod": "The method \"{method}\" has not been implemented",
+			"validation": "Validation failed"
+		},
+		"factory": {
+			"noUnregister": "There is no {typeName} registered with the name \"{name}\"",
+			"noGet": "The requested {typeName} \"{name}\" does not exist in the factory"
+		},
+		"bitString": {
+			"outOfRange": "The index should be >= 0 and less than the length of the bit string, the index is \"{index}\" and the number of bit is \"{numberBits}\""
+		},
+		"base32": {
+			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
+		},
+		"base64": {
+			"length4Multiple": "Invalid length should be a multiple of 4, it is \"{value}\""
+		},
+		"base58": {
+			"invalidCharacter": "Data contains a character \"{invalidCharacter}\" which is not in the charset"
+		},
+		"jsonHelper": {
+			"failedPatch": "Failed to patch the JSON object, patch index \"{index}\" failed"
+		},
+		"validateLocales": {
+			"validationFailed": "Validation failed.",
+			"unusedLocaleEntry": "Locale entry \"{key}\" is not used in the source files.",
+			"usesSingleQuotes": "Locale entry \"{key}\" uses single quotes around a parameter. Use double quotes otherwise the value will not be substituted correctly.",
+			"missingLocaleEntry": "Locale entry \"{key}\" is missing from the locale file it is referenced in source file \"{source}:{line}:{column}\".",
+			"unableToProcessContent": "Unable to process content \"{content}\".",
+			"missingPropertyInLocale": "Missing property \"{property}\" when referencing key \"{key}\" in source file \"{source}:{line}:{column}\"."
+		}
+	},
+	"warn": {
+		"common": {
+			"devOnlyTool": "This tool is intended to be used for development purposes, it is not recommended for use in production scenarios."
+		}
+	},
+	"cli": {
+		"progress": {
+			"done": "Done.",
+			"error": "Error",
+			"loadingEnvFiles": "Loading env files",
+			"pleaseWait": "Please wait...",
+			"writingJsonFile": "Writing JSON file",
+			"writingEnvFile": "Writing env file",
+			"readingJsonFile": "Reading JSON file",
+			"readingEnvFile": "Reading env file"
+		},
+		"options": {
+			"lang": {
+				"param": "--lang '<'lang'>'",
+				"description": "The language to display the output in."
+			},
+			"load-env": {
+				"param": "--load-env [env...]",
+				"description": "Load the env files to initialise any environment variables."
+			},
+			"no-console": {
+				"param": "--no-console",
+				"description": "Hides the output in the console."
+			},
+			"json": {
+				"param": "--json '<'filename'>'",
+				"description": "Creates a JSON file containing the output."
+			},
+			"env": {
+				"param": "--env '<'filename'>'",
+				"description": "Creates an env file containing the output."
+			},
+			"merge-json": {
+				"param": "--merge-json",
+				"description": "If the JSON file already exists merge the data instead of overwriting."
+			},
+			"merge-env": {
+				"param": "--merge-env",
+				"description": "If the env file already exists merge the data instead of overwriting."
+			}
+		}
+	},
+	"errorNames": {
+		"error": "Error",
+		"generalError": "General",
+		"guardError": "Guard",
+		"conflictError": "Conflict",
+		"notFoundError": "Not Found",
+		"notSupportedError": "Not Supported",
+		"alreadyExistsError": "Already Exists",
+		"notImplementedError": "Not Implemented",
+		"validationError": "Validation",
+		"unprocessableError": "Unprocessable",
+		"unauthorizedError": "Unauthorized"
+	},
+	"validation": {
+		"defaultFieldName": "The field"
+	},
+	"commands": {
+		"validate-locales": {
+			"options": {
+				"source": {
+					"param": "--source '<'glob'>'",
+					"description": "Glob for the source files to check."
+				},
+				"locales": {
+					"param": "--locales '<'glob'>'",
+					"description": "Glob for the locale files to check."
+				},
+				"ignoreFile": {
+					"param": "--ignoreFile <'path'>",
+					"description": "File containing keys to ignore."
+				}
+			},
+			"progress": {
+				"validatingLocale": "Validating locale: {localeFile}"
+			},
+			"labels": {
+				"source": "Source",
+				"locales": "Locales",
+				"ignoreFile": "Ignore file",
+				"noMissingLocaleEntries": "✅  No missing locale entries found",
+				"noUnusedLocaleEntries": "✅  No unused locale entries found"
+			},
+			"warnings": {
+				"noSourceFiles": "No source files found to validate.",
+				"noLocaleFiles": "No locale files found to validate."
+			}
+		}
+	}
+}

package/dist/types/cli.d.ts

@@ -0,0 +1,23 @@
+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.
+     * @param options Additional options.
+     * @param options.overrideOutputWidth Override the output width.
+     * @returns The exit code.
+     */
+    run(argv: string[], localesDirectory?: string, options?: {
+        overrideOutputWidth?: number;
+    }): 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/validateLocales.d.ts

@@ -0,0 +1,18 @@
+import type { Command } from "commander";
+/**
+ * Build the root command to be consumed by the CLI.
+ * @param program The command to build on.
+ */
+export declare function buildCommandValidateLocales(program: Command): void;
+/**
+ * Action the root command.
+ * @param opts The options for the command.
+ * @param opts.source The source glob.
+ * @param opts.locales The locales glob.
+ * @param opts.ignoreFile The ignore file path.
+ */
+export declare function actionCommandValidateLocales(opts: {
+    source: string;
+    locales: string;
+    ignoreFile: string;
+}): Promise<void>;

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./cli";
+export * from "./commands/validateLocales";

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

@@ -0,0 +1,25 @@
+/**
+ * Model for a locale dictionary entry.
+ */
+export interface ILocaleDictionaryEntry {
+    /**
+     * The locale.
+     */
+    locale: string;
+    /**
+     * The key.
+     */
+    key: string;
+    /**
+     * The value.
+     */
+    value: string;
+    /**
+     * The property names.
+     */
+    propertyNames: string[];
+    /**
+     * Whether the entry is referenced in the source code.
+     */
+    referenced: boolean;
+}

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

@@ -0,0 +1,25 @@
+/**
+ * Model for a locale dictionary missing reference.
+ */
+export interface ILocaleMissingReference {
+    /**
+     * The type of the missing reference.
+     */
+    type: string;
+    /**
+     * The key of the missing reference.
+     */
+    key: string;
+    /**
+     * The source file for the missing reference.
+     */
+    source: string;
+    /**
+     * The line number for the missing reference.
+     */
+    line: number;
+    /**
+     * The column number for the missing reference.
+     */
+    column: number;
+}

package/docs/changelog.md

@@ -0,0 +1,22 @@
+# Changelog
+
+## [0.0.2-next.21](https://github.com/twinfoundation/framework/compare/validate-locales-v0.0.2-next.20...validate-locales-v0.0.2-next.21) (2025-10-09)
+
+
+### Features
+
+* locales validation ([#197](https://github.com/twinfoundation/framework/issues/197)) ([55fdadb](https://github.com/twinfoundation/framework/commit/55fdadb13595ce0047f787bd1d4135d429a99f12))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/cli-core bumped from 0.0.2-next.20 to 0.0.2-next.21
+    * @twin.org/core bumped from 0.0.2-next.20 to 0.0.2-next.21
+    * @twin.org/nameof bumped from 0.0.2-next.20 to 0.0.2-next.21
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.20 to 0.0.2-next.21
+  * devDependencies
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.20 to 0.0.2-next.21
+
+## @twin.org/validate-locales - Changelog

package/docs/examples.md

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

package/docs/reference/classes/CLI.md

@@ -0,0 +1,83 @@
+# Class: CLI
+
+The main entry point for the CLI.
+
+## Extends
+
+- `CLIBase`
+
+## Constructors
+
+### Constructor
+
+> **new CLI**(): `CLI`
+
+#### Returns
+
+`CLI`
+
+#### Inherited from
+
+`CLIBase.constructor`
+
+## Methods
+
+### run()
+
+> **run**(`argv`, `localesDirectory?`, `options?`): `Promise`\<`number`\>
+
+Run the app.
+
+#### Parameters
+
+##### argv
+
+`string`[]
+
+The process arguments.
+
+##### localesDirectory?
+
+`string`
+
+The directory for the locales, default to relative to the script.
+
+##### options?
+
+Additional options.
+
+###### overrideOutputWidth?
+
+`number`
+
+Override the output width.
+
+#### 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/actionCommandValidateLocales.md

@@ -0,0 +1,33 @@
+# Function: actionCommandValidateLocales()
+
+> **actionCommandValidateLocales**(`opts`): `Promise`\<`void`\>
+
+Action the root command.
+
+## Parameters
+
+### opts
+
+The options for the command.
+
+#### source
+
+`string`
+
+The source glob.
+
+#### locales
+
+`string`
+
+The locales glob.
+
+#### ignoreFile
+
+`string`
+
+The ignore file path.
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/reference/functions/buildCommandValidateLocales.md

@@ -0,0 +1,17 @@
+# Function: buildCommandValidateLocales()
+
+> **buildCommandValidateLocales**(`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/index.md

@@ -0,0 +1,10 @@
+# @twin.org/validate-locales
+
+## Classes
+
+- [CLI](classes/CLI.md)
+
+## Functions
+
+- [buildCommandValidateLocales](functions/buildCommandValidateLocales.md)
+- [actionCommandValidateLocales](functions/actionCommandValidateLocales.md)

package/locales/.validate-ignore

@@ -0,0 +1,2 @@
+===>
+<===

package/locales/en.json

@@ -0,0 +1,44 @@
+{
+	"error": {
+		"validateLocales": {
+			"validationFailed": "Validation failed.",
+			"unusedLocaleEntry": "Locale entry \"{key}\" is not used in the source files.",
+			"usesSingleQuotes": "Locale entry \"{key}\" uses single quotes around a parameter. Use double quotes otherwise the value will not be substituted correctly.",
+			"missingLocaleEntry": "Locale entry \"{key}\" is missing from the locale file it is referenced in source file \"{source}:{line}:{column}\".",
+			"unableToProcessContent": "Unable to process content \"{content}\".",
+			"missingPropertyInLocale": "Missing property \"{property}\" when referencing key \"{key}\" in source file \"{source}:{line}:{column}\"."
+		}
+	},
+	"commands": {
+		"validate-locales": {
+			"options": {
+				"source": {
+					"param": "--source '<'glob'>'",
+					"description": "Glob for the source files to check."
+				},
+				"locales": {
+					"param": "--locales '<'glob'>'",
+					"description": "Glob for the locale files to check."
+				},
+				"ignoreFile": {
+					"param": "--ignoreFile <'path'>",
+					"description": "File containing keys to ignore."
+				}
+			},
+			"progress": {
+				"validatingLocale": "Validating locale: {localeFile}"
+			},
+			"labels": {
+				"source": "Source",
+				"locales": "Locales",
+				"ignoreFile": "Ignore file",
+				"noMissingLocaleEntries": "✅  No missing locale entries found",
+				"noUnusedLocaleEntries": "✅  No unused locale entries found"
+			},
+			"warnings": {
+				"noSourceFiles": "No source files found to validate.",
+				"noLocaleFiles": "No locale files found to validate."
+			}
+		}
+	}
+}

package/package.json

@@ -0,0 +1,62 @@
+{
+	"name": "@twin.org/validate-locales",
+	"version": "0.0.2-next.21",
+	"description": "Tool to validate source files against the locales",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/framework.git",
+		"directory": "apps/validate-locales"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/cli-core": "0.0.2-next.21",
+		"@twin.org/core": "0.0.2-next.21",
+		"@twin.org/nameof": "0.0.2-next.21",
+		"@twin.org/nameof-transformer": "0.0.2-next.21",
+		"commander": "14.0.1",
+		"glob": "11.0.3",
+		"typescript": "5.9.2"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		}
+	},
+	"files": [
+		"bin",
+		"dist/cjs",
+		"dist/esm",
+		"dist/locales",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"bin": {
+		"validate-locales": "bin/index.js"
+	},
+	"directories": {
+		"doc": "docs",
+		"test": "tests"
+	},
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/framework/issues"
+	},
+	"homepage": "https://twindev.org",
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain"
+	]
+}