fix: clarify report messages for no-missing-placeholders and no-unuse…

…d-placeholders (#278)
eslint-community · Aug 4, 2022 · f5a5c24 · f5a5c24
1 parent 5bf0648
commit f5a5c24
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 4 deletions.
diff --git a/lib/rules/no-missing-placeholders.js b/lib/rules/no-missing-placeholders.js
@@ -26,7 +26,7 @@ module.exports = {
     schema: [],
     messages: {
       placeholderDoesNotExist:
-        'The placeholder {{{{missingKey}}}} does not exist.',
+        "The placeholder {{{{missingKey}}}} is missing (must provide it in the report's `data` object).",
     },
   },
 

diff --git a/lib/rules/no-unused-placeholders.js b/lib/rules/no-unused-placeholders.js
@@ -25,7 +25,8 @@ module.exports = {
     fixable: null,
     schema: [],
     messages: {
-      placeholderUnused: 'The placeholder {{{{unusedKey}}}} is unused.',
+      placeholderUnused:
+        'The placeholder {{{{unusedKey}}}} is unused (does not exist in the actual message).',
     },
   },
 

diff --git a/tests/lib/rules/no-missing-placeholders.js b/tests/lib/rules/no-missing-placeholders.js
@@ -18,7 +18,10 @@ const RuleTester = require('eslint').RuleTester;
  * @returns {object} An expected error
  */
 function error(missingKey, type = 'Literal') {
-  return { type, message: `The placeholder {{${missingKey}}} does not exist.` };
+  return {
+    type,
+    message: `The placeholder {{${missingKey}}} is missing (must provide it in the report's \`data\` object).`,
+  };
 }
 
 // ------------------------------------------------------------------------------

diff --git a/tests/lib/rules/no-unused-placeholders.js b/tests/lib/rules/no-unused-placeholders.js
@@ -18,7 +18,10 @@ const RuleTester = require('eslint').RuleTester;
  * @returns {object} An expected error
  */
 function error(unusedKey, type = 'Literal') {
-  return { type, message: `The placeholder {{${unusedKey}}} is unused.` };
+  return {
+    type,
+    message: `The placeholder {{${unusedKey}}} is unused (does not exist in the actual message).`,
+  };
 }
 
 // ------------------------------------------------------------------------------