Update the error msg

pinterest · May 15, 2023 · abfbbfa · abfbbfa
1 parent 6e25045
commit abfbbfa
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/...ine-core/src/main/kotlin/com/pinterest/ktlint/rule/engine/core/internal/IdNamingPolicy.kt b/...ine-core/src/main/kotlin/com/pinterest/ktlint/rule/engine/core/internal/IdNamingPolicy.kt
@@ -14,13 +14,19 @@ internal object IdNamingPolicy {
      * Will throw [IllegalArgumentException] on invalid [ruleId] name.
      */
     internal fun enforceRuleIdNaming(ruleId: String) =
-        require(ruleId.matches(RULE_ID_REGEX)) { "Rule id '$ruleId' must match '${RULE_ID_REGEX.pattern}'" }
+        require(ruleId.matches(RULE_ID_REGEX)) {
+            "No ktlint rule with rule id '$ruleId' has been loaded. Please check " +
+                "spelling of the id which has to match regexp '${RULE_ID_REGEX.pattern}'"
+        }
 
     /**
      * Checks provided [ruleSetId] is valid.
      *
      * Will throw [IllegalArgumentException] on invalid [ruleSetId] name.
      */
     internal fun enforceRuleSetIdNaming(ruleSetId: String) =
-        require(ruleSetId.matches(RULE_SET_ID_REGEX)) { "RuleSet id '$ruleSetId' must match '${RULE_SET_ID_REGEX.pattern}'" }
+        require(ruleSetId.matches(RULE_SET_ID_REGEX)) {
+            "No ktlint rule with ruleSet id '$ruleSetId' has been loaded. Please check spelling of the id which has " +
+                "to match regexp '${RULE_SET_ID_REGEX.pattern}'"
+        }
 }
diff --git a/...-rule-engine-core/src/test/kotlin/com/pinterest/ktlint/rule/engine/core/api/RuleKtTest.kt b/...-rule-engine-core/src/test/kotlin/com/pinterest/ktlint/rule/engine/core/api/RuleKtTest.kt
@@ -12,7 +12,10 @@ class RuleKtTest {
     fun `Given a rule with an unqualified rule id than the rule can not be instantiated`() {
         assertThatThrownBy { creatRule("some-unqualified-rule-id") }
             .isInstanceOf(IllegalArgumentException::class.java)
-            .hasMessage("Rule id 'some-unqualified-rule-id' must match '[a-z]+(-[a-z]+)*:[a-z]+(-[a-z]+)*'")
+            .hasMessage(
+                "No ktlint rule with rule id 'some-unqualified-rule-id' has been loaded. Please check " +
+                    "spelling of the id which has to match regexp '[a-z]+(-[a-z]+)*:[a-z]+(-[a-z]+)*'",
+            )
     }
 
     @ParameterizedTest(name = "Qualified rule id: `{0}`, expected rule id: `{1}`")