Expand description
§adrs-core
Core library for managing Architecture Decision Records (ADRs).
This library provides the foundational types and operations for working with ADRs, including parsing, creating, linking, and querying decision records.
§Modes
The library supports two modes:
- Compatible mode (default): Writes markdown-only format compatible with adr-tools, but can read both legacy and next-gen formats.
- Next-gen mode: Uses YAML frontmatter for structured metadata, enabling richer features like typed links and better validation.
Re-exports§
pub use export::ConsideredOption;pub use export::ImportOptions;pub use export::ImportResult;pub use export::JSON_ADR_SCHEMA;pub use export::JSON_ADR_VERSION;pub use export::JsonAdr;pub use export::JsonAdrBulkExport;pub use export::JsonAdrLink;pub use export::JsonAdrSingle;pub use export::RepositoryInfo;pub use export::ToolInfo;pub use export::export_adr;pub use export::export_directory;pub use export::export_repository;pub use export::import_to_directory;pub use lint::Issue;pub use lint::IssueSeverity;pub use lint::LintReport;pub use lint::check_all;pub use lint::check_repository;pub use lint::lint_adr;pub use lint::lint_all;pub use doctor::Check;pub use doctor::Diagnostic;pub use doctor::DoctorReport;pub use doctor::Severity;pub use doctor::check as doctor_check;
Modules§
- doctor
- Health checks for ADR repositories.
- export
- JSON-ADR export functionality.
- lint
- ADR linting using mdbook-lint rules.
Structs§
- Adr
- An Architecture Decision Record.
- AdrLink
- A link between ADRs.
- Config
- Configuration for an ADR repository.
- Discovered
Config - Result of discovering configuration.
- Parser
- Parser for ADR files.
- Repository
- A repository of Architecture Decision Records.
- Template
- A template for generating ADRs.
- Template
Engine - Template engine for managing and rendering templates.
Enums§
- AdrStatus
- The status of an ADR.
- Config
Mode - The mode of operation for the ADR tool.
- Config
Source - Where the configuration was loaded from.
- Error
- Errors that can occur when working with ADRs.
- Link
Kind - The kind of link between ADRs.
- Template
Format - Built-in template formats.
- Template
Variant - Template variants for different levels of detail.
Functions§
- discover
- Discover configuration by searching up the directory tree.
Type Aliases§
- Result
- Result type alias using the library’s error type.