weo-edu · Nov 19, 2018 · Nov 19, 2018 · Nov 19, 2018 · Dec 12, 2019 · Dec 12, 2019
Showing with 9,594 additions and 41 deletions.

+65 −0 .github/pull_request_template.md

+13 −0 .github/workflows/ci.yml

+1 −0 .nvmrc

+10 −0 CHANGELOG.md

+9 −9 README.md

+6 −11 index.js

+9,434 −0 package-lock.json

+36 −12 package.json

+20 −9 test/index.js
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,65 @@
+<!-- Author/Reviewer expectations are described in the last comment -->
+
+> **Note** - Since this is a public repository, make sure that we're not publishing private data in the code, commit comments, or this PR.
+
+## 📚 Context/Description Behind The Change
+<!--
+  What changes have you made to the code, and why?
+
+  As skilled engineers, we all know how to read and interpret code, so take this opportunity
+  to be a bit more verbal about your changes.
+
+  Giving the context behind your changes will make your PR review quicker,
+  as the reviewer will not need to guess your intent.
+-->
+
+## 🚨 Potential Risks & What To Monitor After Deployment
+<!--
+  What can go wrong with this deploy?
+  Does it touch any critical services?
+  How will these changes affect adjacent code/features?
+  How will we handle any adverse issues?
+-->
+
+## 🧑‍🔬 How Has This Been Tested?
+<!--
+  Imagine: How do I (and the Reviewer):
+  How do we know this PR does what it's supposed to do?
+  How do we ensure that adjacent code/features are still working?
+  How do we evaluate the performance implications of this PR?
+-->
+
+## 🚚 Release Plan
+<!--
+  Imagine: If you had to leave in a rush, what should the backup engineer do to deploy this?
+
+  Add any tasks that need to be done before/during/after release (i.e, creating indices, deploying
+  other services, bumping modules, notifying PM or other engineers, etc).
+-->
+
+
+
+<!--
+  ## 🤝 Expectations
+
+  When Opening/Reviewing a PR, please keep in mind:
+
+  ### As the PR Author
+  - Provide all the necessary context on "Why" you have performed your changes
+  - Assume that the reviewer has no previous knowledge about the codebase: would he/she be able to
+    review it the way it is right now?
+  - If changes are extensive, break them into smaller commits that tell a story, instead of 1 commit
+    with 15 files changed.
+  - Split Refactors and New-Code-Changes into different commits, ideally: different PRs.
+  - Test your code before requesting review — unless some rare exceptions, we shouldn't ship any code
+    without testing it before.
+  - If your PR is UI related, consider adding screenshots/videos with the behavior and before/after.
+
+  ### As the PR Reviewer
+  - Be kind. Don't nitpick.
+  - Expect to have all the necessary context to review the PR on (or linked on) the PR itself.
+  - When in doubt: ask.
+  - Validate if the author's tests have any missing coverage points. Do not approve an untested PR.
+  - Pay extra attention to the "Potential Risks" and "Release Plan" sections.
+  - If the PR alters the product UI, consider checking out the branch to visually inspect it.
+-->
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,13 @@
+name: continuous-integration
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  checks:
+    uses: mixmaxhq/github-workflows-public/.github/workflows/checks.yml@main
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+12.22.6
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,10 @@
+## [1.0.0](https://github.com/mixmaxhq/express-robots/compare/v0.1.6...v1.0.0) (2019-12-12)
+
+
+### ⚠ BREAKING CHANGES
+
+* The main export now returns an express router instead of an express application.
+
+### Bug Fixes
+
+* use express router instead of application ([b07fa43](https://github.com/mixmaxhq/express-robots/commit/b07fa43d31f553dd6b1fbcd9b7f6f372cf5515d7))
diff --git a/README.md b/README.md
@@ -13,25 +13,25 @@ app.use(robots(__dirname + '/robots.txt'));
 ### Basic object
 
 ```javascript
-app.use(robots({UserAgent: '*', Disallow: '/'}))
+app.use(robots({ UserAgent: '*', Disallow: '/' }))
 ```
 
 #### Will produce:
 ```
-UserAgent: *
+User-agent: *
 Disallow: /
 ```
 
 ### Crawl Delay
 You can optionally pass a CrawlDelay in just like passing in Disallow
 
 ```javascript
-app.use(robots({UserAgent: '*', Disallow: '/', CrawlDelay: '5'}))
+app.use(robots({ UserAgent: '*', Disallow: '/', CrawlDelay: '5' }))
 ```
 
 #### Will produce:
 ```
-UserAgent: *
+User-agent: *
 Disallow: /
 Crawl-delay: 5
 ```
@@ -53,9 +53,9 @@ app.use(robots([
 
 #### Will produce:
 ```
-UserAgent: Googlebot
+User-agent: Googlebot
 Disallow: /no-google
-UserAgent: Bingbot
+User-agent: Bingbot
 Disallow: /no-bing
 ```
 
@@ -76,11 +76,11 @@ app.use(robots([
 
 #### Will produce:
 ```
-UserAgent: Googlebot
-UserAgent: Slurp
+User-agent: Googlebot
+User-agent: Slurp
 Disallow: /no-google
 Disallow: /no-yahoo
-UserAgent: *
+User-agent: *
 Disallow: /no-bots
 Disallow: /still-no-bots
 ```
diff --git a/index.js b/index.js
@@ -1,14 +1,9 @@
-var fs = require('fs');
-var asArray = require('as-array');
+const fs = require('fs');
 
-if (!Array.isArray) {
-  Array.isArray = function(arg) {
-    return Object.prototype.toString.call(arg) === '[object Array]';
-  };
-}
+const asArray = (value = []) => Array.isArray(value) ? value : [value];
 
-module.exports = function(robots) {
-  var app = require('express')();
+module.exports = function(robots, {express = require('express')} = {}) {
+  const app = express.Router();
 
   if(robots) {
     robots = 'string' === typeof robots
@@ -27,7 +22,7 @@ module.exports = function(robots) {
 
 function render(robots) {
   return asArray(robots).map(function(robot) {
-    var userAgentArray = [];
+    let userAgentArray = [];
     if (Array.isArray(robot.UserAgent)) {
       userAgentArray = robot.UserAgent.map(function(userAgent) {
         return 'User-agent: ' + userAgent
@@ -47,4 +42,4 @@ function render(robots) {
       return 'Disallow: ' + disallow;
     })).join('\n');
   }).join('\n');
-}
+}