Merge pull request #63 from zxqfox/feature/enforce-existance-except-exports

enforceExistence: add exceptExports value

Author: qfox

README.md

@@ -55,7 +55,9 @@ To use plugin you should add these lines to configuration file `.jscsrc`:
         "jscs-jsdoc"
     ],
     "jsDoc": {
-        "enforceExistence": true
+        "checkAnnotations": "closurecompiler",
+        "checkTypes": "strictNativeCase",
+        "enforceExistence": "exceptExports"
     }
 }
 ```
@@ -519,9 +521,9 @@ function _e() {}
 
 Ensures jsdoc block exist
 
-Type: `Boolean`
+Type: `Boolean` or `String`
 
-Values: `true`
+Values: `true` or `"exceptExports"` (skip `module.exports = function () {};`)
 
 Context: `functions`
 

lib/rules/validate-jsdoc/enforce-existence.js

@@ -1,7 +1,7 @@
 module.exports = enforceExistence;
 module.exports.scopes = ['function'];
 module.exports.options = {
-    enforceExistence: {allowedValues: [true]}
+    enforceExistence: {allowedValues: [true, 'exceptExports']}
 };
 
 /**
@@ -10,15 +10,28 @@ module.exports.options = {
  * @param {Function} err
  */
 function enforceExistence(node, err) {
+    var reportExports = this._options.enforceExistence !== 'exceptExports';
+
     // if function is not anonymous or in variabledeclarator or in assignmentexpression
     var parentNode = node.parentNode || {};
     var needCheck = node.id ||
         parentNode.type === 'VariableDeclarator' ||
         parentNode.type === 'Property' ||
         parentNode.type === 'AssignmentExpression' && parentNode.operator === '=';
 
-    // and report unless jsdoc exists
-    if (needCheck && !node.jsdoc) {
-        err('jsdoc definition required', node.loc.start);
+    if (!reportExports && needCheck && parentNode.type === 'AssignmentExpression') {
+        var left = parentNode.left;
+        if ((left.object && left.object.name) === 'module' &&
+            (left.property && left.property.name) === 'exports') {
+            needCheck = false;
+        }
+    }
+
+    // skip unless jsdoc exists and check is needed
+    if (node.jsdoc || !needCheck) {
+        return;
     }
+
+    // report absence
+    err('jsdoc definition required', node.loc.start);
 }

test/lib/rules/validate-jsdoc/enforce-existence.js

@@ -118,9 +118,33 @@ describe('lib/rules/validate-jsdoc/enforce-existence', function () {
                         };
                     })();
                 }
+            }, {
+                it: 'should report jsdocs existence for module.exports anonymous function',
+                code: function () {
+                    module.exports = function () {
+                    };
+                },
+                errors: 1
             }
             /* jshint ignore:end */
         ]);
 
     });
+
+    describe('with exceptExports', function() {
+        checker.rules({enforceExistence: 'exceptExports'});
+
+        checker.cases([
+            /* jshint ignore:start */
+            {
+                it: 'should not report jsdocs existence for module.exports anonymous function',
+                code: function () {
+                    module.exports = function () {
+                    };
+                }
+            }
+            /* jshint ignore:end */
+        ]);
+    });
+
 });