From e111a02f74bd1af82ab5d23e83c9bbd589326466 Mon Sep 17 00:00:00 2001
From: Bryan Mishkin <698306+bmish@users.noreply.github.com>
Date: Wed, 3 Aug 2022 22:11:23 -0400
Subject: [PATCH] fix: clarify report messages for no-missing-placeholders and
 no-unused-placeholders

---
 lib/rules/no-missing-placeholders.js       | 2 +-
 lib/rules/no-unused-placeholders.js        | 3 ++-
 tests/lib/rules/no-missing-placeholders.js | 5 ++++-
 tests/lib/rules/no-unused-placeholders.js  | 5 ++++-
 4 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/lib/rules/no-missing-placeholders.js b/lib/rules/no-missing-placeholders.js
index 6523d2a8..8a651873 100644
--- 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
index 61f17adb..e877eb9d 100644
--- 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
index fb2aafb6..cf346b37 100644
--- 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
index 8679d0c4..aad9d35b 100644
--- 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).`,
+  };
 }
 
 // ------------------------------------------------------------------------------