fix(no-missing-syntax): pass in missing comment

Also documents `message` values and adds test line numbers.
gajus · May 14, 2021 · a977896 · a977896
1 parent 310ea75
commit a977896
Show file tree

Hide file tree

Showing 10 changed files with 285 additions and 16 deletions.
diff --git a/.README/rules/no-missing-syntax.md b/.README/rules/no-missing-syntax.md
@@ -42,7 +42,8 @@ Use the `minimum` property (defaults to 1) to indicate how many are required
 for the rule to be reported.
 
 Use the `message` property to indicate the specific error to be shown when an
-error is reported for that context being found missing.
+error is reported for that context being found missing. You may use
+`{{context}}` and `{{comment}}` with such messages.
 
 Set to `"any"` if you want the rule to apply to any jsdoc block throughout
 your files (as is necessary for finding function blocks not attached to a

diff --git a/README.md b/README.md
@@ -7601,7 +7601,8 @@ Use the `minimum` property (defaults to 1) to indicate how many are required
 for the rule to be reported.
 
 Use the `message` property to indicate the specific error to be shown when an
-error is reported for that context being found missing.
+error is reported for that context being found missing. You may use
+`{{context}}` and `{{comment}}` with such messages.
 
 Set to `"any"` if you want the rule to apply to any jsdoc block throughout
 your files (as is necessary for finding function blocks not attached to a
@@ -7628,16 +7629,16 @@ function quux () {
 
 }
 // "jsdoc/no-missing-syntax": ["error"|"warn", {"contexts":[{"comment":"JSDocBlock[postDelimiter=\"\"]:has(JSDocTypeUnion[left.name=\"Foo\"])","context":"FunctionDeclaration"}]}]
-// Message: Syntax is required: FunctionDeclaration
+// Message: Syntax is required: FunctionDeclaration with JSDocBlock[postDelimiter=""]:has(JSDocTypeUnion[left.name="Foo"])
 
 /**
  * @implements {Bar|Foo}
  */
 function quux () {
 
 }
-// "jsdoc/no-missing-syntax": ["error"|"warn", {"contexts":[{"comment":"JSDocBlock[postDelimiter=\"\"]:has(JSDocTypeUnion[left.name=\"Foo\"])","context":"FunctionDeclaration","message":"Problematic function syntax: `{{context}}`."}]}]
-// Message: Problematic function syntax: `FunctionDeclaration`.
+// "jsdoc/no-missing-syntax": ["error"|"warn", {"contexts":[{"comment":"JSDocBlock[postDelimiter=\"\"]:has(JSDocTypeUnion[left.name=\"Foo\"])","context":"FunctionDeclaration","message":"Problematically missing function syntax: `{{context}}` with `{{comment}}`."}]}]
+// Message: Problematically missing function syntax: `FunctionDeclaration` with `JSDocBlock[postDelimiter=""]:has(JSDocTypeUnion[left.name="Foo"])`.
 
 /**
  * @implements {Bar|Foo}
@@ -7663,7 +7664,7 @@ function quux () {
 
 }
 // "jsdoc/no-missing-syntax": ["error"|"warn", {"contexts":[{"comment":"JSDocBlock[postDelimiter=\"\"]:has(JSDocTypeUnion[left.name=\"Bar\"])","context":"FunctionDeclaration","minimum":2}]}]
-// Message: Syntax is required: FunctionDeclaration
+// Message: Syntax is required: FunctionDeclaration with JSDocBlock[postDelimiter=""]:has(JSDocTypeUnion[left.name="Bar"])
 ````
 
 The following patterns are not considered problems:

diff --git a/src/rules/noMissingSyntax.js b/src/rules/noMissingSyntax.js
@@ -56,9 +56,11 @@ export default iterateJsdoc(({
         !state.selectorMap[contextStr][comment] ||
         state.selectorMap[contextStr][comment] < (cntxt?.minimum ?? 1)
       ) {
-        const message = cntxt?.message ?? 'Syntax is required: {{context}}';
+        const message = cntxt?.message ?? 'Syntax is required: {{context}}' +
+          (comment ? ' with {{comment}}' : '');
         context.report({
           data: {
+            comment,
             context: contextStr,
           },
           loc: {

diff --git a/test/rules/assertions/checkLineAlignment.js b/test/rules/assertions/checkLineAlignment.js
@@ -12,6 +12,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -42,6 +43,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -72,6 +74,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -101,6 +104,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -130,6 +134,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -159,6 +164,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -188,6 +194,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -217,6 +224,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -248,6 +256,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -281,6 +290,7 @@ export default {
       `,
       errors: [
         {
+          line: 3,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -312,6 +322,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -344,6 +355,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -377,6 +389,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -410,6 +423,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -445,6 +459,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -477,10 +492,12 @@ export default {
       `,
       errors: [
         {
+          line: 5,
           message: 'Expected JSDoc block lines to not be aligned.',
           type: 'Block',
         },
         {
+          line: 6,
           message: 'Expected JSDoc block lines to not be aligned.',
           type: 'Block',
         },
@@ -510,6 +527,7 @@ export default {
       `,
       errors: [
         {
+          line: 6,
           message: 'Expected JSDoc block lines to not be aligned.',
           type: 'Block',
         },
@@ -539,6 +557,7 @@ export default {
       `,
       errors: [
         {
+          line: 6,
           message: 'Expected JSDoc block lines to not be aligned.',
           type: 'Block',
         },
@@ -568,6 +587,7 @@ export default {
       `,
       errors: [
         {
+          line: 6,
           message: 'Expected JSDoc block lines to not be aligned.',
           type: 'Block',
         },
@@ -595,6 +615,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -628,6 +649,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -659,6 +681,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },
@@ -718,6 +741,7 @@ export default {
       `,
       errors: [
         {
+          line: 6,
           message: 'Expected JSDoc block lines to not be aligned.',
           type: 'Block',
         },
@@ -745,6 +769,7 @@ export default {
       `,
       errors: [
         {
+          line: 6,
           message: 'Expected JSDoc block lines to not be aligned.',
           type: 'Block',
         },
@@ -772,6 +797,7 @@ export default {
       `,
       errors: [
         {
+          line: 5,
           message: 'Expected JSDoc block lines to not be aligned.',
           type: 'Block',
         },
@@ -800,6 +826,7 @@ export default {
       `,
       errors: [
         {
+          line: 7,
           message: 'Expected JSDoc block lines to not be aligned.',
           type: 'Block',
         },
@@ -873,6 +900,7 @@ export default {
       `,
       errors: [
         {
+          line: 2,
           message: 'Expected JSDoc block lines to be aligned.',
           type: 'Block',
         },

diff --git a/test/rules/assertions/checkParamNames.js b/test/rules/assertions/checkParamNames.js
@@ -753,15 +753,19 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'Missing @param "bbox.x"',
         },
         {
+          line: 4,
           message: 'Missing @param "bbox.y"',
         },
         {
+          line: 4,
           message: 'Missing @param "bbox.width"',
         },
         {
+          line: 4,
           message: 'Missing @param "bbox.height"',
         },
       ],
@@ -783,15 +787,19 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'Missing @param "bbox.x"',
         },
         {
+          line: 4,
           message: 'Missing @param "bbox.y"',
         },
         {
+          line: 4,
           message: 'Missing @param "bbox.width"',
         },
         {
+          line: 4,
           message: 'Missing @param "bbox.height"',
         },
       ],
@@ -809,9 +817,11 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'Missing @param "fetchOptions.url"',
         },
         {
+          line: 4,
           message: 'Missing @param "fetchOptions.options"',
         },
       ],
@@ -905,9 +915,11 @@ export default {
       `,
       errors: [
         {
+          line: 4,
           message: 'Missing @param "options.foo"',
         },
         {
+          line: 4,
           message: 'Missing @param "options.foo.bar"',
         },
       ],
@@ -958,9 +970,11 @@ export default {
       `,
       errors: [
         {
+          line: 6,
           message: '@param "props.prop.a" does not exist on props',
         },
         {
+          line: 7,
           message: '@param "props.prop.b" does not exist on props',
         },
       ],