gen-orb-mcp 0.1.7

Generate MCP servers from CircleCI orb definitions
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

//! Migration engine: planning and applying conformance-based migrations.
//!
//! The migrator converts `Vec<ConformanceRule>` + `ConsumerConfig` into a
//! `MigrationPlan`, then applies the plan to files on disk.
//!
//! ## Usage
//!
//! ```ignore
//! use gen_orb_mcp::migrator::Migrator;
//! use gen_orb_mcp::consumer_parser::ConsumerParser;
//!
//! let config = ConsumerParser::parse_directory(".circleci/".as_ref())?;
//! let plan = Migrator::plan(&rules, &config, "toolkit");
//! println!("{}", plan.format_summary());
//! let applied = Migrator::apply(&plan, false)?;  // false = not dry run
//! ```

pub mod applicator;
pub mod planner;
pub mod reporter;
pub mod types;

pub use types::{AppliedChanges, ChangeType, MigrationPlan, PlannedChange};

use crate::{conformance_rule::ConformanceRule, consumer_parser::types::ConsumerConfig};

/// Entry point for migration planning and application.
pub struct Migrator;

impl Migrator {
    /// Produces a `MigrationPlan` from conformance rules and a consumer config.
    ///
    /// # Arguments
    /// * `rules` — conformance rules for the target version
    /// * `config` — parsed consumer CI config
    /// * `orb_alias` — the orb alias as used in the consumer's config
    pub fn plan(
        rules: &[ConformanceRule],
        config: &ConsumerConfig,
        orb_alias: &str,
    ) -> MigrationPlan {
        planner::plan(rules, config, orb_alias)
    }

    /// Applies a migration plan to files on disk.
    ///
    /// When `dry_run` is `true`, files are not modified.
    pub fn apply(plan: &MigrationPlan, dry_run: bool) -> std::io::Result<AppliedChanges> {
        applicator::apply(plan, dry_run)
    }
}