Merge pull request #236 from brettz9/ignore-private

- `ignorePrivate` setting; fixes #78

Author: brettz9

README.md

@@ -2848,6 +2848,14 @@ class A {
 
   }
 }
+
+/**
+ * @private
+ */
+function quux (foo) {
+
+}
+// Settings: {"jsdoc":{"ignorePrivate":true}}
 ````
 
 

src/iterateJsdoc.js

@@ -230,9 +230,7 @@ export {
   parseComment
 };
 
-export default (iterator, options) => {
-  const opts = options || {};
-
+export default (iterator, opts = {}) => {
   return {
     /**
      * The entrypoint for the JSDoc rule.
@@ -246,6 +244,9 @@ export default (iterator, options) => {
     create (context) {
       const sourceCode = context.getSourceCode();
 
+      // All rules
+      const ignorePrivate = Boolean(_.get(context, 'settings.jsdoc.ignorePrivate'));
+
       // `check-tag-names` and many require/param rules
       const tagNamePreference = _.get(context, 'settings.jsdoc.tagNamePreference') || {};
 
@@ -351,6 +352,13 @@ export default (iterator, options) => {
           sourceCode
         );
 
+        if (
+          ignorePrivate &&
+          utils.hasTag('private')
+        ) {
+          return;
+        }
+
         iterator({
           context,
           indent,

test/rules/assertions/requireParam.js

@@ -474,6 +474,21 @@ export default {
             }
           }
       `
+    },
+    {
+      code: `
+          /**
+           * @private
+           */
+          function quux (foo) {
+
+          }
+      `,
+      settings: {
+        jsdoc: {
+          ignorePrivate: true
+        }
+      }
     }
   ]
 };