pub struct CommitSubjectConfig { /* private fields */ }
Expand description

Configuration for the CommitSubject check.

No configuration is necessary. The defaults are guided by common commit message guidelines.

FieldTypeDefault
min_summarypositive integer8
max_summarypositive integer78
check_work_in_progressbooleantrue
check_rebase_commandsbooleantrue
check_suggestion_subjectsbooleanfalse

The prefix configurations are lists of strings that are by default empty lists. The tolerated_prefixes key is interpreted as a list of regular expressions.

This check is registered as a commit check with the name `“commit_subject”.

Example

{
    "min_summary": 8,
    "max_summary": 78,

    "check_work_in_progress": true,
    "check_rebase_commands": true,
    "check_suggestion_subjects": true,

    "tolerated_prefixes": [
        "regex"
    ],
    "allowed_prefixes": [
        "literal"
    ],
    "disallowed_prefixes": [
        "literal"
    ]
}

Trait Implementations

Formats the value using the given formatter. Read more

Deserialize this value from the given Serde deserializer. Read more

The check parsed by this configuration.

Create a new instance of the check from the configuration.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.