feat: update files (#39)

README.md

@@ -84,8 +84,6 @@ https://github.com/settings/tokens/new?scopes=repo
 
 ## Todos
 
-- **Editing files** based on current content  
-  Add support to pass a function as file content, the function will be called with the current file content, if present.
 - **Multiple commits**  
   Split up changes among multiple edits
 

src/create-pull-request.ts

@@ -15,7 +15,7 @@ type Options = {
 
 type Changes = {
   files: {
-    [path: string]: string | File;
+    [path: string]: string | File | UpdateFunction;
   };
   commit: string;
 };
@@ -26,6 +26,14 @@ type File = {
   encoding: "utf-8" | "base64";
 };
 
+type UpdateFunctionFile = {
+  size: number;
+  encoding: "base64";
+  content: string;
+};
+
+type UpdateFunction = (file: UpdateFunctionFile) => string | File;
+
 export async function octokitCreatePullRequest(
   octokit: Octokit,
   { owner, repo, title, body, base, head, changes }: Options
@@ -113,31 +121,24 @@ export async function octokitCreatePullRequest(
           }
         }
 
-        // Text files can be changed through the .content key
-        if (typeof value === "string") {
-          return {
-            path,
-            mode: "100644",
-            content: value,
-          };
+        // When passed a function, retrieve the content of the file, pass it
+        // to the function, then return the result
+        if (typeof value === "function") {
+          const { data: file } = await octokit.request(
+            "GET /repos/:owner/:repo/contents/:path",
+            {
+              owner: fork,
+              repo,
+              ref: firstCommit.sha,
+              path,
+            }
+          );
+
+          const result = await value(file as UpdateFunctionFile);
+          return valueToTreeObject(octokit, owner, repo, path, result);
         }
 
-        // 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 blobSha = data.sha;
-        return {
-          path,
-          mode: "100644",
-          sha: blobSha,
-        };
+        return valueToTreeObject(octokit, owner, repo, path, value);
       })
     )
   ).filter(Boolean) as TreeParameter;
@@ -181,3 +182,34 @@ export async function octokitCreatePullRequest(
     body,
   });
 }
+
+async function valueToTreeObject(
+  octokit: Octokit,
+  owner: string,
+  repo: string,
+  path: string,
+  value: string | File
+) {
+  // Text files can be changed through the .content key
+  if (typeof value === "string") {
+    return {
+      path,
+      mode: "100644",
+      content: value,
+    };
+  }
+
+  // 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 blobSha = data.sha;
+  return {
+    path,
+    mode: "100644",
+    sha: blobSha,
+  };
+}

test/create-binary-file.test.ts

@@ -4,7 +4,7 @@ import { RequestError } from "@octokit/request-error";
 import { createPullRequest } from "../src";
 const Octokit = Core.plugin(createPullRequest);
 
-test("happy path", async () => {
+test("create binary file", async () => {
   const fixtures = require("./fixtures/create-binary-file");
   const fixturePr = fixtures[fixtures.length - 1].response;
   const octokit = new Octokit();

test/delete-files.test.ts

@@ -4,7 +4,7 @@ import { RequestError } from "@octokit/request-error";
 import { createPullRequest } from "../src";
 const Octokit = Core.plugin(createPullRequest);
 
-test("happy path", async () => {
+test("delete files", async () => {
   const fixtures = require("./fixtures/delete-files");
   const fixturePr = fixtures[fixtures.length - 1].response;
   const octokit = new Octokit();