completed-docs: Handle undefined symbol (#2230)

palantir · Feb 27, 2017 · 12435bf · 12435bf
1 parent ba3cfa0
commit 12435bf
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/src/rules/completedDocsRule.ts b/src/rules/completedDocsRule.ts
@@ -392,7 +392,12 @@ class CompletedDocsWalker extends Lint.ProgramAwareRuleWalker {
             return;
         }
 
-        const comments = this.getTypeChecker().getSymbolAtLocation(node.name).getDocumentationComment();
+        const symbol = this.getTypeChecker().getSymbolAtLocation(node.name);
+        if (!symbol) {
+            return;
+        }
+
+        const comments = symbol.getDocumentationComment();
         this.checkComments(node, nodeType, comments);
     }
 

diff --git a/test/rules/completed-docs/defaults/test.ts.lint b/test/rules/completed-docs/defaults/test.ts.lint
@@ -5,6 +5,10 @@ export class Aaa {
 
     public ccc() { }
     ~~~~~~~~~~~~~~~~       [Documentation must exist for public methods.]
+
+    // TODO: TypeScript API doesn't give us a symbol for this, so we must ignore it.
+    // https://github.com/Microsoft/TypeScript/issues/14257
+    [Symbol.iterator]() {}
 }
 
 export enum Ddd { }