Compare commits
No commits in common. "v0.1.4" and "main" have entirely different histories.
50 changed files with 2851 additions and 4937 deletions
|
|
@ -6,3 +6,4 @@ indent_size = 4
|
|||
charset = utf-8
|
||||
trim_trailing_whitespace = true
|
||||
insert_final_newline = true
|
||||
end_of_line = lf
|
||||
|
|
|
|||
|
|
@ -1 +0,0 @@
|
|||
node_modules
|
||||
23
.eslintrc
23
.eslintrc
|
|
@ -1,23 +0,0 @@
|
|||
{
|
||||
"root": true,
|
||||
"parser": "@typescript-eslint/parser",
|
||||
"plugins": ["@typescript-eslint", "prettier"],
|
||||
"extends": [
|
||||
"eslint:recommended",
|
||||
"plugin:@typescript-eslint/eslint-recommended",
|
||||
"plugin:@typescript-eslint/recommended",
|
||||
"plugin:react/recommended",
|
||||
"plugin:prettier/recommended"
|
||||
],
|
||||
"settings": {
|
||||
"react": {
|
||||
"pragma": "createElement"
|
||||
}
|
||||
},
|
||||
"rules": {
|
||||
"@typescript-eslint/no-namespace": "off",
|
||||
"@typescript-eslint/ban-types": "off",
|
||||
"react/prop-types": "off",
|
||||
"react/jsx-key": "off"
|
||||
}
|
||||
}
|
||||
38
.forgejo/workflows/ci.yml
Normal file
38
.forgejo/workflows/ci.yml
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
branches: [main]
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
check:
|
||||
runs-on: node-24
|
||||
steps:
|
||||
- uses: https://code.forgejo.org/actions/checkout@v4
|
||||
- name: Cache npm dependencies
|
||||
uses: https://code.forgejo.org/actions/cache@v4
|
||||
with:
|
||||
path: ~/.npm
|
||||
key: node-24-${{ hashFiles('**/package-lock.json') }}
|
||||
- run: npm ci
|
||||
- run: npm run check
|
||||
|
||||
build:
|
||||
needs: check
|
||||
strategy:
|
||||
matrix:
|
||||
node: [22, 24]
|
||||
runs-on: node-${{ matrix.node }}
|
||||
steps:
|
||||
- uses: https://code.forgejo.org/actions/checkout@v4
|
||||
- name: Cache npm dependencies
|
||||
uses: https://code.forgejo.org/actions/cache@v4
|
||||
with:
|
||||
path: ~/.npm
|
||||
key: node-${{ matrix.node }}-${{ hashFiles('**/package-lock.json') }}
|
||||
- run: npm ci
|
||||
- run: npm run build
|
||||
- run: npm test
|
||||
2
.gitattributes
vendored
Normal file
2
.gitattributes
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
# Ensure that git uses lf line-endings for text files.
|
||||
* text=auto eol=lf
|
||||
2
.nvmrc
2
.nvmrc
|
|
@ -1 +1 @@
|
|||
lts/erbium
|
||||
18
|
||||
|
|
|
|||
10
.travis.yml
10
.travis.yml
|
|
@ -1,10 +0,0 @@
|
|||
language: node_js
|
||||
os:
|
||||
- linux
|
||||
- osx
|
||||
- windows
|
||||
node_js:
|
||||
- node
|
||||
- lts/*
|
||||
- 12
|
||||
- 10
|
||||
16
CHANGELOG.md
16
CHANGELOG.md
|
|
@ -1,5 +1,21 @@
|
|||
# Changelog
|
||||
|
||||
## [0.2.0](https://github.com/websnacksjs/websnacks/releases/tag/v0.2.0) (2021-02-28)
|
||||
|
||||
### Features
|
||||
|
||||
- add dangerouslySetInnerHTML attr ([#15](https://github.com/websnacksjs/websnacks/issues/15), [3f356dd](https://github.com/websnacksjs/websnacks/commit/3f356ddfeeb38e8a60c32d26c3e9e8715d0246c3))
|
||||
|
||||
### Misc
|
||||
|
||||
- **BREAKING CHANGE** update node-watch optional dep to major v0.7.1
|
||||
|
||||
## [0.1.5](https://github.com/websnacksjs/websnacks/releases/tag/v0.1.5) (2020-06-14)
|
||||
|
||||
### Bugfixes
|
||||
|
||||
- stack size exceed error on purging module cache ([32eee9b](https://github.com/websnacksjs/websnacks/commit/32eee9b2e04475452905e3478f0fa2a21ad3ccf4))
|
||||
|
||||
## [0.1.4](https://github.com/websnacksjs/websnacks/releases/tag/v0.1.4) (2020-06-10)
|
||||
|
||||
### Bugfixes
|
||||
|
|
|
|||
19
README.md
19
README.md
|
|
@ -1,20 +1,9 @@
|
|||
# websnacks: Minimal Dependency Server-Side JSX for Static Sites
|
||||
|
||||
<div>
|
||||
|
||||
[](https://www.npmjs.com/package/@websnacksjs/websnacks "NPM release")
|
||||
[](https://www.mozilla.org/en-US/MPL/2.0/FAQ/ "License info")
|
||||
[](https://travis-ci.com/websnacksjs/websnacks "Build status for master branch")
|
||||
|
||||
</div>
|
||||
|
||||
<div>
|
||||
|
||||
[](https://david-dm.org/websnacksjs/websnacks "Dependency status")
|
||||
[](https://david-dm.org/websnacksjs/websnacks?type=optional "Optional dependency status")
|
||||
[](https://david-dm.org/websnacksjs/websnacks?type=dev "Dev dependency status")
|
||||
|
||||
</div>
|
||||
[](https://www.npmjs.com/package/@websnacksjs/websnacks "NPM release")
|
||||
[](https://www.mozilla.org/en-US/MPL/2.0/FAQ/ "License info")
|
||||
[](https://git.theinnerlimit.ch/websnacksjs/websnacks/actions?workflow=ci.yml "CI status for main branch")
|
||||
|
||||
|
||||
Develop fully static websites using typesafe JSX templates on the server without the complex build system and dependency management of server-side rendered React frameworks.
|
||||
|
||||
|
|
|
|||
41
biome.json
Normal file
41
biome.json
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"$schema": "https://biomejs.dev/schemas/2.4.14/schema.json",
|
||||
"files": {
|
||||
"includes": ["**", "!dist", "!node_modules", "!.temp"]
|
||||
},
|
||||
"assist": {
|
||||
"enabled": true,
|
||||
"actions": {
|
||||
"source": {
|
||||
"organizeImports": "on"
|
||||
}
|
||||
}
|
||||
},
|
||||
"formatter": {
|
||||
"enabled": true
|
||||
},
|
||||
"linter": {
|
||||
"enabled": true,
|
||||
"rules": {
|
||||
"recommended": true,
|
||||
"style": {
|
||||
"useShorthandFunctionType": "off"
|
||||
},
|
||||
"correctness": {
|
||||
"useJsxKeyInIterable": "off"
|
||||
}
|
||||
}
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
"includes": ["test/**"],
|
||||
"linter": {
|
||||
"rules": {
|
||||
"a11y": {
|
||||
"useHtmlLang": "off"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -1,5 +1,9 @@
|
|||
import { stylesheet } from "typestyle";
|
||||
import { Component, createElement } from "websnacks";
|
||||
import {
|
||||
type Component,
|
||||
// biome-ignore lint/correctness/noUnusedImports: required to support JSX
|
||||
createElement,
|
||||
} from "websnacks";
|
||||
|
||||
const styles = stylesheet({
|
||||
header: {
|
||||
|
|
|
|||
|
|
@ -1,6 +1,10 @@
|
|||
import { normalize } from "csstips";
|
||||
import { stylesheet } from "typestyle";
|
||||
import { Component, createElement } from "websnacks";
|
||||
import {
|
||||
type Component,
|
||||
// biome-ignore lint/correctness/noUnusedImports: required to support JSX
|
||||
createElement,
|
||||
} from "websnacks";
|
||||
|
||||
import { stylesheetPath } from "../config";
|
||||
import { Header } from "./header";
|
||||
|
|
@ -46,10 +50,7 @@ export const Layout: Component<LayoutProps> = ({ children, headline }) => (
|
|||
{headline && ` | ${headline}`}
|
||||
</title>
|
||||
<meta name="description" content="" />
|
||||
<meta
|
||||
name="viewport"
|
||||
content="width=device-width, initial-scale=1"
|
||||
/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="stylesheet" href={stylesheetPath} />
|
||||
</head>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,9 @@
|
|||
import { stylesheet } from "typestyle";
|
||||
import { Component, createElement } from "websnacks";
|
||||
import {
|
||||
type Component,
|
||||
// biome-ignore lint/correctness/noUnusedImports: required to support JSX
|
||||
createElement,
|
||||
} from "websnacks";
|
||||
|
||||
const styles = stylesheet({
|
||||
navbar: {
|
||||
|
|
|
|||
1367
examples/personal-site/package-lock.json
generated
1367
examples/personal-site/package-lock.json
generated
File diff suppressed because it is too large
Load diff
|
|
@ -1,5 +1,6 @@
|
|||
{
|
||||
"name": "websnacks-example-personal-site",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"build": "websnacks -r ts-node/register build",
|
||||
"dev": "websnacks -r ts-node/register dev"
|
||||
|
|
|
|||
|
|
@ -1,22 +1,25 @@
|
|||
import { Component, createElement } from "websnacks";
|
||||
import {
|
||||
type Component,
|
||||
// biome-ignore lint/correctness/noUnusedImports: required to support JSX
|
||||
createElement,
|
||||
} from "websnacks";
|
||||
|
||||
import { Layout } from "../components/layout";
|
||||
|
||||
export const page: Component = () => (
|
||||
<Layout>
|
||||
<p>
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur
|
||||
dapibus condimentum mauris et egestas. Quisque orci nulla, consequat
|
||||
at erat laoreet, malesuada sodales nisi. Sed in lorem semper lorem
|
||||
placerat fermentum a id arcu. Curabitur non aliquam tellus, sed
|
||||
auctor lacus. Nunc sit amet lectus ultrices, sodales nisl sit amet,
|
||||
luctus nisl. Nunc mollis imperdiet quam, eget sollicitudin leo
|
||||
tincidunt vel. Duis felis dui, imperdiet aliquam bibendum sed,
|
||||
auctor et dolor. Vivamus odio ipsum, venenatis in felis sed, aliquam
|
||||
dictum turpis. Pellentesque pellentesque consequat neque, id
|
||||
imperdiet diam molestie nec. Nullam ut vestibulum est. Pellentesque
|
||||
orci urna, porta vel porta quis, semper ut enim. Donec sit amet urna
|
||||
arcu. Nam tincidunt fermentum ligula a pharetra.{" "}
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur dapibus
|
||||
condimentum mauris et egestas. Quisque orci nulla, consequat at erat
|
||||
laoreet, malesuada sodales nisi. Sed in lorem semper lorem placerat
|
||||
fermentum a id arcu. Curabitur non aliquam tellus, sed auctor lacus. Nunc
|
||||
sit amet lectus ultrices, sodales nisl sit amet, luctus nisl. Nunc mollis
|
||||
imperdiet quam, eget sollicitudin leo tincidunt vel. Duis felis dui,
|
||||
imperdiet aliquam bibendum sed, auctor et dolor. Vivamus odio ipsum,
|
||||
venenatis in felis sed, aliquam dictum turpis. Pellentesque pellentesque
|
||||
consequat neque, id imperdiet diam molestie nec. Nullam ut vestibulum est.
|
||||
Pellentesque orci urna, porta vel porta quis, semper ut enim. Donec sit
|
||||
amet urna arcu. Nam tincidunt fermentum ligula a pharetra.{" "}
|
||||
</p>
|
||||
</Layout>
|
||||
);
|
||||
|
|
|
|||
|
|
@ -1,5 +1,9 @@
|
|||
import { stylesheet } from "typestyle";
|
||||
import { Component, createElement } from "websnacks";
|
||||
import {
|
||||
type Component,
|
||||
// biome-ignore lint/correctness/noUnusedImports: required to support JSX
|
||||
createElement,
|
||||
} from "websnacks";
|
||||
|
||||
import { Layout } from "../components/layout";
|
||||
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
import { promises as fs } from "fs";
|
||||
import * as path from "path";
|
||||
import { Config } from "websnacks";
|
||||
import { promises as fs } from "node:fs";
|
||||
import * as path from "node:path";
|
||||
import type { Config } from "websnacks";
|
||||
|
||||
import { stylesheetPath } from "./config";
|
||||
|
||||
const config: Config = {
|
||||
const _config: Config = {
|
||||
// Watch additional files and folders for changes when the dev server is
|
||||
// running.
|
||||
watch: ["components/", "config.ts"],
|
||||
|
|
@ -23,4 +23,3 @@ const config: Config = {
|
|||
},
|
||||
},
|
||||
};
|
||||
export = config;
|
||||
|
|
|
|||
2017
package-lock.json
generated
2017
package-lock.json
generated
File diff suppressed because it is too large
Load diff
26
package.json
26
package.json
|
|
@ -1,14 +1,15 @@
|
|||
{
|
||||
"name": "@websnacksjs/websnacks",
|
||||
"description": "Minimal dependency server-side JSX for static sites",
|
||||
"version": "0.1.4",
|
||||
"version": "0.2.0",
|
||||
"author": {
|
||||
"name": "M. George Hansen",
|
||||
"email": "mgeorge@technopolitica.com"
|
||||
},
|
||||
"license": "MPL-2.0",
|
||||
"repository": "github:websnacksjs/websnacks",
|
||||
"engines": {
|
||||
"node": ">=10"
|
||||
"node": ">=18"
|
||||
},
|
||||
"main": "dist/index.js",
|
||||
"types": "types.d.ts",
|
||||
|
|
@ -23,6 +24,7 @@
|
|||
],
|
||||
"scripts": {
|
||||
"build": "tsc",
|
||||
"check": "biome check .",
|
||||
"clean": "ts-node scripts/clean.ts",
|
||||
"prepublishOnly": "npm run reset && npm test",
|
||||
"pretest": "npm run build",
|
||||
|
|
@ -34,20 +36,14 @@
|
|||
"test:e2e": "cd test && ts-node --script-mode ./run-e2e.ts"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "~10",
|
||||
"@types/ws": "^7.2.4",
|
||||
"@typescript-eslint/eslint-plugin": "^3.0.2",
|
||||
"@typescript-eslint/parser": "^3.0.2",
|
||||
"eslint": "^7.1.0",
|
||||
"eslint-config-prettier": "^6.11.0",
|
||||
"eslint-plugin-prettier": "^3.1.3",
|
||||
"eslint-plugin-react": "^7.20.0",
|
||||
"prettier": "^2.0.5",
|
||||
"ts-node": "^8.10.2",
|
||||
"typescript": "~3.9.3"
|
||||
"@biomejs/biome": "2.4.14",
|
||||
"@types/node": "~18",
|
||||
"@types/ws": "^8.18.1",
|
||||
"ts-node": "^10.9.2",
|
||||
"typescript": "~4.9.5"
|
||||
},
|
||||
"optionalDependencies": {
|
||||
"node-watch": "^0.6.4",
|
||||
"ws": "^7.3.0"
|
||||
"node-watch": "^0.7.4",
|
||||
"ws": "^8.20.0"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import * as fs from "fs";
|
||||
import * as path from "path";
|
||||
import * as fs from "node:fs";
|
||||
import * as path from "node:path";
|
||||
|
||||
const ROOT_DIR = path.resolve(__dirname, "..");
|
||||
const DIST_DIR = path.join(ROOT_DIR, "dist");
|
||||
|
|
|
|||
24
src/build.ts
24
src/build.ts
|
|
@ -3,12 +3,12 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { promises as fs } from "fs";
|
||||
import * as path from "path";
|
||||
import { promises as fs } from "node:fs";
|
||||
import * as path from "node:path";
|
||||
|
||||
import { Config, ConfigPaths } from "./config";
|
||||
import type { Config, ConfigPaths } from "./config";
|
||||
import { renderPage } from "./render";
|
||||
import { purgeModuleAndDepsFromCache, walkDir } from "./utils";
|
||||
import { decacheModule, walkDir } from "./utils";
|
||||
|
||||
const renderPagesToHtml = async ({
|
||||
pagesDir,
|
||||
|
|
@ -22,21 +22,19 @@ const renderPagesToHtml = async ({
|
|||
}
|
||||
|
||||
// Ensure that we don't cache page modules when running in dev server.
|
||||
purgeModuleAndDepsFromCache(srcPath);
|
||||
decacheModule(srcPath);
|
||||
// eslint-disable-next-line @typescript-eslint/no-var-requires
|
||||
const pageSrc = require(srcPath);
|
||||
if (!("page" in pageSrc)) {
|
||||
throw new Error(
|
||||
`page source at ${srcPath} does not export a "page" variable`
|
||||
`page source at ${srcPath} does not export a "page" variable`,
|
||||
);
|
||||
}
|
||||
let compiledHtml;
|
||||
let compiledHtml: string;
|
||||
try {
|
||||
compiledHtml = renderPage(pageSrc.page());
|
||||
} catch (error) {
|
||||
throw new Error(
|
||||
`failed to compile ${srcPath}: ${error.stack ?? error}`
|
||||
);
|
||||
throw new Error(`failed to compile ${srcPath}: ${error}`);
|
||||
}
|
||||
const relPath = path.relative(pagesDir, path.dirname(srcPath));
|
||||
let baseName = path.basename(srcPath, ".tsx");
|
||||
|
|
@ -48,7 +46,7 @@ const renderPagesToHtml = async ({
|
|||
(async () => {
|
||||
await fs.mkdir(path.dirname(destPath), { recursive: true });
|
||||
await fs.writeFile(destPath, compiledHtml);
|
||||
})()
|
||||
})(),
|
||||
);
|
||||
}
|
||||
await Promise.all(deferred);
|
||||
|
|
@ -60,7 +58,7 @@ const copyStaticAssets = async ({
|
|||
}: ConfigPaths): Promise<void> => {
|
||||
try {
|
||||
await fs.access(staticAssetsDir);
|
||||
} catch (error) {
|
||||
} catch (_error) {
|
||||
// Static assets folder doesn't exist, so no-op.
|
||||
return;
|
||||
}
|
||||
|
|
@ -73,7 +71,7 @@ const copyStaticAssets = async ({
|
|||
(async () => {
|
||||
await fs.mkdir(path.dirname(destPath), { recursive: true });
|
||||
await fs.copyFile(assetPath, destPath);
|
||||
})()
|
||||
})(),
|
||||
);
|
||||
}
|
||||
await Promise.all(deferred);
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@
|
|||
|
||||
import { renderSite } from "../../build";
|
||||
import { loadConfig } from "../../config";
|
||||
import { Command, UsageError } from "../types";
|
||||
import { type Command, UsageError } from "../types";
|
||||
|
||||
const helpText = `\
|
||||
Usage: websnacks build [ROOT_DIR]
|
||||
|
|
|
|||
|
|
@ -3,14 +3,14 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { existsSync, promises as fs, watch } from "fs";
|
||||
import * as http from "http";
|
||||
import * as net from "net";
|
||||
import * as path from "path";
|
||||
import { existsSync, promises as fs, watch } from "node:fs";
|
||||
import * as http from "node:http";
|
||||
import * as path from "node:path";
|
||||
|
||||
import { renderSite } from "../../build";
|
||||
import { Config, loadConfig } from "../../config";
|
||||
import { Command, UsageError } from "../types";
|
||||
import { type Config, loadConfig } from "../../config";
|
||||
import { isErrnoException } from "../../utils/error";
|
||||
import { type Command, UsageError } from "../types";
|
||||
|
||||
const DEFAULT_SERVER_PORT = 8080;
|
||||
|
||||
|
|
@ -26,11 +26,11 @@ const injectLiveReloadScript = (htmlContents: string, port: number): string =>
|
|||
};
|
||||
</script>
|
||||
</html>
|
||||
`
|
||||
`,
|
||||
);
|
||||
|
||||
const guessMimeType = (ext: string): string => {
|
||||
let mimeType;
|
||||
let mimeType: string;
|
||||
switch (ext) {
|
||||
case ".apng":
|
||||
mimeType = "image/apng";
|
||||
|
|
@ -119,14 +119,16 @@ const guessMimeType = (ext: string): string => {
|
|||
return mimeType;
|
||||
};
|
||||
|
||||
const portFromServer = (server: Pick<net.Server, "address">): number => {
|
||||
const addrInfo = server.address();
|
||||
if (addrInfo == null) {
|
||||
throw new Error(`server address is null (this should never happen!)`);
|
||||
}
|
||||
if (typeof addrInfo === "string") {
|
||||
const portFromServer = (
|
||||
addrInfo: { port: number } | object | string | undefined | null,
|
||||
): number => {
|
||||
if (
|
||||
typeof addrInfo !== "object" ||
|
||||
addrInfo == null ||
|
||||
!("port" in addrInfo)
|
||||
) {
|
||||
throw new Error(
|
||||
`server address is a string (this should never happen!)`
|
||||
"server address does not have a valid port (this should never happen!)",
|
||||
);
|
||||
}
|
||||
return addrInfo.port;
|
||||
|
|
@ -147,10 +149,10 @@ const startHttpServer = async (publicDir: string): Promise<http.Server> => {
|
|||
reqExt = ".html";
|
||||
}
|
||||
|
||||
let contents;
|
||||
let contents: Buffer | string;
|
||||
try {
|
||||
contents = await fs.readFile(path.join(publicDir, reqPath));
|
||||
} catch (error) {
|
||||
} catch (_error) {
|
||||
console.error(`unable to load file ${reqPath}`);
|
||||
res.writeHead(404);
|
||||
res.end();
|
||||
|
|
@ -158,7 +160,7 @@ const startHttpServer = async (publicDir: string): Promise<http.Server> => {
|
|||
}
|
||||
const mimeType = guessMimeType(reqExt);
|
||||
if (mimeType === "text/html") {
|
||||
const port = portFromServer(req.socket);
|
||||
const port = portFromServer(req.socket.address());
|
||||
contents = injectLiveReloadScript(contents.toString("utf8"), port);
|
||||
}
|
||||
res.writeHead(200, {
|
||||
|
|
@ -166,7 +168,7 @@ const startHttpServer = async (publicDir: string): Promise<http.Server> => {
|
|||
});
|
||||
res.end(contents);
|
||||
});
|
||||
const listen = async (port?: number): Promise<string> =>
|
||||
const listen = async (port?: number): Promise<void> =>
|
||||
new Promise((resolve, reject) => {
|
||||
httpServer
|
||||
.once("error", (error) => reject(error))
|
||||
|
|
@ -176,25 +178,33 @@ const startHttpServer = async (publicDir: string): Promise<http.Server> => {
|
|||
try {
|
||||
await listen(DEFAULT_SERVER_PORT);
|
||||
} catch (error) {
|
||||
if (error.code !== "EADDRINUSE") {
|
||||
if (
|
||||
error instanceof Error &&
|
||||
isErrnoException(error) &&
|
||||
error.code !== "EADDRINUSE"
|
||||
) {
|
||||
throw error;
|
||||
}
|
||||
await listen();
|
||||
}
|
||||
const port = portFromServer(httpServer);
|
||||
const port = portFromServer(httpServer.address());
|
||||
console.log(`Listening at http://127.0.0.1:${port}`);
|
||||
return httpServer;
|
||||
};
|
||||
|
||||
const startWebSocketServer = async (
|
||||
httpServer: http.Server
|
||||
httpServer: http.Server,
|
||||
): Promise<import("ws").Server | undefined> => {
|
||||
// Attempt to load the ws module, aborting if it isn't available.
|
||||
let ws;
|
||||
let ws: typeof import("ws");
|
||||
try {
|
||||
ws = await import("ws");
|
||||
} catch (error) {
|
||||
if (error.code !== "MODULE_NOT_FOUND") {
|
||||
if (
|
||||
error instanceof Error &&
|
||||
isErrnoException(error) &&
|
||||
error.code !== "MODULE_NOT_FOUND"
|
||||
) {
|
||||
throw error;
|
||||
}
|
||||
console.warn(`'ws' module not found, live-reloading will be disabled`);
|
||||
|
|
@ -209,7 +219,7 @@ const startWebSocketServer = async (
|
|||
|
||||
const watchFolders = async (
|
||||
folders: string[],
|
||||
listener: (eventType: "update" | "remove", fileName: string) => void
|
||||
listener: (eventType?: "update" | "remove", fileName?: string) => void,
|
||||
): Promise<void> => {
|
||||
// Try to load node-watch, falling back to fs watch if node-watch isn't
|
||||
// available.
|
||||
|
|
@ -218,19 +228,23 @@ const watchFolders = async (
|
|||
nodeWatch.default(folders, { recursive: true }, listener);
|
||||
return;
|
||||
} catch (error) {
|
||||
if (error.code !== "MODULE_NOT_FOUND") {
|
||||
if (
|
||||
error instanceof Error &&
|
||||
isErrnoException(error) &&
|
||||
error.code !== "MODULE_NOT_FOUND"
|
||||
) {
|
||||
throw error;
|
||||
}
|
||||
console.warn(
|
||||
`'node-watch' module not found, falling back to fs.watch (may ` +
|
||||
`result in file watch issues on some OSes)`
|
||||
"result in file watch issues on some OSes)",
|
||||
);
|
||||
}
|
||||
// NOTE: fs.watch has significant cross-platform issues, including
|
||||
// triggering duplicate file events on some systems.
|
||||
for (const folder of folders) {
|
||||
watch(folder, { recursive: true }, (_, fileName) => {
|
||||
listener("update", fileName);
|
||||
listener("update", fileName || undefined);
|
||||
});
|
||||
}
|
||||
};
|
||||
|
|
@ -279,13 +293,15 @@ const devCommand: Command = {
|
|||
const httpServer = await startHttpServer(outDir);
|
||||
const wsServer = await startWebSocketServer(httpServer);
|
||||
const watchedFolders = config.watch.filter((filePath) =>
|
||||
existsSync(filePath)
|
||||
existsSync(filePath),
|
||||
);
|
||||
await watchFolders(watchedFolders, async (event, filePath) => {
|
||||
console.log(`${filePath}:${event} triggering rebuild...`);
|
||||
const filePathForLog = filePath || "<UNKNOWN_FILE>";
|
||||
const eventForLog = event || "<UNKNOWN_EVENT>";
|
||||
console.log(`${filePathForLog}:${eventForLog} triggering rebuild...`);
|
||||
await rebuild();
|
||||
if (wsServer != null) {
|
||||
console.log(`rebuild finished, reloading browsers...`);
|
||||
console.log("rebuild finished, reloading browsers...");
|
||||
for (const ws of wsServer.clients) {
|
||||
ws.send("reload");
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { Command, UsageError } from "./types";
|
||||
import { type Command, UsageError } from "./types";
|
||||
|
||||
const globalHelpText = `\
|
||||
Usage: websnacks [...globalOptions] <command>
|
||||
|
|
@ -24,7 +24,7 @@ interface Options {
|
|||
}
|
||||
|
||||
const parseArgs = (
|
||||
args: string[]
|
||||
args: string[],
|
||||
): { options: Options; commandName?: string; commandArgs: string[] } => {
|
||||
const options: Options = {
|
||||
showHelp: false,
|
||||
|
|
@ -45,8 +45,8 @@ const parseArgs = (
|
|||
const moduleName = args.shift();
|
||||
if (moduleName == null) {
|
||||
throw new UsageError(
|
||||
`-r requires a valid module name`,
|
||||
globalHelpText
|
||||
"-r requires a valid module name",
|
||||
globalHelpText,
|
||||
);
|
||||
}
|
||||
options.require.push(moduleName);
|
||||
|
|
@ -67,7 +67,7 @@ const _main = async (args: string[]): Promise<void> => {
|
|||
return;
|
||||
}
|
||||
if (commandName == null) {
|
||||
throw new UsageError(`must specify a valid command`, globalHelpText);
|
||||
throw new UsageError("must specify a valid command", globalHelpText);
|
||||
}
|
||||
for (const moduleName of options.require) {
|
||||
await import(moduleName);
|
||||
|
|
@ -82,10 +82,7 @@ const _main = async (args: string[]): Promise<void> => {
|
|||
command = await import("./commands/dev");
|
||||
break;
|
||||
default:
|
||||
throw new UsageError(
|
||||
`unknown command ${commandName}`,
|
||||
globalHelpText
|
||||
);
|
||||
throw new UsageError(`unknown command ${commandName}`, globalHelpText);
|
||||
}
|
||||
// NOTE: Should this just delegate to the command?
|
||||
for (const arg of commandArgs) {
|
||||
|
|
|
|||
|
|
@ -37,15 +37,15 @@ export type Element =
|
|||
/**
|
||||
* Custom HTMLElement factory that can be parameterized by props.
|
||||
*/
|
||||
export interface Component<P extends object = {}> {
|
||||
export interface Component<P extends object = Record<string, unknown>> {
|
||||
(
|
||||
props: P & {
|
||||
children?: Element[];
|
||||
}
|
||||
},
|
||||
): HTMLElement;
|
||||
}
|
||||
|
||||
export const Fragment: Component<{}> = ({ children }) => ({
|
||||
export const Fragment: Component = ({ children }) => ({
|
||||
tag: "#fragment",
|
||||
attributes: {},
|
||||
children: children || [],
|
||||
|
|
|
|||
|
|
@ -3,9 +3,9 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import * as path from "path";
|
||||
import * as path from "node:path";
|
||||
|
||||
import { purgeModuleAndDepsFromCache } from "./utils";
|
||||
import { decacheModule } from "./utils";
|
||||
|
||||
/**
|
||||
* Paths used during configuration.
|
||||
|
|
@ -58,15 +58,15 @@ const noop = () => {};
|
|||
* @return Fully-realized configuration.
|
||||
*/
|
||||
export const loadConfig = async (rootDir: string): Promise<Config> => {
|
||||
let configPath;
|
||||
let configPath = "";
|
||||
let userConfig: UserConfig = {};
|
||||
// Attempt to load a websnacks.ts/js file in rootDir.
|
||||
try {
|
||||
configPath = require.resolve(path.resolve(rootDir, "websnacks"));
|
||||
purgeModuleAndDepsFromCache(configPath);
|
||||
decacheModule(configPath);
|
||||
// TODO: validate user config.
|
||||
userConfig = await import(configPath);
|
||||
} catch (error) {
|
||||
} catch (_error) {
|
||||
// Use default config;
|
||||
}
|
||||
const outDir = path.join(rootDir, "public");
|
||||
|
|
@ -74,7 +74,7 @@ export const loadConfig = async (rootDir: string): Promise<Config> => {
|
|||
const staticAssetsDir = path.join(rootDir, "static");
|
||||
|
||||
const watch = [pagesDir, staticAssetsDir];
|
||||
if (configPath != null) {
|
||||
if (configPath) {
|
||||
watch.push(path.relative(rootDir, configPath));
|
||||
}
|
||||
if (userConfig.watch != null) {
|
||||
|
|
@ -97,3 +97,5 @@ export const loadConfig = async (rootDir: string): Promise<Config> => {
|
|||
watch,
|
||||
};
|
||||
};
|
||||
|
||||
export const defineConfig = (userConfig: UserConfig): UserConfig => userConfig;
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { Component, Element, HTMLElement } from "./component";
|
||||
import { HTMLAttributes } from "./jsx";
|
||||
import type { Component, Element, HTMLElement } from "./component";
|
||||
import type { HTMLAttributes } from "./jsx";
|
||||
import { flatDeep } from "./utils";
|
||||
|
||||
/**
|
||||
|
|
@ -38,8 +38,7 @@ export function createElement(
|
|||
...children: Element[]
|
||||
): HTMLElement;
|
||||
export function createElement(
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
type: string | Component<any>,
|
||||
type: string | Component,
|
||||
props: object | null,
|
||||
...children: Element[]
|
||||
): HTMLElement {
|
||||
|
|
@ -54,14 +53,21 @@ export function createElement(
|
|||
}
|
||||
const attrs: Record<string, string | number | boolean> = {};
|
||||
for (const [key, value] of Object.entries(props || {})) {
|
||||
if (key === "dangerouslySetInnerHTML") {
|
||||
if (children.length > 0) {
|
||||
throw new Error(
|
||||
'An element with children may not have a "dangerouslySetInnerHTML" prop since children would be overriden',
|
||||
);
|
||||
}
|
||||
attrs[key] = value.__html;
|
||||
continue;
|
||||
}
|
||||
if (
|
||||
typeof value !== "string" &&
|
||||
typeof value !== "number" &&
|
||||
typeof value !== "boolean"
|
||||
) {
|
||||
console.warn(
|
||||
`non-primitive attribute ${key} = ${JSON.stringify(value)}`
|
||||
);
|
||||
console.warn(`non-primitive attribute ${key} = ${JSON.stringify(value)}`);
|
||||
continue;
|
||||
}
|
||||
attrs[key] = value;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
export { HTMLElement, Component, Fragment } from "./component";
|
||||
export { UserConfig as Config } from "./config";
|
||||
export { Component, Fragment, HTMLElement } from "./component";
|
||||
export { defineConfig, UserConfig as Config } from "./config";
|
||||
export { createElement } from "./create-element";
|
||||
export * from "./jsx";
|
||||
|
|
|
|||
11
src/jsx.ts
11
src/jsx.ts
|
|
@ -4,7 +4,7 @@
|
|||
*/
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
||||
import { HTMLElement } from "./component";
|
||||
import type { HTMLElement } from "./component";
|
||||
|
||||
export interface RdfaAttributes {
|
||||
about?: string;
|
||||
|
|
@ -25,7 +25,14 @@ export interface MicrodataAttributes {
|
|||
itemRef?: string;
|
||||
}
|
||||
|
||||
export interface HTMLAttributes extends RdfaAttributes, MicrodataAttributes {
|
||||
export interface SetInnerHtmlAttributes {
|
||||
dangerouslySetInnerHTML?: { __html: string };
|
||||
}
|
||||
|
||||
export interface HTMLAttributes
|
||||
extends RdfaAttributes,
|
||||
MicrodataAttributes,
|
||||
SetInnerHtmlAttributes {
|
||||
accept?: string;
|
||||
acceptCharset?: string;
|
||||
accessKey?: string;
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { Element, HTMLElement } from "./component";
|
||||
import type { Element, HTMLElement } from "./component";
|
||||
|
||||
const HTML_ESCAPES: { [char: string]: string } = {
|
||||
"&": "&",
|
||||
|
|
@ -34,9 +34,13 @@ const renderElement = (elem: Element): string => {
|
|||
|
||||
let output = "";
|
||||
output += startTag(elem);
|
||||
if (elem.attributes.dangerouslySetInnerHTML != null) {
|
||||
output += elem.attributes.dangerouslySetInnerHTML;
|
||||
} else {
|
||||
for (const child of elem.children) {
|
||||
output += renderElement(child);
|
||||
}
|
||||
}
|
||||
output += endTag(elem);
|
||||
return output;
|
||||
};
|
||||
|
|
@ -55,6 +59,11 @@ const startTag = (elem: HTMLElement): string => {
|
|||
continue;
|
||||
}
|
||||
|
||||
// Ignore the special attr for setting raw inner HTML.
|
||||
if (attrName === "dangerouslySetInnerHTML") {
|
||||
continue;
|
||||
}
|
||||
|
||||
let normalizedAttrName = escapeHtml(attrName.toLowerCase());
|
||||
if (normalizedAttrName === "classname") {
|
||||
normalizedAttrName = "class";
|
||||
|
|
@ -62,9 +71,7 @@ const startTag = (elem: HTMLElement): string => {
|
|||
if (attrValue === true) {
|
||||
output += ` ${normalizedAttrName}=""`;
|
||||
} else {
|
||||
output += ` ${normalizedAttrName}="${escapeAttr(
|
||||
attrValue.toString()
|
||||
)}"`;
|
||||
output += ` ${normalizedAttrName}="${escapeAttr(attrValue.toString())}"`;
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -88,19 +95,19 @@ const endTag = (elem: HTMLElement): string => {
|
|||
* @return Fully rendered HTML document as a string.
|
||||
*/
|
||||
export const renderPage = (rootElem: Element): string => {
|
||||
if (rootElem == undefined) {
|
||||
throw new Error(`root page element cannot be null`);
|
||||
if (rootElem == null) {
|
||||
throw new Error("root page element cannot be null");
|
||||
}
|
||||
if (typeof rootElem !== "object" || !("tag" in rootElem)) {
|
||||
throw new Error(
|
||||
`root page element must be a valid HTMLElement, got ${JSON.stringify(
|
||||
rootElem
|
||||
)}`
|
||||
rootElem,
|
||||
)}`,
|
||||
);
|
||||
}
|
||||
if (rootElem.tag.toLowerCase() !== "html") {
|
||||
throw new Error(
|
||||
`attempted to render page with non-HTML root element ${rootElem.tag}`
|
||||
`attempted to render page with non-HTML root element ${rootElem.tag}`,
|
||||
);
|
||||
}
|
||||
|
||||
|
|
|
|||
71
src/utils.ts
71
src/utils.ts
|
|
@ -1,71 +0,0 @@
|
|||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { promises as fs } from "fs";
|
||||
import * as path from "path";
|
||||
|
||||
/**
|
||||
* Recursively walk a directory, returning the files it finds.
|
||||
*
|
||||
* @param dirPath Path to the directory to walk.
|
||||
*
|
||||
* @return Generator that yields the files found while walking the directory.
|
||||
*/
|
||||
export const walkDir = async function* (
|
||||
dirPath: string
|
||||
): AsyncGenerator<string> {
|
||||
const dirEnts = await fs.readdir(dirPath, { withFileTypes: true });
|
||||
for (const dirEnt of dirEnts) {
|
||||
if (dirEnt.isDirectory()) {
|
||||
yield* walkDir(path.join(dirPath, dirEnt.name));
|
||||
}
|
||||
if (dirEnt.isFile()) {
|
||||
yield path.join(dirPath, dirEnt.name);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Purge cached versions of a node module and all of its dependencies from the
|
||||
* global require cache, ensuring that future imports reload the module from
|
||||
* disk.
|
||||
*
|
||||
* @param modName Name of the module to purge from the require cache.
|
||||
*/
|
||||
export const purgeModuleAndDepsFromCache = (modName: string): void => {
|
||||
const modPath = require.resolve(modName);
|
||||
if (modPath == null) {
|
||||
return;
|
||||
}
|
||||
const mod = require.cache[modPath];
|
||||
if (mod == null) {
|
||||
return;
|
||||
}
|
||||
for (const child of mod.children) {
|
||||
purgeModuleAndDepsFromCache(child.id);
|
||||
}
|
||||
delete require.cache[modPath];
|
||||
};
|
||||
|
||||
export type Flattenable<T> = Array<T | Flattenable<T>>;
|
||||
|
||||
/**
|
||||
* Flatten an arbitrarily-deeply nested array into a flat array.
|
||||
*
|
||||
* @param arr Array to flatten.
|
||||
*
|
||||
* @return Flattened array.
|
||||
*/
|
||||
export const flatDeep = <T>(arr: Flattenable<T>): T[] => {
|
||||
const flattenedArr: T[] = [];
|
||||
for (const val of arr) {
|
||||
if (Array.isArray(val)) {
|
||||
flattenedArr.push(...flatDeep(val));
|
||||
} else {
|
||||
flattenedArr.push(val);
|
||||
}
|
||||
}
|
||||
return flattenedArr;
|
||||
};
|
||||
75
src/utils/decache-module.ts
Normal file
75
src/utils/decache-module.ts
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { isErrnoException } from "./error";
|
||||
|
||||
const resolveModulePath = (importPath: string): string | undefined => {
|
||||
try {
|
||||
return require.resolve(importPath);
|
||||
} catch (error) {
|
||||
if (
|
||||
error instanceof Error &&
|
||||
isErrnoException(error) &&
|
||||
error.code === "MODULE_NOT_FOUND"
|
||||
) {
|
||||
return;
|
||||
}
|
||||
throw error;
|
||||
}
|
||||
};
|
||||
|
||||
const removeParentModuleRef = (mod: NodeModule): void => {
|
||||
const parent = mod.parent;
|
||||
if (parent == null) {
|
||||
return;
|
||||
}
|
||||
|
||||
const siblings = parent.children;
|
||||
const nSiblings = siblings.length;
|
||||
for (let i = nSiblings - 1; i >= 0; i--) {
|
||||
const sibling = siblings[i];
|
||||
if (sibling.id === mod.id) {
|
||||
siblings.splice(i, 1);
|
||||
return;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Clear a module and its dependencies from node's module cache, ensuring that
|
||||
* requiring the module again will reload the code from disk.
|
||||
*
|
||||
* @param importPath Path or name of the module to resolve (same as
|
||||
* {@see require}).
|
||||
*
|
||||
* @throws Error if the module could not be resolved due to filesystem error.
|
||||
*/
|
||||
export const decacheModule = (importPath: string): void => {
|
||||
const modulePath = resolveModulePath(importPath);
|
||||
if (modulePath == null) {
|
||||
return;
|
||||
}
|
||||
|
||||
// DFS the module dependency tree, using iteration to avoid stack size
|
||||
// exceeded exceptions.
|
||||
const modsToCheck: NodeModule[] = [];
|
||||
const visited: Set<string> = new Set();
|
||||
let currentMod: NodeModule | undefined = require.cache[modulePath];
|
||||
while (currentMod != null) {
|
||||
if (visited.has(currentMod.id)) {
|
||||
currentMod = modsToCheck.pop();
|
||||
continue;
|
||||
}
|
||||
|
||||
removeParentModuleRef(currentMod);
|
||||
delete require.cache[currentMod.id];
|
||||
for (const childMod of currentMod.children) {
|
||||
modsToCheck.push(childMod);
|
||||
}
|
||||
|
||||
visited.add(currentMod.id);
|
||||
currentMod = modsToCheck.pop();
|
||||
}
|
||||
};
|
||||
3
src/utils/error.ts
Normal file
3
src/utils/error.ts
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
export const isErrnoException = (
|
||||
error: Error,
|
||||
): error is NodeJS.ErrnoException => "code" in error;
|
||||
51
src/utils/index.ts
Normal file
51
src/utils/index.ts
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { promises as fs } from "node:fs";
|
||||
import * as path from "node:path";
|
||||
|
||||
export { decacheModule } from "./decache-module";
|
||||
|
||||
/**
|
||||
* Recursively walk a directory, returning the files it finds.
|
||||
*
|
||||
* @param dirPath Path to the directory to walk.
|
||||
*
|
||||
* @return Generator that yields the files found while walking the directory.
|
||||
*/
|
||||
export const walkDir = async function* (
|
||||
dirPath: string,
|
||||
): AsyncGenerator<string> {
|
||||
const dirEnts = await fs.readdir(dirPath, { withFileTypes: true });
|
||||
for (const dirEnt of dirEnts) {
|
||||
if (dirEnt.isDirectory()) {
|
||||
yield* walkDir(path.join(dirPath, dirEnt.name));
|
||||
}
|
||||
if (dirEnt.isFile()) {
|
||||
yield path.join(dirPath, dirEnt.name);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
export type Flattenable<T> = Array<T | Flattenable<T>>;
|
||||
|
||||
/**
|
||||
* Flatten an arbitrarily-deeply nested array into a flat array.
|
||||
*
|
||||
* @param arr Array to flatten.
|
||||
*
|
||||
* @return Flattened array.
|
||||
*/
|
||||
export const flatDeep = <T>(arr: Flattenable<T>): T[] => {
|
||||
const flattenedArr: T[] = [];
|
||||
for (const val of arr) {
|
||||
if (Array.isArray(val)) {
|
||||
flattenedArr.push(...flatDeep(val));
|
||||
} else {
|
||||
flattenedArr.push(val);
|
||||
}
|
||||
}
|
||||
return flattenedArr;
|
||||
};
|
||||
|
|
@ -3,11 +3,15 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { promises as fs } from "fs";
|
||||
import * as path from "path";
|
||||
import { promises as fs } from "node:fs";
|
||||
import * as path from "node:path";
|
||||
|
||||
import {
|
||||
npmCmd, runCommand, WEBSNACKS_BIN_PATH, WEBSNACKS_REPO_ROOT, withTempDir
|
||||
npmCmd,
|
||||
runCommand,
|
||||
WEBSNACKS_BIN_PATH,
|
||||
WEBSNACKS_REPO_ROOT,
|
||||
withTempDir,
|
||||
} from "../helpers/e2e";
|
||||
import { testSuite } from "../lib";
|
||||
|
||||
|
|
@ -35,7 +39,7 @@ testSuite("build command", ({ test }) => {
|
|||
}),
|
||||
{
|
||||
encoding: "utf8",
|
||||
}
|
||||
},
|
||||
);
|
||||
await fs.writeFile(
|
||||
path.join(tempDirPath, "websnacks.ts"),
|
||||
|
|
@ -48,7 +52,7 @@ testSuite("build command", ({ test }) => {
|
|||
`,
|
||||
{
|
||||
encoding: "utf8",
|
||||
}
|
||||
},
|
||||
);
|
||||
const pagesPath = path.join(tempDirPath, "pages");
|
||||
await fs.mkdir(pagesPath);
|
||||
|
|
@ -60,7 +64,7 @@ testSuite("build command", ({ test }) => {
|
|||
`,
|
||||
{
|
||||
encoding: "utf8",
|
||||
}
|
||||
},
|
||||
);
|
||||
await fs.writeFile(
|
||||
path.join(tempDirPath, "package.json"),
|
||||
|
|
@ -69,7 +73,7 @@ testSuite("build command", ({ test }) => {
|
|||
websnacks: `file:${WEBSNACKS_REPO_ROOT}`,
|
||||
},
|
||||
}),
|
||||
{ encoding: "utf8" }
|
||||
{ encoding: "utf8" },
|
||||
);
|
||||
await runCommand(npmCmd, ["install", "--silent"], {
|
||||
cwd: tempDirPath,
|
||||
|
|
@ -79,7 +83,7 @@ testSuite("build command", ({ test }) => {
|
|||
[WEBSNACKS_BIN_PATH, "-r", "ts-node/register", "build"],
|
||||
{
|
||||
cwd: tempDirPath,
|
||||
}
|
||||
},
|
||||
);
|
||||
await cmd.complete;
|
||||
});
|
||||
|
|
@ -108,7 +112,7 @@ testSuite("build command", ({ test }) => {
|
|||
}),
|
||||
{
|
||||
encoding: "utf8",
|
||||
}
|
||||
},
|
||||
);
|
||||
const pagesPath = path.join(tempDirPath, "pages");
|
||||
await fs.mkdir(pagesPath);
|
||||
|
|
@ -120,7 +124,7 @@ testSuite("build command", ({ test }) => {
|
|||
`,
|
||||
{
|
||||
encoding: "utf8",
|
||||
}
|
||||
},
|
||||
);
|
||||
await fs.writeFile(
|
||||
path.join(tempDirPath, "package.json"),
|
||||
|
|
@ -129,7 +133,7 @@ testSuite("build command", ({ test }) => {
|
|||
websnacks: `file:${WEBSNACKS_REPO_ROOT}`,
|
||||
},
|
||||
}),
|
||||
{ encoding: "utf8" }
|
||||
{ encoding: "utf8" },
|
||||
);
|
||||
await runCommand(npmCmd, ["install", "--silent"], {
|
||||
cwd: tempDirPath,
|
||||
|
|
@ -139,7 +143,7 @@ testSuite("build command", ({ test }) => {
|
|||
[WEBSNACKS_BIN_PATH, "-r", "ts-node/register", "build"],
|
||||
{
|
||||
cwd: tempDirPath,
|
||||
}
|
||||
},
|
||||
);
|
||||
await cmd.complete;
|
||||
});
|
||||
|
|
|
|||
|
|
@ -3,11 +3,16 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { promises as fs } from "fs";
|
||||
import * as path from "path";
|
||||
import { promises as fs } from "node:fs";
|
||||
import * as path from "node:path";
|
||||
|
||||
import {
|
||||
npmCmd, runCommand, wait, WEBSNACKS_BIN_PATH, WEBSNACKS_REPO_ROOT, withTempDir
|
||||
npmCmd,
|
||||
runCommand,
|
||||
WEBSNACKS_BIN_PATH,
|
||||
WEBSNACKS_REPO_ROOT,
|
||||
wait,
|
||||
withTempDir,
|
||||
} from "../helpers/e2e";
|
||||
import { testSuite } from "../lib";
|
||||
|
||||
|
|
@ -35,7 +40,7 @@ testSuite("dev command", ({ test, expect }) => {
|
|||
}),
|
||||
{
|
||||
encoding: "utf8",
|
||||
}
|
||||
},
|
||||
);
|
||||
await fs.writeFile(
|
||||
path.join(tempDirPath, "websnacks.ts"),
|
||||
|
|
@ -48,7 +53,7 @@ testSuite("dev command", ({ test, expect }) => {
|
|||
`,
|
||||
{
|
||||
encoding: "utf8",
|
||||
}
|
||||
},
|
||||
);
|
||||
const pagesPath = path.join(tempDirPath, "pages");
|
||||
await fs.mkdir(pagesPath);
|
||||
|
|
@ -60,7 +65,7 @@ testSuite("dev command", ({ test, expect }) => {
|
|||
`,
|
||||
{
|
||||
encoding: "utf8",
|
||||
}
|
||||
},
|
||||
);
|
||||
await fs.writeFile(
|
||||
path.join(tempDirPath, "package.json"),
|
||||
|
|
@ -69,7 +74,7 @@ testSuite("dev command", ({ test, expect }) => {
|
|||
websnacks: `file:${WEBSNACKS_REPO_ROOT}`,
|
||||
},
|
||||
}),
|
||||
{ encoding: "utf8" }
|
||||
{ encoding: "utf8" },
|
||||
);
|
||||
await runCommand(npmCmd, ["install", "--silent"], {
|
||||
cwd: tempDirPath,
|
||||
|
|
@ -79,7 +84,7 @@ testSuite("dev command", ({ test, expect }) => {
|
|||
[WEBSNACKS_BIN_PATH, "-r", "ts-node/register", "dev"],
|
||||
{
|
||||
cwd: tempDirPath,
|
||||
}
|
||||
},
|
||||
);
|
||||
// FIXME: This test is a bit brittle due to relying on timeouts.
|
||||
await wait(10_000);
|
||||
|
|
@ -112,7 +117,7 @@ testSuite("dev command", ({ test, expect }) => {
|
|||
}),
|
||||
{
|
||||
encoding: "utf8",
|
||||
}
|
||||
},
|
||||
);
|
||||
const pagesPath = path.join(tempDirPath, "pages");
|
||||
await fs.mkdir(pagesPath);
|
||||
|
|
@ -124,7 +129,7 @@ testSuite("dev command", ({ test, expect }) => {
|
|||
`,
|
||||
{
|
||||
encoding: "utf8",
|
||||
}
|
||||
},
|
||||
);
|
||||
await fs.writeFile(
|
||||
path.join(tempDirPath, "package.json"),
|
||||
|
|
@ -133,7 +138,7 @@ testSuite("dev command", ({ test, expect }) => {
|
|||
websnacks: `file:${WEBSNACKS_REPO_ROOT}`,
|
||||
},
|
||||
}),
|
||||
{ encoding: "utf8" }
|
||||
{ encoding: "utf8" },
|
||||
);
|
||||
await runCommand(npmCmd, ["install", "--silent"], {
|
||||
cwd: tempDirPath,
|
||||
|
|
@ -143,7 +148,7 @@ testSuite("dev command", ({ test, expect }) => {
|
|||
[WEBSNACKS_BIN_PATH, "-r", "ts-node/register", "dev"],
|
||||
{
|
||||
cwd: tempDirPath,
|
||||
}
|
||||
},
|
||||
);
|
||||
// FIXME: This test is a bit brittle due to relying on timeouts.
|
||||
await wait(10_000);
|
||||
|
|
|
|||
|
|
@ -3,10 +3,10 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { ChildProcess, spawn } from "child_process";
|
||||
import { promises as fs } from "fs";
|
||||
import * as os from "os";
|
||||
import * as path from "path";
|
||||
import { type ChildProcess, spawn } from "node:child_process";
|
||||
import { promises as fs } from "node:fs";
|
||||
import * as os from "node:os";
|
||||
import * as path from "node:path";
|
||||
|
||||
/**
|
||||
* Set a timeout and wait for at least the specified number of milliseconds,
|
||||
|
|
@ -36,7 +36,7 @@ const TEMP_PATH = path.resolve(__dirname, "..", "..", ".temp");
|
|||
* directory path as its only argument.
|
||||
*/
|
||||
export const withTempDir = async (
|
||||
op: (tempDirPath: string) => Promise<void> | void
|
||||
op: (tempDirPath: string) => Promise<void> | void,
|
||||
): Promise<void> => {
|
||||
await fs.mkdir(TEMP_PATH, { recursive: true });
|
||||
const tempDirPath = await fs.mkdtemp(`${TEMP_PATH}/`);
|
||||
|
|
@ -57,7 +57,7 @@ export const WEBSNACKS_REPO_ROOT = path.resolve(__dirname, "..", "..");
|
|||
export const WEBSNACKS_BIN_PATH = path.join(
|
||||
WEBSNACKS_REPO_ROOT,
|
||||
"bin",
|
||||
"websnacks.js"
|
||||
"websnacks.js",
|
||||
);
|
||||
|
||||
/**
|
||||
|
|
@ -113,7 +113,7 @@ const DEFAULT_CLI_OPTIONS = {
|
|||
export const runCommand = (
|
||||
command: string,
|
||||
args: string[] = [],
|
||||
options?: CliOptions
|
||||
options?: CliOptions,
|
||||
): AsyncCommand => {
|
||||
const optionsWithDefaults = { ...DEFAULT_CLI_OPTIONS, ...options };
|
||||
const process = spawn(command, args, {
|
||||
|
|
@ -137,9 +137,7 @@ export const runCommand = (
|
|||
threwError = true;
|
||||
process.kill();
|
||||
reject(
|
||||
new Error(
|
||||
`max timeout of ${optionsWithDefaults.timeoutMs}ms reached`
|
||||
)
|
||||
new Error(`max timeout of ${optionsWithDefaults.timeoutMs}ms reached`),
|
||||
);
|
||||
}, optionsWithDefaults.timeoutMs);
|
||||
process.on("exit", (code) => {
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ class ExpectError extends Error {
|
|||
super(
|
||||
`${reason}\n` +
|
||||
`\texpected: ${displayValue(expected)}\n` +
|
||||
`\tactual : ${displayValue(actual)}`
|
||||
`\tactual : ${displayValue(actual)}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
@ -48,9 +48,9 @@ export class Expect<T> {
|
|||
public toEqual(expected: T): void {
|
||||
if (!areEqual(this.value, expected)) {
|
||||
throw new ExpectError(
|
||||
`value does not equal expected`,
|
||||
"value does not equal expected",
|
||||
expected,
|
||||
this.value
|
||||
this.value,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
@ -71,9 +71,9 @@ export class StringExpect extends Expect<string> {
|
|||
public toMatch(pattern: RegExp): void {
|
||||
if (!this.value.match(pattern)) {
|
||||
throw new ExpectError(
|
||||
`value does not match expected pattern`,
|
||||
"value does not match expected pattern",
|
||||
pattern,
|
||||
this.value
|
||||
this.value,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
@ -89,9 +89,9 @@ export class StringExpect extends Expect<string> {
|
|||
public toStartWith(prefix: string): void {
|
||||
if (!this.value.startsWith(prefix)) {
|
||||
throw new ExpectError(
|
||||
`value does not start with expected prefix`,
|
||||
"value does not start with expected prefix",
|
||||
prefix,
|
||||
this.value
|
||||
this.value,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
@ -107,9 +107,9 @@ export class StringExpect extends Expect<string> {
|
|||
public toEndWith(suffix: string): void {
|
||||
if (!this.value.endsWith(suffix)) {
|
||||
throw new ExpectError(
|
||||
`value does not end with expected suffix`,
|
||||
"value does not end with expected suffix",
|
||||
suffix,
|
||||
this.value
|
||||
this.value,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
@ -135,25 +135,21 @@ export class FunctionExpect<T> extends Expect<() => T> {
|
|||
this.value();
|
||||
} catch (error) {
|
||||
if (!(error instanceof Error)) {
|
||||
throw new ExpectError(
|
||||
`function threw non-Error value`,
|
||||
pattern,
|
||||
error
|
||||
);
|
||||
throw new ExpectError("function threw non-Error value", pattern, error);
|
||||
}
|
||||
if (!matches(error.message, pattern)) {
|
||||
throw new ExpectError(
|
||||
`thrown Error's message does not match pattern`,
|
||||
pattern,
|
||||
error.message
|
||||
error.message,
|
||||
);
|
||||
}
|
||||
return;
|
||||
}
|
||||
throw new ExpectError(
|
||||
`function did not throw expected error`,
|
||||
"function did not throw expected error",
|
||||
pattern,
|
||||
null
|
||||
null,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -39,9 +39,7 @@ const runTest = async (test: Test): Promise<TestResult> => {
|
|||
error:
|
||||
error instanceof Error
|
||||
? error
|
||||
: new Error(
|
||||
`threw non-error object: ${displayValue(error)}`
|
||||
),
|
||||
: new Error(`threw non-error object: ${displayValue(error)}`),
|
||||
};
|
||||
}
|
||||
return result;
|
||||
|
|
@ -86,7 +84,7 @@ export interface TestSuiteContext {
|
|||
*/
|
||||
export const testSuite = (
|
||||
suiteName: string,
|
||||
def: (ctx: TestSuiteContext) => void
|
||||
def: (ctx: TestSuiteContext) => void,
|
||||
): void => {
|
||||
const tests: Test[] = [];
|
||||
const test = (name: string, runTest: () => void | Promise<void>): void => {
|
||||
|
|
@ -104,14 +102,14 @@ export const testSuite = (
|
|||
if (testResult.result === "fail") {
|
||||
console.error(
|
||||
`[TEST FAILURE] "${suiteName}": "${testResult.testName}": ` +
|
||||
`${testResult.error.stack}\n`
|
||||
`${testResult.error.stack}\n`,
|
||||
);
|
||||
continue;
|
||||
}
|
||||
passed += 1;
|
||||
}
|
||||
console.info(
|
||||
`[TEST] suite "${suiteName}": ${passed} of ${tests.length} succeeded\n\n`
|
||||
`[TEST] suite "${suiteName}": ${passed} of ${tests.length} succeeded\n\n`,
|
||||
);
|
||||
if (passed < tests.length) {
|
||||
process.exitCode = 1;
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ export const shuffle = <T>(arr: T[]): void => {
|
|||
};
|
||||
|
||||
const areArraysEqual = <T>(a: T[], b: T[]): boolean => {
|
||||
if (a.length != b.length) {
|
||||
if (a.length !== b.length) {
|
||||
return false;
|
||||
}
|
||||
for (let i = 0; i < a.length; i++) {
|
||||
|
|
@ -33,7 +33,7 @@ const areArraysEqual = <T>(a: T[], b: T[]): boolean => {
|
|||
|
||||
const areObjectsEqual = <T extends Record<string, unknown>>(
|
||||
a: T,
|
||||
b: T
|
||||
b: T,
|
||||
): boolean => {
|
||||
const aKeys = Object.keys(a) as Array<keyof T>;
|
||||
const bKeys = Object.keys(b) as Array<keyof T>;
|
||||
|
|
@ -67,7 +67,7 @@ export const areEqual = <T>(a: T, b: T): boolean => {
|
|||
if (typeof a === "object" && typeof b === "object") {
|
||||
return areObjectsEqual(
|
||||
a as Record<string, unknown>,
|
||||
b as Record<string, unknown>
|
||||
b as Record<string, unknown>,
|
||||
);
|
||||
}
|
||||
return a === b;
|
||||
|
|
|
|||
|
|
@ -3,9 +3,9 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { fork } from "child_process";
|
||||
import * as fs from "fs";
|
||||
import * as path from "path";
|
||||
import { fork } from "node:child_process";
|
||||
import * as fs from "node:fs";
|
||||
import * as path from "node:path";
|
||||
|
||||
import { shuffle } from "./lib/utils";
|
||||
|
||||
|
|
|
|||
|
|
@ -3,9 +3,9 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { fork } from "child_process";
|
||||
import * as fs from "fs";
|
||||
import * as path from "path";
|
||||
import { fork } from "node:child_process";
|
||||
import * as fs from "node:fs";
|
||||
import * as path from "node:path";
|
||||
|
||||
import { shuffle } from "./lib/utils";
|
||||
|
||||
|
|
|
|||
|
|
@ -3,14 +3,14 @@
|
|||
* file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
*/
|
||||
|
||||
import { Component, createElement, Fragment } from "../../dist";
|
||||
import { type Component, createElement, Fragment } from "../../dist";
|
||||
import { renderPage } from "../../dist/render";
|
||||
import { testSuite } from "../lib";
|
||||
|
||||
testSuite("renderPage", ({ test, expect }) => {
|
||||
test("throws an Error when root elem is not html tag", () => {
|
||||
expect(() => renderPage(<div />)).toThrowErrorMatching(
|
||||
"attempted to render page with non-HTML root element div"
|
||||
"attempted to render page with non-HTML root element div",
|
||||
);
|
||||
});
|
||||
|
||||
|
|
@ -20,11 +20,9 @@ testSuite("renderPage", ({ test, expect }) => {
|
|||
});
|
||||
|
||||
test("escapes HTML in tag names", () => {
|
||||
const html = renderPage(
|
||||
<html>{createElement("div></div", null)}</html>
|
||||
);
|
||||
const html = renderPage(<html>{createElement("div></div", null)}</html>);
|
||||
expect(html).toEqual(
|
||||
"<!DOCTYPE html><html><div></div></div></div></html>"
|
||||
"<!DOCTYPE html><html><div></div></div></div></html>",
|
||||
);
|
||||
});
|
||||
|
||||
|
|
@ -32,10 +30,10 @@ testSuite("renderPage", ({ test, expect }) => {
|
|||
const html = renderPage(
|
||||
<html>
|
||||
<div className="test" id="1" />
|
||||
</html>
|
||||
</html>,
|
||||
);
|
||||
expect(html).toEqual(
|
||||
'<!DOCTYPE html><html><div class="test" id="1"></div></html>'
|
||||
'<!DOCTYPE html><html><div class="test" id="1"></div></html>',
|
||||
);
|
||||
});
|
||||
|
||||
|
|
@ -48,18 +46,16 @@ testSuite("renderPage", ({ test, expect }) => {
|
|||
<body>
|
||||
<div />
|
||||
</body>
|
||||
</html>
|
||||
</html>,
|
||||
);
|
||||
expect(html).toEqual(
|
||||
"<!DOCTYPE html><html><head><title></title></head><body><div></div></body></html>"
|
||||
"<!DOCTYPE html><html><head><title></title></head><body><div></div></body></html>",
|
||||
);
|
||||
});
|
||||
|
||||
test("renders text nodes", () => {
|
||||
const html = renderPage(<html>There are three lights!</html>);
|
||||
expect(html).toEqual(
|
||||
"<!DOCTYPE html><html>There are three lights!</html>"
|
||||
);
|
||||
expect(html).toEqual("<!DOCTYPE html><html>There are three lights!</html>");
|
||||
});
|
||||
|
||||
test("renders spliced number nodes", () => {
|
||||
|
|
@ -80,10 +76,10 @@ testSuite("renderPage", ({ test, expect }) => {
|
|||
<Light lightN={lightN} />
|
||||
))}{" "}
|
||||
lights!
|
||||
</html>
|
||||
</html>,
|
||||
);
|
||||
expect(html).toEqual(
|
||||
"<!DOCTYPE html><html>There are <div>1</div><div>2</div><div>3</div> lights!</html>"
|
||||
"<!DOCTYPE html><html>There are <div>1</div><div>2</div><div>3</div> lights!</html>",
|
||||
);
|
||||
});
|
||||
|
||||
|
|
@ -97,10 +93,10 @@ testSuite("renderPage", ({ test, expect }) => {
|
|||
const html = renderPage(
|
||||
<html>
|
||||
There are <Light nLights={3} />!
|
||||
</html>
|
||||
</html>,
|
||||
);
|
||||
expect(html).toEqual(
|
||||
"<!DOCTYPE html><html>There are <div>3 lights</div>!</html>"
|
||||
"<!DOCTYPE html><html>There are <div>3 lights</div>!</html>",
|
||||
);
|
||||
});
|
||||
|
||||
|
|
@ -111,10 +107,43 @@ testSuite("renderPage", ({ test, expect }) => {
|
|||
<div>test of</div>
|
||||
<div>fragments</div>
|
||||
</Fragment>
|
||||
</html>
|
||||
</html>,
|
||||
);
|
||||
expect(html).toEqual(
|
||||
"<!DOCTYPE html><html><div>test of</div><div>fragments</div></html>"
|
||||
"<!DOCTYPE html><html><div>test of</div><div>fragments</div></html>",
|
||||
);
|
||||
});
|
||||
|
||||
test("renders unescaped HTML via dangerouslySetInnerHTML", () => {
|
||||
const html = renderPage(
|
||||
<html>
|
||||
<div
|
||||
dangerouslySetInnerHTML={{
|
||||
__html: "<div>red alert!</div>",
|
||||
}}
|
||||
/>
|
||||
</html>,
|
||||
);
|
||||
expect(html).toEqual(
|
||||
"<!DOCTYPE html><html><div><div>red alert!</div></div></html>",
|
||||
);
|
||||
});
|
||||
|
||||
test("throws error when both dangerouslySetInnerHTML and children prop present", () => {
|
||||
expect(() =>
|
||||
renderPage(
|
||||
<html>
|
||||
<div
|
||||
dangerouslySetInnerHTML={{
|
||||
__html: "<div>set phasers to kill</div>",
|
||||
}}
|
||||
>
|
||||
<div>set phasers to stun</div>
|
||||
</div>
|
||||
</html>,
|
||||
),
|
||||
).toThrowErrorMatching(
|
||||
'An element with children may not have a "dangerouslySetInnerHTML" prop since children would be overriden',
|
||||
);
|
||||
});
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue