Changelog
Every release of paratext, newest first, from its CHANGELOG.md — what changed and the pull request it came from.
0.7.3
Patch Changes
-
#674
e9f45d8Thanks @ofri-peretz! - README: family header, badges, install, migrating, the family table.Every package README now opens the same way — lockup, tagline, one badge row in one order (npm version, downloads, Quality Gate, the package's own coverage, OpenSSF Scorecard, unpacked size, dependencies, types, Node, licence, npm provenance), a row of compatibility badges read from the graded baseline — and carries the same sections in the same order: Install for npm, pnpm, yarn and bun, Quick start, Migrating as a before/after diff, Compatibility, Benchmarks, For agents, API, and a generated table of the nine packages. Links are absolute, so they work on npm as well as GitHub.
-
#713
8a338baThanks @ofri-peretz! - Code paths no input could reach are removed; behaviour is unchanged.paratext checkno longer carries a "(replaces …)" suffix it could never print, because it loads one plugin into an emptied registry.paratext/terminal-link's detection no longer carrieshas-flag's short and bare flag forms, since every flag it asks about is a long one, nor a "not a tty" answer inside its colour check, which it only reaches for a tty. The root entry no longer registers the built-ins a second time afteransi-escapes.jshas already done it at load. Three fallbacks for a regex group or asplitelement that is always there are gone, and the schema walk reads a type's first letter withcharAt, which gives the same answer. -
#684
6c7b55aThanks @ofri-peretz! -paratext/csi: the CSI half ofansi-escapesas a subpath of its own — cursor moves, erases, scrolling, the alternate screen and synchronized output, byte-exact withansi-escapes7.3.0. It is 2,700 bytes and, unlike the package root, registers no built-ins when imported.flagstaff/log-update,flagstaff/ora,caique/rawandcaique/inquirertake their cursor sequences from it instead of carrying their own copies; caique now depends on paratext. Output is unchanged, with one spelling difference:caique/raw's repaint clears withESC[Jrather than the equivalentESC[0J.caique/inquirerkeeps@inquirer/ansi's answer of nothing for a zero-row move, whereansi-escapes'cursorUp(0)isESC[0A. -
#678
088ceccThanks @ofri-peretz! - Whether anybody is there, whether to colour, and whether a tick can be drawn are roundel's questions, and three packages answered them by hand.roundel/terminal(new subpath, 878 B, reaching nothing):interactive(rt)— a terminal on stdin, noCI, and no agent variable (CLAUDECODE,AI_AGENT,CURSOR_AGENT,CODEX_THREAD_ID,GEMINI_CLI, exported asAGENTS), withFORCE_TTY=1as the override — andunicode(rt), is-unicode-supported 2.1.0's table over{ env, platform }.caique/decidenow depends onroundeland asksinteractive(). Behaviour change: under an agent that has a terminal —CLAUDECODE=1and a TTY on stdin — a missing required value is refused with a usage error naming the flag (--x is required when nobody is there to answer) instead of prompting and hanging the agent.FORCE_TTY=1now prompts even without a terminal on stdin, as it does for burgee.caique/inquirer's tick andflagstaff/ora's log symbols and spinner fallback use roundel'sunicode(). caique's copy was a four-condition subset: the Linux console (TERM=linux) now gets√rather than✔, and ConEmu/Cmder, Terminus, Alacritty, rxvt-unicode and JetBrains' terminal on Windows now get✔, asfiguresdraws them.burgeehelp colour is roundel'scolorLevel(rt) > 0. Behaviour changes:NO_COLORnow beatsFORCE_COLOR;--no-colorand--color=…on the command line are honoured;CLI_ACCESSIBLEturns help colour off; and a terminal that sets noTERM(Windows' conhost) gets plain help unlessFORCE_COLOR,--colororCOLORTERMasks for colour.burgee/contrastrounds with roundel'sround2; no output changes.paratext: the supports-color fork behindparatext/terminal-linkis unchanged, and now held to roundel's policy by a parity test everywhere their two incumbents agree.
0.7.2
Patch Changes
- #604
0e7b1e8Thanks @ofri-peretz! - Each README links to its migration guides under the docs link: "Migrating from: chalk", "ora · log-update · boxen · cli-table3", and so on. That puts a path from the npm page to the guide for the library you are replacing. No code changes.
0.7.1
Patch Changes
- #588
073037aThanks @ofri-peretz! - READMEs and package descriptions now match what each drop-in path is graded at. bellpull namesbellpull/node-whichas the drop-in for npmwhich(5 / 5) and no longer lists execa as a drop-in. paratext's ansi-escapes row is 4 / 4, with the CSI half implemented. seniority's rc row is 1 / 1, dotenv'sconfig()defaults toprocess.env, and lilconfig is 77 / 77. linegauge documentsambiguousIsNarrowandstripas shipped. No code changes.
0.7.0
Minor Changes
-
#543
dc1b1a7Thanks @ofri-peretz! - paratext implementsansi-escapes' CSI half —cursorTo,cursorMove,eraseLines,clearTerminal,enterAlternativeScreen,synchronizedOutputand the rest, byte-exact with ansi-escapes 7.3.0 — soimport ansiEscapes from 'paratext'is a full drop-in, graded 4 / 4 by ansi-escapes' own suite (it was 1 / 4 with CSI declaredundefined).burgee migratenow rewritesansi-escapestoparatext. -
#546
0592441Thanks @ofri-peretz! -paratext/terminal-linknow links exactly wheresupports-hyperlinks4.5.0 does. It honoursFORCE_HYPERLINK,--no-hyperlink/--hyperlink=always,CI, win32 outside Windows Terminal, NETLIFY, and the incumbent's version floors for iTerm2, WezTerm, VS Code and VTE (0.50.0 segfaults on OSC 8). It also recognises kitty, alacritty, ghostty, zed, Orca and Cursor. Its previous guess disagreed with the incumbent in 30 of 55 environments. The compatibility row is now 8 / 8, soburgee migraterewritesterminal-linkimports toparatext/terminal-link.
Patch Changes
-
#518
866b972Thanks @ofri-peretz! - README weight lines now count every incumbent with a graded drop-in: terminal-link and term-img (paratext), exit-hook (closeout), @inquirer/core (caique). -
#474
1955419Thanks @ofri-peretz! - burgee plugins can hook two more stages.parseruns before the command is resolved: it receives argv and may return a replacement, which is how an alias plugin mapsdtodeploy.shutdownruns once as the program exits, whether the command succeeded or failed. The familyschema.jsonshipped in every package now describes both stages.
0.6.1
Patch Changes
- #508
1aae1e2Thanks @ofri-peretz! -<package> --helpand--versionanswer instead of crashing. The bin took its first argument as the plugin file to import, soroundel --helpfailed withCannot find module '…/--help'and exit 1.-h/--helpnow print usage and exit 0,-V/--versionprint the version and exit 0, and any other flag where the plugin file belongs is a usage error, exit 2.
0.6.0
Minor Changes
- #507
b8e97dcThanks @ofri-peretz! - Runs on Node 20 and 22, not just 24+:engines.nodeis now^20.19.0 || >=22.13.0. Those are the first releases whererequire(esm)loads without a warning, so the CommonJSrequire()path keeps working. Every package's test suite runs on exactly 20.19.0 and 22.13.0, on Linux, macOS and Windows. caique's prompts no longer callPromise.withResolvers, which Node 20 doesn't have.
Patch Changes
- #505
9800b43Thanks @ofri-peretz! - Docs: the Benchmarks section's weight ceiling is re-measured against a fresh install of each incumbent's latest release (cosmiconfig 10.0.1, slice-ansi 9.0.1, which 7.0.0, dotenv 18.0.3, …) instead of the copies hoisted in this workspace, and names incumbents that were measured but left out of the ceiling as exactly that.
0.5.4
Patch Changes
- #494
f7f6d4bThanks @ofri-peretz! - Each package'shomepageand README docs link now point at its own documentation site,https://<package>.interlace.tools, instead of a page on burgee's site. The oldburgee.interlace.tools/docs/packages/<package>URLs answer with a 301 to the new host, so nothing already linked breaks. closeout's README override example also resolves to the current release again (npm:closeout@^0.4; the 0.4.0 release left it at^0.3).
0.5.3
Patch Changes
- #480
2dc573fThanks @ofri-peretz! - README corrections: paratext shows terminal-link at its measured 8 / 10 (was the stale 0 / 10 floor); linegauge's and closeout'snpm:override examples resolve to the current release instead of 0.2 / 0.1.
0.5.2
Patch Changes
- #465
acf98f3Thanks @ofri-peretz! - Each README now opens with the incumbent it replaces and the agent surface it serves (--json, an agent event, or a static projection), so npm shows both above the fold. README text only; no code changed.
0.5.1
Patch Changes
-
#454
b4584e7Thanks @ofri-peretz! - Every package's npmhomepagenow points at its page on the docs site,https://burgee.interlace.tools/docs/packages/<name>, and each README links it under the header. The keywords add what people and models search for:burgeegainscli-framework,argument-parser,subcommands,json-schema,mcp-server,model-context-protocol,ai-agent,llm,shell-completion,typescript,zero-dependency,commander-alternativeandyargs-alternative; the other eight gainagent,ai-agent,non-tty,jsonandzero-dependencywhere the package does that —zero-dependencyonly on the six that install nothing at all.burgee's README gains a short FAQ (commander alternative, agent use, MCP, dependencies) and states the compatibility counts the oracle holds — 1,360 / 1,360 of commander's tests and 804 / 804 of yargs' — where it had said 1,215 and 1,185.caique's README no longer calls a released package pre-release. -
#442
bdaf364Thanks @ofri-peretz! - Every package now listsplugin,pluginsandextensiblein its npm keywords, because every package takes plugins through one shared contract.A plugin is a plain object, validated against the
schema.jsonthat ships in every package, and checked with the package's owncheckcommand. Each package reads its own key and ignores the rest, so one object can extend any subset of the family. The plugins page has a nine-layer example that every package'scheckaccepts in CI. -
#435
7888524Thanks @ofri-peretz! -schema.jsonnow describes every plugin host in the family.The one schema each package ships as its plugin contract used to cover only four hosts: roundel's
tokens, flagstaff'sglyphs,spinners,bordersandcomponents, paratext'scapabilities, and linegauge'swidths. Five hosts validated their keys in their own code, but the file an author (or a model) writes against said nothing about them. It now describes all of them:- bellpull
resolvers, including the absolute-path rule onpaths - caique
widgets - closeout
handlers, including the phases a plugin may use - seniority
sources, including the rank bounds - burgee
commands,hooksandenforce
Where the schema can express a rule, it gives the same verdict as the host's own validator, and a test holds the two together. Function-valued fields (
static,run,read,handler) are described and required, but not typed, because JSON Schema can't say "function".flagstaff now validates a plugin against only its own keys, not the whole family schema. It no longer refuses a plugin over another host's key, which lets one plugin object contribute to several hosts. Its entry points are also 4.7–5.9 KB lighter for it.
- bellpull
-
#445
dac303eThanks @ofri-peretz! - Every package now declaressideEffectstruthfully, so bundlers can drop what you don't import.Six packages declared nothing, so no bundler could drop any of their modules. A named import from the root now bundles to the same bytes as the same import from its subpath:
import before after import { explain } from 'seniority'2,939 B 1,067 B import { decide } from 'caique'1,235 B 734 B import { strip } from 'linegauge'1,102 B 940 B import { once } from 'closeout'353 B 235 B flagstaff and roundel used to declare
false, but each ships acheckcommand whose file runs when loaded. Each now lists that file, which is the true statement. paratext also lists the two modules that register its built-in capabilities when they load.
0.5.0
Minor Changes
-
#421
db3c59eThanks @ofri-peretz! - Every plugin host has acheckcommand.npx linegauge check ./my-widths.mjs npx burgee check ./my-plugin.mjs --jsonPRINCIPLES 7 asks three things of an extension surface: the plugin is data validated against one published schema, there is a
checkcommand that shows it every way it can be seen, and the bar is measured. The first was built in all nine hosts; the second existed inflagstaffalone. So an author writing a plugin for any other host found out what it did by shipping it into a program — and a surface nobody can check is a surface nobody outside this repository can write against.Each command validates, registers, and shows what the host does with the plugin, in the host's own terms: linegauge measures each code point before and after the override, paratext shows a capability's
encodeand itsfallback, roundel each token and what it replaced, caique each widget's static projection rendered with its own sample. burgee's returns a document rather than printing one, soburgee check --jsonis the form an agent that just wrote a plugin reads.They share one contract with the author, held identically across all nine:
- a readable report, contribution by contribution, with
okas the last line; - a refusal with a code from the family's vocabulary and a
fix, exit 1; E_NO_CONTRIBUTIONfor a plugin that contributes nothing to this host — the schema allows unknown keys so one object registers everywhere, which makes a misspelled key silent, and this is how that typo tells on itself;- exit 2 with no file.
Each host also gains an eval case measuring the one-turn claim, proved to discriminate before it was committed: green against a correct plugin, red against the same plugin with one field broken.
- a readable report, contribution by contribution, with
Patch Changes
-
#430
4d1b2b3Thanks @ofri-peretz! -checknow reports every refusal with its code and its fix, wherever it was raised.Some plugin files register themselves on import: they call
register()at the top of the module and export the result. Until now, when such a file was refused, the error was thrown insidecheck'simport(), before the onlytrythat turns aPluginErrorintoE_PLUGIN_SCHEMA: …plus afix:line. The author got the bare message on stderr, with no code and no fix. Now the whole ofcheckruns inside that one handler, so every refusal comes out the same way on every host. -
#421
db3c59eThanks @ofri-peretz! - linegauge hosts plugins —widths, and it is the ninth of nine.scripts/extension-surface-lock.test.tshas carriedlinegauge: { plugin: false }since it was written, and the row was empty honestly: a width function is not obviously extensible, and an extension point invented to fill a table is worse than a gap that says so.What makes
widthsreal is that the package already admits the problem.width.tssays ambiguous-width characters are "counted narrow, which is what a terminal does unless it has been told it is rendering an East Asian locale" — and that covers only the ambiguity Unicode sanctions. A Nerd Font putting a two-column icon in the Private Use Area, a code point added by a Unicode release newer than the table compiled into this build, a font drawing U+2500 wide: each is a real, local disagreement with the built-in answer, and until now a user had no way to settle it short of patching the package.export default { name: "nerd-font", widths: { icons: { ranges: [[0xe000, 0xf8ff]], columns: 2, why: "Nerd Font patches two-column icons into the PUA; measured in WezTerm", }, }, };Three fields of plain data, so a plugin can arrive as JSON, be diffed, be generated and be printed without running its author's code (R7).
whyis required, which no other$defin the family does: a width table with no provenance cannot be audited when it turns out to be wrong, and wrong is the normal outcome for ambiguous width.A later registration wins over an earlier one and over the built-in tables, which is the point — the built-in answer is right for most terminals and the user is the authority on theirs. An override applies before the zero-width and emoji rules, or it would be decorative. A program with no plugin pays one
length === 0per cluster, and the ASCII fast path never reaches it.The family schema gains
widthRange,widthOverrideandwidths, and because it is one byte-identical file across every host, every host that validates against it grows by about 1.3 KB — five flagstaff budgets and two paratext ones moved for a definition only linegauge reads. That trade is the design's and is recorded as D-108 rather than absorbed.
0.4.0
Minor Changes
-
#380
f3224f4Thanks @ofri-peretz! -paratext/term-img— theterm-imgsurface as a drop-in subpath.terminalImage(image, options?)andUnsupportedTerminalError, graded at 12 / 18 against term-img's own suite, up from 0. A subpath rather than the package root because the root default export is alreadyansi-escapes' object and term-img's default export is a function — one default cannot be both, which is why the row measured zero: its whole TAP was aSyntaxErrorabout a missing named export, not eighteen failing behaviours.The six cases that stay red are one decision.
term-imgaccepts a path and reads it; this package takes bytes only, so thatnode:fsstays out of a package that otherwise touches nothing but strings. The refusal is aTypeErrorthrown at exactly the point upstream would have opened the file, which is what keeps the four path-to-an-unsupported- terminal cases passing.terminalImage(await readFile(path))is the migration.The five-terminal support table is term-img's own — iTerm2 ≥ 3, WezTerm ≥ 20220319, Konsole ≥ 22.04, Rio ≥ 0.1.13, VSCode ≥ 1.80 — read from the environment, with no
iterm2-versionand noansi-escapesbehind it, and with upstream's iTerm2 major-version comparison corrected so that 10.x is not read as 1.x.The OSC 1337 record moved from
builtins.tsinto its own module so the new subpath can reach it without loading the plugin registry.paratext's exportedimagecapability is the same object it always was. -
#372
2f6cb16Thanks @ofri-peretz! -paratext/terminal-link— theterminal-linksurface as a drop-in subpath.terminalLink(text, url, options?),terminalLink.stderr, andisSupportedon both, graded at 8 / 10 against terminal-link's own suite, up from 0. A subpath rather than the package root because the root default export is alreadyansi-escapes' object and terminal-link's default export is a function — one default cannot be both.Runtime.isTTYgains an optionalstderr, since this façade's whole surface is a pair and deciding both streams from one would answer the wrong question for half the API.
Patch Changes
-
#373
a1f1d40Thanks @ofri-peretz! - Stage 2's artifact is nowspec.md, the name Anthropic's AI-Native SDLC playbook gives it, so the source comments and README sections that cite a package's own design document point atspec.mdrather thandesign.md.No behaviour changes. The published tarballs do move, by two bytes per surviving reference —
design.mdis nine characters andspec.mdis seven — so the four packages carrying a weight band were re-measured against it: linegauge 83,538 to 83,536; paratext 66,343 to 66,341; closeout 84,455 to 84,453; bellpull 86,113 to 86,107.
0.3.0
Minor Changes
-
#316
c8acb28Thanks @ofri-peretz! -paratextis now call-compatible withansi-escapesfor the four OSC members of its surface —link,image,setCwd,beep— as both a default export and named exports (paratext/design.mdR8). The bytes are the incumbent's where the terminal understands them, and the static projection everywhere else:Docs (https://x.dev)for a link, the caption for an image, nothing for asetCwd. That difference is the reason to swap, and it is the difference between a pipe receiving something readable and a pipe receiving\u001B]1337;File=inline=1;….Its CSI half stays out of scope — the cursor, erasing, scroll regions, the alternate screen, which
flagstaffdraws andcloseoutputs back. Those thirty-three names are nonetheless declared, asundefined, because ESM refuses a named import of a name a module does not export: without themimport ansiEscapes, { cursorTo } from 'paratext'was aSyntaxErrorthat took the whole file down before a line of it ran. TypeScript types them so that calling one is a compile error rather than a run-time surprise. Graded againstansi-escapes@7.3.0's own suite the row moves 0 / 4 to 1 / 4, which is its ceiling: three of its four cases assert CSI, so 25% there means complete.Two root exports changed shape.
linkandimageare now the incumbent's functions rather than this package's capability records, because a caller who swapped one import specifier would otherwise have got an object shaped nothing like a function, silently. The rule is stated rather than case-by-case — a record export survives unlessansi-escapeshas that name — sobell,clipboard,cwd,notifyandtitleare unchanged. The two that moved are reached ascapability('link')andcapability('image'), or throughbuiltins.image's encode template gainedpreserveAspectRatioandsize, upstream's last two options in upstream's order, soimage()is byte-identical to the incumbent rather than merely call-compatible.sizeis optional in the protocol and required by xterm.js, which is why upstream always writes it.New subpath
paratext/plugin: paratext hostscapabilities(plugin-contractR5a). A plugin object registers, every key another layer owns is ignored without complaint, andattach()hands the contributions to the sameregister()the built-ins go through — so a third party's capability is not a second-class citizen of the registry. Refusals use the family vocabulary:E_PLUGIN_SCHEMA,E_PLUGIN_CONTRACT, andE_NO_STATIC_PROJECTIONfor a capability with nofallback, which is the same defect flagstaff raises it for in a component and caique in a widget.Runtimegained an optionalcwd, which is the only thingsetCwd()needs to default the way the incumbent defaults it toprocess.cwd()— and the way to add it without a secondprocessreference in the package. -
#294
3f92a60Thanks @ofri-peretz! - paratext validates against the family plugin schema, with its shape undercapabilities.paratext shipped its own
schema.jsonwhose root was one capability, so the family had three plugin schemas where the contract says one (PRINCIPLES 14,plugin-contractR2). The capability shape is now$defs/capabilityof the shared file, reached through acapabilitieskey besidespinners,tokensandcomponents, andpackages/*/src/schema.jsonhashes to one value. flagstaff and roundel ship the same bytes: their published./schema.jsongains the capability definitions and nothing about what they validate changes.check()follows the schema's$defs/capabilityDocumentand takes either shape:- a plugin carrying its capabilities under
capabilities, which is where they live from now on, and whose problems are reported atcapabilities.<key>; - deprecated — one capability written as the whole document, which is what a 0.2
capability file looks like. It still validates, and
check()returns adeprecated:line saying to move it undercapabilities. paratext 1.0 stops accepting it (.sdlc/PLAN.mdD2).
refusals()andisDeprecation()are exported to tell the two kinds of line apart; the lines that are not deprecations are the ones that block, and the onesregister()throws on.register(capability)is unchanged: it takes one capability, not a document, so it neither reports nor accepts the document-level deprecation. - a plugin carrying its capabilities under
-
#332
3ea38c3Thanks @ofri-peretz! - New subpathparatext/link— OSC 8 on its own, 2,337 B, and nothing registered at import.The root is 17,574 B and runs
registerBuiltins()as an import-time side effect, which is correct for a program that wants all seven capabilities and unaffordable for one that wants a clickable URL in its--help.burgeeis that consumer:help.tsis imported statically byexecute.ts, so anything help reaches is paid for byburgee foo --jsonas much as byburgee --help, and a dynamicimport('paratext')of a barrel is not shakeable — burgee has a measured 54,986 B failure from exactly that. So the dependency was refused, and the refusal was correct. This entry is the answer to it.import { link, linkFor, supportsLink } from "paratext/link"; link("Docs", "https://x.dev"); // a supporting terminal: ESC ] 8 ; ; https://x.dev BEL Docs ESC ] 8 ; ; BEL // a pipe: Docs (https://x.dev)linkFor(runtime)is the form a host should use —burgee's renderer already carries aRuntime, and passing it means nothing in the path readsprocess.supportsLink(runtime)answers the guess without emitting, for a renderer deciding layout rather than bytes.LINKis the capability record itself, and it is the same objectbuiltins.linkis rather than a copy: the record moved into this module andbuiltins.tsre-exports it.It does not consult the registry, on purpose. A caller who corrected our terminal guess by re-registering
linkglobally does not change what this returns — the registry is what this entry deliberately does not load.emit(runtime, 'link', …)on the root is the form that does.Supportandsupports()moved to an internalsupports.tsso the subpath can ask "does this terminal do OSC 8" without pullingschema.json, which is 6,531 B of plugin contract. Both are re-exported from their old home unchanged; no import moved.Also new:
packages/paratext/src/weight.test.ts, the per-entry-point lockcloseout,caiqueandroundelalready carry. Every published entry declares what it may reach, what it may never reach, and what it may weigh, and a new export cannot ship without a rule —./linkmay not reachcapability.js,builtins.js,index.js,plugin.jsorschema.json, which is what makes "registers nothing" true by construction rather than by inspection.Splitting the two modules out cost the root 619 B, 16,955 → 17,574.
-
#334
0f00f72Thanks @ofri-peretz! -check()andregister()now readschema.jsonrather than one array out of it.The package's own extension surface accepted this:
{ name: 'x', osc: { nope: true }, when: 'not an object', encode: 'e{text}', fallback: '{text}', extra: 1 }whenis the one that mattered.supports()destructures it, a string destructures to fourundefinedclauses, every guard falls through, and the answer istrue— so a capability with a typo there wrote OSC into whatever the caller had redirected to. Measured on the published build,emit()on a runtime withisTTY.stdout: falsereturned"]8;;https://x.devDocs]8;;". That is the one failure this package exists to prevent, reached through its own documented plugin surface.src/shape.tsis a walk over the JSON-Schema keywords the file actually uses —type,oneOf,const,minLength,minimum,items,propertiesandadditionalProperties: false— with no dependency added, becauseajvis over 100 KB in a package whose root entry is under 20 KB. It is wired intocapabilityProblems(), which bothcheck()andregister()already went through, so the same refusal closes the document path and the registry path:register()is the only way into the registryemit()reads, and it is that refusal, not a guard further down, that keeps a malformedwhenaway fromsupports().supports()additionally answersfalsefor awhenit cannot read, which is the fail-safe direction rule 6 asks for.Every refusal names the path it is about —
capabilities.link.when.tty, not merely the capability — and carries a code from the family's one vocabulary:CapabilityErrornow has thecodethatPluginErroralways had, andplugin.tsstopped keeping its own copy of "fallback is required" besidecapability.ts's.This is a behaviour change for a plugin that was already wrong. A capability whose
osc,when,encode,fallbackornamedoes not match the published shape, or that carries a field the schema does not declare, is now refused atregister()and reported bycheck()where it used to pass. Nothing that validated cleanly before is refused now.What is not enforced is written down rather than left to be discovered:
$ref,pattern,minItems,maxLength,enum,allOf,anyOfandnot. None appears under a capability today, so nothing is silently unchecked — but a keyword added to the schema tomorrow would be, and the README says so instead of claiming the whole file is validated.
Patch Changes
-
#303
fc640ddThanks @ofri-peretz! - Stop claiming a drop-in path in the npm description until one is graded.The compat oracle now vendors
ansi-escapes' own suite at 7.3.0 and grades it. The control is 4 / 4;paratextscores 0 / 4, and the reason is one line of TAP —SyntaxError: The requested module 'paratext' does not provide an export named 'default'. The ansi-escapes-compatible default export (design R8) is not built, so "Drop-in paths for ansi-escapes, terminal-link and term-img" was a claim with a measured zero behind it. The description now says what is true — the OSC half of those three packages is covered — and defers the drop-in claim to the row that would prove it.No runtime behaviour changes.
-
#339
f295630Thanks @ofri-peretz! -schema.jsonconstrains token names, because it was promising something no host honours.tokenswas described as any name to a#rrggbbcolour.roundel'svalidate()accepts ten semantic names —error,warn,ok,hint,muted,command,flag,value,heading,ground— and throws on everything else. So a plugin author doing exactly what their ownE_PLUGIN_SCHEMAerror tells them, comparing their object againstroundel/schema.json, got a green from the schema and"accent" is not a tokenfromregister(). Measured 2026-09-16 with{ accent: '[#336699](https://github.com/ofri-peretz/burgee/issues/336699)' }.The schema now carries
propertyNames.enum, andscripts/plugin-contract-lock.test.tspins the enum and the runtime set to each other from both sides, so neither can grow a name the other does not know.Every host ships a byte-identical copy of this file (
plugin-schema-lock.test.tsasserts it), which is why nine packages are listed. Only the keyroundelowns is constrained: describingwidgets,handlers,sources,resolversorcommandsin a file all eight hosts share is what made flagstaff start validating caique's key last time (PluginError: plugin.widgets.later: expected object, got boolean), and those stay inplugin-schema-lock'sUNDESCRIBEDlist with that reason.linegaugeis in the list for a different change:ceilings.json's R9 block now records the bar as D1's tree-inclusive ceiling — 83,538 against 170,342, a ratio of 0.4904 — and keeps the supersededget-east-asian-widthbar beside it with the count of entries that cleared it.
0.2.0
Minor Changes
-
#229
6a6442eThanks @ofri-peretz! - The OSC layer, with extensibility as its shape rather than an addition to it.Seven capabilities —
link(OSC 8),image(OSC 1337),title(OSC 0),clipboard(OSC 52),notify(OSC 9),cwd(OSC 50 + 9;9) andbell— and a capability is one plain object with no functions in it: a name, an OSC code, a declaration of when a terminal is believed to understand it, and two templates. It can be written in a config file, generated, diffed and validated against the publishedparatext/schema.jsonwithout running anybody's code, which is what PRINCIPLES rule 7 asks for and what an agent needs to ship one in a turn.Nothing in this layer is detectable, so every capability carries a static projection and
registerrefuses one without it: an image becomes its caption, a notification a printed line, a hyperlinktext (url), and a pipe receives no control byte at all.
Patch Changes
- #229
6a6442eThanks @ofri-peretz! - Name reserved for the OSC layer.paratextwill own the escape class that addresses the terminal program rather than the character grid — hyperlinks, inline images, the window title, the clipboard, desktop notifications, the working directory and the bell — each with a static fallback for terminals that cannot do it. Exports only its own name until its intent and design are approved.