From f872cd7248b8de2ac9b6400c8ccefe78b03836ea Mon Sep 17 00:00:00 2001
From: Bryan Mishkin <698306+bmish@users.noreply.github.com>
Date: Sun, 11 Jul 2021 14:15:05 -0400
Subject: [PATCH] Docs: Improve consistency of `require-meta-*` rule violation
 messages

---
 lib/rules/require-meta-docs-url.js        | 2 +-
 lib/rules/require-meta-fixable.js         | 4 ++--
 lib/rules/require-meta-has-suggestions.js | 4 ++--
 lib/rules/require-meta-schema.js          | 2 +-
 lib/rules/require-meta-type.js            | 2 +-
 5 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/lib/rules/require-meta-docs-url.js b/lib/rules/require-meta-docs-url.js
index 7d09f4f0..ed7d67a7 100644
--- a/lib/rules/require-meta-docs-url.js
+++ b/lib/rules/require-meta-docs-url.js
@@ -34,7 +34,7 @@ module.exports = {
     }],
     messages: {
       mismatch: '`meta.docs.url` property must be `{{expectedUrl}}`.',
-      missing: 'Rules should export a `meta.docs.url` property.',
+      missing: '`meta.docs.url` property is missing.',
       wrongType: '`meta.docs.url` property must be a string.',
     },
   },
diff --git a/lib/rules/require-meta-fixable.js b/lib/rules/require-meta-fixable.js
index 72721737..9503b2dc 100644
--- a/lib/rules/require-meta-fixable.js
+++ b/lib/rules/require-meta-fixable.js
@@ -22,8 +22,8 @@ module.exports = {
     },
     schema: [],
     messages: {
-      invalid: '`meta.fixable` must be either `code`, `whitespace` or `null`.',
-      missing: 'Fixable rules must export a `meta.fixable` property.',
+      invalid: '`meta.fixable` must be either `code`, `whitespace`, or `null`.',
+      missing: '`meta.fixable` must be either `code` or `whitespace` for fixable rules.',
     },
   },
 
diff --git a/lib/rules/require-meta-has-suggestions.js b/lib/rules/require-meta-has-suggestions.js
index e29a41ce..ba8df6d7 100644
--- a/lib/rules/require-meta-has-suggestions.js
+++ b/lib/rules/require-meta-has-suggestions.js
@@ -17,8 +17,8 @@ module.exports = {
     },
     schema: [],
     messages: {
-      shouldBeSuggestable: 'Suggestable rules should specify a `meta.hasSuggestions` property with value `true`.',
-      shouldNotBeSuggestable: 'Non-suggestable rules should not specify a `meta.hasSuggestions` property with value `true`.',
+      shouldBeSuggestable: '`meta.hasSuggestions` must be `true` for suggestable rules.',
+      shouldNotBeSuggestable: '`meta.hasSuggestions` cannot be `true` for non-suggestable rules.',
     },
   },
 
diff --git a/lib/rules/require-meta-schema.js b/lib/rules/require-meta-schema.js
index 47e4d90c..4b0c8913 100644
--- a/lib/rules/require-meta-schema.js
+++ b/lib/rules/require-meta-schema.js
@@ -28,7 +28,7 @@ module.exports = {
       },
     ],
     messages: {
-      foundOptionsUsage: 'Found usage of rule options but no options are defined in `meta.schema`.',
+      foundOptionsUsage: '`meta.schema` has no schema defined but rule has options.',
       missing: '`meta.schema` is required (use [] if rule has no schema).',
       wrongType: '`meta.schema` should be an array or object (use [] if rule has no schema).',
     },
diff --git a/lib/rules/require-meta-type.js b/lib/rules/require-meta-type.js
index cba76b63..330d3e94 100644
--- a/lib/rules/require-meta-type.js
+++ b/lib/rules/require-meta-type.js
@@ -25,7 +25,7 @@ module.exports = {
     schema: [],
     messages: {
       missing: '`meta.type` is required (must be either `problem`, `suggestion`, or `layout`).',
-      unexpected: '`meta.type` must be either `problem`, `suggestion` or `layout`.',
+      unexpected: '`meta.type` must be either `problem`, `suggestion`, or `layout`.',
     },
   },