fix(match-description): tighten default regex to require punctuation at the end even if only a single character

fix(match-description, require-description): allow `contexts` to work with any node type
feat(require-jsdoc): add `contexts` option to allow working with any node type

Author: brettz9

.README/rules/match-description.md

@@ -6,7 +6,7 @@ The default is this basic expression to match English sentences (Support
 for Unicode upper case may be added in a future version when it can be handled
 by our supported Node versions):
 
-``^([A-Z]|[`\\d_])([\\s\\S]*[.?!`])?$``
+``^([A-Z]|[`\\d_])[\\s\\S]*[.?!`]$``
 
 #### Options
 

.README/rules/require-jsdoc.md

@@ -34,6 +34,11 @@ be checked by the rule.
   - `FunctionExpression`
   - `MethodDefinition`
 
+- `contexts` - Set this to a string or array of strings representing the additional
+  AST context where you wish the rule to be applied (e.g., `Property` for properties).
+  Note that unlike `require-description` and `match-description`, this rule has no
+  `noDefaults` option because its defaults are instead set up by `require`.
+
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`|

README.md

@@ -2285,7 +2285,7 @@ The default is this basic expression to match English sentences (Support
 for Unicode upper case may be added in a future version when it can be handled
 by our supported Node versions):
 
-``^([A-Z]|[`\\d_])([\\s\\S]*[.?!`])?$``
+``^([A-Z]|[`\\d_])[\\s\\S]*[.?!`]$``
 
 <a name="eslint-plugin-jsdoc-rules-match-description-options-1"></a>
 #### Options
@@ -2400,7 +2400,7 @@ function quux () {
 // Message: JSDoc description does not satisfy the regex pattern.
 
 /**
- * тест.
+ * Abc.
  */
 function quux () {
 
@@ -2563,6 +2563,33 @@ class quux {
 // Options: [{"contexts":["ClassDeclaration"],"noDefaults":true}]
 >>>>>>> feat(match-description): allow `main description: string|boolean` to override or disable main description separate from default
 // Message: JSDoc description does not satisfy the regex pattern.
+
+class MyClass {
+  /**
+   * Abc
+   */
+  myClassField = 1
+}
+// Options: [{"contexts":["ClassProperty"],"noDefaults":true}]
+// Message: JSDoc description does not satisfy the regex pattern.
+
+/**
+ * foo.
+ */
+interface quux {
+
+}
+// Options: [{"contexts":["TSInterfaceDeclaration"],"noDefaults":true}]
+// Message: JSDoc description does not satisfy the regex pattern.
+
+const myObject = {
+  /**
+   * Bad description
+   */
+  myProp: true
+};
+// Options: [{"contexts":["Property"],"noDefaults":true}]
+// Message: JSDoc description does not satisfy the regex pattern.
 ````
 
 The following patterns are not considered problems:
@@ -2715,6 +2742,30 @@ class quux {
 
 }
 // Options: [{"tags":{"main description":true}}]
+
+class MyClass {
+  /**
+   * Abc.
+   */
+  myClassField = 1
+}
+// Options: [{"contexts":["ClassProperty"],"noDefaults":true}]
+
+/**
+ * Foo.
+ */
+interface quux {
+
+}
+// Options: [{"contexts":["TSInterfaceDeclaration"],"noDefaults":true}]
+
+const myObject = {
+  /**
+   * Bad description
+   */
+  myProp: true
+};
+// Options: [{"contexts":[],"noDefaults":true}]
 ````
 
 
@@ -3523,6 +3574,7 @@ interface quux {
 }
 // Options: [{"contexts":["TSInterfaceDeclaration"],"noDefaults":true}]
 // Message: Missing JSDoc @description declaration.
+<<<<<<< HEAD
 
 /**
  *
@@ -3541,6 +3593,8 @@ var quux = {
 };
 // Options: [{"contexts":["ObjectExpression"]}]
 // Message: Missing JSDoc @description declaration.
+=======
+>>>>>>> fix(match-description): tighten default regex to require punctuation at the end even if only a single character
 ````
 
 The following patterns are not considered problems:
@@ -3602,6 +3656,7 @@ function quux () {
 interface quux {
 
 }
+<<<<<<< HEAD
 
 /**
  *
@@ -3616,6 +3671,9 @@ var quux = class {
 var quux = {
 
 };
+=======
+// Message: Missing JSDoc @description declaration.
+>>>>>>> fix(match-description): tighten default regex to require punctuation at the end even if only a single character
 ````
 
 
@@ -3883,6 +3941,11 @@ be checked by the rule.
   - `FunctionExpression`
   - `MethodDefinition`
 
+- `contexts` - Set this to a string or array of strings representing the additional
+  AST context where you wish the rule to be applied (e.g., `Property` for properties).
+  Note that unlike `require-description` and `match-description`, this rule has no
+  `noDefaults` option because its defaults are instead set up by `require`.
+
 |||
 |---|---|
 |Context|`ArrowFunctionExpression`, `ClassDeclaration`, `ClassExpression`, `FunctionDeclaration`, `FunctionExpression`|
@@ -4214,6 +4277,12 @@ export function someMethod() {
 }
 // Options: [{"publicOnly":{"cjs":false,"esm":true,"window":false},"require":{"FunctionDeclaration":true}}]
 // Message: Missing JSDoc comment.
+
+const myObject = {
+  myProp: true
+};
+// Options: [{"contexts":["Property"]}]
+// Message: Missing JSDoc comment.
 ````
 
 The following patterns are not considered problems:
@@ -4683,6 +4752,11 @@ exports.someMethod = function() {
 
 }
 // Options: [{"publicOnly":{"cjs":false,"esm":true,"window":false},"require":{"FunctionExpression":true}}]
+
+const myObject = {
+  myProp: true
+};
+// Options: [{"contexts":[]}]
 ````
 
 

src/iterateJsdoc.js

@@ -464,11 +464,7 @@ export default function iterateJsdoc (iterator, ruleConfig) {
         };
       }
 
-      return contexts.reduce((obj, prop) => {
-        obj[prop] = checkJsdoc;
-
-        return obj;
-      }, {});
+      return jsdocUtils.getContextObject(contexts, checkJsdoc);
     },
     meta: ruleConfig.meta
   };

src/jsdocUtils.js

@@ -511,8 +511,17 @@ const enforcedContexts = (context, defaultContexts) => {
     [...new Set([...defltContexts, ...contexts])];
 };
 
+const getContextObject = (contexts, checkJsdoc) => {
+  return contexts.reduce((obj, prop) => {
+    obj[prop] = checkJsdoc;
+
+    return obj;
+  }, {});
+};
+
 export default {
   enforcedContexts,
+  getContextObject,
   getFunctionParameterNames,
   getJsdocParameterNames,
   getJsdocParameterNamesDeep,

src/rules/matchDescription.js

@@ -23,7 +23,7 @@ export default iterateJsdoc(({
 
       // If supporting Node >= 10, we could loosen to this for the
       //   initial letter: \\p{Upper}
-      ) || '^[A-Z`\\d_](?:[\\s\\S]*[.?!`])?$',
+      ) || '^[A-Z`\\d_][\\s\\S]*[.?!`]$',
       'u'
     );
 

src/rules/requireJsdoc.js

@@ -7,6 +7,19 @@ import getJSDocComment from '../eslint/getJSDocComment';
 const OPTIONS_SCHEMA = {
   additionalProperties: false,
   properties: {
+    contexts: {
+      oneOf: [
+        {
+          items: {
+            type: 'string'
+          },
+          type: 'array'
+        },
+        {
+          type: 'string'
+        }
+      ]
+    },
     publicOnly: {
       oneOf: [
         {
@@ -164,60 +177,64 @@ export default iterateJsdoc(null, {
       }
     };
 
-    return {
-      ArrowFunctionExpression (node) {
-        if (!requireOption.ArrowFunctionExpression) {
-          return;
-        }
+    // eslint-disable-next-line fp/no-mutating-assign
+    return Object.assign(
+      jsdocUtils.getContextObject(jsdocUtils.enforcedContexts(context, []), checkJsDoc),
+      {
+        ArrowFunctionExpression (node) {
+          if (!requireOption.ArrowFunctionExpression) {
+            return;
+          }
 
-        if (!['VariableDeclarator', 'ExportDefaultDeclaration'].includes(node.parent.type)) {
-          return;
-        }
+          if (!['VariableDeclarator', 'ExportDefaultDeclaration'].includes(node.parent.type)) {
+            return;
+          }
 
-        checkJsDoc(node);
-      },
-
-      ClassDeclaration (node) {
-        if (!requireOption.ClassDeclaration) {
-          return;
-        }
+          checkJsDoc(node);
+        },
 
-        checkJsDoc(node);
-      },
+        ClassDeclaration (node) {
+          if (!requireOption.ClassDeclaration) {
+            return;
+          }
 
-      ClassExpression (node) {
-        if (!requireOption.ClassExpression) {
-          return;
-        }
+          checkJsDoc(node);
+        },
 
-        checkJsDoc(node);
-      },
+        ClassExpression (node) {
+          if (!requireOption.ClassExpression) {
+            return;
+          }
 
-      FunctionDeclaration (node) {
-        if (!requireOption.FunctionDeclaration) {
-          return;
-        }
+          checkJsDoc(node);
+        },
 
-        checkJsDoc(node);
-      },
+        FunctionDeclaration (node) {
+          if (!requireOption.FunctionDeclaration) {
+            return;
+          }
 
-      FunctionExpression (node) {
-        if (requireOption.MethodDefinition && node.parent.type === 'MethodDefinition') {
           checkJsDoc(node);
+        },
 
-          return;
-        }
+        FunctionExpression (node) {
+          if (requireOption.MethodDefinition && node.parent.type === 'MethodDefinition') {
+            checkJsDoc(node);
 
-        if (!requireOption.FunctionExpression) {
-          return;
-        }
+            return;
+          }
 
-        if (['VariableDeclarator', 'AssignmentExpression', 'ExportDefaultDeclaration'].includes(node.parent.type)) {
-          checkJsDoc(node);
-        } else if (node.parent.type === 'Property' && node === node.parent.value) {
-          checkJsDoc(node);
+          if (!requireOption.FunctionExpression) {
+            return;
+          }
+
+          if (['VariableDeclarator', 'AssignmentExpression', 'ExportDefaultDeclaration'].includes(node.parent.type)) {
+            checkJsDoc(node);
+          } else if (node.parent.type === 'Property' && node === node.parent.value) {
+            checkJsDoc(node);
+          }
         }
       }
-    };
+    );
   }
 });