@cleartrip/frontguard 0.1.9 → 0.2.0

package/dist/index.d.ts

@@ -67,7 +67,7 @@ interface FrontGuardConfig {
         tsAnyDelta: {
             enabled: boolean;
             gate: CheckGate;
-            /** Fallback when not in GitHub Actions: `main` */
+            /** Fallback merge-base ref when `BITBUCKET_PR_DESTINATION_BRANCH` is unset (e.g. `main`) */
             baseRef: string;
             /** Warn/block when added-any count exceeds this (0 = only report delta). */
             maxAdded: number;
@@ -88,18 +88,23 @@ interface FrontGuardConfig {
             /** Max lines of ts-prune output to attach */
             maxReportLines: number;
         };
-        /** Static bundle size after optional build step. */
+        /**
+         * Static bundle size: optionally run `buildCommand`, then sum bytes under `measureGlobs`.
+         * For default `npm run build`, the run is skipped (info) when `package.json` has no matching script — use `buildCommand` / `runBuild: false` for non-standard repos.
+         */
         bundle: {
             enabled: boolean;
             gate: CheckGate;
-            /** Skip when false and only `measureGlobs` exist */
+            /** When false, only measures existing files (no build). Set false for libs/backends with no web bundle. */
             runBuild: boolean;
+            /** E.g. `npm run build`, `pnpm run vite-build`, or any command that produces artifacts under measureGlobs */
             buildCommand: string;
             measureGlobs: string[];
             baselinePath: string;
             /**
-             * Git ref used to read `baselinePath` from the base branch when the file is not on disk
-             * (e.g. `main` or `master`). Separate from `tsAnyDelta.baseRef` so bundle can track a release branch.
+             * Git ref used to read `baselinePath` from the base branch when the file is not on disk.
+             * Bitbucket PR pipelines set `BITBUCKET_PR_DESTINATION_BRANCH`, which is preferred for resolving the ref.
+             * Separate from `tsAnyDelta.baseRef` so bundle can track a release branch.
              */
             baselineRef: string;
             maxDeltaBytes: number | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cleartrip/frontguard",
-  "version": "0.1.9",
+  "version": "0.2.0",
   "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/freekit-ci-setup.md

@@ -8,6 +8,13 @@ The Bitbucket template uploads `frontguard-report.html` with **no signup or API
 
 Optional env (advanced): **`FREEKIT_BASE_URL`** — override the API host (e.g. self‑hosted instance per FreeKit docs).
 
+## PR checks (`pr-hygiene`, `pr-size`)
+
+On **Bitbucket Pipelines** pull-request builds, FrontGuard reads **`BITBUCKET_PR_ID`** (and related branch env vars) and computes diff size with **`git diff <destination>...HEAD --numstat`**, so **`pr-size` runs** when the destination ref exists in the clone.
+
+- **`pr-hygiene`** needs the PR description text. Bitbucket does not expose the body in default env vars — set **`FRONTGUARD_PR_BODY`** in the pipeline (e.g. fetch from the [Bitbucket PR API](https://developer.atlassian.com/cloud/bitbucket/rest/api-group-pullrequests/) in a prior step and `export` it) if you want body-length / section / AI-disclosure rules to apply.
+- **Shallow clones:** If `git` cannot resolve `BITBUCKET_PR_DESTINATION_BRANCH`, add a **`git fetch`** of the base branch so `pr-size` can measure the PR (see Bitbucket “clone depth” docs).
+
 ## Things to know
 
 - **Public:** Anyone with the link can open the report. Do not use for highly sensitive content unless you add FreeKit **password** protection via their API (requires passing `password` in the JSON — not in this template).