@weft-js/cli 0.1.1 → 0.1.2

package/src/share-checks.mjs

@@ -11,21 +11,35 @@ const USER_TYPED = /\b(?:location\.|URLSearchParams|useSearchParams|searchParams
 /** warp components that take `ui`. Anything else would write `ui="[object Object]"` on its element. */
 const TAKES_UI = new Set(['Button', 'Checkbox', 'Switch', 'Radio', 'Toggle', 'Chip', 'Card'])
 
-const rowsOf = sf => {
+const rowsOf = (sf) => {
   const rows = new Set()
-  const visit = n => {
-    if (ts.isVariableDeclaration(n) && ts.isIdentifier(n.name) && n.initializer && ts.isCallExpression(n.initializer) && n.initializer.expression.getText?.(sf) === 'interaction') rows.add(n.name.text)
+  const visit = (n) => {
+    if (
+      ts.isVariableDeclaration(n) &&
+      ts.isIdentifier(n.name) &&
+      n.initializer &&
+      ts.isCallExpression(n.initializer) &&
+      n.initializer.expression.getText?.(sf) === 'interaction'
+    )
+      rows.add(n.name.text)
     ts.forEachChild(n, visit)
   }
   visit(sf)
   return rows
 }
 
-const warpNames = sf => {
+const warpNames = (sf) => {
   const names = new Map()
   for (const n of sf.statements) {
-    if (!ts.isImportDeclaration(n) || !n.moduleSpecifier.text.startsWith('@weft-js/warp') || !n.importClause?.namedBindings || !ts.isNamedImports(n.importClause.namedBindings)) continue
-    for (const s of n.importClause.namedBindings.elements) names.set(s.name.text, (s.propertyName ?? s.name).text)
+    if (
+      !ts.isImportDeclaration(n) ||
+      !n.moduleSpecifier.text.startsWith('@weft-js/warp') ||
+      !n.importClause?.namedBindings ||
+      !ts.isNamedImports(n.importClause.namedBindings)
+    )
+      continue
+    for (const s of n.importClause.namedBindings.elements)
+      names.set(s.name.text, (s.propertyName ?? s.name).text)
   }
   return names
 }
@@ -34,41 +48,111 @@ export function shareChecks(root, { files }) {
   const out = []
   let sharesIn
   for (const { rel, text } of files) {
-    const usesRow = text.includes('@weft-js/core/interaction')
-    if (!usesRow && !/\bui=\{/.test(text)) continue
-    const sf = ts.createSourceFile(rel, text, ts.ScriptTarget.Latest, true, /\.[jt]sx$/.test(rel) ? ts.ScriptKind.TSX : ts.ScriptKind.TS)
-    const pos = positions(text)
-    const report = (code, n, why) => out.push(diagnostic({ code, file: rel, span: pos.span(n.getStart(sf), n.end), offset: [n.getStart(sf), n.end], why }))
-    const rows = rowsOf(sf), warp = warpNames(sf)
-    const visit = n => {
-      if (ts.isCallExpression(n) && ts.isIdentifier(n.expression) && n.expression.text === 'interaction' && usesRow) {
-        const share = n.arguments[0] && ts.isObjectLiteralExpression(n.arguments[0]) ? n.arguments[0].properties.find(p => p.name?.getText(sf) === 'share') : undefined
-        if (share) {
-          sharesIn ??= rel
-          const value = share.getText(sf)
-          if (UNSTABLE.test(value)) report('U001', share, 'A `share` key that changes on every load never meets another tab or client.')
-          else if (USER_TYPED.test(value)) report('U002', share, 'This `share` key comes from what the user typed or the URL, so `realtime({ share })` is authorising a string they chose.')
-        }
-      }
-      if (ts.isBinaryExpression(n) && n.operatorToken.kind === ts.SyntaxKind.EqualsToken) {
-        const l = n.left
-        const target = ts.isPropertyAccessExpression(l) && l.name.text === 'value' ? l.expression : l
-        if (ts.isPropertyAccessExpression(target) && target.name.text === 'remote' && ts.isIdentifier(target.expression) && rows.has(target.expression.text))
-          report('U004', n, '`remote` is what others are doing: only the network writes it.')
-      }
-      if (ts.isJsxSelfClosingElement(n) || ts.isJsxOpeningElement(n)) {
-        const tag = n.tagName.getText(sf), ui = n.attributes.properties.find(a => ts.isJsxAttribute(a) && a.name.getText(sf) === 'ui')
-        if (ui && warp.has(tag) && !TAKES_UI.has(warp.get(tag))) report('U005', ui, `\`${warp.get(tag)}\` doesn't take \`ui\` yet, so this writes an attribute and draws nothing.`)
-      }
-      ts.forEachChild(n, visit)
-    }
-    visit(sf)
+    sharesIn = checkFile(rel, text, out, sharesIn)
   }
   if (sharesIn && existsSync(join(root, 'src/routes'))) {
-    const file = ['src/realtime.server.ts', 'src/realtime.server.js'].map(f => join(root, f)).find(existsSync)
+    const file = ['src/realtime.server.ts', 'src/realtime.server.js']
+      .map((f) => join(root, f))
+      .find(existsSync)
     if (!file || !/\bshare\s*:/.test(readFileSync(file, 'utf8'))) {
-      out.push(diagnostic({ code: 'U003', file: sharesIn, span: { start: { line: 1, column: 1 }, end: { line: 1, column: 1 } }, offset: [0, 0], why: 'This app shares UI state and no `realtime({ share })` says who may: tabs work, and the socket refuses every key.' }))
+      out.push(
+        diagnostic({
+          code: 'U003',
+          file: sharesIn,
+          span: { start: { line: 1, column: 1 }, end: { line: 1, column: 1 } },
+          offset: [0, 0],
+          why: 'This app shares UI state and no `realtime({ share })` says who may: tabs work, and the socket refuses every key.',
+        }),
+      )
     }
   }
   return out
 }
+
+function checkFile(rel, text, out, sharesIn) {
+  const usesRow = text.includes('@weft-js/core/interaction')
+  if (!usesRow && !/\bui=\{/.test(text)) return sharesIn
+  const sf = ts.createSourceFile(
+    rel,
+    text,
+    ts.ScriptTarget.Latest,
+    true,
+    /\.[jt]sx$/.test(rel) ? ts.ScriptKind.TSX : ts.ScriptKind.TS,
+  )
+  const pos = positions(text)
+  const report = (code, n, why) =>
+    out.push(
+      diagnostic({
+        code,
+        file: rel,
+        span: pos.span(n.getStart(sf), n.end),
+        offset: [n.getStart(sf), n.end],
+        why,
+      }),
+    )
+  const rows = rowsOf(sf),
+    warp = warpNames(sf)
+  const markShare = () => {
+    sharesIn ??= rel
+  }
+  const visit = makeVisitor({ sf, usesRow, rows, warp, report, markShare })
+  visit(sf)
+  return sharesIn
+}
+
+function makeVisitor({ sf, usesRow, rows, warp, report, markShare }) {
+  const visit = (n) => {
+    if (
+      ts.isCallExpression(n) &&
+      ts.isIdentifier(n.expression) &&
+      n.expression.text === 'interaction' &&
+      usesRow
+    ) {
+      const share =
+        n.arguments[0] && ts.isObjectLiteralExpression(n.arguments[0])
+          ? n.arguments[0].properties.find((p) => p.name?.getText(sf) === 'share')
+          : undefined
+      if (share) {
+        markShare()
+        const value = share.getText(sf)
+        if (UNSTABLE.test(value))
+          report(
+            'U001',
+            share,
+            'A `share` key that changes on every load never meets another tab or client.',
+          )
+        else if (USER_TYPED.test(value))
+          report(
+            'U002',
+            share,
+            'This `share` key comes from what the user typed or the URL, so `realtime({ share })` is authorising a string they chose.',
+          )
+      }
+    }
+    if (ts.isBinaryExpression(n) && n.operatorToken.kind === ts.SyntaxKind.EqualsToken) {
+      const l = n.left
+      const target = ts.isPropertyAccessExpression(l) && l.name.text === 'value' ? l.expression : l
+      if (
+        ts.isPropertyAccessExpression(target) &&
+        target.name.text === 'remote' &&
+        ts.isIdentifier(target.expression) &&
+        rows.has(target.expression.text)
+      )
+        report('U004', n, '`remote` is what others are doing: only the network writes it.')
+    }
+    if (ts.isJsxSelfClosingElement(n) || ts.isJsxOpeningElement(n)) {
+      const tag = n.tagName.getText(sf),
+        ui = n.attributes.properties.find(
+          (a) => ts.isJsxAttribute(a) && a.name.getText(sf) === 'ui',
+        )
+      if (ui && warp.has(tag) && !TAKES_UI.has(warp.get(tag)))
+        report(
+          'U005',
+          ui,
+          `\`${warp.get(tag)}\` doesn't take \`ui\` yet, so this writes an attribute and draws nothing.`,
+        )
+    }
+    ts.forEachChild(n, visit)
+  }
+  return visit
+}

package/src/site.mjs

@@ -7,13 +7,40 @@ const absolute = /^(https?:)?\/\//
 export function checkSite(site, report) {
   const image = typeof site.image === 'object' ? site.image.url : site.image
   if (image && !site.url && !absolute.test(image)) {
-    const what = image === 'auto' ? 'The generated card (`image: \'auto\'`) is served from a relative URL' : `\`site.image\` (\`${image}\`) is relative`
-    report('H001', `${what} and \`site.url\` is not set, so og:image (and canonical, og:url) can't be absolute. Crawlers don't resolve relative URLs.`, 'image')
+    const what =
+      image === 'auto'
+        ? "The generated card (`image: 'auto'`) is served from a relative URL"
+        : `\`site.image\` (\`${image}\`) is relative`
+    report(
+      'H001',
+      `${what} and \`site.url\` is not set, so og:image (and canonical, og:url) can't be absolute. Crawlers don't resolve relative URLs.`,
+      'image',
+    )
   }
-  if (!site.description?.trim()) report('H003', 'Pages have no description: `site.description` is not set and no route overrides it yet.', 'site')
+  if (!site.description?.trim())
+    report(
+      'H003',
+      'Pages have no description: `site.description` is not set and no route overrides it yet.',
+      'site',
+    )
   // The default page title is `name`; a template's fixed part is in every other title.
   const fixed = site.title ? site.title.replace('%s', '').length : 0
-  if (site.name && site.name.length > 60) report('H004', `The default title \`${site.name}\` is ${site.name.length} characters (over 60).`, 'name')
-  if (fixed > 40) report('H004', `The title template's fixed part is ${fixed} characters, leaving under 20 of 60 for the page title.`, 'title')
-  if (site.description && site.description.length > 160) report('H004', `\`site.description\` is ${site.description.length} characters (over 160).`, 'description')
+  if (site.name && site.name.length > 60)
+    report(
+      'H004',
+      `The default title \`${site.name}\` is ${site.name.length} characters (over 60).`,
+      'name',
+    )
+  if (fixed > 40)
+    report(
+      'H004',
+      `The title template's fixed part is ${fixed} characters, leaving under 20 of 60 for the page title.`,
+      'title',
+    )
+  if (site.description && site.description.length > 160)
+    report(
+      'H004',
+      `\`site.description\` is ${site.description.length} characters (over 160).`,
+      'description',
+    )
 }

package/src/slots.mjs

@@ -6,21 +6,92 @@
  */
 export const slotTable = [
   { id: 'font.build', version: 1, cardinality: 'one', sides: ['build'], default: null, phase: '2' },
-  { id: 'media.build', version: 1, cardinality: 'one', sides: ['build'], default: null, phase: '2' },
-  { id: 'media.encode', version: 1, cardinality: 'keyed', sides: ['build', 'server'], default: null, phase: '3c' },
-  { id: 'media.server', version: 1, cardinality: 'one', sides: ['server'], default: null, phase: '3' },
-  { id: 'text.measure', version: 1, cardinality: 'one', sides: ['client', 'worker'], default: null, phase: '2 (Surfaces)' },
-  { id: 'surface.renderer', version: 1, cardinality: 'keyed', sides: ['client'], default: ['canvas2d', 'webgl2'], phase: '2 (Surfaces)' },
-  { id: 'realtime.bus', version: 1, cardinality: 'one', sides: ['server'], default: 'memory', phase: '3' },
-  { id: 'db.adapter', version: 1, cardinality: 'keyed', sides: ['server'], default: ['drizzle'], phase: '3c' },
-  { id: 'server.extension', version: 1, cardinality: 'keyed', sides: ['server'], default: null, phase: '6c' },
-  { id: 'pay.rail', version: 1, cardinality: 'keyed', sides: ['server', 'client', 'native'], default: null, phase: '6c' },
+  {
+    id: 'media.build',
+    version: 1,
+    cardinality: 'one',
+    sides: ['build'],
+    default: null,
+    phase: '2',
+  },
+  {
+    id: 'media.encode',
+    version: 1,
+    cardinality: 'keyed',
+    sides: ['build', 'server'],
+    default: null,
+    phase: '3c',
+  },
+  {
+    id: 'media.server',
+    version: 1,
+    cardinality: 'one',
+    sides: ['server'],
+    default: null,
+    phase: '3',
+  },
+  {
+    id: 'text.measure',
+    version: 1,
+    cardinality: 'one',
+    sides: ['client', 'worker'],
+    default: null,
+    phase: '2 (Surfaces)',
+  },
+  {
+    id: 'surface.renderer',
+    version: 1,
+    cardinality: 'keyed',
+    sides: ['client'],
+    default: ['canvas2d', 'webgl2'],
+    phase: '2 (Surfaces)',
+  },
+  {
+    id: 'realtime.bus',
+    version: 1,
+    cardinality: 'one',
+    sides: ['server'],
+    default: 'memory',
+    phase: '3',
+  },
+  {
+    id: 'db.adapter',
+    version: 1,
+    cardinality: 'keyed',
+    sides: ['server'],
+    default: ['drizzle'],
+    phase: '3c',
+  },
+  {
+    id: 'server.extension',
+    version: 1,
+    cardinality: 'keyed',
+    sides: ['server'],
+    default: null,
+    phase: '6c',
+  },
+  {
+    id: 'pay.rail',
+    version: 1,
+    cardinality: 'keyed',
+    sides: ['server', 'client', 'native'],
+    default: null,
+    phase: '6c',
+  },
 ]
 
 export function slotDef(id) {
-  const def = slotTable.find(s => s.id === id)
+  const def = slotTable.find((s) => s.id === id)
   if (def) return def
-  if (/^device\.[a-z][\w-]*$/.test(id)) return { id, version: 1, cardinality: 'keyed', sides: ['native', 'client'], default: null, phase: '6b' }
+  if (/^device\.[a-z][\w-]*$/.test(id))
+    return {
+      id,
+      version: 1,
+      cardinality: 'keyed',
+      sides: ['native', 'client'],
+      default: null,
+      phase: '6b',
+    }
   return undefined
 }
 
@@ -32,7 +103,7 @@ export function slotDef(id) {
 export function bindSlots(config, report) {
   const plugins = config.plugins ?? []
   const chosen = config.slots ?? {}
-  const names = new Set(plugins.map(p => p.name))
+  const names = new Set(plugins.map((p) => p.name))
 
   /** slot id → key ('' for `one`) → provider names */
   const offers = new Map()
@@ -40,7 +111,11 @@ export function bindSlots(config, report) {
     for (const item of p.provides ?? []) {
       const { slot, key = '' } = typeof item === 'string' ? { slot: item } : item
       if (!slotDef(slot) && !slot.startsWith(`${p.name}.`)) {
-        report('P008', `\`${p.name}\` provides \`${slot}\`, which is not a slot weft defines.`, p.name)
+        report(
+          'P008',
+          `\`${p.name}\` provides \`${slot}\`, which is not a slot weft defines.`,
+          p.name,
+        )
         continue
       }
       const byKey = offers.get(slot) ?? new Map()
@@ -57,13 +132,15 @@ export function bindSlots(config, report) {
     const picks = typeof pick === 'string' ? { '': pick } : pick
     for (const [key, name] of Object.entries(picks)) {
       if (name.startsWith('weft:default')) continue
-      if (!names.has(name)) report('P009', `\`slots['${id}']\` picks \`${name}\`, which is not in \`plugins\`.`, id)
-      else if (!(offers.get(id)?.get(key) ?? []).includes(name)) report('P009', `\`slots['${id}']\` picks \`${name}\`, which does not provide it.`, id)
+      if (!names.has(name))
+        report('P009', `\`slots['${id}']\` picks \`${name}\`, which is not in \`plugins\`.`, id)
+      else if (!(offers.get(id)?.get(key) ?? []).includes(name))
+        report('P009', `\`slots['${id}']\` picks \`${name}\`, which does not provide it.`, id)
     }
   }
 
   /** @type {Set<string>} */
-  const known = new Set([...slotTable.map(s => s.id), ...offers.keys()])
+  const known = new Set([...slotTable.map((s) => s.id), ...offers.keys()])
   const ids = [...known].sort()
   const out = {}
   for (const id of ids) {
@@ -77,7 +154,11 @@ export function bindSlots(config, report) {
       if (providers.length === 1) return providers[0]
       if (providers.length > 1) {
         const where = key ? `\`${id}\` key \`${key}\`` : `\`${id}\``
-        report('P100', `${where} has ${providers.length} providers: ${providers.join(', ')}. Array order never decides.`, providers[0])
+        report(
+          'P100',
+          `${where} has ${providers.length} providers: ${providers.join(', ')}. Array order never decides.`,
+          providers[0],
+        )
         return null
       }
       return fallback
@@ -86,9 +167,13 @@ export function bindSlots(config, report) {
       out[id] = resolve('', typeof def.default === 'string' ? `weft:default:${def.default}` : null)
     } else {
       /** @type {Set<string>} */
-      const keys = new Set([...(Array.isArray(def.default) ? def.default : []), ...[...byKey.keys()].filter(Boolean)])
+      const keys = new Set([
+        ...(Array.isArray(def.default) ? def.default : []),
+        ...[...byKey.keys()].filter(Boolean),
+      ])
       const block = {}
-      for (const key of [...keys].sort()) block[key] = resolve(key, def.default?.includes(key) ? 'weft:default' : null)
+      for (const key of [...keys].sort())
+        block[key] = resolve(key, def.default?.includes(key) ? 'weft:default' : null)
       out[id] = block
     }
   }

package/src/start/build.mjs

@@ -0,0 +1,116 @@
+import { audit, builtPublic } from '../audit.mjs'
+import { writeMap } from '../map.mjs'
+import { diagnostic } from '../diag.mjs'
+import { loadConfig } from '../load-config.mjs'
+import { host, presetFor } from '../deploy/hosts.mjs'
+
+export async function finishBuild({
+  root,
+  config,
+  preset,
+  rust,
+  refuse,
+  running,
+  shipSidecars,
+  output,
+  warned,
+  unsafe,
+  forced,
+  loaded,
+  t,
+  writeContract,
+}) {
+  const contract = await writeContract({
+    root,
+    site: config.site,
+    preset,
+    rust,
+    live: (await loadConfig(root)).config?.live,
+    verify: true,
+  })
+  for (const refused of contract.diagnostics.filter((d) => d.severity === 'error')) refuse(refused)
+  if (running) shipSidecars(root)
+  await writeMap(root)
+  // Last, the pages as built, in a clean Chrome at a phone's width and a desktop's (audit.mjs): an error fails the build.
+  const settings = (await loadConfig(root)).config?.build?.audit ?? true
+  const audited =
+    settings === false
+      ? {
+          diagnostics: [
+            diagnostic({
+              code: 'L000',
+              severity: 'warning',
+              file: 'weft.config.ts',
+              why: '`build.audit` is false: the built pages were not audited.',
+            }),
+          ],
+        }
+      : await audit(root, {
+          dir: builtPublic(root),
+          ...(typeof settings === 'object' && settings),
+        })
+  const pages = audited.diagnostics.map((d) =>
+    d.severity === 'error' && unsafe.allows(d) ? unsafe.let(d) : d,
+  )
+  const kept = [
+    ...contract.diagnostics.filter((d) => !(d.severity === 'error' && unsafe.allows(d))),
+    ...warned,
+  ].map((d) => diagnostic({ file: '.weft/contract.json', ...d }))
+  const diagnostics = [
+    ...kept,
+    ...pages,
+    ...forced.map((d) => diagnostic({ file: '.weft/contract.json', ...d })),
+  ]
+  return {
+    ok: !diagnostics.some((d) => d.severity === 'error'),
+    preset,
+    output,
+    contract: contract.path,
+    functions: contract.functions,
+    notes: loaded.contributions.flatMap((c) => c.manifest.notes ?? []),
+    audited: audited.pages?.length ?? 0,
+    diagnostics,
+    ms: Math.round(performance.now() - t),
+  }
+}
+
+export async function startBuildSidecars({
+  start,
+  root,
+  config,
+  preset,
+  rust,
+  refuse,
+  writeContract,
+}) {
+  const { buildSidecars, shipSidecars, startSidecars, usesRemote } = await start(root, 'sidecar')
+  const contracted = () => writeContract({ root, site: config.site, preset, rust })
+  let warned = []
+  // Sidecars first: prerendering a share card runs its route's `load`, which may read one.
+  const running = usesRemote(root)
+    ? await contracted().then(async (c) => {
+        const stop = c.diagnostics.find((d) => d.severity === 'error')
+        if (stop) refuse(stop)
+        const built = await buildSidecars({ root, contract: c.contract, rust, preset })
+        const failed = built.diagnostics.find((d) => d.severity === 'error')
+        if (failed) refuse(failed)
+        warned = built.diagnostics
+        return startSidecars({ root, built: true, log: () => {} })
+      })
+    : undefined
+  return { running, warned, shipSidecars }
+}
+
+export async function buildPreset(root, { preset, runtime, hostRuntime, PRESETS }) {
+  const chosen = runtime ?? (await loadConfig(root)).config?.runtime ?? hostRuntime()
+  // `deploy.target` picks the preset when nothing else does: a build for Fly is the runtime's server, for Netlify `netlify`
+  const target = !preset && !runtime && (await loadConfig(root)).config?.deploy?.target
+  if (target) preset = presetFor(host(target), chosen)
+  if (!preset && !PRESETS[chosen])
+    throw Object.assign(
+      new Error(`unknown runtime "${chosen}": use ${Object.keys(PRESETS).join(', ')}`),
+      { code: 'E_USAGE' },
+    )
+  preset ??= PRESETS[chosen]
+  return preset
+}

package/src/start/routes.mjs

@@ -0,0 +1,38 @@
+import { readFileSync } from 'node:fs'
+import { join } from 'node:path'
+import { diagnostic, locate, positions } from '../diag.mjs'
+
+/**
+ * Route findings as diagnostics, pointing at the `meta` export, or at where one goes. H011's fix is that export, as an
+ * edit an agent can apply: not safe, since the words are a start and not the page's best.
+ */
+export function routeDiagnostics(root, found) {
+  const text = (f) => {
+    try {
+      return readFileSync(join(root, f), 'utf8')
+    } catch {
+      return ''
+    }
+  }
+  return found.map(({ code, severity, file, route, why, help }) => {
+    const source = text(file)
+    const at =
+      code === 'H011' &&
+      help?.startsWith('export const') &&
+      !/\bexport\s+(?:const|function|async function)\s+meta\b/.test(source)
+        ? source.indexOf('export default')
+        : -1
+    const place = positions(source)
+    const fix = at >= 0 && {
+      fix: {
+        safe: false,
+        description: 'Add `meta`',
+        edits: [{ file, span: place.span(at, at), offset: [at, at], text: `${help}\n\n` }],
+      },
+    }
+    return {
+      ...diagnostic({ code, severity, file, why, help, ...locate(source, 'meta'), ...fix }),
+      route,
+    }
+  })
+}