@outerlayer/cli 0.15.0 → 0.17.0

package/skill-pack/template/build/scripts/criterion-citations.mjs

@@ -9,7 +9,8 @@
 // The criteria come from the file `record-criteria.mjs` wrote, by default
 // `<git dir>/build-reports/criteria.json`. A test cites a criterion when the
 // criterion's id appears as a whole token in a test's title or in a comment
-// above it. Only git-tracked test files are scanned, so every link names code
+// above it. `WC-01 counts`, `WC-01: counts` and `WC-01 - counts` all cite
+// WC-01. Only git-tracked test files are scanned, so every link names code
 // that a commit contains. The link names the HEAD commit and is written only
 // when the origin remote is on GitHub; otherwise the test is listed unlinked.
 // A criterion no test cites gets an empty list. An existing block in the
@@ -32,9 +33,13 @@ function escapeRegExp(text) {
   return text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 }
 
-/** A pattern that finds `id` as a whole token: not inside a longer id such as `WC-10` for `WC-1`, and still found before a sentence's full stop. */
+/**
+ * A pattern that finds `id` as a whole token: not inside a longer id such as
+ * `WC-10` for `WC-1` or `WC-1:b` for `WC-1`, and still found before a
+ * sentence's full stop or a title's colon, as in `WC-1: counts words`.
+ */
 export function idPattern(id) {
-  return new RegExp(`(?<![A-Za-z0-9_:-])${escapeRegExp(id)}(?![A-Za-z0-9_:-]|\\.[A-Za-z0-9])`);
+  return new RegExp(`(?<![A-Za-z0-9_:-])${escapeRegExp(id)}(?![A-Za-z0-9_-]|:[A-Za-z0-9_-]|\\.[A-Za-z0-9])`);
 }
 
 /** The ids of a criteria file shaped `{ "criteria": [{ "id" }] }`. */

package/skill-pack/template/build/scripts/record-criteria.mjs

@@ -85,10 +85,16 @@ export function classifyEmitFailure(message) {
   return /\brefused \(409\):/.test(message) ? "item-list-stands" : "refused";
 }
 
