summaryrefslogtreecommitdiff
path: root/node_modules/@11ty/eleventy-dev-server/server.js
diff options
context:
space:
mode:
authorShipwreckt <me@shipwreckt.co.uk>2025-10-31 20:02:14 +0000
committerShipwreckt <me@shipwreckt.co.uk>2025-10-31 20:02:14 +0000
commit7a52ddeba2a68388b544f529d2d92104420f77b0 (patch)
tree15ddd47457a2cb4a96060747437d36474e4f6b4e /node_modules/@11ty/eleventy-dev-server/server.js
parent53d6ae2b5568437afa5e4995580a3fb679b7b91b (diff)
Changed from static to 11ty!
Diffstat (limited to 'node_modules/@11ty/eleventy-dev-server/server.js')
-rw-r--r--node_modules/@11ty/eleventy-dev-server/server.js1024
1 files changed, 1024 insertions, 0 deletions
diff --git a/node_modules/@11ty/eleventy-dev-server/server.js b/node_modules/@11ty/eleventy-dev-server/server.js
new file mode 100644
index 0000000..9fbe898
--- /dev/null
+++ b/node_modules/@11ty/eleventy-dev-server/server.js
@@ -0,0 +1,1024 @@
+const path = require("node:path");
+const fs = require("node:fs");
+
+const finalhandler = require("finalhandler");
+const WebSocket = require("ws");
+const { WebSocketServer } = WebSocket;
+const mime = require("mime");
+const ssri = require("ssri");
+const send = require("send");
+const chokidar = require("chokidar");
+const { TemplatePath, isPlainObject } = require("@11ty/eleventy-utils");
+
+const debug = require("debug")("Eleventy:DevServer");
+
+const pkg = require("./package.json");
+const wrapResponse = require("./server/wrapResponse.js");
+const ipAddress = require("./server/ipAddress.js");
+
+if (!globalThis.URLPattern) {
+ require("urlpattern-polyfill");
+}
+
+const DEFAULT_OPTIONS = {
+ port: 8080,
+ reloadPort: false, // Falsy uses same as `port`
+ liveReload: true, // Enable live reload at all
+ showAllHosts: false, // IP address based hosts (other than localhost)
+ injectedScriptsFolder: ".11ty", // Change the name of the special folder used for injected scripts
+ portReassignmentRetryCount: 10, // number of times to increment the port if in use
+ https: {}, // `key` and `cert`, required for http/2 and https
+ domDiff: true, // Use morphdom to apply DOM diffing delta updates to HTML
+ showVersion: false, // Whether or not to show the server version on the command line.
+ encoding: "utf-8", // Default file encoding
+ pathPrefix: "/", // May be overridden by Eleventy, adds a virtual base directory to your project
+ watch: [], // Globs to pass to separate dev server chokidar for watching
+ aliases: {}, // Aliasing feature
+ indexFileName: "index.html", // Allow custom index file name
+ useCache: false, // Use a cache for file contents
+ headers: {}, // Set default response headers
+ messageOnStart: ({ hosts, startupTime, version, options }) => {
+ let hostsStr = " started";
+ if(Array.isArray(hosts) && hosts.length > 0) {
+ // TODO what happens when the cert doesn’t cover non-localhost hosts?
+ hostsStr = ` at ${hosts.join(" or ")}`;
+ }
+
+ return `Server${hostsStr}${options.showVersion ? ` (v${version})` : ""}`;
+ },
+
+ onRequest: {}, // Maps URLPatterns to dynamic callback functions that run on a request from a client.
+
+ // Example:
+ // "/foo/:name": function({ url, pattern, patternGroups }) {
+ // return {
+ // headers: {
+ // "Content-Type": "text/html",
+ // },
+ // body: `${url} ${JSON.stringify(patternGroups)}`
+ // }
+ // }
+
+ // Logger (fancier one is injected by Eleventy)
+ logger: {
+ info: console.log,
+ log: console.log,
+ error: console.error,
+ }
+}
+
+class EleventyDevServer {
+ #watcher;
+ #serverClosing;
+ #serverState;
+ #readyPromise;
+ #readyResolve;
+
+ static getServer(...args) {
+ return new EleventyDevServer(...args);
+ }
+
+ constructor(name, dir, options = {}) {
+ debug("Creating new Dev Server instance.")
+ this.name = name;
+ this.normalizeOptions(options);
+
+ this.fileCache = {};
+ // Directory to serve
+ if(!dir) {
+ throw new Error("Missing `dir` to serve.");
+ }
+ this.dir = dir;
+ this.logger = this.options.logger;
+ this.getWatcher();
+
+ this.#readyPromise = new Promise((resolve) => {
+ this.#readyResolve = resolve;
+ })
+ }
+
+ normalizeOptions(options = {}) {
+ this.options = Object.assign({}, DEFAULT_OPTIONS, options);
+
+ // better names for options https://github.com/11ty/eleventy-dev-server/issues/41
+ if(options.folder !== undefined) {
+ this.options.injectedScriptsFolder = options.folder;
+ delete this.options.folder;
+ }
+ if(options.domdiff !== undefined) {
+ this.options.domDiff = options.domdiff;
+ delete this.options.domdiff;
+ }
+ if(options.enabled !== undefined) {
+ this.options.liveReload = options.enabled;
+ delete this.options.enabled;
+ }
+
+ this.options.pathPrefix = this.cleanupPathPrefix(this.options.pathPrefix);
+ }
+
+ get watcher() {
+ if(this.#watcher) {
+ return this.#watcher;
+ }
+
+ debug("Watching %O", this.options.watch);
+ // TODO if using Eleventy and `watch` option includes output folder (_site) this will trigger two update events!
+ this.#watcher = chokidar.watch(this.options.watch, {
+ // TODO allow chokidar configuration extensions (or re-use the ones in Eleventy)
+
+ ignored: ["**/node_modules/**", ".git"],
+ ignoreInitial: true,
+
+ // same values as Eleventy
+ awaitWriteFinish: {
+ stabilityThreshold: 150,
+ pollInterval: 25,
+ },
+ });
+
+ this.#watcher.on("change", (path) => {
+ this.logger.log( `File changed: ${path} (skips build)` );
+ this.reloadFiles([path]);
+ });
+
+ this.#watcher.on("add", (path) => {
+ this.logger.log( `File added: ${path} (skips build)` );
+ this.reloadFiles([path]);
+ });
+
+ return this.#watcher;
+ }
+
+ getWatcher() {
+ // only initialize watcher if watcher via getWatcher if has targets
+ // this.watcher in watchFiles() is a manual workaround
+ if(this.options.watch.length > 0) {
+ return this.watcher;
+ }
+ }
+
+ watchFiles(files) {
+ if(Array.isArray(files) && files.length > 0) {
+ files = files.map(entry => TemplatePath.stripLeadingDotSlash(entry));
+
+ debug("Also watching %O", files);
+ this.watcher.add(files);
+ }
+ }
+
+ cleanupPathPrefix(pathPrefix) {
+ if(!pathPrefix || pathPrefix === "/") {
+ return "/";
+ }
+ if(!pathPrefix.startsWith("/")) {
+ pathPrefix = `/${pathPrefix}`
+ }
+ if(!pathPrefix.endsWith("/")) {
+ pathPrefix = `${pathPrefix}/`;
+ }
+ return pathPrefix;
+ }
+
+ // Allowed list of files that can be served from outside `dir`
+ setAliases(aliases) {
+ if(aliases) {
+ this.passthroughAliases = aliases;
+ debug( "Setting aliases (emulated passthrough copy) %O", aliases );
+ }
+ }
+
+ matchPassthroughAlias(url) {
+ let aliases = Object.assign({}, this.options.aliases, this.passthroughAliases);
+ for(let targetUrl in aliases) {
+ if(!targetUrl) {
+ continue;
+ }
+
+ let file = aliases[targetUrl];
+ if(url.startsWith(targetUrl)) {
+ let inputDirectoryPath = file + url.slice(targetUrl.length);
+
+ // e.g. addPassthroughCopy("img/") but <img src="/img/built/IdthKOzqFA-350.png">
+ // generated by the image plugin (written to the output folder)
+ // If they do not exist in the input directory, this will fallback to the output directory.
+ if(fs.existsSync(inputDirectoryPath)) {
+ return inputDirectoryPath;
+ }
+ }
+ }
+ return false;
+ }
+
+ isFileInDirectory(dir, file) {
+ let absoluteDir = TemplatePath.absolutePath(dir);
+ let absoluteFile = TemplatePath.absolutePath(file);
+ return absoluteFile.startsWith(absoluteDir);
+ }
+
+ getOutputDirFilePath(filepath, filename = "") {
+ let computedPath;
+ if(filename === ".html") {
+ // avoid trailing slash for filepath/.html requests
+ let prefix = path.join(this.dir, filepath);
+ if(prefix.endsWith(path.sep)) {
+ prefix = prefix.substring(0, prefix.length - path.sep.length);
+ }
+ computedPath = prefix + filename;
+ } else {
+ computedPath = path.join(this.dir, filepath, filename);
+ }
+
+ computedPath = decodeURIComponent(computedPath);
+
+ if(!filename) { // is a direct URL request (not an implicit .html or index.html add)
+ let alias = this.matchPassthroughAlias(filepath);
+
+ if(alias) {
+ if(!this.isFileInDirectory(path.resolve("."), alias)) {
+ throw new Error("Invalid path");
+ }
+
+ return alias;
+ }
+ }
+
+ // Check that the file is in the output path (error if folks try use `..` in the filepath)
+ if(!this.isFileInDirectory(this.dir, computedPath)) {
+ throw new Error("Invalid path");
+ }
+
+ return computedPath;
+ }
+
+ isOutputFilePathExists(rawPath) {
+ return fs.existsSync(rawPath) && !TemplatePath.isDirectorySync(rawPath);
+ }
+
+ /* Use conventions documented here https://www.zachleat.com/web/trailing-slash/
+ * resource.html exists:
+ * /resource matches
+ * /resource/ redirects to /resource
+ * resource/index.html exists:
+ * /resource redirects to /resource/
+ * /resource/ matches
+ * both resource.html and resource/index.html exists:
+ * /resource matches /resource.html
+ * /resource/ matches /resource/index.html
+ */
+ mapUrlToFilePath(url) {
+ // Note: `localhost` is not important here, any host would work
+ let u = new URL(url, "http://localhost/");
+ url = u.pathname;
+
+ // Remove PathPrefix from start of URL
+ if (this.options.pathPrefix !== "/") {
+ // Requests to root should redirect to new pathPrefix
+ if(url === "/") {
+ return {
+ statusCode: 302,
+ url: this.options.pathPrefix,
+ }
+ }
+
+ // Requests to anything outside of root should fail with 404
+ if (!url.startsWith(this.options.pathPrefix)) {
+ return {
+ statusCode: 404,
+ };
+ }
+
+ url = url.slice(this.options.pathPrefix.length - 1);
+ }
+
+ let rawPath = this.getOutputDirFilePath(url);
+ if (this.isOutputFilePathExists(rawPath)) {
+ return {
+ statusCode: 200,
+ filepath: rawPath,
+ };
+ }
+
+ let indexHtmlPath = this.getOutputDirFilePath(url, this.options.indexFileName);
+ let indexHtmlExists = fs.existsSync(indexHtmlPath);
+
+ let htmlPath = this.getOutputDirFilePath(url, ".html");
+ let htmlExists = fs.existsSync(htmlPath);
+
+ // /resource/ => /resource/index.html
+ if (indexHtmlExists && url.endsWith("/")) {
+ return {
+ statusCode: 200,
+ filepath: indexHtmlPath,
+ };
+ }
+ // /resource => resource.html
+ if (htmlExists && !url.endsWith("/")) {
+ return {
+ statusCode: 200,
+ filepath: htmlPath,
+ };
+ }
+
+ // /resource => redirect to /resource/
+ if (indexHtmlExists && !url.endsWith("/")) {
+ return {
+ statusCode: 301,
+ url: u.pathname + "/",
+ };
+ }
+
+ // /resource/ => redirect to /resource
+ if (htmlExists && url.endsWith("/")) {
+ return {
+ statusCode: 301,
+ url: u.pathname.substring(0, u.pathname.length - 1),
+ };
+ }
+
+ return {
+ statusCode: 404,
+ };
+ }
+
+ #readFile(filepath) {
+ if(this.options.useCache && this.fileCache[filepath]) {
+ return this.fileCache[filepath];
+ }
+
+ let contents = fs.readFileSync(filepath, {
+ encoding: this.options.encoding,
+ });
+
+ if(this.options.useCache) {
+ this.fileCache[filepath] = contents;
+ }
+
+ return contents;
+ }
+
+ #getFileContents(localpath, rootDir) {
+ let filepath;
+ let searchLocations = [];
+
+ if(rootDir) {
+ searchLocations.push(TemplatePath.absolutePath(rootDir, localpath));
+ }
+
+ // fallbacks for file:../ installations
+ searchLocations.push(TemplatePath.absolutePath(__dirname, localpath));
+ searchLocations.push(TemplatePath.absolutePath(__dirname, "../../../", localpath));
+
+ for(let loc of searchLocations) {
+ if(fs.existsSync(loc)) {
+ filepath = loc;
+ break;
+ }
+ }
+
+ return this.#readFile(filepath);
+ }
+
+ augmentContentWithNotifier(content, inlineContents = false, options = {}) {
+ let { integrityHash, scriptContents } = options;
+ if(!scriptContents) {
+ scriptContents = this.#getFileContents("./client/reload-client.js");
+ }
+ if(!integrityHash) {
+ integrityHash = ssri.fromData(scriptContents);
+ }
+
+ let searchParams = new URLSearchParams();
+ if(this.options.reloadPort) {
+ searchParams.set("reloadPort", this.options.reloadPort);
+ }
+
+ let searchParamsStr = searchParams.size > 0 ? `?${searchParams.toString()}` : "";
+
+ // This isn’t super necessary because it’s a local file, but it’s included anyway
+ let script = `<script type="module" integrity="${integrityHash}"${inlineContents ? `>${scriptContents}` : ` src="/${this.options.injectedScriptsFolder}/reload-client.js${searchParamsStr}">`}</script>`;
+
+ if (content.includes("</head>")) {
+ return content.replace("</head>", `${script}</head>`);
+ }
+
+ // If the HTML document contains an importmap, insert the module script after the importmap element
+ let importMapRegEx = /<script type=\\?importmap\\?[^>]*>(\n|.)*?<\/script>/gmi;
+ let importMapMatch = content.match(importMapRegEx)?.[0];
+
+ if (importMapMatch) {
+ return content.replace(importMapMatch, `${importMapMatch}${script}`);
+ }
+
+ // <title> is the only *required* element in an HTML document
+ if (content.includes("</title>")) {
+ return content.replace("</title>", `</title>${script}`);
+ }
+
+ // If you’ve reached this section, your HTML is invalid!
+ // We want to be super forgiving here, because folks might be in-progress editing the document!
+ if (content.includes("</body>")) {
+ return content.replace("</body>", `${script}</body>`);
+ }
+ if (content.includes("</html>")) {
+ return content.replace("</html>", `${script}</html>`);
+ }
+ if (content.includes("<!doctype html>")) {
+ return content.replace("<!doctype html>", `<!doctype html>${script}`);
+ }
+
+ // Notably, works without content at all!!
+ return (content || "") + script;
+ }
+
+ getFileContentType(filepath, res) {
+ let contentType = res.getHeader("Content-Type");
+
+ // Content-Type might be already set via middleware
+ if (contentType) {
+ return contentType;
+ }
+
+ let mimeType = mime.getType(filepath);
+ if (!mimeType) {
+ return;
+ }
+
+ contentType = mimeType;
+
+ // We only want to append charset if the header is not already set
+ if (contentType === "text/html") {
+ contentType = `text/html; charset=${this.options.encoding}`;
+ }
+
+ return contentType;
+ }
+
+ renderFile(filepath, res) {
+ let contents = fs.readFileSync(filepath);
+ let contentType = this.getFileContentType(filepath, res);
+
+ for(const [key, value] of Object.entries(this.options.headers)){
+ res.setHeader(key, value);
+ }
+
+ if (!contentType) {
+ return res.end(contents);
+ }
+
+ res.setHeader("Content-Type", contentType);
+
+ if (contentType.startsWith("text/html")) {
+ // the string is important here, wrapResponse expects strings internally for HTML content (for now)
+ return res.end(contents.toString());
+ }
+
+ return res.end(contents);
+ }
+
+ async eleventyDevServerMiddleware(req, res, next) {
+ if(this.#serverState === "CLOSING") {
+ return res.end("");
+ }
+
+ for(let urlPatternString in this.options.onRequest) {
+ let fn = this.options.onRequest[urlPatternString];
+ let fullPath = this.getServerPath(urlPatternString);
+ let p = new URLPattern({ pathname: fullPath });
+
+ // request url should already include pathprefix.
+ let fullUrl = this.getServerUrlRaw("localhost", req.url);
+ let match = p.exec(fullUrl);
+
+ let u = new URL(fullUrl);
+
+ if(match) {
+ let result = await fn({
+ url: u,
+ pattern: p,
+ patternGroups: match?.pathname?.groups || {},
+ });
+
+ if(!result && result !== "") {
+ continue;
+ }
+
+ if(typeof result === "string") {
+ return res.end(result);
+ }
+
+ if(isPlainObject(result) || result instanceof Response) {
+ if(typeof result.status === "number") {
+ res.statusCode = result.status;
+ }
+
+ if(result.headers instanceof Headers) {
+ for(let [key, value] of result.headers.entries()) {
+ res.setHeader(key, value);
+ }
+ } else if(isPlainObject(result.headers)) {
+ for(let key of Object.keys(result.headers)) {
+ res.setHeader(key, result.headers[key]);
+ }
+ }
+
+ if(result instanceof Response) {
+ // no gzip/br compression here, uncompressed from fetch https://github.com/w3c/ServiceWorker/issues/339
+ res.removeHeader("content-encoding");
+
+ let arrayBuffer = await result.arrayBuffer();
+ res.setHeader("content-length", arrayBuffer.byteLength);
+
+ let buffer = Buffer.from(arrayBuffer);
+ return res.end(buffer);
+ }
+
+ return res.end(result.body || "");
+ }
+
+ throw new Error(`Invalid return type from \`onRequest\` pattern for ${urlPatternString}: expected string, object literal, or Response instance.`);
+ }
+ } // end onRequest
+
+ if(req.url.startsWith(`/${this.options.injectedScriptsFolder}/reload-client.js`)) {
+ if(this.options.liveReload) {
+ res.setHeader("Content-Type", mime.getType("js"));
+ return res.end(this.#getFileContents("./client/reload-client.js"));
+ }
+ } else if(req.url === `/${this.options.injectedScriptsFolder}/morphdom.js`) {
+ if(this.options.domDiff) {
+ res.setHeader("Content-Type", mime.getType("js"));
+ let morphdomEsmPath = require.resolve("morphdom").replace("morphdom.js", "morphdom-esm.js");
+ return res.end(this.#readFile(morphdomEsmPath));
+ }
+ }
+
+ next();
+ }
+
+ // This runs at the end of the middleware chain
+ eleventyProjectMiddleware(req, res) {
+ // Known issue with `finalhandler` and HTTP/2:
+ // UnsupportedWarning: Status message is not supported by HTTP/2 (RFC7540 8.1.2.4)
+ // https://github.com/pillarjs/finalhandler/pull/34
+
+ let lastNext = finalhandler(req, res, {
+ onerror: (e) => {
+ if (e.statusCode === 404) {
+ let localPath = TemplatePath.stripLeadingSubPath(
+ e.path,
+ TemplatePath.absolutePath(this.dir)
+ );
+ this.logger.error(
+ `HTTP ${e.statusCode}: Template not found in output directory (${this.dir}): ${localPath}`
+ );
+ } else {
+ this.logger.error(`HTTP ${e.statusCode}: ${e.message}`);
+ }
+ },
+ });
+
+ // middleware (maybe a serverless request) already set a body upstream, skip this part
+ if(!res._shouldForceEnd) {
+ let match = this.mapUrlToFilePath(req.url);
+ debug( req.url, match );
+
+ if (match) {
+ if (match.statusCode === 200 && match.filepath) {
+ // Content-Range request, probably Safari trying to stream video
+ if (req.headers.range) {
+ return send(req, match.filepath).pipe(res);
+ }
+
+ return this.renderFile(match.filepath, res);
+ }
+
+ // Redirects, usually for trailing slash to .html stuff
+ if (match.url) {
+ res.statusCode = match.statusCode;
+ res.setHeader("Location", match.url);
+ return res.end();
+ }
+
+ let raw404Path = this.getOutputDirFilePath("404.html");
+ if(match.statusCode === 404 && this.isOutputFilePathExists(raw404Path)) {
+ res.statusCode = match.statusCode;
+ res.isCustomErrorPage = true;
+ return this.renderFile(raw404Path, res);
+ }
+ }
+ }
+
+ if(res.body && !res.bodyUsed) {
+ if(res._shouldForceEnd) {
+ res.end();
+ } else {
+ let err = new Error("A response was never written to the stream. Are you missing a server middleware with `res.end()`?");
+ err.statusCode = 500;
+ lastNext(err);
+ return;
+ }
+ }
+
+ lastNext();
+ }
+
+ async onRequestHandler (req, res) {
+ res = wrapResponse(res, content => {
+
+ // check to see if this is a client fetch and not a navigation
+ let isXHR = req.headers["sec-fetch-mode"] && req.headers["sec-fetch-mode"] != "navigate";
+
+ if(this.options.liveReload !== false && !isXHR) {
+ let scriptContents = this.#getFileContents("./client/reload-client.js");
+ let integrityHash = ssri.fromData(scriptContents);
+
+ // Bare (not-custom) finalhandler error pages have a Content-Security-Policy `default-src 'none'` that
+ // prevents the client script from executing, so we override it
+ if(res.statusCode !== 200 && !res.isCustomErrorPage) {
+ res.setHeader("Content-Security-Policy", `script-src '${integrityHash}'`);
+ }
+ return this.augmentContentWithNotifier(content, res.statusCode !== 200, {
+ scriptContents,
+ integrityHash
+ });
+ }
+
+ return content;
+ });
+
+ let middlewares = this.options.middleware || [];
+ middlewares = middlewares.slice();
+
+ // TODO because this runs at the very end of the middleware chain,
+ // if we move the static stuff up in the order we could use middleware to modify
+ // the static content in middleware!
+ middlewares.push(this.eleventyProjectMiddleware);
+ middlewares.reverse();
+
+ // Runs very first in the middleware chain
+ middlewares.push(this.eleventyDevServerMiddleware);
+
+ let bound = [];
+ let next;
+
+ for(let ware of middlewares) {
+ let fn;
+ if(next) {
+ fn = ware.bind(this, req, res, next);
+ } else {
+ fn = ware.bind(this, req, res);
+ }
+ bound.push(fn);
+ next = fn;
+ }
+
+ bound.reverse();
+
+ let [first] = bound;
+ await first();
+ }
+
+ getHosts() {
+ let hosts = new Set();
+ if(this.options.showAllHosts) {
+ for(let host of ipAddress()) {
+ hosts.add(this.getServerUrl(host));
+ }
+ }
+ hosts.add(this.getServerUrl("localhost"));
+ return Array.from(hosts);
+ }
+
+ get server() {
+ if (this._server) {
+ return this._server;
+ }
+
+ this.start = Date.now();
+
+ // Check for secure server requirements, otherwise use HTTP
+ let { key, cert } = this.options.https;
+ if(key && cert) {
+ const { createSecureServer } = require("http2");
+
+ let options = {
+ allowHTTP1: true,
+
+ // Credentials
+ key: fs.readFileSync(key),
+ cert: fs.readFileSync(cert),
+ };
+ this._server = createSecureServer(options, this.onRequestHandler.bind(this));
+ this._serverProtocol = "https:";
+ } else {
+ const { createServer } = require("http");
+
+ this._server = createServer(this.onRequestHandler.bind(this));
+ this._serverProtocol = "http:";
+ }
+
+ this.portRetryCount = 0;
+ this._server.on("error", (err) => {
+ if (err.code == "EADDRINUSE") {
+ if (this.portRetryCount < this.options.portReassignmentRetryCount) {
+ this.portRetryCount++;
+ debug(
+ "Server already using port %o, trying the next port %o. Retry number %o of %o",
+ err.port,
+ err.port + 1,
+ this.portRetryCount,
+ this.options.portReassignmentRetryCount
+ );
+ this._serverListen(err.port + 1);
+ } else {
+ throw new Error(
+ `Tried ${this.options.portReassignmentRetryCount} different ports but they were all in use. You can a different starter port using --port on the command line.`
+ );
+ }
+ } else {
+ this._serverErrorHandler(err);
+ }
+ });
+
+ this._server.on("listening", (e) => {
+ this.setupReloadNotifier();
+
+ let logMessageCallback = typeof this.options.messageOnStart === "function" ? this.options.messageOnStart : () => false;
+ let hosts = this.getHosts();
+ let message = logMessageCallback({
+ hosts,
+ localhostUrl: this.getServerUrl("localhost"),
+ options: this.options,
+ version: pkg.version,
+ startupTime: Date.now() - this.start,
+ });
+
+ if(message) {
+ this.logger.info(message);
+ }
+
+ this.#readyResolve();
+ });
+
+ return this._server;
+ }
+
+ async ready() {
+ return this.#readyPromise;
+ }
+
+ _serverListen(port) {
+ this.server.listen({
+ port,
+ });
+ }
+
+ getServerPath(pathname) {
+ // duplicate slashes
+ if(this.options.pathPrefix.endsWith("/") && pathname.startsWith("/")) {
+ pathname = pathname.slice(1);
+ }
+ return `${this.options.pathPrefix}${pathname}`;
+ }
+
+ getServerUrlRaw(host, pathname = "", isRaw = true) {
+ if(!this._server || !this._serverProtocol) {
+ throw new Error("Access to server url not yet available.");
+ }
+
+ let address = this._server.address();
+ if(!address?.port) {
+ throw new Error("Access to server port not yet available.");
+ }
+
+ return `${this._serverProtocol}//${host}:${address.port}${isRaw ? pathname : this.getServerPath(pathname)}`;
+ }
+
+ getServerUrl(host, pathname = "") {
+ return this.getServerUrlRaw(host, pathname, false);
+ }
+
+ async getPort() {
+ return new Promise(resolve => {
+ this.server.on("listening", (e) => {
+ let { port } = this._server.address();
+ resolve(port);
+ });
+ })
+ }
+
+ serve(port) {
+ this.getWatcher();
+
+ this._serverListen(port);
+ }
+
+ _serverErrorHandler(err) {
+ if (err.code == "EADDRINUSE") {
+ this.logger.error(`Server error: Port in use ${err.port}`);
+ } else {
+ this.logger.error(`Server error: ${err.message}`);
+ }
+ }
+
+ // Websocket Notifications
+ setupReloadNotifier() {
+ let options = {};
+ if(this.options.reloadPort) {
+ options.port = this.options.reloadPort;
+ } else {
+ // includes the port
+ options.server = this.server;
+ }
+
+ let updateServer = new WebSocketServer(options);
+
+ updateServer.on("connection", (ws) => {
+ this.sendUpdateNotification({
+ type: "eleventy.status",
+ status: "connected",
+ });
+ });
+
+ updateServer.on("error", (err) => {
+ this._serverErrorHandler(err);
+ });
+
+ this.updateServer = updateServer;
+ }
+
+ // Broadcasts to all open browser windows
+ sendUpdateNotification(obj) {
+ if(!this.updateServer?.clients) {
+ return;
+ }
+
+ for(let client of this.updateServer.clients) {
+ if (client.readyState === WebSocket.OPEN) {
+ client.send(JSON.stringify(obj));
+ }
+ }
+ }
+
+ // Helper for promisifying close methods with callbacks, like http.Server or ws.WebSocketServer.
+ async _closeServer(server) {
+ return new Promise((resolve, reject) => {
+ server.close(err => {
+ if (err) {
+ reject(err);
+ }
+ resolve();
+ });
+
+ // Note: this method won’t exist for updateServer
+ if("closeAllConnections" in server) {
+ // Node 18.2+
+ server.closeAllConnections();
+ }
+ });
+ }
+
+ async close() {
+ // Prevent multiple invocations.
+ if (this.#serverClosing) {
+ return this.#serverClosing;
+ }
+
+ // TODO would be awesome to set a delayed redirect when port changed to redirect to new _server_
+ this.sendUpdateNotification({
+ type: "eleventy.status",
+ status: "disconnected",
+ });
+
+ let promises = []
+ if(this.updateServer) {
+ // Close all existing WS connections.
+ this.updateServer?.clients.forEach(socket => socket.close());
+ promises.push(this._closeServer(this.updateServer));
+ }
+
+ if(this._server?.listening) {
+ promises.push(this._closeServer(this.server));
+ }
+
+ if(this.#watcher) {
+ promises.push(this.#watcher.close());
+ this.#watcher = undefined;
+ }
+
+ this.#serverClosing = Promise.all(promises).then(() => {
+ this.#serverState = "CLOSED";
+ this.#serverClosing = undefined;
+ });
+
+ this.#serverState = "CLOSING";
+
+ return this.#serverClosing;
+ }
+
+ sendError({ error }) {
+ this.sendUpdateNotification({
+ type: "eleventy.error",
+ // Thanks https://stackoverflow.com/questions/18391212/is-it-not-possible-to-stringify-an-error-using-json-stringify
+ error: JSON.stringify(error, Object.getOwnPropertyNames(error)),
+ });
+ }
+
+ // reverse of mapUrlToFilePath
+ // /resource/ <= /resource/index.html
+ // /resource <= resource.html
+ getUrlsFromFilePath(path) {
+ if(this.dir === ".") {
+ path = `/${path}`
+ } else {
+ path = path.slice(this.dir.length);
+ }
+
+ let urls = [];
+ urls.push(path);
+
+ if(path.endsWith(`/${this.options.indexFileName}`)) {
+ urls.push(path.slice(0, -1 * this.options.indexFileName.length));
+ } else if(path.endsWith(".html")) {
+ urls.push(path.slice(0, -1 * ".html".length));
+ }
+
+ return urls;
+ }
+
+ // returns [{ url, inputPath, content }]
+ getBuildTemplatesFromFilePath(path) {
+ // We can skip this for non-html files, dom-diffing will not apply
+ if(!path.endsWith(".html")) {
+ return [];
+ }
+
+ let urls = this.getUrlsFromFilePath(path);
+ let obj = {
+ inputPath: path,
+ content: fs.readFileSync(path, "utf8"),
+ }
+
+ return urls.map(url => {
+ return Object.assign({ url }, obj);
+ });
+ }
+
+ reloadFiles(files, useDomDiffingForHtml = true) {
+ if(!Array.isArray(files)) {
+ throw new Error("reloadFiles method requires an array of file paths.");
+ }
+
+ let subtype;
+ if(!files.some((entry) => !entry.endsWith(".css"))) {
+ // only if all changes are css changes
+ subtype = "css";
+ }
+
+ let templates = [];
+ if(useDomDiffingForHtml && this.options.domDiff) {
+ for(let filePath of files) {
+ if(!filePath.endsWith(".html")) {
+ continue;
+ }
+ for(let templateEntry of this.getBuildTemplatesFromFilePath(filePath)) {
+ templates.push(templateEntry);
+ }
+ }
+ }
+
+ this.reload({
+ files,
+ subtype,
+ build: {
+ templates
+ }
+ });
+ }
+
+ reload(event = {}) {
+ let { subtype, files, build } = event;
+ if (build?.templates) {
+ build.templates = build.templates
+ .filter(entry => {
+ if(!this.options.domDiff) {
+ // Don’t include any files if the dom diffing option is disabled
+ return false;
+ }
+
+ // Filter to only include watched templates that were updated
+ return (files || []).includes(entry.inputPath);
+ });
+ }
+
+ this.sendUpdateNotification({
+ type: "eleventy.reload",
+ subtype,
+ files,
+ build,
+ });
+ }
+}
+
+module.exports = EleventyDevServer;