@twin.org/validate-locales 0.0.2-next.21 → 0.0.3-next.1

package/bin/index.js

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

package/dist/es/cli.js

@@ -0,0 +1,37 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { CLIBase } from "@twin.org/cli-core";
+import { buildCommandValidateLocales } from "./commands/validateLocales.js";
+/**
+ * The main entry point for the CLI.
+ */
+export 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.
+     */
+    async run(argv, localesDirectory, options) {
+        return this.execute({
+            title: "TWIN Validate Locales",
+            appName: "validate-locales",
+            version: "0.0.3-next.1", // x-release-please-version
+            icon: "⚙️ ",
+            supportsEnvFiles: false,
+            overrideOutputWidth: options?.overrideOutputWidth
+        }, 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) {
+        buildCommandValidateLocales(program);
+    }
+}
+//# sourceMappingURL=cli.js.map

package/dist/es/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../src/cli.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAE5E;;GAEG;AACH,MAAM,OAAO,GAAI,SAAQ,OAAO;IAC/B;;;;;;;OAOG;IACI,KAAK,CAAC,GAAG,CACf,IAAc,EACd,gBAAyB,EACzB,OAA0C;QAE1C,OAAO,IAAI,CAAC,OAAO,CAClB;YACC,KAAK,EAAE,uBAAuB;YAC9B,OAAO,EAAE,kBAAkB;YAC3B,OAAO,EAAE,cAAc,EAAE,2BAA2B;YACpD,IAAI,EAAE,KAAK;YACX,gBAAgB,EAAE,KAAK;YACvB,mBAAmB,EAAE,OAAO,EAAE,mBAAmB;SACjD,EACD,gBAAgB,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,YAAY,CAAC,EACzF,IAAI,CACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACO,aAAa,CAAC,OAAgB;QACvC,2BAA2B,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;CACD","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport { CLIBase } from \"@twin.org/cli-core\";\nimport type { Command } from \"commander\";\nimport { buildCommandValidateLocales } from \"./commands/validateLocales.js\";\n\n/**\n * The main entry point for the CLI.\n */\nexport class CLI extends CLIBase {\n\t/**\n\t * Run the app.\n\t * @param argv The process arguments.\n\t * @param localesDirectory The directory for the locales, default to relative to the script.\n\t * @param options Additional options.\n\t * @param options.overrideOutputWidth Override the output width.\n\t * @returns The exit code.\n\t */\n\tpublic async run(\n\t\targv: string[],\n\t\tlocalesDirectory?: string,\n\t\toptions?: { overrideOutputWidth?: number }\n\t): Promise<number> {\n\t\treturn this.execute(\n\t\t\t{\n\t\t\t\ttitle: \"TWIN Validate Locales\",\n\t\t\t\tappName: \"validate-locales\",\n\t\t\t\tversion: \"0.0.3-next.1\", // x-release-please-version\n\t\t\t\ticon: \"⚙️ \",\n\t\t\t\tsupportsEnvFiles: false,\n\t\t\t\toverrideOutputWidth: options?.overrideOutputWidth\n\t\t\t},\n\t\t\tlocalesDirectory ?? path.join(path.dirname(fileURLToPath(import.meta.url)), \"../locales\"),\n\t\t\targv\n\t\t);\n\t}\n\n\t/**\n\t * Configure any options or actions at the root program level.\n\t * @param program The root program command.\n\t */\n\tprotected configureRoot(program: Command): void {\n\t\tbuildCommandValidateLocales(program);\n\t}\n}\n"]}

package/dist/{esm/index.mjs → es/commands/validateLocales.js}

