{ "app": { "App": "wire xdg dirs, store and cache together, the application control plane layer, directories-only layer so a cli opens databases per command, in-memory test layer seeded with files", "AppCache": "the app's ttl cache database in the xdg cache directory, a second named cache under your own service key", "AppConfig": "xdg-namespaced config file preset, load and save app config via config-file, decorated codec with its own error union", "AppStore": "the app's migrated sqlite state database in the xdg state directory, multiple stores each under your own service key", "AppTest": "hermetic app layer for tests over an in-memory filesystem, from the testing entrypoint" }, "bun": { "BunExtension": "bun lockfile extension data, catalog, catalogs, overrides and trustedDependencies", "BunLockDocument": "read a bun.lock as written, decode bun's native lockfile document, workspaces and package tuples" }, "bundler": { "ActionBuildOptions": "minify, source maps, externals, stub out ignored packages in action bundles", "ActionBuildResult": "what validating, bundling and persisting an action produced", "ActionBuilder": "build a github action end to end, validate, bundle, size check, persist", "ActionBundle": "bundle a github action with rolldown, one self-contained file per entry", "ActionConfig": "configure a github action build, the action table of effected.toml", "ActionEntries": "declare lifecycle entry points and worker bundles for an action", "ActionPersistLocalOptions": "copy an action build locally for nektos act testing", "ActionValidation": "check action config, entry points, action.yml and bundle sizes before shipping", "ActionWorker": "a worker bundle as its own table, source and a per-worker import check opt-out", "ActionYml": "parse and decode action.yml metadata, github action manifest shape", "ActionYmlBranding": "marketplace icon and color of an action", "ActionYmlBrandingColor": "allowed marketplace branding colors for an action", "ActionYmlBrandingIcon": "allowed feather icon names for action branding", "ActionYmlInput": "declare one workflow input, its default and deprecation message", "ActionYmlOutput": "declare one output an action sets", "ActionYmlPathError": "a runs path in action.yml names no file in the local copy", "ActionYmlRuns": "node24 main, pre, post steps and their conditions in action.yml", "ActionValidationOptions": "require action.yml, cap bundle size, treat warnings as errors", "BuildCollector": "accumulate build events, record warnings and pass timings, snapshot the report", "BuildCollectorTag": "service tag to provide or read the running build's event collector", "BuildFormat": "output module format choices, esm or cjs, for a build", "BuildIssuesSchema": "read issues.json back, decode a build's aggregated diagnostics", "BuildJournal": "append one jsonl line per finished build, per-package build history", "BuildPlatform": "target runtime choices, node, browser or neutral", "BuildReport": "per-package report of every target group, pass and emitted file", "BuildFailed": "an action entry failed to bundle or does not load", "BuildResult": "whether an action bundle succeeded, per-entry outcomes and duration", "BundleFailed": "an action entry is missing, unsafely named or could not bundle", "Bundler": "build one package to dist/prod, js and declarations, manifest, api model, single executable", "BundlerBuildResult": "finished build's outcome, its report and issues artifact", "BundleResult": "one action entry's outcome, its error, stats and rolldown warnings", "BundleStats": "one action bundle's size, build time and output path", "BundlerError": "build stopped early, names the failed phase and carries the collected report", "BundlerPhase": "which stage a build failed in, for reporting a failure", "CleanError": "removing an action build's dist directory failed", "ConfigValidationError": "structurally invalid build config, refused before any build work", "ConfigValidator": "fast-fail structural check of a resolved build config", "CopyEntry": "copy non-module assets into the published package, ship json schemas or data files beside the build", "DEFAULT_EXE_NODE_VERSION": "node runtime version embedded in a single-executable binary by default", "DiagnosticEntry": "one captured warning or error, tsdown, rolldown, api extractor or config", "EffectedConfig": "decoded effected.toml document, typed build config", "EffectedConfigError": "effected.toml unreadable, unparseable, undecodable, or its workspace undiscoverable", "EffectedConfigFile": "discover, merge by precedence and decode effected.toml for a package", "EffectedConfigSchema": "effected.toml json schema url, `#:schema` directive for tombi taplo, hosted schema identity", "EmittedFile": "one output file and its byte size, optional gzip size", "EntryOverride": "pin format and bundling to some export paths, per-entry build settings", "ExeConfig": "configure a node single-executable sea binary to compile", "ExeSeaConfig": "override the sea config defaults for a binary", "ExeTargetConfig": "platform and architecture to compile a binary for", "IssueJournal": "append one jsonl line per error and warning, per-package diagnostic history", "JsxConfig": "jsx transform settings, automatic or classic runtime and import source", "LooseFileSpec": "standalone output file's source and format, self-contained extra file", "ManifestConfig": "change the emitted package.json, drop fields from a published manifest", "MetaConfig": "api model generation settings, the build meta table", "MetaGenerationError": "api extractor run failed for an entry", "OgGenerateError": "open graph renderer threw or returned no valid image, fails the build", "PackageBuildConfig": "build settings of one package, plugins, externals, loose files, executables", "PackageConfig": "package table of effected.toml, build and tsdoctor settings", "PersistLocal": "copy an action build for local nektos act testing, generate the act template", "PersistLocalError": "copying an action build to its local directory failed", "PersistLocalResult": "files copied and skipped by a local action persist", "PassReport": "one pass's timing and files, js, dts, loose, exe or meta", "PlainDiagnosticSchema": "read one diagnostic back from issues.json or a journal line", "PluginLoadError": "named rolldown plugin module failed to load or has no plugin default export", "RELEASE_CHANNELS": "every release channel value, for iterating or validating channels", "ReportTimings": "start, end and duration of a build step", "ResolvedConfig": "effective config with every default filled, package table always present", "ResolvedEffectedConfig": "effective effected.toml plus the files it was merged from", "TargetGroupReport": "report of one publish group's passes and output", "TsdocConfig": "tsdoc settings, custom tags and warning suppressions for api extractor", "TsdocTagDefinition": "define a custom tsdoc tag, block, inline or modifier syntax", "BundleConfig": "author the emitted bundle.json config tier in effected.toml", "BundleManifestEmitError": "docs sidecar could not encode or write, recorded as a meta error", "BundleOpenGraphConfig": "open graph settings of a package's api docs, generate social cards", "BundleOpenGraphImage": "declare one open graph image for a package's api docs", "BundleRegistryRef": "declare a registry a documented package publishes to", "BundleManifestSourceError": "present bundle.json source file failed to parse or decode", "ValidationFailed": "action validation or a strict warning stopped the build", "ValidationIssue": "one action validation finding with code, file and suggestion", "ValidationResult": "whether an action may build, its errors and warnings", "WarningSuppressionRule": "silence api extractor messages by message id and pattern", "WriteError": "writing an action build's output file failed", "ambientOutName": "output file name for a types-only export, from its export key", "analyzeReexportBarrel": "classify a barrel's re-exports as value or type, can it become a stub", "assertNoEntryCollisions": "fail when a types-only output name clashes with a js entry", "buildEmittedManifest": "compute final package.json bytes for a publish group", "buildMetricsPlugin": "rolldown plugin recording emitted file sizes and rolldown diagnostics", "buildResolvedTsconfig": "portable absolute-path tsconfig object for the declaration pass", "buildTargetGroups": "run tsdown js and declaration passes for every publish group", "cjsDefaultInterop": "rolldown plugin, fix cjs default export alongside named exports with a footer", "classifyDtsExport": "tell ambient, mixed and runtime export values apart", "collectExportNames": "list every name a module exports, test re-exports against a base entry", "composeBundleManifest": "flatten authoring tiers into the emitted docs manifest", "computeExeFileName": "exact binary file name for a platform and architecture target", "copyAmbientDts": "copy types-only declaration exports verbatim into the output directory", "copyPublicDir": "copy public directory contents into the built package, additive", "createTimer": "wall-clock stopwatch for timing a build step", "createTsdownLogger": "route tsdown warnings and errors to the collector instead of console", "declarationExt": "get a path's declaration extension, is this a declaration file", "declarationsDirFor": "unpublished per-module declarations directory for api extractor diagnostics", "defaultManifestTransform": "strip build and dev-only fields from a published package.json", "deriveDtsPassOptions": "tsdown options for one publish group's bundled declarations", "deriveExportPaths": "map each build entry to its package.json export key", "deriveTargetGroupOptions": "tsdown options for one publish group's per-module js", "dtsPassDtsOptions": "dts plugin options for a resolved tsconfig path", "emitManifest": "rolldown plugin writing transformed package.json, license and readme to output", "extractAmbientDts": "find types-only declaration exports in an exports map, reject mixed ones", "extractEntries": "derive build entry points and bins from package.json", "findRelativeSpecifiers": "list relative imports in a declaration file, is it self-contained", "flattenIssues": "aggregate and de-duplicate a build snapshot into the issues artifact", "formatTime": "format milliseconds as human-readable duration", "githubOwnerRepo": "parse owner/repo from any github repository url spelling", "isTargetObject": "narrow a publish target value to its object form", "loadPlugins": "import rolldown plugin modules by path through jiti, typescript included", "loadBundleManifestSources": "read package and workspace bundle.json source tiers, report retired tsdoctor.json files", "manifestNeedsCatalogResolution": "check a manifest has catalog or workspace specifiers, skip resolving when none", "merge": "overlay a package's raw effected.toml on the workspace root's", "mixedDtsExportError": "error for an export mixing declaration types with a runtime source", "nodeBuiltinDefaultInterop": "rewrite default imports of node builtins to namespaces, work around rolldown cjs defect", "normalizeBinPaths": "strip leading ./ from bin paths npm would drop", "normalizeExeOptions": "resolve single-executable config to one spec per binary", "normalizeLooseFiles": "resolve standalone output file config to build descriptors, reject bad shapes", "normalizeMetaOptions": "fill api model option defaults", "ogImageInfoOf": "what a social card renderer receives, package name and description", "outDirFor": "output directory path for a publish group", "packageJsonEntries": "tsdown entry record, name to source path, from package.json", "readTsconfigJsx": "read jsx compiler options from a package tsconfig, best effort", "registriesFromTargets": "derive published registries from build targets, public packages only", "releaseWarnings": "advisory warnings for valid but suspicious publish targets", "removeDeclarationMaps": "delete .d.ts.map files from a built package before publishing", "renderCiAnnotations": "github actions error and warning workflow commands from a build report", "renderReexportStub": "write a thin declaration stub re-exporting from a base entry", "resolveJsxConfig": "effective jsx settings, explicit override or inferred from tsconfig", "resolveManifest": "replace catalog and workspace specifiers with concrete versions in a manifest", "resolveNextVersions": "optimistic next release version of every workspace package from pending changesets", "resolveOgCacheSalt": "cache key salt for rendered social cards, disable with false", "resolveOgGenerator": "pick a social card renderer by configured name", "resolvePortableTsconfig": "flatten extends into portable compiler options for the meta bundle", "resolveTargets": "turn publishConfig targets into distinct publish groups and bindings", "rewriteMetaVersions": "set own and sibling versions to their next release in a meta manifest", "runExeBuild": "compile single-executable binaries through tsdown", "serializeIssues": "pretty json text of the issues artifact", "transformBin": "rewrite typescript bin targets to built js paths", "transformExports": "rewrite typescript exports to types and import conditions, optional require", "transformManifest": "apply standard package.json publish rewrites, excluding catalog resolution", "writeDtsEmitTsconfig": "tsconfig variant with stable type ordering for deterministic declarations", "writeGeneratedOgImage": "render or reuse a cached social card, write it to the meta directory", "writeIssuesArtifact": "atomically write issues.json for a build target", "writeResolvedTsconfig": "write the resolved tsconfig to a temp file, get its path", "writeTargetsBinding": "write dist/prod/targets.json for the release action" }, "manifest": { "BundleManifest": "bundle.json schema, metadata a docs site reads for a package api bundle, decode emitted sidecar", "BundleManifestError": "unparseable or invalid bundle.json sidecar failure", "KNOWN_REGISTRY_TYPES": "registry protocol families supported beyond a link, npm and jsr", "MANIFEST_SPEC": "spec version of bundle.json this package reads and writes", "ManifestSource": "authoring tier of bundle.json, package or project source file schema", "OpenGraphConfig": "social card settings in a docs manifest, schema", "OpenGraphImage": "social card image entry, path, mime type and dimensions, schema", "ProjectIdentity": "project display name and tagline in a docs manifest, schema", "RegistryRef": "one registry a package publishes to, type, label and url, schema", "SbomRef": "point a docs manifest at an sbom file, path and format, schema", "BUNDLE_MANIFEST_FILENAME": "file name of the docs sidecar, bundle.json, inside a meta bundle", "decodeBundleManifest": "validate an unknown value as a docs manifest, parse bundle.json", "decodeManifestSource": "validate an unknown value as a bundle.json source tier", "encodeBundleManifest": "serialize a docs manifest to json-ready value, write bundle.json", "isKnownRegistryType": "check a registry type is recognized, otherwise degrade to link-only" }, "changesets": { "AmbiguousPackageError": "changeset names a package by a name two workspace projects publish, directory key needed", "BreakingFloor": "release must bump breaking, peer floor crosses dependency minor, patch ripple fix", "BumpType": "changeset bump values, patch, minor or major", "Changelog": "render changelog block for a release, insert into CHANGELOG.md, getReleaseLine", "ChangelogError": "changelog module function threw or rejected while rendering", "ChangesetConfig": "read and decode .changeset/config.json, changelog and snapshot options, defaults", "ChangesetConfigError": "changeset config missing, invalid json or wrong shape", "ChangesetFile": "parse a changeset markdown file, front matter and summary", "ChangesetLint": "lint changeset front matter, package names, release types, workspace packages, add house rules", "ChangesetMove": "consumed changeset moved under .changeset/pre in pre mode", "ChangesetParseError": "changeset without front matter, malformed yaml, or an invalid bump", "ComprehensiveRelease": "decode a planned release as changelog modules get it, @changesets/types shape", "Consumption": "has the ledger consumed this intent, prerelease-only or stable, graduation check", "EpicOutOfBand": "epic member major outside its lead's band, committed version check violation", "FixedOutOfStep": "fixed group members on different versions, lockstep check violation", "FloorCause": "dependency whose breaking release moves a dependent peer floor, stranded consumer", "Ledger": "read pnpm .changeset/ledger.yaml, which intents a release consumed, pending per project", "LedgerEntry": "one released name@version in pnpm ledger, project dir, consumed intent ids", "LedgerError": "pnpm release ledger malformed, invalid yaml, bad entry", "ManifestEdit": "new version and rewritten dependency ranges for one package.json", "MissingPackageError": "release plan names a package not among the given packages", "ModCompWithPackage": "decode an updated dependency with its manifest and dir, getDependencyReleaseLine input", "NewChangeset": "decode a changeset as a changelog module gets it, id summary releases", "NewChangesetWithCommit": "decode a changeset with its adding commit, getReleaseLine input", "PackageJSON": "decode a manifest as changelog modules get it, open, unknown keys kept", "ParsedChangeset": "released packages and summary text of one changeset", "PendingChangeset": "one unreleased changeset read from disk", "PendingChangesets": "list and read unreleased changesets under .changeset", "PlannedRelease": "one package's old version, new version and bump type in a plan", "PreState": "read pre mode state from pre.json, tag, initial versions, consumed changesets", "ProjectRef": "resolve a changeset release key to a workspace project, name and directory", "RangeEdit": "one rewritten dependency range, from and to specifier", "RegistryVersions": "is this version already published, registry probe for first releases", "ReleaseCause": "why a package releases, intent, dependency ripple, fixed group, epic re-base", "ReleaseContext": "release plan with the packages and config it was read from, hand to edits and changelog, read from a subdirectory", "ReleaseEdits": "changeset version as data, manifest edits, changesets to delete, next pre.json", "ReleaseManager": "detect whether releases are planned by pnpm versioning or the changesets cli, ledger.yaml, versioning key", "ReleasePlan": "compute next versions from pending changesets, dependents, snapshot versions, apply edits", "ReleaseType": "package release outcomes, including none for an unreleased package", "SnapshotPreModeError": "snapshot release refused while in pre mode", "SnapshotTemplateError": "snapshot prerelease template placeholder without a value, or missing tag", "UnknownPackageError": "changeset names a package missing from the workspace", "VersionType": "decode a bump, major minor patch or none, changelog contract", "VersioningCheck": "pnpm change check, committed versions against epic bands and fixed groups", "VersioningError": "pnpm refuses a release plan, maxBump exceeded, epic band, ignored package, pnpm error code" }, "cli": { "CLI_VERSION": "the effected command's own version, replaced at build, what effected --version prints", "main": "run the effected command on Node, the effected bin entry, a carrier bin shim passes its distribution", "run": "run the effected program over a test platform layer in-process, drive the cli in a test", "makeRootCommand": "build the effected command tree over a process boundary, wire audience flags, test the cli with its own process values", "mainOptions": "how the effected program runs, exit 3 for uncoded typed errors, failure report span trail", "CatalogMergeError": "merged schemastore catalog could not be assembled, duplicate catalog url or entry name across slices", "DriftError": "published schema drifted under onDrift error, nothing written, exit 1", "GateError": "schema failed lint or validation gate, nothing written, exit 1", "NoConfigError": "no schemastore config found, exit 2, usage failure of effected schema", "StaleError": "effected schema check found committed documents out of date, CI drift gate, exit 1", "ValidationFailedError": "payload does not conform to schema, validation verdict, exit 1", "ActionBuildFailedError": "action validation stopped the build or an entry failed, exit code 1", "ActionConfigError": "action build could not start, bad config or no action table, exit code 2", "ActionRunError": "action build could not finish, missing entry or unwritable file, exit code 3", "BuildFailedError": "package build crashed or recorded errors, exit code 1", "PackageRunError": "package build hit an unreadable or unwritable file, exit code 3", "PackageConfigError": "package build could not start, bad config or plugin, exit code 2", "ActionInitError": "action init could not start, no package.json, bad metadata, existing files, exit code 2" }, "cli-kit": { "Cancelled": "user quit a prompt or screen with esc or ctrl-c, exit 130", "CliAudience": "add --agent --human --ci --audience flags, resolve the audience before parsing", "CliColor": "decide once whether stdout gets ansi colour, `FORCE_COLOR` and `NO_COLOR` aware", "CliDoc": "let an error class draw its own failure report as a document", "CliEnv": "build audience, terminal, theme and links once, decide whether the run may prompt", "CliExit": "record the highest exit code set during a run for a findings-not-a-failure cli command, read back by CliRuntime.main", "CliFailure": "draw a failure as a document, schema issues as a tree, app frames and spans only", "CliInteractive": "may this run prompt a person, human audience on a tty, not TERM=dumb", "CliLinks": "open file links in vscode or as file urls, osc 8, never for agents", "CliLog": "opt-in diagnostics, log level env var, ndjson for agents and CI, file sink, a painted status glyph on a log line", "CliLogger": "plain-line cli logger, no timestamp or level prefix, every level to stderr by default", "CliMessage": "print one themed success, info, warning or failure line no log level silences", "CliPrompt": "prompt for a missing flag or argument only when interactive, else a default", "CliRuntime": "report a cli program's failures through its own logger, set exit code", "CliTest": "spawn a cli bin in a sandbox, read exit and output, stream or signal", "CliTheme": "paint text by semantic token per stream, colour level aware, status glyphs, the agent-never-gets-an-escape rule", "CliUi": "run an ink screen from a handler or flag fallback, map a screen's answer, live progress view with a lazy view and a final document", "CliUiTest": "test ink screens and live views in memory: press keys, read frames, terminal transcript", "serializer": "register the cli frame snapshot serializer through vitest snapshotSerializers config", "ConfigIssueRenderer": "render a @effected/config-file validation error into human-readable lines", "Confirm": "yes or no question screen with extra toggles", "Doc": "build a report once as a document: tables, trees, lists, counts, diffs, callouts", "DocView": "draw a document inside an ink tree, byte for byte like the static output", "Fmt": "sanitize escapes, display width, truncate, durations, plural, did-you-mean suggestions, error text", "GithubAnnotation": "format a GitHub Actions error or warning annotation for a file and line", "Glyphs": "unicode or ascii status glyphs, spinner frames, tree segments, ascii under TERM=dumb", "KeyHelp": "one-line key help footer from key tables, cut to the terminal width", "KeyTable": "declare a screen key bindings once for dispatch and help", "MultiSelect": "checkbox list screen in sections, pick several values", "NotInteractive": "a prompt was reached with no person to ask, exit 64", "Render": "render a document as plain text, ansi, markdown or a GitHub Actions log, collapsible rendered plain inside an open log group", "SchemaIssueRenderer": "turn a schema decode failure issue tree into lines a user can act on", "Select": "pick one value from a scrolling list screen, disabled choices skipped", "Status": "typed status vocabulary with glyphs, colours and severity rank, extend it, pick the worst", "Styled": "paint ink text with a theme token", "Tabs": "tab bar for a custom ink screen, tab and digit keys switch tabs", "TestTerminal": "drive core prompts in a test, type keys, capture output, prove nothing was read", "TextInput": "single-line text entry screen with placeholder and validation", "Toggle": "on or off switch view for a custom ink screen", "Token": "semantic colour tokens and custom styles, hex or named colours, colourless at none", "UiKey": "normalise ink key input into named keys or characters", "UiProvider": "give an ink tree the kit did not mount the cli theme and glyphs", "UiStreams": "which stdin, stdout and stderr an ink screen binds to", "Viewport": "scroll a window of rows that never overflows the terminal, sticky section headers", "inkProps": "map a theme style to ink text props, colourless at colour none", "useGlyphs": "read the cli glyph set inside an ink component", "useKeys": "dispatch ink keystrokes through a key table, chunk-safe", "useTerminalSize": "usable terminal columns and rows inside an ink component", "useTheme": "read the cli theme inside an ink component", "CliFormat": "add a --format flag, alias or custom formats, print json, print json without the flag", "CliTestFailure": "a spawned cli test run exited otherwise than expected, assert exit code, read child stderr", "useStyle": "resolve Ink Text props from a theme token, honour consumer theme overrides in a component" }, "commands": { "CommandFailedError": "handle a command that failed to spawn, exited non-zero, or timed out", "CommandOutput": "captured stdout, stderr and exit code from a finished command run", "CommandOutputError": "handle a command whose output was not usable json, exceeded byte cap", "DEFAULT_MAX_OUTPUT_BYTES": "the default 16 MiB per-stream captured output ceiling", "ExecContext": "how to run a project-local binary: launcher argv prefix, dlx prefix, script prefix, directory", "Launcher": "package managers with a local exec argv: npm, pnpm, bun", "LocalExec": "contract for the project-local way to run a binary here", "LocalExecError": "handle failure determining the project-local execution context", "MismatchPolicy": "what to do when global and project-local tool versions disagree: preferLocal, preferGlobal, fail", "REDACTED": "the placeholder string written in place of a redacted secret", "Redaction": "scrub secret values and known secret-bearing flags out of command args and captured output", "ResolvedSource": "which copy of a tool was resolved from: global or local", "ResolvedTool": "a tool discovery found, with its resolved source, version and a runnable command builder", "Retry": "classify a command failure as a transient transport hiccup, ready-made retry policy with backoff", "Run": "run a subprocess and collect output, text, lines, json, or a streaming line-by-line result", "SECRET_FLAGS": "argv flag names whose following value is treated as a secret to redact", "ScriptedSpawner": "test double for ChildProcessSpawner: script each spawn's outcome, inspect recorded spawns", "TRANSIENT_PATTERNS": "substrings in command output that mark a failure as a retryable transport hiccup", "Tool": "a cli tool to resolve, constraints: version probe, source, mismatch policy", "ToolDiscovery": "find a cli tool on path or project-locally, cache probe evidence, resolve its version", "ToolNotFoundError": "handle a tool that could not be found where its source requirement demanded it", "ToolRefusedError": "handle a tool name refused: looks like a flag, or empty", "ToolSource": "where a tool must be found for resolution to succeed: any, local, global, both", "ToolVersionMismatchError": "handle global and local copies of a tool reporting different versions", "VersionFlag": "learn a tool's version by passing a flag and matching output pattern", "VersionJson": "learn a tool's version via json, reading a dotted path within it", "VersionNone": "skip asking a tool for its version; only check that it is present", "VersionProbe": "ways to learn a tool's version: flag output, json path, or none", "ToolPreference": "choose global or local copy when both installed, prefer global tool", "makeToolDiscoverySync": "find a cli tool without an Effect runtime, synchronous probe for lint-staged handlers", "nodeSpawnSync": "node child_process binding for synchronous tool probes", "ExecKind": "classify a launcher argv as npx, pnpm dlx, bunx or a local exec", "ModuleResolution": "resolve a package from the project's own install, detect a stale install, load it lazily", "PrebuiltBinary": "find the platform-specific binary an optionalDependencies fan-out installed", "PrebuiltBinaryError": "no usable prebuilt binary for this platform, missing package or deleted binary", "PrebuiltBinaryReason": "why prebuilt binary resolution failed, branch on the reason", "ProcessLiveness": "current pid and hostname, check whether another process is still alive", "ResolvedPrebuilt": "the resolved binary path, package and version for this platform", "RunOnce": "run work once across concurrent processes with a lock file and done marker, stale lock takeover", "nodePrebuiltHost": "node binding for prebuilt binary resolution from an anchor path", "nodeProcessLiveness": "node binding for pid, hostname and a signal-0 liveness probe", "nodeRunOnceFileSystem": "node fs binding for the run-once lock and done files", "nodeRunOnceHost": "complete node host for synchronous run-once: fs, liveness, clock, sleep, nonce, spawn", "nodeRunSync": "node child_process binding for a synchronous run-once command" }, "config-file": { "ConfigCodecError": "handle malformed config content, typed parse or stringify failure", "ConfigDefaultPathMissingError": "handle save called without a configured default path", "ConfigEncryptionError": "handle encryption, decryption or key-derivation failure on a config file", "ConfigEvent": "one timestamped config-pipeline event to subscribe to", "ConfigEventPayload": "discovery, parse, validate, merge, write event union, subscribe to config lifecycle", "ConfigEvents": "opt-in pubsub hub for config discovery, parse, validate, write events", "ConfigFile": "load, save and watch an application's config file across several candidate locations", "ConfigFileNotFoundError": "handle no config file found anywhere in the resolver chain", "ConfigFileReadError": "handle a config file that could not be read from disk", "ConfigFileWriteError": "handle a config file that could not be written to disk", "ConfigMigration": "upgrade an old config file schema to the latest version on load", "ConfigMigrationError": "handle a versioned config migration step failing to read, apply or write", "ConfigResolver": "find a config file: explicit path, static dir, upward walk, or /etc", "ConfigSourceRef": "path and resolver name that contributed a config value", "ConfigValidationError": "handle a config document failing schema validation or a custom check", "EncryptedCodec": "wrap a config codec with aes-gcm encryption at rest", "EncryptedCodecKey": "supply a crypto key or derive one from a passphrase for encrypted config", "JsonCodec": "parse and stringify config as plain json, no parsing engine dependency", "JsoncCodec": "parse and stringify config as jsonc, comments and trailing commas allowed", "MergeStrategy": "combine several discovered config sources into one value, first-match or deep merge", "ConfigMerge": "deep merge two config values synchronously, override wins, prototype-pollution safe", "TomlCodec": "parse and stringify config as toml", "VersionAccess": "read and write the version field used by config migrations", "YamlCodec": "parse and stringify config as yaml", "asConfigProvider": "bridge a loaded config document into effect's Config accessors", "layerConfigProvider": "install a config file as a fallback beneath the ambient ConfigProvider" }, "engine": { "Identity": "build the effected tool identity report, version distribution and resolved effect version for a front end", "IdentityReport": "what the effected tool reports about itself, tool name, version, carrier distribution, effect version", "BuildLockHolder": "who holds a package's build lock, pid, start time and package directory", "BuildLockTimeoutError": "another build of the same package held its build lock for the whole wait, naming the holder", "AjvInstanceValidator": "the shipped ajv strict-mode InstanceValidator engine layer, the one real implementation effected schema validate composes, provide it to validate payloads yourself", "AjvValidator": "the shipped ajv strict-mode SchemaValidator engine layer, the one real implementation effected schema build composes, provide it to drive SchemaPipeline yourself", "ConfigLoader": "find and load schemastore.config.ts, walk upward discovery, jiti import, explicit config path", "ConfigLoadError": "schemastore config exists but could not be loaded, import threw, bad default export", "ConfigNotFoundError": "no schemastore config found by discovery or at explicit --config path", "ConflictingFlagsError": "force combined with a drift policy other than allow, contradictory flags usage error", "CatalogConflict": "catalog url or display name advertised twice across slices, merge refuses a winner", "CatalogDirError": "catalogDir exists but cannot be listed, file in place of directory, permission failure", "CatalogReport": "catalog line of a schema run report, this config slice and merged catalog", "CatalogSliceReport": "this config's catalog slice file, entry array rewritten wholesale per run", "MergedCatalogReport": "merged schemastore catalog.json, every slice united and sorted by url", "InvalidSlice": "a catalog slice the merge could not use, unreadable, not JSON, not an array", "DocumentDiff": "what differs between a document on disk and the generated one, line hunks, drift report", "LineDiffHunkSchema": "schema for one line diff hunk of a document diff, decode wire form", "LineDiffLineSchema": "schema for one line of a diff hunk, decode wire form", "FrozenVersionIdMismatchError": "frozen schema file lacks or changes its derived $id, checked before build", "FrozenVersionMissingError": "advertised frozen schema version file missing on disk, checked before build", "LocatedFinding": "one way a payload fails its schema with source location, validation finding with line and column", "SourcePoint": "one-based line and column of a place in a file, UTF-16 columns", "MissingSchemaRefError": "payload names no schema and none given, nothing to validate against", "PayloadError": "payload file unreadable or not JSON, nothing validated", "SchemaResolutionError": "schema reference resolves to no readable document, not a file nor a derived identity", "Report": "render a schemastore run report for a terminal, as JSON or as GitHub step summary markdown", "RunReport": "whole schemastore build or check run as a value, drives renderers and exit codes", "SchemaReport": "one schema's line in a run report, status and drift outcome", "Runner": "shared build and check walk, verify frozen versions, classify drift policy, write when clean", "SchemaRun": "run effected schema build or check as an Effect, load config, version check, drift policy, write documents", "SchemaRunResult": "answer of one schema run, report, verdict, version mismatch passed", "SchemaValidate": "validate a payload file against a published schema, resolve by file then derived identity, effected schema validate", "StepSummary": "append a rendered report to GITHUB_STEP_SUMMARY in a GitHub Action", "ValidateReport": "answer of one validate, valid flag and located findings, non-conforming payload is a result", "VersionCheck": "compare schemastore versions stamped on a config with the version the tool was built against", "VersionMismatch": "config built from a different schemastore copy than the tool, mismatch report", "VersionMismatchError": "run refused a schemastore version mismatch before generating anything, exit 2", "ActionRun": "run one github action build for a front end, verdict and partial result", "ActionRunResult": "an action build's verdict and what validation and bundling did", "NotAnActionError": "action build requested where effected.toml has no action table", "BuildRun": "run one package build for a front end, verdict and journal lines", "BuildRunResult": "one build's verdict, issues artifact, recorded report and config files read", "NotAPackageError": "build requested in a directory without a readable package.json", "ActionInit": "scaffold a new github action, plan files as data, write without overwriting", "ActionInitResult": "what action init wrote or replaced and the dependencies still to add", "ActionScaffold": "a new action scaffold as data, its files and the packages it imports", "ActionScaffoldFile": "one scaffold file, relative path and whole content", "ScaffoldExistsError": "action init refused, target files exist and force was not given", "ActionMetadataMissingError": "action init has no name or description, given or in package.json", "ActionMetadataInvalidError": "action init refused a name or description holding control characters", "ScaffoldConflict": "one path action init cannot write, symlink, wrong kind, unreadable, unwritable, outside", "ScaffoldConflictError": "action init refused symlinks or wrong-kind entries before any write, even with force", "ScaffoldWriteError": "action init write failed after its checks, names files already written, exit code 3" }, "kit": { "CurrentDistribution": "read which carrier package installed this run without it appearing in R, defaults to none", "Distribution": "the carrier package name and version a tool's bins were installed through", "DistributionField": "the nullable distribution field of a machine-readable envelope, null for a direct install", "ErrorText": "turn any thrown value or error into text without throwing, cause-chain messages", "LaunchContext": "resolve a launched tool's project directory from argv, env keys, then cwd, rejecting unsubstituted placeholders", "ProcessGuard": "transport-neutral crash guards for an lsp or any server process before its graph loads, mark connected yourself, exit only before connect, startup failure exits 1, parse a crash-injection env value", "Remediation": "what a caller, usually an agent, should do after a failure: hint plus optional suggested tool and args", "distributionSuffix": "render the via name version suffix for a --version line or startup log, empty for a direct install", "Exclusive": "serialize work that mutates process-global state, one at a time with a timeout, abortable promises", "ExclusiveTimeout": "exclusive lane body ran past its timeout", "ProcessScope": "scoped chdir, env var and stream patches restored when the scope closes", "ProcessScopeError": "changing the working directory or process state failed", "withDistribution": "provide the carrier package name and version a tool was installed through", "withDistributionVersion": "append the via carrier suffix to a --version line formatter", "PathContainment": "check a caller-supplied path stays inside a workspace root, refuse path traversal, containment guard" }, "env": { "Audience": "tell a human from an agent or CI job, override variable, flag-sourced", "CurrentRuntimeEnv": "detect the running agent, CI provider and terminal once, from config", "EnvOverride": "read a mode variable accepted per audience, report rejected values without logging", "RuntimeEnv": "agent, CI and terminal detection snapshot, persist as plain JSON", "TerminalEnv": "per-stream colour level, `FORCE_COLOR` precedence, sync colour from env record, hyperlinks, width, core TerminalCapabilities", "Sgr": "strip colour and attribute escape codes only, keep cursor moves and hyperlinks, paint text bold dim italic underline or basic colours at a colour level", "ShellExports": "parse and write shell export files, read session env, quote one shell word, posix sh quoting, always quote, quote without throwing", "ShellExportsError": "shell export text rejected, line, column and reason", "ShellQuoteError": "shell value cannot be quoted, NUL or lone surrogate" }, "git": { "BranchEntry": "one local or remote-tracking branch, name sha and whether it is checked out", "CommitInfo": "one commit's sha, GPG signature verdict, and raw message from git log", "CommitLogEntry": "one commit from git log with sha, author identity, both dates as DateTime.Utc, and touched paths", "ConfigListEntry": "one git config key/value pair from git config --list", "DirtyWorktreeError": "merge-shaped op refused because local changes would be overwritten, commit or stash first", "FileNotFoundError": "diffFile path found neither at the ref nor in the index, patch text of one file", "Git": "run git commands with redacted argv, read file at ref, patch text of one file, status untracked files mode", "GitCommand": "pure constructors for git argv/invocations with redacted secrets", "GitCommandError": "git command failed or spawn/timeout failure, exit code and redacted argv and stderr", "GitConfig": "lossless git-config document, parse and surgically edit git config text preserving formatting", "GitConfigDiagnostic": "one structural problem found parsing git-config text, malformed config line", "GitConfigEditError": "a set/append/unset/section edit to a git config document was refused", "GitConfigEntry": "one variable line of a parsed git-config document, key and decoded value", "GitConfigInclude": "one include or includeIf directive found in a git-config document, not resolved", "GitConfigParseError": "git-config text failed to parse, malformed config, handle diagnostics", "GitConfigSection": "one [section] or [section \"subsection\"] block of a parsed git-config document", "Gitmodules": "typed view over a .gitmodules document, parse .gitmodules, decoded submodule entries", "GitmodulesDecodeError": "a [submodule] section in .gitmodules failed to decode, missing path or url", "GitmodulesEntry": "one decoded submodule entry from .gitmodules: name path url branch shallow update ignore", "LsFilesEntry": "one staged index entry from git ls-files --stage, mode oid stage path, staged gitlink", "LsRemoteEntry": "one ref a remote advertises via git ls-remote, sha and full refname", "LsTreeEntry": "one entry of a git ls-tree listing at a ref, mode type oid path", "MergeConflictError": "merge-shaped operation stopped with conflict markers, pull or stash pop conflict", "NameStatusEntry": "one changed path with its one-letter status code from git diff --name-status", "NonFastForwardError": "git push rejected because the remote ref moved, non-fast-forward or force-with-lease failure", "NotARepositoryError": "cwd is not inside a git working tree", "RefEntry": "one ref from git for-each-ref, refname sha and pointed-at object type", "StashEntry": "one stash entry from git stash list, reflog selector sha and subject", "StatusEntry": "one entry of git status --porcelain, index and working-tree status codes and path", "SubmoduleStatusEntry": "one line of git submodule status, decoded state current uninitialized outOfSync conflict", "ShallowHistoryError": "commit that added a file is behind a shallow clone boundary, deepen or unshallow to find it", "UnknownRefError": "a ref or ref range does not resolve to an object in the repository", "WorktreeEntry": "one working tree from git worktree list, path head branch detached bare locked prunable", "GitRemote": "parse, format and redact git remote urls, scp addresses and paths, repository path", "GitRemotePath": "a remote given as a filesystem path", "GitRemoteScp": "a remote in scp-like user at host colon path form", "GitRemoteTransport": "a remote routed through a transport helper, double-colon address", "GitRemoteUrl": "a remote in url form with scheme, credentials, host, port and path", "TreeIdentity": "compare working trees, same worktree, same repository or unrelated, physical toplevel", "GitFile": "parse a worktree or submodule .git pointer file, gitdir line, no spawn", "GitFileParseError": "text is not a gitfile, missing gitdir prefix or empty path", "UpstreamBranch": "the current branch's upstream remote and branch, gone when deleted" }, "github-actions": { "Action": "run an action's main/pre/post entry point, compose the runtime, set exit code on failure", "ActionCache": "save and restore the runner's actions/cache, warm a toolchain or dependency cache between jobs", "ActionCacheError": "handle a cache save or restore failure, actions cache misconfigured or unreachable", "ActionEnvironment": "read `GITHUB_*` and `RUNNER_*` variables, process.env access for an action, step debug mode", "ActionEnvironmentError": "handle a missing or malformed runner environment variable", "ActionInput": "read with: inputs, INPUT_ variables, config provider for action inputs, dry-run boolean input, record which inputs a program reads", "ActionLogger": "workflow-command logger, collapsible log groups, phase heading that opens no group, buffered step transcript, notice annotation", "ActionManifest": "decode or read action.yml, runner-shaped INPUT_ test environment from manifest defaults, diff code reads/writes against declared inputs/outputs", "ActionManifestBranding": "action.yml marketplace branding, icon and color", "ActionManifestCompositeRuns": "action.yml runs block for a composite action, using composite with steps", "ActionManifestDecodeError": "handle an action.yml that is not yaml or not a valid action manifest", "ActionManifestDiff": "where action code and action.yml disagree, unread or undeclared inputs and outputs, inSync", "ActionManifestDockerRuns": "action.yml runs block for a docker container action, image args env entrypoints", "ActionManifestInput": "one declared action.yml input, default description required deprecationMessage", "ActionManifestNodeRuns": "action.yml runs block for a javascript action, node24 main pre post pre-if post-if", "ActionManifestOutput": "one declared action.yml output, description and composite value expression", "ActionManifestReadError": "handle an action.yml that cannot be read from the filesystem", "ActionOutputs": "set step output, export env var, add to PATH, mask a secret", "ActionRuntime": "the composed default action runtime layer, wire ActionEnvironment/Logger/Outputs/State", "ActionState": "persist and read state across pre/main/post phase boundary, GITHUB_STATE file", "ActionStateError": "handle action state save or read failure across the phase boundary", "ActionsIdentityToken": { "intent": "serve @effected/oidc's IdentityToken contract from the runner's OIDC issuer, sign with runner identity", "implements": "oidc.IdentityToken" }, "ActionsProvenance": "build SLSA provenance from the runner's OIDC claims, attest a GitHub Actions workflow run", "ActionsRegistryCredential": "mint runner oidc token for registry audience, mask it, build npm workload publish credential", "AmbientPackageManager": "a package manager already on PATH from the runner's toolchain, no tool-cache entry", "Artifact": "upload, list, download and delete GitHub Actions artifacts", "ArtifactError": "handle an artifact upload, list, download or delete failure", "BlobEnvelope": "frame bytes with a versioned metadata header, pure encode/decode a stored blob", "BlobMetadataDecodeError": "handle blob metadata that does not satisfy the caller's schema", "BlobMetadataEncodeError": "handle a value that will not encode into blob metadata", "BlobStore": "get/put/has durable blob storage with a metadata channel, sigv4-signed s3-compatible or in-memory backend", "BlobStoreError": "handle a blob store read or write failure, unreachable or refused backend, request signing failure, invalid key", "BlobTransferError": "handle a signed blob url upload or download failure", "CacheKey": "build a GitHub Actions cache key, restore-key fallback ladder, hash files", "CacheKeyBadPatternError": "handle a glob pattern that will not compile while deriving a cache key", "CacheKeyReadError": "handle a file read failure while hashing files for a cache key", "CachedPackageManager": "a package manager installed into the runner's tool cache, binDir to addPath", "CheckDocument": "reconcile check-run state onto a sticky PR comment or PR description, debounced managed regions", "CheckDocumentError": "handle a check document render, read-back or sink write failure", "CheckDocumentStamp": "run identity for staleness ordering between two runs writing the same document", "CheckReport": "one check's current state and presentation for a check document render", "CheckState": "running/pass/fail/warn/skipped/timeout vocabulary for a release pipeline's checks", "ChildEnv": "prepend directories to PATH for a spawned child, cross-platform PATH casing, extendEnv trap", "DetachedLogUnavailableError": "handle a detached child's log file that could not be opened", "DetachedNotReadyError": "handle a detached child readiness probe that never succeeded", "DetachedOutputError": "handle output from a detached worker that cannot reach the runner file", "DetachedProcess": "spawn a long-lived child outliving the action, poll readiness, signal by pid", "DetachedSignalFailedError": "handle a signal refused when reaping a detached child", "DetachedSpawnFailedError": "handle a detached child that did not start", "DryRun": "rehearsal guard for action mutations: dry-run input, skip and report", "GitHubCacheBlobStore": "BlobStore backend over the runner's own Actions cache, no S3 bucket needed", "GitHubContext": "GITHUB_* workflow context: repository, ref, sha, actor, pull request head ref, branch", "GitHubMarkdown": "fluent markdown writer for pr comments and check-run bodies, render a table", "GitHubToken": "mint, persist, read and revoke a GitHub App installation token across action phases", "GitHubTokenError": "handle a persisted installation token that expired before a later phase read it", "InstalledPackageManager": "decoded union of an ambient or tool-cache package manager install result", "InvalidOutputNameError": "handle an output or variable name that would corrupt the runner file's block structure", "InvalidPidError": "handle a non-positive pid refused before signaling a process group by mistake", "ManagedDocument": "marker-delimited document with named regions a tool owns inside human-edited text", "ManagedDocumentError": "handle a corrupt or ambiguous managed document region structure", "NotABlobEnvelopeError": "handle bytes that are not a recognizable blob envelope, legacy unframed blob", "OidcTokenError": "handle an OIDC token that could not be minted or decoded, missing id-token permission", "OidcTokenIssuer": "mint runner oidc token for audience, masked at issuance, read claims unverified as ActionsOidcClaims, recording test double", "OutputEncodeError": "handle a value that did not satisfy its schema while publishing a JSON output", "PackageManagerInstaller": "provision an exact npm/pnpm/bun version from a corepack pin onto the runner", "PackageManagerInstallerError": "handle a package manager provisioning failure: integrity mismatch, unsupported platform", "ProcessId": "validating schema for a pid crossing the action phase boundary through state", "RecordedOutput": "assert what an action published under a recording double: member, name, encoded value", "RunnerContext": "RUNNER_* context: os, arch, temp directory, tool cache root", "RunnerFileUnavailableError": "handle a runner file (GITHUB_OUTPUT/STATE/ENV/PATH) that is not available", "RunnerFileWriteError": "handle a runner file that exists but could not be appended to", "Secret": "mask a Redacted value in runner logs, declassify only for a plain-string api", "ToolInstaller": "download, extract and cache a toolchain binary in the runner's tool cache", "ToolInstallerError": "handle a tool download, extract or tool-cache write failure, retryable download status", "TruncatedBlobEnvelopeError": "handle a blob envelope frame that ends mid-header or mid-metadata", "UnsupportedBlobEnvelopeVersionError": "handle a blob envelope written by a newer format revision", "describeCause": "one-line [Tag]: message summary of why an action failed", "projectCheckState": "map the kit's check state onto GitHub's check-run status/conclusion wire vocabulary" }, "github-commands": { "CommandNeutralizer": "make log text safe on a GitHub Actions runner: defang ::command:: lines and ##[ anywhere, split at CR/LF/CRLF, idempotent", "WorkflowCommand": "render ::error::/::warning::/::notice::/::group:: workflow commands, escape a log annotation, mask a value, shared open-group depth key" }, "github-references": { "CLOSING_KEYWORDS": "the nine github closing keywords, close/fix/resolve conjugations", "REFERENCE_KEYWORDS": "the non-closing reference keywords ref, refs, references", "collectReferenceLists": "extract every closing or reference list from commit or PR body text", "harvestIssueReferences": "find closes/fixes/resolves #12 style references in commit message or pr body prose", "harvestReferenceLists": "find several issue lists inline in running text, e.g. closes #123, fixes #456", "keywordFamily": "collapse close/closes/closed and similar conjugations to one stem", "parseBareLineReference": "parse a whole trailer line as one issue reference, e.g. Closes: #12", "parseBareLines": "parse every bare trailer line in a text into issue references", "parseClosingList": "parse a whole line naming several issues under a closing keyword", "parseClosingLists": "parse every closing-list line in a text", "parseReferenceList": "parse a whole line naming several issues under a closing or ref keyword", "parseReferenceLists": "parse every reference-list line in a text" }, "github": { "ActionsOidc": "verify a github actions oidc token from a workflow, authorize a ci caller by repository id", "ActionsOidcClaims": "typed claims of a verified actions oidc token, repository id, run id, job workflow ref", "ActionsOidcClaimsFromWire": "decode or encode actions oidc claims as the token carries them, `snake_case` keys and string ids", "Annotation": "one file annotation on a check run, notice or warning at a line range", "AnnotationLevel": "notice warning failure severity for a check run annotation", "AppIdentity": "resolve the github app's slug name and bot user id", "AppInfo": "the github app's own id slug name and node id from GET /app", "ArtifactMetadata": "record where a published package artifact lives, org-level storage record, supply chain provenance", "Attestation": "upload a sigstore bundle, list attestations for a subject digest, slsa lookup", "AttestationListEntry": "one attestation bundle url and predicate type from a listing", "AttestationRecord": "a stored attestation's id and url after upload", "AuthenticatedApp": "app jwt surface: read the app, webhook deliveries, redeliver, uninstall an installation", "BotIdentity": "committer name and email for a bot commit, dco signoff trailer, github-actions bot identity", "BotUser": "a github app bot user's id and login, matched against event actor ids", "ChangelogInfo": "changelog line credit for a commit or pull request, batched graphql, replaces get-github-info", "CheckConclusion": "success failure neutral cancelled timed_out action_required skipped, how a check run finished", "CheckRun": "report a job's verdict on a commit, create update complete a run, find a run by external id", "CheckRunOutput": "check run title summary and annotations, truncate to github's 65535 byte limit", "CheckRunRef": "a check run as github reports it: status, conclusion, head sha, urls, timestamps, output", "CheckRunStatus": "queued `in_progress` completed waiting requested pending, a check run's reported lifecycle phase", "CodeScanning": "configure codeql default setup, detect repository languages for codeql, enable codeql scanning", "CommentMarker": "hidden html marker that makes a sticky comment findable again, namespaced comment key", "CommentOnceResult": "whether commentOnce posted a new comment or found the marker already there", "CommentRecord": "id body and url of a comment this package wrote or found", "CommitChangelogInfo": "commit author login, pull request number and markdown links for a changelog line", "CommitComparison": "diff between two refs, ahead/behind counts, commits and changed files", "CommitFile": "one file's path status additions deletions from a commit or comparison", "CommitRef": "a commit's sha, tree sha, and parent shas for building a tree", "CommitSummary": "a commit projected to sha message author and parents", "CreatedCommit": "a just-created commit's sha and its html_url, including on github enterprise server", "DeliveryAttempt": "one webhook delivery attempt: id guid status code event action installation", "DeploymentEnvironment": "create update list and delete a deployment environment, environment protection rules", "DispatchedRun": "the run id and urls github returns when a workflow dispatch is asked for run details", "ExpiringUserTokens": "user access and refresh token pair, check expiry, persist a user grant", "ExtraPermission": "a permission a token was granted beyond what was required", "FileChange": "a file content write or deletion to include in a commit's tree", "FileContent": "a file to write in a commit, path content and blob mode", "FileDeletion": "a file to remove in a commit by path", "FileMode": "git blob file mode literals for the git database api, 100644 100755 120000", "FileStatus": "added removed modified renamed copied changed unchanged, how a file changed", "GRAPHQL_ONLY_SETTINGS": "repository settings reachable only through the graphql updateRepository mutation", "GitBranch": "create reset delete a branch ref, link a branch to an issue", "GitCommit": "build a git tree and commit files onto a branch", "GitHubApp": "mint scope revoke installation tokens, client as the app via jwt, cache tokens across requests", "GitHubAppError": "a github app authentication call failed, jwt token revoke identity or installation lookup failure", "GitHubClient": "the typed github rest and graphql transport: one request, one paginated read", "GitHubCommit": "read a commit, list commits on a ref, compare two refs", "GitHubContent": "read a text file's contents out of a repository at a ref", "GitHubError": "rest api failure taxonomy, classify notFound alreadyExists rateLimited, classify a raw http response", "GitHubErrorKind": "notFound alreadyExists rejected unauthorized rateLimited transport decode, structural routing for a github rest failure", "GitHubFixtures": "recorded github responses for a fixture client, record a raw failure status headers body", "GitHubGraphQLError": "classify a failed github graphql call, errors array in a 200 response", "GitHubIssue": "get list close and comment on an issue, post a marked comment", "GitHubRelease": "create update and list releases, upload a release asset, get a release by tag", "GitHubRepository": "read patch repository settings, apply settings blob across rest graphql", "GitHubUserAuth": "oauth web flow, exchange a code for user tokens, refresh, revoke a grant, pkce", "GitHubUserAuthFinal": "oauth refused, reconnect or reconfigure remedy, bad refresh token, sign in again", "GitHubUserAuthOperation": "which oauth step failed: exchange, refresh or revoke", "GitHubUserAuthOptions": "configure the oauth client id and secret, enterprise server token url, timeout", "GitHubUserAuthTemporary": "oauth network, timeout, 5xx or malformed reply, retry later, keep tokens", "GitHubUserTokens": "decode or persist a user's oauth tokens, expiring or non-expiring union", "GitHubValidationCode": "missing missing_field invalid already_exists unprocessable custom, github 422 validation error codes", "GitHubValidationEntry": "one entry from a failed rest response's errors array, resource field code and message", "GitTag": "create reset resolve and delete a tag ref, find newest semver-shaped tag", "GraphQLDocument": "a named graphql query or mutation, its variables and response codec, typed graphql call", "GraphQLErrorEntry": "one entry from a graphql response's errors array, message and github's error type", "Installation": "one installation of a github app, installation id and account", "InstallationToken": "a minted app installation token, expiry and permissions, re-mint before it expires", "InstallationTokenStore": "cache installation tokens across requests or worker isolates, kv-backed token store seam", "InvalidChangelogRefError": "changelog lookup refused a non-hex sha or non-positive pull request number", "InvalidRepoRefError": "a repository slug was not owner/repo, malformed repo ref parse failure", "IssueInfo": "an issue's number title state labels and node id, projected for callers", "LinkedIssue": "an issue a pull request closes, whether linked manually or github-inferred", "MergeMethod": "merge squash rebase, how a pull request is merged", "NonExpiringUserTokens": "user access token with no expiry and no refresh token", "PageOptions": "how many items per page and how many pages to walk", "PermissionGap": "a permission a token is missing or holds too weak a level of", "PermissionLevel": "read write admin, how much access a permission grants", "PermissionResult": "what comparing a token's permissions against a requirement found, missing and extra permissions", "PullRequest": "get list create update and merge a pull request, request reviewers", "PullRequestChangelogInfo": "pull request author, merge commit and markdown links for a changeset pr override", "PullRequestComment": "post or update a sticky marked comment on a pull request", "PullRequestInfo": "a pull request's number head base sha state and merge status, projected for callers", "RateLimitSnapshot": "what github's rate-limit headers said on the last response, remaining requests and reset time", "RawFailure": "a raw github error response recorded in a fixture, classified at call time", "ReleaseAsset": "a file attached to a release, its download url and size", "ReleaseInfo": "a release's tag name body draft/prerelease flags and upload url", "Repo": "which repository the surrounding program acts on, provide a repo coordinate", "RepoRef": "parse an owner/repo slug into owner and repo, the pure repository coordinate value", "ReportedCheckConclusion": "how a check run finished as github reports it, including stale", "ReportedCheckRunOutput": "a check run's reported output title summary and annotation count", "RepositorySecret": "encrypt and write a repository or environment secret via sealed box", "RepositorySecurity": "toggle dependabot vulnerability alerts, automated security fixes, private vulnerability reporting inbox", "RepositoryVariable": "create update list and delete a repository or environment variable, github actions variables", "RetryPolicy": "how the client retries a failed request: backoff, jitter, retry-after delay", "Ruleset": "create update list delete a repository ruleset, bypass actor lookup", "SECURITY_ANALYSIS_STATUS_FIELDS": "which security_and_analysis fields github accepts as an enabled/disabled status object", "SemverTag": "a tag whose name carries a parsed semantic version, tag sha and version together", "StorageRecordInput": "what to record about a published artifact's location, name digest registry and repository", "TagRef": "a tag name and the sha it dereferences to, annotated tag", "TokenPermissionError": "a token lacks access it needs, or holds access it never requested", "TokenPermissions": "compare a token's granted permissions against a requirement, assert sufficient scopes", "WorkflowDispatch": "trigger a workflow dispatch event and get back the run it created, poll a dispatched run until it finishes, cancel a run", "WorkflowRunStatus": "a workflow run's id status and conclusion, whether a dispatched run has finished", "repositoryPatch": "build a repository settings patch from a draft, drop unset fields", "transformSecurityAndAnalysis": "translate a security_and_analysis block into the shape the repository patch endpoint expects", "versionFromTag": "extract a version string out of a tag name, the default tag-to-semver convention" }, "files": { "AtomicDirectory": "replace a directory atomically, stage in a sibling then rename into place, write a file set without a half-written tree", "AtomicDirectoryError": "handle an atomic directory write failure, validate clear stage write or promote step failed", "AtomicFile": "write a file atomically, temp then rename, keep or replace a symlink, keep permissions", "AtomicFileOptions": "replace a symlink atomically, follow or replace a symlinked target, untrusted checkout" }, "glob": { "GlobPattern": "compile a glob pattern, test if a path matches, minimatch dialect", "GlobPatternError": "handle malformed glob pattern, pattern too long, brace expansion budget exceeded, nesting depth exceeded", "GlobPatternOptions": "configure glob matching: dialect, dot files, case sensitivity, brace expansion, extglob", "GlobSet": "match a path against multiple include and exclude glob patterns, negated exclusion", "Wildcard": "match `*` and `?` allow-list patterns, no path separators, not a glob", "WildcardOptions": "case-insensitive wildcard matching, nocase option" }, "images": { "ImageFacts": "image width height and format from bytes, mime type of an image, image dimensions without image-size, sync image header read, file extension for an image (jpg for jpeg)", "ImageExtension": "file extension union for an image format, png jpg gif webp avif", "ImageMimeType": "image media type union, image/png image/jpeg image/gif image/webp image/avif", "ImageFormat": "supported image formats png jpeg gif webp avif", "ImageParseError": "typed failure for unreadable image bytes, truncated or malformed header", "ImageCacheKey": "cache key for a generated image from schema-encoded parameters via fromParams, content-addressed sha-256 of params and salt via core Crypto", "ImageCacheKeyError": "cache key derivation failed, params rejected by schema or not json", "ImageBackend": "storage port for cached images, directory backend, adapt store cache as image backend, layerNone no-op backend to switch the image cache off", "ImageBackendError": "image cache storage read or write failed, unsupported content type", "ImageCache": "get or generate an image once, skip re-rendering an open graph image, cache satori output, accept list narrows the result format", "ImageGenerateError": "generator returned empty, unreadable or wrong-format image bytes" }, "jsonc": { "Jsonc": "parse and stringify jsonc, edit-adjacent utilities, build jsonc schemas", "JsoncCanonicalizeError": "handle canonicalization failure, malformed value at a json-pointer path", "JsoncCanonicalizeOptions": "lenient fingerprint, accept bigint, omit undefined, honour date tojson, nan as null", "JsoncCanonicalizeErrorCode": "canonicalize-stage error code, rfc 8785 serialization failure mode", "JsoncEdit": "non-mutating text edit, replace offset/length span with content", "JsoncFingerprint": "canonical json serialization rfc 8785, sha-256 content hash, deduplicate or diff json documents", "JsoncFormatter": "format jsonc text, reindent and normalize whitespace while preserving comments", "JsoncFormattingOptions": "options controlling jsonc formatting, indent width, tab vs spaces", "JsoncFormattingOptionsLike": "formatting options accepted at call sites, instance or plain literal, no class construction required", "JsoncModificationError": "handle failed structural jsonc edit, path segment expects wrong container kind", "JsoncModifier": "edit jsonc text, insert or replace value by path keeping comments, sync result form", "JsoncModifyOptions": "formatting controls for text generated by a structural jsonc modification", "JsoncNode": "immutable jsonc ast node produced by parsing into a tree", "JsoncNodeType": "union of jsonc ast node type string literals, object array string number etc", "JsoncParseError": "handle malformed jsonc input, edit tsconfig without losing comments, aggregated recovered parse errors", "JsoncParseErrorCode": "jsonc parse-error code, syntax failure during parsing", "JsoncParseErrorDetail": "one recovered jsonc parse error with code and exact position", "JsoncParseOptions": "options controlling jsonc parse behavior", "JsoncPath": "ordered sequence of path segments locating a value within a jsonc document tree", "JsoncRange": "character offset and length span within a jsonc document, restrict formatting to a region", "JsoncSegment": "single jsonc path segment, string property key or numeric array index", "JsoncStringifyError": "handle jsonc stringify failure, circular reference guard", "JsoncStringifyErrorCode": "jsonc stringify-error code, serialization failure mode", "JsoncStringifyOptions": "options controlling jsonc output formatting on stringify", "JsoncTextHashOptions": "options controlling hashText, hash raw jsonc text into a content fingerprint", "JsoncVisitor": "walk a jsonc ast with sax-style visitor events", "JsoncVisitorEvent": "discriminated union of jsonc visitor events, object array property and literal value with offset/length" }, "jsonl": { "Envelope": "decode and encode a jsonl envelope line, read a journal's current state with no runtime via lastValid", "InvalidData": "handle a line whose envelope frame or registered payload fails schema validation", "Journal": "define a journal service with a static layer, append events, query history, live tail changes", "JournalClosed": "handle an append attempted after the journal's scope has closed", "JournalNotFound": "handle an operation against a journal file that does not exist yet", "JournalResync": "handle a journal file truncated or replaced beneath a reader", "JournalWatcher": "watch a journal file or its directory with a watch that succeeds only once registered, so no append lands unseen while arming", "JsonlEvent": "define a journal event tag and payload schema, register into typed registry", "Line": "split jsonl text into utf-8 byte-offset lines, parse one line's json", "LinePosition": "an envelope's byte offset and end in the journal, the resume cursor", "LineSlice": "one candidate jsonl line located in the source by utf-8 byte offset", "MalformedLine": "a malformed journal line: not valid json, torn tail vs corrupt hole", "NodeJournalWatcher": "provide the journal watcher on node over fs.watch, from the @effected/jsonl/node subpath", "Slice": "filter journal reads by event, scope and time, resume from a cursor, skip or fail on bad lines", "TerminalViolation": "handle an append attempted after a terminal event without a reopen-marked event", "UnknownEvent": "handle a line whose event tag is not in the journal's registry", "UnserializableData": "handle a payload with a bigint or reference cycle that json.stringify cannot serialize" }, "jwt": { "JoseHeader": "decoded jws protected header, alg kid typ", "Jwk": "json web key schema, rsa or p-256 key from a jwks, private members redacted", "Jwks": "json web key set schema, decode an issuer's published keys", "JwksResolver": "fetch and cache an issuer's jwks by oidc discovery, verification key by kid, key rotation", "JwksStore": "cache seam for fetched jwks, kv or in-memory, share keys across worker isolates", "Jws": "sign or verify a compact jws, decode a token's header unverified", "Jwt": "sign a jwt, verify a jwt's signature and exp nbf iss aud claims", "JwtError": "typed jwt failure routed by reason, expired, bad signature, wrong audience", "JwtErrorReason": "every reason a jwt operation fails, for routing on reason", "JwtKey": "import a pem private key pkcs1 or pkcs8, import a jwk, generate a test key pair", "RegisteredClaims": "standard jwt claims iss sub aud exp nbf iat jti", "SigningKey": "an imported private key with its algorithm, for signing", "TestIssuer": "network-free test oidc issuer, sign test tokens verified through the real resolver", "VerificationKey": "an imported public key with its algorithm, for verifying" }, "lockfiles": { "CatalogChange": "catalog entry added, removed or changed between lockfiles, version before and after, consumers", "ConfigDependencyLock": "config dependency integrity from lockfile, verify config dependency fetch", "ImporterChange": "importer dependency added, removed or changed between two lockfiles, specifier and version", "ImporterDependency": "one workspace importer's declared dependency as the lockfile records it", "Lockfile": "parse a pnpm npm or bun lockfile into one unified lockfile model", "LockfileDiff": "compare two lockfiles, what moved after an install or update, catalog and importer changes", "LockfileFormat": "the lockfile format literal: bun, npm or pnpm", "LockfileFramingError": "handle a lockfile whose yaml stream carries no lockfile document, e.g. a config-dependencies-only pnpm-lock.yaml", "LockfileImporter": "one workspace importer's declared dependencies, keyed by importer path", "LockfileIntegrity": "verify lockfile integrity against workspace manifests, unsatisfied constraint and missing workspace check", "LockfileParseError": "handle malformed or wrong-shape lockfile content, syntax vs validation failure", "PackageManagerLock": "read pinned pnpm version, specifier and sri integrity, per-platform native binary integrity", "PnpmEnvLockfile": "read pnpm version and config dependency integrity from a pnpm-lock.yaml env preamble", "ResolvedPackage": "one package resolved from a lockfile, its dependency and peer edges", "WorkspaceDependency": "a directed dependency edge between two workspace packages as the lockfile records it", "WorkspaceManifest": "the minimal package.json shape lockfile integrity checking compares against", "filenameFor": "the conventional lockfile filename for a format, e.g. pnpm-lock.yaml", "filenamesFor": "every filename a lockfile format is genuinely written under, including alternates", "fromFilename": "detect which lockfile format a conventional filename identifies", "isUnsupportedLockfileVersion": "check if a lockfile parse error means the version is too old" }, "lsp": { "LspFrame": "encode an lsp message with a byte-counted content-length header, decode lsp frames from chunked bytes or a stream", "LspFrameError": "malformed or truncated lsp frame, missing or bad content-length, stray stdout log line", "LspFrameErrorCode": "lsp frame error codes, missing content-length, header too large, truncated", "LspProbe": "smoke-test a built language server bin, initialize then shutdown and exit 0", "LspProcess": "drive a spawned language server bin from a test, send content-length frames, read until a response, wait for a stderr report, assert stdout carried only lsp frames", "LspStdio": "launch an effect language server over stdio, keep runMain's failure report off stdout, exit 1 on exit without shutdown, end the process on exit when stdin stays open", "LspTestFailure": "lsp probe or process failure, stream ended, invalid frame, not json-rpc, timeout", "LspUri": "convert a file uri to a path and back, textDocument uri to fsPath, windows drive and unc paths, without node:url" }, "markdown": { "Blockquote": "build a blockquote node, construct quoted content, mdast blockquote", "Break": "build a hard line break node, construct a break for stringify", "BreakStyle": "line break concrete-syntax variants, backslash vs spaces break marker", "BulletChar": "unordered list bullet marker literals, dash asterisk plus", "Code": "build a fenced or indented code block node, construct a code block for stringify", "CodeBlockStyle": "fenced vs indented code block variants", "Definition": "build a link reference definition node, construct a definition for stringify, resolve [ref]: /url", "Delete": "build a gfm strikethrough node, construct deleted/struck-through text", "DocumentSection": "heading-delimited span of a document, section boundaries and body blocks", "Emphasis": "build an emphasis node, construct italic text for stringify", "EmphasisChar": "emphasis marker character literals, asterisk vs underscore", "FenceChar": "code fence or frontmatter fence character literals, backtick vs tilde", "FlowContent": "block-level node type union, top-level document content types", "FootnoteDefinition": "build a gfm footnote definition node, construct footnote content for stringify", "FootnoteReference": "build a gfm footnote marker node, construct a footnote reference for stringify", "Frontmatter": "raw frontmatter capture node, fidelity-preserving metadata block, yaml toml json fence capture", "FrontmatterContent": "frontmatter node type union", "FrontmatterDecodeError": "handle malformed frontmatter body, typed frontmatter parse failure", "FrontmatterEncodeError": "handle frontmatter serialization failure, typed frontmatter write failure", "FrontmatterFenceState": "tell no frontmatter from an unclosed fence, lint a missing closing fence", "FrontmatterFormat": "frontmatter fence format literals, yaml toml json frontmatter kind", "FrontmatterFormatMismatchError": "handle wrong-format frontmatter codec applied, yaml codec given a toml capture", "FrontmatterMissingError": "handle document with no frontmatter capture, typed missing-frontmatter failure", "FrontmatterMissingReason": "why frontmatter decode found no capture: absent, capture disabled or unclosed fence", "FrontmatterNewline": "frontmatter fence line terminator literals, lf vs crlf", "FrontmatterSource": "split and join frontmatter at string level without parsing, gray-matter style extraction", "FrontmatterSourceBlock": "string-level frontmatter block with format, raw bytes and newline", "FrontmatterSourceSplit": "result of splitting source into frontmatter block and body remainder", "FrontmatterValidationError": "handle decoded frontmatter that fails a consumer schema, typed frontmatter validation failure", "Heading": "build an atx or setext heading node, construct a heading for stringify", "HeadingDepth": "legal heading depth levels 1 through 6", "HeadingStyle": "atx vs setext heading style variants", "Html": "build a raw html node, construct verbatim html block or inline fragment", "Image": "build an inline image node, construct an image for stringify", "ImageReference": "build a reference-style image node, image pointing at a definition by identifier", "InlineCode": "build an inline code span node, construct backtick code for stringify", "JsonFrontmatter": "json frontmatter codec, decode and encode json frontmatter over jsonc", "Link": "build an inline link node, construct a link or autolink for stringify", "LinkReference": "build a reference-style link node, link pointing at a definition by identifier", "List": "build an ordered or unordered list node, construct a list for stringify", "ListContent": "list-content node type union, list item member types", "ListDelimiter": "ordered list delimiter literals, period vs paren", "ListItem": "build a list item node, construct one item of a list for stringify", "Markdown": "parse markdown source into a tree, gfm or commonmark parse facade, stringify a tree or a single block", "MarkdownDiagnostic": "structured parse or stringify diagnostic, position-carrying warning or error", "MarkdownDialect": "markdown dialect literals, gfm vs commonmark", "MarkdownDocument": "parsed markdown document with source diagnostics and definitions, find headings links sections", "MarkdownEdit": "non-mutating text edit, replace a source span, insert or delete text", "MarkdownFormat": "format markdown source, modify a node in place, normalize concrete-syntax markers", "MarkdownFormattingOptions": "options controlling which markers a formatter normalizes", "MarkdownFrontmatter": "compose a frontmatter schema decoder, typed gray-matter parity, validate frontmatter against a schema", "MarkdownModificationError": "handle a failed modify call, node not in document, unsupported target or unrenderable fragment", "MarkdownModificationErrorCode": "modification failure reason codes", "MarkdownNode": "union of every node type this package produces, mdast node type union", "MarkdownParseError": "handle a rejected markdown parse, typed parse failure with diagnostic", "MarkdownParseErrorCode": "parse failure reason codes", "MarkdownParseOptions": "options controlling markdown parse, dialect and frontmatter capture toggle", "MarkdownRange": "offset and length span for restricting formatting to a region", "MarkdownStringifyError": "handle a refused tree during stringify, typed stringify failure with diagnostic", "MarkdownTransform": "map or rewrite a markdown tree with typed node handlers, replace links with link references, canonicalize a tree by clearing fidelity fields, shift or demote heading levels, find sections by child index after a transform", "MarkdownVisitor": "walk or traverse markdown tree synchronously or as stream, sax-style enter and exit events", "MarkdownVisitorEvent": "enter exit and error visitor event union, tree-walk event shape", "Mdast": "project to and from plain mdast, remark ecosystem interop, strip fidelity extras, plain text of a node like mdast-util-to-string", "MdastDecodeError": "handle foreign mdast input that fails to decode, typed mdast admission failure", "MdxFlowExpression": "build an mdx flow expression node, construct mdx block expression for stringify", "MdxJsxAttribute": "build an mdx jsx attribute node, construct a named jsx attribute", "MdxJsxAttributeContent": "mdx jsx attribute node type union", "MdxJsxAttributeValueExpression": "build an mdx jsx attribute expression value node, construct b={c} for stringify", "MdxJsxExpressionAttribute": "build an mdx jsx spread attribute node, construct {...b} for stringify", "MdxJsxFlowElement": "build an mdx jsx flow element node, construct a block-position jsx component or fragment", "MdxJsxTextElement": "build an mdx jsx text element node, construct an inline jsx component or fragment", "MdxTextExpression": "build an mdx text expression node, construct mdx inline expression for stringify", "MdxjsEsm": "build an mdx esm node, construct import or export statement block for stringify", "Paragraph": "build a paragraph node, construct a run of phrasing content for stringify", "PhrasingContent": "inline-level node type union, phrasing content member types", "Point": "a single source position, line column and offset coordinate", "Position": "a node's source span, start and end point pair", "ReferenceType": "link or image reference type literals, shortcut collapsed full", "Root": "build the whole-document root node, construct a tree root for stringify", "RowContent": "table row content node type union, table cell member types", "SchemaDeclaration": "classified $schema declaration union, by name path url or inline", "SchemaDeclarationByName": "$schema declaration referencing a registered schema by name, name@version grammar", "SchemaDeclarationByPath": "$schema declaration referencing a schema by relative or absolute path", "SchemaDeclarationByUrl": "$schema declaration referencing a schema by url", "SchemaDeclarationInline": "$schema declaration carrying an inline json-schema-like document", "SchemaDeclarationInvalidError": "handle a $schema value that does not classify, malformed schema declaration", "SchemaDeclarationMissingError": "handle frontmatter with no $schema declaration, required declaration absent", "SchemaNameUnknownError": "handle a $schema name the resolver does not recognize, unregistered schema name", "SchemaResolver": "classify a $schema declaration and resolve it to a schema, built-in name registry resolver", "SchemaVersionUnresolvableError": "handle a registered $schema name with no matching version, unsatisfied partial version", "Strong": "build a strong emphasis node, construct bold text for stringify", "Table": "build a gfm table node, construct two-dimensional tabular data for stringify", "TableAlign": "table column alignment literals, left right center or none", "TableCell": "build a table cell node, construct a header or data cell for stringify", "TableContent": "table content node type union, table row member types", "TableRow": "build a table row node, construct a header or data row for stringify", "Text": "build a text node, construct literal run of characters for stringify", "ThematicBreak": "build a thematic break node, construct a horizontal rule for stringify", "ThematicBreakChar": "thematic break character literals, dash asterisk underscore", "TomlFrontmatter": "toml frontmatter codec, decode and encode toml frontmatter over @effected/toml", "UnresolvedFootnoteReference": "footnote marker with no definition, lint undefined footnotes, label and position", "YamlFrontmatter": "yaml frontmatter codec, decode and encode yaml frontmatter over @effected/yaml", "stringify": "serialize a node tree to markdown without the parser, tree-shakable, effect form", "stringifyResult": "serialize a node tree to markdown synchronously, parser-free bundle, result form" }, "markdown-lint": { "LintDiagnostic": "read a lint finding, line column detail range and autofix edit", "LintFixInfo": "one-line autofix in markdownlint's shape, edit column delete count insert text", "LintRule": "write a markdownlint custom rule over an mdast tree, define a rule once", "MarkdownLint": "lint markdown programmatically without markdownlint, run rules over a string or parsed document", "MarkdownlintAdapter": "run a kit lint rule inside markdownlint-cli2 or vs code as a custom rule", "PositionMapping": "convert offsets to markdownlint line numbers, columns, ranges and one-line fixes" }, "mcp": { "MCP_VERSION": "the effected-mcp server's own version, replaced at build, reported by the identity tool", "main": "run the effected-mcp server over stdio, the effected-mcp bin entry, a carrier bin shim passes its distribution" }, "memfs": { "MemoryFileSystem": "in-memory FileSystem test double, seed files, inject faults, inspect writes, sync and promises ports, case-insensitive volume", "MemoryFileSystemErrnoError": "node-shaped thrown error, fail a port fault like node:fs", "MemoryFileSystemHandle": "one volume every view, assert after the run, sync setup mutators, fault the ports, emit watch events, count watchers", "MemoryFileSystemFileFaults": "fault an opened file handle, fail writes on one file, decorate the File open returns", "MemoryFileSystemOptions": "seed root, case-insensitive volume, inject faults at build", "MemoryFileSystemPortStats": "stat result for an injected port, file directory symlink checks", "MemoryFileSystemPromisesFaults": "fault an injected fs/promises port, reject one path", "MemoryFileSystemPromisesFileSystem": "test double for injected fs/promises walker, readdir withFileTypes", "MemoryFileSystemSyncFaults": "fault an injected sync filesystem port, throw errno for one path", "MemoryFileSystemVolumeStat": "literal lstat of a volume entry, kind size mtime", "MemoryFileSystemDirent": "readdir withFileTypes entry from the promises port", "MemoryFileSystemPortOptions": "configure faults on a sync or promises port, win32 drive-letter path spelling", "MemoryFileSystemSpies": "spy on filesystem calls, count reads or writes, observe without replacing, record call arguments", "NodeDirectorySeed": "seed volume from real fixture directory, copy fixture tree byte-exact", "NodeSyncFileSystem": "read real disk under Effect.runSync, synchronous read-only node filesystem" }, "mcp-kit": { "McpGuard": "crash guards before the server graph loads, exit only before connect, startup failure exits 1, parse a crash-injection env value", "McpHarness": "test mcp server in-process, call tools over queue-backed stdio", "McpProbe": "smoke-test a built mcp bin, initialize then clean exit", "McpProcess": "drive a spawned mcp bin, read json-rpc lines, wait for a stderr report with a timeout, never hang on exit", "McpStdio": "serve mcp over stdio, keep stdout the json-rpc wire, exit 0 on stdin close", "McpTestFailure": "mcp test client failure, stream ended, server stopped, timed out", "McpToolAudit": "lint served tools list, closed inputs, titles, hints, object-rooted outputs", "McpToolkit": "name every unknown tool argument in one InvalidParams, strict by default, meet declared tool dependencies from a layer built once for the server lifetime", "ToolFailure": "fold remediation into tool error message, truncate echoed caller values", "ToolInputSchema": "find unknown tool arguments at every depth, object-root a union input", "ToolOutputSchema": "object-root a union tool success schema so outputSchema is served", "ToolRefusal": "declared tool refusal with remediation in the message, survives error scrubbing", "StdioCapture": "divert stdout and stderr writes in one async context, keep the stdio wire clean, null writable", "ToolOutcome": "return expected tool errors as an ok false structured envelope agents can branch on", "ToolReplay": "idempotent write tool replay by key, return the stored first result" }, "npm": { "BasicCredentialError": "handle a username and password that cannot become basic auth, colon in username", "CachingPackageManager": "list of package managers with a known cache dir", "CatalogAssemblyError": "handle unreadable or malformed pnpm-workspace.yaml, bad catalog block, broken pnpmfile config dependency", "CatalogResolver": "resolve a catalog: specifier to a version range, catalog contract, noop default layer", "CatalogSpecifier": "represent a parsed catalog: dependency reference and its catalog name", "CorepackIntegrityHash": "restrict integrity hash to corepack algo.hex, convert npm sri to corepack pin", "DEFAULT_REGISTRY": "the public npmjs.org registry url", "Default": "provide both catalog and workspace resolver noop layers at once", "DependencyField": "package.json dependency map key name: dependencies, devDependencies, peerDependencies, optionalDependencies", "DependencyKind": "short dependency kind label: prod, dev, peer, optional", "DependencyResolutionError": "handle a catalog or workspace resolver mechanism failure, not an unmatched specifier", "DependencySection": "convert between dependency kind and manifest field name", "DependencySpecifier": "classify a dependency version string's protocol, detect catalog/workspace/range/git/url specifiers", "DistTagSpecifier": "represent a bare dist-tag dependency specifier like latest or next", "IntegrityHash": "validate and classify a subresource integrity string across sri and corepack forms", "InvalidDependencySpecifierError": "handle a string that is not a recognized dependency specifier", "InvalidIntegrityHashError": "handle a string that fails to parse as any known integrity hash form", "InvalidPackageManagerPinError": "handle a malformed corepack packageManager pin string", "InvalidSriIntegrityHashError": "handle failure converting an sri integrity string to corepack form", "Manifest": "resolve catalog: and workspace: specifiers in a tolerant package.json-shaped record to concrete version ranges", "ManifestDecodeError": "handle a manifest whose dependency fields fail to decode", "NpmConfig": "read .npmrc, scoped registries, per-host auth token, registry target, npmrc at the workspace root", "NpmConfigError": "handle npmrc load failure: unset env var in a token, unreadable npmrc file", "NpmExecutor": "choose which npm binary runs a publish command, ambient vs pinned", "NpmRegistry": "read npm registry metadata over http: version, manifest fields, dist-tags, publish times", "NpmWorkspacePatterns": "decide which directories an npm workspaces field declares, map-workspaces rules, ordered negations, package-lock link rows", "NpmWorkspacePatternsError": "handle a workspaces field past the matcher ceilings: too many patterns, wildcards, brace alternatives, too long, uncompilable", "PackageManagerCache": "look up a package manager's default cache directory for a platform", "PackageManagerPin": "parse and print a corepack packageManager pin string, name@version+integrity", "PackageManagerPinName": "the package managers a pin can name: npm, pnpm, bun", "PackagePublish": "pack tarball, publish to registry, write npmrc auth token, recording test double", "PackageTarball": "download, verify and extract a published tarball by integrity, private registry auth, read a published version's CHANGELOG.md", "PackageTarballExtractOptions": "authenticate a private registry tarball download by its url", "PackedTarball": "the tarball path, digests and size npm pack produced", "PublishError": "handle an npm publish step failure: auth, pack, publish, output parse, digest", "PublishTime": "when one package version was published, from the registry time map", "PublishedVersion": "one package version's registry metadata: name, version, integrity, tarball url", "RangeSpecifier": "represent a plain semver range or exact version dependency specifier", "RawSpecifier": "fallback classification for file:/link:/portal:/git/url/npm: specifiers this package does not further interpret", "RegistryCredentialLookup": "credential per request url, keep a token off cdn hosts", "RegistryKind": "classify a registry url as npm, github-packages, jsr, or custom", "RegistryReadError": "handle failed registry http read: transport error, bad status, undecodable body, refused workload credential", "SriIntegrityHash": "restrict integrity hash to sri algo-base64 form, reject corepack hashes", "TarballError": "handle a tarball that could not be fetched, verified or extracted, integrity mismatch", "UnresolvedDependencyError": "handle a catalog or workspace specifier that resolves to no entry", "VersionManifest": "one published version's dependencies, peer dependencies and engines, read peers from the registry", "WorkspaceResolver": "resolve a workspace: specifier to a concrete package version, workspace contract, noop default layer", "WorkspaceSpecifier": "represent a parsed workspace: dependency reference and its range modifier", "basicCredentialFromPairResult": "build basic-auth registry credential from username and password, base64 encode, result not throw", "classifyRegistry": "determine which well-known registry a url points at", "isValidDependencySpecifier": "check if a string is a recognized dependency version specifier", "isValidIntegrityHash": "check if a string is a valid integrity hash in any supported form", "registryDisplayName": "human-readable registry name for prose: npm, GitHub Packages, JSR, or host", "registryHost": "extract the host portion of a registry url or bare host string", "registryShortLabel": "compact registry label for a log or table: npm, github, jsr, or host", "workloadCredential": "build publish-only registry token from ci oidc identity token and registry prefix", "NpmrcEntry": "one parsed .npmrc line, key, expanded value, unset env variables, array flag", "parseNpmrc": "parse an .npmrc text into entries, expand env variables, never fails", "npmrcValue": "look up the last value of an .npmrc key, Option when absent", "npmrcValues": "read every value of an .npmrc array setting such as ca", "NpmTransportSettings": "read npmrc proxy, noproxy, strict-ssl, ca and client cert settings, npm and pnpm superset", "NpmRegistryTls": "per-registry ca, cert and key settings for one registry url, client certificate", "NpmHttpClient": "node http client honouring npmrc proxy, cafile, client certificates, strict-ssl", "NpmReleaseAge": "read npm min-release-age and its exclude list, hold back fresh versions", "NpmTransportError": "handle unreadable npmrc cafile, certfile or keyfile, unparseable proxy url", "LockfileDocumentError": "handle an unreadable lockfile document: syntax, framing, shape or too-old lockfileVersion", "PackageLockDocument": "read a package-lock.json as written, decode npm's native lockfile document, lockfileVersion 3 gate" }, "oidc": { "IdTokenClaims": "standard openid connect id token claims, azp nonce `auth_time` acr amr over the jwt registered claims", "IdentityToken": "oidc identity token contract, get a workload token to sign with sigstore or present a workload identity", "IdentityTokenError": "handle failure obtaining an oidc identity token for an audience", "Oidc": "verify an openid connect id token against its issuer's discovered jwks, decode a trusted token's claims unverified" }, "plugin": { "CatalogEntry": "build a schemastore catalog.json entry, assemble unversioned or versioned schema urls", "CatalogLintFinding": "catalog fileMatch hygiene warning, generic pattern or complex glob rejection", "DriftPolicy": "classify a published target's change as write or drift against its configured tolerance", "HostedSchema": "build a config's hosted schema identity stamped with the tool's version, $id and $schema url from one value", "InvalidSchemaVersionError": "handle a version label outside 1-3 numeric parts, optional prerelease, no build metadata", "KeywordFamilies": "recognize non-standard vscode taplo tombi intellij x-ai json schema keyword families, machine annotation hint", "PLUGIN_VERSION": "the effected carrier package version, replaced at build, passed as distribution version by both bin shims", "SCHEMASTORE_CATALOG_BASE": "the www host constant a schemastore catalog.json entry url points at", "SCHEMASTORE_ID_BASE": "the json host constant a schemastore-hosted document declares in $id", "SchemaTarget": "declare one schema publication target with its $id, path and optional version", "SchemaVersion": "branded schema version label, one to three components with optional prerelease for catalog file naming", "SchemaVersioning": "compute versioned or unversioned catalog urls, order schema version labels, derive schema file names", "SchemastoreVersion": "read the tool's schemastore version, diagnose a config value from a mismatched copy", "defineSchemastore": "default export of schemastore.config.ts, validate and assemble the config with the tool's own schemastore" }, "pnpm": { "Epic": "pnpm versioning epic, lead package and member selectors banding member majors to the lead's major", "OverrideKey": "parse pnpm overrides key, parent>child selector, name@range, dependency type suffix", "OverrideKeyError": "unparseable pnpm overrides selector, empty segment, invalid package name", "PartialReleaseAgeGate": "one config source's contribution to a pnpm minimumReleaseAge gate before merging", "PeerDependencyRules": "pnpm peerDependencyRules block, ignoreMissing allowAny allowedVersions, match peer name against suppression lists", "PnpmEnvDocument": "read the env preamble document of a pnpm-lock.yaml, configDependencies and packageManagerDependencies as written", "PnpmExtension": "pnpm lockfile extension data, catalogs, overrides and settings from the lockfile header", "PnpmLockDocument": "read a pnpm-lock.yaml as written, decode pnpm's native lockfile document, importers, snapshots", "PnpmMatcher": "match peerDependencyRules ignoreMissing or allowAny lists, compile pnpm name patterns with negation", "PnpmNpmConfig": "registry and proxy pnpm view uses, pnpm-workspace.yaml registry, httpsProxy, behind a proxy", "PnpmSettings": "read pnpm effective settings, pnpm config get precedence, minimumReleaseAge, which source set a value", "PnpmSettingsCatalog": "every pnpm 12 setting, per-setting schema, where it may be set, typed read", "PnpmSettingsError": "unreadable, non-yaml or non-mapping pnpm settings file", "PnpmSettingsLoadOptions": "where to read pnpm settings from: cwd, environment, platform, home, global config dir", "PnpmWorkspaceFile": "edit pnpm-workspace.yaml keeping comments and style, write catalogs or settings as targeted edits, canonical key order", "PnpmWorkspaceFileError": "malformed pnpm-workspace.yaml, invalid YAML in workspace file", "ReleaseAgeGate": "enforce pnpm minimumReleaseAge, filter candidate versions younger than the cutoff, match exclude patterns", "VersioningConfig": "decode pnpm-workspace.yaml versioning block, release lanes, fixed groups, ignore, maxBump, changelog storage, epics" }, "pnpm-plugin-effected": { "catalogs": "read the effected catalog, effect family and kit versions as a map" }, "package-json": { "BinField": "bin field shape, string path or name-to-path map", "Bugs": "bugs field model, issue tracker url or email, shorthand fidelity", "Dependency": "resolved dependency entry, name plus specifier plus kind, prod dev peer optional", "DependencyMapField": "dependencies field codec, json object to HashMap", "DevEngine": "single devEngines constraint, engine name version onFail", "DevEngineOrArray": "devEngines constraint slot, single engine or array of engines", "DevEnginesSchema": "devEngines field schema, runtime and package manager os cpu libc constraints", "ExportEntry": "one exported subpath and its target file, pattern template or concrete", "ExportsField": "exports field shape, string entry point or conditional exports object", "Funding": "read a package's funding field, where to sponsor a maintainer, single entry or array", "InvalidPackageManagerRangeError": "handle a malformed packageManager or devEngines.packageManager range, bad name, range or integrity", "InvalidPackageNameError": "handle invalid npm package name, failed naming rules", "InvalidSpdxLicenseError": "handle invalid spdx license field, unrecognized identifier or expression", "LenientManifest": "sniff or discover a package.json leniently, degrade malformed fields instead of failing", "Package": "read a package.json, strict publishable manifest, resolve workspace and catalog specifiers", "PackageDecodeError": "handle package.json schema decode failure", "PackageExports": "resolve package exports subpath, imports specifier, types declaration file, enumerate entry points, node resolution algorithm", "PackageExportsError": "handle subpath not exported, invalid package target, path traversal refused, node error code", "PackageFileTarget": "resolved exports or imports file path inside the package", "PackageJsonFile": "read and write package.json over the filesystem, surgical field edit preserving byte layout", "PackageJsonFormat": "sort and format package.json text, source-preserving formatter, parse to plain object, surgical modify", "PackageJsonModifyError": "handle package.json surgical edit failure, path navigation mismatch or unserializable value", "PackageJsonNotFoundError": "handle missing package.json file", "PackageJsonParseError": "handle package.json invalid json contents", "PackageJsonReadError": "handle package.json filesystem read failure", "PackageJsonSyntaxError": "handle package.json text that is not valid json or not an object", "PackageJsonWriteError": "handle package.json filesystem write failure", "PackageManager": "parse packageManager field, corepack pin triple name version integrity, exact pinnable version only", "PackageManagerRange": "parse packageManager field with a semver range, pnpm manage-package-manager-versions, verbatim range text", "PackageManifest": "read a package.json that may lack name or version, private workspace root", "PackageName": "validate npm package name, scoped or unscoped, classify scope", "PackageSpecifierTarget": "imports entry mapped to another package bare specifier", "PackageValidationError": "handle package.json validation rule failures, aggregated report", "PackageValidator": "validate package.json against rules, license description repository not-private checks, custom rule set", "PeerDependenciesMetaField": "peerDependenciesMeta field shape, optional flag per peer", "Person": "author or contributors field model, shorthand string or object, name email url", "PublishConfigField": "publishConfig field shape, access directory targets", "Repository": "repository field model, github shorthand or url, browsable url normalization, gitUrl", "RepositorySlug": "repository owner and name, github owner repo, forge host from repository url", "RepositoryField": "repository field raw wire shape, shorthand string or object", "ScopedPackageName": "validate scoped npm package name, at-scope slash name", "SpdxLicense": "validate spdx license field, spdx expression or UNLICENSED or SEE LICENSE IN", "TypesTarget": "typescript declaration file candidates for a subpath, types condition, typesVersions", "StringMapField": "engines field codec, string map to HashMap, no default", "UnresolvedEntryPointError": "handle a package with no resolvable exports entry point, no condition matched", "UnscopedPackageName": "validate unscoped npm package name", "defaultRules": "default package.json validation rule set, license description repository not-private", "isUnresolvedDependency": "check if a dependency has an unresolved workspace or catalog specifier", "isValidSpdx": "check if a string is a valid spdx license, or UNLICENSED", "licenseExpressionOf": "turn a manifest license field into a parsed spdx expression, skipping UNLICENSED and SEE LICENSE IN", "noLocalDepsRule": "validation rule rejecting local file link portal dependencies", "noUnresolvedDepsRule": "validation rule rejecting unresolved workspace or catalog dependencies", "resolveEntryPoint": "resolve a package's root entry point, exports map condition resolution, main fallback" }, "runtimes": { "AuthenticationError": "github rejected credentials, bad token, 401 auth failure", "BunRelease": "one published bun version and its release date", "BunResolver": "resolve a bun version from a semver range, pick a bun release, latest bun", "BunResolverOptions": "options for resolving bun versions, range and increments and default", "DenoRelease": "one published deno version and its release date", "DenoResolver": "resolve a deno version from a semver range, pick a deno release, latest deno", "DenoResolverOptions": "options for resolving deno versions, range and increments and default", "FreshnessError": "live runtime feed unreachable, layerFresh failed, no snapshot fallback allowed", "GitHubAuth": "how github api requests are authenticated, pat or GITHUB_TOKEN, anonymous auth", "GitHubClient": "list tags and releases from a github repo, github REST client over HttpClient", "GitHubRelease": "one github release as the releases API returns it, tag draft prerelease", "GitHubTag": "one github tag as the tags API returns it", "Increments": "group matching versions by latest, minor, or patch granularity", "InvalidScheduleDateError": "node release schedule date could not be parsed, malformed schedule.json", "NetworkError": "http request to a runtime feed failed or returned a bad status", "NoMatchingVersionError": "no runtime release matched the semver range or lifecycle phases searched", "NodePhase": "node lifecycle phase: current, active-lts, maintenance-lts, end-of-life", "NodeRelease": "one published node version with its npm version, ask if a release is lts", "NodeResolver": "resolve a node version from a semver range and lifecycle phase", "NodeResolverOptions": "options for resolving node versions, range, phases, increments, default, date", "NodeSchedule": "the node.js release schedule, look up lifecycle phase for a version", "NodeScheduleData": "raw shape of nodejs/Release schedule.json before parsing", "NodeScheduleEntry": "one node release line's lifecycle dates: start, lts, maintenance, end, codename", "RateLimitError": "github api rate limit exhausted, back off using retryAfter", "ResolvedVersions": "what a runtime resolver returns: matching versions, latest, lts, default, and provenance", "ResponseParseError": "a runtime feed responded in an unexpected shape, upstream feed changed", "Runtime": "which javascript runtime a resolver targets: node, bun, or deno", "Source": "whether resolved versions came from a live api fetch or the bundled offline snapshot", "UnresolvableDefaultError": "the caller's requested default version range matched nothing", "isLtsPhase": "check if a node lifecycle phase counts as long-term support", "nodeReleaseLine": "compute the node release-line key for a version, e.g. v0.10 vs v20" }, "s3": { "S3Client": "put get head delete list objects in r2 or s3 from a worker", "S3ConditionalConflict": "conditional put raced a concurrent write, 409 conditionalrequestconflict, retry with backoff", "S3InvalidRequest": "handle a key or metadata refused before signing, nothing was sent", "S3InvalidRequestReason": "route why a request was refused locally, bad key metadata or maxKeys", "S3ListPage": "read one listobjectsv2 page, keys, common prefixes, continuation token", "S3MalformedResponse": "handle an unreadable store answer, html proxy page, empty body, truncated page without token", "S3NotFound": "handle a missing object on get or head, nosuchkey", "S3NotModified": "conditional get with an etag, object unchanged, 304 answer", "S3Object": "read a downloaded object's bytes or text, etag, metadata, content range", "S3ObjectHead": "object metadata without the body, etag, size, content type, last modified", "S3ObjectSummary": "one listed object, key size last modified, entry in a bucket listing stream", "S3Operation": "which object operation an error came from, put get head delete list", "S3PreconditionFailed": "first-write-wins put lost, if-none-match or if-match refused, 412 answer", "S3PutResult": "etag and version id returned by an object write", "S3RequestFailed": "handle a store refusal, status, error code, request id, nosuchbucket", "S3TransportError": "request never completed, network failure with a redacted cause" }, "sbom": { "CYCLONEDX_BOM_PREDICATE": "attest an sbom, cyclonedx bom predicate type uri, in-toto predicateType for a bom", "Component": "cyclonedx component entry, describe a dependency or root package in a bom", "ComponentType": "cyclonedx component type enum, library application or framework", "Contact": "cyclonedx point of contact, sbom author or supplier contact info", "ExternalReference": "link a component to its repository, issue tracker, homepage or docs", "ExternalReferenceType": "external reference kind enum, vcs issue-tracker website documentation", "GITHUB_BUILD_TYPE": "slsa build type uri for a github actions workflow/v1 build", "IN_TOTO_PAYLOAD_TYPE": "dsse payload type for an in-toto statement, github attestations media type", "IN_TOTO_STATEMENT_V1": "in-toto statement v1 type uri stamped onto every statement", "InTotoStatement": "build an in-toto attestation statement, wrap a subject and predicate for signing", "InTotoSubject": "the artifact an attestation is about, name plus algorithm-to-digest map", "InvalidSha256DigestError": "handle malformed sha-256 digest input, typed digest validation failure", "NtiaElement": "one ntia minimum element's pass/fail verdict on an sbom", "NtiaElementId": "the seven ntia minimum element identifiers", "NtiaReport": "validate ntia compliance, check sbom minimum elements, generate compliance report", "SIGSTORE_BUNDLE_V0_3_MEDIA_TYPE": "sigstore bundle media type constant, dsse bundle version identifier", "SIGSTORE_OIDC_AUDIENCE": "the oidc audience sigstore's certificate authority (fulcio) requires", "SLSA_PROVENANCE_V1": "slsa provenance predicate type uri", "Sbom": "generate an sbom, assemble and serialize a cyclonedx document, write a bom to disk", "SbomDocument": "the cyclonedx 1.6 bom document model, bomFormat specVersion metadata and components", "SbomMetadata": "cyclonedx document metadata, who made the bom, when, and about what root component", "SbomMetadataSource": "derive sbom metadata from a package.json manifest, npm purl, root component", "SbomWriteError": "handle failure writing an sbom to disk, filesystem write failure", "Sha256Digest": "validate and normalize a sha-256 digest, strip sha256: prefix, lowercase hex", "SigningError": "handle sigstore signing failure, identity certificate transparency log or bundle step", "SigningErrorKind": "which sigstore signing step failed, identity certificate transparency log bundle", "SigstoreBundle": "the signed dsse bundle wire form, sigstore attestation result value", "SigstoreSigner": "sign with sigstore, produce a dsse bundle over fulcio and rekor", "SlsaBuildDefinition": "slsa provenance build definition, workflow ref, repository and resolved dependencies", "SlsaProvenance": "slsa provenance statement, attest a github actions build's origin", "SlsaRunDetails": "slsa provenance run details, builder identity and invocation id", "Supplier": "cyclonedx supplier organization, who supplied a component, ntia supplier name element" }, "schema-org": { "APIReference": "schema.org APIReference node, structured data for a documented api surface", "ConflictingTermError": "handle a catch-all key colliding with a typed field, @id or @type when building a json-ld document", "Conformance": "validate a json-ld document against schema.org offline, gate structured data in ci without a live validator", "ConformanceIssue": "the union of everything conformance checking can report about a json-ld document", "CreativeWork": "schema.org CreativeWork node, the general created-work vocabulary other nodes extend", "CreativeWorkFields": "the shared CreativeWork field set, spread into a node class you are composing", "DanglingReference": "a json-ld reference pointing at an @id no node in the document defines, legal but reportable", "DeprecatedProperty": "a schema.org property that is deprecated, valid but flagged", "DeprecatedType": "a schema.org type that is deprecated, valid but flagged", "DuplicateNodeIdError": "handle two json-ld nodes claiming the same @id when assembling a document", "InvalidNodeIdError": "handle a json-ld @id that is empty, has whitespace or carries a control character", "JsonLdDocument": "assemble schema.org nodes into one json-ld document and serialize it safely into a script element", "JsonLdNode": "the union of node types a json-ld document can hold", "NodeId": "the json-ld node identifier rule as a schema, reuse the @id validity check by identity", "NodeRef": "point one schema.org node at another by @id instead of embedding it", "NonConformantGraphError": "handle a json-ld document failing its schema.org conformance gate", "Organization": "schema.org Organization node, structured data for a company or group", "Person": "schema.org Person node, structured data for an author or maintainer", "PropertyNotOnType": "a property schema.org does not define on the type carrying it, including by inheritance", "SoftwareSourceCode": "schema.org SoftwareSourceCode node, structured data for a package's source", "TechArticle": "schema.org TechArticle node, structured data for a documentation page", "TechArticleFields": "the shared TechArticle field set, spread into a node class you are composing", "TermKind": "whether a conformance issue is about a schema.org type or a property", "ThingFields": "the shared Thing field set every schema.org node in this package carries", "UnknownTerm": "a term schema.org does not define at all, reported and never silently passed", "Vocabulary": "ask the vendored schema.org vocabulary directly about types, properties and inheritance" }, "schemastore": { "CanonicalJson": "deterministic canonical json text, stable diff-friendly serialization for committed schema files, content equality for two parsed json documents", "CatalogEntry": "build a schemastore catalog.json entry, assemble unversioned or versioned schema urls", "CatalogLintFinding": "catalog fileMatch hygiene warning, generic pattern or complex glob rejection", "ContractChangeTarget": "one published schema target whose contract changed, pair its pinned version with the next bumped label", "DRAFT_07_META_SCHEMA": "draft-07 meta-schema url constant for $schema", "DocumentDiff": "diff two schema documents, classify annotation-only vs contract change, decide new version", "DocumentLint": "structural lint over an assembled schema document, unresolved $ref check, unknown keyword check", "DocumentLintFinding": "lint finding value for a schema document structural check", "HostedSchema": "a schema's hosted identity, derive the $schema url an application writes and the $id defineConfig emits from one value, github schemastore or custom host constructors", "DriftPolicy": "classify a published target's change as write or drift against its configured tolerance", "InstanceFinding": "one engine-reported problem in a payload instance, a json pointer value never an error", "InstanceValidator": "validate a json payload against a published schema document with a real engine, the contract the schemastore validate command composes", "InstanceValidatorError": "handle the instance validation engine failing as a mechanism rather than a rejection", "InvalidSchemaVersionError": "handle a version label outside 1-3 numeric parts, optional prerelease, no build metadata", "JsonDepthExceededError": "handle json value nesting past the hardening cap during canonical serialize", "KeywordFamilies": "recognize non-standard vscode taplo tombi intellij x-ai json schema keyword families, machine annotation hint", "NonJsonValueError": "handle a non-json value (undefined, bigint, function, NaN) during canonical serialize", "PipelineFinding": "normalized lint or validator finding surfaced by the schema pipeline", "SCHEMASTORE_CATALOG_BASE": "the www host constant a schemastore catalog.json entry url points at", "SCHEMASTORE_ID_BASE": "the json host constant a schemastore-hosted document declares in $id", "SchemaContractChangeError": "handle a pipeline run refusing to rewrite a pinned published schema in place, block-versioned contract change", "SchemaConversionError": "handle failure converting an effect schema into a schemastore document", "SchemaFile": "read and write emitted schema documents to disk, drift check for ci", "SchemaFileNotFoundError": "handle a missing schema file on read", "SchemaFileReadError": "handle a schema file filesystem read failure", "SchemaFileWriteError": "handle a schema file filesystem write failure", "SchemaGateError": "handle blocking lint or validator findings that fail a schema pipeline gate", "SchemaPipeline": "generate lint validate gate and write schema targets, run the pipeline", "SchemaTarget": "declare one schema publication target with its $id, path and optional version", "SchemaValidator": "validate a json schema document with a real engine, ajv strict mode gate", "SchemaValidatorError": "handle the validation engine failing as a mechanism rather than a rejection", "SchemaVersion": "branded schema version label, one to three components with optional prerelease for catalog file naming", "SchemaVersioning": "compute versioned or unversioned catalog urls, order schema version labels, derive schema file names", "StoreDocument": "assemble a schemastore-shaped draft-07 document from an effect schema, publish a json schema", "ValidationFinding": "one ajv validation problem in a document, a value never an error", "UndeclaredAnnotationKeyError": "refuse an annotation key outside the declared language-server families, fail a schemastore document build naming every offending key, gate includeAnnotationKey", "defineConfig": "validate and assemble a schemastore.config.ts value, fill drift defaults, derive catalog versions", "isSchemastoreConfig": "recognize a config module's default export as one defineConfig produced", "SchemastoreVersion": "which copy of schemastore produced a config value, detect mismatched duplicate installs" }, "semver": { "Comparator": "check if a version satisfies an operator constraint, single comparator like >=1.2.3", "EmptyCacheError": "handle empty version cache, no versions loaded, latest or oldest with nothing cached", "InvalidComparatorError": "handle malformed comparator string, typed parse failure for a single constraint", "InvalidRangeError": "handle malformed semver range string, typed parse failure for a range expression", "InvalidVersionError": "handle malformed version string, typed parse failure, not valid semver", "InvalidVersionSpecifierError": "handle a dependency specifier that is not one operator and one version, compound or partial range refused", "Range": "parse and match a semver range, npm-style ranges: hyphen x-range tilde caret, includePrerelease matching, node-semver written-order comparator sets, any-version range check", "SemVer": "parse and validate a semver version string, compare versions, bump major minor patch", "SemVerBump": "bump a version, increment major minor patch prerelease or build metadata", "UnsatisfiableConstraintError": "handle impossible intersected ranges, no comparator set can satisfy both ranges", "UnsatisfiedRangeError": "handle no cached version matching a range, report available versions against the requested range", "VersionCache": "track and query available versions, find latest or oldest satisfying a range", "VersionDiff": "classify the change between two versions: major minor or patch", "VersionNotFoundError": "handle a version missing from the cache during diff next or prev navigation", "VersionSpecifier": "split a dependency specifier into operator and one version, keep caret and tilde, refuse compound ranges" }, "shell": { "ShellAnsiCPart": "decoded dollar-quoted string, ansi-c escapes in a shell word", "ShellArithmeticPart": "arithmetic expansion or double-parenthesis command, shift is not a heredoc", "ShellAssignment": "read a leading `FOO=1` environment prefix or variable assignment on a command", "ShellAssignmentBuiltin": "declare typeset local export readonly options and operands as bash reads them, which array keys are strings", "ShellBarePart": "unquoted literal text in a shell word, backslash escapes removed", "ShellBracePart": "brace expansion span the shell would rewrite, fail closed on `git {commit,}`", "ShellCommand": "resolve a segment's command name and args, unwrap sudo env exec nohup time", "ShellCommandSubstitutionPart": "nested dollar-paren or backtick command text to parse and inspect", "ShellCommandWalk": "every command at every depth through substitutions, with truncations a guard must refuse", "ShellComment": "read a shell comment's text and offsets", "ShellDiagnostic": "refuse input a parse could not finish, unterminated quote or substitution with offset", "ShellDiagnosticCode": "route why a command string parse was odd, unterminated quote heredoc bad escape", "ShellDoubleQuotedPart": "double-quoted string in a shell word, list the expansions inside it", "ShellExpansionPart": "variable, substitution or arithmetic expansion inside double quotes or a heredoc", "ShellGlobPart": "unquoted pathname-expansion syntax in a shell word, star question-mark bracket", "ShellHeredoc": "read a heredoc body and delimiter, commit message passed through a heredoc", "ShellNestedScript": "one parsed substitution body reached by a walk, its depth and parent", "ShellOpaquePart": "text a lexer could not finish, never literal, unterminated quote to end of input", "ShellOperator": "control operators joining commands, and-or, pipe, semicolon, background, newline", "ShellProcessSubstitutionPart": "process substitution body to parse and inspect, input or output direction", "ShellRedirection": "read a command's output or input redirections, file descriptor, operator and target", "ShellRedirectionOperator": "redirection operator vocabulary, output, append, input, heredoc, descriptor duplication", "ShellScript": "list every command and substitution a command string would run, read diagnostics", "ShellSegment": "one simple command between control operators, words, assignments, redirections", "ShellSingleQuotedPart": "single-quoted literal text in a shell word", "ShellSubstitutionPart": "every nested command or process substitution, recurse to find hidden commands", "ShellSyntax": "parse a command string without executing it, guard a bash tool call", "ShellTildePart": "home-directory tilde prefix the shell would expand, never literal", "ShellTruncation": "a substitution a walk did not parse, past the depth cap or work budget", "ShellVariablePart": "variable or parameter expansion, command name that cannot be read statically", "ShellWord": "read an argument's literal value only if the shell passes it unchanged", "ShellWordPart": "how a word is quoted or expanded, switch on part kind" }, "source": { "EditDistance": "edit distance between two strings, levenshtein, did you mean suggestions, nearest candidate, typo hint", "LineIndex": "convert offset to line and character, lsp position, count lines, line start end", "LineDiff": "diff two texts line by line, hunks with context, plain values, unified diff" }, "spdx": { "AndNode": "spdx AND compound expression node, conjunction of two license expressions", "InvalidSpdxExpressionError": "handle malformed or unknown spdx license expression input", "License": "validate an spdx license identifier, catalog lookup, known and deprecated ids", "LicenseException": "validate an spdx license exception identifier, catalog lookup for WITH clauses", "LicenseNode": "spdx expression license leaf node with the optional + or-later marker", "LicenseRefNode": "spdx expression LicenseRef/DocumentRef reference leaf node", "OrNode": "spdx OR compound expression node, disjunction of two license expressions", "SpdxExpression": "validate an spdx license expression, parse to an ast, codec to and from string", "WithExceptionNode": "spdx license WITH exception compound node", "isValidExpression": "check if a string is a valid spdx license expression" }, "store": { "Cache": "cache with ttl and tags, durable local state, tag invalidation and write-order eviction, second cache under your own key", "CacheEntry": "a stored cache row, key value bytes, content type, tags and expiry", "CacheError": "handle a cache sql operation failure, get set has invalidate prune failed", "CacheEvent": "a published cache lifecycle event with its timestamp", "CacheEventPayload": "cache hit, miss, set, expired, evicted, invalidated, pruned event shapes", "Store": "durable local state, migrated sqlite database, schema-versioned store, adopt an effect sql migrator ledger, second database under your own key", "StoreError": "handle a store sql operation failure, migrate rollback status setup adopt failed", "StoreMigrationError": "handle a failing user-defined migration, sql error during up or down", "StoreMigrationStatus": "a migration's applied/pending status, when it ran", "Uint8ArrayFromUtf8": "encode text to bytes for a store or cache value, utf-8 codec to uint8array" }, "templates": { "CheckOutcome": "report whether a managed section is missing, in sync, or drifted without writing", "CommentStyle": "pick how BEGIN and END markers are commented per file type", "ManagedSection": "update a generated section in a file, read compare and remove blocks", "PlacedSection": "locate a managed section's position in a document, span of an existing BEGIN/END block", "Section": "declare the content that belongs inside a managed region, identity plus payload", "SectionDialect": "configure the marker phrase and comment styles a document is scanned with", "SectionDocument": "parse a file into its text plus every managed section found", "SectionFileError": "handle a managed-section file that could not be read or written", "SectionId": "identify a managed section by its key and comment style", "SectionKey": "the name written inside BEGIN/END markers, validate a managed section key's grammar", "SectionParseError": "handle a document whose managed-section markers are malformed or ambiguous, cannot read BEGIN/END structure", "SectionRenderError": "handle a section that cannot be rendered as marker-delimited text", "SyncOutcome": "report what a sync did to a declared section, inserted updated or left unchanged" }, "toml": { "Toml": "parse and stringify a toml document, entry point for toml 1.1.0 parsing", "TomlArray": "heterogeneous list possibly spanning multiple lines with comments", "TomlArrayTableHeader": "[[table]] header expression", "TomlBoolean": "true or false literal", "TomlDateTimeLiteral": "wrapping local date, local time, local date-time or offset date-time", "TomlDiagnostic": "one structured toml parse or stringify diagnostic: error code, message, source position", "TomlDocument": "lossless toml document, byte-exact source, CST, semantic diagnostics, parse cargo.toml, sync result form", "TomlEdit": "a non-mutating text edit over a toml document, replace a span", "TomlErrorCode": "the union of every toml error code across lex parse semantic and stringify stages", "TomlExpression": "union of top-level toml CST node types: key-value, table header, array-table header", "TomlFloat": "including inf and nan spellings", "TomlFormat": "format or modify toml document by path, apply structured edit, sync result form", "TomlFormattingOptions": "options controlling toml format and modify newline normalization", "TomlInlineEntry": "one key = value entry inside a toml inline table, dotted key path entry", "TomlInlineTable": "{ k = v } braces possibly spanning multiple lines since 1.1", "TomlInteger": "decodes to number or bigint for full 64-bit range", "TomlKey": "one simple key segment within a possibly dotted toml key path", "TomlKeyKind": "the toml key spelling kinds, bare basic or literal key", "TomlKeyValue": "span and trailing comment for one assignment", "TomlLexErrorCode": "the union of toml lexer-stage error codes, tokenizing failure", "TomlLocalDate": "no time or offset, validated calendar date", "TomlLocalDateTime": "no offset, combined date and time", "TomlLocalTime": "no date or offset, tolerates rfc 3339 leap second", "TomlModificationError": "handle a failed toml modification: path unresolved or insertion refused", "TomlOffsetDateTime": "utc offset in minutes", "TomlParseError": "handle malformed toml input, typed parse failure with diagnostic entries", "TomlParseErrorCode": "the union of toml parser-stage error codes, grammar violation while parsing", "TomlRange": "a character offset and length span within a toml document, restrict formatting", "TomlSemanticErrorCode": "the union of toml semantic-stage error codes, duplicate key or table conflict", "TomlString": "decoded text plus raw source spelling", "TomlStringStyle": "the toml string quoting styles, basic literal multiline-basic or multiline-literal", "TomlStringifyError": "handle a failure stringifying to toml: unsupported, out-of-range, circular, depth", "TomlStringifyErrorCode": "the union of toml stringifier-stage error codes", "TomlStringifyOptions": "options controlling toml stringify newline output", "TomlTableHeader": "declares a `[table]` section header opening a table body", "TomlTrivia": "a run of blank lines and standalone comments coalesced into one toml node", "TomlValueNode": "union of every toml value type: string integer float boolean date-time array", "TomlVisitor": "sax-style streaming walk over a toml document, visit events in document order", "TomlVisitorEvent": "the discriminated toml visitor event union, table start array-table start key-value or comment events" }, "tsconfig-json": { "CompilerOptions": "tsconfig compilerOptions schema, target module lib jsx strict flags, forward-tolerant passthrough", "CompilerOptionsFromProgrammatic": "accept ts.CompilerOptions or numeric enums, decode and validate into tsconfig strings", "FallbackPolling": "watchOptions.fallbackPolling enum, polling strategy when native watching is unavailable", "Jsx": "compilerOptions.jsx enum, react-jsx react-jsxdev preserve classic transform", "JsxConfig": "derive bundler jsx runtime from compilerOptions, automatic vs classic transform, jsxImportSource default", "Lib": "compilerOptions.lib enum, dom es2015 esnext lib file names", "Module": "compilerOptions.module enum, commonjs esnext nodenext output format", "ModuleDetection": "compilerOptions.moduleDetection enum, auto legacy force", "ModuleResolution": "compilerOptions.moduleResolution enum, node10 bundler nodenext", "NewLine": "compilerOptions.newLine enum, crlf lf line ending", "PortableTsconfig": "project compilerOptions for a virtual typescript environment, twoslash sandbox, strip absolute paths", "Reference": "tsconfig references entry, project reference path", "ResolvedTsconfig": "merge a tsconfig extends chain, absolutize compiler option paths, configDir substitution", "Target": "compilerOptions.target enum, ecmascript version es2015 esnext", "TsEnumCodec": "convert tsc string enum spellings to numeric enum values, normalize lib names", "TsconfigDiscovery": "find the governing tsconfig, nearest tsconfig.json upward search from a starting directory", "TsconfigExtendsError": "handle a broken tsconfig extends chain, unresolvable target, cycle, depth limit, empty extends spec", "TsconfigJson": "tsconfig.json document schema, compilerOptions files include exclude references watchOptions typeAcquisition", "TsconfigJsonFromString": "parse tsconfig.json text with comments, jsonc codec for tsconfig documents", "TsconfigLoader": "resolve tsconfig extends chain, read decode and merge a tsconfig.json and bases", "TsconfigLoaderSync": "resolve tsconfig extends chain synchronously, bundler plugin hook config factory", "TsconfigParseError": "handle a tsconfig.json that fails to parse or decode", "TypeAcquisition": "tsconfig typeAcquisition schema, enable include exclude automatic type acquisition", "WatchDirectory": "watchOptions.watchDirectory enum, directory watching strategy", "WatchFile": "watchOptions.watchFile enum, file watching strategy, polling vs fsevents", "WatchOptions": "tsconfig watchOptions schema, watchFile watchDirectory fallbackPolling exclude" }, "walker": { "DescendError": "handle unreadable directory during glob descent, depth cap exceeded, typed filesystem walk failure", "GlobExpansionError": "handle pattern-to-files expansion failure, compile or descend stage error, wraps GlobPatternError or DescendError", "PathEscapeError": "handle path escaping a base directory, zip slip, symlink escape, absolute or dot-dot refused", "PathEscapeReason": "why a confined path was refused, traversal, symlink outside base, unresolvable, win32 reserved", "Walker": "walk up directories, nearest config file or valid manifest, stop at .git, sync forms", "compileAndExpand": "compile a glob string, expand against the filesystem, pattern to matching files", "confineReal": "check a path stays inside a base directory physically, resolve symlinks, refuse escapes", "confineRealSync": "synchronous symlink-aware containment check over a caller-supplied fs port, Result", "relativeWithin": "base-relative posix path of an absolute path physically inside a base, even if it does not exist yet, Option", "relativeWithinSync": "synchronous base-relative containment answer over a caller-supplied fs port, Option", "confineRelative": "confine an untrusted relative path to a base directory as an Effect, reject dot-dot escapes", "confineRelativeResult": "confine an archive entry or manifest path under a base dir synchronously, zip slip guard, Result", "descend": "expand a compiled glob into files or directories under a directory, prune node_modules", "descendEntries": "walk glob matches keeping each file's stat, record unreadable directories", "descendEntriesSync": "synchronous glob walk keeping stats, over a caller-supplied fs port", "descendSync": "synchronous glob walk over a caller-supplied fs port, no Effect runtime", "nodeWalkerFileSystem": "node fs binding for the synchronous walker", "nodeWalkerPath": "node path binding for the synchronous walker", "nodeWalkerSyncOps": "node fs and path bindings to spread into a synchronous walk", "PosixPath": "sync pure posix path join, normalize, relative, dirname, no cwd, no Path service", "UpwardAcceptCache": "memoize each ancestor's answer in a sync upward search, hot path" }, "workspaces": { "CatalogSet": "pnpm catalog data, resolve a catalog: specifier to a version range", "ChangeDetectionError": "handle git change detection setup failure, no repository or nothing to detect against", "ChangeDetectionOptions": "configure the git diff range, base and head refs, include uncommitted working-tree changes", "ChangeDetector": "find changed files since a git ref, which packages changed, blast radius", "ConfigDependencyHooks": "replay pnpm config dependency pnpmfile hooks, inject catalogs from a config-dependency plugin, updateConfig hook", "CyclicDependencyError": "handle a circular workspace dependency, cannot topologically sort packages", "DependencyGraph": "inter-package dependency graph, topological sort, parallel build levels, blast radius", "Dependent": "who pulls one resolved copy of a package, importer path or dependent package name and version", "DetectedPackageManager": "which package manager and version runs this workspace, detection result and evidence", "DuplicateCheck": "find packages resolved at more than one version in a lockfile and who pulls each copy, duplicate kit copies, pnpm why aggregated, Layer mismatch from two @effected copies", "DuplicateInstance": "one resolved instance of a duplicated package with everything that pulls it", "DuplicatedPackage": "one package name resolved at two or more distinct versions", "DuplicatedVersion": "one version of a duplicated package with its resolved instances", "LockfileReadError": "handle the workspace lockfile file cannot be read off disk", "LockfileReader": "read and parse the workspace lockfile, look up a resolved package version", "PackageManagerDetectionError": "handle no package manager could be detected at a workspace root", "PackageManagerDetector": "detect which package manager npm pnpm or bun runs a workspace", "PackageManagerEvidence": "which marker file or manifest field decided a package-manager detection", "PackageManagerName": "the supported package managers, npm pnpm bun", "PackageNotFoundError": "handle an unknown workspace package name requested by name", "PackageStateSnapshot": "one package's captured state at a point in time: name, version, dependencies", "PeerCheck": "find unsatisfied peer dependencies in a lockfile, replicate pnpm peers check, peer dependency audit", "PeerParent": "one link from an importer to a package declaring an unmet peer", "PublishConfig": "typed publishConfig fields, registry access directory and dist-tag for publishing", "PublishTarget": "a resolved publish destination for a package, registry access directory and provenance", "PublishabilityDetector": "decide whether a workspace package publishes and to where, npm publish semantics", "ReleaseTag": "format a git release tag, single shared tag or per-package scoped tag naming", "TagStyle": "whether a release uses one shared tag or one tag per package", "TrackingTag": "floating major/minor alias tag like v1 or v1.2, re-point at a release", "UnsatisfiedPeer": "one declared but unmet peer dependency row, missing or wrong version resolved", "VersioningStrategy": "how a workspace assigns versions: single fixed-group or independent, derive release tags", "VersioningStrategyType": "single, fixed-group or independent versioning classification", "WORKSPACE_MARKERS": "marker filenames that identify a workspace root, pnpm-workspace.yaml or package.json", "WorkspaceMarker": "workspace root marker filename schema, restrict root search to pnpm-workspace.yaml", "WorkspaceRootMatch": "found workspace root with its matched marker file path", "WorkspaceCatalogs": { "intent": "assemble pnpm catalogs for a workspace, resolve a catalog: specifier, release-age gate, effective peerDependencyRules", "implements": "npm.CatalogResolver" }, "WorkspaceDiscovery": { "intent": "enumerate workspace packages, find a package by name, resolve a file path", "implements": "npm.WorkspaceResolver" }, "WorkspaceDiscoveryError": "handle a workspace member's package.json that cannot be read or parsed", "WorkspaceInfo": "top-level workspace facts, root directory and packages: patterns", "WorkspaceManifestError": "handle a package.json that cannot be read or decoded into the strict manifest model", "WorkspacePackage": "a located workspace member, discovered package.json projection, dependency lookups and glob matching", "WorkspacePatternError": "handle a packages: glob pattern that cannot be enumerated, missing base directory", "WorkspaceRoot": "find the nearest workspace root, ascend directories for pnpm-workspace.yaml or a package.json workspaces field, locate the matched marker file as an Effect", "WorkspaceRootNotFoundError": "handle no workspace root found above a starting directory", "WorkspaceSnapshots": "read workspace state at a ref with no checkout, live worktree snapshot", "WorkspaceStateSnapshot": "workspace state at a ref, resolve catalog: or workspace: specifiers", "Workspaces": { "intent": "composite layers wiring the whole workspaces package, one-call setup, run a project-local binary", "implements": "commands.LocalExec" }, "classifyTag": "classify a git tag string as a release tag or a tracking alias", "findWorkspaceRootSync": "synchronously find the workspace root, non-Effect entry point for config files like vitest.config", "locateWorkspaceRootSync": "find the workspace root and the marker file that matched, pnpm-workspace.yaml path, sync", "getWorkspacePackagesSync": "synchronously enumerate workspace packages, non-Effect entry point for config files", "nodeFileSystem": "sync filesystem adapter over node:fs, exists read directory stat", "nodePath": "sync path adapter, the running platform's node:path", "nodeSyncOps": "bundle node filesystem and path adapters for the sync entry points", "SourceBoundary": "scan source for process reads, node imports, console and stdout writes", "Offence": "one boundary violation with file line column and rule", "SourceScan": "boundary scan result, files read, allowlisted files, offences", "LayerPolicy": "decode a committed layers.json dependency layering policy", "LayerPolicyError": "layer policy file unreadable, not json, or wrong shape", "LayerEdge": "one workspace dependency edge in one manifest field", "LayeringReport": "layering violations, sideways upward edges, cycles, unclassified packages", "WorkspaceLayering": "check monorepo package graph against layers, per-field edges", "PackedInstall": "pack carrier, install outside workspace under npm pnpm bun, closure before run, override unreleased dependency", "PackedInstallError": "packed install failure, manager unavailable, unresolved workspace protocol, missing bin, invalid override, bin conflict", "InstalledConsumer": "scratch consumer project, installed bin path, bin command for a probe, run the carrier's own bin under shared bins", "PackedInstallResult": "installed consumers, unavailable managers, packed tarball paths", "ConfigDependencySpec": "parse a pnpm-workspace.yaml configDependencies version, split inline sri integrity, render bare form", "InvalidConfigDependencySpecError": "handle a configDependencies spec whose version is not exact or integrity is not sri", "ImportGraph": "walk relative imports from entry files, report forbidden import reached with its chain, flag runtime import no manifest field declares", "ReachabilityScan": "reachability walk result, violation labels, files reached, unresolved links", "ReachOffence": "forbidden specifier reached from an entry, chain of files that reaches it", "UnresolvedImport": "relative or followed import no candidate file resolves", "UndeclaredScan": "undeclared import check result, violation labels, packages and files checked", "UndeclaredImport": "runtime import of a package absent from dependencies, peer or optional", "NoEntriesError": "reachability called with an empty entry list", "EntryNotFoundError": "reachability entry that resolves to no file", "detectPackageManagerSync": "synchronously detect pnpm, npm or bun at a root, no Effect runtime", "localExecContextSync": "synchronously get the pnpm exec or npx prefix for this workspace", "UnsupportedPackageManagerError": "detect a yarn repository, refuse an unsupported package manager instead of guessing npm" }, "xdg": { "AppDirKind": "the config, data, cache, state or runtime directory kind", "AppDirs": "resolve and create an app's namespaced config, data, cache, state and runtime directories", "AppDirsError": "handle an app directory failing to be created on disk", "CurrentPlatform": "override the detected os platform for native directory resolution in tests", "NativeDirs": "map platform and environment to os-native app directories, macOS Application Support, Windows AppData", "ResolvedAppDirs": "the fully resolved app-namespaced directories and their search paths", "Xdg": "read the XDG Base Directory environment once at layer construction, opt-in home fallback", "XdgConfig": "bridge xdg app directories into a config-file resolver, search path or native directory", "XdgEnvError": "handle the HOME environment variable missing for xdg resolution", "XdgPaths": "the resolved XDG_CONFIG_HOME/XDG_DATA_HOME and friends, home directory required", "XdgPlatform": "the os platform values xdg resolution reasons about, darwin/win32/linux and others", "AppDirsSegmentError": "workspace key maps to an empty, dot or dot-dot directory segment" }, "yaml": { "CollectionStyle": "block vs flow collection style literal, {} and [] vs indented", "QuoteCompat": "quote dialect compat literal, json-safe or yaml 1.1 quoting", "QuoteStyle": "fallback quote style literal, single vs double quote preference", "ScalarChomp": "block scalar chomping indicator, strip clip keep trailing newlines", "ScalarStyle": "scalar style literal, plain single double literal folded", "StyleConflict": "report disagreeing style spellings found across sources, strict inference conflict", "StyleEvidence": "collected style vote and floor evidence for config inference", "StyleFloor": "measured minimum bound a source proves for a style limit, never fabricate a max", "StyleFloorTally": "merge measured style floors across sources, keep the largest observed value", "StyleVote": "one observed style choice occurrence, categorical vote for inferring config", "StyleVoteTally": "accumulate how many times a style spelling was voted, first-seen position", "Yaml": "parse and stringify yaml, strip comments, semantic equality, build yaml schemas", "YamlAlias": "referencing a previously defined anchor by name", "YamlComposerErrorCode": "compose-stage error code, anchor and alias resolution failures", "YamlDiagnostic": "structured parse or lint error/warning with code and exact position", "YamlDirective": "yaml directive before a document, %YAML version or %TAG shorthand", "YamlDocument": "recovered errors, warnings and directives after parsing, sync parse and stringify result form", "YamlEdit": "non-mutating text edit, replace offset/length span with content", "YamlErrorCode": "union of all yaml error codes across lex, parse, compose and stringify stages", "YamlFormat": "format, modify and reprint yaml text while preserving comments and style, sync result form", "YamlFormattingOptions": "options for formatting yaml, preserve comments, restrict to a range, requote scalars", "YamlLexErrorCode": "lexer-stage error code, tokenizing failure", "YamlLint": "lint a yaml file, run yamllint-class rules, infer config from observed style", "YamlLintConfig": "lint rule configuration, map rule ids to severity or per-rule options", "YamlLintDiagnostic": "one lint finding: rule, severity, span and optional autofix", "YamlLintRuleSetting": "one rules-map entry value, severity literal or rule options object", "YamlLintSeverity": "lint severity literal, error warning or off", "YamlMap": "collection of key-value pairs", "YamlModificationError": "handle failed structural yaml edit, path mismatch, multi-document stream, or directive-carrying document", "YamlModifyErrorCode": "modify-stage error code, structural edit navigation failure, multi-document or directive refusal, circular reference, nesting depth exceeded, unrepresentable function or symbol", "YamlNode": "union of all yaml ast value node types, scalar map seq alias", "YamlPair": "within a mapping, value null when key has none", "YamlParseError": "handle malformed yaml input, aggregated fatal diagnostics from error-recovery parse", "YamlParseErrorCode": "parser-stage error code, syntax failure during parsing", "YamlParseOptions": "options controlling parse behavior, strict mode, alias count guard, unique keys", "YamlRange": "character offset and length span within a yaml document, restrict formatting to a region", "YamlScalar": "string number boolean or null value", "YamlSeq": "ordered list of nodes", "YamlStringifyError": "handle yaml stringify failure, circular reference guard, nesting depth exceeded, unrepresentable function or symbol", "YamlStringifyErrorCode": "stringifier-stage error code, circular reference, unrepresentable function or symbol", "YamlStringifyOptions": "options controlling yaml output: indent width, line width, quote style, sort keys", "YamlStyleConflictError": "handle non-unanimous strict style inference, conflicting observed spellings across sources", "YamlToken": "single positioned yaml lexical token", "YamlTokenKind": "union of lexical token kind string literals, public yaml token stream vocabulary", "YamlTokens": "tokenize yaml text into a public token stream", "YamlVisitor": "walk a yaml ast with sax-style visitor events", "YamlVisitorEvent": "discriminated union of yaml ast visitor events, begin/end with path and depth" }, "crypto": { "ConstantTime": "constant-time compare bytes or strings, timing-safe secret or mac equality", "DriftApply": "drift decision to apply desired config, no baseline or desired changed", "DriftDecision": "three-way drift outcome apply unchanged or drift, reconcile declared config against a remote", "DriftDetected": "drift decision, live resource changed out of band, carries applied and live fingerprints", "DriftUnchanged": "drift decision to leave a resource alone, live matches applied and desired", "Fingerprint": "stable sha256 fingerprint of a json value, sorted keys, three-way drift detection applied live desired", "FingerprintError": "handle a value with no canonical json form, bigint cycle map or class instance refused", "Hash": "digest a multi-part message, hash bytes to hex or base64, sha-256 sha-512 md5", "Hmac": "compute or verify hmac-sha256 or sha512, redacted key, hex base64 base64url output, over core mac", "HttpRedaction": "scrub credentials from a kept http error cause, redact authorization cookie api key headers, redact url userinfo token query, safe HttpClientError request response copy for logs", "SigV4": "sign an aws or s3-compatible request, sigv4 authorization header, signing key", "SigV4EncodingError": "sigv4 refused a lone surrogate in a path, query, header or method", "SigV4PathError": "handle an s3 key or sigv4 path with a dot segment that a url would collapse" }, "webhooks": { "AttestationContextError": "invalid attestation context part, empty or contains a separator", "GitHub": "verify a github webhook delivery, x-hub-signature-256 sha256 hmac", "HmacHeader": "verify a generic hmac signature header, hex or base64, linear webhooks", "Sanity": "verify a sanity webhook signature, millisecond timestamp, base64url hmac", "SharedSecret": "verify a shared-secret header, constant-time, attest an archived delivery, verify on replay", "SharedSecretAttestOptions": "bind an archived webhook attestation to its route context", "SharedSecretAttestedOptions": "accept the live secret or an archived attestation, replay a delivery", "StandardWebhooks": "verify svix or standard webhooks signature, whsec secret, rotated v1 keys", "Stripe": "verify a stripe-signature header, timestamped v1 hmac, replay tolerance", "WebhookPreset": "which webhook verification preset produced a result or failure", "WebhookVerificationError": "handle webhook verification failure, missing or bad signature, stale timestamp", "WebhookVerificationReason": "route a webhook rejection to 401 or 400 by reason", "Webhooks": "check webhook timestamp freshness against receive time, default replay tolerance" } }