deeplink-parity 0.6.2 → 0.6.4

package/README.md

@@ -13,7 +13,8 @@ npx deeplink-parity .
 ```
 
 ```
-deeplink-parity · 3 domain(s) checked
+deeplink-parity v0.6.4 · 3 domain(s) checked
+routes: deeplink-parity.yml (iOS 74 · Android 73)
 
 ERROR  links.example.com
        AASA responded with 404
@@ -24,7 +25,11 @@ WARN   promo.example.com
        Declared on iOS but not on Android
        The same link opens the app on iOS and the browser on Android
 
-1 error, 1 warn, 0 info
+WARN   route-gap
+       /events is in the Android route table but not iOS's
+       A /events link navigates on Android and goes nowhere on iOS.
+
+1 error, 2 warn, 0 info
 ```
 
 <br>
@@ -57,6 +62,9 @@ Findings show up as annotations on the run. Add `sha256` to include the Android
 key in the check, and `fail-on: never` to report without failing while an existing backlog
 is cleared.
 
+Domains are checked with zero setup. To also compare the **screens behind the links**,
+run `npx deeplink-parity init` once — see [Route parity](#route-parity).
+
 <br>
 
 ## Contents
@@ -111,6 +119,7 @@ No configuration file. Domains are discovered from your app, then the matching w
 **Warnings** — one platform works and the other does not
 
 - **A domain is declared on iOS but not Android, or the reverse**
+- **A route is in one platform's route table but not the other's** (with [route parity](#route-parity) set up)
 - An `https` intent-filter has no `autoVerify`
 - A manifest host reference could not be resolved
 
@@ -135,6 +144,7 @@ npx deeplink-parity init [path...]             # interactive setup for route com
   --output <file>          Also write the JSON result to a file
   --format github          GitHub Actions annotations (auto-detected on Actions)
   --yes                    init only: accept the top suggestion without prompting
+  -v, --version            Print the version
   -h, --help               Show this message
 ```
 
@@ -274,6 +284,8 @@ The **check never writes to the repositories it scans** — it reads files and G
 public well-known files per domain, nothing else. `init` writes exactly one file,
 `deeplink-parity.yml`, in your working directory, after printing its content and asking.
 
+<br>
+
 ## Native, Flutter and React Native
 
 Whatever the app is written in, deep links are declared in the same two native files and
@@ -316,7 +328,9 @@ read as browser registration rather than deep links.
 
 - **Deferred deep links are out of scope.** Install-then-open attribution is decided at runtime by your attribution SDK's servers. No static check can confirm it, and reporting a pass would be worse than saying nothing.
 - **It does not prove path equivalence.** iOS and Android use different path-matching engines. Differing path sets are reported as `info` with both sides shown, for a human to judge — not asserted as a bug.
-- **It does not run your app.** Route handling inside the app is not inspected.
+- **It does not run your app.** Route parity compares the declared tables; whether a
+  handler behind a route actually works, or a dynamically-matched route resolves, only
+  shows up on a device.
 
 <br>
 
@@ -330,7 +344,7 @@ npm run typecheck
 
 `fixtures/` holds synthetic iOS and Android projects covering literal hosts, chained
 `@string` references resolved through gradle `resValue` and `.properties`, flavor-specific
-values, and unresolvable references.
+values, unresolvable references, and route tables in both platforms' shapes.
 
 <br>
 

package/dist/cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { stat, writeFile } from 'node:fs/promises';
+import { readFile, stat, writeFile } from 'node:fs/promises';
 import { resolve } from 'node:path';
 import { localSource, networkSource } from './fetch/wellKnown.js';
 import { exitCodeFor, printReport } from './report/console.js';
@@ -28,6 +28,7 @@ Options
   --output <file>          Also write the JSON result to a file
   --format github          GitHub Actions annotations (auto-detected on Actions)
   --yes                    init only: accept the top suggestion without prompting
+  -v, --version            Print the version
   -h, --help               Show this message
 
 The check reads the repositories and GETs two public well-known files per domain —
