testing(check-examples): add configFile test

gajus · Jun 26, 2021 · d73787c · d73787c
1 parent f03fec4
commit d73787c
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1268,6 +1268,16 @@ function quux2 () {
  */
 function quux2 () {
 
+}
+// "jsdoc/check-examples": ["error"|"warn", {"configFile":".eslintrc.json","matchingFileName":"../../jsdocUtils.js"}]
+// Message: @example warning (id-length): Identifier name 'i' is too short (< 2).
+
+/**
+ * @example const i = 5;
+ * quux2()
+ */
+function quux2 () {
+
 }
 // Message: @example warning (id-length): Identifier name 'i' is too short (< 2).
 

diff --git a/test/rules/assertions/checkExamples.js b/test/rules/assertions/checkExamples.js
@@ -361,6 +361,31 @@ export default {
           message: '@example error (semi): Missing semicolon.',
         },
       ],
+      options: [{
+        configFile: '.eslintrc.json',
+        matchingFileName: '../../jsdocUtils.js',
+      }],
+    },
+    {
+      code: `
+          /**
+           * @example const i = 5;
+           * quux2()
+           */
+          function quux2 () {
+
+          }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: '@example warning (id-length): Identifier name \'i\' is too short (< 2).',
+        },
+        {
+          line: 4,
+          message: '@example error (semi): Missing semicolon.',
+        },
+      ],
       filename: 'test/rules/data/jsdocUtils.js',
     },
     {