@@ -1,14 +1,12 @@
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-import { CLIDisplay, CLIUtils, CLIBase } from '@twin.org/cli-core';
-import { readFile } from 'node:fs/promises';
-import { I18n, Is, GeneralError, StringHelper } from '@twin.org/core';
-import { manual } from '@twin.org/nameof-transformer';
-import * as glob from 'glob';
-import * as ts from 'typescript';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import { CLIDisplay, CLIUtils } from "@twin.org/cli-core";
+import { GeneralError, I18n, Is, StringHelper } from "@twin.org/core";
+import { manual } from "@twin.org/nameof-transformer";
+import * as glob from "glob";
+import * as ts from "typescript";
 const ERROR_TYPES = [
     { name: "GeneralError", dynamicPropertyIndex: 2 },
     { name: "GuardError", dynamicPropertyIndex: -1 },
@@ -23,7 +21,7 @@ const ERROR_TYPES = [
 ];
 const SKIP_FILES = ["**/models/**/*.ts"];
 const SKIP_LITERALS = [
-    /\d+\.\d+\.\d+(-\w+(\.\w+)*)?$/, // Version string
+    /^\d+\.\d+\.\d+(-\w+(\.\w+)*)?(-\d)?$/, // Version string
     /^[^@]+@[^@]+\.[^@]+$/, // Email string
     /\.json$/i, // ending in .json
     /\.js$/i, // ending in .js
@@ -33,7 +31,8 @@ const SKIP_LITERALS = [
     /\.lock$/i, // ending in .lock
     /\.toml$/i, // ending in .toml
     /\.{3}/i, // ...
-    /@twin\.org/ // starting with @twin.org
+    /@twin\.org/, // starting with @twin.org
+    /^console.log/i // console.log
 ];
 const SKIP_METHODS = [/^generateRest/, /^generateSocket/];
 const CAPTURE_VARIABLES = [/ROUTES_SOURCE/];
@@ -41,7 +40,7 @@ const CAPTURE_VARIABLES = [/ROUTES_SOURCE/];
  * Build the root command to be consumed by the CLI.
  * @param program The command to build on.
  */
-function buildCommandValidateLocales(program) {
+export function buildCommandValidateLocales(program) {
     program
         .option(I18n.formatMessage("commands.validate-locales.options.source.param"), I18n.formatMessage("commands.validate-locales.options.source.description"), "src/**/*.ts")
         .option(I18n.formatMessage("commands.validate-locales.options.locales.param"), I18n.formatMessage("commands.validate-locales.options.locales.description"), "locales/**/*.json")
@@ -57,7 +56,7 @@ function buildCommandValidateLocales(program) {
  * @param opts.locales The locales glob.
  * @param opts.ignoreFile The ignore file path.
  */
-async function actionCommandValidateLocales(opts) {
+export async function actionCommandValidateLocales(opts) {
     opts.source = path.resolve(opts.source);
     opts.locales = path.resolve(opts.locales);
     opts.ignoreFile = path.resolve(opts.ignoreFile);
@@ -93,7 +92,7 @@ async function validateLocales(sourceFiles, localeFiles, ignore) {
     const localeEntries = [];
     let hasQuoteError = false;
     let hasUnused = false;
-    let hasMissing = false;
+    let hasFailures = false;
     for (const localeFile of localeFiles) {
         const dictionary = await CLIUtils.readJsonFile(localeFile);
         const locale = path.basename(localeFile, path.extname(localeFile));
@@ -118,27 +117,27 @@ async function validateLocales(sourceFiles, localeFiles, ignore) {
                 });
             }
         }
-        let missing = [];
+        let failures = [];
         const captureVariables = {};
         for (const sourceFile of sourceFiles) {
             const source = await readFile(sourceFile, "utf8");
             const sourceTs = ts.createSourceFile(sourceFile, source, ts.ScriptTarget.ESNext, true, ts.ScriptKind.TS);
-            visit(sourceTs, sourceTs, localeEntries, missing, captureVariables);
+            visit(sourceTs, sourceTs, localeEntries, failures, captureVariables);
         }
-        missing = missing.filter(mr => !ignore.some(pattern => pattern.test(mr.key)));
-        if (missing.length === 0) {
+        failures = failures.filter(mr => !ignore.some(pattern => pattern.test(mr.key)));
+        if (failures.length === 0) {
             CLIDisplay.write(I18n.formatMessage("commands.validate-locales.labels.noMissingLocaleEntries"));
             CLIDisplay.break();
         }
         else {
-            hasMissing = true;
-            for (const missingRef of missing) {
-                if (missingRef.type === "key") {
+            hasFailures = true;
+            for (const failureRef of failures) {
+                if (failureRef.type === "key") {
                     CLIDisplay.errorMessage(I18n.formatMessage("error.validateLocales.missingLocaleEntry", {
-                        key: missingRef.key,
-                        source: missingRef.source,
-                        line: missingRef.line,
-                        column: missingRef.column
+                        key: failureRef.key,
+                        source: failureRef.source,
+                        line: failureRef.line,
+                        column: failureRef.column
                     }));
                 }
             }
@@ -164,7 +163,7 @@ async function validateLocales(sourceFiles, localeFiles, ignore) {
             }
         }
     }
-    if (hasMissing || hasUnused || hasQuoteError) {
+    if (hasFailures || hasUnused || hasQuoteError) {
         throw new GeneralError("validateLocales", "validationFailed");
     }
 }
@@ -173,43 +172,43 @@ async function validateLocales(sourceFiles, localeFiles, ignore) {
  * @param sourceFile The TypeScript source file for position calculations.
  * @param node The node to visit.
  * @param localeEntries The locale entries.
- * @param missing The missing entries.
+ * @param failures The failure entries.
  * @param captureVariables The capture variables.
  */
-function visit(sourceFile, node, localeEntries, missing, captureVariables) {
+function visit(sourceFile, node, localeEntries, failures, captureVariables) {
     let handled = false;
     if (ts.isNewExpression(node) &&
         ts.isIdentifier(node.expression) &&
         ERROR_TYPES.some(errorType => errorType.name === node.expression.getText())) {
-        processErrorType(sourceFile, node, node.expression.text, localeEntries, missing);
+        processErrorType(sourceFile, node, node.expression.text, localeEntries, failures);
         handled = true;
     }
     else if (ts.isStringLiteral(node)) {
-        processStringLiteral(sourceFile, node, localeEntries, missing);
+        processStringLiteral(sourceFile, node, localeEntries, failures);
         handled = true;
     }
     else if (ts.isTemplateExpression(node)) {
-        processTemplateExpression(sourceFile, node, localeEntries, missing);
+        processTemplateExpression(sourceFile, node, localeEntries, failures);
         handled = true;
     }
     else if (ts.isCallExpression(node)) {
-        handled = processCallExpression(sourceFile, node, localeEntries, missing, captureVariables);
+        handled = processCallExpression(sourceFile, node, localeEntries, failures, captureVariables);
     }
     else if (ts.isFunctionDeclaration(node)) {
-        handled = processFunctionDeclaration(sourceFile, node);
+        handled = processFunctionDeclaration(sourceFile, node, localeEntries, failures);
     }
     else if (ts.isVariableDeclaration(node)) {
-        handled = processVariableDeclaration(sourceFile, node, localeEntries, missing, captureVariables);
+        handled = processVariableDeclaration(sourceFile, node, localeEntries, failures, captureVariables);
     }
     else if (ts.isImportDeclaration(node) || ts.isExportDeclaration(node)) {
         // Don't care about string in imports/exports
         handled = true;
     }
     else if (ts.isPropertyAssignment(node)) {
-        handled = processPropertyAssignment(sourceFile, node, localeEntries, missing);
+        handled = processPropertyAssignment(sourceFile, node, localeEntries, failures);
     }
     if (!handled) {
-        ts.forEachChild(node, child => visit(sourceFile, child, localeEntries, missing, captureVariables));
+        ts.forEachChild(node, child => visit(sourceFile, child, localeEntries, failures, captureVariables));
     }
 }
 /**
@@ -218,12 +217,12 @@ function visit(sourceFile, node, localeEntries, missing, captureVariables) {
  * @param node The node to process.
  * @param errorType The error type.
  * @param localeEntries The locale entries.
- * @param missing The missing entries.
+ * @param failures The failure entries.
  */
-function processErrorType(sourceFile, node, errorType, localeEntries, missing) {
+function processErrorType(sourceFile, node, errorType, localeEntries, failures) {
     const errType = ERROR_TYPES.find(e => e.name === errorType);
     if (Is.object(errType)) {
-        const localeKey = localeFromClassAndMessage(node.arguments?.[0], node.arguments?.[1], "error");
+        const localeKey = localeFromClassAndMessage(sourceFile, node.arguments?.[0], node.arguments?.[1], "error", failures);
         if (Is.stringValue(localeKey)) {
             const localeEntry = findAndReferenceLocale(localeEntries, localeKey);
             if (Is.object(localeEntry)) {
@@ -232,11 +231,11 @@ function processErrorType(sourceFile, node, errorType, localeEntries, missing) {
                     if (errType.dynamicPropertyIndex !== -1) {
                         usedProperties.push(...getPropertiesFromNode(node.arguments?.[errType.dynamicPropertyIndex]));
                     }
-                    checkPropertyUsage(sourceFile, node, localeEntry, localeKey, usedProperties, missing);
+                    checkPropertyUsage(sourceFile, node, localeEntry, localeKey, usedProperties, failures);
                 }
             }
             else {
-                missing.push({
+                failures.push({
                     type: "key",
                     key: localeKey,
                     source: path.resolve(sourceFile.fileName),
@@ -268,9 +267,9 @@ function findAndReferenceLocale(localeEntries, entryToMatch) {
  * @param sourceFile The TypeScript source file for position calculations.
  * @param node The node to process.
  * @param localeEntries The locale entries.
- * @param missing The missing entries.
+ * @param failures The failure entries.
  */
-function processStringLiteral(sourceFile, node, localeEntries, missing) {
+function processStringLiteral(sourceFile, node, localeEntries, failures) {
     if (node.text.length > 3 &&
         node.text.includes(".") &&
         !/[ ()/]/.test(node.text) &&
@@ -283,18 +282,18 @@ function processStringLiteral(sourceFile, node, localeEntries, missing) {
             if (localeEntry) {
                 localeEntry.referenced = true;
                 const usedProperties = getPropertiesFromNode(node);
-                checkPropertyUsage(sourceFile, node, localeEntry, node.text, usedProperties, missing);
+                checkPropertyUsage(sourceFile, node, localeEntry, node.text, usedProperties, failures);
             }
             if (!localeEntry && ["validation.", "common."].some(t => node.text.startsWith(t))) {
                 localeEntry = findAndReferenceLocale(localeEntries, `error.${node.text}`);
                 if (localeEntry) {
                     localeEntry.referenced = true;
                     const usedProperties = getPropertiesFromNode(node);
-                    checkPropertyUsage(sourceFile, node, localeEntry, `error.${node.text}`, usedProperties, missing);
+                    checkPropertyUsage(sourceFile, node, localeEntry, `error.${node.text}`, usedProperties, failures);
                 }
             }
             if (!localeEntry) {
-                missing.push({
+                failures.push({
                     type: "key",
                     key: node.text,
                     source: path.resolve(sourceFile.fileName),
@@ -309,9 +308,9 @@ function processStringLiteral(sourceFile, node, localeEntries, missing) {
  * @param sourceFile The TypeScript source file for position calculations.
  * @param node The node to process.
  * @param localeEntries The locale entries.
- * @param missing The missing entries.
+ * @param failures The failure entries.
  */
-function processTemplateExpression(sourceFile, node, localeEntries, missing) {
+function processTemplateExpression(sourceFile, node, localeEntries, failures) {
     // This case handles templates like `error.${nameof(Class)}.message`
     const templateParts = extractTemplatePartsWithExpressions(node);
     // Join all literal text parts to form a potential locale key
@@ -320,14 +319,14 @@ function processTemplateExpression(sourceFile, node, localeEntries, missing) {
         let localeEntry = findAndReferenceLocale(localeEntries, key);
         if (localeEntry) {
             const usedProperties = getPropertiesFromNode(node);
-            checkPropertyUsage(sourceFile, node, localeEntry, localeEntry.key, usedProperties, missing);
+            checkPropertyUsage(sourceFile, node, localeEntry, localeEntry.key, usedProperties, failures);
         }
         else if (["validation.", "common."].some(t => key.startsWith(t))) {
             localeEntry = findAndReferenceLocale(localeEntries, `error.${key}`);
             if (localeEntry) {
                 localeEntry.referenced = true;
                 const usedProperties = getPropertiesFromNode(node.parent.parent);
-                checkPropertyUsage(sourceFile, node, localeEntry, `error.${key}`, usedProperties, missing);
+                checkPropertyUsage(sourceFile, node, localeEntry, `error.${key}`, usedProperties, failures);
             }
         }
     }
@@ -337,14 +336,17 @@ function processTemplateExpression(sourceFile, node, localeEntries, missing) {
  * @param sourceFile The TypeScript source file for position calculations.
  * @param node The node to process.
  * @param localeEntries The locale entries.
- * @param missing The missing entries.
+ * @param failures The failure entries.
  * @param captureVariables The capture variables.
  * @returns True if processed, false otherwise.
  */
-function processCallExpression(sourceFile, node, localeEntries, missing, captureVariables) {
+function processCallExpression(sourceFile, node, localeEntries, failures, captureVariables) {
     if (ts.isPropertyAccessExpression(node.expression)) {
         const functionName = node.expression.name.getText();
-        if (functionName === "log" &&
+        if (node.expression.getText() === "console.log") {
+            return true;
+        }
+        else if (functionName === "log" &&
             node.arguments.length === 1 &&
             ts.isObjectLiteralExpression(node.arguments[0])) {
             let level;
@@ -375,14 +377,14 @@ function processCallExpression(sourceFile, node, localeEntries, missing, capture
                     }
                 }
             }
-            const localeKey = localeFromClassAndMessage(source, message, level);
+            const localeKey = localeFromClassAndMessage(sourceFile, source, message, level, failures);
             if (Is.stringValue(localeKey)) {
                 const localeEntry = findAndReferenceLocale(localeEntries, localeKey);
                 if (Is.object(localeEntry)) {
-                    checkPropertyUsage(sourceFile, node, localeEntry, localeKey, dataNames ?? [], missing);
+                    checkPropertyUsage(sourceFile, node, localeEntry, localeKey, dataNames ?? [], failures);
                 }
                 else {
-                    missing.push({
+                    failures.push({
                         type: "key",
                         key: localeKey,
                         source: path.resolve(sourceFile.fileName),
@@ -401,10 +403,10 @@ function processCallExpression(sourceFile, node, localeEntries, missing, capture
                 const dataNames = getPropertiesFromNode(node.arguments[1]);
                 const localeEntry = findAndReferenceLocale(localeEntries, localeKey);
                 if (Is.object(localeEntry)) {
-                    checkPropertyUsage(sourceFile, node, localeEntry, localeKey, dataNames ?? [], missing);
+                    checkPropertyUsage(sourceFile, node, localeEntry, localeKey, dataNames ?? [], failures);
                 }
                 else {
-                    missing.push({
+                    failures.push({
                         type: "key",
                         key: localeKey,
                         source: path.resolve(sourceFile.fileName),
@@ -422,10 +424,10 @@ function processCallExpression(sourceFile, node, localeEntries, missing, capture
  * @param sourceFile The TypeScript source file for position calculations.
  * @param node The node to process.
  * @param localeEntries The locale entries.
- * @param missing The missing entries.
+ * @param failures The failure entries.
  * @returns True if processed, false otherwise.
  */
-function processFunctionDeclaration(sourceFile, node, localeEntries, missing) {
+function processFunctionDeclaration(sourceFile, node, localeEntries, failures) {
     if (Is.object(node.name) &&
         ts.isIdentifier(node.name) &&
         SKIP_METHODS.some(re => re.test(node.name?.text ?? ""))) {
@@ -438,11 +440,11 @@ function processFunctionDeclaration(sourceFile, node, localeEntries, missing) {
  * @param sourceFile The TypeScript source file for position calculations.
  * @param node The node to process.
  * @param localeEntries The locale entries.
- * @param missing The missing entries.
+ * @param failures The failure entries.
  * @param captureVariables The capture variables.
  * @returns True if processed, false otherwise.
  */
-function processVariableDeclaration(sourceFile, node, localeEntries, missing, captureVariables) {
+function processVariableDeclaration(sourceFile, node, localeEntries, failures, captureVariables) {
     if (Is.object(node.name) &&
         Is.object(node.initializer) &&
         ts.isIdentifier(node.name) &&
@@ -458,10 +460,10 @@ function processVariableDeclaration(sourceFile, node, localeEntries, missing, ca
  * @param sourceFile The TypeScript source file for position calculations.
  * @param node The node to process.
  * @param localeEntries The locale entries.
- * @param missing The missing entries.
+ * @param failures The failure entries.
  * @returns True if processed, false otherwise.
  */
-function processPropertyAssignment(sourceFile, node, localeEntries, missing) {
+function processPropertyAssignment(sourceFile, node, localeEntries, failures) {
     if (Is.object(node.name) && ts.isIdentifier(node.name) && node.name.getText() === "message") {
         const localeKey = getExpandedText(node.initializer);
         if (Is.stringValue(localeKey)) {
@@ -470,7 +472,7 @@ function processPropertyAssignment(sourceFile, node, localeEntries, missing) {
                 localeEntry = findAndReferenceLocale(localeEntries, `error.${localeKey}`);
             }
             if (!Is.object(localeEntry)) {
-                missing.push({
+                failures.push({
                     type: "key",
                     key: localeKey,
                     source: path.resolve(sourceFile.fileName),
@@ -529,7 +531,7 @@ function extractTemplatePartsWithExpressions(node) {
  * @returns True if the template parts are valid, false otherwise.
  */
 function hasValidTemplateContent(templateParts) {
-    return !templateParts.some(part => /[ #,/:=?|]/.test(part));
+    return !templateParts.some(part => /[#,/:=?|]/.test(part));
 }
 /**
  * Expand template parts into a single string, processing nameof expressions.
@@ -573,9 +575,9 @@ function expandTemplatePart(templatePart) {
  * @param localeEntry The locale entry to check against.
  * @param key The key in the locale entry.
  * @param usedProperties The properties used in the code.
- * @param missing The missing entries.
+ * @param failures The failure entries.
  */
-function checkPropertyUsage(sourceFile, node, localeEntry, key, usedProperties, missing) {
+function checkPropertyUsage(sourceFile, node, localeEntry, key, usedProperties, failures) {
     for (const propName of localeEntry.propertyNames) {
         const propIndex = usedProperties.indexOf(propName);
         if (propIndex === -1) {
@@ -587,7 +589,7 @@ function checkPropertyUsage(sourceFile, node, localeEntry, key, usedProperties,
                 line: position.line,
                 column: position.column
             }));
-            missing.push({
+            failures.push({
                 type: "property",
                 key: localeEntry.key,
                 source: path.resolve(sourceFile.fileName),
@@ -673,66 +675,74 @@ function isSkipLiteral(value) {
 }
 /**
  * Get the locale from the class and message nodes.
+ * @param sourceFile The TypeScript source file for position calculations.
  * @param classNode The class node.
  * @param messageNode The message node.
  * @param prefix The prefix for the locale key.
+ * @param failures The failure entries.
  * @returns The locale entry or undefined.
  */
-function localeFromClassAndMessage(classNode, messageNode, prefix) {
+function localeFromClassAndMessage(sourceFile, classNode, messageNode, prefix, failures) {
     if (!classNode || !messageNode) {
         return undefined;
     }
     const classNameParam = classNode.getText();
     const classNameParamParts = classNameParam?.split(".");
     if (Is.array(classNameParamParts)) {
-        const localeKey = getExpandedText(messageNode);
-        if (Is.stringValue(localeKey)) {
-            const localeKeyParts = [];
-            if (Is.stringValue(prefix)) {
-                localeKeyParts.push(prefix);
+        const messageKey = getExpandedText(messageNode);
+        if (Is.stringValue(messageKey)) {
+            if (messageKey.includes(" ")) {
+                // If the message contains spaces then it is not a key
+                // but should be replaced by one
+                const position = getSourcePosition(sourceFile, messageNode);
+                CLIDisplay.errorMessage(I18n.formatMessage("error.validateLocales.shouldBeKey", {
+                    value: messageKey,
+                    source: path.resolve(sourceFile.fileName),
+                    line: position.line,
+                    column: position.column
+                }));
+                failures.push({
+                    type: "noKey",
+                    key: messageKey,
+                    source: path.resolve(sourceFile.fileName),
+                    ...position
+                });
             }
-            // If the key is not fully qualified then add the class name
-            if (!localeKey.includes(".")) {
-                localeKeyParts.push(expandTemplatePart(classNameParam));
+            else {
+                const finalKeyParts = [];
+                const classNameExpanded = expandTemplatePart(classNameParam);
+                const messageKeyParts = messageKey.split(".");
+                if (messageKeyParts.length === 2 && classNameExpanded === messageKeyParts[0]) {
+                    // But if it is fully qualified with exactly two segments and starts with the class name
+                    // then the class name is redundant and should be removed in the source
+                    const position = getSourcePosition(sourceFile, messageNode);
+                    CLIDisplay.errorMessage(I18n.formatMessage("error.validateLocales.noNeedToQualify", {
+                        key: messageKey,
+                        property: classNameParam,
+                        source: path.resolve(sourceFile.fileName),
+                        line: position.line,
+                        column: position.column
+                    }));
+                    failures.push({
+                        type: "qualify",
+                        key: messageKey,
+                        source: path.resolve(sourceFile.fileName),
+                        ...position
+                    });
+                }
+                else if (!messageKey.includes(".")) {
+                    // If the key is not fully qualified then add the class name
+                    // to the final key
+                    finalKeyParts.push(classNameExpanded);
+                }
+                finalKeyParts.push(messageKey);
+                if (Is.stringValue(prefix)) {
+                    finalKeyParts.unshift(prefix);
+                }
+                return finalKeyParts.join(".");
             }
-            localeKeyParts.push(localeKey);
-            return localeKeyParts.join(".");
         }
     }
     return undefined;
 }
-
-// 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.
-     * @param options Additional options.
-     * @param options.overrideOutputWidth Override the output width.
-     * @returns The exit code.
-     */
-    async run(argv, localesDirectory, options) {
-        return this.execute({
-            title: "TWIN Validate Locales",
-            appName: "validate-locales",
-            version: "0.0.2-next.21", // x-release-please-version
-            icon: "⚙️ ",
-            supportsEnvFiles: false,
-            overrideOutputWidth: options?.overrideOutputWidth
-        }, 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) {
-        buildCommandValidateLocales(program);
-    }
-}
-
-export { CLI, actionCommandValidateLocales, buildCommandValidateLocales };
+//# sourceMappingURL=validateLocales.js.map