Struct ProjectConfig 

pub struct ProjectConfig {
    pub base: String,
    pub pad: usize,
    pub layout: Layout,
    pub types: BTreeMap<String, DocType>,
    pub rules: Vec<Rule>,
    pub stats: Vec<StatSpec>,
    pub palette: BTreeMap<String, PaletteEntry>,
    pub tui: TuiConfig,
    pub file_refs: FileRefs,
}

Fields

base: String

Inventory base directory, relative to the project root (the dir holding opys.toml). Defaults to opys.

pad: usize

layout: Layout

types: BTreeMap<String, DocType>

rules: Vec<Rule>

stats: Vec<StatSpec>

Custom stats sections rendered by opys stats (and the TUI stats screen). Each is a single sql query over the corpus view, rendered as a markdown table.

palette: BTreeMap<String, PaletteEntry>

Presentation rules for the TUI. Ignored by the core engine; parsed and validated here so config validate catches mistakes regardless of the tui feature. See crate::palette.

tui: TuiConfig

TUI list presentation. Ignored by the core engine; see TuiConfig.

file_refs: FileRefs

How document ids are mentioned in code, for show --refs and the post-renumber reference warning. See FileRefs.

Implementations

impl ProjectConfig

pub fn load(path: &Path) -> Result<ProjectConfig>

Load opys.toml, or a usage error pointing at config init when absent.

pub fn doc_dirs(&self) -> Vec<&str>

The distinct directories (under the base) that hold documents — the set generic discovery scans. Multiple types may share a dir (assigned by id prefix at load).

pub fn dir_for_id(&self, id: &str) -> &str

The directory holding the type whose prefix matches id (the default dir when the prefix matches no type).

pub fn doc_relpath(&self, id: &str, status: &str) -> PathBuf

The canonical file path for a document, relative to the inventory base: the layout.path template with {type}/{status}/{id} substituted and empty path segments collapsed. The {type}/{status} segments come from the type matching id’s prefix (empty for an unknown prefix).

pub fn type_name_for_id(&self, id: &str) -> Option<&str>

The name of the type whose prefix matches id’s prefix, if any. (A doc’s type is derived from its ID prefix — the ID is the single source of truth.)

pub fn validate(&self) -> Vec<String>

Check the config is well-formed, returning all problems (empty == OK). These are content problems (verify-style), not hard errors.

Trait Implementations

impl Clone for ProjectConfig

fn clone(&self) -> ProjectConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProjectConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProjectConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.