Expand description
Graph generation settings.
The settings control how a branching graph is layed out. They are used in the print module when generating a visualization and persisted to disk in the config module.
These are the main structs
- Settings The main settings object, which contains:
- CommitFormat Format of the commit summary text to the right of the graph.
- Characters The symbols to use when rendering a graph as text.
- BranchSettings Control how a graph is formatted.
- BranchOrder Determines the left-to-right order of branches.
- MergePatterns Regex that extract branch names from a merge commit.
Structs§
- Branch
Settings - Settings defining branching models
- Branch
Settings Def - Helper for reading BranchSettings, required due to RegEx.
- Characters
- The characters used for drawing text-based graphs.
- Colors
Def - Helper for reading branch colors, required due to RegEx.
- Merge
Patterns - RegEx patterns for extracting branch names from merge commit summaries.
- Repo
Settings - Repository settings for the branching model. Used to read repo’s git-graph.toml
- Settings
- Top-level settings
Enums§
- Branch
Order - Ordering policy for branches in visual columns.