@haystackeditor/cli 0.25.0 → 0.25.1

package/dist/commands/init.js

@@ -359,18 +359,26 @@ export async function initCommand(options) {
     const plan = planInit(gitRoot);
     // Telemetry is part of onboarding (CAPTURE-V1 rule 8): planned on every run; a missing answer stops only it.
     const telemetryModule = await import('./init-telemetry.js');
-    const telemetryOptions = { app: options.app, origins: options.origin ?? [], consent: options.consent };
+    const telemetryOptions = { app: options.app, origins: options.origin ?? [], consent: options.consent, urlRewrites: options.urlRewrites };
     let telemetryPlan = await telemetryModule.planTelemetry(gitRoot, repository, telemetryOptions);
     const telemetryFrom = plan.changes.length;
     plan.changes.push(...telemetryPlan.changes);
     plan.notices.push(...telemetryPlan.notices);
     let notesWritten = null;
     let telemetry = null;
+    // Before the apply (a preview, or no login), the report is the preview: what telemetry will do, `received` unchecked (null).
+    const report = () => telemetry ?? telemetryModule.previewTelemetry(telemetryPlan, repository, notes);
+    const showPreview = () => {
+        const preview = telemetryModule.previewTelemetry(telemetryPlan, repository, notes);
+        for (const line of telemetryModule.formatTelemetry(preview.telemetry, preview.steps))
+            say(line);
+        say('');
+    };
     const finish = (status, onboarding, exitCode) => {
         if (options.json) {
             const changes = plan.changes.map(({ path, action, reason, diff }) => ({ path, action, reason, diff }));
             process.stdout.write(`${JSON.stringify(withSchema('init', { status, repository, changes, notices: plan.notices, notes: notesWritten,
-                onboarding, telemetry: telemetry?.telemetry ?? null, telemetrySteps: telemetry?.steps ?? [] }), null, 2)}\n`);
+                onboarding, telemetry: report().telemetry, telemetrySteps: report().steps }), null, 2)}\n`);
         }
         process.exitCode = exitCode;
     };
@@ -397,6 +405,7 @@ export async function initCommand(options) {
     catch (error) {
         if (!(error instanceof NotLoggedInError))
             throw error;
+        showPreview();
         say(chalk.yellow('Not logged in, so nothing was changed. Run `haystack login`, then `haystack init` again.'));
         finish('login-required', null, EXIT_CODES['login-required']);
         return;
@@ -404,6 +413,7 @@ export async function initCommand(options) {
     if (plan.changes.length > 0 && !options.yes) {
         const interactive = !options.json && process.stdin.isTTY === true && process.stdout.isTTY === true;
         if (!interactive || !await confirmed()) {
+            showPreview();
             say('Nothing was changed. Run `haystack init --yes` to make these changes.');
             finish('planned', null, EXIT_CODES.planned);
             return;

package/dist/commands/verify-onboarding.js

@@ -103,6 +103,12 @@ export function parseOnboardingStatus(value, expected) {
     if (!Array.isArray(value.services) || !value.services.every(service => isRecord(service) && typeof service.id === 'string'
         && SERVICE_ENGINES.includes(service.engine)))
         invalid('its services');
+    const review = value.review;
+    if (!(review === null || (isRecord(review) && (review.verdict === 'accept'
+        || (review.verdict === 'skipped' && typeof review.reason === 'string' && review.reason.length > 0)))))
+        invalid('its review');
+    if (value.state !== 'ready' && review !== null)
+        invalid('its review');
     if (value.block !== null)
         parseOnboardingBlock(value.block);
     const checkpoint = value.checkpoint;
@@ -311,8 +317,18 @@ export function formatOnboarding(status) {
     const outside = [...status.standIns, ...status.unsetProviders, ...standInGapNotes(status.standInGaps)];
     if (outside.length)
         lines.push('', ...outside.map(note => chalk.yellow(`Note: ${safe(note)}`)));
+    const unreviewed = reviewNotes(status.review);
+    if (unreviewed.length)
+        lines.push('', ...unreviewed.map(note => chalk.yellow(`Note: ${safe(note)}`)));
     return lines.join('\n');
 }
+/** Rule 17 (amendment 32): an onboarding the independent review skipped, as the sentence every result shows; none otherwise. */
+export function reviewNotes(review) {
+    if (review?.verdict !== 'skipped')
+        return [];
+    return [`This onboarding was NOT reviewed: the independent review that checks the setup did not cheat is turned off for this `
+            + `team (${review.reason}).`];
+}
 /** Rule 15(g), amendment 3: a stand-in gap as the sentence every result shows. */
 export function standInGapNotes(gaps) {
     return gaps.map(gap => `A stand-in could not serve ${gap} while onboarding signed in and did the workflow; the crawl may meet it too.`);

package/dist/commands/verify.js

@@ -31,7 +31,7 @@ import { classifyHttpError, readWithRetries, SERVICE_SILENCE_LIMIT_MS, ServiceSi
 import { GATEWAY_TIMEOUT_MS, gatewayFetch } from './case-batch.js';
 import { CRAWL_BRIEF_MAX_FUNCTIONS, CRAWL_BRIEF_MAX_GROUPS, CRAWL_BRIEF_MAX_PRODUCTION_ROWS, CRAWL_BUDGET_MAX_MS, CRAWL_BUDGET_MIN_MS, CRAWL_MAX_FINDINGS, CRAWL_MAX_FINDING_STEPS, CRAWL_MAX_IDEAS, CRAWL_MAX_STAND_IN_LINES, CRAWL_MAX_STAND_IN_ROWS, CRAWL_MAX_TEXT_CHARS, CRAWL_WAIT_MAX_MS, CRAWL_POOLS, } from './crawl-contract.js';
 import { captureCheckout, crawlUnavailableText, EXPLICIT_WALL_MS, normalModeFailure, postPrecomputeCapture, } from './verify-precompute.js';
-import { formatOnboarding, onboardingExitCode, readOnboardingStatus, reportOnboardingState, standInGapNotes, waitForOnboarding } from './verify-onboarding.js';
+import { formatOnboarding, onboardingExitCode, readOnboardingStatus, reportOnboardingState, reviewNotes, standInGapNotes, waitForOnboarding, } from './verify-onboarding.js';
 import { formatCapture, readPreVerifyCapture } from './capture-brief.js';
 const CRAWLS_PATH = '/api/agent/cloud-verifier/crawls';
 /** A held read (waitAfter): the service's hold, then the time any read gets. */
@@ -1094,7 +1094,7 @@ export async function verifyCommand(options) {
     else {
         console.log(formatCrawl(view));
         const notes = [...(onboarding?.dataAbsences ?? []), ...(onboarding?.versionChoices ?? []), ...(onboarding?.standIns ?? []),
-            ...(onboarding?.unsetProviders ?? []), ...standInGapNotes(onboarding?.standInGaps ?? [])];
+            ...(onboarding?.unsetProviders ?? []), ...standInGapNotes(onboarding?.standInGaps ?? []), ...reviewNotes(onboarding?.review ?? null)];
         if (notes.length)
             console.log(['', ...notes.map(note => `Note: ${safe(note)}`)].join('\n'));
     }

package/dist/index.js

@@ -154,6 +154,7 @@ program
     .option('--app <dir>', 'The app whose telemetry init sets up, when the repository has several; see below')
     .option('--origin <url>', 'A production origin of the app (repeat for several): browser capture accepts events only from these', (value, previous = []) => [...previous, value])
     .option('--consent <choice>', 'How the site asks visitors for consent: its consent platform, or not-required when your user decided so')
+    .option('--url-rewrites <answer>', 'When init asks: none, or hidden-segment:<name> when the app\'s middleware adds a leading [<name>] segment to page paths')
     .option('--json', 'The result as one JSON document on stdout (see `haystack schema init`)')
     .addHelpText('after', `
 There is no setup file: Haystack works out how to run the app from what the