-/** Builds the `emit` function that runs `outerlayer emit criteria`; `spawn` is `spawnSync`, or a stand-in in tests. */
+/**
+ * Builds the `emit` function that runs `outerlayer emit criteria`; `spawn` is `spawnSync`, or a stand-in in tests.
+ * A machine that ran the CLI through `npx` has no `outerlayer` on PATH, so a missing command falls back to `npx -y @outerlayer/cli`.
+ */
 export function makeEmit(spawn, item) {
   return (file) => {
-    const run = spawn("outerlayer", ["emit", "criteria", file, "--item", item], { encoding: "utf8", timeout: 120000 });
+    const args = ["emit", "criteria", file, "--item", item];
+    const options = { encoding: "utf8", timeout: 120000 };
+    let run = spawn("outerlayer", args, options);
+    if (run.error?.code === "ENOENT") run = spawn("npx", ["-y", "@outerlayer/cli", ...args], options);
     if (run.status === 0) return { ok: true };
     if (run.error) return { ok: false, message: `could not run outerlayer emit criteria: ${run.error.message}` };
     if (run.signal) return { ok: false, message: `outerlayer emit criteria was stopped by ${run.signal}` };

package/skill-pack/template/spec/SKILL.md

@@ -9,6 +9,8 @@ description: >
   /spec <what you want built>.
 ---
 
+Run the CLI as `outerlayer`. If that command is not on PATH, run `npx -y @outerlayer/cli` with the same arguments. Every `outerlayer ...` command below follows this rule.
+
 Take one idea from a sentence to an issue a person can build from. This file
 is the procedure. The content discipline is the `writing-specs` skill: summary
 block, problem before solution, non-goals, Given/When/Then criteria and the

package/skill-pack/template/writing-specs/SKILL.md

@@ -103,7 +103,7 @@ implementing. Never write them by reading the finished implementation back.
   human-visible evidence. Use `video` for a flow of more than one step and
   `screenshot` for a single state. A test is the proof only where nothing visible
   changes. The proof shows the running page, never a component render. The
-  emitting-evidence skill covers capture.
+  outerlayer-evidence skill covers capture.
 
 ## The two verdicts
 

package/skill-pack/validators/acceptance-criteria.yaml

@@ -5,11 +5,12 @@
 # the test that cites it. Write its verdicts as an .html file and emit it as
 # a report artifact bound to this check:
 #   outerlayer emit artifact criteria.html --for acceptance-criteria --caption "Each criterion judged against the test that cites it"
-# Then run `outerlayer sync`, and copy the report's deep link from the pull
-# request's evidence comment. The link can take up to a minute to appear
-# after the sync. If it is not there yet, wait a minute and read the comment
-# again; do not give up after one look. Never build the link by hand, and
-# never link a pull request comment: a comment can be edited or deleted later.
+# Then run `outerlayer sync`. It prints a line for the report that ends with
+# its link; take the link from that line. If `sync` printed no line for it,
+# another sync already uploaded the report: run
+# `outerlayer sync --link <the artifact id>`, with the id `emit artifact`
+# printed. Never build the link by hand, and never link a pull request
+# comment: a comment can be edited or deleted later.
 #
 # Then record the verdict once, with that link as its proof:
 #   outerlayer emit acceptance-criteria --item "$OUTERLAYER_WORK" --result pass --link <the report's deep link>

package/skill-pack/validators/code-review.yaml

@@ -4,11 +4,12 @@
 # findings report (each confirmed finding with its severity and fix, or a
 # clean bill) as an .html file. Emit it as a report artifact with no --for:
 #   outerlayer emit artifact review.html --caption "Review of the change and what it found"
-# Then run `outerlayer sync`, and copy the report's deep link from the pull
-# request's evidence comment. The link can take up to a minute to appear
-# after the sync. If it is not there yet, wait a minute and read the comment
-# again; do not give up after one look. Never build the link by hand, and
-# never link a pull request comment: a comment can be edited or deleted later.
+# Then run `outerlayer sync`. It prints a line for the report that ends with
+# its link; take the link from that line. If `sync` printed no line for it,
+# another sync already uploaded the report: run
+# `outerlayer sync --link <the artifact id>`, with the id `emit artifact`
+# printed. Never build the link by hand, and never link a pull request
+# comment: a comment can be edited or deleted later.
 #
 # Then record the verdict once, with that link as its proof:
 #   outerlayer emit code-review --item "$OUTERLAYER_WORK" --result pass --link <the report's deep link>

package/dist/runner-key-7SSNMUBQ.js

@@ -1,154 +0,0 @@
-#!/usr/bin/env node
-import { createRequire } from 'node:module';
-import { readConfigObject, RunnerInitError } from './chunk-HXLMZOKU.js';
-import './chunk-Z3NOIFDR.js';
-import './chunk-UUDDPNRJ.js';
-import './chunk-KMDLFI4P.js';
-import './chunk-QKFB4K7X.js';
-import './chunk-RSNSZ2LJ.js';
-import './chunk-T5VPP6H7.js';
-import './chunk-RLYZLUQ7.js';
-import './chunk-6MZSX4M7.js';
-import { postJson, WorkCommandError, getJson } from './chunk-JR6ERP3M.js';
-import './chunk-NPQWKGUA.js';
-import './chunk-IP7BIBXJ.js';
-import { runnerCredentialProblem } from './chunk-22RMZBGW.js';
-import './chunk-UXYLWVTQ.js';
-import './chunk-R7PF5OOU.js';
-import './chunk-QOZKPLVJ.js';
-import './chunk-N5FOE5PS.js';
-import './chunk-OGFGZQA3.js';
-import './chunk-4NPZVMJU.js';
-import './chunk-7RQ73DLO.js';
-import './chunk-4Q7OMKAT.js';
-import './chunk-CX22S5BA.js';
-import './chunk-YDSMROTB.js';
-import './chunk-WUYTWNMA.js';
-import './chunk-JXYVA45C.js';
-import './chunk-4KSQKQXE.js';
-import './chunk-N6LURUEF.js';
-import './chunk-YRYMNBGQ.js';
-import './chunk-WZBHBH3J.js';
-import './chunk-3NLOVYJQ.js';
-import './chunk-LCEXHCHD.js';
-import './chunk-ZJSNLVCE.js';
-import './chunk-YO4PSLVB.js';
-import './chunk-BYT5O5RV.js';
-import './chunk-ZA5CHAFY.js';
-import './chunk-2M63GG56.js';
-import './chunk-PLMTLGYH.js';
-import './chunk-J5M7BSJQ.js';
-import { readCloudConfig } from './chunk-EABW6AJQ.js';
-import './chunk-RA3O54FC.js';
-import './chunk-V7NIVOFD.js';
-import './chunk-ZM2IMMYN.js';
-import './chunk-XCCLFVXM.js';
-import { readRepoConnection } from './chunk-BJ3KTMDH.js';
-import { homeFromEnv } from './chunk-VNVZDWO3.js';
-import './chunk-Z5GEFMRW.js';
-import { existsSync } from 'fs';
-import { hostname } from 'os';
-
-createRequire(import.meta.url);
-var RUNNER_KEY_PERMISSIONS = [
-  "sessions.ingest",
-  "evidence.insert",
-  "work.read",
-  "git.read",
-  "context.read",
-  "work.update",
-  "work.claim",
-  "hosts.ingest"
-];
-var MAX_NAME_ATTEMPTS = 10;
-var PASTED_KEY_FALLBACK = "Ask a member who can create keys to make one with the Runner preset on the factory's API keys page, then put it in the runner's config file as apiKey, with the Factory Id as appId, and run this again.";
-function runnerKeyLogin(configPath, opts = {}) {
-  const env = opts.env ?? process.env;
-  const config = existsSync(configPath) ? readConfigObject(configPath) : {};
-  if (config.apiKey !== void 0) {
-    if (opts.appId !== void 0 && opts.appId !== config.appId) {
-      throw new RunnerInitError(
-        `${configPath} already holds a runner key, for the factory its appId names, so --app-id ${opts.appId} creates no key. Leave --app-id out, or give it the same id.`
-      );
-    }
-    return void 0;
-  }
-  const saved = readCloudConfig(opts.home ?? homeFromEnv(env));
-  const own = typeof config.accountToken === "string" && config.accountToken !== "";
-  const accountToken = own ? config.accountToken : saved.accountToken;
-  if (accountToken === void 0 || accountToken === "") return void 0;
-  const url = config.url ?? (own ? void 0 : saved.url);
-  const appId = opts.appId ?? (env.OUTERLAYER_APP_ID || void 0) ?? config.appId ?? readRepoConnection(opts.cwd ?? process.cwd())?.appId;
-  if (appId === void 0) {
-    throw new RunnerInitError(
-      "you are logged in, so this command creates the runner's key, but no factory is chosen. Pass --app-id with the Factory Id from the factory's Settings \u2192 General, or set OUTERLAYER_APP_ID."
-    );
-  }
-  const problem = runnerCredentialProblem({ url, apiKey: accountToken, appId });
-  if (problem !== void 0) {
-    const where = problem.field === "appId" ? "the factory id" : `${configPath}: ${problem.field}`;
-    throw new RunnerInitError(`${where} ${problem.reason}.`);
-  }
-  return { url, accountToken, appId };
-}
-function defaultRunnerKeyName(host = hostname()) {
-  const short = host.replace(/\..*$/, "").trim();
-  return short === "" ? "runner" : short;
-}
-function clause(message) {
-  return message.replace(/\.+$/, "");
-}
-function forbidden(err) {
-  return new RunnerInitError(`your login cannot create a runner key on this factory: ${clause(err.message)}. ${PASTED_KEY_FALLBACK}`);
-}
-async function createKey(login, name, fetchImpl) {
-  for (let attempt = 1; attempt <= MAX_NAME_ATTEMPTS; attempt++) {
-    const tried = attempt === 1 ? name : `${name}-${attempt}`;
-    try {
-      const { data } = await postJson(
-        login.url,
-        "/v1/api-keys",
-        login.accountToken,
-        login.appId,
-        { name: tried, permissions: [...RUNNER_KEY_PERMISSIONS], app_id: login.appId },
-        fetchImpl
-      );
-      const apiKey = data.plaintext_key;
-      if (typeof apiKey !== "string" || apiKey === "") {
-        throw new RunnerInitError(`the gateway created the key ${tried} but did not return it. Delete it on the factory's API keys page, then run this again.`);
-      }
-      return { apiKey, name: tried };
-    } catch (err) {
-      if (!(err instanceof WorkCommandError)) throw err;
-      if (err.status === 409) continue;
-      if (err.status === 403) throw forbidden(err);
-      throw new RunnerInitError(`the runner key was not created: ${clause(err.message)}.`);
-    }
-  }
-  throw new RunnerInitError(
-    `the names ${name} to ${name}-${MAX_NAME_ATTEMPTS} are all taken by keys on this factory. Pass --key-name with another name.`
-  );
-}
-async function checkKey(key, fetchImpl) {
-  const unusable = (why) => new RunnerInitError(
-    `the runner key ${key.name} was created, but ${why}. Nothing else was changed. Delete the key on the factory's API keys page, then run this again.`
-  );
-  let data;
-  try {
-    ({ data } = await getJson(key.url, "/v1/runner/host-key", key.apiKey, key.appId, fetchImpl));
-  } catch (err) {
-    throw unusable(`the gateway did not accept it: ${clause(err instanceof Error ? err.message : String(err))}`);
-  }
-  if (data.bound !== false) {
-    throw unusable("the gateway did not report it as a new runner key");
-  }
-}
-async function createRunnerKey(login, opts = {}) {
-  const fetchImpl = opts.fetchImpl ?? fetch;
-  const created = await createKey(login, opts.name ?? defaultRunnerKeyName(), fetchImpl);
-  const key = { url: login.url, apiKey: created.apiKey, appId: login.appId, name: created.name };
-  await checkKey(key, fetchImpl);
-  return key;
-}
-
-export { RUNNER_KEY_PERMISSIONS, createRunnerKey, defaultRunnerKeyName, runnerKeyLogin };