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

package/dist/cjs/index.cjs

@@ -46,7 +46,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
@@ -116,7 +116,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 cliCore.CLIUtils.readJsonFile(localeFile);
         const locale = path.basename(localeFile, path.extname(localeFile));
@@ -141,27 +141,27 @@ async function validateLocales(sourceFiles, localeFiles, ignore) {
                 });
             }
         }
-        let missing = [];
+        let failures = [];
         const captureVariables = {};
         for (const sourceFile of sourceFiles) {
             const source = await promises.readFile(sourceFile, "utf8");
             const sourceTs = ts__namespace.createSourceFile(sourceFile, source, ts__namespace.ScriptTarget.ESNext, true, ts__namespace.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) {
             cliCore.CLIDisplay.write(core.I18n.formatMessage("commands.validate-locales.labels.noMissingLocaleEntries"));
             cliCore.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") {
                     cliCore.CLIDisplay.errorMessage(core.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
                     }));
                 }
             }
@@ -187,7 +187,7 @@ async function validateLocales(sourceFiles, localeFiles, ignore) {
             }
         }
     }
-    if (hasMissing || hasUnused || hasQuoteError) {
+    if (hasFailures || hasUnused || hasQuoteError) {
         throw new core.GeneralError("validateLocales", "validationFailed");
     }
 }
