websnacksjs/websnacks
1
0
Fork 0
Code Issues Pull requests Projects Releases 7 Packages Wiki Activity Actions

chore: update * pin prettier version & format code

Browse source
This commit is contained in:
M. George Hansen 2021-01-02 13:40:18 -08:00
parent 5d05f87768
commit 53d4062e52
Signed by: mgeorgehansen
SSH key fingerprint: SHA256:JlIGiQLPyQ2RHTH3a2oVlb20Xkh9Glr8DUF4YTXHJxM
18 changed files with 93 additions and 78 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.prettierignore Normal file
View file

@ -0,0 +1,2 @@
node_modules/
dist/

6
.prettierrc
View file

@ -1,3 +1,7 @@
{
"endOfLine": "lf"
"endOfLine": "lf",
"singleQuote": false,
"trailingComma": "all",
"tabWidth": 4,
"semi": true
}

6
package-lock.json generated
View file

@ -1219,9 +1219,9 @@
"dev": true
},
"prettier": {
"version": "2.0.5",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.0.5.tgz",
"integrity": "sha512-7PtVymN48hGcO4fGjybyBSIWDsLU4H4XlvOHfq91pz9kkGlonzwTfYkaIEwiRg/dAJF9YlbsduBAgtYLi+8cFg==",
"version": "2.2.1",
"resolved": "https://registry.npmjs.org/prettier/-/prettier-2.2.1.tgz",
"integrity": "sha512-PqyhM2yCjg/oKkFPtTGUojv7gnZAoG80ttl45O6x2Ug/rMJw4wcc9k6aaf2hibP7BGVCCM33gZoGjyvt9mm16Q==",
"dev": true
},
"prettier-linter-helpers": {

2
package.json
View file

@ -43,7 +43,7 @@
"eslint-config-prettier": "^6.11.0",
"eslint-plugin-prettier": "^3.1.3",
"eslint-plugin-react": "^7.20.0",
"prettier": "^2.0.5",
"prettier": "=2.2.1",
"ts-node": "^8.10.2",
"typescript": "~3.9.3"
},

8
src/build.ts
View file

@ -27,7 +27,7 @@ const renderPagesToHtml = async ({
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;
@ -35,7 +35,7 @@ const renderPagesToHtml = async ({
compiledHtml = renderPage(pageSrc.page());
} catch (error) {
throw new Error(
`failed to compile ${srcPath}: ${error.stack ?? error}`
`failed to compile ${srcPath}: ${error.stack ?? error}`,
);
}
const relPath = path.relative(pagesDir, path.dirname(srcPath));
@ -48,7 +48,7 @@ const renderPagesToHtml = async ({
(async () => {
await fs.mkdir(path.dirname(destPath), { recursive: true });
await fs.writeFile(destPath, compiledHtml);
})()
})(),
);
}
await Promise.all(deferred);
@ -73,7 +73,7 @@ const copyStaticAssets = async ({
(async () => {
await fs.mkdir(path.dirname(destPath), { recursive: true });
await fs.copyFile(assetPath, destPath);
})()
})(),
);
}
await Promise.all(deferred);

12
src/cli/commands/dev.ts
View file

