Add excluded option

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 *.tgz
+yarn.lock

README.md

@@ -17,9 +17,12 @@ See [examples](examples/) for examples
 
 The following options are available:
 
-* `showAuth`: Shows any hapi authentication scheme using _server.auth.strategy_. Default: false
-* `showScope`: Shows route access rules using _route.options.auth.access.scope_. Default: false
-* `showStart`: Shows route information during startup of server. Default: true
+Option | Type | Description | Defaut
+-|:-:|:-:|-
+`showAuth` | boolean | Shows any hapi authentication scheme using _server.auth.strategy_ | `false`
+`showScope` | boolean | Shows route access rules using _route.options.auth.access.scope_ | `false`
+`showStart` | boolean | Shows route information during startup of server | `true`
+`excluded` | array | Doesn't show specified routes. Routes should be a `string` type. Example, [`'/doc'`, `'/swagger'`] | `[ ]`
 
 
 The module also registers the _'info()'_  and _'text()'_ API methods:

lib/index.js

@@ -13,7 +13,8 @@ const internals = {
     schema: {
         showAuth: Joi.boolean().default(false),
         showScope: Joi.boolean().default(false),
-        showStart: Joi.boolean().default(true)
+        showStart: Joi.boolean().default(true),
+        excluded: Joi.array().items(Joi.string().regex(/\/[a-zA-Z0-9.-]*/)).default([])
     }
 };
 
@@ -70,6 +71,10 @@ internals.printableRoutes = function (routes, options) {
 
     routes.forEach((show) => {
 
+        if (options.excluded.includes(show.path)){
+            return;
+        }
+
         const row = {
             method: internals.formatMethod(show.method),
             path: internals.formatPath(show.path),

test/index.js

@@ -282,6 +282,24 @@ describe('routes', () => {
         expect(text).to.match(/findme.*api routes/);
     });
 
+    it('excluded routes should be shown', async () => {
+
+        const blippOptions = {
+            excluded: [
+                '/api',
+                '/hi'
+            ]
+        };
+
+        const server = await internals.prepareServer({ blippOptions });
+
+        const info = server.plugins[Pkg.name].info();
+        delete info[0].uri;
+        const text = server.plugins[Pkg.name].text();
+        expect(text).to.not.match(/\/api/);
+        expect(text).to.not.match(/\/hi/);
+    });
+
     it('fails with invalid options', async () => {
 
         try {