code_passenger 0.2.0

Language-pack + header-plan driven code annotator: scans usage + auto-generates feature gates and doc headers.
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

use crate::{
    error::{PassengerError, Result},
    model::{FileReport, ScaffoldOutput, ScaffoldRequest, UsedSymbols},
    plans::HeaderPlan, scaffolds::ScaffoldPlan,
};
use std::path::Path;

pub trait LanguagePack: Send + Sync {
    fn id(&self) -> &'static str;

    /// Which files this pack owns.
    fn matches_path(&self, path: &Path) -> bool;

    /// Extract “used deps/symbols” from file content.
    fn detect_usage(&self, content: &str) -> UsedSymbols;

    /// Render the header (doc + notes + gates) using a plan.
    fn render_header(&self, plan: &dyn HeaderPlan, report: &FileReport) -> String;

    /// Insert/replace header block idempotently.
    fn apply_header(&self, original: &str, header: &str) -> String;

    /// Optional: generate scaffolding for a new file/module.
    fn scaffold(&self, _plan: &dyn ScaffoldPlan, _req: ScaffoldRequest) -> Result<ScaffoldOutput> {
        Err(PassengerError::Unsupported("scaffold not supported by this pack".into()))
    }

    // fn scaffold(&self, _kind: &str, _name: &str, _module_path: &[String]) -> Result<Vec<(std::path::PathBuf, String)>> {
    //     Err(PassengerError::Unsupported("scaffold not supported by this pack".into()))
    // }
}


#[cfg(feature = "lang_rust")]
pub mod rust;

pub fn get_pack(lang: &str) -> Result<Box<dyn LanguagePack>> {
    match lang {
        #[cfg(feature = "lang_rust")]
        "rust" | "rs" => Ok(Box::new(rust::RustPack)),
        _ => Err(PassengerError::Unsupported(format!("language pack '{lang}' not available"))),
    }
}