completed-docs: methods and properties on interfaces are checked. (pa…

…lantir#4032)
temporaryAny · Aug 21, 2018 · d178206 · d178206
1 parent 360bdd0
commit d178206
Show file tree

Hide file tree

Showing 5 changed files with 102 additions and 0 deletions.
diff --git a/src/rules/completedDocsRule.ts b/src/rules/completedDocsRule.ts
@@ -340,6 +340,10 @@ function walk(context: Lint.WalkContext<ExclusionsMap>, typeChecker: ts.TypeChec
                 checkNode(node as ts.InterfaceDeclaration, ARGUMENT_INTERFACES);
                 break;
 
+            case ts.SyntaxKind.MethodSignature:
+                checkNode(node as ts.MethodSignature, ARGUMENT_METHODS);
+                break;
+
             case ts.SyntaxKind.MethodDeclaration:
                 if (node.parent!.kind !== ts.SyntaxKind.ObjectLiteralExpression) {
                     checkNode(node as ts.MethodDeclaration, ARGUMENT_METHODS);
@@ -350,6 +354,10 @@ function walk(context: Lint.WalkContext<ExclusionsMap>, typeChecker: ts.TypeChec
                 checkNode(node as ts.ModuleDeclaration, ARGUMENT_NAMESPACES);
                 break;
 
+            case ts.SyntaxKind.PropertySignature:
+                checkNode(node as ts.PropertySignature, ARGUMENT_PROPERTIES);
+                break;
+
             case ts.SyntaxKind.PropertyDeclaration:
                 checkNode(node as ts.PropertyDeclaration, ARGUMENT_PROPERTIES);
                 break;

diff --git a/test/rules/completed-docs/interface-members/test.ts.lint b/test/rules/completed-docs/interface-members/test.ts.lint
@@ -0,0 +1,39 @@
+/**
+ * ...
+ */
+interface BadInterfaceMembers {
+    prop: number;
+    ~~~~~~~~~~~~~                [Documentation must exist for properties.]
+    method(): number;
+    ~~~~~~~~~~~~~~~~~            [Documentation must exist for methods.]
+}
+
+/**
+ * ...
+ */
+interface EmptyInterfaceMembers {
+    /**
+     *
+     */
+    prop: number;
+    ~~~~~~~~~~~~~               [Documentation must exist for properties.]
+    /**
+     *
+     */
+    method(): number;
+    ~~~~~~~~~~~~~~~~~           [Documentation must exist for methods.]
+}
+
+/**
+ * ...
+ */
+interface GoodInterfaceMembers {
+    /**
+     * ...
+     */
+    prop: number;
+    /**
+     * ...
+     */
+    method(): number;
+}
diff --git a/test/rules/completed-docs/interface-members/tsconfig.json b/test/rules/completed-docs/interface-members/tsconfig.json
@@ -0,0 +1,5 @@
+{
+    "compilerOptions": {
+        "module": "commonjs"
+    }
+}
diff --git a/test/rules/completed-docs/interface-members/tslint.json b/test/rules/completed-docs/interface-members/tslint.json
@@ -0,0 +1,10 @@
+{
+  "rules": {
+    "completed-docs": [
+      true,
+      "interfaces",
+      "methods",
+      "properties"
+    ]
+  }
+}
diff --git a/test/rules/completed-docs/types/test.ts.lint b/test/rules/completed-docs/types/test.ts.lint
@@ -291,6 +291,46 @@ interface EmptyInterface { }
  */
 interface GoodInterface { }
 
+/**
+ * ...
+ */
+interface BadInterfaceMembers {
+    prop: number;
+    ~~~~~~~~~~~~~                [Documentation must exist for properties.]
+    method(): number;
+    ~~~~~~~~~~~~~~~~~            [Documentation must exist for methods.]
+}
+
+/**
+ * ...
+ */
+interface EmptyInterfaceMembers {
+    /**
+     *
+     */
+    prop: number;
+    ~~~~~~~~~~~~~               [Documentation must exist for properties.]
+    /**
+     *
+     */
+    method(): number;
+    ~~~~~~~~~~~~~~~~~           [Documentation must exist for methods.]
+}
+
+/**
+ * ...
+ */
+interface GoodInterfaceMembers {
+    /**
+     * ...
+     */
+    prop: number;
+    /**
+     * ...
+     */
+    method(): number;
+}
+
 namespace BadNamespace { }
 ~~~~~~~~~~~~~~~~~~~~~~~~~~      [Documentation must exist for namespaces.]