feat: { createPullRequest } export. Default export is now deprecated (gr2m#34)

Author: gr2m

README.md

@@ -4,7 +4,6 @@
 
 [![@latest](https://img.shields.io/npm/v/octokit-plugin-create-pull-request.svg)](https://www.npmjs.com/package/octokit-plugin-create-pull-request)
 [![Build Status](https://travis-ci.com/gr2m/octokit-plugin-create-pull-request.svg?branch=master)](https://travis-ci.com/gr2m/octokit-plugin-create-pull-request)
-[![Greenkeeper](https://badges.greenkeeper.io/gr2m/octokit-plugin-create-pull-request.svg)](https://greenkeeper.io/)
 
 Features
 
@@ -16,12 +15,9 @@ Features
 
 ## Usage
 
-Update or create two files with a single commit
-
 ```js
 const { Octokit } = require("@octokit/core");
-const createPullRequest = require("octokit-plugin-create-pull-request");
-
+const { createPullRequest } = require("octokit-plugin-create-pull-request");
 const MyOctokit = Octokit.plugin(createPullRequest);
 
 const TOKEN = "secret123"; // token needs "repo" scope

index.js

@@ -1,7 +1,16 @@
-module.exports = octokitCreatePullRequest
+module.exports = deprecatedCreatePullRequest;
 
-const createPullRequest = require('./lib/create-pull-request')
+const octokitCreatePullRequest = require("./lib/create-pull-request");
 
-function octokitCreatePullRequest (octokit) {
-  octokit.createPullRequest = createPullRequest.bind(null, octokit)
+function deprecatedCreatePullRequest(octokit) {
+  octokit.log.warn(
+    "[octokit-plugin-create-pull-request] Default export is deprecated. Use 'const { createPullRequest} = require('octokit-plugin-create-pull-request')` instead"
+  );
+  octokit.createPullRequest = octokitCreatePullRequest.bind(null, octokit);
 }
+
+function createPullRequest(octokit) {
+  octokit.createPullRequest = octokitCreatePullRequest.bind(null, octokit);
+}
+
+deprecatedCreatePullRequest.createPullRequest = createPullRequest;

test/create-binary-file-test.js

@@ -2,7 +2,7 @@ const { test } = require("tap");
 const { RequestError } = require("@octokit/request-error");
 
 const { Octokit: Core } = require("@octokit/core");
-const createPullRequest = require("..");
+const { createPullRequest } = require("..");
 const Octokit = Core.plugin(createPullRequest);
 
 test("happy path", async (t) => {

test/create-fork-test.js

@@ -1,7 +1,7 @@
 const { test } = require("tap");
 
 const { Octokit: Core } = require("@octokit/core");
-const createPullRequest = require("..");
+const { createPullRequest } = require("..");
 const Octokit = Core.plugin(createPullRequest);
 
 test("create fork", async (t) => {

test/delete-files-test.js

@@ -2,7 +2,7 @@ const { test } = require("tap");
 const { RequestError } = require("@octokit/request-error");
 
 const { Octokit: Core } = require("@octokit/core");
-const createPullRequest = require("..");
+const { createPullRequest } = require("..");
 const Octokit = Core.plugin(createPullRequest);
 
 test("happy path", async (t) => {

test/happy-path-test.js

@@ -1,6 +1,7 @@
 const { test } = require("tap");
 
 const { Octokit: Core } = require("@octokit/core");
+// intentionally test deprecated default export
 const createPullRequest = require("..");
 const Octokit = Core.plugin(createPullRequest);
 

test/missing-authentication-test.js

@@ -1,7 +1,7 @@
 const { test } = require("tap");
 
 const { Octokit: Core } = require("@octokit/core");
-const createPullRequest = require("..");
+const { createPullRequest } = require("..");
 const Octokit = Core.plugin(createPullRequest);
 
 test("invalid auth", async (t) => {

test/use-custom-base-test.js

@@ -1,7 +1,7 @@
 const { test } = require("tap");
 
 const { Octokit: Core } = require("@octokit/core");
-const createPullRequest = require("..");
+const { createPullRequest } = require("..");
 const Octokit = Core.plugin(createPullRequest);
 
 test("use custom base", async (t) => {

test/use-fork-test.js

@@ -1,7 +1,7 @@
 const { test } = require("tap");
 
 const { Octokit: Core } = require("@octokit/core");
-const createPullRequest = require("..");
+const { createPullRequest } = require("..");
 const Octokit = Core.plugin(createPullRequest);
 
 test("create fork", async (t) => {