feat(require-jsdoc): add enableFixer option; if set to false, will avoid fixer; fixes #372

Author: brettz9

README.md

@@ -8359,6 +8359,12 @@ function myFunction() {
 // Settings: {"jsdoc":{"minLines":1}}
 // Message: Missing JSDoc comment.
 
+function myFunction() {
+
+}
+// Options: [{"enableFixer":false}]
+// Message: Missing JSDoc comment.
+
 export var test = function () {
 
 };

src/rules/requireJsdoc.js

@@ -29,6 +29,10 @@ const OPTIONS_SCHEMA = {
       },
       type: 'array',
     },
+    enableFixer: {
+      default: true,
+      type: 'boolean',
+    },
     exemptEmptyFunctions: {
       default: false,
       type: 'boolean',
@@ -108,10 +112,12 @@ const getOptions = (context) => {
     publicOnly,
     contexts = [],
     exemptEmptyFunctions = false,
+    enableFixer = true,
   } = context.options[0] || {};
 
   return {
     contexts,
+    enableFixer,
     exemptEmptyFunctions,
     publicOnly: ((baseObj) => {
       if (!publicOnly) {
@@ -146,7 +152,7 @@ export default {
     const {
       require: requireOption,
       contexts,
-      publicOnly, exemptEmptyFunctions,
+      publicOnly, exemptEmptyFunctions, enableFixer,
     } = getOptions(context);
 
     const checkJsDoc = (node, isFunctionContext) => {
@@ -200,7 +206,7 @@ export default {
           start: node.loc.start,
         };
         context.report({
-          fix,
+          fix: enableFixer ? fix : null,
           loc,
           messageId: 'missingJsDoc',
           node,

test/rules/assertions/requireJsdoc.js

@@ -97,6 +97,28 @@ export default {
         },
       },
     },
+    {
+      code: `
+       function myFunction() {
+
+       }
+       `,
+      errors: [
+        {
+          message: 'Missing JSDoc comment.',
+        },
+      ],
+      options: [
+        {
+          enableFixer: false,
+        },
+      ],
+      output: `
+       function myFunction() {
+
+       }
+       `,
+    },
     {
       code: `
           export var test = function () {