Added the ability to exclude frontend reload script injection via glob patterns at the server configuration level.

* Added minimatch as a dependency
* Added new tests to test reload excludeRoutes
* Added default excludeRoutes as empty array

Author: alallier

README.md

@@ -372,10 +372,13 @@ Resolves to:
     {
       "enable": true,
       "port": 9856,
-      "httpsPort": 9857
+      "httpsPort": 9857,
+      "excludeRoutes": []
     }
     ```
 
+  - `excludeRoutes`: Reload auto script injection happens on all HTML routes by default unless specified in `excludeRoutes`. An array of valid glob patterns is accepted
+
 - `htmlValidator`: Parameters to send to [express-html-validator](https://github.com/rooseveltframework/express-html-validator#configuration). This feature is only available in development mode.
 
   - `enable`: *[Boolean]* Enables or disables the built-in HTML validator.

lib/defaults/config.json

@@ -42,7 +42,8 @@
     "enable": true,
     "port": 9856,
     "httpsPort": 9857,
-    "verbose": false
+    "verbose": false,
+    "excludeRoutes": []
   },
   "cores": 1,
   "shutdownTimeout": 30000,

lib/injectReload.js

@@ -1,11 +1,15 @@
 // Injects <script> tag containing "reload.js"
+
+const minimatch = require('minimatch')
+
 module.exports = function (app) {
   const reloadParams = app.get('params').frontendReload
 
   // check that Reload is enabled and app is running in development mode
   if (app.get('env') === 'development' && reloadParams.enable) {
     app.use(require('tamper')((req, res) => {
-      if (res.getHeader('Content-Type') && res.getHeader('Content-Type').includes('text/html')) {
+      // Check to make sure requested URL isn't the exclude routes configured and if type HTML append the reload frontend script
+      if (!matchUrlPatterns(req.url, reloadParams.excludeRoutes) && res.getHeader('Content-Type') && res.getHeader('Content-Type').includes('text/html')) {
         return (body) => {
           const pos = body.lastIndexOf('</body>')
           body = body.substring(0, pos) + `<!-- Injected by Roosevelt for frontend reload functionality -->\n<script src='/reload${getProtocol(req.protocol)}/reload.js'></script>\n</body>` + body.substring(pos + 7)
@@ -19,4 +23,8 @@ module.exports = function (app) {
   function getProtocol (protocol) {
     return protocol.charAt(0).toUpperCase() + protocol.slice(1)
   }
+
+  function matchUrlPatterns (url, patterns) {
+    return patterns.some(pattern => minimatch(url, pattern))
+  }
 }

lib/sourceParams.js

@@ -195,6 +195,9 @@ module.exports = (params, app, appSchema) => {
       },
       verbose: {
         default: defaults.frontendReload.verbose
+      },
+      excludeRoutes: {
+        default: defaults.frontendReload.excludeRoutes
       }
     },
     cores: {