@@ -1045,6 +1046,7 @@ program.command('capture').description('Real users\' journeys and devices: the t
     .description('Publish the app\'s route manifest into its static output (the build step `haystack init` adds)')
     .option('--app <dir>', 'The app directory (default: the current directory)')
     .option('--rails-routes <file>', 'Rails: the routes file the rake task wrote')
+    .option('--adapter <id>', 'The framework adapter to use instead of the one init recorded in .haystack/capture.json')
     .option('--json', 'The release, counts and files written as JSON')
     .action((options) => runPublicCommand(() => captureManifestCommand(options), options.json));
 // ─── db ──────────────────────────────────────────────────────────────────────

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haystackeditor/cli",
-  "version": "0.25.0",
+  "version": "0.25.1",
   "description": "haystack verify: run your app with and without a change, and see what the change broke",
   "type": "module",
   "bin": {

package/schemas/init.v1.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://docs.haystackeditor.com/cli/schemas/init.v1.json",
   "title": "Haystack init: this repository's setup for `haystack verify`",
-  "description": "Machine-readable output of `haystack init --json`. `changes` are the project-local changes init planned (made when status is done); `onboarding` is the base's OnboardingStatusV1 (onboarding_contracts.ts, APP-ONBOARDING-V1) as POST /api/agent/cloud-verifier/onboarding returns it, null unless status is done. `notes` says what became of `--notes`: \"written\" (the repository's onboarding notes are now these), \"unchanged\" (they already were), null without `--notes` or when init stopped before writing them. Exit codes: 0 done (onboarding running or ready), 1 failed (the error envelope), 2 planned (nothing written; run with --yes), 3 done but onboarding blocked, 4 login-required, 5 app-required (install the Haystack GitHub App), 6 done but onboarding stopped before finishing (run init again). `telemetry` (CAPTURE-V1 rule 8e, InitTelemetryReport in capture_contracts.ts) is null unless status is done: per part (`capture`, the browser tag; `server`, server telemetry) `installed`, `manual` with the exact `steps`, or `unsupported` with `why`, and `received`, the newest telemetry Haystack holds for this application (null when none; `stale` past 24 hours), plus `dbProfileCommand`, the `haystack db profile` command for the user to run with production read access (null when the app's database is not one it profiles). `telemetrySteps` is what the person does next for telemetry to arrive, in order, including the off switches; [] without telemetry.",
+  "description": "Machine-readable output of `haystack init --json`. `changes` are the project-local changes init planned (made when status is done); `onboarding` is the base's OnboardingStatusV1 (onboarding_contracts.ts, APP-ONBOARDING-V1) as POST /api/agent/cloud-verifier/onboarding returns it, null unless status is done. `notes` says what became of `--notes`: \"written\" (the repository's onboarding notes are now these), \"unchanged\" (they already were), null without `--notes` or when init stopped before writing them. Exit codes: 0 done (onboarding running or ready), 1 failed (the error envelope), 2 planned (nothing written; run with --yes), 3 done but onboarding blocked, 4 login-required, 5 app-required (install the Haystack GitHub App), 6 done but onboarding stopped before finishing (run init again). `telemetry` (CAPTURE-V1 rule 8e, InitTelemetryReport in capture_contracts.ts) is what telemetry does (status done) or will do (planned, login-required: the same report before anything is written, every `received` null because nothing was checked): per part (`capture`, the browser tag; `server`, server telemetry) `installed`, `manual` with the exact `steps`, or `unsupported` with `why`, and `received`, the newest telemetry Haystack holds for this application (null when none; `stale` past 24 hours), plus `dbProfileCommand`, the `haystack db profile` command for the user to run with production read access (null when the app's database is not one it profiles). `telemetrySteps` is what the person does next for telemetry to arrive, in order, including the off switches; [] without telemetry.",
   "type": "object",
   "additionalProperties": false,
   "required": ["schema_version", "status", "repository", "changes", "notices", "notes", "onboarding", "telemetry", "telemetrySteps"],