Testing: Global function checking

gajus · Dec 31, 2019 · 95533cc · 95533cc
1 parent 2cdbc02
commit 95533cc
Show file tree

Hide file tree

Showing 5 changed files with 430 additions and 0 deletions.
diff --git a/test/rules/assertions/requireParamDescription.js b/test/rules/assertions/requireParamDescription.js
@@ -16,6 +16,59 @@ export default {
         },
       ],
     },
+    {
+      code: `
+          /**
+           * @param foo
+           */
+          function quux (foo) {
+
+          }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Missing JSDoc @param "foo" description.',
+        },
+      ],
+      options: [{
+        contexts: ['any'],
+      }],
+    },
+    {
+      code: `
+          /**
+           * @function
+           * @param foo
+           */
+      `,
+      errors: [
+        {
+          line: 4,
+          message: 'Missing JSDoc @param "foo" description.',
+        },
+      ],
+      options: [{
+        contexts: ['any'],
+      }],
+    },
+    {
+      code: `
+          /**
+           * @callback
+           * @param foo
+           */
+      `,
+      errors: [
+        {
+          line: 4,
+          message: 'Missing JSDoc @param "foo" description.',
+        },
+      ],
+      options: [{
+        contexts: ['any'],
+      }],
+    },
     {
       code: `
           /**
@@ -84,5 +137,36 @@ export default {
           }
       `,
     },
+    {
+      code: `
+          /**
+           * @param foo Foo.
+           */
+          function quux (foo) {
+
+          }
+      `,
+      options: [
+        {
+          contexts: ['any'],
+        },
+      ],
+    },
+    {
+      code: `
+          /**
+           * @function
+           * @param foo
+           */
+      `,
+    },
+    {
+      code: `
+          /**
+           * @callback
+           * @param foo
+           */
+      `,
+    },
   ],
 };
diff --git a/test/rules/assertions/requireParamName.js b/test/rules/assertions/requireParamName.js
@@ -32,6 +32,59 @@ export default {
         },
       ],
     },
+    {
+      code: `
+          /**
+           * @param {string}
+           */
+          function quux (foo) {
+
+          }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'There must be an identifier after @param tag.',
+        },
+      ],
+      options: [{
+        contexts: ['any'],
+      }],
+    },
+    {
+      code: `
+          /**
+           * @function
+           * @param {string}
+           */
+      `,
+      errors: [
+        {
+          line: 4,
+          message: 'There must be an identifier after @param tag.',
+        },
+      ],
+      options: [{
+        contexts: ['any'],
+      }],
+    },
+    {
+      code: `
+          /**
+           * @callback
+           * @param {string}
+           */
+      `,
+      errors: [
+        {
+          line: 4,
+          message: 'There must be an identifier after @param tag.',
+        },
+      ],
+      options: [{
+        contexts: ['any'],
+      }],
+    },
     {
       code: `
           /**
@@ -67,6 +120,21 @@ export default {
           }
       `,
     },
+    {
+      code: `
+          /**
+           * @param foo
+           */
+          function quux (foo) {
+
+          }
+      `,
+      options: [
+        {
+          contexts: ['any'],
+        },
+      ],
+    },
     {
       code: `
           /**
@@ -77,5 +145,21 @@ export default {
           }
       `,
     },
+    {
+      code: `
+          /**
+           * @function
+           * @param
+           */
+      `,
+    },
+    {
+      code: `
+          /**
+           * @callback
+           * @param
+           */
+      `,
+    },
   ],
 };
diff --git a/test/rules/assertions/requireParamType.js b/test/rules/assertions/requireParamType.js
@@ -16,6 +16,59 @@ export default {
         },
       ],
     },
+    {
+      code: `
+          /**
+           * @param foo
+           */
+          function quux (foo) {
+
+          }
+      `,
+      errors: [
+        {
+          line: 3,
+          message: 'Missing JSDoc @param "foo" type.',
+        },
+      ],
+      options: [{
+        contexts: ['any'],
+      }],
+    },
+    {
+      code: `
+          /**
+           * @function
+           * @param foo
+           */
+      `,
+      errors: [
+        {
+          line: 4,
+          message: 'Missing JSDoc @param "foo" type.',
+        },
+      ],
+      options: [{
+        contexts: ['any'],
+      }],
+    },
+    {
+      code: `
+          /**
+           * @callback
+           * @param foo
+           */
+      `,
+      errors: [
+        {
+          line: 4,
+          message: 'Missing JSDoc @param "foo" type.',
+        },
+      ],
+      options: [{
+        contexts: ['any'],
+      }],
+    },
     {
       code: `
           /**
@@ -84,5 +137,34 @@ export default {
           }
       `,
     },
+    {
+      code: `
+          /**
+           * @param {number} foo
+           */
+          function quux (foo) {
+
+          }
+      `,
+      options: [{
+        contexts: ['any'],
+      }],
+    },
+    {
+      code: `
+          /**
+           * @function
+           * @param foo
+           */
+      `,
+    },
+    {
+      code: `
+          /**
+           * @callback
+           * @param foo
+           */
+      `,
+    },
   ],
 };