@cleartrip/frontguard 0.2.3 → 0.2.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cleartrip/frontguard",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Org-wide frontend PR guardrails: linting, hygiene, any-delta, cycles, dead code, bundle/CWV hints, custom rules, optional LLM brief",
   "type": "module",
   "bin": {

package/templates/checks-snapshot-bitbucket-snippet.yml

@@ -0,0 +1,30 @@
+# Optional fragment: PNG of the Checks table in the PR comment (Bitbucket Cloud)
+#
+# Merge into pull-requests after `frontguard run` produces:
+#   - frontguard-checks.html   (--checksSnapshotOut)
+#   - frontguard-report.html   (--htmlOut)
+#
+# Flow:
+# 1. Screenshot the minimal HTML with Playwright (Chromium).
+# 2. Upload the PNG somewhere HTTPS-public (examples below).
+# 3. export FRONTGUARD_CHECKS_IMAGE_URL='https://.../frontguard-checks.png'
+# 4. Run frontguard again with --prCommentOut (or only export + re-run snippet step) so the comment includes ![...](url).
+#
+# The PR body is Markdown: Bitbucket renders ![](https://...) images when the URL is reachable.
+
+# --- Example: screenshot + upload to Bitbucket Downloads (public file URL for repo viewers) ---
+#   - npx playwright@1.49.0 install chromium
+#   - |
+#     FILE_URL="$(node --input-type=module -e "import { pathToFileURL } from 'node:url'; console.log(pathToFileURL('frontguard-checks.html').href)")"
+#     npx playwright@1.49.0 screenshot "$FILE_URL" frontguard-checks.png --viewport-size=920,2000
+#   - |
+#     curl --silent --show-error --fail --request POST \
+#       --url "https://api.bitbucket.org/2.0/repositories/${BITBUCKET_REPO_FULL_NAME}/downloads" \
+#       --header "Authorization: Bearer ${BITBUCKET_ACCESS_TOKEN}" \
+#       --form "files=@frontguard-checks.png"
+#   # Then set FRONTGUARD_CHECKS_IMAGE_URL to the href Bitbucket returns for that file (see API response),
+#   # or construct the known downloads URL pattern for your workspace.
+#
+# --- Example: same image hosted on your CDN / object storage ---
+#   - aws s3 cp frontguard-checks.png s3://my-bucket/ci/frontguard-checks-${BITBUCKET_BUILD_NUMBER}.png --acl public-read
+#   - export FRONTGUARD_CHECKS_IMAGE_URL="https://my-bucket.s3.amazonaws.com/ci/frontguard-checks-${BITBUCKET_BUILD_NUMBER}.png"

package/templates/freekit-ci-setup.md

@@ -22,6 +22,27 @@ On **Bitbucket Pipelines** pull-request builds, FrontGuard reads **`BITBUCKET_PR
 - **Limits:** Per FreeKit docs — e.g. HTML payload size caps, **rate limits** (creates per minute per IP), possible `429`. Large reports or busy runners may need retries or another host.
 - **No delete token in CI:** Each run creates a **new** site URL. Old FreeKit URLs may still work until you delete them with the `deleteToken` returned in the API response (this template does not store it).
 
+## Checks table image in PR comments
+
+Bitbucket renders **`![](https://.../checks.png)`** in PR comments when the URL is public HTTPS. FrontGuard can emit a **minimal HTML** file that contains only the Checks table (same styling as the full report):
+
+```bash
+yarn frontguard run --markdown \
+  --htmlOut frontguard-report.html \
+  --checksSnapshotOut frontguard-checks.html \
+  > frontguard-report.md
+```
+
+Then:
+
+1. **Screenshot** `frontguard-checks.html` with headless Chromium (e.g. `npx playwright screenshot "<file://...>" frontguard-checks.png`).
+2. **Upload** the PNG to a reachable URL (Bitbucket Downloads API, S3, CDN, etc.).
+3. Set **`FRONTGUARD_CHECKS_IMAGE_URL`** to that URL **before** writing the PR comment (e.g. before `formatBitbucketPrSnippet` / `--prCommentOut`).
+
+The snippet places the image at the **top** of the comment and keeps the **full interactive report** link below (with a short line explaining that details are in the HTML).
+
+See **`templates/checks-snapshot-bitbucket-snippet.yml`** for merge-ready pipeline examples.
+
 ## Compared to Surge
 
 Surge credentials (`SURGE_LOGIN` / `SURGE_TOKEN`) are **not** required for FreeKit’s open POST flow. If you remove Surge, you can delete any old Surge-related secured variables from the repository.