@straitlink/cli 0.3.5 → 0.3.6

package/README.md

@@ -83,7 +83,7 @@ Android (assetlinks.json)
 | `--key` | Also check the publishable key. Env: `STRAIT_PUBLISHABLE_KEY`. Left out, the key check is skipped |
 | `--json` | The reports as JSON, for CI and agents |
 
-With a secret key (`STRAIT_SECRET_KEY` or `--secret-key`), `doctor` also runs [`strait app verify`](#whats-wrong-with-my-setup-strait-app-verify) and prints its checks under "Account"; `--host` is then optional. If those checks can't run (a refused or malformed key, no connection, the 6-a-minute limit) it says "Could not check" and exits `1`, never a silent pass. `--json` adds them as `verify`. If your CI sets `STRAIT_SECRET_KEY` and should check only the host, unset it for the doctor step (`env -u STRAIT_SECRET_KEY npx @straitlink/cli doctor --host …`).
+With a secret key (`STRAIT_SECRET_KEY` or `--secret-key`), `doctor` also runs [`strait app verify`](#whats-wrong-with-my-setup-strait-app-verify) and prints its checks under "Account"; `--host` is then optional. If those checks can't run (a refused or malformed key, no connection, the 6-a-minute limit) it says "Could not check". They are shown but don't change the exit code, so a CI job that already sets `STRAIT_SECRET_KEY` keeps passing as before; add `--strict` to exit `1` when one fails or can't run. `--json` adds them as `verify` (its own `ok` inside); the top-level `ok` matches the exit code.
 
 Exit codes: `0` no errors (warnings allowed), `1` a check failed, `2` usage problem. What a terminal can't see (intent filters, the Associated Domains entitlement) is checked by `doctor()` inside a debug build and by the [free tools](https://straitlink.in/tools/).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@straitlink/cli",
-  "version": "0.3.5",
+  "version": "0.3.6",
   "description": "Strait deep links from the terminal: init sets them up in a React Native, Expo, Flutter or Android app, doctor checks your link host, app verify checks your whole setup with a fix for each problem, links creates and lists links and saves QR codes.",
   "keywords": [
     "strait",

package/src/app.mjs

@@ -99,8 +99,9 @@ function formatVerify(answer) {
 }
 
 /** `strait doctor`'s account block: the verify answer, or why it could not run (never a silent pass). */
-export function formatAccount(answer) {
+export function formatAccount(answer, strict = false) {
   const head = 'Account (strait app verify)';
-  if (answer?.error) return lines([head, `  Could not check: ${answer.error}`]);
-  return lines([head, ...verifyLines(answer), '', verifyVerdict(answer)]);
+  const soft = !strict && answer?.ok !== true ? ['These checks don\'t change doctor\'s exit code: add --strict to make doctor fail on them.'] : [];
+  if (answer?.error) return lines([head, `  Could not check: ${answer.error}`, ...soft]);
+  return lines([head, ...verifyLines(answer), '', verifyVerdict(answer), ...soft]);
 }

package/src/cli.mjs

@@ -31,6 +31,7 @@ const OPTIONS = {
     cert: { type: 'string', multiple: true },
     'secret-key': { type: 'string' },
     'api-url': { type: 'string' },
+    strict: { type: 'boolean', default: false },
     json: { type: 'boolean', default: false },
   },
   links: {
@@ -93,7 +94,8 @@ doctor options (the same checks and messages as doctor() in the SDKs)
   --cert <sha256>         Android signing certificate fingerprint (repeatable)
   --key <st_pub_live_…>   Also check the publishable key (env STRAIT_PUBLISHABLE_KEY)
   --secret-key <st_live_…>  Also run strait app verify (env STRAIT_SECRET_KEY); --host is then optional.
-                          If it can't run (refused key, no connection), doctor says so and exits 1
+                          If it can't run (refused key, no connection), doctor says so
+  --strict                Exit 1 when an account check fails or can't run (default: shown, exit unchanged)
   --api-url <url>         Engine for those checks (env STRAIT_API_URL, default https://strait.link)
   --json                  Print the reports as JSON
   With neither --android nor --ios, both files are checked and the apps they list are shown.
@@ -255,7 +257,8 @@ async function doctor({ values: v }, { out, env, io }) {
     result = await runDoctor({ host: normalizeHost(hostIn), key, android: v.android?.trim(), ios: v.ios?.trim(), certs: v.cert ?? [], fetch: fetchImpl });
   }
   if (secretIn) {
-    // A secret key adds the engine's checks (docs/adr/0003). If they can't run, say so and fail: never a silent pass.
+    // A secret key adds the engine's checks (docs/adr/0003), always shown; if they can't run, that is shown too.
+    // They change the exit code only with --strict, so a CI job that already sets the key keeps passing as before.
     try {
       const call = apiClient({ apiUrl: v['api-url'] ?? env.STRAIT_API_URL ?? DEFAULT_API_URL, key: secretKey(secretIn), fetch: fetchImpl, userAgent: `strait-cli/${CLI_VERSION}` });
       result.verify = await getVerify(call);
@@ -263,9 +266,9 @@ async function doctor({ values: v }, { out, env, io }) {
       if (!(e instanceof ApiError || e instanceof UsageError)) throw e;
       result.verify = { error: e.message };
     }
-    if (result.verify?.ok !== true) result.ok = false;
+    if (v.strict && result.verify?.ok !== true) result.ok = false;
   }
-  const text = v.json ? toJson(result) : [hostIn && formatDoctor(result), secretIn && formatAccount(result.verify)].filter(Boolean).join('\n\n');
+  const text = v.json ? toJson(result) : [hostIn && formatDoctor(result), secretIn && formatAccount(result.verify, v.strict)].filter(Boolean).join('\n\n');
   out.write(text + '\n');
   return result.ok ? 0 : 1;
 }

package/src/version.mjs

@@ -1,2 +1,2 @@
 // Kept equal to package.json version (test/links.test.mjs checks it). Sent as the API User-Agent.
-export const CLI_VERSION = '0.3.5';
+export const CLI_VERSION = '0.3.6';