Fix bug where you couldn't enable the "completed-docs" rule for just …

…private/protected methods (#2749)

+ Fix the bug
+ Fix the broken "privacies" test
+ Add tests for the individual "privacies"

src/rules/completedDocsRule.ts

@@ -328,7 +328,7 @@ class ClassRequirement extends Requirement<IClassRequirementDescriptor> {
             return this.privacies.has(PRIVACY_PROTECTED);
         }
 
-        return Lint.hasModifier(node.modifiers, ts.SyntaxKind.PublicKeyword);
+        return this.privacies.has(PRIVACY_PUBLIC);
     }
 }
 

test/rules/completed-docs/privacies-private/test.ts.lint

@@ -0,0 +1,30 @@
+class Class {
+    badDefaultMethod() { }
+
+    /**
+     * ...
+     */
+    goodDefaultMethod() { }
+
+    public badPublicMethod() { }
+
+    /**
+     * ...
+     */
+    public goodPublicMethod() { }
+
+    protected badProtectedMethod() { }
+
+    /**
+     * ...
+     */
+    protected goodProtectedMethod() { }
+
+    private badPrivateMethod() { }
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~       [Documentation must exist for private methods.]
+
+    /**
+     * ...
+     */
+    private goodPrivateMethod() { }
+}

test/rules/completed-docs/privacies-private/tslint.json

@@ -0,0 +1,12 @@
+{
+  "linterOptions": {
+    "typeCheck": true
+  },
+  "rules": {
+    "completed-docs": [true, {
+      "methods": {
+        "privacies": ["private"]
+      }
+    }]
+  }
+}

test/rules/completed-docs/privacies-protected/test.ts.lint

@@ -0,0 +1,30 @@
+class Class {
+    badDefaultMethod() { }
+
+    /**
+     * ...
+     */
+    goodDefaultMethod() { }
+
+    public badPublicMethod() { }
+
+    /**
+     * ...
+     */
+    public goodPublicMethod() { }
+
+    protected badProtectedMethod() { }
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~       [Documentation must exist for protected methods.]
+
+    /**
+     * ...
+     */
+    protected goodProtectedMethod() { }
+
+    private badPrivateMethod() { }
+
+    /**
+     * ...
+     */
+    private goodPrivateMethod() { }
+}

test/rules/completed-docs/privacies-protected/tslint.json

@@ -0,0 +1,12 @@
+{
+  "linterOptions": {
+    "typeCheck": true
+  },
+  "rules": {
+    "completed-docs": [true, {
+      "methods": {
+        "privacies": ["protected"]
+      }
+    }]
+  }
+}

test/rules/completed-docs/privacies-public/test.ts.lint

@@ -0,0 +1,31 @@
+class Class {
+    badDefaultMethod() { }
+    ~~~~~~~~~~~~~~~~~~~~~~       [Documentation must exist for methods.]
+
+    /**
+     * ...
+     */
+    goodDefaultMethod() { }
+
+    public badPublicMethod() { }
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~       [Documentation must exist for public methods.]
+
+    /**
+     * ...
+     */
+    public goodPublicMethod() { }
+
+    protected badProtectedMethod() { }
+
+    /**
+     * ...
+     */
+    protected goodProtectedMethod() { }
+
+    private badPrivateMethod() { }
+
+    /**
+     * ...
+     */
+    private goodPrivateMethod() { }
+}

test/rules/completed-docs/privacies-public/tslint.json

@@ -0,0 +1,12 @@
+{
+  "linterOptions": {
+    "typeCheck": true
+  },
+  "rules": {
+    "completed-docs": [true, {
+      "methods": {
+        "privacies": ["public"]
+      }
+    }]
+  }
+}

test/rules/completed-docs/privacies/tslint.json

@@ -5,10 +5,7 @@
   "rules": {
     "completed-docs": [true, {
       "methods": {
-        "visibilities": ["public", "protected"]
-      },
-      "properties": {
-        "visibilities": ["public"]
+        "privacies": ["all"]
       }
     }]
   }