fix(no-restricted-syntax): include comment in templates and in de…

…fault error message if present
gajus · Apr 2, 2022 · cc031b8 · cc031b8
1 parent 0f27a91
commit cc031b8
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -9328,7 +9328,7 @@ function quux () {
 
 }
 // "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":["FunctionDeclaration"]}]
-// Message: Syntax is restricted: FunctionDeclaration.
+// Message: Syntax is restricted: FunctionDeclaration
 
 /**
  *
@@ -9346,7 +9346,7 @@ function quux () {
 
 }
 // "jsdoc/no-restricted-syntax": ["error"|"warn", {"contexts":[{"comment":"JsdocBlock[postDelimiter=\"\"]:has(JsdocTypeUnion > JsdocTypeName[value=\"Bar\"]:nth-child(1))","context":"FunctionDeclaration"}]}]
-// Message: Syntax is restricted: FunctionDeclaration.
+// Message: Syntax is restricted: FunctionDeclaration with JsdocBlock[postDelimiter=""]:has(JsdocTypeUnion > JsdocTypeName[value="Bar"]:nth-child(1))
 
 /**
  * @implements {Bar|Foo}

diff --git a/src/rules/noRestrictedSyntax.js b/src/rules/noRestrictedSyntax.js
@@ -36,9 +36,11 @@ export default iterateJsdoc(({
     foundContext.context ?? 'any' :
     foundContext;
   const message = foundContext?.message ??
-    'Syntax is restricted: {{context}}.';
+    'Syntax is restricted: {{context}}' +
+      (comment ? ' with {{comment}}' : '');
 
   report(message, null, null, {
+    comment,
     context: contextStr,
   });
 }, {

diff --git a/test/rules/assertions/noRestrictedSyntax.js b/test/rules/assertions/noRestrictedSyntax.js
@@ -12,7 +12,7 @@ export default {
       errors: [
         {
           line: 2,
-          message: 'Syntax is restricted: FunctionDeclaration.',
+          message: 'Syntax is restricted: FunctionDeclaration',
         },
       ],
       options: [
@@ -61,7 +61,7 @@ export default {
       errors: [
         {
           line: 2,
-          message: 'Syntax is restricted: FunctionDeclaration.',
+          message: 'Syntax is restricted: FunctionDeclaration with JsdocBlock[postDelimiter=""]:has(JsdocTypeUnion > JsdocTypeName[value="Bar"]:nth-child(1))',
         },
       ],
       options: [