You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

251 lines
12 KiB

7 months ago
12 months ago
  1. # budo-express - Auto-reload superpowers for Express!
  2. Get client-side code bundling and automagical live-reloading working in your Express app, in 5 minutes!
  3. This library integrates a [Budo]( development server into your Express application. It uses Browserify for bundling, and LiveReload for page reloading. It combines really well with `nodemon`, for auto-restarting your server process too!
  4. Because this package doesn't rely on any generators or boilerplates, you can easily integrate it into your *existing* Express application.
  5. ## What about Webpack?
  6. This library uses Browserify, which is a bundler just like Webpack - however, Browserify is much simpler to understand and configure. It can do the same things as Webpack can, and you won't need Webpack when using Browserify. It's actually been around for longer than Webpack!
  7. ## License, donations, and other boilerplate
  8. Licensed under either the [WTFPL]( or [CC0](, at your choice. In practice, that means it's more or less public domain, and you can do whatever you want with it. Giving credit is *not* required, but still very much appreciated! I'd love to [hear from you]( if this module was useful to you.
  9. Creating and maintaining open-source modules is a lot of work. A donation is also not required, but much appreciated! You can donate [here](
  10. ## Usage
  11. Because `budo-express` is meant to integrate into your own Express app, it's exposed as a library rather than a command-line utility.
  12. You simply start by creating your own "binary", something like `bin/server.js`, and then call `budo-express` from there, handing it your Express app as an argument:
  13. ```js
  14. "use strict";
  15. const budoExpress = require("budo-express");
  16. const path = require("path");
  17. budoExpress({
  18. port: 3000,
  19. expressApp: require("../src/server/app"),
  20. basePath: path.join(__dirname, ".."),
  21. entryFiles: "src/client/index.jsx",
  22. staticPath: "public",
  23. bundlePath: "js/bundle.js",
  24. livereloadPattern: "**/*.{css,html,js,svg}",
  25. browserify: {
  26. extensions: [".jsx"],
  27. transform: [
  28. ["babelify", {
  29. presets: ["@babel/preset-env", "@babel/preset-react"],
  30. }]
  31. ]
  32. }
  33. });
  34. ```
  35. (Don't worry about all those options for now - they're all explained below!)
  36. And in your `src/server/app.js` -- note that __you never call `app.listen`__, and you *export* your app instead:
  37. ```js
  38. "use strict";
  39. const express = require("express");
  40. let app = express();
  41. // ... your Express app stuff goes here ...
  42. module.exports = app;
  43. ```
  44. Now you simply run:
  45. ```sh
  46. NODE_ENV=development node bin/server.js
  47. ```
  48. ... and that's it! You now have a fully-functioning development server, that:
  49. - bundles `src/client/index.jsx` into `public/js/bundle.js`
  50. - transforms JSX and ES6+ using Babel
  51. - automatically reloads the browser when any `.css`, `.html`, `.js`, or `.svg` files in the `public/` folder change.
  52. There's only one thing missing; your server process won't auto-restart when your *server* code changes. That's easy to fix, when you have [`nodemon`]( installed:
  53. ```sh
  54. NODE_ENV=development nodemon bin/server.js
  55. ```
  56. (Note how we've just changed `node` to `nodemon`, and that's it!)
  57. ## More complex bundling configurations (eg. CSS modules)
  58. The `browserify` option accepts any kind of valid [Browserify configuration](
  59. So for example, if we want to add support for CSS modules and nested CSS, we just install [`icssify`]( and [`postcss-nested`](, and do this in our `bin/server.js`:
  60. ```js
  61. "use strict";
  62. const budoExpress = require("budo-express");
  63. const path = require("path");
  64. budoExpress({
  65. port: 3000,
  66. expressApp: require("../src/server/app"),
  67. basePath: path.join(__dirname, ".."),
  68. entryFiles: "src/client/index.jsx",
  69. staticPath: "public",
  70. bundlePath: "js/bundle.js",
  71. livereloadPattern: "**/*.{css,html,js,svg}",
  72. browserify: {
  73. extensions: [".jsx"],
  74. plugin: [
  75. ["icssify", {
  76. before: [ require("postcss-nested")() ]
  77. }]
  78. ],
  79. transform: [
  80. ["babelify", {
  81. presets: ["@babel/preset-env", "@babel/preset-react"],
  82. }]
  83. ]
  84. }
  85. });
  86. ```
  87. Note the added `plugin` list with `icssify`; that's the only difference.
  88. ## Running in production
  89. Of course, we don't want to run a development server when we're really deploying our app. And when we're running it in production, we need a 'real' generated bundle, not just one that the development server generates on-the-fly.
  90. There's only two steps needed to run your app in production. Step one is to generate the bundle:
  91. ```sh
  92. BUDO_BUILD=1 node bin/server.js
  93. ```
  94. Note how we're just running the same 'binary' again, but with a different environment variable. This tells `budo-express` that we want to generate a bundle instead. This doesn't require any extra configuration; it'll use the configuration we've specified in `bin/server.js`!
  95. The second step is to actually *run* your application, but without the development server sitting in front of it:
  96. ```
  97. node bin/server.js
  98. ```
  99. That's it! We just leave off the environment variables, and it will default to production mode. Nothing will be auto-reloaded, `budo-express` will get out of the way, and all you're left with is your own Express application.
  100. ## About all those options...
  101. In the example above, there were quite a few options - especially path-related options. This is because we're actually dealing with two different *kinds* of paths
  102. 1. Filesystem paths, ie. paths of folders/files on your computer
  103. 2. URL paths, ie. the `/some/path` part in ``.
  104. ... and we need to deal with a number of different files; the input files, the output bundle, static files, and so on.
  105. Here's a rundown of what all the path-related options mean:
  106. __basePath:__ This is the filesystem path for your "project root", ie. where your `package.json` is. It must be an absolute path. The easiest way to generate this is to use [`path.join`]( with [`__dirname`]( and the right amount of `../..` entries.
  107. For example, in the example above, our `bin/server.js` is in `bin`, which is one folder deeper than the root of the project; so we need to combine it with a single `..` to get the project root.
  108. __entryFiles:__ These are the files - __relative to the `basePath` (project root)__ - that the bundler should start with; basically, the files that contain the code that should be executed right when the bundle loads. The bundler will then follow all the `require(...)` statements starting from those files, collecting everything together. Note that this can be __either a single path, or an array of them__.
  109. __staticPath:__ This is the filesystem path - again, relative to the `basePath` - where your static files (CSS stylesheets, images...) are stored.
  110. __bundlePath:__ This is the filesystem path - __relative to both `staticPath` *and* the URL root of your static files__ (see the `staticPrefix` option below) - where your bundle should be saved. So if `staticPath` is `"public/"`, and `bundlePath` is `"js/bundle.js"`, the final path for your generated bundle will be `"public/js/bundle.js"` (relative to the project root).
  111. __livereloadPattern:__ This is the [glob pattern]( - relative to `staticPath` - that defines which files should be live-reloaded when they changed. Anything in the static files folder that matches this pattern, will be reloaded; anything that does not, will not.
  112. And then there's a bunch of required non-path options:
  113. __port:__ The port that your server should run on, __both in development and production mode__.
  114. __expressApp:__ The actual Express application that the development server should be integrated into (or, in production mode, the application that should be run).
  115. __browserify:__ The [Browserify configuration]( to use for bundling.
  116. ## Optional extras
  117. Finally, there's a handful of __optional__ options:
  118. __staticPrefix:__ The *URL path*, relative to the root of your domain/hostname, where your static file folder is publicly exposed. If you're exposing it at the root (the default result of doing `app.use(express.static(...))` without specifying a middleware prefix), leave this undefined.
  119. __host:__ The host to listen on in production mode. Defaults to all network interfaces (`"::"`).
  120. __allowUnsafeHost:__ By default, in development mode, the development server will only listen on `localhost`, so that noone can access it from outside your computer; this is for security reasons. If you want to disable this and use the host specified in `host` instead, you can set this option to `true` -- however, only do this if you fully understand the risks!
  121. __sourceMaps:__ Whether to enable Browserify's [sourcemaps]( in development mode. Defaults to `true`.
  122. __developmentMode:__ Whether to run in development mode (`true`), production mode (`false`), or auto-detect it based on the `NODE_ENV` environment variable like in the examples (`"auto"`). Defaults to auto-detection.
  123. __middleware:__ Custom Connect/Express-style middleware to run __in development mode only__, before a request reaches your application. Don't use this for normal application middleware! You should almost never need this option.
  124. __livereloadPort:__ The port that the LiveReload server should listen on. Changing this will almost certainly break any LiveReload browser extensions. Defaults to `35729`.
  125. __stream:__ A Writable stream to log ndjson output from Budo to. This defaults to `process.stdout` (ie. your terminal).
  126. Altogether, the various paths are composed like this:
  127. Path | Calculated as
  128. -----|--------------
  129. Static files filesystem path | `basePath` + `staticPath`
  130. Static files URL path | root of your domain + `staticPrefix`
  131. Bundle filesystem path | `basePath` + `staticPath` + `bundlePath`
  132. Bundle URL path | root of your domain + `staticPrefix` + `bundlePath`
  133. Pattern for livereloaded file matching | `basePath` + `staticPath` + `livereloadPattern`
  134. Entry files filesystem path | `basePath` + `entryFiles`
  135. ## API
  136. ### expressBudo(options)
  137. Depending on whether `BUDO_BUILD=1` is specified:
  138. - If yes, starts an instance of your Express application; with, if development mode is enabled (`NODE_ENV=development` or `developmentMode: true`), a development server integrated into it.
  139. - If no, generates and saves a bundle based on your configuration.
  140. Arguments:
  141. - __options:__ The options, as documented above.
  142. ## Changelog
  143. ### v1.0.8 (May 8, 2020)
  144. - __Patch:__ The previous release included a small error that broke Express integration; this is now fixed.
  145. ### v1.0.7 (May 8, 2020)
  146. - __Patch:__ Now uses `inject-lr` for LiveReload script injection instead of a custom implementation, to make it more robust in edge cases.
  147. - __Patch:__ Budo-served resources now bypass the Express app entirely, and therefore it should now be possible to have a catch-all 404 handler in your Express app without breaking `express-budo`.
  148. - __Patch:__ Now waits with sending out a LiveReload event for a bit, so that when `budo-express` is used with an external restarter such as Nodemon, there's no longer a race condition between the browser reloading and the server process having restarted (which would result in an error page). Currently uses a fixed timeout, which is not ideal; if you're still seeing this problem, please file an issue!
  149. ### v1.0.6 (December 7, 2020)
  150. - __Patch:__ No longer crashes when headers have already been sent; though in some cases this may break auto-reloading. If you can find a better solution for livereload injection, please file a PR!
  151. ### v1.0.4 (October 23, 2020)
  152. - __Patch:__ No longer breaks in development mode when a string is sent as the response (rather than a Buffer).
  153. - __Patch:__ No longer breaks in development mode when a Content-Type header is omitted entirely.
  154. ### v1.0.3 (October 4, 2020)
  155. - __Patch:__ Fixed monkeypatching logic in development mode (for livereload tag injection) to also work on newer Node versions.
  156. ### v1.0.2 (February 17, 2020)
  157. - __Misc:__ Fixed repository URL in package.json
  158. ### v1.0.1 (February 16, 2020)
  159. - __Documentation:__ Added license/donation boilerplate to README
  160. ### v1.0.0 (February 16, 2020)
  161. Initial release.