@@ -39,6 +40,7 @@ function parseArgs(argv) {
     const positional = [];
     let json = false;
     let help = false;
+    let version = false;
     let printRoutes = false;
     let yes = false;
     let sha256;
@@ -53,6 +55,8 @@ function parseArgs(argv) {
             json = true;
         else if (arg === '-h' || arg === '--help')
             help = true;
+        else if (arg === '-v' || arg === '--version')
+            version = true;
         else if (arg === '--print-routes')
             printRoutes = true;
         else if (arg === '--yes')
@@ -77,6 +81,7 @@ function parseArgs(argv) {
         roots: roots.length ? roots : [resolve('.')],
         json,
         help,
+        version,
         printRoutes,
         yes,
         sha256,
@@ -110,6 +115,11 @@ async function assertRootsExist(roots) {
 }
 async function main() {
     const opts = parseArgs(process.argv);
+    const pkg = JSON.parse(await readFile(new URL('../package.json', import.meta.url), 'utf8'));
+    if (opts.version) {
+        console.log(pkg.version);
+        return;
+    }
     if (opts.help) {
         console.log(USAGE);
         return;
@@ -150,6 +160,8 @@ async function main() {
         console.log();
     }
     const payload = {
+        version: pkg.version,
+        routeConfig: configPath,
         ios: result.iosApps.map((a) => ({
             entitlements: a.entitlementsPath,
             teamId: a.teamId,
@@ -181,13 +193,19 @@ async function main() {
     // machine-readable output in the same run.
     if (opts.output)
         await writeFile(opts.output, `${JSON.stringify(payload, null, 2)}\n`);
+    const routesLine = configPath
+        ? `routes: ${configPath}` +
+            (result.routes
+                ? ` (iOS ${result.routes.ios?.paths.length ?? 0} · Android ${result.routes.android?.paths.length ?? 0})`
+                : '')
+        : 'routes: no config found — run "deeplink-parity init" to compare route tables';
     if (opts.json) {
         console.log(JSON.stringify(payload, null, 2));
     }
     else {
         if (opts.format === 'github')
             printGithubAnnotations(result.findings);
-        printReport(result.findings, result.domains);
+        printReport(result.findings, result.domains, { version: pkg.version, routesLine });
     }
     process.exit(exitCodeFor(result.findings));
 }

package/dist/report/console.js

@@ -10,10 +10,14 @@ const LABEL = { error: 'ERROR', warn: 'WARN ', info: 'INFO ' };
 const ORDER = ['error', 'warn', 'info'];
 const useColor = process.stdout.isTTY && !process.env.NO_COLOR;
 const paint = (s, c) => (useColor ? `${c}${s}${RESET}` : s);
-export function printReport(findings, checkedDomains) {
+export function printReport(findings, checkedDomains, meta) {
     // every escape goes through paint(), which is a no-op when stdout is not a terminal
     const separator = paint('·', DIM);
-    console.log(`\n${paint('deeplink-parity', BOLD)} ${separator} ${checkedDomains.length} domain(s) checked\n`);
+    const version = meta ? ` ${paint(`v${meta.version}`, DIM)}` : '';
+    console.log(`\n${paint('deeplink-parity', BOLD)}${version} ${separator} ${checkedDomains.length} domain(s) checked`);
+    if (meta)
+        console.log(paint(meta.routesLine, DIM));
+    console.log();
     if (findings.length === 0) {
         console.log(paint('No problems found', ''));
         console.log();

package/dist/routes/extract.js

@@ -33,9 +33,11 @@ export async function extractRoutes(platform, config, roots) {
     const findings = [];
     const files = [];
     const paths = new Set();
+    let unresolved = false;
     for (const file of config.files) {
         const hits = await resolveInRoots(file, roots);
         if (hits.length === 0) {
+            unresolved = true;
             findings.push({
                 severity: 'error',
                 rule: 'routes-file-missing',
@@ -45,6 +47,7 @@ export async function extractRoutes(platform, config, roots) {
             continue;
         }
         if (hits.length > 1) {
+            unresolved = true;
             findings.push({
                 severity: 'error',
                 rule: 'routes-file-ambiguous',
@@ -59,6 +62,9 @@ export async function extractRoutes(platform, config, roots) {
             paths.add(m[1] ?? m[0]);
         }
     }
+    // a table missing any of its files is incomplete; diffing it would manufacture gaps
+    if (unresolved)
+        return { findings };
     if (files.length > 0 && paths.size === 0) {
         // matching nothing is a broken config, never a clean pass
         findings.push({

package/dist/routes/init.js

@@ -35,7 +35,17 @@ async function pickFiles(rl, platform, candidates, yes) {
             return [];
         if (answer === 'm') {
             const manual = (await rl.question('path: ')).trim();
-            return manual ? [manual] : [];
+            if (!manual)
+                return [];
+            // a mistyped path written into the config would only surface at check time
+            try {
+                await access(manual);
+                return [manual];
+            }
+            catch {
+                console.log(`  Not found: ${manual}`);
+                continue;
+            }
         }
         const tokens = answer.split(/[,\s]+/);
         const indexes = tokens.map((t) => Number.parseInt(t, 10));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deeplink-parity",
-  "version": "0.6.2",
+  "version": "0.6.4",
   "description": "Checks that what your mobile app declares about deep links matches what is actually hosted — across iOS and Android.",
   "type": "module",
   "bin": {