jason.woltje
9353675d1c
Jason's Q168: a visual editor for the Console's project documents, held to row 148's rendering rules. Library. ProseMirror with prosemirror-markdown and markdown-it, chosen in the phase 1 library report (LIBRARY.md, REPORT.md in the packet). packages/webui/third_party/editor/ holds 19 upstream packages as source, byte for byte, each with its license, plus NOTICE and PROVENANCE.json. Build. packages/webui/editor/ holds the model, view, entry and build.mjs. esbuild 0.28.2 is an exact devDependency of packages/webui with its own lock; editor/toolchain.mjs checks the version and the binary's sha256 before any build. MOSAIC_REQUIRE_EDITOR_BUILD=1 turns a missing or different esbuild into a failure, and the rebuild test then checks the committed src/public/editor.js and editor.css match a fresh build. The built bundle is committed under Mos's conditions (mos-0755, mos-0765). Console. The docs view gets Visual and Source modes. A save still writes Markdown through the existing project write path, with the same stale-base and read-only handling. A mode switch reuses the draft and reads nothing from the project. Links and images keep row 148's target rules, and no raw HTML runs. serve.mjs serves /editor.js and /editor.css; index.html loads them. Owner Researcher, brief docs/plans/2026-10-16_q168-wysiwyg-editor.md. Round 5 is a rebase ontod88613bac(row 155); only docs/TOOLS.md, webui/README.md, public/bus.js and serve.mjs differ from the round before. Reviewers on candidate manifest 3a4bc21c...3b05: Dewey (security) approve 29027, Filbert approve 29026. Mos's decision 123 go for public.diff 902f0244 (handwritten part ea59079e): mos-0824. Sage gate on72c3fa598with MOSAIC_REQUIRE_EDITOR_BUILD=1: GATE_PASSED 25/25 (node 2397, selftests 422), 22:07:29Z to 22:13:50Z; the rebuild test ran and passed. Nothing live.
62 lines
3.4 KiB
JavaScript
62 lines
3.4 KiB
JavaScript
// usage: node editor/build.mjs [--out <dir>]
|
|
// Row 154 (#1648, Q168): builds src/public/editor.js and src/public/editor.css from the reviewed source
|
|
// (editor/*.mjs and third_party/editor/) with the pinned esbuild. The output is one unminified IIFE.
|
|
// It also writes editor/BUILD.json: the esbuild version, every input, and the sha256 of each output.
|
|
// Paths in the bundle are relative to packages/webui, so a build from any copy of the tree is the same bytes.
|
|
import { createHash } from 'node:crypto';
|
|
import { mkdirSync, readFileSync, writeFileSync } from 'node:fs';
|
|
import { dirname, join } from 'node:path';
|
|
import { fileURLToPath } from 'node:url';
|
|
import { ESBUILD, toolchain } from './toolchain.mjs';
|
|
|
|
export { ESBUILD };
|
|
const root = dirname(dirname(fileURLToPath(import.meta.url)));
|
|
const T = './third_party/editor';
|
|
const alias = {};
|
|
for (const p of ['model', 'state', 'view', 'transform', 'inputrules', 'markdown']) alias[`prosemirror-${p}`] = `${T}/prosemirror-${p}/src/index.ts`;
|
|
for (const p of ['commands', 'history', 'keymap', 'schema-list']) alias[`prosemirror-${p}`] = `${T}/prosemirror-${p}/src/${p}.ts`;
|
|
for (const p of ['orderedmap', 'rope-sequence', 'w3c-keyname']) alias[p] = `${T}/${p}/index.js`;
|
|
for (const p of ['markdown-it', 'mdurl', 'uc.micro', 'linkify-it']) alias[p] = `${T}/${p}/index.mjs`;
|
|
alias['punycode.js'] = `${T}/punycode.js/punycode.js`;
|
|
alias.entities = `${T}/entities/src/index.ts`;
|
|
|
|
const sha256 = buf => createHash('sha256').update(buf).digest('hex');
|
|
|
|
export async function run(outDir = join(root, 'src/public'), buildJson = join(root, 'editor/BUILD.json')) {
|
|
const tool = toolchain();
|
|
if (!tool.ok) throw new Error(`refusing to build: ${tool.reason}`);
|
|
const { build, version } = await import('esbuild');
|
|
const result = await build({
|
|
absWorkingDir: root,
|
|
entryPoints: ['./editor/entry.mjs'],
|
|
outfile: './src/public/editor.js',
|
|
bundle: true, format: 'iife', target: 'es2022', platform: 'browser',
|
|
legalComments: 'inline', logLevel: 'warning', metafile: true, write: false,
|
|
alias,
|
|
});
|
|
const js = Buffer.from(result.outputFiles[0].contents);
|
|
const css = Buffer.from(
|
|
'/* Built by editor/build.mjs: prosemirror-view/style/prosemirror.css, then editor/editor.css. Do not edit. */\n'
|
|
+ readFileSync(join(root, 'third_party/editor/prosemirror-view/style/prosemirror.css'), 'utf8')
|
|
+ '\n' + readFileSync(join(root, 'editor/editor.css'), 'utf8'));
|
|
mkdirSync(outDir, { recursive: true });
|
|
writeFileSync(join(outDir, 'editor.js'), js);
|
|
writeFileSync(join(outDir, 'editor.css'), css);
|
|
const info = {
|
|
schema: 1, esbuild: version,
|
|
options: 'bundle, iife, es2022, browser, legal-comments inline, unminified; aliases in editor/build.mjs',
|
|
outputs: { 'src/public/editor.js': { sha256: sha256(js), bytes: js.length }, 'src/public/editor.css': { sha256: sha256(css), bytes: css.length } },
|
|
inputs: Object.keys(result.metafile.inputs).sort(),
|
|
};
|
|
writeFileSync(buildJson, JSON.stringify(info, null, 2) + '\n');
|
|
return info;
|
|
}
|
|
|
|
if (process.argv[1] === fileURLToPath(import.meta.url)) {
|
|
const i = process.argv.indexOf('--out');
|
|
const out = i > 0 ? process.argv[i + 1] : undefined;
|
|
const info = await run(out, out ? join(out, 'BUILD.json') : undefined);
|
|
console.log(`editor.js ${info.outputs['src/public/editor.js'].sha256} (${info.inputs.length} inputs)`);
|
|
console.log(`editor.css ${info.outputs['src/public/editor.css'].sha256}`);
|
|
}
|