feat: Add .findReferencesAsNodes() to deprecate .getReferencingNodes(…

…) in next major. Using `findReferencesAsNodes()` so that the method is more discoverable when using `findReferences()`.
dsherret · Jun 1, 2018 · a8a731a · a8a731a
1 parent a4dd7d2
commit a8a731a
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 13 deletions.
diff --git a/docs/navigation/finding-references.md b/docs/navigation/finding-references.md
@@ -35,5 +35,5 @@ If you just went the nodes that reference the named/nameable declaration, then u
 following method:
 
 ```ts
-const nodes = classDeclaration.getReferencingNodes();
+const nodes = classDeclaration.findReferencesAsNodes();
 ```
diff --git a/src/compiler/base/name/ReferenceFindableNode.ts b/src/compiler/base/name/ReferenceFindableNode.ts
@@ -8,11 +8,16 @@ export type ReferenceFindableNodeExtensionType = Node<ts.Node & { name?: ts.Prop
 
 export interface ReferenceFindableNode {
     /**
-     * Finds the references of the node.
+     * Finds the references of the definition of the node.
      */
     findReferences(): ReferencedSymbol[];
+    /**
+     * Finds the nodes that reference the definition of the node.
+     */
+    findReferencesAsNodes(): Node[];
     /**
      * Gets the nodes that reference the definition of the node.
+     * @deprecated Use `findReferencesAsNodes()`
      */
     getReferencingNodes(): Node[];
 }
@@ -23,8 +28,12 @@ export function ReferenceFindableNode<T extends Constructor<ReferenceFindableNod
             return this.global.languageService.findReferences(getNodeForReferences(this));
         }
 
+        findReferencesAsNodes() {
+            return this.global.languageService.findReferencesAsNodes(getNodeForReferences(this));
+        }
+
         getReferencingNodes() {
-            return this.global.languageService.getDefinitionReferencingNodes(getNodeForReferences(this));
+            return this.findReferencesAsNodes();
         }
     };
 }

diff --git a/src/compiler/class/ClassDeclaration.ts b/src/compiler/class/ClassDeclaration.ts
@@ -914,7 +914,7 @@ export class ClassDeclaration extends ClassDeclarationBase<ts.ClassDeclaration>
         if (nameNode == null)
             return classes;
 
