index.js

'use strict'

// Local
const PathRoutifier = require('./lib/PathRoutifier')

/**
 * Convenience method for generating express-compatible routes using PathRoutifier. Any ${options}
 * are also passed to the PathRoutifier for its configuration.
 *
 * @param {express} app
 * @param {String} routesPath root path to recursively transform into express compatible routes
 * @param {Object} [options = {}] defaults to an empty object; passed directly to PathRoutifier
 * @param {String} [options.middlewaresPath] path to all application middlewares
 * @param {RegExp} [ignorePattern] ignore all files matching this regex
 * @returns {express.Router}
 */
module.exports = function(app, routesPath, options = {}) {
	const pathRoutifier = new PathRoutifier(app, options)
	const middlewares = pathRoutifier.loadMiddlewares(options.middlewaresPath, options.ignorePattern)
	return pathRoutifier.routify(routesPath, middlewares)
}