@domandigital/craft 0.6.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +36 -0
- package/CHARACTER.md +280 -20
- package/COPY.md +280 -0
- package/README.md +12 -0
- package/dist/audit-W57YDZ2K.js +20 -0
- package/dist/audit.cjs +901 -103
- package/dist/audit.d.cts +16 -1
- package/dist/audit.d.ts +16 -1
- package/dist/audit.js +899 -102
- package/dist/chunk-35OX6C4H.js +112 -0
- package/dist/{chunk-GWMSSRIQ.js → chunk-CZHRNPDD.js} +1521 -934
- package/dist/chunk-K253ZXB3.js +458 -0
- package/dist/{chunk-HYGFP3LB.js → chunk-OGSYVCMU.js} +40 -3
- package/dist/chunk-OVOH7KZY.js +163 -0
- package/dist/{cli-7ME4VIRG.js → chunk-Q4MN3OXF.js} +50 -101
- package/dist/chunk-ULYKASLA.js +175 -0
- package/dist/chunk-X65RDW65.js +364 -0
- package/dist/cli-F7ONSKZS.js +21 -0
- package/dist/cli-FKJOMOOF.js +15 -0
- package/dist/{cli-F7W4F3ER.js → cli-KA3JDNDH.js} +14 -168
- package/dist/cli-LZ7R6KJM.js +312 -0
- package/dist/cli-SHLNRHK6.js +16 -0
- package/dist/cli.js +2 -1
- package/dist/index.cjs +1528 -99
- package/dist/index.d.cts +365 -4
- package/dist/index.d.ts +365 -4
- package/dist/index.js +1493 -96
- package/package.json +4 -2
- package/word-lists.json +164 -0
package/dist/index.d.ts
CHANGED
|
@@ -882,6 +882,8 @@ interface Finding {
|
|
|
882
882
|
excerpt: string;
|
|
883
883
|
message: string;
|
|
884
884
|
fix: string;
|
|
885
|
+
/** The house copy tier (`house.ts`), on copy findings only. */
|
|
886
|
+
house?: "block" | "review" | "explicit";
|
|
885
887
|
}
|
|
886
888
|
/** A class list as it applies to one element, with where it starts. */
|
|
887
889
|
interface ClassUnit {
|
|
@@ -1029,9 +1031,15 @@ interface CheckReport {
|
|
|
1029
1031
|
* Bumped whenever an entry is added, removed or its detection changes, so a
|
|
1030
1032
|
* report can say which list it was judged against.
|
|
1031
1033
|
*/
|
|
1032
|
-
declare const CATALOGUE_VERSION = "2026.09.
|
|
1034
|
+
declare const CATALOGUE_VERSION = "2026.09.6";
|
|
1033
1035
|
declare const CATALOGUE: readonly Tell[];
|
|
1034
1036
|
declare function tellById(id: string): Tell | undefined;
|
|
1037
|
+
/**
|
|
1038
|
+
* Apply the house copy policy (`house.ts`): a finding from a house-blocking
|
|
1039
|
+
* tell becomes a block, so the run fails on it. Everything else keeps its
|
|
1040
|
+
* catalogue severity, which is `warn`.
|
|
1041
|
+
*/
|
|
1042
|
+
declare function applyHouseGate(result: CheckReport): CheckReport;
|
|
1035
1043
|
/** Scan markup, component code and stylesheets for design tells. */
|
|
1036
1044
|
declare function scanSource(files: SourceFile[], options?: CheckOptions): CheckReport;
|
|
1037
1045
|
/** Check the prose in files for copy tells. */
|
|
@@ -1048,11 +1056,97 @@ declare function runTell(tell: Tell, files: SourceFile[]): Hit[];
|
|
|
1048
1056
|
* markers, and a test fails if the two differ.
|
|
1049
1057
|
*/
|
|
1050
1058
|
declare function catalogueTable(): string;
|
|
1059
|
+
/**
|
|
1060
|
+
* The copy word and phrase lists, as portable JSON.
|
|
1061
|
+
*
|
|
1062
|
+
* These are the only part of the copy catalogue a non-TypeScript consumer can
|
|
1063
|
+
* use directly: a word list is data, a regex-shaped tell (contrastive
|
|
1064
|
+
* negation, the "No X" badge, em dash, emoji) is not something worth
|
|
1065
|
+
* re-deriving from a JSON export, so those stay TypeScript-only here.
|
|
1066
|
+
*
|
|
1067
|
+
* `claude-kit`'s `copy_check.py` is the reason this exists. It hardcoded its
|
|
1068
|
+
* own copies of these same lists rather than reading this package, and the
|
|
1069
|
+
* two drifted (documented in claude-kit's `house-style/copy-rules.md`, "Note
|
|
1070
|
+
* the enforcement gap"). `word-lists.json` is the file that ends the drift:
|
|
1071
|
+
* `install/sync-copy-wordlists.sh` on that side copies it in verbatim, same
|
|
1072
|
+
* shape as `sync-craft-standard.sh` does for `STANDARD.md`. Regenerate the
|
|
1073
|
+
* checked-in `word-lists.json` with `pnpm --filter @domandigital/craft run
|
|
1074
|
+
* docs` after changing any list in `tells/copy.ts`.
|
|
1075
|
+
*/
|
|
1076
|
+
declare function wordListsJson(): string;
|
|
1051
1077
|
|
|
1052
1078
|
/** Plain-text rendering of a report, for a terminal or a hook. */
|
|
1053
1079
|
|
|
1054
1080
|
declare function formatReport(report: CheckReport, title: string): string;
|
|
1055
1081
|
|
|
1082
|
+
/**
|
|
1083
|
+
* The house copy policy: which copy tells fail a commit.
|
|
1084
|
+
*
|
|
1085
|
+
* craft ships every tell as `warn`, because a tell is a default, not a
|
|
1086
|
+
* mistake. The Doman Digital house goes further for copy: the blocking tier of
|
|
1087
|
+
* `COPY.md` is not a judgment call, and a single hit fails. This file is where
|
|
1088
|
+
* that is written down, next to the tells it names, so the list of what blocks
|
|
1089
|
+
* and the rules that say why live in one package.
|
|
1090
|
+
*
|
|
1091
|
+
* It used to live in claude-kit's `copy_check.py`, a Python wrapper in another
|
|
1092
|
+
* repo. Two lists in two repos is how the old checker drifted from the rules
|
|
1093
|
+
* in the first place.
|
|
1094
|
+
*
|
|
1095
|
+
* `craft copy --gate` applies it. `craft tells list --json` publishes it, so
|
|
1096
|
+
* the `copy-check` wrapper reads the policy instead of keeping its own copy.
|
|
1097
|
+
*
|
|
1098
|
+
* block a single finding fails the run
|
|
1099
|
+
* review printed, never fails
|
|
1100
|
+
* explicit printed only when a person named the file; never fails
|
|
1101
|
+
*
|
|
1102
|
+
* A copy tell not named here is `review`: a new tell never breaks a commit.
|
|
1103
|
+
* Moving one to `block` needs its estate hits read by a person first (see
|
|
1104
|
+
* ROADMAP.md), and `COPY.md` updated in the same change.
|
|
1105
|
+
*/
|
|
1106
|
+
type HouseTier = "block" | "review" | "explicit";
|
|
1107
|
+
interface HouseRule {
|
|
1108
|
+
tier: HouseTier;
|
|
1109
|
+
/** What the finding means, in the words the house rules use. */
|
|
1110
|
+
label: string;
|
|
1111
|
+
}
|
|
1112
|
+
declare const HOUSE: Readonly<Record<string, HouseRule>>;
|
|
1113
|
+
/** The house rule for a copy tell. Unknown ids are review, so a new tell never blocks. */
|
|
1114
|
+
declare function houseRule(id: string, name?: string): HouseRule;
|
|
1115
|
+
|
|
1116
|
+
/**
|
|
1117
|
+
* Protected facts: what a rewrite must never lose or invent.
|
|
1118
|
+
*
|
|
1119
|
+
* A rewrite that removes every tell and drops the price, or changes "since
|
|
1120
|
+
* 2009" to "for over a decade", or adds a review count nobody supplied, is
|
|
1121
|
+
* worse than the draft it replaced. The research on de-AI tooling puts this
|
|
1122
|
+
* gate first: compare the facts before and after, and block any change nobody
|
|
1123
|
+
* explained.
|
|
1124
|
+
*
|
|
1125
|
+
* Pure over text. `craft copy compare <before> <after>` is the command.
|
|
1126
|
+
*/
|
|
1127
|
+
|
|
1128
|
+
type FactKind = "url" | "email" | "phone" | "postcode" | "money" | "date" | "time" | "number" | "name";
|
|
1129
|
+
interface Fact {
|
|
1130
|
+
kind: FactKind;
|
|
1131
|
+
/** As written, for the report. */
|
|
1132
|
+
value: string;
|
|
1133
|
+
/** How it is compared: spacing and thousands separators do not make a new fact. */
|
|
1134
|
+
key: string;
|
|
1135
|
+
}
|
|
1136
|
+
/** The reader-visible text of a file: prose for documents, visible strings for code. */
|
|
1137
|
+
declare function visibleText(file: SourceFile): string;
|
|
1138
|
+
declare function protectedFacts(text: string): Fact[];
|
|
1139
|
+
interface FactComparison {
|
|
1140
|
+
before: number;
|
|
1141
|
+
after: number;
|
|
1142
|
+
/** In the original, missing from the rewrite. */
|
|
1143
|
+
lost: Fact[];
|
|
1144
|
+
/** In the rewrite, not in the original: each one needs a source. */
|
|
1145
|
+
added: Fact[];
|
|
1146
|
+
}
|
|
1147
|
+
declare function compareFacts(before: string, after: string): FactComparison;
|
|
1148
|
+
declare function formatComparison(result: FactComparison, beforePath: string, afterPath: string): string;
|
|
1149
|
+
|
|
1056
1150
|
/**
|
|
1057
1151
|
* The rendered detection path for tells that can be seen on a live page.
|
|
1058
1152
|
*
|
|
@@ -1257,8 +1351,8 @@ declare const SHADCN_PRIMITIVES: readonly ["accordion", "alert", "alert-dialog",
|
|
|
1257
1351
|
* harness) are not here: they have tells of their own, so a finding says
|
|
1258
1352
|
* which tier it belongs to.
|
|
1259
1353
|
*/
|
|
1260
|
-
declare const AI_WORDS: readonly ["tapestry", "testament", "realm", "embark", "embarking", "unleash", "unlocks", "unlocking", "elevate", "elevates", "elevated", "elevating", "bustling", "nestled", "meticulous", "meticulously", "paramount", "furthermore", "moreover", "navigating", "ever-evolving", "unparalleled"];
|
|
1261
|
-
declare const STOCK_PHRASES: readonly ["in today's digital age", "to the next level", "one-stop shop", "second to none", "we pride ourselves", "passionate about", "your journey", "our journey", "curated", "crafted with care", "tailored to your", "peace of mind"];
|
|
1354
|
+
declare const AI_WORDS: readonly ["tapestry", "testament", "realm", "embark", "embarking", "unleash", "unlocks", "unlocking", "elevate", "elevates", "elevated", "elevating", "bustling", "nestled", "meticulous", "meticulously", "paramount", "furthermore", "moreover", "navigating", "ever-evolving", "unparalleled", "underscore", "underscores", "underscoring", "showcasing", "pivotal"];
|
|
1355
|
+
declare const STOCK_PHRASES: readonly ["in today's digital age", "to the next level", "one-stop shop", "second to none", "we pride ourselves", "passionate about", "your journey", "our journey", "curated", "crafted with care", "tailored to your", "peace of mind", "so here's", "in an era where", "the future looks bright", "only time will tell"];
|
|
1262
1356
|
/**
|
|
1263
1357
|
* The phrase list from the blocking tier of copy-rules.md, plus the phrases
|
|
1264
1358
|
* the old copy-check blocked that the rules had never written down. Each is a
|
|
@@ -1418,4 +1512,271 @@ declare function propose(input: ProposeInput): {
|
|
|
1418
1512
|
direction: ArtDirection;
|
|
1419
1513
|
};
|
|
1420
1514
|
|
|
1421
|
-
|
|
1515
|
+
/**
|
|
1516
|
+
* The counterfactual: what a model builds for this brief when nobody tells it
|
|
1517
|
+
* anything else. Signal 2 of CHARACTER.md.
|
|
1518
|
+
*
|
|
1519
|
+
* A null model is about twenty pages generated from one brief, each reduced to
|
|
1520
|
+
* a fingerprint. A site is typical when it sits as close to those pages as they
|
|
1521
|
+
* sit to each other. That question keeps working when model defaults move,
|
|
1522
|
+
* which a fixed list of tells cannot: ban Inter and the null model moves with
|
|
1523
|
+
* the model, so the comparison moves too.
|
|
1524
|
+
*
|
|
1525
|
+
* `harvest` reads the same pages the other way round: which choices recur
|
|
1526
|
+
* across them that the catalogue does not know yet. Those are the candidates
|
|
1527
|
+
* for the next generation of tells. A person decides; nothing is added here.
|
|
1528
|
+
*
|
|
1529
|
+
* Pure. Generating pages and snapshotting them lives in the CLI.
|
|
1530
|
+
*/
|
|
1531
|
+
|
|
1532
|
+
declare const NULL_VERSION = 1;
|
|
1533
|
+
/**
|
|
1534
|
+
* The prompt a null run gets: the brief, and nothing about how it should look.
|
|
1535
|
+
* Changing this changes every null model built after it, so it is versioned
|
|
1536
|
+
* by being recorded in each one.
|
|
1537
|
+
*/
|
|
1538
|
+
declare function nullPrompt(brief: string): string;
|
|
1539
|
+
interface NullRun {
|
|
1540
|
+
/** The page's file name without extension: "01". */
|
|
1541
|
+
id: string;
|
|
1542
|
+
fingerprint: Fingerprint;
|
|
1543
|
+
/** Catalogue tells found on the page, source and rendered, each once. */
|
|
1544
|
+
tells: string[];
|
|
1545
|
+
/** Every visible string on the page, for the phrase harvest. */
|
|
1546
|
+
copy: string[];
|
|
1547
|
+
}
|
|
1548
|
+
interface NullModel {
|
|
1549
|
+
version: typeof NULL_VERSION;
|
|
1550
|
+
brief: string;
|
|
1551
|
+
prompt: string;
|
|
1552
|
+
/** What was asked for with --model, or "default". */
|
|
1553
|
+
model: string;
|
|
1554
|
+
catalogueVersion: string;
|
|
1555
|
+
builtAt: string;
|
|
1556
|
+
runs: NullRun[];
|
|
1557
|
+
}
|
|
1558
|
+
/** The HTML document in a model's reply, without code fences or commentary. */
|
|
1559
|
+
declare function extractHtml(reply: string): string | null;
|
|
1560
|
+
/** Fewer runs than this and the spread of the null is noise, so nothing is judged. */
|
|
1561
|
+
declare const MIN_RUNS = 5;
|
|
1562
|
+
/** Typical when at least this share of the null's own pages sit further out. */
|
|
1563
|
+
declare const TYPICAL_AT = 0.1;
|
|
1564
|
+
interface Typicality {
|
|
1565
|
+
/**
|
|
1566
|
+
* 0 to 1: the share of the null's own pages that sit further from the rest
|
|
1567
|
+
* than this page sits from them. 1 is more typical than anything the model
|
|
1568
|
+
* built; 0 is further out than every one of them.
|
|
1569
|
+
*/
|
|
1570
|
+
score: number;
|
|
1571
|
+
typical: boolean;
|
|
1572
|
+
/** Mean distance to the k nearest null pages. */
|
|
1573
|
+
distance: number;
|
|
1574
|
+
/** The same measure for each null page against the others, median. */
|
|
1575
|
+
baseline: number;
|
|
1576
|
+
nearest: {
|
|
1577
|
+
id: string;
|
|
1578
|
+
distance: number;
|
|
1579
|
+
}[];
|
|
1580
|
+
/** The choices this page shares with most of the null: why it reads as typical. */
|
|
1581
|
+
shared: {
|
|
1582
|
+
part: string;
|
|
1583
|
+
value: string;
|
|
1584
|
+
runs: number;
|
|
1585
|
+
of: number;
|
|
1586
|
+
}[];
|
|
1587
|
+
}
|
|
1588
|
+
/**
|
|
1589
|
+
* How typical a page is against one or more null models (pooled). Every null
|
|
1590
|
+
* page is scored against the others the same way, leaving itself out, so the
|
|
1591
|
+
* threshold comes from the model's own spread and not from a number picked
|
|
1592
|
+
* here: a page drawn from the null is flagged nine times in ten by
|
|
1593
|
+
* construction, and the calibration checks whether real sites are not.
|
|
1594
|
+
*/
|
|
1595
|
+
declare function typicality(target: Fingerprint, runs: NullRun[], k?: number): Typicality;
|
|
1596
|
+
declare function hueName(o: Oklch | null): string;
|
|
1597
|
+
declare function groundName(o: Oklch): string;
|
|
1598
|
+
declare function shapeName(roundness: number | null): string;
|
|
1599
|
+
/** The discrete choices a fingerprint makes, as part → value. What a person would name. */
|
|
1600
|
+
declare function choicesOf(fp: Fingerprint): Record<string, string[]>;
|
|
1601
|
+
type CandidateKind = "face" | "accent" | "ground" | "shape" | "motion" | "opening" | "tell" | "phrase";
|
|
1602
|
+
interface HarvestCandidate {
|
|
1603
|
+
kind: CandidateKind;
|
|
1604
|
+
value: string;
|
|
1605
|
+
/** Null pages that make this choice, across every model given. */
|
|
1606
|
+
runs: number;
|
|
1607
|
+
of: number;
|
|
1608
|
+
/** Distinct briefs it turned up for. A habit shows across briefs; a brief's own words do not. */
|
|
1609
|
+
briefs: number;
|
|
1610
|
+
/** The catalogue tell that already catches it, or null when nothing does. */
|
|
1611
|
+
known: string | null;
|
|
1612
|
+
/** An example, for a phrase: the string it came from. */
|
|
1613
|
+
example?: string;
|
|
1614
|
+
}
|
|
1615
|
+
interface HarvestOptions {
|
|
1616
|
+
/** Report a choice made by at least this share of pages. Default 0.25. */
|
|
1617
|
+
minShare?: number;
|
|
1618
|
+
/** Which copy tell, if any, already catches a phrase. The CLI passes the catalogue's. */
|
|
1619
|
+
copyTell?: (phrase: string) => string | null;
|
|
1620
|
+
}
|
|
1621
|
+
/**
|
|
1622
|
+
* Choices that recur across null pages, with the tell that already catches
|
|
1623
|
+
* each, if any. The ones with `known: null` are the next generation's
|
|
1624
|
+
* candidates. Nothing here decides: a person reads them, and a candidate only
|
|
1625
|
+
* becomes a tell with a flag case and a pass case like every other.
|
|
1626
|
+
*/
|
|
1627
|
+
declare function harvest(models: Pick<NullModel, "brief" | "runs">[], options?: HarvestOptions): HarvestCandidate[];
|
|
1628
|
+
/** A representative colour for a hue family, for a report. */
|
|
1629
|
+
declare function hueSwatch(runs: NullRun[], hue: string): string | null;
|
|
1630
|
+
|
|
1631
|
+
/**
|
|
1632
|
+
* The estate register: every site the agency has shipped, fingerprinted, so a
|
|
1633
|
+
* new one can be checked against its siblings. Signal 3 of CHARACTER.md.
|
|
1634
|
+
*
|
|
1635
|
+
* An agency's biggest tell is its clients looking like each other. No single
|
|
1636
|
+
* site shows it; only the set does. So the register holds one fingerprint per
|
|
1637
|
+
* site, and `compareToEstate` says which sites a page sits nearest and what
|
|
1638
|
+
* it shares with them.
|
|
1639
|
+
*
|
|
1640
|
+
* The line for "siblings" is not a number picked here. Two different
|
|
1641
|
+
* businesses are siblings when they sit closer together than two pages Claude
|
|
1642
|
+
* builds for the same brief usually do: if a barber and an electrician look
|
|
1643
|
+
* more alike than two drafts of one barber, nobody chose either look. The
|
|
1644
|
+
* median comes from null models when they are given, and from the 2026-09-23
|
|
1645
|
+
* calibration when they are not.
|
|
1646
|
+
*
|
|
1647
|
+
* Pure. The CLI reads and writes the register file.
|
|
1648
|
+
*/
|
|
1649
|
+
|
|
1650
|
+
declare const ESTATE_VERSION = 1;
|
|
1651
|
+
/**
|
|
1652
|
+
* Median fingerprint distance between two null pages built from the same
|
|
1653
|
+
* brief, across seven briefs and 1,330 pairs (calibration/null, 2026-09-23).
|
|
1654
|
+
*/
|
|
1655
|
+
declare const SIBLING_AT = 0.31;
|
|
1656
|
+
interface EstateSite {
|
|
1657
|
+
/** Short kebab-case id: "rmp", "chair-and-blade". */
|
|
1658
|
+
id: string;
|
|
1659
|
+
client: string;
|
|
1660
|
+
url: string;
|
|
1661
|
+
/** Where the site's source lives, if known: "rmp474/RMP-Electrical". */
|
|
1662
|
+
repo?: string;
|
|
1663
|
+
fingerprint: Fingerprint;
|
|
1664
|
+
/** Rendered tells found when it was added, for the record. */
|
|
1665
|
+
tells: string[];
|
|
1666
|
+
addedAt: string;
|
|
1667
|
+
}
|
|
1668
|
+
interface EstateRegister {
|
|
1669
|
+
version: typeof ESTATE_VERSION;
|
|
1670
|
+
sites: EstateSite[];
|
|
1671
|
+
}
|
|
1672
|
+
declare function emptyEstate(): EstateRegister;
|
|
1673
|
+
/** Add a site, or replace the one with the same id. Sorted by id so the file diffs cleanly. */
|
|
1674
|
+
declare function addSite(register: EstateRegister, site: EstateSite): EstateRegister;
|
|
1675
|
+
/**
|
|
1676
|
+
* What two fingerprints effectively share, named the way a person would see
|
|
1677
|
+
* it: "Fraunces headline", "no accent", "pill buttons". A part counts when its
|
|
1678
|
+
* distance is 0.2 or less.
|
|
1679
|
+
*/
|
|
1680
|
+
declare function sharedParts(a: Fingerprint, b: Fingerprint, d?: FingerprintDistance): string[];
|
|
1681
|
+
interface EstateMatch {
|
|
1682
|
+
id: string;
|
|
1683
|
+
distance: number;
|
|
1684
|
+
sibling: boolean;
|
|
1685
|
+
shared: string[];
|
|
1686
|
+
}
|
|
1687
|
+
/** The sites nearest a fingerprint, closest first, leaving out `exclude` (the site itself). */
|
|
1688
|
+
declare function compareToEstate(target: Fingerprint, register: EstateRegister, options?: {
|
|
1689
|
+
exclude?: string;
|
|
1690
|
+
siblingAt?: number;
|
|
1691
|
+
}): EstateMatch[];
|
|
1692
|
+
interface EstatePair {
|
|
1693
|
+
a: string;
|
|
1694
|
+
b: string;
|
|
1695
|
+
distance: number;
|
|
1696
|
+
sibling: boolean;
|
|
1697
|
+
shared: string[];
|
|
1698
|
+
}
|
|
1699
|
+
/** Every pair in the register, closest first. */
|
|
1700
|
+
declare function estatePairs(register: EstateRegister, siblingAt?: number): EstatePair[];
|
|
1701
|
+
/**
|
|
1702
|
+
* The sibling line from null models: the median distance between two pages
|
|
1703
|
+
* built from the same brief. Each inner array is one brief's fingerprints.
|
|
1704
|
+
*/
|
|
1705
|
+
declare function siblingLine(briefs: Fingerprint[][]): number;
|
|
1706
|
+
|
|
1707
|
+
/**
|
|
1708
|
+
* The character report: the three signals and the reason rule, read together.
|
|
1709
|
+
*
|
|
1710
|
+
* No one signal decides. A site can carry no catalogued tell and still be what
|
|
1711
|
+
* Claude builds for its brief (signal 2); it can be nothing like the null and
|
|
1712
|
+
* still wear last year's reflexes (signal 1); it can pass both and be a twin of
|
|
1713
|
+
* the agency's other client (signal 3). And a site that passes all three has
|
|
1714
|
+
* still only avoided defaults: "decided" needs the reasons written down.
|
|
1715
|
+
*
|
|
1716
|
+
* So the verdict is:
|
|
1717
|
+
* default two or more signals raised
|
|
1718
|
+
* mixed one raised
|
|
1719
|
+
* decided none raised, and all measured, reasons included
|
|
1720
|
+
* unproven none raised, but something was not measured. Unverified is
|
|
1721
|
+
* never a pass.
|
|
1722
|
+
*
|
|
1723
|
+
* The actions change the surface: type, colour, shape, effects, motion, copy.
|
|
1724
|
+
* Never the page grammar. A layout tell says what to change about how a
|
|
1725
|
+
* section looks, not that it should move.
|
|
1726
|
+
*
|
|
1727
|
+
* Pure. The CLI gathers the inputs.
|
|
1728
|
+
*/
|
|
1729
|
+
|
|
1730
|
+
/** Three or more distinct design tells: the rule fixed for the 2026-09-23 calibration. */
|
|
1731
|
+
declare const TELL_HEAVY = 3;
|
|
1732
|
+
/** Fewer choices decided than this and the reasons are not yet a direction. */
|
|
1733
|
+
declare const MIN_DECIDED = 5;
|
|
1734
|
+
type Verdict = "default" | "mixed" | "decided" | "unproven";
|
|
1735
|
+
type Area = "direction" | "type" | "colour" | "shape" | "effects" | "motion" | "layout" | "copy";
|
|
1736
|
+
interface SignalResult {
|
|
1737
|
+
id: "tells" | "typicality" | "estate" | "reasons";
|
|
1738
|
+
/** null when it was not measured. */
|
|
1739
|
+
raised: boolean | null;
|
|
1740
|
+
detail: string;
|
|
1741
|
+
}
|
|
1742
|
+
interface Action {
|
|
1743
|
+
area: Area;
|
|
1744
|
+
what: string;
|
|
1745
|
+
why: string;
|
|
1746
|
+
/** 1 first. Deciding comes before changing, so direction actions are always 1. */
|
|
1747
|
+
priority: 1 | 2 | 3;
|
|
1748
|
+
/** The art-direction choice that settles it, when there is one. */
|
|
1749
|
+
choice?: ChoiceKey;
|
|
1750
|
+
}
|
|
1751
|
+
interface CharacterReport {
|
|
1752
|
+
site: string;
|
|
1753
|
+
verdict: Verdict;
|
|
1754
|
+
summary: string;
|
|
1755
|
+
signals: SignalResult[];
|
|
1756
|
+
actions: Action[];
|
|
1757
|
+
}
|
|
1758
|
+
interface CharacterInputs {
|
|
1759
|
+
site: string;
|
|
1760
|
+
/** Source and rendered findings, merged. */
|
|
1761
|
+
findings?: CheckReport | null;
|
|
1762
|
+
typicality?: Typicality | null;
|
|
1763
|
+
estate?: EstateMatch[] | null;
|
|
1764
|
+
direction?: DirectionReport | null;
|
|
1765
|
+
}
|
|
1766
|
+
declare function characterReport(input: CharacterInputs, copyTells?: Set<string>): CharacterReport;
|
|
1767
|
+
|
|
1768
|
+
/**
|
|
1769
|
+
* `craft retrofit`: a character report turned into the checklist a retrofit
|
|
1770
|
+
* session works through, in the order that works: decide, then change.
|
|
1771
|
+
*
|
|
1772
|
+
* Every change is tied to the art-direction choice that settles it, and shows
|
|
1773
|
+
* the decided value and its reason when there is one. A change with no
|
|
1774
|
+
* decided value waits for the decision; otherwise the retrofit swaps one
|
|
1775
|
+
* default for the next.
|
|
1776
|
+
*
|
|
1777
|
+
* Pure. Returns Markdown.
|
|
1778
|
+
*/
|
|
1779
|
+
|
|
1780
|
+
declare function retrofitPlan(report: CharacterReport, direction?: ArtDirection | null): string;
|
|
1781
|
+
|
|
1782
|
+
export { AI_PHRASES, AI_VIOLET, AI_WORDS, type AccentFork, type AccentForkOptions, type Action, type Area, type ArtDirection, BUZZWORDS, CATALOGUE, CATALOGUE_VERSION, CHOICE_KEYS, type CandidateKind, type CharacterInputs, type CharacterReport, type CheckOptions, type CheckReport, type CheckRestraintInput, type ChoiceKey, type ContrastCheck, type ContrastReport, type CopyTell, type CraftTokensInput, type CraftTokensResult, DENSITIES, DENSITY_NAMES, DIRECTION_VERSION, DISTANCE_WEIGHTS, DURATION_MS, DURATION_S, type DensityCssOptions, type DensityName, type DirectionChoice, type DirectionProblem, type DirectionReport, type DirectionSource, type DurationName, EASE, EASE_TUPLE, ESTATE_VERSION, EXIT_RATIO, type EaseName, type EmitCssOptions, type EstateMatch, type EstatePair, type EstateRegister, type EstateSite, FINGERPRINT_VERSION, type Fact, type FactComparison, type FactKind, type Finding, type Fingerprint, type FingerprintDistance, type FluidSpaceOptions, type FluidTypeOptions, type FluidTypeResult, type FontClass, type Gamut, type Generation, HOUSE, HOUSE_BUDGET, HOUSE_TYPE, type HarvestCandidate, type HarvestOptions, type Hit, type HouseRule, type HouseTier, LIGHTNESS_CURVE, MIN_DECIDED, MIN_RUNS, type MotionDecision, type MotionKind, NEGATIVE_REASSURANCE, NULL_VERSION, type NullModel, type NullRun, type Oklch, type OklchToHexOptions, PILL_LIMIT, PLAINER_WORDS, PROPOSED, type PaletteColour, type Proposal, type ProposeInput, RAMP_STEPS, REFLEX_FONTS_1, REFLEX_FONTS_2, RENDERED_PATHS, REVEAL_LIMIT, REVIEW_PHRASES, type Ramp, type RampFromAnchorsOptions, type RampOptions, type RampStep, type RestraintBudget, type RestraintReport, type RestraintSeverity, type RestraintViolation, type Rgb, SCALE, SHADCN_LIMIT, SHADCN_PRIMITIVES, SIBLING_AT, SNAPSHOT_VERSION, SOURCE_KINDS, SPACE_STEPS, SPRING, STOCK_PHRASES, type SectionKind, type SectionRhythmOptions, type SemanticInput, type SemanticResult, type Severity, type ShouldAnimateInput, type SignalResult, type Snapshot, type SnapshotColour, type SnapshotControl, type SnapshotEffects, type SnapshotFont, type SnapshotGradient, type SnapshotHeading, type SnapshotMotion, type SnapshotPatch, type SnapshotSection, type SourceFile, type SourceKind, type SourceTell, type SpaceStep, type Surface, TELL_HEAVY, TYPE_STEPS, TYPICAL_AT, type TailwindPreset, type Tell, type TellException, type TypeStep, type Typicality, VAGUE_WORDS, type ValidateContext, type Verdict, accentFork, addSite, apcaContrast, applyHouseGate, auditSnapshot, catalogueTable, characterReport, checkCopy, checkPair, checkRestraint, choicesOf, compareFacts, compareToEstate, craftTokens, deltaEOk, deltaEOkHex, densityCss, densityTokens, emitCss, emptyEstate, estatePairs, exitDuration, extractHtml, findColours, fingerprint, fingerprintDistance, fluidClamp, fluidSpace, fluidType, fontClass, formatComparison, formatHex, formatReport, groundName, harvest, hexToOklch, houseRule, hueName, hueSwatch, inP3Gamut, inSrgbGamut, initDirection, isAiViolet, isCream, makeSnapshot, motionTokens, nearest, normaliseFamily, nullPrompt, oklchToHex, oklchToRgb, paletteFromPixels, parseColour, parseHex, propose, protectedFacts, ramp, rampFromAnchors, retrofitPlan, runTell, scanSource, sectionRhythm, semantic, shapeName, sharedParts, shouldAnimate, siblingLine, tailwindV3Preset, tailwindV4Theme, tellById, toGamut, typeFeatureTokens, typicality, validateDirection, visibleText, wcagContrast, wordListsJson };
|