Skip to content
2 min read · 467 words

@nhtio/adk/batteries/dev-tools ​

Typed development-editing pipeline contracts and factory.

Interfaces ​

InterfaceDescription
CheckCapabilityA checker capability declaration.
CheckRequestRequest passed to a checker.
DevCandidateA candidate exposed to selection middleware.
DevCapabilityProbeA synchronous declaration-only capability probe.
DevChainChainable development plan builder.
DevEngineA self-declaring development engine.
DevFileAccessNarrow filesystem façade granted to in-place capabilities.
DevGateCallDescription of the step presented to a gate.
DevGateContextContext supplied to a development-tools gate.
DevPipelineDevelopment pipeline callable and its front ends.
DevPlanDevelopment plan.
DevResultThe composite result of a development-tools execution.
DevSelectionContextSelection middleware context.
DevStepDevelopment plan step.
DevStepContextStep middleware context.
DevWorkspaceMutable workspace state passed to step middleware.
DevWorkspaceTokenOpaque provenance token for one workspace value. Tokens are runtime-minted and unique per execution and persistence point, so a short-circuit cannot restore a stale or foreign workspace.
DiagnosticA diagnostic returned by the pipeline.
FileChangeSummaryA summary row for one final workspace change.
FormatCapabilityA formatter capability declaration.
FormatRequestRequest passed to a formatter.
LintCapabilityA linter capability declaration.
LintRequestRequest passed to a linter.
RawDiagnosticA diagnostic returned by an engine before runtime provenance is added.
RunOptionsExecution options.
WorkspaceBoundsWorkspace resource limits.
WorkspaceDeltaThe common result of every engine capability.

Type Aliases ​

Type AliasDescription
DevGateFnGate callback used by the pipeline.
DevGateVerdictGate verdict; omission or approval permits the step.
DevOpOperation-shaped plan input.
DevSelectionMiddlewareFnSelection middleware callback.
DevStepMiddlewareFnStep middleware callback.
SeverityDiagnostic severity, ordered from most to least serious.

Variables ​

VariableDescription
E_DEV_BAD_ARGInvalid development-step argument.
E_DEV_ENGINE_REQUIREDA requested engine capability is not configured.
E_DEV_GATE_DECLINEDA gate declined a step.
E_DEV_STEP_FAILEDA development step failed during execution or validation.
E_DEV_STEP_UNAVAILABLEA step implementation is not available.
E_DEV_UNKNOWN_STEPUnknown development step.
E_DEV_WORKSPACE_BOUNDSWorkspace bounds were exceeded.
E_INVALID_DEV_PIPELINE_CONFIGFatal configuration error for a development-tools pipeline.

Functions ​

FunctionDescription
createDevPipelineConstruct a development-editing pipeline.