@getvitops/cli 8.3.0-alpha.1 → 8.3.0-alpha.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/dist/cli.mjs +214 -9
- package/dist/cli.mjs.map +1 -1
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,44 @@
|
|
|
1
1
|
# @getvitops/cli
|
|
2
2
|
|
|
3
|
+
## 8.3.0-alpha.2
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 0a47856: Build correctness and gaps from the second upstream round.
|
|
8
|
+
|
|
9
|
+
- **`@getvitops/emdash`: fixes a circular import that emptied the plugin block map in the static build.** `Section.astro` and `WidgetArea.astro` imported `emdash/ui` statically, which imports `virtual:emdash/block-components`, which is `@getvitops/emdash/astro` again. Depending on import order, every `vitops_*` block inside a section body was dropped from prerendered pages with only a `PortableText [components.type] is missing …` warning. Both now import it lazily, and a test fails if any renderer imports `emdash/ui` statically. No code change needed in sites.
|
|
10
|
+
- **`@getvitops/cli`: `vitops emdash build`** runs `astro build` and then `check-prerender`, and fails when the build reports a block type with no component (reported once per type). The template's `build`, `deploy` and `deploy:dev` scripts use it; existing sites replace `astro build && vitops emdash check-prerender` with `vitops emdash build`. `check-prerender` also warns (fails with `--strict`) on a page without exactly one `<h1>`.
|
|
11
|
+
- **`@getvitops/emdash`: `vitops_hero` and `vitops_section` heading level** accepts `h1`–`h6` and `p` (a heading that is styled but not in the outline). The hero defaults to `h1`; set the level to `2` on a page whose layout already renders an `h1` (the template's seed does).
|
|
12
|
+
- **`@getvitops/emdash`: `vitops_logos`** shows an entry's name as text (`.logos__name`) when it has no image. `@getvitops/core` adds the rule (all formats).
|
|
13
|
+
- **`@getvitops/emdash`: an empty content widget** (no text, no blocks) no longer renders its title, and an area whose widgets are all empty renders nothing.
|
|
14
|
+
- **`@getvitops/create`:** the template's `pages` collection gets `urlPattern: "/{slug}"` (the sitemap listed `/pages/<slug>`, which 404s; existing sites change it under Content Types), and `.gitignore` ignores only `src/styles/tailwind.css` and `tokens.json`, so site CSS kept in `src/styles/` is committed.
|
|
15
|
+
- **`@getvitops/emdash`: per-item colour.** The rows of `vitops_cards`, `vitops_stats`, `vitops_steps` and the hero's `cards` take their own `tone` / `color` (blank inherits the block's), so one block can hold a pine item and an amber one. Hero cards also take an `eyebrow` and a button (`ctaLabel` / `ctaHref`; with a button the card is no longer a stretched link).
|
|
16
|
+
- **`@getvitops/generator` / `@getvitops/emdash`: solid fills read.** The generator emits `--color-<hue>-<step>-on` for every step of every hue, the foreground for a fill at that step picked by the same APCA rule as `text-on-<role>` (css and tailwind formats, a plain `:root`, not `@theme`). A block fill chosen by `color` (hue and step) uses it instead of a fixed white..
|
|
17
|
+
- **`@getvitops/core`: `.counter__value.sr-only`** hides itself, so a build that never emitted the `.sr-only` utility no longer shows a counting figure twice (all formats).
|
|
18
|
+
- **`@getvitops/astro` / `@getvitops/core`: `SiteFooter` groups.** A top-level item of the `footer-sitemap` menu with children becomes a column (its label is the heading, its children the links, one level only); childless items stay in the flat list. Each column is a named `<nav>`.
|
|
19
|
+
- **`@getvitops/astro`: planned links and header buttons.** A menu item with `draft` in its CSS classes stays in the menu but is not rendered (at every level, in the header and the footer). `<SiteNav>` has an `actions` slot for header buttons that are not menu items, and an item with `cta` in its CSS classes renders as a button.
|
|
20
|
+
- **`@getvitops/cli`: `check-prerender` warnings** (fail with `--strict`): links to pages the build did not produce, a form with no delivery address (no `site.notifications.email`, location `email` or `site.crm`), and form fields missing from every `site.templates` form entry (the generated privacy policy reads those). It reads `./site.json`, or `--site=<path>`. `vitops setup … --dry-run` is accepted as `--dry`.
|
|
21
|
+
- **`@getvitops/emdash` / `@getvitops/astro`: "tick any number" form field** (`vitops_form` field kind `checkboxes`): a fieldset of checkboxes sharing one name. The conversion route joins repeated values (`IT, Marketing`) instead of keeping the last. The "required" toggle is not applied to the group (HTML cannot require one of several).
|
|
22
|
+
- **`@getvitops/core`: size hooks.** `.steps__title`, `.stats__figure` and `.card__title` read `--steps-title-size` (default one step below `heading`), `--stats-figure-size` and `--card-title-size`, set on the block through its `style` field. They set the `--heading-fs` / `--display-fs` properties the type-role utilities already read, so no extra class or prop is needed (all formats).
|
|
23
|
+
- **`@getvitops/create`:** the template's `site.json` lists its contact form under `site.templates`, so the privacy policy inventory and the new check agree.
|
|
24
|
+
- **`@getvitops/emdash`: `theme` on every block, on widget areas and on your own markup.** A `theme` select (`<role>` tinted, `<role>:solid` filled, populated from the site's roles by a new `themes/list` route) is a common field on every `vitops_*` block, applied to the block's own root with the role's computed readable text. `<VitopsWidgetArea theme="…">` takes the same, and `themeAttrs('surface')` gives `{ class, style }` for a layout `<body>`. `vitops_section`'s existing `theme` now goes through the same path.
|
|
25
|
+
- **`@getvitops/cli` / `@getvitops/emdash`: pages with a dropped block fail the build.** `vitops_section` and widget areas emit an invisible `<template data-vitops-unrendered="…">` for any body block with no renderer, and `check-prerender` fails the page naming the types (nested bodies only; `vitops emdash build` also scans the build log, which covers top-level bodies). A regression test imports the plugin entry first with a mock of the real virtual module, so the old import cycle fails it.
|
|
26
|
+
- **`@getvitops/emdash`: `formTemplateFromBlock(block)`** turns a saved `vitops_form` value into a `site.templates` form entry (names as submitted, a `checkboxes` field as a `checkbox` with options), to paste into `site.json` so the generated privacy policy lists what the form collects. The build cannot read the CMS database, so this is run by hand; `check-prerender` warns when fields are missing.
|
|
27
|
+
- **`@getvitops/utils`: `hasFormDelivery`** (`@getvitops/utils/notify`): the one test for "has this form anywhere to go", used by `check-prerender`.
|
|
28
|
+
- **`@getvitops/emdash`:** a `color` hue tint now flips with the colour scheme (`light-dark()`); hero option cards sit at `h2` under an `h1` hero; menu items also accept `hidden: true` (same as the `draft` class); `vitops docs blocks` documents `theme`, the per-row colours, the `--<role>-fs` type-size hook and the form checks.
|
|
29
|
+
- **`@getvitops/create`:** the template redirects `/home` to `/`, and the guides use `vp exec` instead of `vpx`.
|
|
30
|
+
|
|
31
|
+
### Patch Changes
|
|
32
|
+
|
|
33
|
+
- 0a47856: **Breaking: every block type is now `vitops_<name>`** (`vitops_cards`, `vitops_hero`, `vitops_actionLink`, …), where the Portable Text blocks were `vitops.<name>` and the section block type was already `vitops_section`. EmDash validates a block type's slug as `[a-z][a-z0-9_]*`, so `vitops.section` was never possible and the toolkit had two styles for one kind of thing. Underscore is the one form valid everywhere, so it is now the only one.
|
|
34
|
+
|
|
35
|
+
Migration: in stored content and in `seed/seed.json`, rename `_type` values from `vitops.<name>` to `vitops_<name>`; in `PortableText` `components`, rename the keys the same way; the `blocks: { include, exclude }` option takes full type names, so rename those too. `vt_*` names in a site are that site's own types and are unaffected. A search-and-replace of `vitops.(actionLink|imageCompare|copyButton|banner|details|carousel|gallery|cards|accordion|hero|marquee|logos|steps|stats|callout|entries|pricing|embed|form|reviews|nav|badges|widgetArea)` with `vitops_$1` covers it. `vitops emdash build` reports any block left on the old name as having no component.
|
|
36
|
+
|
|
37
|
+
- Updated dependencies [0a47856]
|
|
38
|
+
- Updated dependencies [0a47856]
|
|
39
|
+
- @getvitops/generator@8.3.0-alpha.2
|
|
40
|
+
- @getvitops/utils@8.3.0-alpha.2
|
|
41
|
+
|
|
3
42
|
## 8.3.0-alpha.1
|
|
4
43
|
|
|
5
44
|
### Minor Changes
|
package/dist/cli.mjs
CHANGED
|
@@ -17,8 +17,8 @@ import { createInterface } from "node:readline/promises";
|
|
|
17
17
|
import { DEFAULT_BUDGETS, buildReport, fetchSitemapPaths, formatSummary as formatSummary$2, parseImpacts, pathsFromSeed, planPages, preflight, reportFiles, runAudit, runCommand, startPreview } from "@getvitops/utils/audit";
|
|
18
18
|
import { zohoAccountsHost, zohoApiHost } from "@getvitops/utils/crm";
|
|
19
19
|
import { backoffSchedule as backoffSchedule$1, blockedDomains, collectFromAddresses, dnsStatus, enableSending, findZoneForHost, formatPlan as formatPlan$5, formatSummary as formatSummary$3, hasDrift as hasDrift$2, listSendingSubdomains, planSendingDomains, resolveTxt, sendingDns } from "@getvitops/utils/email";
|
|
20
|
-
import { normalizeEmailChannel, resolveSender } from "@getvitops/utils/notify";
|
|
21
|
-
import { execFileSync, spawnSync } from "node:child_process";
|
|
20
|
+
import { hasFormDelivery, normalizeEmailChannel, resolveSender } from "@getvitops/utils/notify";
|
|
21
|
+
import { execFileSync, spawn, spawnSync } from "node:child_process";
|
|
22
22
|
import { createServer } from "node:net";
|
|
23
23
|
import { adminCollaboratorIds, branches, createD1, createDevEnvironment, createProdEnvironment, createR2Bucket, createRepo, defaultBranch, environments, findD1, findR2Bucket, formatPlan as formatPlan$6, formatSummary as formatSummary$4, ghAuthed, mainProtected, originRemote, plan as plan$4, planDomainConsistency, protectMain, pushBranches, repoNwo, secretsPresent, setDefaultBranch, setSecret, wranglerWhoami } from "@getvitops/utils/hosting";
|
|
24
24
|
import { createWidget, deriveDomains, formatPlan as formatPlan$7, formatSummary as formatSummary$5, hasDrift as hasDrift$3, listWidgets, patchSiteKey, plan as plan$5, resolveAccountId } from "@getvitops/utils/turnstile";
|
|
@@ -714,6 +714,7 @@ Setup all options:
|
|
|
714
714
|
Emdash subcommands:
|
|
715
715
|
vitops emdash prepare-db Migrate and seed the local D1 the build prerenders from
|
|
716
716
|
vitops emdash check-prerender [d] Fail if a prerendered page is not a real page
|
|
717
|
+
vitops emdash build [d] astro build, then check-prerender; fails on blocks with no renderer
|
|
717
718
|
|
|
718
719
|
Emdash prepare-db options:
|
|
719
720
|
(none) Starts \`astro dev\` once, calls EmDash's dev-bypass setup (migrates, applies the
|
|
@@ -724,7 +725,14 @@ Emdash check-prerender options:
|
|
|
724
725
|
[dir] Build output to check (default: dist/client). Fails on a page that carries the
|
|
725
726
|
pending-migrations message, is not an HTML document, or has no <title>.
|
|
726
727
|
--strict Also fail (not just warn) when a page uses a type-role class (font-display, …)
|
|
727
|
-
the built CSS has no rule for
|
|
728
|
+
the built CSS has no rule for, links to pages the build did not produce, a page without
|
|
729
|
+
exactly one <h1>, or a form with nowhere to send it (reads ./site.json, or --site=<path>).
|
|
730
|
+
|
|
731
|
+
Emdash build options:
|
|
732
|
+
[dir] Runs \`astro build\`, then check-prerender on [dir] (default: dist/client). Also fails
|
|
733
|
+
when the build reports a block type with no component ("PortableText
|
|
734
|
+
[components.type] is missing …"): the page was published without that content.
|
|
735
|
+
--strict Passed through to check-prerender.
|
|
728
736
|
|
|
729
737
|
Email subcommands:
|
|
730
738
|
vitops email setup [domain] Onboard a from-address domain, waiting for its DNS to resolve
|
|
@@ -854,6 +862,8 @@ const EMDASH_HELP = `vitops emdash — build-time steps for an EmDash site
|
|
|
854
862
|
(SKIP_PREPARE_LOCAL_DB=1 skips)
|
|
855
863
|
vitops emdash check-prerender [d] Fail if a prerendered page under [d] (default dist/client)
|
|
856
864
|
is not a real page
|
|
865
|
+
vitops emdash build [d] astro build, then check-prerender; also fails when the build
|
|
866
|
+
reports a block type with no component (content dropped)
|
|
857
867
|
|
|
858
868
|
Run \`vitops --help\` for the full option list for each subcommand.
|
|
859
869
|
`;
|
|
@@ -922,7 +932,7 @@ const wantsHelp = (argv) => argv.includes("-h") || argv.includes("--help");
|
|
|
922
932
|
/** The help text to print for `vitops <command> [sub] --help`. */
|
|
923
933
|
function helpFor(command, argv) {
|
|
924
934
|
const sub = argv[0] && !argv[0].startsWith("-") ? argv[0] : void 0;
|
|
925
|
-
return (sub ? helpSection(command, sub) : void 0) ?? helpSection(command) ?? (command === "search" ? "vitops search — Google Search Console\n\n vitops search setup [opts] Onboard site.searchConsole domains as GSC domain properties\n vitops search notify [opts] Tell search engines a deploy happened (sitemap + IndexNow)\n\nRun `vitops --help` for the full option list for each subcommand.\n" : command === "ads" ? "vitops ads — link this site to its ad properties\n\n vitops ads setup [opts] Ensure each platform's domain-verification DNS record\n vitops ads tags [opts] Print the consent-gated pixel snippets\n vitops ads lint [opts] Report ad properties the rest of the config can't see\n\nRun `vitops --help` for the full option list for each subcommand.\n" : command === "crm" ? "vitops crm — push form submissions into a client CRM\n\n vitops crm check [opts] Compare site.crm's fieldMap/trackingFields against the live CRM\n vitops crm setup [opts] Create missing HubSpot properties (Bigin/Jobber have no such API)\n\nRun `vitops --help` for the full option list for each subcommand.\n" : command === "setup" ? "vitops setup — the scripted path from an empty scaffold to a live site\n\n vitops setup repo [opts] GitHub repo + branch policy (main protected, dev open)\n vitops setup hosting [opts] Dev D1 + R2 + repo secrets (cloudflare) or a Node target\n vitops setup domain [opts] Plan/check the workers.dev-vs-custom-domain consistency\n (never applies the cutover — see SETUP.html)\n vitops setup search [opts] Forwards to `vitops search setup`\n vitops setup ads [opts] Forwards to `vitops ads setup`\n vitops setup all [opts] Run repo, hosting, search, ads in order\n\nRun `vitops --help` for the full option list for each subcommand.\n" : command === "email" ? "vitops email — sender-domain onboarding checks\n\n vitops email setup [domain] Onboard a from-address domain, waiting for its DNS to resolve\n vitops email check [opts] Non-blocking deploy guard: warn if a from domain isn't onboarded\n\nRun `vitops --help` for the full option list for each subcommand.\n" : command === "emdash" ? "vitops emdash — build-time steps for an EmDash site\n\n vitops emdash prepare-db Migrate and seed the local D1 the build prerenders from\n (SKIP_PREPARE_LOCAL_DB=1 skips)\n vitops emdash check-prerender [d] Fail if a prerendered page under [d] (default dist/client)\n is not a real page\n\nRun `vitops --help` for the full option list for each subcommand.\n" : void 0) ?? "vitops — generate design-system outputs from a design-system.json\n\nAnywhere a command takes --input, that file may be a design-system.json OR the\nlarger site config that embeds one (company.json / site.json). The two are told\napart by shape, and a site config also supplies the site-level facts generation\nreads — its default colour scheme, its legal documents, its icon sprite.\n\nUsage:\n vitops generate [options] Generate platform output from a config\n vitops init [options] Scaffold a starter design-system.json\n vitops validate <file> Validate a config against the schema it says it is\n vitops favicon [options] Generate a favicon set from a source image\n vitops agents [options] Link the design-system agent skill + AGENTS.md pointer\n vitops docs [topic] Print live design-system reference docs to stdout\n vitops lint [opts] [files] Report classes that resolve to nothing + primitives you re-implemented\n vitops legal [options] Render legal documents from a site config\n vitops robots [options] Render robots.txt from a site config's environment\n vitops reviews [options] Fetch + cache Google Business Profile reviews\n vitops icons [options] Report which icons your source uses, and build the sprite\n vitops search <sub> [opts] Search Console: onboard domains (setup) + notify deploys (notify)\n vitops ads <sub> [opts] Ad properties: verify domains (setup) + emit pixels (tags) + lint\n vitops setup <sub> [opts] Scripted onboarding: repo, hosting, domain, search, ads, all\n vitops email <sub> [opts] Sender-domain onboarding: check (setup) + deploy guard (check)\n vitops media [options] Encode raw video into web-ready WebM + MP4 + poster\n vitops audit [options] Performance + accessibility budgets over a built site (Lighthouse + axe)\n\nGenerate options:\n -i, --input <path> design-system.json or site config (default: ./design-system.json)\n -f, --format <list> bricks | css | tailwind | design (comma-separated; default: bricks)\n design emits DESIGN.md only (the agent-facing brief) — pair it\n with --out . to write it beside AGENTS.md, or compose:\n --format css,design\n -o, --out <dir> Output directory (default: ./dist)\n --theme <name> Which designSystem.themes entry to build, when --input is\n a site config (default: its defaultTheme, else \"default\")\n --site <path> Site config, when it is a different file from --input.\n Emits legal/*.html into the output directory (see:\n vitops legal). Omitted with a plain design-system.json:\n no legal files.\n --site-env <env> Environment whose A/B variant applies (default: production)\n\nInit options:\n -o, --out <path> Where to write (default: ./design-system.json, or\n ./site.json with --site)\n --force Overwrite an existing file\n --site Write a site config (Config) instead of a bare\n design-system.json — embeds a starter design system at\n designSystem.themes.default, since a Config can't\n merely reference a sibling file\n --name <name> organization.name, when --site is set\n --url <url> site.environments.{production,dev}.url, when --site is set\n\nValidate options:\n <file> Config to check (default: ./design-system.json). Either\n kind — a design-system.json or the config that embeds one.\n -i, --input <path> Same, as a flag\n --site-env <env> Environment whose A/B variant applies (default: production)\n\n Checks the schema, then the things a schema cannot: that every role points at a\n palette hue that exists, that every var() an authored declaration references\n resolves to a token this config emits, and that the colour grammar is current.\n\nFavicon options:\n -i, --input <path> Source SVG or PNG (required)\n -o, --out <dir> Output directory (default: ./public)\n --low-res <path> Optional simplified source for the 16px icon\n --background <hex> Background under the maskable icons, which must be\n opaque (default: #ffffff)\n\nAgents options:\n -i, --input <path> design-system.json or site config (default: ./design-system.json;\n validated if present)\n --theme <name> Theme to read, when --input is a site config\n -o, --out <path> Doc file to update, idempotently (default: ./AGENTS.md)\n --docs-dir <dir> Legacy layout: write the docs bundle as files to this dir\n instead of linking the packaged skill\n\nDocs options:\n <topic> classes | authoring | formats | color | scales | patterns | elements\n (no topic: list topics with summaries)\n -i, --input <path> site config or design-system.json (default: ./site.json, else\n ./design-system.json)\n --theme <name> Theme to render docs from, when --input is a site config\n --all Print every topic, concatenated\n\nIcons options:\n -i, --input <path> Site config carrying the \"icons\" block (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n --src <dir> Source to scan for icon usage (default: ./src)\n --sprite Also build the SVG sprite\n -o, --out <dir> Where to write icons.svg with --sprite (default: ./dist)\n --json Machine-readable report on stdout\n\nLint options:\n -i, --input <path> site config or design-system.json (default: ./site.json, else\n ./design-system.json)\n --theme <name> Theme to judge classes against, when --input is a site config\n -f, --format <fmt> Format you build (bricks | css | tailwind; default: bricks).\n Responsive md-* classes are real in css/bricks, inert in tailwind.\n -s, --src <dir> Directory to scan (default: ./src)\n --strict Also fail on suggestions (reuse hints), not just on\n classes that resolve to nothing\n [files...] Lint these paths instead of scanning --src. Unreadable\n and non-source paths are skipped, so this can be wired\n into a pre-commit hook that appends the staged files.\n --fix Rewrite pre-1.0 colour-grammar token references\n (var(--<role>-<suffix>) → var(--color-<target>-<role>…))\n in CSS and <style> blocks. Applied in ONE pass, so the\n renames that rotate cannot compound. Nothing else is\n rewritten — every other finding is a judgement call.\n\n Run this after a major bump: it is the migration tool for anything the\n changelog says was renamed.\n\nLegal options:\n -i, --input <path> Site config: .json, or a .js/.ts module with a default\n export (default: ./site.json)\n -d, --doc <name> privacy | terms | cookies (repeatable; default: those\n enabled in the config)\n -f, --format <fmt> md | html | portable-text (default: md)\n html suits WordPress/Bricks and plain sites;\n portable-text suits EmDash\n -o, --out <dir> Write files here (default: print to stdout)\n --site-env <env> Environment whose A/B variant applies (default: production)\n\n Generated from your config — a starting point, not legal advice. Review before\n publishing, and make sure the config describes what your site actually does.\n\nRobots options:\n -i, --input <path> Site config: .json, or a .js/.ts module with a default\n export (default: ./site.json)\n -o, --out <dir> Write robots.txt here (default: print to stdout)\n --site-env <env> Which site.environments entry to render for (default: production)\n\n Reads the resolved environment's robots directive (falling back to\n site.seo.robots) — the same fact vitops search notify's noindex gate already\n reads. A directive containing noindex disallows every user agent and emits\n no Sitemap line; otherwise it allows everything and links\n site.seo.indexing.sitemapUrl, or the derived <canonical>/sitemap-index.xml.\n\nReviews options:\n -i, --input <path> Site config carrying site.reviews (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n --location <key> Fetch only this site.reviews.locations key\n --cache <path> Where to read/write the cache (default: .vitops/reviews.json)\n --out <dir> Also write the selected reviews per location as JSON here\n --dry Print the plan and exit. Fetches nothing.\n --check Fetch and diff against the cache; exit non-zero on drift.\n Mutates nothing.\n\n Reviews live only on the legacy Business Profile v4 API — there is no newer\n replacement — and the calling GCP project must be allowlisted by Google before\n any call succeeds (a one-time approval; a 403 says so rather than failing\n opaquely). Auth is user OAuth, the same VITOPS_GOOGLE_CLIENT_ID /\n VITOPS_GOOGLE_CLIENT_SECRET / VITOPS_GOOGLE_REFRESH_TOKEN (or ADC login) that\n vitops search setup uses, scoped to business.manage. The cache is meant to be\n committed: reviews change slowly, and a build should not need a live Google\n credential. Review JSON-LD is off by default (site.reviews.schema) — a business\n marking up reviews of itself is not eligible for Google's rich results and\n risks a manual action.\n\nSearch subcommands:\n vitops search setup [opts] Onboard site.searchConsole domains into GSC\n vitops search notify [opts] Tell search engines about a deploy (sitemap + IndexNow)\n\nSearch setup options:\n -i, --input <path> Site config carrying site.searchConsole (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n --domain <name> Scope to a single site.searchConsole entry\n --dry Print the plan and exit. Changes nothing, and runs without\n credentials (planning from scratch, which it says).\n --check Report drift and exit non-zero if any domain is not fully\n onboarded. Mutates nothing, but does need credentials —\n drift is a comparison against live state.\n\n For each domain it ensures the apex verification TXT in Cloudflare, verifies\n ownership (DNS_TXT, retried with backoff while DNS propagates — a still-\n unverified domain is reported PENDING, not failed), adds the sc-domain: property,\n and adds any delegatedOwners to the web resource. DNS is only ever created,\n never edited or deleted. Credentials come from the environment:\n CLOUDFLARE_API_TOKEN (Zone:DNS:Edit + Zone:Read — the standard \"Edit zone DNS\"\n template covers both; Zone:Read is what the zone-by-name lookup uses), and\n VITOPS_GOOGLE_CLIENT_ID /\n VITOPS_GOOGLE_CLIENT_SECRET / VITOPS_GOOGLE_REFRESH_TOKEN (a user OAuth token\n scoped to siteverification + webmasters). Granting a Google Group Full-User\n access has no API and is surfaced as a reminder.\n\n Or just be logged in: with no VITOPS_GOOGLE_* set, an Application Default\n Credentials login is used —\n gcloud auth application-default login \\\n --scopes=openid,https://www.googleapis.com/auth/siteverification,\\\n https://www.googleapis.com/auth/webmasters,https://www.googleapis.com/auth/cloud-platform\n ADC authenticates through a shared OAuth client that owns no project, so it also\n needs site.google.project in the config (sent as x-goog-user-project), both APIs\n enabled on that project, and serviceusage.services.use on it. One project per site\n is what keeps each site's API usage and billing separate.\n\nSearch notify options:\n -i, --input <path> Site config carrying seo.indexing (default: ./site.json)\n --site-env <env> Environment to notify for (default: production). An\n environment whose robots policy says noindex is refused.\n --sitemap <src> Sitemap URL or local path (default: from the config)\n --urls <list> Comma-separated URLs to submit, skipping the diff\n --all Submit every URL in the sitemap, not just what changed\n --dry Print the plan and exit. Makes no requests.\n --check Read-only: ask Google whether seo.indexing.priorityUrls\n are indexed. Exits non-zero if one is not.\n --new-key Print a fresh IndexNow key and exit\n --write-key <dir> Write the IndexNow key file into <dir> (for stacks with\n no Astro integration to do it — Bricks, WordPress)\n --snapshot <path> Changed-URL state file (default: .vitops/sitemap-snapshot.json).\n Persist it between runs (a CI cache) or every run submits\n everything.\n\n What notify can and cannot do: Google exposes no \"request indexing\" API, and its\n sitemap ping endpoint was removed in 2023 — so it resubmits your sitemap\n through the Search Console API and verifies the result with --check. IndexNow\n reaches Bing, Yandex, Naver, Seznam and Yep; Google does not participate.\n Search Console takes either credential, whichever you already have, added as an\n owner of the property: a service account in VITOPS_GSC_SERVICE_ACCOUNT (inline\n JSON) or GOOGLE_APPLICATION_CREDENTIALS (a path), or the same user OAuth\n credential \"search setup\" uses (VITOPS_GOOGLE_CLIENT_ID / _CLIENT_SECRET /\n _REFRESH_TOKEN). The service account is preferred when both are set — this runs\n on every deploy, and it does not expire.\n\nAds subcommands:\n vitops ads setup [opts] Ensure each platform's domain-verification DNS record\n vitops ads tags [opts] Print the consent-gated pixel snippets\n vitops ads lint [opts] Report ad properties the rest of the config can't see\n\nAds setup options:\n -i, --input <path> Site config carrying site.ads (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n --provider <name> Scope to one site.ads entry (google | meta | linkedin |\n reddit | tiktok | microsoft | pinterest | snapchat)\n --dry Print the plan and exit. Creates nothing. With\n CLOUDFLARE_API_TOKEN set it reads live DNS first, so the\n plan says what is already done; without one it plans from\n scratch and says so, rather than refusing to run.\n --check Report drift and exit non-zero if any property is not\n linked. Mutates nothing, prompts for nothing.\n --no-prompt Never ask for a missing token; fail with the field name\n instead (the default when stdin is not a TTY, e.g. in CI)\n --no-write Don't persist an answered token back into the config\n\n Four platforms verify a domain by DNS TXT — Meta, TikTok, Pinterest, Snapchat —\n and that record is the one thing this creates for you (in Cloudflare, via\n CLOUDFLARE_API_TOKEN; created only, never edited or deleted). Google Ads,\n LinkedIn, Reddit and Microsoft Ads have no domain verification at all: linking\n there is the tag and the account ID, and the run says so rather than skipping in\n silence. No platform Marketing API is called — Meta's needs a system-user token\n and Google's needs an approved developer token, so the final \"Verify\" click stays\n a reminder. The verification token is not a secret (it is published in DNS, which\n is the ownership proof), so it lives in the config and is prompted for on the\n first run.\n\nAds tags options:\n -i, --input <path> Site config carrying site.ads (default: ./site.json)\n --provider <name> Print one platform's tag\n --strategy <s> idle | async | interaction (default: idle)\n\n Prints each pixel as an INERT, consent-gated <script>: type=\"text/plain\" with the\n library URL on data-src, so an undecided visitor's page issues no third-party\n request. For stacks with no Astro integration — Bricks, WordPress, Eleventy.\n Paste into your template; @getvitops/core's consent runtime activates them.\n\nAds lint options:\n -i, --input <path> Site config carrying site.ads (default: ./site.json)\n\n Reports the gaps that are invisible at runtime: a click-ID parameter this\n platform stamps that attribution doesn't capture, a pixel while site.tracking is\n off (every conversion arrives unattributed), and a configured property with no\n tag ID. Exits non-zero on a finding.\n\nCrm check options:\n -i, --input <path> Site config carrying site.crm (default: ./site.json)\n --site-env <env> Environment to resolve (default: production)\n\n Fetches the live field/property list (HubSpot: crm/v3/properties/contacts;\n Bigin: bigin/v2/settings/fields) and reports every fieldMap/trackingFields\n target that doesn't exist there. HubSpot rejects a submission naming an\n unrecognised property; Bigin silently ignores it — this is the only way to\n see a broken mapping before a real submission finds it. Needs\n VITOPS_HUBSPOT_ACCESS_TOKEN, VITOPS_ZOHO_CLIENT_ID/_CLIENT_SECRET/\n _REFRESH_TOKEN, or (unused for now) VITOPS_JOBBER_CLIENT_ID/_CLIENT_SECRET/\n _REFRESH_TOKEN, matching whichever provider site.crm names. Jobber currently\n renders fieldMap/trackingFields as note-text lines rather than app-configured\n custom fields, so there is nothing live to check there yet. Exits non-zero\n on any missing target.\n\nCrm setup options:\n -i, --input <path> Site config carrying site.crm (default: ./site.json)\n --site-env <env> Environment to resolve (default: production)\n --dry Print what would be created and exit. Creates nothing.\n\n HubSpot: creates missing contact properties named by fieldMap/trackingFields.\n Bigin: no such API exists, so this always prints a manual reminder listing\n the fields to add in Zoho Bigin's field editor, then re-run \"crm check\".\n Jobber: app-configured custom fields aren't wired up yet, so this prints a\n reminder instead of creating anything.\n\nSetup repo options:\n --dry Print the plan and exit\n --check Report drift/blocked steps and exit non-zero, mutating nothing\n --public Create the repo public (default: private)\n --platform <p> cloudflare (default) | node — shown for parity with the hosting stage's plan\n --no-dev-resources Same — this stage never provisions D1/R2 either way\n\n Creates the GitHub repo (via `gh`), pushes main + dev, makes dev the default\n branch, and requests main branch protection + the production/dev environments.\n Idempotent — a re-run of a fully set-up repo is all skips. Branch protection and\n environment reviewers 403 on a private repo without GitHub Pro/Team; that is\n reported as blocked, with the manual Settings path, never as a failure.\n\nSetup hosting options:\n --dry Print the plan and exit\n --check Report drift/blocked steps and exit non-zero, mutating nothing\n --platform <p> cloudflare (default) | node\n --no-dev-resources Skip D1/R2 — a pure static Workers Assets project has\n nothing to provision, just the account id + token\n\n Provisions the isolated dev D1 database + R2 bucket (cloudflare) and sets the\n DEV_D1_ID / CLOUDFLARE_ACCOUNT_ID repo secrets, once `vitops setup repo` has run.\n CLOUDFLARE_API_TOKEN is always reported as blocked — no API can create one; see\n the printed dashboard link. Requires `npx wrangler login` first.\n\nSetup domain options:\n -i, --input <path> Site config (default: ./site.json)\n --site-env <env> Environment to check (default: production)\n --dry Print the plan and exit\n --check Exit non-zero if the domain state is inconsistent\n --domain <apex> Print the manual cutover steps for this apex\n\n Plans and checks the consistency between wrangler.jsonc's workers.dev/custom-domain\n state and site.json's environments/domains/robots — it NEVER edits wrangler.jsonc\n or deploys. Cutover overwrites the zone's DNS record and can take an existing live\n site down; that step is manual, on purpose. See SETUP.html's \"Domain strategy\" stage.\n\nSetup turnstile options:\n -i, --input <path> Site config (default: ./site.json)\n --site-env <env> Environment to read (default: production)\n --dry Print the plan and exit (needs no token)\n --check Exit non-zero if no widget/site key is set up; mutates nothing\n --no-write Do not write site.security.turnstile.siteKey back to the config\n --no-secret Do not run `wrangler secret put` for the new widget's secret\n\n Creates a managed Turnstile widget for the site's hostnames (canonical + each\n environment URL) unless one already covers them, and writes the PUBLIC site key to\n site.security.turnstile.siteKey. The SECRET is returned once at creation: it is piped\n to `wrangler secret put VITOPS_TURNSTILE_SECRET` and never written to a config file.\n Never edits, rotates or deletes an existing widget.\n Needs CLOUDFLARE_API_TOKEN with \"Account > Turnstile > Edit\", plus CLOUDFLARE_ACCOUNT_ID\n (or a token that can list accounts), and `wrangler login` for the secret.\n\nSetup search options:\n Forwards every option to `vitops search setup` unchanged — see \"Search setup\n options:\" above.\n\nSetup ads options:\n Forwards every option to `vitops ads setup` unchanged — see \"Ads setup options:\"\n above.\n\nSetup all options:\n --dry Print every stage's plan and exit\n --check Report drift across every stage and exit non-zero\n --public Create the repo public, for the repo stage\n --platform <p> cloudflare (default) | node, for the repo + hosting stages\n --no-dev-resources Skip D1/R2 in the hosting stage (repo stage never provisions them)\n\n Runs repo, hosting, search, ads in order. Stops at the first stage that fails;\n a blocked step (the API token, GitHub Pro/Team gating) is reported, not fatal.\n\nEmdash subcommands:\n vitops emdash prepare-db Migrate and seed the local D1 the build prerenders from\n vitops emdash check-prerender [d] Fail if a prerendered page is not a real page\n\nEmdash prepare-db options:\n (none) Starts `astro dev` once, calls EmDash's dev-bypass setup (migrates, applies the\n seed's sample content), checks the home page renders, stops. Only writes the\n disposable .wrangler/state. SKIP_PREPARE_LOCAL_DB=1 skips it.\n\nEmdash check-prerender options:\n [dir] Build output to check (default: dist/client). Fails on a page that carries the\n pending-migrations message, is not an HTML document, or has no <title>.\n --strict Also fail (not just warn) when a page uses a type-role class (font-display, …)\n the built CSS has no rule for.\n\nEmail subcommands:\n vitops email setup [domain] Onboard a from-address domain, waiting for its DNS to resolve\n vitops email check [opts] Non-blocking deploy guard: warn if a from domain isn't onboarded\n\nEmail setup options:\n -i, --input <path> Site config carrying site.notifications.email (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n [domain] Onboard this exact name instead of deriving candidates from\n config + a source scan\n --src <dir> Source to scan for from: literals as a supplement to config\n (default: ./src)\n --dry Print the plan and exit. Needs no credential — plans from\n scratch and says so.\n --check Report drift and exit non-zero. Mutates nothing.\n --no-prompt Never ask before enabling a domain (the default when\n stdin is not a TTY, e.g. in CI — it just enables)\n --timeout <s> Cap on each DNS-propagation poll wait, in seconds (default: 5)\n\n The onboarded entity is an EXACT name, and it is usually a subdomain\n (send.example.com), never the apex a from address names. When the exact\n domain is absent but a sibling in the same zone is already onboarded, this\n is reported blocked rather than silently enabling the apex too — enabling\n it rewrites _dmarc.<domain>, which can tighten policy on every OTHER mail\n sent from that domain. Sending from the onboarded sibling is the\n recommended fix. Needs CLOUDFLARE_API_TOKEN (Zone:Read + an Email Sending\n scope — broader than the \"Edit zone DNS\" template other commands use).\n\nEmail check options:\n -i, --input <path> Site config carrying site.notifications.email (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n --src <dir> Source to scan for from: literals (default: ./src)\n --strict Exit non-zero on drift (the default just warns and exits 0)\n --skip Skip the check entirely (same as VITOPS_SKIP_EMAIL_CHECK)\n\n Meant to run before a deploy. With no CLOUDFLARE_API_TOKEN it reports \"not\n checked\" and exits 0, so a CI job without the secret never fails on the\n check itself. Skip per-site with site.notifications.email.verifySender: false\n when the scan can't see the real from address and the warning would be a\n false positive.\n\nMedia options:\n --raw <dir> Directory of unprocessed video, walked recursively\n (default: ./raw)\n -o, --out <dir> Where the encoded outputs go (default: ./src/assets/processed).\n Subdirectories under --raw are preserved.\n --max-width <px> Cap the output width, keeping aspect ratio (default: 1920;\n 0 disables scaling)\n --crf <n> Quality on VP9's scale, 0-63, lower is better (default: 32).\n The MP4 fallback uses the equivalent on H.264's scale.\n --max-bitrate <r> Optional ceiling, e.g. 2M or 800k (default: none, which is\n constant quality rather than constrained)\n --audio Keep the audio track (default: dropped — the common case is\n a muted autoplay loop)\n --poster-time <s> Timestamp the poster frame is taken from (default: 0, which\n is often black on a clip that fades in)\n --outputs <list> Comma-separated: webm | mp4 | poster (default: all three)\n --manifest <path> Cache file (default: .vitops/media-manifest.json)\n --force Re-encode everything, ignoring the cache\n --dry Print the plan and exit. Encodes nothing.\n\n Needs ffmpeg on PATH — it is an external tool, not an npm dependency, and this\n command fails rather than quietly skipping. Commit the outputs and the manifest:\n ffmpeg output is not reproducible across versions, so re-encoding in CI churns\n the diff on every toolchain bump. Use --force when you mean to re-encode.\n\nAudit options:\n --build Run `astro build` first (default: audit the existing build)\n --url <base> Audit an already-running server instead of `astro preview`\n --port <n> Port for `astro preview` (default: 4398; aborts if taken)\n --dir <path> Project directory (default: .)\n --pages <list> Extra comma-separated paths. The page list is the built sitemap\n plus links in seed/seed.json's primary* and footer* menus; only\n when neither exists are / /privacy /terms /cookies /contact\n guessed. A 404 skips a page (with its reason in the report); a\n 404 on / fails the run.\n --no-defaults Never guess the default pages\n --seed <path> EmDash seed to read menus from (default: seed/seed.json if present)\n --lcp <ms> LCP budget (default: 2500)\n --cls <n> CLS budget (default: 0.1)\n --tbt <ms> Total Blocking Time budget, the INP proxy (default: 200)\n --impact <list> axe impacts that fail a page (default: serious,critical)\n --form-factor <f> mobile | desktop Lighthouse profile (default: mobile)\n -o, --out <dir> Report directory (default: .vitops/audit): report.json, report.md,\n and pages/<page>.{json,md}\n --warn Report without failing (exit 0), for first adoption\n\n Needs the optional packages: vp add -D playwright @axe-core/playwright lighthouse\n && vp exec playwright install chromium (checked before any server starts). A pass means no automated axe violations and the\n budgets held — it is NOT AODA certification; report.md lists the manual checks.\n\nCommon:\n -h, --help Show this help\n";
|
|
935
|
+
return (sub ? helpSection(command, sub) : void 0) ?? helpSection(command) ?? (command === "search" ? "vitops search — Google Search Console\n\n vitops search setup [opts] Onboard site.searchConsole domains as GSC domain properties\n vitops search notify [opts] Tell search engines a deploy happened (sitemap + IndexNow)\n\nRun `vitops --help` for the full option list for each subcommand.\n" : command === "ads" ? "vitops ads — link this site to its ad properties\n\n vitops ads setup [opts] Ensure each platform's domain-verification DNS record\n vitops ads tags [opts] Print the consent-gated pixel snippets\n vitops ads lint [opts] Report ad properties the rest of the config can't see\n\nRun `vitops --help` for the full option list for each subcommand.\n" : command === "crm" ? "vitops crm — push form submissions into a client CRM\n\n vitops crm check [opts] Compare site.crm's fieldMap/trackingFields against the live CRM\n vitops crm setup [opts] Create missing HubSpot properties (Bigin/Jobber have no such API)\n\nRun `vitops --help` for the full option list for each subcommand.\n" : command === "setup" ? "vitops setup — the scripted path from an empty scaffold to a live site\n\n vitops setup repo [opts] GitHub repo + branch policy (main protected, dev open)\n vitops setup hosting [opts] Dev D1 + R2 + repo secrets (cloudflare) or a Node target\n vitops setup domain [opts] Plan/check the workers.dev-vs-custom-domain consistency\n (never applies the cutover — see SETUP.html)\n vitops setup search [opts] Forwards to `vitops search setup`\n vitops setup ads [opts] Forwards to `vitops ads setup`\n vitops setup all [opts] Run repo, hosting, search, ads in order\n\nRun `vitops --help` for the full option list for each subcommand.\n" : command === "email" ? "vitops email — sender-domain onboarding checks\n\n vitops email setup [domain] Onboard a from-address domain, waiting for its DNS to resolve\n vitops email check [opts] Non-blocking deploy guard: warn if a from domain isn't onboarded\n\nRun `vitops --help` for the full option list for each subcommand.\n" : command === "emdash" ? "vitops emdash — build-time steps for an EmDash site\n\n vitops emdash prepare-db Migrate and seed the local D1 the build prerenders from\n (SKIP_PREPARE_LOCAL_DB=1 skips)\n vitops emdash check-prerender [d] Fail if a prerendered page under [d] (default dist/client)\n is not a real page\n vitops emdash build [d] astro build, then check-prerender; also fails when the build\n reports a block type with no component (content dropped)\n\nRun `vitops --help` for the full option list for each subcommand.\n" : void 0) ?? "vitops — generate design-system outputs from a design-system.json\n\nAnywhere a command takes --input, that file may be a design-system.json OR the\nlarger site config that embeds one (company.json / site.json). The two are told\napart by shape, and a site config also supplies the site-level facts generation\nreads — its default colour scheme, its legal documents, its icon sprite.\n\nUsage:\n vitops generate [options] Generate platform output from a config\n vitops init [options] Scaffold a starter design-system.json\n vitops validate <file> Validate a config against the schema it says it is\n vitops favicon [options] Generate a favicon set from a source image\n vitops agents [options] Link the design-system agent skill + AGENTS.md pointer\n vitops docs [topic] Print live design-system reference docs to stdout\n vitops lint [opts] [files] Report classes that resolve to nothing + primitives you re-implemented\n vitops legal [options] Render legal documents from a site config\n vitops robots [options] Render robots.txt from a site config's environment\n vitops reviews [options] Fetch + cache Google Business Profile reviews\n vitops icons [options] Report which icons your source uses, and build the sprite\n vitops search <sub> [opts] Search Console: onboard domains (setup) + notify deploys (notify)\n vitops ads <sub> [opts] Ad properties: verify domains (setup) + emit pixels (tags) + lint\n vitops setup <sub> [opts] Scripted onboarding: repo, hosting, domain, search, ads, all\n vitops email <sub> [opts] Sender-domain onboarding: check (setup) + deploy guard (check)\n vitops media [options] Encode raw video into web-ready WebM + MP4 + poster\n vitops audit [options] Performance + accessibility budgets over a built site (Lighthouse + axe)\n\nGenerate options:\n -i, --input <path> design-system.json or site config (default: ./design-system.json)\n -f, --format <list> bricks | css | tailwind | design (comma-separated; default: bricks)\n design emits DESIGN.md only (the agent-facing brief) — pair it\n with --out . to write it beside AGENTS.md, or compose:\n --format css,design\n -o, --out <dir> Output directory (default: ./dist)\n --theme <name> Which designSystem.themes entry to build, when --input is\n a site config (default: its defaultTheme, else \"default\")\n --site <path> Site config, when it is a different file from --input.\n Emits legal/*.html into the output directory (see:\n vitops legal). Omitted with a plain design-system.json:\n no legal files.\n --site-env <env> Environment whose A/B variant applies (default: production)\n\nInit options:\n -o, --out <path> Where to write (default: ./design-system.json, or\n ./site.json with --site)\n --force Overwrite an existing file\n --site Write a site config (Config) instead of a bare\n design-system.json — embeds a starter design system at\n designSystem.themes.default, since a Config can't\n merely reference a sibling file\n --name <name> organization.name, when --site is set\n --url <url> site.environments.{production,dev}.url, when --site is set\n\nValidate options:\n <file> Config to check (default: ./design-system.json). Either\n kind — a design-system.json or the config that embeds one.\n -i, --input <path> Same, as a flag\n --site-env <env> Environment whose A/B variant applies (default: production)\n\n Checks the schema, then the things a schema cannot: that every role points at a\n palette hue that exists, that every var() an authored declaration references\n resolves to a token this config emits, and that the colour grammar is current.\n\nFavicon options:\n -i, --input <path> Source SVG or PNG (required)\n -o, --out <dir> Output directory (default: ./public)\n --low-res <path> Optional simplified source for the 16px icon\n --background <hex> Background under the maskable icons, which must be\n opaque (default: #ffffff)\n\nAgents options:\n -i, --input <path> design-system.json or site config (default: ./design-system.json;\n validated if present)\n --theme <name> Theme to read, when --input is a site config\n -o, --out <path> Doc file to update, idempotently (default: ./AGENTS.md)\n --docs-dir <dir> Legacy layout: write the docs bundle as files to this dir\n instead of linking the packaged skill\n\nDocs options:\n <topic> classes | authoring | formats | color | scales | patterns | elements\n (no topic: list topics with summaries)\n -i, --input <path> site config or design-system.json (default: ./site.json, else\n ./design-system.json)\n --theme <name> Theme to render docs from, when --input is a site config\n --all Print every topic, concatenated\n\nIcons options:\n -i, --input <path> Site config carrying the \"icons\" block (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n --src <dir> Source to scan for icon usage (default: ./src)\n --sprite Also build the SVG sprite\n -o, --out <dir> Where to write icons.svg with --sprite (default: ./dist)\n --json Machine-readable report on stdout\n\nLint options:\n -i, --input <path> site config or design-system.json (default: ./site.json, else\n ./design-system.json)\n --theme <name> Theme to judge classes against, when --input is a site config\n -f, --format <fmt> Format you build (bricks | css | tailwind; default: bricks).\n Responsive md-* classes are real in css/bricks, inert in tailwind.\n -s, --src <dir> Directory to scan (default: ./src)\n --strict Also fail on suggestions (reuse hints), not just on\n classes that resolve to nothing\n [files...] Lint these paths instead of scanning --src. Unreadable\n and non-source paths are skipped, so this can be wired\n into a pre-commit hook that appends the staged files.\n --fix Rewrite pre-1.0 colour-grammar token references\n (var(--<role>-<suffix>) → var(--color-<target>-<role>…))\n in CSS and <style> blocks. Applied in ONE pass, so the\n renames that rotate cannot compound. Nothing else is\n rewritten — every other finding is a judgement call.\n\n Run this after a major bump: it is the migration tool for anything the\n changelog says was renamed.\n\nLegal options:\n -i, --input <path> Site config: .json, or a .js/.ts module with a default\n export (default: ./site.json)\n -d, --doc <name> privacy | terms | cookies (repeatable; default: those\n enabled in the config)\n -f, --format <fmt> md | html | portable-text (default: md)\n html suits WordPress/Bricks and plain sites;\n portable-text suits EmDash\n -o, --out <dir> Write files here (default: print to stdout)\n --site-env <env> Environment whose A/B variant applies (default: production)\n\n Generated from your config — a starting point, not legal advice. Review before\n publishing, and make sure the config describes what your site actually does.\n\nRobots options:\n -i, --input <path> Site config: .json, or a .js/.ts module with a default\n export (default: ./site.json)\n -o, --out <dir> Write robots.txt here (default: print to stdout)\n --site-env <env> Which site.environments entry to render for (default: production)\n\n Reads the resolved environment's robots directive (falling back to\n site.seo.robots) — the same fact vitops search notify's noindex gate already\n reads. A directive containing noindex disallows every user agent and emits\n no Sitemap line; otherwise it allows everything and links\n site.seo.indexing.sitemapUrl, or the derived <canonical>/sitemap-index.xml.\n\nReviews options:\n -i, --input <path> Site config carrying site.reviews (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n --location <key> Fetch only this site.reviews.locations key\n --cache <path> Where to read/write the cache (default: .vitops/reviews.json)\n --out <dir> Also write the selected reviews per location as JSON here\n --dry Print the plan and exit. Fetches nothing.\n --check Fetch and diff against the cache; exit non-zero on drift.\n Mutates nothing.\n\n Reviews live only on the legacy Business Profile v4 API — there is no newer\n replacement — and the calling GCP project must be allowlisted by Google before\n any call succeeds (a one-time approval; a 403 says so rather than failing\n opaquely). Auth is user OAuth, the same VITOPS_GOOGLE_CLIENT_ID /\n VITOPS_GOOGLE_CLIENT_SECRET / VITOPS_GOOGLE_REFRESH_TOKEN (or ADC login) that\n vitops search setup uses, scoped to business.manage. The cache is meant to be\n committed: reviews change slowly, and a build should not need a live Google\n credential. Review JSON-LD is off by default (site.reviews.schema) — a business\n marking up reviews of itself is not eligible for Google's rich results and\n risks a manual action.\n\nSearch subcommands:\n vitops search setup [opts] Onboard site.searchConsole domains into GSC\n vitops search notify [opts] Tell search engines about a deploy (sitemap + IndexNow)\n\nSearch setup options:\n -i, --input <path> Site config carrying site.searchConsole (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n --domain <name> Scope to a single site.searchConsole entry\n --dry Print the plan and exit. Changes nothing, and runs without\n credentials (planning from scratch, which it says).\n --check Report drift and exit non-zero if any domain is not fully\n onboarded. Mutates nothing, but does need credentials —\n drift is a comparison against live state.\n\n For each domain it ensures the apex verification TXT in Cloudflare, verifies\n ownership (DNS_TXT, retried with backoff while DNS propagates — a still-\n unverified domain is reported PENDING, not failed), adds the sc-domain: property,\n and adds any delegatedOwners to the web resource. DNS is only ever created,\n never edited or deleted. Credentials come from the environment:\n CLOUDFLARE_API_TOKEN (Zone:DNS:Edit + Zone:Read — the standard \"Edit zone DNS\"\n template covers both; Zone:Read is what the zone-by-name lookup uses), and\n VITOPS_GOOGLE_CLIENT_ID /\n VITOPS_GOOGLE_CLIENT_SECRET / VITOPS_GOOGLE_REFRESH_TOKEN (a user OAuth token\n scoped to siteverification + webmasters). Granting a Google Group Full-User\n access has no API and is surfaced as a reminder.\n\n Or just be logged in: with no VITOPS_GOOGLE_* set, an Application Default\n Credentials login is used —\n gcloud auth application-default login \\\n --scopes=openid,https://www.googleapis.com/auth/siteverification,\\\n https://www.googleapis.com/auth/webmasters,https://www.googleapis.com/auth/cloud-platform\n ADC authenticates through a shared OAuth client that owns no project, so it also\n needs site.google.project in the config (sent as x-goog-user-project), both APIs\n enabled on that project, and serviceusage.services.use on it. One project per site\n is what keeps each site's API usage and billing separate.\n\nSearch notify options:\n -i, --input <path> Site config carrying seo.indexing (default: ./site.json)\n --site-env <env> Environment to notify for (default: production). An\n environment whose robots policy says noindex is refused.\n --sitemap <src> Sitemap URL or local path (default: from the config)\n --urls <list> Comma-separated URLs to submit, skipping the diff\n --all Submit every URL in the sitemap, not just what changed\n --dry Print the plan and exit. Makes no requests.\n --check Read-only: ask Google whether seo.indexing.priorityUrls\n are indexed. Exits non-zero if one is not.\n --new-key Print a fresh IndexNow key and exit\n --write-key <dir> Write the IndexNow key file into <dir> (for stacks with\n no Astro integration to do it — Bricks, WordPress)\n --snapshot <path> Changed-URL state file (default: .vitops/sitemap-snapshot.json).\n Persist it between runs (a CI cache) or every run submits\n everything.\n\n What notify can and cannot do: Google exposes no \"request indexing\" API, and its\n sitemap ping endpoint was removed in 2023 — so it resubmits your sitemap\n through the Search Console API and verifies the result with --check. IndexNow\n reaches Bing, Yandex, Naver, Seznam and Yep; Google does not participate.\n Search Console takes either credential, whichever you already have, added as an\n owner of the property: a service account in VITOPS_GSC_SERVICE_ACCOUNT (inline\n JSON) or GOOGLE_APPLICATION_CREDENTIALS (a path), or the same user OAuth\n credential \"search setup\" uses (VITOPS_GOOGLE_CLIENT_ID / _CLIENT_SECRET /\n _REFRESH_TOKEN). The service account is preferred when both are set — this runs\n on every deploy, and it does not expire.\n\nAds subcommands:\n vitops ads setup [opts] Ensure each platform's domain-verification DNS record\n vitops ads tags [opts] Print the consent-gated pixel snippets\n vitops ads lint [opts] Report ad properties the rest of the config can't see\n\nAds setup options:\n -i, --input <path> Site config carrying site.ads (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n --provider <name> Scope to one site.ads entry (google | meta | linkedin |\n reddit | tiktok | microsoft | pinterest | snapchat)\n --dry Print the plan and exit. Creates nothing. With\n CLOUDFLARE_API_TOKEN set it reads live DNS first, so the\n plan says what is already done; without one it plans from\n scratch and says so, rather than refusing to run.\n --check Report drift and exit non-zero if any property is not\n linked. Mutates nothing, prompts for nothing.\n --no-prompt Never ask for a missing token; fail with the field name\n instead (the default when stdin is not a TTY, e.g. in CI)\n --no-write Don't persist an answered token back into the config\n\n Four platforms verify a domain by DNS TXT — Meta, TikTok, Pinterest, Snapchat —\n and that record is the one thing this creates for you (in Cloudflare, via\n CLOUDFLARE_API_TOKEN; created only, never edited or deleted). Google Ads,\n LinkedIn, Reddit and Microsoft Ads have no domain verification at all: linking\n there is the tag and the account ID, and the run says so rather than skipping in\n silence. No platform Marketing API is called — Meta's needs a system-user token\n and Google's needs an approved developer token, so the final \"Verify\" click stays\n a reminder. The verification token is not a secret (it is published in DNS, which\n is the ownership proof), so it lives in the config and is prompted for on the\n first run.\n\nAds tags options:\n -i, --input <path> Site config carrying site.ads (default: ./site.json)\n --provider <name> Print one platform's tag\n --strategy <s> idle | async | interaction (default: idle)\n\n Prints each pixel as an INERT, consent-gated <script>: type=\"text/plain\" with the\n library URL on data-src, so an undecided visitor's page issues no third-party\n request. For stacks with no Astro integration — Bricks, WordPress, Eleventy.\n Paste into your template; @getvitops/core's consent runtime activates them.\n\nAds lint options:\n -i, --input <path> Site config carrying site.ads (default: ./site.json)\n\n Reports the gaps that are invisible at runtime: a click-ID parameter this\n platform stamps that attribution doesn't capture, a pixel while site.tracking is\n off (every conversion arrives unattributed), and a configured property with no\n tag ID. Exits non-zero on a finding.\n\nCrm check options:\n -i, --input <path> Site config carrying site.crm (default: ./site.json)\n --site-env <env> Environment to resolve (default: production)\n\n Fetches the live field/property list (HubSpot: crm/v3/properties/contacts;\n Bigin: bigin/v2/settings/fields) and reports every fieldMap/trackingFields\n target that doesn't exist there. HubSpot rejects a submission naming an\n unrecognised property; Bigin silently ignores it — this is the only way to\n see a broken mapping before a real submission finds it. Needs\n VITOPS_HUBSPOT_ACCESS_TOKEN, VITOPS_ZOHO_CLIENT_ID/_CLIENT_SECRET/\n _REFRESH_TOKEN, or (unused for now) VITOPS_JOBBER_CLIENT_ID/_CLIENT_SECRET/\n _REFRESH_TOKEN, matching whichever provider site.crm names. Jobber currently\n renders fieldMap/trackingFields as note-text lines rather than app-configured\n custom fields, so there is nothing live to check there yet. Exits non-zero\n on any missing target.\n\nCrm setup options:\n -i, --input <path> Site config carrying site.crm (default: ./site.json)\n --site-env <env> Environment to resolve (default: production)\n --dry Print what would be created and exit. Creates nothing.\n\n HubSpot: creates missing contact properties named by fieldMap/trackingFields.\n Bigin: no such API exists, so this always prints a manual reminder listing\n the fields to add in Zoho Bigin's field editor, then re-run \"crm check\".\n Jobber: app-configured custom fields aren't wired up yet, so this prints a\n reminder instead of creating anything.\n\nSetup repo options:\n --dry Print the plan and exit\n --check Report drift/blocked steps and exit non-zero, mutating nothing\n --public Create the repo public (default: private)\n --platform <p> cloudflare (default) | node — shown for parity with the hosting stage's plan\n --no-dev-resources Same — this stage never provisions D1/R2 either way\n\n Creates the GitHub repo (via `gh`), pushes main + dev, makes dev the default\n branch, and requests main branch protection + the production/dev environments.\n Idempotent — a re-run of a fully set-up repo is all skips. Branch protection and\n environment reviewers 403 on a private repo without GitHub Pro/Team; that is\n reported as blocked, with the manual Settings path, never as a failure.\n\nSetup hosting options:\n --dry Print the plan and exit\n --check Report drift/blocked steps and exit non-zero, mutating nothing\n --platform <p> cloudflare (default) | node\n --no-dev-resources Skip D1/R2 — a pure static Workers Assets project has\n nothing to provision, just the account id + token\n\n Provisions the isolated dev D1 database + R2 bucket (cloudflare) and sets the\n DEV_D1_ID / CLOUDFLARE_ACCOUNT_ID repo secrets, once `vitops setup repo` has run.\n CLOUDFLARE_API_TOKEN is always reported as blocked — no API can create one; see\n the printed dashboard link. Requires `npx wrangler login` first.\n\nSetup domain options:\n -i, --input <path> Site config (default: ./site.json)\n --site-env <env> Environment to check (default: production)\n --dry Print the plan and exit\n --check Exit non-zero if the domain state is inconsistent\n --domain <apex> Print the manual cutover steps for this apex\n\n Plans and checks the consistency between wrangler.jsonc's workers.dev/custom-domain\n state and site.json's environments/domains/robots — it NEVER edits wrangler.jsonc\n or deploys. Cutover overwrites the zone's DNS record and can take an existing live\n site down; that step is manual, on purpose. See SETUP.html's \"Domain strategy\" stage.\n\nSetup turnstile options:\n -i, --input <path> Site config (default: ./site.json)\n --site-env <env> Environment to read (default: production)\n --dry Print the plan and exit (needs no token)\n --check Exit non-zero if no widget/site key is set up; mutates nothing\n --no-write Do not write site.security.turnstile.siteKey back to the config\n --no-secret Do not run `wrangler secret put` for the new widget's secret\n\n Creates a managed Turnstile widget for the site's hostnames (canonical + each\n environment URL) unless one already covers them, and writes the PUBLIC site key to\n site.security.turnstile.siteKey. The SECRET is returned once at creation: it is piped\n to `wrangler secret put VITOPS_TURNSTILE_SECRET` and never written to a config file.\n Never edits, rotates or deletes an existing widget.\n Needs CLOUDFLARE_API_TOKEN with \"Account > Turnstile > Edit\", plus CLOUDFLARE_ACCOUNT_ID\n (or a token that can list accounts), and `wrangler login` for the secret.\n\nSetup search options:\n Forwards every option to `vitops search setup` unchanged — see \"Search setup\n options:\" above.\n\nSetup ads options:\n Forwards every option to `vitops ads setup` unchanged — see \"Ads setup options:\"\n above.\n\nSetup all options:\n --dry Print every stage's plan and exit\n --check Report drift across every stage and exit non-zero\n --public Create the repo public, for the repo stage\n --platform <p> cloudflare (default) | node, for the repo + hosting stages\n --no-dev-resources Skip D1/R2 in the hosting stage (repo stage never provisions them)\n\n Runs repo, hosting, search, ads in order. Stops at the first stage that fails;\n a blocked step (the API token, GitHub Pro/Team gating) is reported, not fatal.\n\nEmdash subcommands:\n vitops emdash prepare-db Migrate and seed the local D1 the build prerenders from\n vitops emdash check-prerender [d] Fail if a prerendered page is not a real page\n vitops emdash build [d] astro build, then check-prerender; fails on blocks with no renderer\n\nEmdash prepare-db options:\n (none) Starts `astro dev` once, calls EmDash's dev-bypass setup (migrates, applies the\n seed's sample content), checks the home page renders, stops. Only writes the\n disposable .wrangler/state. SKIP_PREPARE_LOCAL_DB=1 skips it.\n\nEmdash check-prerender options:\n [dir] Build output to check (default: dist/client). Fails on a page that carries the\n pending-migrations message, is not an HTML document, or has no <title>.\n --strict Also fail (not just warn) when a page uses a type-role class (font-display, …)\n the built CSS has no rule for, links to pages the build did not produce, a page without\n exactly one <h1>, or a form with nowhere to send it (reads ./site.json, or --site=<path>).\n\nEmdash build options:\n [dir] Runs `astro build`, then check-prerender on [dir] (default: dist/client). Also fails\n when the build reports a block type with no component (\"PortableText\n [components.type] is missing …\"): the page was published without that content.\n --strict Passed through to check-prerender.\n\nEmail subcommands:\n vitops email setup [domain] Onboard a from-address domain, waiting for its DNS to resolve\n vitops email check [opts] Non-blocking deploy guard: warn if a from domain isn't onboarded\n\nEmail setup options:\n -i, --input <path> Site config carrying site.notifications.email (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n [domain] Onboard this exact name instead of deriving candidates from\n config + a source scan\n --src <dir> Source to scan for from: literals as a supplement to config\n (default: ./src)\n --dry Print the plan and exit. Needs no credential — plans from\n scratch and says so.\n --check Report drift and exit non-zero. Mutates nothing.\n --no-prompt Never ask before enabling a domain (the default when\n stdin is not a TTY, e.g. in CI — it just enables)\n --timeout <s> Cap on each DNS-propagation poll wait, in seconds (default: 5)\n\n The onboarded entity is an EXACT name, and it is usually a subdomain\n (send.example.com), never the apex a from address names. When the exact\n domain is absent but a sibling in the same zone is already onboarded, this\n is reported blocked rather than silently enabling the apex too — enabling\n it rewrites _dmarc.<domain>, which can tighten policy on every OTHER mail\n sent from that domain. Sending from the onboarded sibling is the\n recommended fix. Needs CLOUDFLARE_API_TOKEN (Zone:Read + an Email Sending\n scope — broader than the \"Edit zone DNS\" template other commands use).\n\nEmail check options:\n -i, --input <path> Site config carrying site.notifications.email (default: ./site.json)\n --site-env <env> Environment whose A/B variant applies (default: production)\n --src <dir> Source to scan for from: literals (default: ./src)\n --strict Exit non-zero on drift (the default just warns and exits 0)\n --skip Skip the check entirely (same as VITOPS_SKIP_EMAIL_CHECK)\n\n Meant to run before a deploy. With no CLOUDFLARE_API_TOKEN it reports \"not\n checked\" and exits 0, so a CI job without the secret never fails on the\n check itself. Skip per-site with site.notifications.email.verifySender: false\n when the scan can't see the real from address and the warning would be a\n false positive.\n\nMedia options:\n --raw <dir> Directory of unprocessed video, walked recursively\n (default: ./raw)\n -o, --out <dir> Where the encoded outputs go (default: ./src/assets/processed).\n Subdirectories under --raw are preserved.\n --max-width <px> Cap the output width, keeping aspect ratio (default: 1920;\n 0 disables scaling)\n --crf <n> Quality on VP9's scale, 0-63, lower is better (default: 32).\n The MP4 fallback uses the equivalent on H.264's scale.\n --max-bitrate <r> Optional ceiling, e.g. 2M or 800k (default: none, which is\n constant quality rather than constrained)\n --audio Keep the audio track (default: dropped — the common case is\n a muted autoplay loop)\n --poster-time <s> Timestamp the poster frame is taken from (default: 0, which\n is often black on a clip that fades in)\n --outputs <list> Comma-separated: webm | mp4 | poster (default: all three)\n --manifest <path> Cache file (default: .vitops/media-manifest.json)\n --force Re-encode everything, ignoring the cache\n --dry Print the plan and exit. Encodes nothing.\n\n Needs ffmpeg on PATH — it is an external tool, not an npm dependency, and this\n command fails rather than quietly skipping. Commit the outputs and the manifest:\n ffmpeg output is not reproducible across versions, so re-encoding in CI churns\n the diff on every toolchain bump. Use --force when you mean to re-encode.\n\nAudit options:\n --build Run `astro build` first (default: audit the existing build)\n --url <base> Audit an already-running server instead of `astro preview`\n --port <n> Port for `astro preview` (default: 4398; aborts if taken)\n --dir <path> Project directory (default: .)\n --pages <list> Extra comma-separated paths. The page list is the built sitemap\n plus links in seed/seed.json's primary* and footer* menus; only\n when neither exists are / /privacy /terms /cookies /contact\n guessed. A 404 skips a page (with its reason in the report); a\n 404 on / fails the run.\n --no-defaults Never guess the default pages\n --seed <path> EmDash seed to read menus from (default: seed/seed.json if present)\n --lcp <ms> LCP budget (default: 2500)\n --cls <n> CLS budget (default: 0.1)\n --tbt <ms> Total Blocking Time budget, the INP proxy (default: 200)\n --impact <list> axe impacts that fail a page (default: serious,critical)\n --form-factor <f> mobile | desktop Lighthouse profile (default: mobile)\n -o, --out <dir> Report directory (default: .vitops/audit): report.json, report.md,\n and pages/<page>.{json,md}\n --warn Report without failing (exit 0), for first adoption\n\n Needs the optional packages: vp add -D playwright @axe-core/playwright lighthouse\n && vp exec playwright install chromium (checked before any server starts). A pass means no automated axe violations and the\n budgets held — it is NOT AODA certification; report.md lists the manual checks.\n\nCommon:\n -h, --help Show this help\n";
|
|
926
936
|
}
|
|
927
937
|
|
|
928
938
|
// src/commands/search.ts
|
|
@@ -2409,6 +2419,19 @@ function prerenderProblem(html) {
|
|
|
2409
2419
|
if (PENDING_MIGRATIONS.test(html)) return "carries the pending-migrations message";
|
|
2410
2420
|
if (!/<html[\s>]/i.test(html)) return "is not an HTML document";
|
|
2411
2421
|
if (!/<title>[^<]+<\/title>/i.test(html)) return "has no <title>";
|
|
2422
|
+
const unrendered = unrenderedBlocks(html);
|
|
2423
|
+
if (unrendered.length) return `dropped block(s) with no renderer: ${unrendered.join(", ")} (see \`PortableText [components.type] is missing\` in the build log)`;
|
|
2424
|
+
}
|
|
2425
|
+
/**
|
|
2426
|
+
* `vitops_*` block types a page's nested body dropped. `vitops_section` and widget areas emit a
|
|
2427
|
+
* `data-vitops-unrendered="<type>"` marker for each, so a page whose sections rendered as
|
|
2428
|
+
* headings over empty bodies fails here instead of passing for a real page. (The build-log check in
|
|
2429
|
+
* `vitops emdash build` also catches top-level bodies, which carry no marker.)
|
|
2430
|
+
*/
|
|
2431
|
+
function unrenderedBlocks(html) {
|
|
2432
|
+
const types = /* @__PURE__ */ new Set();
|
|
2433
|
+
for (const m of html.matchAll(/data-vitops-unrendered\s*=\s*"([^"]+)"/gi)) types.add(m[1]);
|
|
2434
|
+
return [...types].sort();
|
|
2412
2435
|
}
|
|
2413
2436
|
const TYPE_ROLE_CLASS = new RegExp(`^font-(?:${[
|
|
2414
2437
|
"display",
|
|
@@ -2433,7 +2456,7 @@ function classesIn(html) {
|
|
|
2433
2456
|
* Type-role classes a page uses that the built stylesheet has no rule for.
|
|
2434
2457
|
*
|
|
2435
2458
|
* Tailwind v4 does not scan `node_modules`, so a utility used only by a package's own renderer
|
|
2436
|
-
* (`font-display` in `
|
|
2459
|
+
* (`font-display` in `vitops_stats`) was never generated, and the page rendered at body size with
|
|
2437
2460
|
* no error. The type roles are the one family checkable without the site's config: the list is
|
|
2438
2461
|
* closed. A class is "defined" when the CSS names it as a selector.
|
|
2439
2462
|
*/
|
|
@@ -2441,6 +2464,106 @@ function missingTypeRoleRules(html, css) {
|
|
|
2441
2464
|
const defined = (cls) => new RegExp(`\\.${cls}(?![\\w-])`).test(css);
|
|
2442
2465
|
return [...classesIn(html)].filter((c) => TYPE_ROLE_CLASS.test(c) && !defined(c)).sort();
|
|
2443
2466
|
}
|
|
2467
|
+
/**
|
|
2468
|
+
* Block types EmDash's `<PortableText>` reported as having no component, from a build's output.
|
|
2469
|
+
*
|
|
2470
|
+
* `astro build` prints `PortableText [components.type] is missing "vitops_cards"` once per
|
|
2471
|
+
* occurrence and carries on, rendering nothing for that block. A single missing renderer is a
|
|
2472
|
+
* page published with its content gone, and the prerender guard cannot see it in the HTML. The
|
|
2473
|
+
* known cause is an import cycle that empties the plugin's block map for a whole build, so the
|
|
2474
|
+
* warning arrives dozens of times; it is reported once per type.
|
|
2475
|
+
*/
|
|
2476
|
+
function missingBlockComponents(log) {
|
|
2477
|
+
const plain = log.replace(/\u001b\[[0-9;]*m/g, "");
|
|
2478
|
+
const seen = /* @__PURE__ */ new Set();
|
|
2479
|
+
for (const m of plain.matchAll(/PortableText \[components\.type\] is missing "([^"]+)"/g)) seen.add(m[1]);
|
|
2480
|
+
return [...seen].sort();
|
|
2481
|
+
}
|
|
2482
|
+
/**
|
|
2483
|
+
* How many `<h1>` a page has. A page with none has no title in its outline; a page with two (a
|
|
2484
|
+
* hero left on its `h1` default beside a layout title) has a muddled one. Counted outside
|
|
2485
|
+
* `<template>`, `<script>` and comments so inert markup does not skew it.
|
|
2486
|
+
*/
|
|
2487
|
+
function h1Count(html) {
|
|
2488
|
+
return (html.replace(/<!--[\s\S]*?-->/g, "").replace(/<(script|template|style)[\s\S]*?<\/\1>/gi, "").match(/<h1[\s>]/gi) ?? []).length;
|
|
2489
|
+
}
|
|
2490
|
+
/** The URL path a built `.html` file is served at: `a/index.html` and `a.html` are both `/a`. */
|
|
2491
|
+
function routeOf(relativeFile) {
|
|
2492
|
+
const path = "/" + relativeFile.replace(/\\/g, "/").replace(/(^|\/)index\.html$/, "$1").replace(/\.html$/, "");
|
|
2493
|
+
return path.length > 1 ? path.replace(/\/+$/, "") : "/";
|
|
2494
|
+
}
|
|
2495
|
+
/**
|
|
2496
|
+
* Site-relative links in a page that point at a route the build did not produce: a planned link
|
|
2497
|
+
* (`/pricing` in a menu before the page exists) that would 404. Anchors, query-only links, assets
|
|
2498
|
+
* (anything with a file extension), `/_emdash/*` and `/api/*` (Worker routes) are not judged.
|
|
2499
|
+
*/
|
|
2500
|
+
function brokenInternalLinks(html, routes) {
|
|
2501
|
+
const live = html.replace(/<!--[\s\S]*?-->/g, "").replace(/<(script|template|style)[\s\S]*?<\/\1>/gi, "");
|
|
2502
|
+
const broken = /* @__PURE__ */ new Set();
|
|
2503
|
+
for (const m of live.matchAll(/<a\s[^>]*?href\s*=\s*(?:"([^"]*)"|'([^']*)')/gi)) {
|
|
2504
|
+
const href = (m[1] ?? m[2] ?? "").trim();
|
|
2505
|
+
if (!href.startsWith("/") || href.startsWith("//")) continue;
|
|
2506
|
+
const path = href.split(/[?#]/)[0] || "/";
|
|
2507
|
+
if (/\.[a-z0-9]{1,8}$/i.test(path) || path.startsWith("/_") || path.startsWith("/api/")) continue;
|
|
2508
|
+
const norm = path.length > 1 ? path.replace(/\/+$/, "") : path;
|
|
2509
|
+
if (!routes.has(norm)) broken.add(norm);
|
|
2510
|
+
}
|
|
2511
|
+
return [...broken].sort();
|
|
2512
|
+
}
|
|
2513
|
+
/** Whether a built page carries the `vitops_form` block's post (to the conversion route). */
|
|
2514
|
+
function hasConversionForm(html) {
|
|
2515
|
+
return /<form[^>]*\saction\s*=\s*["']\/api\/track["']/i.test(html);
|
|
2516
|
+
}
|
|
2517
|
+
/**
|
|
2518
|
+
* Why a site with a form has nowhere to send it, or `undefined` when something is configured.
|
|
2519
|
+
* `createConversionRoute` refuses a post with no recipient and no CRM rather than accept a message
|
|
2520
|
+
* nobody receives, so the first visitor to submit would be told it failed. A recipient is
|
|
2521
|
+
* `site.notifications.email` (a bare address, or `{ to }`) or a location `email`; a CRM also counts.
|
|
2522
|
+
*/
|
|
2523
|
+
function deliveryProblem(config) {
|
|
2524
|
+
const c = config ?? {};
|
|
2525
|
+
const locations = c.organization?.locations;
|
|
2526
|
+
const locationEmails = (Array.isArray(locations) ? locations : Object.values(locations ?? {})).map((l) => l?.email).filter((e) => typeof e === "string" && e !== "");
|
|
2527
|
+
return hasFormDelivery({
|
|
2528
|
+
notifications: c.site?.notifications,
|
|
2529
|
+
locationEmails
|
|
2530
|
+
}, c.site?.crm) ? void 0 : "no recipient: set `site.notifications.email`, or give an organization location an `email`, or configure `site.crm`";
|
|
2531
|
+
}
|
|
2532
|
+
const NOT_COLLECTED = /* @__PURE__ */ new Set([
|
|
2533
|
+
"_next",
|
|
2534
|
+
"website",
|
|
2535
|
+
"honeypot",
|
|
2536
|
+
"_honeypot",
|
|
2537
|
+
"cf-turnstile-response"
|
|
2538
|
+
]);
|
|
2539
|
+
/**
|
|
2540
|
+
* The visitor-supplied field names of the form that posts to `/api/track`, from the built HTML:
|
|
2541
|
+
* every named control except the hidden ones, the honeypot and the Turnstile token, which are not
|
|
2542
|
+
* personal information the visitor gave. Repeated names (a tick-box group) count once.
|
|
2543
|
+
*/
|
|
2544
|
+
function formFieldNames(html) {
|
|
2545
|
+
const names = /* @__PURE__ */ new Set();
|
|
2546
|
+
for (const form of html.matchAll(/<form[^>]*\saction\s*=\s*["']\/api\/track["'][^>]*>([\s\S]*?)<\/form>/gi)) for (const m of form[1].matchAll(/<(input|textarea|select)\b([^>]*)>/gi)) {
|
|
2547
|
+
const attrs = m[2];
|
|
2548
|
+
if (/\stype\s*=\s*["']hidden["']/i.test(attrs)) continue;
|
|
2549
|
+
const name = /\sname\s*=\s*["']([^"']+)["']/i.exec(attrs)?.[1];
|
|
2550
|
+
if (name && !NOT_COLLECTED.has(name)) names.add(name);
|
|
2551
|
+
}
|
|
2552
|
+
return [...names].sort();
|
|
2553
|
+
}
|
|
2554
|
+
/**
|
|
2555
|
+
* Form fields that are on a built page but not in any `site.templates` form entry. `vitops legal`
|
|
2556
|
+
* derives "what personal information we collect" from those entries, not from the editor's block,
|
|
2557
|
+
* so a field added in the admin is invisible to the generated privacy policy until mirrored.
|
|
2558
|
+
*/
|
|
2559
|
+
function uninventoriedFields(config, built) {
|
|
2560
|
+
const templates = config?.site?.templates;
|
|
2561
|
+
const known = /* @__PURE__ */ new Set();
|
|
2562
|
+
for (const tpl of Object.values(templates ?? {})) if (tpl?.type === "form") {
|
|
2563
|
+
for (const f of tpl.fields ?? []) if (f?.name) known.add(f.name);
|
|
2564
|
+
}
|
|
2565
|
+
return built.filter((name) => !known.has(name));
|
|
2566
|
+
}
|
|
2444
2567
|
|
|
2445
2568
|
// src/commands/emdash.ts
|
|
2446
2569
|
/**
|
|
@@ -2453,6 +2576,7 @@ function missingTypeRoleRules(html, css) {
|
|
|
2453
2576
|
*
|
|
2454
2577
|
* prepare-db migrate and seed the LOCAL D1 the build prerenders from
|
|
2455
2578
|
* check-prerender fail if a prerendered page is not a real page
|
|
2579
|
+
* build `astro build`, then the same checks, plus a failure for any block with no renderer
|
|
2456
2580
|
*
|
|
2457
2581
|
* Why both exist: `astro build` prerenders every page inside a local workerd against a local D1
|
|
2458
2582
|
* (`.wrangler/state`), never the deployed database. The template sets
|
|
@@ -2555,6 +2679,11 @@ function cmdCheckPrerender(argv) {
|
|
|
2555
2679
|
if (!existsSync(root)) fail(`${root} does not exist (run \`astro build\` first).`);
|
|
2556
2680
|
const bad = [];
|
|
2557
2681
|
const unstyled = [];
|
|
2682
|
+
const outline = [];
|
|
2683
|
+
const dead = [];
|
|
2684
|
+
let formPage;
|
|
2685
|
+
const formFields = /* @__PURE__ */ new Set();
|
|
2686
|
+
const routes = new Set([...htmlFiles(root)].map((f) => routeOf(relative(root, f))));
|
|
2558
2687
|
const css = cssFiles(root).map((f) => readFileSync(f, "utf8")).join("\n");
|
|
2559
2688
|
let count = 0;
|
|
2560
2689
|
for (const file of htmlFiles(root)) {
|
|
@@ -2562,7 +2691,19 @@ function cmdCheckPrerender(argv) {
|
|
|
2562
2691
|
const html = readFileSync(file, "utf8");
|
|
2563
2692
|
const why = prerenderProblem(html);
|
|
2564
2693
|
if (why) bad.push(` ${file} ${why}`);
|
|
2565
|
-
else
|
|
2694
|
+
else {
|
|
2695
|
+
const h1s = h1Count(html);
|
|
2696
|
+
if (h1s !== 1 && !file.endsWith("/404.html")) outline.push(` ${file}: ${h1s} <h1>`);
|
|
2697
|
+
}
|
|
2698
|
+
if (!why && hasConversionForm(html)) {
|
|
2699
|
+
formPage ??= file;
|
|
2700
|
+
for (const n of formFieldNames(html)) formFields.add(n);
|
|
2701
|
+
}
|
|
2702
|
+
if (!why) {
|
|
2703
|
+
const links = brokenInternalLinks(html, routes);
|
|
2704
|
+
if (links.length) dead.push(` ${file}: ${links.join(", ")}`);
|
|
2705
|
+
}
|
|
2706
|
+
if (!why && css) {
|
|
2566
2707
|
const missing = missingTypeRoleRules(html, css);
|
|
2567
2708
|
if (missing.length) unstyled.push(` ${file}: ${missing.join(", ")}`);
|
|
2568
2709
|
}
|
|
@@ -2574,19 +2715,83 @@ function cmdCheckPrerender(argv) {
|
|
|
2574
2715
|
if (strict) fail(note);
|
|
2575
2716
|
console.warn(`check-prerender: warning: ${note}`);
|
|
2576
2717
|
}
|
|
2718
|
+
if (formPage) {
|
|
2719
|
+
const siteFile = argv.find((a) => a.startsWith("--site="))?.slice(7) ?? "site.json";
|
|
2720
|
+
let siteConfig;
|
|
2721
|
+
try {
|
|
2722
|
+
if (existsSync(siteFile)) siteConfig = JSON.parse(readFileSync(siteFile, "utf8"));
|
|
2723
|
+
} catch {
|
|
2724
|
+
siteConfig = void 0;
|
|
2725
|
+
}
|
|
2726
|
+
if (siteConfig) {
|
|
2727
|
+
const problem = deliveryProblem(siteConfig);
|
|
2728
|
+
if (problem) {
|
|
2729
|
+
const note = `${formPage} has a form, but ${problem}. The route refuses submissions until one is set, so the first visitor to send a message would be told it failed. Run \`vitops email setup\` for the sender domain once it is.`;
|
|
2730
|
+
if (strict) fail(note);
|
|
2731
|
+
console.warn(`check-prerender: warning: ${note}`);
|
|
2732
|
+
}
|
|
2733
|
+
const missing = uninventoriedFields(siteConfig, [...formFields].sort());
|
|
2734
|
+
if (missing.length) {
|
|
2735
|
+
const note = `the form collects ${missing.join(", ")}, which no site.templates form entry in ${siteFile} lists. \`vitops legal\` builds the privacy policy's "what we collect" from those entries, so the generated policy would under-report. Mirror the fields in a \`type: "form"\` template.`;
|
|
2736
|
+
if (strict) fail(note);
|
|
2737
|
+
console.warn(`check-prerender: warning: ${note}`);
|
|
2738
|
+
}
|
|
2739
|
+
}
|
|
2740
|
+
}
|
|
2741
|
+
if (dead.length) {
|
|
2742
|
+
const note = `links to pages the build did not produce (they would 404):\n${dead.join("\n")}\n\nPublish the page, or mark the menu item as a planned link by adding \`draft\` to its CSS classes so it is not rendered until the page exists.`;
|
|
2743
|
+
if (strict) fail(note);
|
|
2744
|
+
console.warn(`check-prerender: warning: ${note}`);
|
|
2745
|
+
}
|
|
2746
|
+
if (outline.length) {
|
|
2747
|
+
const note = `pages whose outline has not exactly one <h1>:\n${outline.join("\n")}\n\nGive each page one: set a \`vitops_hero\` (or section) heading level to h1, or let the layout render the title, and make other display headings h2 or p.`;
|
|
2748
|
+
if (strict) fail(note);
|
|
2749
|
+
console.warn(`check-prerender: warning: ${note}`);
|
|
2750
|
+
}
|
|
2577
2751
|
console.log(`check-prerender: ${count} prerendered page(s) look like real pages.`);
|
|
2578
2752
|
}
|
|
2753
|
+
/**
|
|
2754
|
+
* `astro build` and then `check-prerender`, failing on any block type EmDash reported as having
|
|
2755
|
+
* no component. That report is a build-log warning, not an exit code, so the build's output is
|
|
2756
|
+
* streamed through unchanged and scanned afterwards.
|
|
2757
|
+
*/
|
|
2758
|
+
async function cmdBuild(argv) {
|
|
2759
|
+
const bin = existsSync("node_modules/.bin/astro") ? "node_modules/.bin/astro" : "astro";
|
|
2760
|
+
let log = "";
|
|
2761
|
+
const code = await new Promise((resolve) => {
|
|
2762
|
+
const child = spawn(bin, ["build"], { stdio: [
|
|
2763
|
+
"inherit",
|
|
2764
|
+
"pipe",
|
|
2765
|
+
"pipe"
|
|
2766
|
+
] });
|
|
2767
|
+
child.stdout.on("data", (d) => {
|
|
2768
|
+
log += d;
|
|
2769
|
+
process.stdout.write(d);
|
|
2770
|
+
});
|
|
2771
|
+
child.stderr.on("data", (d) => {
|
|
2772
|
+
log += d;
|
|
2773
|
+
process.stderr.write(d);
|
|
2774
|
+
});
|
|
2775
|
+
child.on("error", () => resolve(1));
|
|
2776
|
+
child.on("close", (c) => resolve(c ?? 1));
|
|
2777
|
+
});
|
|
2778
|
+
if (code !== 0) process.exit(code);
|
|
2779
|
+
const missing = missingBlockComponents(log);
|
|
2780
|
+
if (missing.length) fail(`the build rendered nothing for these block types (no component registered):\n` + missing.map((t) => ` ${t}`).join("\n") + "\n\nEvery page using them was published without that content. If they are `vitops_*` blocks, the plugin block map was empty for this build: check that no module imported by `@getvitops/emdash/astro` imports `emdash/ui` statically (an import cycle), and that the plugin is registered in astro.config.mjs.");
|
|
2781
|
+
cmdCheckPrerender(argv);
|
|
2782
|
+
}
|
|
2579
2783
|
async function cmdEmdash(argv) {
|
|
2580
2784
|
const [sub, ...rest] = argv;
|
|
2581
2785
|
switch (sub) {
|
|
2582
2786
|
case "prepare-db": return cmdPrepareDb();
|
|
2583
2787
|
case "check-prerender": return cmdCheckPrerender(rest);
|
|
2788
|
+
case "build": return cmdBuild(rest);
|
|
2584
2789
|
case void 0:
|
|
2585
2790
|
case "-h":
|
|
2586
2791
|
case "--help":
|
|
2587
2792
|
console.log(EMDASH_HELP);
|
|
2588
2793
|
return;
|
|
2589
|
-
default: fail(`unknown "emdash" subcommand "${sub}" (expected: prepare-db | check-prerender). Try: vitops --help`);
|
|
2794
|
+
default: fail(`unknown "emdash" subcommand "${sub}" (expected: prepare-db | check-prerender | build). Try: vitops --help`);
|
|
2590
2795
|
}
|
|
2591
2796
|
}
|
|
2592
2797
|
|
|
@@ -2619,7 +2824,7 @@ const SETUP_HELP = `vitops setup <sub> [options]
|
|
|
2619
2824
|
vitops setup ads [options] (forwards to \`vitops ads setup\`)
|
|
2620
2825
|
vitops setup all [--dry] [--check] [--public] [--platform <p>]
|
|
2621
2826
|
|
|
2622
|
-
--dry prints the plan and stops. --check reports drift/blocked steps and exits
|
|
2827
|
+
--dry (or --dry-run) prints the plan and stops. --check reports drift/blocked steps and exits
|
|
2623
2828
|
non-zero, mutating nothing. Neither creates the Cloudflare API token or performs
|
|
2624
2829
|
a custom-domain cutover — both are named as manual steps; see SETUP.html.`;
|
|
2625
2830
|
function projectName() {
|
|
@@ -3096,7 +3301,7 @@ function forward(sub, argv) {
|
|
|
3096
3301
|
}
|
|
3097
3302
|
}
|
|
3098
3303
|
async function cmdSetup(argv) {
|
|
3099
|
-
const [sub, ...rest] = argv;
|
|
3304
|
+
const [sub, ...rest] = argv.map((a) => a === "--dry-run" ? "--dry" : a);
|
|
3100
3305
|
switch (sub) {
|
|
3101
3306
|
case "repo": return cmdSetupRepo(rest);
|
|
3102
3307
|
case "hosting": return cmdSetupHosting(rest);
|