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

connect-chokidar

v1.0.4

Published

Middleware to watch files and remove require.cache on change, making nodemon unnecessary.

Downloads

6

Readme

connect-chokidar Build Status NPM version

Middleware to watch files and remove require.cache on change, making nodemon unnecessary.

Motivation

Sometimes restarting the entire process when a file changes (as with nodemon) takes too long or is undesirable. This is often the case with "universal" web applications, where the code which runs both on the client and server is already hot-reloaded with webpack. In such apps we sometimes have server-only code (such as a GraphQL server or a RESTful API). Restarting the entire server with nodemon would mean forcing webpack to have to take time to rebuild, loosing the benefits of hot reloading.

This module saves that time by specifically only removing files from the require.cache (a cache that require() uses on every call) when a change to one of the files on the file system is detected.

Usage

const createWatcher = require('connect-chokidar');

const watchMiddleware = createWatcher(`${__dirname}`, {
  // `process.env.NODE_ENV === 'development'` will be used as the default
  // when this is `false`, no file watching will be done and your middleware
  // will be executed with minimal interference
  isDevEnv: process.env.NODE_ENV === 'development',

  // Only the filenames that are in the regexp below will be deleted
  // from `require.cache` when files change
  requireCacheToRemoveRe: /\/src\//,

  // `usePolling: true` is usually necessary with NFS (and, for me, in docker for mac)
  // other `chokidar` opts can also be provided here
  chokidar: {
    usePolling: true,
  },
});

//...

const app = connect(); // or express()

// Now is the trickier bit, you'll have to `require()` all of the files that your
// local middleware or router depend on. This is because if we required it on top,
// the router / middleware would always refere to that instance and there would be
// no way of clearing it.

app.use('/auth', watchMiddleware(() => require('../auth/router')));

app.use(
  '/api',
  watchMiddleware(() => {
    const midA = require('./middlewareA');
    const apiRouter = require('./api/router');
    return [midA, apiRouter];
  }),
);

app.use(
  '/hello',
  watchMiddleware(() => {
    const midA = require('./middlewareA');
    return [
      midA,
      (req, res) => {
        res.end('world');
      },
    ];
  }),
);

Debug-logging

Run your process with the NODE_DEBUG=connect-chokidar environment variable set.

Inspiration

https://codeburst.io/dont-use-nodemon-there-are-better-ways-fc016b50b45e

License

MIT