Merge pull request #392 from ahwayakchih/test/check-indentation-examples-with-captions-and-code

Additional assertions for `check-indentation`

Author: brettz9

README.md

@@ -962,6 +962,35 @@ function quux () {
 
 }
 // Message: There must be no indentation.
+
+/**
+* @example <caption>
+* Here is a long
+*   indented summary of this
+* example
+* </caption>
+* ```js
+* function hi () {
+*   alert('Hello');
+* }
+* ```
+*/
+// Options: [{"excludeTags":[]}]
+// Message: There must be no indentation.
+
+/**
+* @example <caption>
+* Here is a long
+* summary of this
+* example
+* </caption>
+* // Code is not wrapped into fenced code block
+* function hi () {
+*   alert('Hello');
+* }
+*/
+// Options: [{"excludeTags":[]}]
+// Message: There must be no indentation.
 ````
 
 The following patterns are not considered problems:
@@ -1030,6 +1059,20 @@ function quux () {
 function quux () {
 
 }
+
+/**
+* @example <caption>
+* Here is a long
+* summary of this
+* example
+* </caption>
+* ```js
+* function hi () {
+*   alert('Hello');
+* }
+* ```
+*/
+// Options: [{"excludeTags":[]}]
 ````
 
 

test/rules/assertions/checkIndentation.js

@@ -135,6 +135,55 @@ export default {
         },
       ],
     },
+    {
+      code: `
+          /**
+          * @example <caption>
+          * Here is a long
+          *   indented summary of this
+          * example
+          * </caption>
+          * \`\`\`js
+          * function hi () {
+          *   alert('Hello');
+          * }
+          * \`\`\`
+          */
+      `,
+      errors: [
+        {
+          line: 5,
+          message: 'There must be no indentation.',
+        },
+      ],
+      options: [{
+        excludeTags: [],
+      }],
+    },
+    {
+      code: `
+          /**
+          * @example <caption>
+          * Here is a long
+          * summary of this
+          * example
+          * </caption>
+          * // Code is not wrapped into fenced code block
+          * function hi () {
+          *   alert('Hello');
+          * }
+          */
+      `,
+      errors: [
+        {
+          line: 10,
+          message: 'There must be no indentation.',
+        },
+      ],
+      options: [{
+        excludeTags: [],
+      }],
+    },
   ],
   valid: [
     {
@@ -221,5 +270,24 @@ export default {
           }
       `,
     },
+    {
+      code: `
+          /**
+          * @example <caption>
+          * Here is a long
+          * summary of this
+          * example
+          * </caption>
+          * \`\`\`js
+          * function hi () {
+          *   alert('Hello');
+          * }
+          * \`\`\`
+          */
+      `,
+      options: [{
+        excludeTags: [],
+      }],
+    },
   ],
 };