@ -26,7 +26,7 @@ const injectLiveReloadScript = (htmlContents: string, port: number): string =>
};
</script>
</html>
`
`,
);
const guessMimeType = (ext: string): string => {
@ -126,7 +126,7 @@ const portFromServer = (server: Pick<net.Server, "address">): number => {
}
if (typeof addrInfo === "string") {
throw new Error(
`server address is a string (this should never happen!)`
`server address is a string (this should never happen!)`,
);
}
return addrInfo.port;
@ -187,7 +187,7 @@ const startHttpServer = async (publicDir: string): Promise<http.Server> => {
};
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;
@ -209,7 +209,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.
@ -223,7 +223,7 @@ const watchFolders = async (
}
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
@ -279,7 +279,7 @@ 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...`);

6
src/cli/index.ts
View file

@ -24,7 +24,7 @@ interface Options {
}
const parseArgs = (
args: string[]
args: string[],
): { options: Options; commandName?: string; commandArgs: string[] } => {
const options: Options = {
showHelp: false,
@ -46,7 +46,7 @@ const parseArgs = (
if (moduleName == null) {
throw new UsageError(
`-r requires a valid module name`,
globalHelpText
globalHelpText,
);
}
options.require.push(moduleName);
@ -84,7 +84,7 @@ const _main = async (args: string[]): Promise<void> => {
default:
throw new UsageError(
`unknown command ${commandName}`,
globalHelpText
globalHelpText,
);
}
// NOTE: Should this just delegate to the command?

2
src/component.ts
View file

@ -41,7 +41,7 @@ export interface Component<P extends object = {}> {
(
props: P & {
children?: Element[];
}
},
): HTMLElement;
}

2
src/create-element.ts
View file

@ -60,7 +60,7 @@ export function createElement(
typeof value !== "boolean"
) {
console.warn(
`non-primitive attribute ${key} = ${JSON.stringify(value)}`
`non-primitive attribute ${key} = ${JSON.stringify(value)}`,
);
continue;
}

8
src/render.ts
View file

@ -63,7 +63,7 @@ const startTag = (elem: HTMLElement): string => {
output += ` ${normalizedAttrName}=""`;
} else {
output += ` ${normalizedAttrName}="${escapeAttr(
attrValue.toString()
attrValue.toString(),
)}"`;
}
}
@ -94,13 +94,13 @@ export const renderPage = (rootElem: Element): string => {
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}`,
);
}

2
src/utils/index.ts
View file

@ -16,7 +16,7 @@ export { decacheModule } from "./decache-module";
* @return Generator that yields the files found while walking the directory.
*/
export const walkDir = async function* (
dirPath: string
dirPath: string,
): AsyncGenerator<string> {
const dirEnts = await fs.readdir(dirPath, { withFileTypes: true });
for (const dirEnt of dirEnts) {

24
test/e2e/build.tsx
View file

@ -7,7 +7,11 @@ import { promises as fs } from "fs";
import * as path from "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;
});

25
test/e2e/dev.tsx
View file

@ -7,7 +7,12 @@ import { promises as fs } from "fs";
import * as path from "path";
import {
npmCmd, runCommand, wait, WEBSNACKS_BIN_PATH, WEBSNACKS_REPO_ROOT, withTempDir
npmCmd,
runCommand,
wait,
WEBSNACKS_BIN_PATH,
WEBSNACKS_REPO_ROOT,
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);

10
test/helpers/e2e.ts
View file

@ -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, {
@ -138,8 +138,8 @@ export const runCommand = (
process.kill();
reject(
new Error(
`max timeout of ${optionsWithDefaults.timeoutMs}ms reached`
)
`max timeout of ${optionsWithDefaults.timeoutMs}ms reached`,
),
);
}, optionsWithDefaults.timeoutMs);
process.on("exit", (code) => {

16
test/lib/expect.ts
View file

@ -10,7 +10,7 @@ class ExpectError extends Error {
super(
`${reason}\n` +
`\texpected: ${displayValue(expected)}\n` +
`\tactual : ${displayValue(actual)}`
`\tactual : ${displayValue(actual)}`,
);
}
}
@ -50,7 +50,7 @@ export class Expect<T> {
throw new ExpectError(
`value does not equal expected`,
expected,
this.value
this.value,
);
}
}
@ -73,7 +73,7 @@ export class StringExpect extends Expect<string> {
throw new ExpectError(
`value does not match expected pattern`,
pattern,
this.value
this.value,
);
}
}
@ -91,7 +91,7 @@ export class StringExpect extends Expect<string> {
throw new ExpectError(
`value does not start with expected prefix`,
prefix,
this.value
this.value,
);
}
}
@ -109,7 +109,7 @@ export class StringExpect extends Expect<string> {
throw new ExpectError(
`value does not end with expected suffix`,
suffix,
this.value
this.value,
);
}
}
@ -138,14 +138,14 @@ export class FunctionExpect<T> extends Expect<() => T> {
throw new ExpectError(
`function threw non-Error value`,
pattern,
error
error,
);
}
if (!matches(error.message, pattern)) {
throw new ExpectError(
`thrown Error's message does not match pattern`,
pattern,
error.message
error.message,
);
}
return;
@ -153,7 +153,7 @@ export class FunctionExpect<T> extends Expect<() => T> {
throw new ExpectError(
`function did not throw expected error`,
pattern,
null
null,
);
}
}

8
test/lib/harness.ts
View file

@ -40,7 +40,7 @@ const runTest = async (test: Test): Promise<TestResult> => {
error instanceof Error
? error
: new Error(
`threw non-error object: ${displayValue(error)}`
`threw non-error object: ${displayValue(error)}`,
),
};
}
@ -86,7 +86,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 +104,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;

4
test/lib/utils.ts
View file

@ -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;

28
test/test-suites/rendering.tsx
View file

@ -10,7 +10,7 @@ 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",
);
});
@ -21,10 +21,10 @@ testSuite("renderPage", ({ test, expect }) => {
test("escapes HTML in tag names", () => {
const html = renderPage(
<html>{createElement("div></div", null)}</html>
<html>{createElement("div></div", null)}</html>,
);
expect(html).toEqual(
"<!DOCTYPE html><html><div&gt;&lt;/div></div&gt;&lt;/div></html>"
"<!DOCTYPE html><html><div&gt;&lt;/div></div&gt;&lt;/div></html>",
);
});
@ -32,10 +32,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,17 +48,17 @@ 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>"
"<!DOCTYPE html><html>There are three lights!</html>",
);
});
@ -80,10 +80,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 +97,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 +111,10 @@ 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>",
);
});
});