fix: octokit.git.listRefs() logs deprecation (#238)

octokit · Oct 7, 2020 · 9e80cb3 · 9e80cb3
1 parent ff5629f
commit 9e80cb3
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 1 deletion.
diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts
@@ -1349,7 +1349,8 @@ export default {
         per_page: { type: "integer" },
         repo: { required: true, type: "string" }
       },
-      url: "/repos/:owner/:repo/git/refs/:namespace"
+      url: "/repos/:owner/:repo/git/refs/:namespace",
+      deprecated: "`[@octokit/plugin-rest-endpoint-methods] \"octokit.git.listRefs({ owner, repo, namespace })\" is deprecated. Use \"octokit.git.listMatchingRefs({ owner, repo, ref })\" instead"
     },
     updateRef: {
       method: "PATCH",

diff --git a/test/deprecations.test.ts b/test/deprecations.test.ts
@@ -169,4 +169,33 @@ describe("Deprecations", () => {
     });
     expect(warnCalledCount).toEqual(1);
   });
+
+  it("octokit.git.listRefs()", () => {
+    const mock = fetchMock
+      .sandbox()
+      .getOnce("path:/repos/octocat/hello-world/git/refs/heads/", {
+        ok: true
+      });
+    const MyOctokit = Octokit.plugin(restEndpointMethods);
+    let warnCalledCount = 0;
+    const octokit = new MyOctokit({
+      log: {
+        warn: (deprecation: Error) => {
+          warnCalledCount++;
+          expect(deprecation.message).toMatch(
+            `[@octokit/plugin-rest-endpoint-methods] "octokit.git.listRefs({ owner, repo, namespace })" is deprecated. Use "octokit.git.listMatchingRefs({ owner, repo, ref })" instead`
+          );
+        }
+      },
+      request: {
+        fetch: mock
+      }
+    });
+    octokit.git.listRefs({
+      owner: "octocat",
+      repo: "hello-world",
+      namespace: "heads/"
+    });
+    expect(warnCalledCount).toEqual(1);
+  });
 });