@@ -196,43 +196,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__namespace.isNewExpression(node) &&
         ts__namespace.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__namespace.isStringLiteral(node)) {
-        processStringLiteral(sourceFile, node, localeEntries, missing);
+        processStringLiteral(sourceFile, node, localeEntries, failures);
         handled = true;
     }
     else if (ts__namespace.isTemplateExpression(node)) {
-        processTemplateExpression(sourceFile, node, localeEntries, missing);
+        processTemplateExpression(sourceFile, node, localeEntries, failures);
         handled = true;
     }
     else if (ts__namespace.isCallExpression(node)) {
-        handled = processCallExpression(sourceFile, node, localeEntries, missing, captureVariables);
+        handled = processCallExpression(sourceFile, node, localeEntries, failures, captureVariables);
     }
     else if (ts__namespace.isFunctionDeclaration(node)) {
         handled = processFunctionDeclaration(sourceFile, node);
     }
     else if (ts__namespace.isVariableDeclaration(node)) {
-        handled = processVariableDeclaration(sourceFile, node, localeEntries, missing, captureVariables);
+        handled = processVariableDeclaration(sourceFile, node, localeEntries, failures, captureVariables);
     }
     else if (ts__namespace.isImportDeclaration(node) || ts__namespace.isExportDeclaration(node)) {
         // Don't care about string in imports/exports
         handled = true;
     }
     else if (ts__namespace.isPropertyAssignment(node)) {
-        handled = processPropertyAssignment(sourceFile, node, localeEntries, missing);
+        handled = processPropertyAssignment(sourceFile, node, localeEntries, failures);
     }
     if (!handled) {
-        ts__namespace.forEachChild(node, child => visit(sourceFile, child, localeEntries, missing, captureVariables));
+        ts__namespace.forEachChild(node, child => visit(sourceFile, child, localeEntries, failures, captureVariables));
     }
 }
 /**
@@ -241,12 +241,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 (core.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 (core.Is.stringValue(localeKey)) {
             const localeEntry = findAndReferenceLocale(localeEntries, localeKey);
             if (core.Is.object(localeEntry)) {
@@ -255,11 +255,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),
@@ -291,9 +291,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) &&
@@ -306,18 +306,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),
@@ -332,9 +332,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
@@ -343,14 +343,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);
             }
         }
     }
@@ -360,11 +360,11 @@ 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__namespace.isPropertyAccessExpression(node.expression)) {
         const functionName = node.expression.name.getText();
         if (functionName === "log" &&
@@ -398,14 +398,14 @@ function processCallExpression(sourceFile, node, localeEntries, missing, capture
                     }
                 }
             }
-            const localeKey = localeFromClassAndMessage(source, message, level);
+            const localeKey = localeFromClassAndMessage(sourceFile, source, message, level, failures);
             if (core.Is.stringValue(localeKey)) {
                 const localeEntry = findAndReferenceLocale(localeEntries, localeKey);
                 if (core.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),
@@ -424,10 +424,10 @@ function processCallExpression(sourceFile, node, localeEntries, missing, capture
                 const dataNames = getPropertiesFromNode(node.arguments[1]);
                 const localeEntry = findAndReferenceLocale(localeEntries, localeKey);
                 if (core.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),
@@ -445,10 +445,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 (core.Is.object(node.name) &&
         ts__namespace.isIdentifier(node.name) &&
         SKIP_METHODS.some(re => re.test(node.name?.text ?? ""))) {
@@ -461,11 +461,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 (core.Is.object(node.name) &&
         core.Is.object(node.initializer) &&
         ts__namespace.isIdentifier(node.name) &&
@@ -481,10 +481,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 (core.Is.object(node.name) && ts__namespace.isIdentifier(node.name) && node.name.getText() === "message") {
         const localeKey = getExpandedText(node.initializer);
         if (core.Is.stringValue(localeKey)) {
@@ -493,7 +493,7 @@ function processPropertyAssignment(sourceFile, node, localeEntries, missing) {
                 localeEntry = findAndReferenceLocale(localeEntries, `error.${localeKey}`);
             }
             if (!core.Is.object(localeEntry)) {
-                missing.push({
+                failures.push({
                     type: "key",
                     key: localeKey,
                     source: path.resolve(sourceFile.fileName),
@@ -552,7 +552,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.
@@ -596,9 +596,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) {
@@ -610,7 +610,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),
@@ -696,30 +696,72 @@ 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 (core.Is.array(classNameParamParts)) {
-        const localeKey = getExpandedText(messageNode);
-        if (core.Is.stringValue(localeKey)) {
-            const localeKeyParts = [];
-            if (core.Is.stringValue(prefix)) {
-                localeKeyParts.push(prefix);
+        const messageKey = getExpandedText(messageNode);
+        if (core.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);
+                cliCore.CLIDisplay.errorMessage(core.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);
+                    cliCore.CLIDisplay.errorMessage(core.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 (core.Is.stringValue(prefix)) {
+                    finalKeyParts.unshift(prefix);
+                }
+                return finalKeyParts.join(".");
             }
-            localeKeyParts.push(localeKey);
-            return localeKeyParts.join(".");
         }
     }
     return undefined;
@@ -743,7 +785,7 @@ class CLI extends cliCore.CLIBase {
         return this.execute({
             title: "TWIN Validate Locales",
             appName: "validate-locales",
-            version: "0.0.2-next.21", // x-release-please-version
+            version: "0.0.2-next.22", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/esm/index.mjs

@@ -23,7 +23,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
@@ -93,7 +93,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 +118,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 +164,7 @@ async function validateLocales(sourceFiles, localeFiles, ignore) {
             }
         }
     }
-    if (hasMissing || hasUnused || hasQuoteError) {
+    if (hasFailures || hasUnused || hasQuoteError) {
         throw new GeneralError("validateLocales", "validationFailed");
     }
 }
@@ -173,43 +173,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);
     }
     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 +218,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 +232,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 +268,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 +283,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 +309,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 +320,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,11 +337,11 @@ 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" &&
@@ -375,14 +375,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 +401,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 +422,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 +438,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 +458,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 +470,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 +529,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 +573,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 +587,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,30 +673,72 @@ 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;
@@ -720,7 +762,7 @@ class CLI extends CLIBase {
         return this.execute({
             title: "TWIN Validate Locales",
             appName: "validate-locales",
-            version: "0.0.2-next.21", // x-release-please-version
+            version: "0.0.2-next.22", // x-release-please-version
             icon: "⚙️ ",
             supportsEnvFiles: false,
             overrideOutputWidth: options?.overrideOutputWidth

package/dist/locales/en.json

@@ -115,7 +115,9 @@
 			"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}\"."
+			"missingPropertyInLocale": "Missing property \"{property}\" when referencing key \"{key}\" in source file \"{source}:{line}:{column}\".",
+			"noNeedToQualify": "No need to qualify key \"{key}\" with property \"{property}\" in source file \"{source}:{line}:{column}\", as source is the same.",
+			"shouldBeKey": "Value \"{value}\" should be an i18n key in source file \"{source}:{line}:{column}\"."
 		}
 	},
 	"warn": {

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

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

package/docs/changelog.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [0.0.2-next.22](https://github.com/twinfoundation/framework/compare/validate-locales-v0.0.2-next.21...validate-locales-v0.0.2-next.22) (2025-10-10)
+
+
+### Features
+
+* detect unused prefixes and non i18 key messages ([a357810](https://github.com/twinfoundation/framework/commit/a357810754e25478496c2e6fd71ddc49dee9f747))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/cli-core bumped from 0.0.2-next.21 to 0.0.2-next.22
+    * @twin.org/core bumped from 0.0.2-next.21 to 0.0.2-next.22
+    * @twin.org/nameof bumped from 0.0.2-next.21 to 0.0.2-next.22
+    * @twin.org/nameof-transformer bumped from 0.0.2-next.21 to 0.0.2-next.22
+  * devDependencies
+    * @twin.org/merge-locales bumped from 0.0.2-next.21 to 0.0.2-next.22
+    * @twin.org/nameof-vitest-plugin bumped from 0.0.2-next.21 to 0.0.2-next.22
+
 ## [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)
 
 

package/locales/en.json

@@ -6,7 +6,9 @@
 			"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}\"."
+			"missingPropertyInLocale": "Missing property \"{property}\" when referencing key \"{key}\" in source file \"{source}:{line}:{column}\".",
+			"noNeedToQualify": "No need to qualify key \"{key}\" with property \"{property}\" in source file \"{source}:{line}:{column}\", as source is the same.",
+			"shouldBeKey": "Value \"{value}\" should be an i18n key in source file \"{source}:{line}:{column}\"."
 		}
 	},
 	"commands": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/validate-locales",
-	"version": "0.0.2-next.21",
+	"version": "0.0.2-next.22",
 	"description": "Tool to validate source files against the locales",
 	"repository": {
 		"type": "git",
@@ -14,13 +14,13 @@
 		"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",
+		"@twin.org/cli-core": "0.0.2-next.22",
+		"@twin.org/core": "0.0.2-next.22",
+		"@twin.org/nameof": "0.0.2-next.22",
+		"@twin.org/nameof-transformer": "0.0.2-next.22",
 		"commander": "14.0.1",
 		"glob": "11.0.3",
-		"typescript": "5.9.2"
+		"typescript": "5.9.3"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",

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

@@ -1,25 +0,0 @@
-/**
- * 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;
-}