Rework interface to be more consistent with Octokit. Add tests

Author: mheap

README.md

@@ -10,11 +10,11 @@ npm install octokit-commit-multiple-files --save
 
 ## Usage
 
-This plugin accepts `owner`, `repo`, `path`, `branch` and `message` like `createOrUpdateFile`.
+This plugin accepts `owner`, `repo`, `path`, `branch` and `message` like `.createOrUpdateFile` ([Octokit Docs](https://octokit.github.io/rest.js/#octokit-routes-repos-create-or-update-file)).
 
-In addition, it accepts `changes` which is an array of objects containing a `path` and the file `contents`.
+If the `branch` provided does not exist, the plugin will error. To automatically create it, set `createBranch` to true. You may provide a `base` branch if you choose to do this, or the plugin will use the repo's default branch as the base.
 
-It also accepts a `newBranch` parameter which will commit these changes to a different branch than the one provided. You can set `overwriteBranch` to `true` to use `branch` as the base commit, or `false` to use the latest commit on `newBranch` as the base commit.
+In addition, it accepts `changes` which is an array of objects containing a `path` and the file `contents`.
 
 ```javascript
 const Octokit = require("@octokit/rest").plugin(
@@ -25,8 +25,8 @@ const octokit = new Octokit();
 const branchName = await octokit.repos.createOrUpdateFiles({
   owner,
   repo,
-  path,
   branch,
+  createBranch,
   message,
   changes: [
     {

create-or-update-files.js

@@ -16,40 +16,43 @@ module.exports = function(octokit, opts) {
       let {
         owner,
         repo,
-        newBranch,
+        base,
         branch: branchName,
-        overwriteBranch,
+        createBranch,
         changes,
         message
       } = opts;
 
-      if (overwriteBranch && !newBranch) {
-        return reject(
-          "You can only overwrite a branch if you provide a 'newBranch'"
-        );
-      }
-
       let branchAlreadyExists = true;
-      let targetBranch = branchName;
       let baseTree;
 
       // Does the target branch already exist?
-      if (newBranch) {
-        baseTree = await loadRef(octokit, owner, repo, newBranch);
-        targetBranch = newBranch;
-        if (!baseTree) {
-          branchAlreadyExists = false;
+      baseTree = await loadRef(octokit, owner, repo, branchName);
+      if (!baseTree) {
+        if (!createBranch) {
+          return reject(
+            `The branch '${branchName}' doesn't exist and createBranch is 'false'`
+          );
         }
-      }
 
-      // If it doesn't exist, or we want to replace the branch then
-      // we grab the base sha from our target branch
-      if (overwriteBranch || !baseTree) {
-        baseTree = await loadRef(octokit, owner, repo, branchName);
+        branchAlreadyExists = false;
+
+        // If not we use the base branch. If not provided, use the
+        // default from the repo
+        if (!base) {
+          // Work out the default branch
+          base = (
+            await octokit.repos.get({
+              owner,
+              repo
+            })
+          ).data.default_branch;
+        }
+
+        baseTree = await loadRef(octokit, owner, repo, base);
+
         if (!baseTree) {
-          return reject(
-            `Unable to load branch. '${branchName}' does not exist`
-          );
+          return reject(`The branch '${base}' doesn't exist`);
         }
       }
 
@@ -124,14 +127,14 @@ module.exports = function(octokit, opts) {
           owner,
           repo,
           force: true,
-          ref: `${updateRefBase}heads/${targetBranch}`,
+          ref: `${updateRefBase}heads/${branchName}`,
           sha: commit.sha
         })
       ).data;
 
       // Return the new branch name so that we can use it later
       // e.g. to create a pull request
-      return resolve(targetBranch);
+      return resolve(branchName);
     } catch (e) {
       return reject(e);
     }
@@ -147,5 +150,7 @@ async function loadRef(octokit, owner, repo, ref) {
         ref: `heads/${ref}`
       })
     ).data.object.sha;
-  } catch (e) {}
+  } catch (e) {
+    //console.log(e);
+  }
 }