Website: create new infra for develop+deploy

Create two scripts, run-build.mjs and run-server.mjs, which perform
different but related tasks:

* run-build.mjs copies website files into a new directory, ignoring
  files we don't want to deploy. This replaces prepare-for-publish.
* run-server.mjs serves files over HTTP similar to what would be seen by
  run-build.mjs (e.g. ignored files aren't served). This replaces
  manually running `python3 -m http.server 9001`.

Also, because I couldn't help myself, allow index.html to be written
with EJS templating. This feature isn't used yet, but will be used in
the future to factor duplication between index.html files.

Author: strager

.github/workflows/deploy-website.yml

@@ -25,8 +25,11 @@ jobs:
           name: web-demo-dist-${{ github.event.inputs.build_commit_id }}
           path: website/public/demo/dist/
           workflow: build-and-test-web-demo.yml
+
+      - name: install build dependencies
+        run: cd website && yarn install --production
       - name: build site
-        run: website/prepare-for-publish ./website-build
+        run: cd website && yarn build
 
       - name: publish to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
@@ -36,7 +39,7 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           keep_files: false
           publish_branch: gh-pages
-          publish_dir: ./website-build
+          publish_dir: ./website/www
 
 # quick-lint-js finds bugs in JavaScript programs.
 # Copyright (C) 2020  Matthew Glazar

website/.gitignore

@@ -1,2 +1,3 @@
 /build-emscripten/
 /node_modules/
+/www/

website/README.md

@@ -1,3 +1,30 @@
 # quick-lint-js website
 
 This directory contains the source code for quick-lint-js' website.
+
+## Developing
+
+Hack on the website locally by running a local web server:
+
+    $ cd website  # Navigate to this directory.
+    $ yarn        # Install dependencies.
+    $ yarn start
+    Server running: http://127.0.0.1:9001/
+
+Open after starting the local web server, open http://127.0.0.1:9001/ in your
+browser.
+
+If you want to work on the demo, see [demo documentation](demo/README.md).
+
+## Packaging for deployment
+
+Prepare the website for publishing on GitHub pages by running `yarn build`:
+
+    $ cd website  # Navigate to this directory.
+    $ yarn        # Install dependencies.
+    $ yarn build
+
+Look at the copied and generated files in `website/www/`.
+
+For instructions on deploying to quick-lint-js.com, see the [release
+documentation](docs/RELEASE.md).

website/package.json

@@ -1,9 +1,21 @@
 {
   "scripts": {
+    "build": "node --experimental-modules run-build.mjs www",
     "fmt": "prettier --write '**/*.css' '**/*.html' '**/*.js' '**/*.mjs'",
+    "start": "node --experimental-modules run-server.mjs 9001",
     "test": "node --experimental-modules run-tests.mjs"
   },
+  "engines": {
+    "node": ">=14.14.0"
+  },
+  "dependencies": {
+    "ejs": "^3.1.6",
+    "express": "^4.17.1",
+    "mime": "^2.5.2",
+    "morgan": "^1.10.0"
+  },
   "devDependencies": {
+    "axios": "^0.21.1",
     "colors": "^1.4.0",
     "jasmine": "^3.7.0",
     "jsdom": "16.4.0",

website/prepare-for-publish

@@ -0,0 +1,105 @@
+// Copyright (C) 2020  Matthew Glazar
+// See end of file for extended copyright information.
+
+import fs from "fs";
+import path from "path";
+import url from "url";
+import { makeBuildInstructionsAsync } from "./src/build.mjs";
+import { Router, makeHTMLRedirect } from "./src/router.mjs";
+import { websiteConfig } from "./src/config.mjs";
+
+let __filename = url.fileURLToPath(import.meta.url);
+let __dirname = path.dirname(__filename);
+
+async function mainAsync() {
+  let { targetDirectory } = parseArguments(process.argv.slice(2));
+
+  let wwwRootPath = websiteConfig.wwwRootPath;
+  let instructions = await makeBuildInstructionsAsync(websiteConfig);
+  let router = new Router(websiteConfig);
+
+  async function copyFileAsync(fromPath, toPath) {
+    let from = path.relative("", path.resolve(wwwRootPath, fromPath));
+    let to = path.relative("", path.resolve(targetDirectory, toPath));
+    console.log(`copy: ${from} -> ${to}`);
+    await fs.promises.mkdir(path.dirname(to), { recursive: true });
+    await fs.promises.writeFile(to, await fs.promises.readFile(from));
+  }
+
+  for (let instruction of instructions) {
+    switch (instruction.type) {
+      case "copy":
+        await copyFileAsync(instruction.path, instruction.path);
+        break;
+
+      case "copy-to":
+        await copyFileAsync(
+          instruction.sourcePath,
+          instruction.destinationPath
+        );
+        break;
+
+      case "build-ejs":
+        let ejsPath = path.join(wwwRootPath, instruction.sourcePath);
+        let outPath = path.join(targetDirectory, instruction.destinationPath);
+        console.log(`build EJS: ${ejsPath} -> ${outPath}`);
+        await fs.promises.mkdir(path.dirname(outPath), { recursive: true });
+        let out = await router.renderEJSFile(ejsPath);
+        fs.promises.writeFile(outPath, out);
+        break;
+
+      case "html-redirect":
+        let htmlPath = path.join(targetDirectory, instruction.htmlPath);
+        await fs.promises.mkdir(path.dirname(htmlPath), { recursive: true });
+        console.log(
+          `redirect: ${htmlPath} -> ${instruction.redirectTargetURL}`
+        );
+        await fs.promises.writeFile(
+          htmlPath,
+          makeHTMLRedirect(instruction.htmlPath, instruction.redirectTargetURL)
+        );
+        break;
+
+      default:
+        throw new Error(
+          `Unexpected type from makeBuildInstructionsAsync: ${instruction.type}`
+        );
+    }
+  }
+}
+
+function parseArguments(args) {
+  let targetDirectory;
+  switch (args.length) {
+    case 1:
+      targetDirectory = args[0];
+      break;
+
+    default:
+      throw new Error("Expected exactly 1 argument");
+  }
+  return { targetDirectory };
+}
+
+mainAsync().catch((error) => {
+  console.error(error.stack);
+  process.exit(1);
+});
+
+// quick-lint-js finds bugs in JavaScript programs.
+// Copyright (C) 2020  Matthew Glazar
+//
+// This file is part of quick-lint-js.
+//
+// quick-lint-js is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// quick-lint-js is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with quick-lint-js.  If not, see <https://www.gnu.org/licenses/>.

website/run-build.mjs

@@ -0,0 +1,77 @@
+// Copyright (C) 2020  Matthew Glazar
+// See end of file for extended copyright information.
+
+import express from "express";
+import http from "http";
+import morgan from "morgan";
+import path from "path";
+import url from "url";
+import { listenAsync, urlFromServerAddress } from "./src/net.mjs";
+import { makeServer } from "./src/server.mjs";
+import { websiteConfig } from "./src/config.mjs";
+
+let __filename = url.fileURLToPath(import.meta.url);
+let __dirname = path.dirname(__filename);
+
+async function mainAsync() {
+  let { host, port } = parseArguments(process.argv.slice(2));
+
+  let app = express();
+  app.use(morgan("dev"));
+  app.use(makeServer(websiteConfig));
+
+  let server = http.createServer(app);
+  await listenAsync(server, { host: host, port: port });
+  console.log(`Server running: ${urlFromServerAddress(server.address())}`);
+}
+
+function parseArguments(args) {
+  let host = "localhost";
+  let port = 0;
+  switch (args.length) {
+    case 0:
+      break;
+
+    case 1:
+      port = parseInt(args[0]);
+      if (isNaN(port)) {
+        throw new Error(`Expected port number, but got: ${args[0]}`);
+      }
+      break;
+
+    case 2:
+      host = args[0];
+      port = parseInt(args[1]);
+      if (isNaN(port)) {
+        throw new Error(`Expected port number, but got: ${args[1]}`);
+      }
+      break;
+
+    default:
+      throw new Error("Too many arguments; expected 0, 1, or 2");
+  }
+  return { host, port };
+}
+
+mainAsync().catch((error) => {
+  console.error(error.stack);
+  process.exit(1);
+});
+
+// quick-lint-js finds bugs in JavaScript programs.
+// Copyright (C) 2020  Matthew Glazar
+//
+// This file is part of quick-lint-js.
+//
+// quick-lint-js is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// quick-lint-js is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with quick-lint-js.  If not, see <https://www.gnu.org/licenses/>.