#![doc = include_str!("../README.md")]
mod export;
mod import;
mod import_helpers;
pub mod library;
use std::fmt::{Display, Formatter};
use cortex_domain::{GraphDocument, GraphError};
pub use export::export_skill_markdown;
pub use import::import_skill_markdown;
pub use library::{
ImportedSkill, LibraryEntry, LibraryImport, LibraryNotice, SkillIndexEntry, import_library,
index_entry, render_index,
};
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub enum SkillError {
InvalidFrontmatter(String),
InvalidGraph(String),
UnsupportedGraph(String),
}
impl Display for SkillError {
fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
match self {
Self::InvalidFrontmatter(message) => {
write!(formatter, "invalid frontmatter: {message}")
}
Self::InvalidGraph(message) => write!(formatter, "invalid skill graph: {message}"),
Self::UnsupportedGraph(message) => {
write!(formatter, "unsupported skill graph: {message}")
}
}
}
}
impl std::error::Error for SkillError {}
impl From<GraphError> for SkillError {
fn from(error: GraphError) -> Self {
Self::InvalidGraph(error.to_string())
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct BundledSkill {
pub id: &'static str,
pub source: &'static str,
pub markdown: &'static str,
}
#[must_use]
#[allow(clippy::too_many_lines)] pub const fn bundled_skills() -> &'static [BundledSkill] {
&[
BundledSkill {
id: "test-driven-development",
source: "cortex-skills/fixtures/test-driven-development.md",
markdown: include_str!("../fixtures/test-driven-development.md"),
},
BundledSkill {
id: "systematic-debugging",
source: "cortex-skills/fixtures/systematic-debugging.md",
markdown: include_str!("../fixtures/systematic-debugging.md"),
},
BundledSkill {
id: "grounded-review",
source: "cortex-skills/fixtures/grounded-review.md",
markdown: include_str!("../fixtures/grounded-review.md"),
},
BundledSkill {
id: "evidence-first-change",
source: "cortex-skills/fixtures/evidence-first-change.md",
markdown: include_str!("../fixtures/evidence-first-change.md"),
},
BundledSkill {
id: "verification-before-completion",
source: "cortex-skills/fixtures/verification-before-completion.md",
markdown: include_str!("../fixtures/verification-before-completion.md"),
},
BundledSkill {
id: "blast-radius-analysis",
source: "cortex-skills/fixtures/blast-radius-analysis.md",
markdown: include_str!("../fixtures/blast-radius-analysis.md"),
},
BundledSkill {
id: "interface-contract-change",
source: "cortex-skills/fixtures/interface-contract-change.md",
markdown: include_str!("../fixtures/interface-contract-change.md"),
},
BundledSkill {
id: "dependency-upgrade",
source: "cortex-skills/fixtures/dependency-upgrade.md",
markdown: include_str!("../fixtures/dependency-upgrade.md"),
},
BundledSkill {
id: "performance-investigation",
source: "cortex-skills/fixtures/performance-investigation.md",
markdown: include_str!("../fixtures/performance-investigation.md"),
},
BundledSkill {
id: "incident-response",
source: "cortex-skills/fixtures/incident-response.md",
markdown: include_str!("../fixtures/incident-response.md"),
},
BundledSkill {
id: "migration-cutover",
source: "cortex-skills/fixtures/migration-cutover.md",
markdown: include_str!("../fixtures/migration-cutover.md"),
},
BundledSkill {
id: "api-versioning",
source: "cortex-skills/fixtures/api-versioning.md",
markdown: include_str!("../fixtures/api-versioning.md"),
},
BundledSkill {
id: "flaky-test-quarantine",
source: "cortex-skills/fixtures/flaky-test-quarantine.md",
markdown: include_str!("../fixtures/flaky-test-quarantine.md"),
},
BundledSkill {
id: "security-threat-model",
source: "cortex-skills/fixtures/security-threat-model.md",
markdown: include_str!("../fixtures/security-threat-model.md"),
},
BundledSkill {
id: "observability-first",
source: "cortex-skills/fixtures/observability-first.md",
markdown: include_str!("../fixtures/observability-first.md"),
},
BundledSkill {
id: "data-migration",
source: "cortex-skills/fixtures/data-migration.md",
markdown: include_str!("../fixtures/data-migration.md"),
},
BundledSkill {
id: "feature-flag-rollout",
source: "cortex-skills/fixtures/feature-flag-rollout.md",
markdown: include_str!("../fixtures/feature-flag-rollout.md"),
},
BundledSkill {
id: "documentation-sync",
source: "cortex-skills/fixtures/documentation-sync.md",
markdown: include_str!("../fixtures/documentation-sync.md"),
},
BundledSkill {
id: "release-checklist",
source: "cortex-skills/fixtures/release-checklist.md",
markdown: include_str!("../fixtures/release-checklist.md"),
},
BundledSkill {
id: "backlog-triage",
source: "cortex-skills/fixtures/backlog-triage.md",
markdown: include_str!("../fixtures/backlog-triage.md"),
},
BundledSkill {
id: "accessibility-audit",
source: "cortex-skills/fixtures/accessibility-audit.md",
markdown: include_str!("../fixtures/accessibility-audit.md"),
},
BundledSkill {
id: "configuration-drift",
source: "cortex-skills/fixtures/configuration-drift.md",
markdown: include_str!("../fixtures/configuration-drift.md"),
},
BundledSkill {
id: "cache-invalidation",
source: "cortex-skills/fixtures/cache-invalidation.md",
markdown: include_str!("../fixtures/cache-invalidation.md"),
},
BundledSkill {
id: "concurrency-bug-hunt",
source: "cortex-skills/fixtures/concurrency-bug-hunt.md",
markdown: include_str!("../fixtures/concurrency-bug-hunt.md"),
},
BundledSkill {
id: "schema-evolution",
source: "cortex-skills/fixtures/schema-evolution.md",
markdown: include_str!("../fixtures/schema-evolution.md"),
},
BundledSkill {
id: "dependency-audit",
source: "cortex-skills/fixtures/dependency-audit.md",
markdown: include_str!("../fixtures/dependency-audit.md"),
},
BundledSkill {
id: "error-budget-review",
source: "cortex-skills/fixtures/error-budget-review.md",
markdown: include_str!("../fixtures/error-budget-review.md"),
},
BundledSkill {
id: "capacity-planning",
source: "cortex-skills/fixtures/capacity-planning.md",
markdown: include_str!("../fixtures/capacity-planning.md"),
},
BundledSkill {
id: "rollback-drill",
source: "cortex-skills/fixtures/rollback-drill.md",
markdown: include_str!("../fixtures/rollback-drill.md"),
},
BundledSkill {
id: "contract-testing",
source: "cortex-skills/fixtures/contract-testing.md",
markdown: include_str!("../fixtures/contract-testing.md"),
},
BundledSkill {
id: "postmortem-writeup",
source: "cortex-skills/fixtures/postmortem-writeup.md",
markdown: include_str!("../fixtures/postmortem-writeup.md"),
},
]
}
pub(crate) fn heading_text(name: &str) -> String {
name.split_whitespace().collect::<Vec<_>>().join(" ")
}
pub fn import_skill(source: &str, markdown: &str) -> Result<GraphDocument, SkillError> {
import_skill_markdown(source, markdown)
}
pub fn export_skill(graph: &GraphDocument) -> Result<String, SkillError> {
export_skill_markdown(graph)
}
#[cfg(test)]
mod tests;
#[cfg(test)]
mod tests_roundtrip;