Configuration reference

Schema reference

These fields cover governance policy, token discovery, and local identity decisions. Unsupported or misspelled keys are reported as inert configuration instead of being treated as active.

TypeScript and JavaScript token modules

Keep format: "auto" for statically analyzable TypeScript and JavaScript modules. Fragments routes the source by its file extension; js and ts are not separate format enum values.

import type { FragmentsConfig } from "@usefragments/core";

export default {
  tokens: {
    sources: [{ path: "src/theme/tokens.ts", format: "auto" }],
  },
} satisfies FragmentsConfig;

Scoping a rule off a path

Every global govern.styles and govern.jsx record accepts an exclude list, as does each entry under govern.rules. Entries are a bare glob or a { glob, reason } record. An exclude scopes only the policy that declares it—the path stays governed by every other rule—which is what separates an exemption from a baseline.

import type { FragmentsConfig } from "@usefragments/core";

export default {
  govern: {
    styles: [
      {
        kind: "style.rawColors.forbid",
        except: ["transparent"],
        prefer: "token",
        severity: "warn",
        // Scopes THIS record off the path. Other rules still run over these files.
        exclude: [{ glob: "src/legacy/vendor/**", reason: "vendor drop, tracked in DS-611" }],
      },
    ],
    // The rule-id keyed form takes the same list, and scopes every record of that rule.
    rules: {
      "styles/no-raw-spacing": { exclude: ["src/legacy/vendor/**"] },
    },
  },
} satisfies FragmentsConfig;

Excluded findings are never silent: each one is counted in the run summary and listed with its glob and reason in the JSON report's ignored array and the SARIF run properties. A glob that matches no scanned file is reported as FUI9006, so a stale path cannot masquerade as active policy.

In-source suppressions

Put a suppression immediately before the statement it applies to. Name the exact FUI code and record a reason; use a real calendar expiry when the exception is temporary. Suppressions are narrow, auditable exceptions—not a substitute for changing the contract through govern.canonicalBridges or another documented config field.

// fragments-allow FUI2005: vendor-owned color, tracked in DS-482 expires="2026-12-31"
const Banner = () => <div style={{ color: "#39594d" }} />;

// @fragments-expect-error FUI1003 reason="legacy import migration tracked in DS-611" expires="2026-12-31"
import { Button } from "@mui/material";

Run fragments check --list-suppressions to review active directives, and fragments check --check-expired to fail on expired ones. For import-path findings, see FUI1003 remediation.