Add optional config with custom filter option and standard js linting (#3)

* conform to standard js linting rules

* add yarn lock file

* ignore .DS_Store files

* add route filter config item

Author: billymoon

.gitignore

@@ -2,6 +2,7 @@
 logs
 *.log
 npm-debug.log*
+.DS_Store
 
 # Coverage directory used by tools like istanbul
 coverage

README.md

@@ -2,6 +2,7 @@
 Use the FS as your micro router
 [![Build Status](https://travis-ci.org/jesseditson/fs-router.svg?branch=master)](https://travis-ci.org/jesseditson/fs-router)
 [![Coverage Status](https://coveralls.io/repos/github/jesseditson/fs-router/badge.svg?branch=master)](https://coveralls.io/github/jesseditson/fs-router?branch=master)
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
 ### "features"
 
@@ -121,3 +122,40 @@ module.exports.GET = async function(req, res) {
 // This works for deep paths (/thing/index.js maps to /thing and /thing/index)
 // and even for params (/thing/:param/index.js maps to /thing/* and /thing/*/index).
 ```
+
+**filter routes**
+```javascript
+// index.js
+const { send } = require('micro')
+
+// set up config to filter only paths including `foo`
+const config = {filter: f => f.indexOf('foo') !== -1}
+
+// pass config to `fs-router` as optional second paramater
+let match = require('fs-router')(__dirname + '/routes', config)
+
+module.exports = async function(req, res) {
+  let matched = match(req)
+  if (matched) return await matched(req, res)
+  send(res, 404, { error: 'Not found' })
+}
+```
+
+The above usage assumes you have a folder called `routes` next to the `index.js` file, that looks something like this:
+```
+routes/
+├── foo
+│   ├── index.js
+│   └── thing.js
+└── bar
+    ├── index.js
+    ├── foo.js
+    └── thing.js
+```
+
+the above tree would generate the following routes:
+```
+/foo
+/foo/thing
+/bar/foo
+```

index.js

@@ -2,21 +2,21 @@ const path = require('path')
 const fs = require('fs')
 const qs = require('querystring')
 
-const paramPattern = /:([^\/]+)/
+const paramPattern = /:([^/]+)/
 // takes routes and decorates them with a 'match' method that will return { params, query } if a path matches
-function addMatch(route) {
+function addMatch (route) {
   let routePath = route.path
   let paramNames = []
   let matched
   // find any paths prefixed with a `:`, and treat them as capture groups
-  while (matched = routePath.match(paramPattern)) {
-    routePath = routePath.replace(paramPattern, '([^\?\/]+)')
+  while ((matched = routePath.match(paramPattern)) !== null) {
+    routePath = routePath.replace(paramPattern, '([^?/]+)')
     paramNames.push(matched[1])
   }
   // if a route ends with `index`, allow matching that route without matching the `index` part
   if (path.basename(routePath) === 'index') {
     route.isIndex = true
-    routePath = routePath.replace(/\/index$/, '\/?(:?index)?')
+    routePath = routePath.replace(/\/index$/, '/?(:?index)?')
   }
   // create a regex with our path
   let pattern = new RegExp(`^${routePath}(\\?(.*)|$)`, 'i')
@@ -36,7 +36,7 @@ function addMatch(route) {
 }
 
 // recursively searches for all js files inside a directory tree, and returns their full paths
-function findRoutes(dir) {
+function findRoutes (dir) {
   let files = fs.readdirSync(dir)
   let resolve = f => path.join(dir, f)
   let routes = files.filter(f => path.extname(f) === '.js').map(resolve)
@@ -45,8 +45,10 @@ function findRoutes(dir) {
 }
 
 const val = v => (typeof v === 'undefined' ? 0 : v)
-module.exports = function router(routesDir) {
+module.exports = function router (routesDir, config) {
   const routes = findRoutes(routesDir)
+    // if filter function is set, filter routes
+    .filter(config && config.filter || function () { return true })
     // require route files, then add a 'path' property to them
     // the path is in the form of '/path/file', relative to routesDir
     .map(routeFile => {
@@ -68,7 +70,7 @@ module.exports = function router(routesDir) {
     .sort((a, b) => val(a.priority) < val(b.priority) ? 1 : -1)
 
   // generated match method - call with a req object to get a route.
-  return function match(req) {
+  return function match (req) {
     let routeFn = r => r[req.method] || (typeof r === 'function' && r)
     let found = routes.find(r => {
       let matched = r.match(req.url)

test/custom-filter-test.js

@@ -0,0 +1,34 @@
+const path = require('path')
+const test = require('tape')
+const router = require('..')
+
+// set up config to filter only paths ending `index.js`
+const config = {filter: f => /(?:^|\/)index.js$/.test(f)}
+
+let match = router(path.join(__dirname, '/fixtures/filter'), config)
+
+test('include non-filtered root path', t => {
+  t.plan(2)
+  let req = { url: '/', method: 'GET' }
+  t.equal(typeof match(req), 'function', 'returns the route function')
+  t.equal(match(req)(), 'index', 'route function is callable')
+})
+
+test('include non-filtered nested path', t => {
+  t.plan(2)
+  let req = { url: '/thing', method: 'GET' }
+  t.equal(typeof match(req), 'function', 'returns the route function')
+  t.equal(match(req)(), 'thing', 'route function is callable')
+})
+
+test('exclude filtered root path', t => {
+  t.plan(1)
+  let req = { url: '/other', method: 'GET' }
+  t.equal(typeof match(req), 'undefined', 'excludes filtered paths')
+})
+
+test('exclude filtered nested path', t => {
+  t.plan(1)
+  let req = { url: '/thing/other', method: 'GET' }
+  t.equal(typeof match(req), 'undefined', 'excludes filtered paths')
+})

test/custom-path-test.js

@@ -1,7 +1,8 @@
+const path = require('path')
 const test = require('tape')
 const router = require('..')
 
-let match = router(__dirname + '/fixtures/custom')
+let match = router(path.join(__dirname, '/fixtures/custom'))
 
 test('uses custom path if provided', t => {
   t.plan(1)
@@ -12,7 +13,7 @@ test('uses custom path if provided', t => {
 test('uses properly parses params in custom path', t => {
   t.plan(1)
   let req = { url: '/random/custom/foo', method: 'GET' }
-  let fn = match(req)
+  match(req)
   t.equal(req.params.param, 'foo', 'param is correct')
 })
 

test/fixtures/custom/custom.js

@@ -1,2 +1,2 @@
-module.exports = function() {}
+module.exports = function () {}
 module.exports.path = '/random/custom/:param'

test/fixtures/filter/index.js

@@ -0,0 +1 @@
+module.exports = () => 'index'

test/fixtures/filter/other.js

@@ -0,0 +1 @@
+module.exports = () => 'other'

test/fixtures/filter/thing/index.js

@@ -0,0 +1 @@
+module.exports = () => 'thing'

test/fixtures/filter/thing/other.js

@@ -0,0 +1 @@
+module.exports = () => 'other'

test/fixtures/params/:root/:why.js

@@ -1,2 +1,2 @@
-module.exports = function() {}
-module.exports.priority = -1;
+module.exports = function () {}
+module.exports.priority = -1

test/fixtures/params/:root/thing.js

@@ -1 +1 @@
-module.exports = function() {}
+module.exports = function () {}

test/fixtures/params/foo/:param/thing.js

@@ -1 +1 @@
-module.exports = function() {}
+module.exports = function () {}

test/fixtures/params/things/:id.js

@@ -1 +1 @@
-module.exports = function() {}
+module.exports = function () {}

test/fixtures/simple/foo/bar.js

@@ -1,3 +1,3 @@
-module.exports = function() {
+module.exports = function () {
   return 'bar'
 }

test/index-test.js

@@ -1,7 +1,8 @@
+const path = require('path')
 const test = require('tape')
 const router = require('..')
 
-let match = router(__dirname + '/fixtures/index')
+let match = router(path.join(__dirname, '/fixtures/index'))
 
 test('uses index.js when the root is requested', t => {
   t.plan(2)

test/params-test.js

@@ -1,7 +1,8 @@
+const path = require('path')
 const test = require('tape')
 const router = require('..')
 
-let match = router(__dirname + '/fixtures/params')
+let match = router(path.join(__dirname, '/fixtures/params'))
 
 test('files starting with `:` are treated as path params', t => {
   t.plan(1)

test/priority-test.js

@@ -1,7 +1,8 @@
+const path = require('path')
 const test = require('tape')
 const router = require('..')
 
-let match = router(__dirname + '/fixtures/priority')
+let match = router(path.join(__dirname, '/fixtures/priority'))
 
 test('matches high priority on collision with default', t => {
   t.plan(1)

test/simple-test.js

@@ -1,7 +1,8 @@
+const path = require('path')
 const test = require('tape')
 const router = require('..')
 
-let match = router(__dirname + '/fixtures/simple')
+let match = router(path.join(__dirname, '/fixtures/simple'))
 
 test('sets up routes from the fs', t => {
   t.plan(2)

test/verbs-test.js

@@ -1,7 +1,8 @@
+const path = require('path')
 const test = require('tape')
 const router = require('..')
 
-let match = router(__dirname + '/fixtures/verbs')
+let match = router(path.join(__dirname, '/fixtures/verbs'))
 const verbs = ['GET', 'PUT', 'POST', 'PATCH', 'DELETE', 'OPTIONS']
 
 test('correctly maps various verbs', t => {