capn-config 1.4.0

Configuration types for capn
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

//! Capn configuration types.
//!
//! This is a separate crate so build.rs can generate schemas from these types.

/// Configuration read from `.config/capn/config.styx`
#[derive(Debug, Clone, facet::Facet)]
#[facet(derive(Default), traits(Default))]
#[facet(rename_all = "kebab-case")]
pub struct CapnConfig {
    /// Configuration for pre-commit hooks.
    #[facet(default)]
    pub pre_commit: PreCommitConfig,

    /// Configuration for pre-push hooks.
    #[facet(default)]
    pub pre_push: PrePushConfig,
}

/// Configuration for pre-commit hooks.
#[derive(Debug, Clone, facet::Facet)]
#[facet(rename_all = "kebab-case", traits(Default), derive(Default))]
pub struct PreCommitConfig {
    /// Deprecated: README generation has been removed from capn.
    /// If enabled, capn will print a recommendation to use `cargo-reedme`.
    #[facet(default = false)]
    pub generate_readmes: bool,

    /// Format staged Rust files with `rustfmt`.
    #[facet(default = true)]
    pub rustfmt: bool,

    /// Stage `Cargo.lock` changes automatically.
    #[facet(default = true)]
    pub cargo_lock: bool,

    /// Create `arborium-header.html` files for enhanced rustdoc syntax highlighting.
    #[facet(default = true)]
    pub arborium: bool,

    /// Require Rust edition 2024 in all workspace crates.
    #[facet(default = true)]
    pub edition_2024: bool,

    /// Check for path dependencies pointing outside the workspace.
    /// These are typically local development overrides that should not be committed.
    #[facet(default = true)]
    pub external_path_deps: bool,

    /// Check for internal dev-dependencies that can break release-plz.
    #[facet(default = true)]
    pub internal_dev_deps_release_plz: bool,
}

/// Configuration for pre-push hooks.
#[derive(Debug, Clone, facet::Facet)]
#[facet(rename_all = "kebab-case", traits(Default), derive(Default))]
pub struct PrePushConfig {
    /// Run `cargo clippy` with warnings as errors.
    #[facet(default = true)]
    pub clippy: bool,

    /// Features to pass to clippy. If `None`, uses `--all-features`.
    #[facet(default)]
    pub clippy_features: Option<Vec<String>>,

    /// Run tests via `cargo nextest`.
    #[facet(default = true)]
    pub nextest: bool,

    /// Run documentation tests via `cargo test --doc`.
    #[facet(default = false)]
    pub doc_tests: bool,

    /// Features to pass to doc tests. If `None`, uses `--all-features`.
    #[facet(default)]
    pub doc_test_features: Option<Vec<String>>,

    /// Build documentation with `cargo doc` and treat warnings as errors.
    #[facet(default = true)]
    pub docs: bool,

    /// Features to pass to rustdoc. If `None`, uses `--all-features`.
    #[facet(default)]
    pub docs_features: Option<Vec<String>>,

    /// Check for unused dependencies with `cargo-shear`.
    #[facet(default = true)]
    pub cargo_shear: bool,
}