globetrotter 0.0.15

Polyglot, type-safe internationalization
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
52
53
54
55
56
57
58
59
60
61
62

//! Source ownership and dynamic-call policy determine which keys count as used.

use std::path::PathBuf;

/// Dynamic translation calls follow this policy during unused-key checks.
#[derive(
    Debug,
    Clone,
    Copy,
    Default,
    PartialEq,
    Eq,
    Hash,
    serde::Deserialize,
    serde::Serialize,
    strum::EnumString,
    strum::Display,
)]
#[serde(rename_all = "kebab-case")]
#[strum(serialize_all = "kebab-case")]
pub enum DynamicUsages {
    /// Accept a specific literal prefix without reporting the dynamic call.
    #[default]
    Allow,
    /// Accept a specific literal prefix and report the dynamic call as a warning.
    Warn,
    /// Report the dynamic call as an error and do not accept its prefix as a usage.
    Deny,
}

/// Associates a translation catalog with its application sources and usage policy.
#[derive(Debug, Clone, PartialEq, Eq, Hash, serde::Deserialize)]
#[serde(default, deny_unknown_fields)]
pub struct UsageConfig {
    /// Relative source roots resolve from the declaring configuration file.
    ///
    /// Empty roots disable scanning unless the caller supplies an override.
    pub roots: Vec<PathBuf>,
    /// This policy controls whether inferred dynamic prefixes keep keys alive.
    pub dynamic: DynamicUsages,
    /// Matching callees treat their first argument as a translation key.
    ///
    /// Names without a dot also match the final member of a callee, such as
    /// `i18n.t` for `t`; dotted names match the complete callee.
    pub functions: Vec<String>,
    /// Enables `.ignore` rules during source discovery.
    pub respect_ignore_files: bool,
    /// Enables `.gitignore`, Git's global excludes, and `.git/info/exclude` rules.
    pub respect_gitignore: bool,
}

impl Default for UsageConfig {
    fn default() -> Self {
        Self {
            roots: Vec::new(),
            dynamic: DynamicUsages::default(),
            functions: vec!["t".into(), "$t".into(), "translate".into()],
            respect_ignore_files: true,
            respect_gitignore: true,
        }
    }
}