refactor: remove lib/ folder (#127)

* 📦 refactor(index.js): move index.js from lib/ to src/ * 📦 refactor(webhook-names): move webhook-names.json from lib/ to src/ * 📦 refactor(scripts-folder): move scripts folder outside src/ (we don't want to expose it when publi * 💎 style(path): fix redundant required path * 📖 docs(README): update import paths for event-handler, middleware, sign, verify on READMEs
octokit · Apr 28, 2020 · 1804f39 · 1804f39
1 parent 7054d1a
commit 1804f39
Show file tree

Hide file tree

Showing 16 changed files with 25 additions and 33 deletions.
diff --git a/lib/index.js b/lib/index.js
diff --git a/src/scripts/generate-types.js → scripts/generate-types.js b/src/scripts/generate-types.js → scripts/generate-types.js
diff --git a/src/scripts/update-known-events.js → scripts/update-known-events.js b/src/scripts/update-known-events.js → scripts/update-known-events.js
@@ -4,7 +4,7 @@ const Table = require("table-builder");
 
 const WEBOOOKS = require("@octokit/webhooks-definitions");
 
-// update lib/webhook-names.json
+// update src/webhook-names.json
 const newWebhookNames = WEBOOOKS.reduce(
   (list, event) => {
     list.push(
@@ -16,7 +16,7 @@ const newWebhookNames = WEBOOOKS.reduce(
   ["*", "error"]
 ).sort();
 writeFileSync(
-  "lib/webhook-names.json",
+  "src/webhook-names.json",
   JSON.stringify([...newWebhookNames], null, 2) + "\n"
 );
 

diff --git a/src/event-handler/README.md b/src/event-handler/README.md
@@ -5,8 +5,8 @@ If you implement the route to receive webhook events from GitHub yourself then y
 ## Example
 
 ```js
-const EventHandler = require('@octokit/webhooks/event-handler')
-const eventHandler = new EventHandler({
+const { createEventHandler } = require('@octokit/webhooks')
+const eventHandler = createEventHandler({
   async transform (event) {
     // optionally transform passed event before handlers are called
     return event
@@ -27,7 +27,7 @@ eventHandler.receive({
 If you receive events through a publicly accessible URL, make sure to verify that the event request is coming from GitHub:
 
 ```js
-const verify = require('@octokit/webhooks/verify')
+const { verify } = require('@octokit/webhooks')
 const secret = 'mysecret'
 
 if (!verify(secret, request.payload, request.headers['x-hub-signature'])) {

diff --git a/src/event-handler/on.js b/src/event-handler/on.js
@@ -1,6 +1,6 @@
 module.exports = receiverOn;
 
-const webhookNames = require("../../lib/webhook-names.json");
+const webhookNames = require("../webhook-names.json");
 
 function receiverOn(state, webhookNameOrNames, handler) {
   if (Array.isArray(webhookNameOrNames)) {

diff --git a/src/index.js b/src/index.js
@@ -7,6 +7,7 @@ module.exports = deprecate(
 
 const { createEventHandler } = require("./event-handler");
 const middleware = require("./middleware/middleware");
+const { createMiddleware } = require("./middleware");
 const { sign } = require("./sign");
 const { verify } = require("./verify");
 const verifyAndReceive = require("./middleware/verify-and-receive");
@@ -33,4 +34,8 @@ function createWebhooksApi(options) {
   };
 }
 
+module.exports.createEventHandler = createEventHandler;
+module.exports.createMiddleware = createMiddleware;
 module.exports.createWebhooksApi = createWebhooksApi;
+module.exports.sign = sign;
+module.exports.verify = verify;
diff --git a/src/middleware/README.md b/src/middleware/README.md
@@ -3,8 +3,8 @@
 If you only need the middleware with access to the `.sign()`, `.verify()` or the receiver’s `.receive()` method, you can use the webhooks middleware directly
 
 ```js
-const Middleware = require('@octokit/webhooks/middleware')
-const middleware = new Middleware({
+const { createMiddleware } = require('@octokit/webhooks')
+const middleware = createMiddleware({
   secret: 'mysecret',
   path: '/github-webhooks'
 })

diff --git a/src/sign/README.md b/src/sign/README.md
@@ -3,7 +3,7 @@
 The `sign` method can be used as a standalone method.
 
 ```js
-const sign = require('@octokit/webhooks/sign')
+const { sign } = require('@octokit/webhooks')
 const signature = sign(secret, eventPayload)
 // string like "sha1=d03207e4b030cf234e3447bac4d93add4c6643d8"
 ```

diff --git a/src/verify/README.md b/src/verify/README.md
@@ -3,7 +3,7 @@
 The `verify` method can be used as a standalone method.
 
 ```js
-const verify = require('@octokit/webhooks/verify')
+const { verify } = require('@octokit/webhooks')
 const matchesSignature = verify(secret, eventData, signature)
 // true or false
 ```

diff --git a/lib/webhook-names.json → src/webhook-names.json b/lib/webhook-names.json → src/webhook-names.json
diff --git a/test/integration/event-handler-test.js b/test/integration/event-handler-test.js
@@ -1,6 +1,6 @@
 const test = require("tap").test;
 
-const { createEventHandler } = require("../../lib");
+const { createEventHandler } = require("../../src");
 const pushEventPayload = require("../fixtures/push-payload");
 const installationCreatedPayload = require("../fixtures/installation-created-payload");
 

diff --git a/test/integration/middleware-test.js b/test/integration/middleware-test.js
@@ -4,7 +4,7 @@ const Buffer = require("buffer").Buffer;
 const test = require("tap").test;
 const simple = require("simple-mock");
 
-const { createMiddleware } = require("../../lib");
+const { createMiddleware } = require("../../src");
 
 const headers = {
   "x-github-delivery": "123e4567-e89b-12d3-a456-426655440000",

diff --git a/test/integration/sign-test.js b/test/integration/sign-test.js
@@ -1,6 +1,6 @@
 const test = require("tap").test;
 
-const { sign } = require("../../lib");
+const { sign } = require("../../src");
 
 const eventPayload = {
   foo: "bar",

diff --git a/test/integration/smoke-test.js b/test/integration/smoke-test.js
@@ -3,7 +3,7 @@ const { mock } = require("simple-mock");
 
 test("@octokit/webhooks", (t) => {
   const emitWarningMock = mock(process, "emitWarning");
-  const { createWebhooksApi } = require("../../lib");
+  const { createWebhooksApi } = require("../../src");
   const api = createWebhooksApi({ secret: "mysecret" });
 
   t.type(api.sign, "function");
@@ -22,7 +22,7 @@ test('require("@octokit/webhooks").sign', (t) => {
   const emitWarningMock = mock(process, "emitWarning");
 
   t.doesNotThrow(() => {
-    const { sign } = require("../../lib");
+    const { sign } = require("../../src");
     sign("1234", {});
   });
   t.false(emitWarningMock.called);
@@ -34,7 +34,7 @@ test('require("@octokit/webhooks").verify', (t) => {
   const emitWarningMock = mock(process, "emitWarning");
 
   t.doesNotThrow(() => {
-    const { verify } = require("../../lib");
+    const { verify } = require("../../src");
     verify("1234", {}, "randomSignature");
   });
   t.false(emitWarningMock.called);
@@ -46,7 +46,7 @@ test('require("@octokit/webhooks").createEventHandler', (t) => {
   const emitWarningMock = mock(process, "emitWarning");
 
   t.doesNotThrow(() => {
-    const { createEventHandler } = require("../../lib");
+    const { createEventHandler } = require("../../src");
     createEventHandler();
   });
   t.false(emitWarningMock.called);
@@ -58,7 +58,7 @@ test('require("@octokit/webhooks).createMiddleware")', (t) => {
   const emitWarningMock = mock(process, "emitWarning");
 
   t.doesNotThrow(() => {
-    const { createMiddleware } = require("../../lib");
+    const { createMiddleware } = require("../../src");
     createMiddleware({ secret: "1234" });
   });
   t.false(emitWarningMock.called);

diff --git a/test/integration/verify-test.js b/test/integration/verify-test.js
@@ -1,6 +1,6 @@
 const test = require("tap").test;
 
-const { verify } = require("../../lib");
+const { verify } = require("../../src");
 
 const eventPayload = {
   foo: "bar",

diff --git a/test/unit/middleware-constructor-test.js b/test/unit/middleware-constructor-test.js
@@ -1,6 +1,6 @@
 const test = require("tap").test;
 
-const { createMiddleware } = require("../../lib");
+const { createMiddleware } = require("../../src");
 
 test("options: none", (t) => {
   t.throws(createMiddleware);