fix: adapt for latest @octokit/types (#66)

gr2m · Jan 15, 2021 · f2abf7f · pelikhan · Feb 8, 2021 · f2abf7f
1 parent cd81aa5
commit f2abf7f
Show file tree

Hide file tree

Showing 22 changed files with 26,755 additions and 7,074 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -4,8 +4,8 @@
   "description": "Octokit plugin to create a pull request with multiple file changes",
   "scripts": {
     "build": "pika build",
-    "lint": "prettier --check '{src,test}/**/*.{ts,md}' *.md package.json tsconfig.json",
-    "lint:fix": "prettier --write '{src,test}/**/*.{ts,md}' *.md package.json tsconfig.json",
+    "lint": "prettier --check \"{src,test}/**/*.{ts,md}\" *.md package.json tsconfig.json",
+    "lint:fix": "prettier --write \"{src,test}/**/*.{ts,md}\" *.md package.json tsconfig.json",
     "pretest": "npm run -s lint",
     "test": "jest --coverage"
   },
@@ -17,6 +17,9 @@
   ],
   "author": "Gregor Martynus (https://github.com/gr2m)",
   "license": "MIT",
+  "dependencies": {
+    "@octokit/types": "^6.3.0"
+  },
   "devDependencies": {
     "@octokit/core": "^3.0.0",
     "@octokit/plugin-paginate-rest": "^2.0.1",

diff --git a/src/compose-create-pull-request.ts b/src/compose-create-pull-request.ts
@@ -31,7 +31,7 @@ export async function composeCreatePullRequest(
 
   // https://developer.github.com/v3/repos/#get-a-repository
   const { data: repository, headers } = await octokit.request(
-    "GET /repos/:owner/:repo",
+    "GET /repos/{owner}/{repo}",
     {
       owner,
       repo,
@@ -57,17 +57,18 @@ export async function composeCreatePullRequest(
     const user = await octokit.request("GET /user");
 
     // https://developer.github.com/v3/repos/forks/#list-forks
-    const forks = await octokit.request("GET /repos/:owner/:repo/forks", {
+    const forks = await octokit.request("GET /repos/{owner}/{repo}/forks", {
       owner,
       repo,
     });
     const hasFork = forks.data.find(
-      (fork) => fork.owner.login === user.data.login
+      /* istanbul ignore next - fork owner can be null, but we don't test that */
+      (fork) => fork.owner?.login === user.data.login
     );
 
     if (!hasFork) {
       // https://developer.github.com/v3/repos/forks/#create-a-fork
-      await octokit.request("POST /repos/:owner/:repo/forks", {
+      await octokit.request("POST /repos/{owner}/{repo}/forks", {
         owner,
         repo,
       });
@@ -79,7 +80,7 @@ export async function composeCreatePullRequest(
   // https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
   const {
     data: [latestCommit],
-  } = await octokit.request("GET /repos/:owner/:repo/commits", {
+  } = await octokit.request("GET /repos/{owner}/{repo}/commits", {
     owner,
     repo,
     sha: base,
@@ -118,15 +119,15 @@ export async function composeCreatePullRequest(
   }
 
   // https://developer.github.com/v3/git/refs/#create-a-reference
-  await octokit.request("POST /repos/:owner/:repo/git/refs", {
+  await octokit.request("POST /repos/{owner}/{repo}/git/refs", {
     owner: state.fork,
     repo,
     sha: state.latestCommitSha,
     ref: `refs/heads/${head}`,
   });
 
   // https://developer.github.com/v3/pulls/#create-a-pull-request
-  return await octokit.request("POST /repos/:owner/:repo/pulls", {
+  return await octokit.request("POST /repos/{owner}/{repo}/pulls", {
     owner,
     repo,
     head: `${state.fork}:${head}`,

diff --git a/src/create-commit.ts b/src/create-commit.ts
@@ -15,7 +15,7 @@ export async function createCommit(
 
   // https://developer.github.com/v3/git/commits/#create-a-commit
   const { data: latestCommit } = await octokit.request(
-    "POST /repos/:owner/:repo/git/commits",
+    "POST /repos/{owner}/{repo}/git/commits",
     {
       owner: fork,
       repo,

diff --git a/src/create-tree.ts b/src/create-tree.ts
@@ -30,7 +30,7 @@ export async function createTree(
           // so we only attempt to delete the file if it exists.
           try {
             // https://developer.github.com/v3/repos/contents/#get-contents
-            await octokit.request("HEAD /repos/:owner/:repo/contents/:path", {
+            await octokit.request("HEAD /repos/{owner}/{repo}/contents/:path", {
               owner: fork,
               repo,
               ref: latestCommitSha,
@@ -54,7 +54,7 @@ export async function createTree(
 
           try {
             const { data: file } = await octokit.request(
-              "GET /repos/:owner/:repo/contents/:path",
+              "GET /repos/{owner}/{repo}/contents/:path",
               {
                 owner: fork,
                 repo,
@@ -90,7 +90,7 @@ export async function createTree(
   // https://developer.github.com/v3/git/trees/#create-a-tree
   const {
     data: { sha: newTreeSha },
-  } = await octokit.request("POST /repos/:owner/:repo/git/trees", {
+  } = await octokit.request("POST /repos/{owner}/{repo}/git/trees", {
     owner: fork,
     repo,
     base_tree: latestCommitTreeSha,

diff --git a/src/types.ts b/src/types.ts
@@ -1,7 +1,7 @@
 import type { Octokit } from "@octokit/core";
 import type { Endpoints } from "@octokit/types";
 
-export type TreeParameter = Endpoints["POST /repos/:owner/:repo/git/trees"]["parameters"]["tree"];
+export type TreeParameter = Endpoints["POST /repos/{owner}/{repo}/git/trees"]["parameters"]["tree"];
 
 export type Options = {
   owner: string;

diff --git a/src/value-to-tree-object.ts b/src/value-to-tree-object.ts
@@ -19,11 +19,14 @@ export async function valueToTreeObject(
 
   // Binary files need to be created first using the git blob API,
   // then changed by referencing in the .sha key
-  const { data } = await octokit.request("POST /repos/:owner/:repo/git/blobs", {
-    owner,
-    repo,
-    ...value,
-  });
+  const { data } = await octokit.request(
+    "POST /repos/{owner}/{repo}/git/blobs",
+    {
+      owner,
+      repo,
+      ...value,
+    }
+  );
   const blobSha = data.sha;
   return {
     path,

diff --git a/test/fixtures/create-binary-file.json b/test/fixtures/create-binary-file.json
@@ -12,7 +12,7 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/:owner/:repo",
+      "url": "/repos/{owner}/{repo}",
       "owner": "gr2m",
       "repo": "pull-request-test"
     },
@@ -168,7 +168,7 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/:owner/:repo/commits",
+      "url": "/repos/{owner}/{repo}/commits",
       "owner": "gr2m",
       "repo": "pull-request-test",
       "sha": "latest",
@@ -302,7 +302,7 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/:owner/:repo/git/blobs",
+      "url": "/repos/{owner}/{repo}/git/blobs",
       "owner": "gr2m",
       "repo": "pull-request-test",
       "content": "R0lGODlhAQABAIAAAAUEBAAAACwAAAAAAQABAAACAkQBADs=",
@@ -357,7 +357,7 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/:owner/:repo/git/trees",
+      "url": "/repos/{owner}/{repo}/git/trees",
       "owner": "gr2m",
       "repo": "pull-request-test",
       "base_tree": "6919b5815d734549eb8071edf686da366c60ae72",
@@ -474,12 +474,14 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/:owner/:repo/git/commits",
+      "url": "/repos/{owner}/{repo}/git/commits",
       "owner": "gr2m",
       "repo": "pull-request-test",
       "message": "why",
       "tree": "d723044b9b085d768f1574e3c9ceec5a8d0116b8",
-      "parents": ["0b147e7357bff7bc8dc4c2dc7d0bbc4e39ae8137"]
+      "parents": [
+        "0b147e7357bff7bc8dc4c2dc7d0bbc4e39ae8137"
+      ]
     },
     "response": {
       "status": 201,
@@ -560,7 +562,7 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/:owner/:repo/git/refs",
+      "url": "/repos/{owner}/{repo}/git/refs",
       "owner": "gr2m",
       "repo": "pull-request-test",
       "sha": "d5b91a8da5645425762aab93c2f523c033702028",
@@ -621,7 +623,7 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/:owner/:repo/pulls",
+      "url": "/repos/{owner}/{repo}/pulls",
       "owner": "gr2m",
       "repo": "pull-request-test",
       "head": "gr2m:patch",

diff --git a/test/fixtures/create-fork.json b/test/fixtures/create-fork.json
@@ -24,7 +24,7 @@
           }
         }
       },
-      "url": "/repos/:owner/:repo",
+      "url": "/repos/{owner}/{repo}",
       "owner": "gr2m",
       "repo": "pull-request-test"
     },
@@ -288,12 +288,16 @@
             "type": "string"
           },
           "sort": {
-            "enum": ["newest", "oldest", "stargazers"],
+            "enum": [
+              "newest",
+              "oldest",
+              "stargazers"
+            ],
             "type": "string"
           }
         }
       },
-      "url": "/repos/:owner/:repo/forks",
+      "url": "/repos/{owner}/{repo}/forks",
       "owner": "gr2m",
       "repo": "pull-request-test"
     },
@@ -357,7 +361,7 @@
           }
         }
       },
-      "url": "/repos/:owner/:repo/forks",
+      "url": "/repos/{owner}/{repo}/forks",
       "owner": "gr2m",
       "repo": "pull-request-test"
     },
@@ -724,7 +728,7 @@
           }
         }
       },
-      "url": "/repos/:owner/:repo/commits",
+      "url": "/repos/{owner}/{repo}/commits",
       "owner": "gr2m",
       "repo": "pull-request-test",
       "sha": "main",
@@ -879,7 +883,13 @@
             "type": "string"
           },
           "tree[].mode": {
-            "enum": ["100644", "100755", "040000", "160000", "120000"],
+            "enum": [
+              "100644",
+              "100755",
+              "040000",
+              "160000",
+              "120000"
+            ],
             "type": "string"
           },
           "tree[].path": {
@@ -889,12 +899,16 @@
             "type": "string"
           },
           "tree[].type": {
-            "enum": ["blob", "tree", "commit"],
+            "enum": [
+              "blob",
+              "tree",
+              "commit"
+            ],
             "type": "string"
           }
         }
       },
-      "url": "/repos/:owner/:repo/git/trees",
+      "url": "/repos/{owner}/{repo}/git/trees",
       "owner": "hipstersmoothie",
       "repo": "pull-request-test",
       "base_tree": "fb00ef8a5edaf5cae464878939b413004407b9e4",
@@ -1029,12 +1043,14 @@
           }
         }
       },
-      "url": "/repos/:owner/:repo/git/commits",
+      "url": "/repos/{owner}/{repo}/git/commits",
       "owner": "hipstersmoothie",
       "repo": "pull-request-test",
       "message": "why",
       "tree": "57359ee9bd51c9222ba2d288a8ce676169c2cdcf",
-      "parents": ["3b6c2a2df60769aa026013f5bc1649cc004bd925"]
+      "parents": [
+        "3b6c2a2df60769aa026013f5bc1649cc004bd925"
+      ]
     },
     "response": {
       "status": 201,
@@ -1135,7 +1151,7 @@
           }
         }
       },
-      "url": "/repos/:owner/:repo/git/refs",
+      "url": "/repos/{owner}/{repo}/git/refs",
       "owner": "hipstersmoothie",
       "repo": "pull-request-test",
       "sha": "74cc7a7189bf22a4acbdef90724d44715d7c2bd4",
@@ -1229,7 +1245,7 @@
           }
         }
       },
-      "url": "/repos/:owner/:repo/pulls",
+      "url": "/repos/{owner}/{repo}/pulls",
       "owner": "gr2m",
       "repo": "pull-request-test",
       "head": "hipstersmoothie:test-branch-u7es0",

diff --git a/test/fixtures/create-when-empty.json b/test/fixtures/create-when-empty.json
@@ -12,7 +12,7 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/:owner/:repo",
+      "url": "/repos/{owner}/{repo}",
       "owner": "gr2m",
       "repo": "pull-request-test"
     },
@@ -168,7 +168,7 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/:owner/:repo/commits",
+      "url": "/repos/{owner}/{repo}/commits",
       "owner": "gr2m",
       "repo": "pull-request-test",
       "sha": "master",
@@ -302,7 +302,7 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/:owner/:repo/contents/:path",
+      "url": "/repos/{owner}/{repo}/contents/:path",
       "owner": "gr2m",
       "repo": "pull-request-test",
       "ref": "b6cc0485d5157e05292f1a9d274836553964eb21",
@@ -373,12 +373,14 @@
         "previews": []
       },
       "request": {},
-      "url": "/repos/:owner/:repo/git/commits",
+      "url": "/repos/{owner}/{repo}/git/commits",
       "owner": "gr2m",
       "repo": "pull-request-test",
       "message": "empty update",
       "tree": "8582bb07259f445f7124689763bd5a1c81012504",
-      "parents": ["b6cc0485d5157e05292f1a9d274836553964eb21"]
+      "parents": [
+        "b6cc0485d5157e05292f1a9d274836553964eb21"
+      ]
     },
     "response": {
       "status": 201,