-        for (const node of nameNode.getReferencingNodes()) {
+        for (const node of nameNode.findReferencesAsNodes()) {
             const nodeParent = node.getParentIfKind(SyntaxKind.ExpressionWithTypeArguments);
             if (nodeParent == null)
                 continue;

diff --git a/src/compiler/tools/LanguageService.ts b/src/compiler/tools/LanguageService.ts
@@ -190,7 +190,7 @@ export class LanguageService {
      * Finds the nodes that reference the definition(s) of the specified node.
      * @param node - Node.
      */
-    getDefinitionReferencingNodes(node: Node) {
+    findReferencesAsNodes(node: Node) {
         const references = this.findReferences(node);
         return ArrayUtils.from(getReferencingNodes());
 
@@ -205,6 +205,15 @@ export class LanguageService {
         }
     }
 
+    /**
+     * Finds the nodes that reference the definition(s) of the specified node.
+     * @param node - Node.
+     * @deprecated Use `findReferencesAsNodes()`.
+     */
+    getDefinitionReferencingNodes(node: Node) {
+        return this.findReferencesAsNodes(node);
+    }
+
     /**
      * Finds references based on the specified position.
      * @param sourceFile - Source file.

diff --git a/src/next-major-deprecations.md b/src/next-major-deprecations.md
@@ -1,3 +1,4 @@
 # Deprecations in the next major
 
-None.
+* getDefinitionReferencingNodes(node)
+* getReferencingNodes()
diff --git a/src/tests/compiler/base/name/nameableNodeTests.ts b/src/tests/compiler/base/name/nameableNodeTests.ts
@@ -105,11 +105,11 @@ describe(nameof(NameableNode), () => {
         });
     });
 
-    describe(nameof<NameableNode>(n => n.getReferencingNodes), () => {
+    describe(nameof<NameableNode>(n => n.findReferencesAsNodes), () => {
         it("should find all the references and exclude the definition when there is a name", () => {
             const {firstChild, project} = getInfoFromText<ClassDeclaration>("class MyClass {}\nconst reference = MyClass;");
             const secondSourceFile = project.createSourceFile("second.ts", "const reference2 = MyClass;");
-            const referencingNodes = firstChild.getReferencingNodes();
+            const referencingNodes = firstChild.findReferencesAsNodes();
             expect(referencingNodes.length).to.equal(2);
             expect(referencingNodes[0].getParentOrThrow().getText()).to.equal("reference = MyClass");
             expect(referencingNodes[1].getParentOrThrow().getText()).to.equal("reference2 = MyClass");
@@ -118,7 +118,7 @@ describe(nameof(NameableNode), () => {
         it("should find all the references and exclude the definition when there isn't a name", () => {
             const {firstChild, project} = getInfoFromText<ClassDeclaration>("export default class {}", { filePath: "/MyClass.ts" });
             const secondSourceFile = project.createSourceFile("/second.ts", "import MyClass from './MyClass';\nconst reference2 = MyClass;");
-            const referencingNodes = firstChild.getReferencingNodes();
+            const referencingNodes = firstChild.findReferencesAsNodes();
             expect(referencingNodes.length).to.equal(2);
             expect(referencingNodes[0].getParentOrThrow().getParentOrThrow().getText()).to.equal("import MyClass from './MyClass';");
             expect(referencingNodes[1].getParentOrThrow().getText()).to.equal("reference2 = MyClass");

diff --git a/src/tests/compiler/base/name/namedNodeTests.ts b/src/tests/compiler/base/name/namedNodeTests.ts
@@ -62,11 +62,11 @@ describe(nameof(NamedNode), () => {
         });
     });
 
-    describe(nameof<NamedNode>(n => n.getReferencingNodes), () => {
+    describe(nameof<NamedNode>(n => n.findReferencesAsNodes), () => {
         it("should find all the references and exclude the definition", () => {
             const {firstChild, sourceFile, project} = getInfoFromText<FunctionDeclaration>("function myFunction() {}\nconst reference = myFunction;");
             const secondSourceFile = project.createSourceFile("second.ts", "const reference2 = myFunction;");
-            const referencingNodes = firstChild.getReferencingNodes();
+            const referencingNodes = firstChild.findReferencesAsNodes();
             expect(referencingNodes.length).to.equal(2);
             expect(referencingNodes[0].getParentOrThrow().getText()).to.equal("reference = myFunction");
             expect(referencingNodes[1].getParentOrThrow().getText()).to.equal("reference2 = myFunction");

diff --git a/src/tests/compiler/common/identifierTests.ts b/src/tests/compiler/common/identifierTests.ts
@@ -113,11 +113,11 @@ const t = MyNamespace.MyClass;
         });
     });
 
-    describe(nameof<Identifier>(n => n.getReferencingNodes), () => {
+    describe(nameof<Identifier>(n => n.findReferencesAsNodes), () => {
         it("should find all the references and exclude the definition", () => {
             const {firstChild, sourceFile, project} = getInfoFromText<FunctionDeclaration>("function myFunction() {}\nconst reference = myFunction;");
             const secondSourceFile = project.createSourceFile("second.ts", "const reference2 = myFunction;");
-            const referencingNodes = firstChild.getNameNode().getReferencingNodes();
+            const referencingNodes = firstChild.getNameNode().findReferencesAsNodes();
             expect(referencingNodes.length).to.equal(2);
             expect(referencingNodes[0].getParentOrThrow().getText()).to.equal("reference = myFunction");
             expect(referencingNodes[1].getParentOrThrow().getText()).to.equal("reference2 = myFunction");