npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@small-tech/web-routes-from-files

v3.1.0

Published

Recursively traverses a given directory structure and uses convention to create a list of web route objects that map url paths to JavaScript callback files.

Downloads

8

Readme

Web routes from files

Recursively traverses a given directory structure and uses convention to create a list of web route objects that map Express-style URL paths to JavaScript callback files.

Installation

npm i @small-tech/web-routes-from-files

Usage

const getRoutes = require ('web-routes-from-files')

const routes = getRoutes('.')

routes.forEach(route => {
  console.log(`${route.path}: ${route.callback}`)
})

Details

Given the following directory structure:

.routes
   ├─── index.js
   ├─── my-folder
   │       ├── index.cjs
   │       └── other.js
   ├─── person
   │       └── index_personId__book_bookId.js
   ├─── rabbit_rabbitName.js
   └─── neat.mjs

And the following invocation:

const getRoutes = require ('web-routes-from-files')
const routes = getRoutes('.routes')

You will get the following data structure:

[
  { path: '/', callback: '.routes/index.js' },
  { path: '/my-folder', callback: '.routes/my-folder/index.js' },
  { path: '/my-folder/other', callback: '.routes/my-folder/other.js' },
  { path: '/person/:personId/book/:bookId', callback: '.routes/person/index_personId__book_bookId.js' },
  { path: '/rabbit/:rabbitName', callback: '.routes/rabbit_rabbitName.js' },
  { path: '/neat', callback: '.routes/neat.mjs' }
]

Which, for example, you could pass to an Express app (as Site.js) does:

const path      = require('path')
const express   = require('express')
const getRoutes = require ('..')

const app = express()
const routes = getRoutes(path.join(__dirname, '.routes'))

// Note that while .mjs and .cjs files are supported,
// this module cannot defy the laws of ECMAScript. So the
// same rules defining mixing of CommonJS and ESM apply here too.
if (!route.callback.endsWith('.mjs')) {
  app.get(route.path, require(route.callback))
}

app.listen(8080, () => console.log('\nServer running on http://localhost:8080'))

Your routes should export standard middleware-style functions. e.g.,

function route (request, response, next) {
  response.end('Hello, world!')
}
module.exports = route

Routes that take parameters (introduced in version 3.0.0) can access them from the request.params object. e.g., in the .routes/person/index_personId__book_bookId.js callback file:

function route (request, response, next) {
  response.end(`person/${request.params.personId}/book/${request.params.bookId}`)
}
module.exports = route

This example is included in the source code. Run it with:

node example

Note: This module will ignore node_modules folders and any folder within the root folder being traversed that begins with a dot (i.e., any hidden folder).

Like this? Fund us!

Small Technology Foundation is a tiny, independent not-for-profit.

We exist in part thanks to patronage by people like you. If you share our vision and want to support our work, please become a patron or donate to us today and help us continue to exist.

Audience

This is small technology.

If you’re evaluating this for a “startup” or an enterprise, let us save you some time: this is not the right tool for you. This tool is for individual developers to build personal web sites and apps for themselves and for others in a non-colonial manner that respects the human rights of the people who use them.

Copyright

© 2020 Aral Balkan, Small Technology Foundation.

License

AGPL version 3.0 or later.