pre-commit-models 0.0.1

Unofficial, high-quality data models for pre-commit configurations and hook 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
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
90
91

//! Pre-commit hook definition models, i.e. for `.pre-commit-hooks.yml`.
//!
//! See: <https://pre-commit.com/#new-hooks>

use crate::common;

/// One or more hook definitions.
#[derive(Debug, serde::Deserialize)]
pub struct Hooks(pub Vec<HookDefinition>);

/// A single hook definition within a `.pre-commit-hooks.yml` file.
#[derive(Debug, serde::Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct HookDefinition {
    /// The ID of the hook, as use in `.pre-commit-config.yml`.
    pub id: String,

    /// The name of the hook, shown during execution.
    pub name: String,

    /// The entrypoint for the hook, i.e. the executable to run.
    ///
    /// This can also contain arguments that aren't overridable, e.g.
    /// `entry: autopep8 -i`.
    pub entry: String,

    /// The hook's language.
    pub language: String,

    /// The pattern of files to run the hook on.
    pub files: Option<String>,

    /// Excludes files matches by `files` from the hook.
    pub exclude: Option<String>,

    /// Default list of file times to run the hook on (AND).
    pub types: Option<Vec<String>>,

    /// Default list of file times to run the hook on (OR).
    pub types_or: Option<Vec<String>>,

    /// Default list of file times to exclude.
    pub exclude_types: Option<Vec<String>>,

    /// If `true`, run the hook even when there are no matching files.
    #[serde(default)]
    pub always_run: bool,

    /// If `true`, pre-commit will stop running hooks if this hook fails.
    #[serde(default)]
    pub fail_fast: bool,

    /// If `true`, force the hook's output to be printed even if it passes.
    #[serde(default)]
    pub verbose: bool,

    /// If `false`, no filenames will be passed to the hook.
    #[serde(default = "default_true")]
    pub pass_filenames: bool,

    /// If `true`, this hook will execute using a single process instead of in parallel.
    #[serde(default)]
    pub require_serial: bool,

    /// A description of the hook, or `''` if not given.
    #[serde(default)]
    pub description: String,

    /// The default version to use for [`Self::language`].
    #[serde(default = "default_language_version")]
    pub language_version: String,

    /// The minimum version of pre-commit required.
    #[serde(default = "common::default_minimum_pre_commit_version")]
    pub minimum_pre_commit_version: String,

    /// The default list of additional parameters to pass to the hook.
    #[serde(default)]
    pub args: Vec<String>,

    /// The default set of stages to run the hook for.
    pub stages: Option<Vec<String>>,
}

const fn default_true() -> bool {
    true
}

fn default_language_version() -> String {
    "default".into()
}