@cleartrip/frontguard 0.2.6 → 0.2.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cleartrip/frontguard",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "Org-wide frontend PR guardrails: linting, hygiene, any-delta, cycles, dead code, bundle/CWV hints, custom rules, optional LLM brief",
   "type": "module",
   "bin": {
@@ -26,6 +26,7 @@
     "build": "tsup",
     "dev": "tsup --watch",
     "typecheck": "tsc --noEmit",
+    "test": "npm run build && tsx --test src/lib/bitbucket-checks-image-md.test.ts src/runner/checks-snapshot-png.integration.test.ts",
     "format": "prettier --write .",
     "prepack": "npm run build"
   },
@@ -38,6 +39,7 @@
   ],
   "license": "MIT",
   "dependencies": {
+    "@resvg/resvg-js": "^2.6.2",
     "fast-glob": "^3.3.3",
     "typescript": "^5.8.2"
   },
@@ -48,6 +50,7 @@
     "picocolors": "^1.1.1",
     "prettier": "^3.5.3",
     "tinyexec": "^1.0.1",
-    "tsup": "^8.4.0"
+    "tsup": "^8.4.0",
+    "tsx": "^4.21.0"
   }
 }

package/templates/bitbucket-pipelines.yml

@@ -1,15 +1,22 @@
 # FrontGuard — PR comment: checks screenshot (inline) + FreeKit full report
 #
-# • FrontGuard renders the checks table to HTML, then to PNG using Playwright (`npx`, no apt Chromium).
+# • PNG matches the HTML snapshot (Overview + Checks). If Bitbucket shows a broken/empty image,
+#   the host may strip data: URLs — use pipeline artifact frontguard-checks.png or HTTPS + FRONTGUARD_CHECKS_IMAGE_URL.
+# • Raster: @resvg/resvg-js (no browser).
 # • The PNG is embedded in the PR comment as a small base64 image (no Bitbucket Downloads / extra tokens).
 # • Full HTML report is uploaded to FreeKit; the comment links to that URL for details.
 #
 # Secured variable: BITBUCKET_ACCESS_TOKEN — must be allowed to post pull request comments.
 #
 # Optional: FREEKIT_BASE_URL — override FreeKit API host (default https://freekit.dev).
+#
+# Deeper clone avoids shallow-git errors (e.g. merge-base / parent rev) for diff-based checks.
 
 image: node:20
 
+clone:
+  depth: 50
+
 pipelines:
   pull-requests:
     '**':
@@ -24,6 +31,7 @@ pipelines:
             - frontguard-checks.png
           script:
             - corepack enable
+            - apt-get update && apt-get install -y --no-install-recommends fonts-dejavu-core fonts-liberation
             - yarn install --immutable || yarn install
             - |
               yarn frontguard run --markdown \
@@ -40,7 +48,9 @@ pipelines:
               from urllib.request import Request, urlopen
 
               DETAILED = "For detailed check analysis, please open the full interactive report:"
-              MAX_B64 = 290_000
+              # Keep in sync with src/lib/bitbucket-checks-image-md.ts (markdown line length cap).
+              MAX_IMAGE_LINE = 300_000
+              PNG_SIG = bytes([0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A])
 
               base = os.environ.get("FREEKIT_BASE_URL", "https://freekit.dev").rstrip("/")
               with open("frontguard-report.html", encoding="utf-8") as f:
@@ -70,12 +80,15 @@ pipelines:
 
               with open("frontguard-checks.png", "rb") as f:
                   raw = f.read()
+              if len(raw) < 8 or raw[:8] != PNG_SIG:
+                  raise SystemExit("frontguard-checks.png is missing or not a valid PNG file.")
               b64 = base64.standard_b64encode(raw).decode("ascii")
-              img_line = f"![FrontGuard — checks summary](data:image/png;base64,{b64})"
-              if len(img_line) > MAX_B64:
+              # ASCII alt text; standard Base64 — matches FrontGuard pngBufferToBitbucketImageMarkdownLine.
+              img_line = f"![FrontGuard checks summary](data:image/png;base64,{b64})"
+              if len(img_line) > MAX_IMAGE_LINE:
                   raise SystemExit(
-                      f"Checks PNG too large for inline comment ({len(raw)} bytes). "
-                      "Shrink the table or raise MAX_B64 after verifying Bitbucket limits."
+                      f"Checks PNG too large for inline comment ({len(raw)} bytes, line {len(img_line)} chars). "
+                      "Shrink the table or host the PNG and link it; see bitbucket-checks-image-md.ts limits."
                   )
 
               body = f"{img_line}\n\n{DETAILED}\n{report_url}\n"

package/templates/freekit-ci-setup.md

@@ -1,6 +1,6 @@
 # FreeKit.dev + FrontGuard (Bitbucket Pipelines)
 
-The Bitbucket template (`templates/bitbucket-pipelines.yml`) runs FrontGuard with **`--checksPngOut`** (Playwright via `npx`), uploads the full HTML to **FreeKit**, and posts a PR comment that **inlines** the checks PNG as `data:image/png;base64,...` plus the FreeKit URL. You only need **`BITBUCKET_ACCESS_TOKEN`** with permission to **comment on pull requests** — no Repository Downloads or `repository:write`.
+The Bitbucket template (`templates/bitbucket-pipelines.yml`) runs FrontGuard with **`--checksPngOut`** (SVG → PNG via **`@resvg/resvg-js`**, no headless browser), uploads the full HTML to **FreeKit**, and posts a PR comment that **inlines** the checks PNG as `data:image/png;base64,...` plus the FreeKit URL. You only need **`BITBUCKET_ACCESS_TOKEN`** with permission to **comment on pull requests** — no Repository Downloads or `repository:write`.
 
 The same step uploads `frontguard-report.html` to FreeKit’s public API:
 
@@ -26,7 +26,7 @@ On **Bitbucket Pipelines** pull-request builds, FrontGuard reads **`BITBUCKET_PR
 
 ## Checks table image in PR comments
 
-The default pipeline uses **`--checksPngOut`** so FrontGuard runs **Playwright via `npx`** and writes `frontguard-checks.png`. A short Python step base64-embeds that image in the PR comment (no extra hosting). If the PNG is too large for Bitbucket, raise the limit in the pipeline script cautiously or host the image and set **`FRONTGUARD_CHECKS_IMAGE_URL`** with **`--prCommentOut`** instead.
+The default pipeline uses **`--checksPngOut`** so FrontGuard writes **`frontguard-checks.png`** (raster from the checks table). A short Python step base64-embeds that image in the PR comment (no extra hosting). If the PNG is too large for Bitbucket, raise the limit in the pipeline script cautiously or host the image and set **`FRONTGUARD_CHECKS_IMAGE_URL`** with **`--prCommentOut`** instead.
 
 ## Compared to Surge